hosting

POST /v1/sites/own-dns-preflight

Check, read-only, whether a domain's DNS can be published on your own DNS account.

All hosting endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the sites.create permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

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/own-dns-preflight \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "domain": <string> }'

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

The create wizard's check for publish DNS on my own Cloudflare/DNS account, run before anything is provisioned. Three reads, nothing written to the account: the organization has an active DNS connection; its key lists the zone the domain lives in and its last permission report shows record edit passing; and the domain's public nameservers are the ones that account assigned. ok is the only passing verdict; every other code names the fix in message. The organization is the body org_id or the X-Zinn-Org header. Requires sites.create.

Request body

NameTypeRequiredWhat it is
domainstringYes—
org_idstringNo—

Response

NameTypeRequiredWhat it is
okbooleanYesTrue only when code is ok.
codestring<ok, no_account, provider_error, zone_missing, cannot_edit, unchecked, ns_mismatch, ns_unknown>Yes—
keystringNoThe refusal catalogue key
paramsobjectNo—
messagestringNoThe fix
domainstringYes—
zonestringNo—
providerstringNo—
permissionstringNo—
expected_nameserversstring[]No—
live_nameserversstring[]No—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429