API reference · DNS
What obhut answers for the zone, name by name, and where each answer comes from
GET
/v1/orgs/{org}/zones/{zone}/dns/effective- Permission
dns.records.read- Operation
dns.effective.list
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
limit | query | integer | no | 1 to 100; default 50 |
cursor | query | string | no | 0 to 200 characters |
name | query | string | no | 0 to 255 characters |
type | query | string | no | 0 to 10 characters |
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[].name | string | yes | |
items[].type | string | yes | |
items[].ttl | integer | yes | 60 to 86400 |
items[].values | array of string | yes | |
items[].source | string | yes | one of "record", "soa", "nameservers", "proxy", "managed" |
items[].ids | array of string | yes | |
items[].status | string | yes | one of "served", "suppressed" |
items[].reason | string | no | one of "proxied_name", "below_delegation" |
nextCursor | string or null | yes |