API reference · Zones
Add a hostname to a zone
POST
/v1/orgs/{org}/zones/{zone}/hostnamesAdd a hostname to a zone. It carries no traffic until the lifecycle enables it
- Permission
zones.hostnames.manage- Audit log
zones.hostname.create- Operation
zones.hostnames.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 |
Response 201
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | for example "hostname_01h455vb4pex5vsknk084sn02q" |
zoneId | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
name | string | yes | |
certificateRequested | boolean | yes | |
edgeServing | boolean | yes | |
proxyDns | boolean | yes | |
revision | string | yes | Opaque revision: dot-joined counters. |
cnameTarget | string or null | yes | |
createdAt | string (date-time) | yes | UTC, ISO 8601. |