API reference · DNS
Add a record
POST
/v1/orgs/{org}/zones/{zone}/dns/recordsAdd a record. The zone answers with it at once
- Permission
dns.records.manage- Audit log
dns.record.create- Operation
dns.records.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 |
|---|---|---|---|
name | string | yes | 1 to 253 characters |
ttl | integer | no | 60 to 86400; default 300 |
data | object or object or object or object or object or object or object or object | yes | |
data.type | "A" | yes | |
data.address | string (ipv4) | yes | |
data.target | string | yes | 1 to 253 characters |
data.nameserver | string | yes | 1 to 253 characters |
data.priority | integer | yes | 0 to 65535 |
data.exchange | string | yes | 1 to 253 characters |
data.text | string | yes | 1 to 4096 characters |
data.weight | integer | yes | 0 to 65535 |
data.port | integer | yes | 0 to 65535 |
data.flags | integer | yes | 0 to 255 |
data.tag | string | yes | one of "issue", "issuewild", "iodef" |
data.value | string | yes | 1 to 1024 characters |
Response 201
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | for example "record_01h455vb4pex5vsknk084sn02q" |
zoneId | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
name | string | yes | |
ttl | integer | yes | 60 to 86400 |
data | object or object or object or object or object or object or object or object | yes | |
data.type | "A" | yes | |
data.address | string (ipv4) | yes | |
data.target | string | yes | 1 to 253 characters |
data.nameserver | string | yes | 1 to 253 characters |
data.priority | integer | yes | 0 to 65535 |
data.exchange | string | yes | 1 to 253 characters |
data.text | string | yes | 1 to 4096 characters |
data.weight | integer | yes | 0 to 65535 |
data.port | integer | yes | 0 to 65535 |
data.flags | integer | yes | 0 to 255 |
data.tag | string | yes | one of "issue", "issuewild", "iodef" |
data.value | string | yes | 1 to 1024 characters |
revision | string | yes | Opaque revision: dot-joined counters. |
createdAt | string (date-time) | yes | UTC, ISO 8601. |
updatedAt | string (date-time) | yes | UTC, ISO 8601. |