List by name
- GET
- /workspaces
- /:workspace
- /domains
- /:domain_id
- /records
- /:record_name
Get all records for domain or subdomain
Request example
CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/domains/:domain_id/records/:record_name" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json"
Response examples
Records List
EXAMPLE RESPONSE
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"records": [
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./SOA",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"type": "SOA",
"name": "@"
},
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./NS",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"type": "NS",
"name": "@"
},
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/www.example.com./A",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"type": "A",
"name": "www"
},
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/api.example.com./A",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"type": "A",
"name": "api"
},
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/blog.example.com./CNAME",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"type": "CNAME",
"name": "blog"
}
]
}STATUS
200 OKPartial Records List
EXAMPLE RESPONSE
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"records": [
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/api.example.com./A",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"type": "A",
"name": "api"
}
]
}STATUS
200 OKNo Records List
EXAMPLE RESPONSE
{
"url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records",
"html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw",
"records": []
}STATUS
200 OK