API reference · DNS
Read the domain's records from its current nameservers or a zone file, for review; nothing is written to the zone
POST/v1/orgs/{org}/zones/{zone}/dns/imports
- Permission
dns.records.manage- Request body
- at most 6,292,480 bytes
- Audit log
dns.import.create- Operation
dns.imports.create
Parameters
| Name | In | Type | Required | Notes |
|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
Idempotency-Key | header | string | no | One key per intended mutation. A retry with the key replays the recorded response instead of executing again; the key with another request answers 422 idempotency_key_reused. For example "01h455vb4pex5vsknk084sn02q" |
x-obhut-management-assignment | header | string | no | Select one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q" |
Request body
| Field | Type | Required | Notes |
|---|
source | "nameservers" | yes | |
zoneFile | string | yes | 1 to 1048576 characters |
Response 201
| Field | Type | Required | Notes |
|---|
id | string | yes | for example "import_01h455vb4pex5vsknk084sn02q" |
zoneId | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
source | string | yes | one of "nameservers", "zonefile" |
method | string or null | yes | |
status | string | yes | one of "queued", "running", "ready", "failed" |
complete | boolean | yes | |
stoppedEarly | boolean | yes | |
nameservers | array of string | yes | |
failure | string or null | yes | |
createdAt | string (date-time) | yes | UTC, ISO 8601. |
finishedAt | string (date-time) or null | yes | |
appliedAt | string (date-time) or null | yes | |
candidates | array of object | yes | |
candidates[].name | string | yes | |
candidates[].ttl | integer | yes | 60 to 86400 |
candidates[].sourceTtl | integer | no | 0 to ∞ |
candidates[].data | object or object or object or object or object or object or object or object | yes | |
candidates[].data.type | "A" | yes | |
candidates[].data.address | string (ipv4) | yes | |
candidates[].data.target | string | yes | 1 to 253 characters |
candidates[].data.nameserver | string | yes | 1 to 253 characters |
candidates[].data.priority | integer | yes | 0 to 65535 |
candidates[].data.exchange | string | yes | 1 to 253 characters |
candidates[].data.text | string | yes | 1 to 4096 characters |
candidates[].data.weight | integer | yes | 0 to 65535 |
candidates[].data.port | integer | yes | 0 to 65535 |
candidates[].data.flags | integer | yes | 0 to 255 |
candidates[].data.tag | string | yes | one of "issue", "issuewild", "iodef" |
candidates[].data.value | string | yes | 1 to 1024 characters |
candidates[].state | string | yes | one of "new", "exists", "suppressed", "conflict" |
candidates[].reason | string | no | one of "proxied_name", "below_delegation" |
skipped | array of object | yes | |
skipped[].name | string | yes | |
skipped[].type | string | yes | |
skipped[].value | string | yes | |
skipped[].reason | string | yes | one of "apex_nameservers", "soa", "dnssec", "unsupported_type", "apex_cname", "outside_zone", "conflicting", "invalid" |