hosting
POST /v1/sites/{siteId}/edge-domains/{hostname}/dns
Publish this domain's DNS records for the customer.
Authentication
Send an API key as a bearer token. The key must carry the hosting.deploy.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/edge-domains/{hostname}/dns \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Writes the records and then resolves them, so the answer is what the internet says rather than what we did. Three tiers in order — the customer's own connected DNS provider, then our nameservers with the zone pre-built, then the records to publish by hand — and the tier that was actually used comes back as `mode`. In `nameservers` mode the `nameservers` array is the one thing left for the customer to do. Requires `hosting.deploy.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
hostname (path) | string | Yes | The bound hostname, lower-cased and without a trailing dot. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
hostname | string | Yes | — |
mode | string<unknown, our_zone, byo_dns, nameservers, manual> | Yes | — |
zone | string | Yes | — |
vendor | string | Yes | — |
detail | string | Yes | — |
nameservers | string[] | Yes | Populated only in `nameservers` mode — the zone is built and the records are in it, and setting these at the registrar is the one thing left to do. |
records | DnsRecordPlan[] | Yes | — |
checks | DnsRecordCheck[] | Yes | — |
resolves | boolean | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429