API reference · Zones
List the zones of the organization, alphabetical, with search and filters
GET
/v1/orgs/{org}/zones- Permission
zones.zones.read- Operation
zones.zones.list
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
limit | query | integer | no | 1 to 100; default 50 |
cursor | query | string | no | 0 to 200 characters |
q | query | string | no | 0 to 253 characters |
setupMode | query | string | no | one of "full", "partial" |
status | query | string | no | one of "pending", "active" |
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" |
Response 200
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of object | yes | |
items[].id | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
items[].name | string | yes | |
items[].setupMode | string | yes | one of "full", "partial" |
items[].status | string | yes | one of "pending", "active" |
items[].nameservers | array of string | yes | |
items[].dnsEligibility | object or null | yes | |
items[].dnsEligibility.eligible | boolean | yes | |
items[].dnsEligibility.reason | string | yes | one of "unobserved", "delegated", "predelegation", "ownership_mismatch", "parent_not_delegated" |
items[].dnsEligibility.observedAt | string (date-time) or null | yes | |
items[].verification | object | yes | |
items[].verification.name | string | yes | |
items[].verification.value | string | yes | |
items[].lastCheck | object or null | yes | |
items[].lastCheck.at | string (date-time) | yes | UTC, ISO 8601. |
items[].lastCheck.ok | boolean | yes | |
items[].lastCheck.code | string | yes | one of "nameservers_match", "nameservers_missing", "nameservers_differ", "verification_found", "verification_missing", "verification_mismatch", "lookup_failed" |
items[].lastCheck.params | object or null | yes | |
items[].lastCheck.params.missing | array of string | no | |
items[].lastCheck.params.unexpected | array of string | no | |
items[].lastCheck.observed | array of string | yes | |
items[].createdAt | string (date-time) | yes | UTC, ISO 8601. |
items[].activatedAt | string (date-time) or null | yes | |
nextCursor | string or null | yes |