API reference · Proxy
List the hostnames with their lifecycle summaries
GET
/v1/orgs/{org}/zones/{zone}/proxy/hostnames- Permission
proxy.hostnames.read- Operation
proxy.hostnames.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 |
q | query | string | no | 0 to 64 characters |
phase | query | string | no | one of "configured", "preparing", "ready", "awaiting_dns", "enabling", "enabled", "disabling" |
origin | query | string | no | for example "origin_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" |
Response 200
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of object | yes | |
items[].hostnameId | string | yes | for example "hostname_01h455vb4pex5vsknk084sn02q" |
items[].name | string | yes | |
items[].mode | string | yes | one of "off", "prepared", "enabled" |
items[].phase | string | yes | one of "configured", "preparing", "ready", "awaiting_dns", "enabling", "enabled", "disabling" |
items[].blocked | boolean | yes | |
items[].health | string | yes | one of "ok", "degraded", "unknown" |
items[].route | string | yes | one of "applied", "pending", "inactive", "missing", "unavailable" |
items[].updatedAt | string (date-time) | yes | UTC, ISO 8601. |
nextCursor | string or null | yes |