Docs

GET /domains/{id}/setup

One-shot DNS setup: zone file, copy-paste commands, provider detection, and every record with host, zone, value_strings.

Parameters

  • id path · string · required

Responses

  • 200 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
commandsobjectyes
commands.cloudflarearray<object>yes
commands.gcloudarray<string>yes
commands.route53objectyes
deep_linkstring | nullyes
detectedbooleanyes
domainstringyes
nameserversarray<string>yes
providerobject | nullyes
provider_hintsobjectyes
provider_hints.cloudflarestringyes
provider_hints.godaddystringyes
provider_hints.namecheapstringyes
provider_hints.route53stringyes
recordsarray<object>yes
records[].hoststringyes
records[].namestringyes
records[].name_relativestringyes
records[].priorityinteger | nullyes
records[].recordstringyes
records[].requiredbooleanyes
records[].ttlintegeryes
records[].typestringyes
records[].valuestringyes
records[].value_bindstringyes
records[].value_stringsarray<string>yes
zonestringyes
zone_filestringyes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.