logo

Domains

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

SecuritybearerAuth
Request
query Parameters
company
required
string
Example: company=54fb80af-576c-4fdc-ba4f-b596c83f15a1
Responses
200

Response object of domains requests

401

No or invalid API key provided to the request

404

Could not find the company or the user does not have permissions to retrieve data

500

Error occurred while retrieving domains

get/domains
Request samples 
Response samples 
application/json
{
  • "company": {
    }
}
Get list of domain DNS records by domain ID
SecuritybearerAuth 
Responses 
200
Response object of domain DNS records requests


401
No or invalid API key provided to the request


500
Error occurred while retrieving domain DNS records


get/domains/{domain_id}/dns-records
Request samples 
Response samples 
application/json
{
  • "domain": {
    }
}
Create a domain DNS record
SecuritybearerAuth 
Request 
path Parameters
domain_id
required
string <uuid> 
 
 Example:  54fb80af-576c-4fdc-ba4f-b596c83f15a1
Request Body schema: application/json
type
required
string
 
name
required
string
 
ttl
required
number  >= 300 
TTL in seconds


 
required
Array of objects
 
Responses 
202
DNS record create action started. Check MyKinsta for status


400
One or more of the required parameters were not provided to the request


401
No or invalid API key provided to the request


500
Error occurred while creating a domain DNS record


post/domains/{domain_id}/dns-records
Request samples 
application/json
{
  • "type": "A",
  • "name": "abc.mydomain.com",
  • "ttl": 3600,
  • "resource_records": [
    ]
}
Response samples 
application/json
{
  • "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
SecuritybearerAuth 
Request 
path Parameters
domain_id
required
string <uuid> 
 
 Example:  54fb80af-576c-4fdc-ba4f-b596c83f15a1
Request Body schema: application/json
type
required
string
 
name
required
string
 
ttl
number  >= 300 
TTL in seconds


 
Array of objects
 
Array of objects
 
Responses 
202
DNS record update action started. Check MyKinsta for status


400
One or more of the required parameters were not provided to the request


401
No or invalid API key provided to the request


500
Error occurred while updating a domain DNS record


put/domains/{domain_id}/dns-records
Request samples 
application/json
{
  • "type": "A",
  • "name": "abc.mydomain.com",
  • "ttl": 3600,
  • "new_resource_records": [
    ],
  • "removed_resource_records": [
    ]
}
Response samples 
application/json
{
  • "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
SecuritybearerAuth 
Request 
path Parameters
domain_id
required
string <uuid> 
 
 Example:  54fb80af-576c-4fdc-ba4f-b596c83f15a1
Request Body schema: application/json
type
required
string
 
name
required
string
 
Responses 
202
Domain DNS record deletion action started. Check MyKinsta for status


400
One or more of the required parameters were not provided to the request


401
No or invalid API key provided to the request


500
Error occurred while deleting a domain DNS record


delete/domains/{domain_id}/dns-records
Request samples 
application/json
{
  • "type": "A",
  • "name": "staging.mydomain.com"
}
Response samples 
application/json
{
  • "operation_id": "domains:delete-dns-record-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "message": "Deleting domain DNS record in progress",
  • "status": 202
}
➔ Next to WordPress Sites