API reference · Static hosting
Selection, publication, delivery and domain readiness of a deployment
GET
/v1/orgs/{org}/zones/{zone}/origins/{origin}/deployments/{deployment}/status- Permission
hosting.deployments.read- Operation
hosting.deployments.status
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
origin | path | string | yes | for example "origin_01h455vb4pex5vsknk084sn02q" |
deployment | path | string | yes | for example "dep_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 |
|---|---|---|---|
deploymentId | string | yes | for example "dep_01h455vb4pex5vsknk084sn02q" |
uploaded | boolean | yes | |
prepared | boolean | yes | |
selection | object | yes | |
selection.selected | boolean | yes | |
selection.selectedAt | string (date-time) or null | yes | |
selection.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
domains | array of object | yes | |
domains[].url | string (uri) | yes | |
domains[].hostnameId | string | yes | for example "hostname_01h455vb4pex5vsknk084sn02q" |
domains[].name | string | yes | |
domains[].mode | string | yes | one of "off", "prepared", "enabled" |
domains[].phase | string | yes | one of "configured", "preparing", "ready", "awaiting_dns", "enabling", "enabled", "disabling" |
domains[].publication | object | yes | |
domains[].publication.state | string | yes | one of "published", "missing", "unselected" |
domains[].publication.sequence | integer or null | yes | |
domains[].publication.missingResources | integer | yes | 0 to ∞ |
domains[].publication.publishedAt | string (date-time) or null | yes | |
domains[].publication.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
domains[].delivery | object | yes | |
domains[].delivery.state | string | yes | one of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable" |
domains[].delivery.ready | integer | yes | 0 to ∞ |
domains[].delivery.total | integer | yes | 0 to ∞ |
domains[].delivery.oldestReportAt | string (date-time) or null | yes | |
domains[].delivery.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
domains[].serving | object | yes | |
domains[].serving.state | string | yes | one of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable" |
domains[].serving.ready | integer | yes | 0 to ∞ |
domains[].serving.total | integer | yes | 0 to ∞ |
domains[].serving.oldestReportAt | string (date-time) or null | yes | |
domains[].serving.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
domains[].delivered | boolean | yes | |
domains[].live | boolean | yes | |
domains[].certificate | object | yes | |
domains[].certificate.state | string | yes | one of "none", "pending", "ready", "failed", "unavailable" |
domains[].certificate.id | string | no | |
domains[].certificate.expiry | string (date-time) | no | UTC, ISO 8601. |
domains[].certificate.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
domains[].route | object | yes | |
domains[].route.state | string | yes | one of "applied", "pending", "inactive", "missing", "unavailable" |
domains[].route.origin | string | no | |
domains[].route.appliedRevision | string | no | |
domains[].route.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
domains[].dns | object | yes | |
domains[].dns.state | string | yes | one of "confirmed", "pending", "failed", "unknown", "unavailable" |
domains[].dns.desiredSerial | integer | no | 0 to ∞ |
domains[].dns.confirmedSerial | integer | no | 0 to ∞ |
domains[].dns.confirmedAt | string (date-time) | no | UTC, ISO 8601. |
domains[].dns.observedAnswers | array of string | no | |
domains[].dns.observedAt | string (date-time) | no | UTC, ISO 8601. |
domains[].dns.secondariesAtSerial | integer | no | 0 to ∞ |
domains[].dns.secondariesTotal | integer | no | 0 to ∞ |
domains[].dns.secondariesAt | string (date-time) | no | UTC, ISO 8601. |
domains[].dns.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
domains[].domainReady | boolean | yes | |
domains[].domainObservedAt | string (date-time) or null | yes | |
previewState | string | yes | one of "unrequested", "unavailable", "pending", "ready" |
previews | array of object | yes | |
previews[].url | string (uri) | yes | |
previews[].hostnameId | string | yes | for example "hostname_01h455vb4pex5vsknk084sn02q" |
previews[].name | string | yes | |
previews[].mode | string | yes | one of "off", "prepared", "enabled" |
previews[].phase | string | yes | one of "configured", "preparing", "ready", "awaiting_dns", "enabling", "enabled", "disabling" |
previews[].publication | object | yes | |
previews[].publication.state | string | yes | one of "published", "missing", "unselected" |
previews[].publication.sequence | integer or null | yes | |
previews[].publication.missingResources | integer | yes | 0 to ∞ |
previews[].publication.publishedAt | string (date-time) or null | yes | |
previews[].publication.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
previews[].delivery | object | yes | |
previews[].delivery.state | string | yes | one of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable" |
previews[].delivery.ready | integer | yes | 0 to ∞ |
previews[].delivery.total | integer | yes | 0 to ∞ |
previews[].delivery.oldestReportAt | string (date-time) or null | yes | |
previews[].delivery.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
previews[].serving | object | yes | |
previews[].serving.state | string | yes | one of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable" |
previews[].serving.ready | integer | yes | 0 to ∞ |
previews[].serving.total | integer | yes | 0 to ∞ |
previews[].serving.oldestReportAt | string (date-time) or null | yes | |
previews[].serving.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
previews[].delivered | boolean | yes | |
previews[].live | boolean | yes | |
previews[].certificate | object | yes | |
previews[].certificate.state | string | yes | one of "none", "pending", "ready", "failed", "unavailable" |
previews[].certificate.id | string | no | |
previews[].certificate.expiry | string (date-time) | no | UTC, ISO 8601. |
previews[].certificate.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
previews[].route | object | yes | |
previews[].route.state | string | yes | one of "applied", "pending", "inactive", "missing", "unavailable" |
previews[].route.origin | string | no | |
previews[].route.appliedRevision | string | no | |
previews[].route.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
previews[].dns | object | yes | |
previews[].dns.state | string | yes | one of "confirmed", "pending", "failed", "unknown", "unavailable" |
previews[].dns.desiredSerial | integer | no | 0 to ∞ |
previews[].dns.confirmedSerial | integer | no | 0 to ∞ |
previews[].dns.confirmedAt | string (date-time) | no | UTC, ISO 8601. |
previews[].dns.observedAnswers | array of string | no | |
previews[].dns.observedAt | string (date-time) | no | UTC, ISO 8601. |
previews[].dns.secondariesAtSerial | integer | no | 0 to ∞ |
previews[].dns.secondariesTotal | integer | no | 0 to ∞ |
previews[].dns.secondariesAt | string (date-time) | no | UTC, ISO 8601. |
previews[].dns.checkedAt | string (date-time) | yes | UTC, ISO 8601. |
previews[].domainReady | boolean | yes | |
previews[].domainObservedAt | string (date-time) or null | yes | |
checkedAt | string (date-time) | yes | UTC, ISO 8601. |