With the domains endpoint, you can:
- Use a
POSTrequest to add a new domain to a WordPress site - Use a
DELrequest to remove a domain. - Use a
PUTrequest to change the primary domain.
You can obtain the environment_id and domain_ids using the GET request with the WordPress Site Environments endpoint.
The environment_id is also shown after the site_id in the URL in MyKinsta when you access the environment, for example in the URL https://my.kinsta.com/sites/details/fbab4927-e354-4044-b226-29ac0fbd20ca/c84ce214-69b9-4a32-8e67-880672cf1d38?idCompany=bdd25d71-5706-4890-870f-1adda17c505d:
- The
site_idisfbab4927-e354-4044-b226-29ac0fbd20ca - The
environment_idisc84ce214-69b9-4a32-8e67-880672cf1d38 - The
company_idisbdd25d71-5706-4890-870f-1adda17c505d
Add new site domain
Site domain creation 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 adding a site domain
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "domain_name": "string",
- "is_wildcardless": false,
- "custom_ssl_key": "string",
- "custom_ssl_cert": "string"
}- 202
- 400
- 401
- 500
{- "operation_id": "sites:add-domain-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Adding site domain in progress",
- "status": 202
}Delete one or more site domains
Site domain 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 site domains
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "domain_ids": [
- "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "3b2b80af-576c-4fdc-ba4f-b596c83f15a1"
]
}- 202
- 400
- 401
- 500
{- "operation_id": "sites:delete-domain-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Deleting site domain in progress",
- "status": 202
}Get list of site domains for the environment
Response object of site domains requests
No or invalid API key provided to the request
Could not find the site domains or the user does not have permissions to retrieve data
Error occurred while retrieving site domains
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 401
- 404
- 500
{- "environment": {
- "site_domains": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "name": "mydomain.com",
- "uses_cloudflare_dns": true
}
]
}
}Get list of verification and pointing records for the site domain
Response object of verification and pointing records requests
No or invalid API key provided to the request
Could not find the verification and pointing records or the user does not have permissions to retrieve data
Error occurred while retrieving verification and pointing records
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 401
- 404
- 500
{- "site_domain": {
- "verification_records": [
- {
- "name": "_acme-challenge.staging.example-site.io",
- "value": "staging.example-site.io.kinstavalidation.app",
- "type": "CNAME"
}
], - "pointing_records": [
- {
- "name": "staging.example-site.io",
- "value": "192.0.2.10",
- "type": "A"
}, - {
- "name": "www",
- "value": "staging.example-site.io",
- "type": "CNAME"
}
]
}
}Change primary domain of an environment
Changing primary domain 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 changing primary domain
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "domain_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "run_search_and_replace": true
}- 202
- 400
- 401
- 500
{- "operation_id": "sites:change-primary-domain-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Changing primary site domain in progress",
- "status": 202
}