If you use Kinsta’s DNS, you can use the domains endpoint to:
- Get a list of domains.
- Get a list of DNS records for a domain.
- Create a DNS record.
- Update a DNS record.
- Delete a DNS record.
To get the list of domains, you need the company ID. You can obtain the company_id from MyKinsta > username > Company settings > Billing details. The domains list will give you the domain_id to get the list of DNS records.
Get list of domains by company ID
Response object of domains requests
No or invalid API key provided to the request
Could not find the company or the user does not have permissions to retrieve data
Error occurred while retrieving domains
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 401
- 404
- 500
{- "company": {
- "domains": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "name": "mydomain.com",
- "site_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "is_active": true
}
]
}
}Get list of domain DNS records by domain ID
Response object of domain DNS records requests
No or invalid API key provided to the request
Error occurred while retrieving domain DNS records
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 401
- 500
{- "domain": {
- "dns_records": [
- {
- "type": "A",
- "name": "abc.mydomain.com",
- "ttl": 3600,
- "resource_records": [
- {
- "value": "1.1.1.1"
}
]
}
]
}
}Create a domain DNS record
DNS record create action started. Check MyKinsta for status
One or more of the required parameters were not provided to the request
No or invalid API key provided to the request
Error occurred while creating a domain DNS record
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "type": "A",
- "name": "abc.mydomain.com",
- "ttl": 3600,
- "resource_records": [
- {
- "value": "1.1.1.1"
}
]
}- 202
- 400
- 401
- 500
{- "operation_id": "domains:create-dns-record-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Creating a domain DNS record in progress",
- "status": 202
}Update a domain DNS record
DNS record update action started. Check MyKinsta for status
One or more of the required parameters were not provided to the request
No or invalid API key provided to the request
Error occurred while updating a domain DNS record
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "type": "A",
- "name": "abc.mydomain.com",
- "ttl": 3600,
- "new_resource_records": [
- {
- "value": "1.1.1.1"
}
], - "removed_resource_records": [
- {
- "value": "2.2.2.2"
}
]
}- 202
- 400
- 401
- 500
{- "operation_id": "domains:update-dns-record-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Updating a domain DNS record in progress",
- "status": 202
}Delete domain DNS record
Domain DNS record deletion action started. Check MyKinsta for status
One or more of the required parameters were not provided to the request
No or invalid API key provided to the request
Error occurred while deleting a domain DNS record
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "type": "A",
- "name": "staging.mydomain.com"
}- 202
- 400
- 401
- 500
{- "operation_id": "domains:delete-dns-record-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Deleting domain DNS record in progress",
- "status": 202
}