API reference · Proxy
Read the hostname lifecycle status
GET
/v1/orgs/{org}/zones/{zone}/hostnames/{hostname}/proxy- Permission
proxy.hostnames.read- Operation
proxy.hostnames.get
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
hostname | path | string | yes | for example "hostname_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 |
|---|---|---|---|
hostnameId | string | yes | for example "hostname_01h455vb4pex5vsknk084sn02q" |
name | string | yes | |
setupMode | string | yes | one of "full", "partial" |
mode | string | yes | one of "off", "prepared", "enabled" |
phase | string | yes | one of "configured", "preparing", "ready", "awaiting_dns", "enabling", "enabled", "disabling" |
health | string | yes | one of "ok", "degraded", "unknown" |
operationId | string (uuid) or null | yes | |
revision | string or null | yes | |
currentRevision | string | yes | Opaque revision: dot-joined counters. |
cnameTarget | string or null | yes | |
blocker | object or object or null | yes | |
warnings | array of object | yes | |
warnings[].code | string | yes | one of "proxy_cname_not_served", "proxy_certificate_replacement_failing" |
warnings[].params | object | no | |
evidence | object | yes | |
evidence.certificate | object | yes | |
evidence.certificate.state | string | yes | one of "none", "pending", "ready", "failed", "unavailable" |
evidence.certificate.id | string | no | |
evidence.certificate.expiry | string (date-time) | no | UTC, ISO 8601. |
evidence.certificate.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
evidence.route | object | yes | |
evidence.route.state | string | yes | one of "applied", "pending", "inactive", "missing", "unavailable" |
evidence.route.origin | string | no | |
evidence.route.appliedRevision | string | no | |
evidence.route.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
evidence.edge | object | yes | |
evidence.edge.state | string | yes | one of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable" |
evidence.edge.ready | integer | yes | 0 to ∞ |
evidence.edge.total | integer | yes | 0 to ∞ |
evidence.edge.oldestReportAt | string (date-time) or null | yes | |
evidence.edge.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
evidence.dns | object | yes | |
evidence.dns.state | string | yes | one of "confirmed", "pending", "failed", "unknown", "unavailable" |
evidence.dns.desiredSerial | integer | no | 0 to ∞ |
evidence.dns.confirmedSerial | integer | no | 0 to ∞ |
evidence.dns.confirmedAt | string (date-time) | no | UTC, ISO 8601. |
evidence.dns.observedAnswers | array of string | no | |
evidence.dns.observedAt | string (date-time) | no | UTC, ISO 8601. |
evidence.dns.secondariesAtSerial | integer | no | 0 to ∞ |
evidence.dns.secondariesTotal | integer | no | 0 to ∞ |
evidence.dns.secondariesAt | string (date-time) | no | UTC, ISO 8601. |
evidence.dns.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
drainUntil | string (date-time) or null | yes | |
retryAt | string (date-time) or null | yes | |
availableActions | array of string | yes | |
updatedAt | string (date-time) | yes | UTC, ISO 8601. |