Docs

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

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
zonepathstringyesfor example "zone_01h455vb4pex5vsknk084sn02q"
originpathstringyesfor example "origin_01h455vb4pex5vsknk084sn02q"
deploymentpathstringyesfor example "dep_01h455vb4pex5vsknk084sn02q"
x-obhut-management-assignmentheaderstringnoSelect 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

FieldTypeRequiredNotes
deploymentIdstringyesfor example "dep_01h455vb4pex5vsknk084sn02q"
uploadedbooleanyes
preparedbooleanyes
selectionobjectyes
selection.selectedbooleanyes
selection.selectedAtstring (date-time) or nullyes
selection.checkedAtstring (date-time)yesUTC, ISO 8601.
domainsarray of objectyes
domains[].urlstring (uri)yes
domains[].hostnameIdstringyesfor example "hostname_01h455vb4pex5vsknk084sn02q"
domains[].namestringyes
domains[].modestringyesone of "off", "prepared", "enabled"
domains[].phasestringyesone of "configured", "preparing", "ready", "awaiting_dns", "enabling", "enabled", "disabling"
domains[].publicationobjectyes
domains[].publication.statestringyesone of "published", "missing", "unselected"
domains[].publication.sequenceinteger or nullyes
domains[].publication.missingResourcesintegeryes0 to ∞
domains[].publication.publishedAtstring (date-time) or nullyes
domains[].publication.checkedAtstring (date-time)yesUTC, ISO 8601.
domains[].deliveryobjectyes
domains[].delivery.statestringyesone of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable"
domains[].delivery.readyintegeryes0 to ∞
domains[].delivery.totalintegeryes0 to ∞
domains[].delivery.oldestReportAtstring (date-time) or nullyes
domains[].delivery.checkedAtstring (date-time)yesUTC, ISO 8601.
domains[].servingobjectyes
domains[].serving.statestringyesone of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable"
domains[].serving.readyintegeryes0 to ∞
domains[].serving.totalintegeryes0 to ∞
domains[].serving.oldestReportAtstring (date-time) or nullyes
domains[].serving.checkedAtstring (date-time)yesUTC, ISO 8601.
domains[].deliveredbooleanyes
domains[].livebooleanyes
domains[].certificateobjectyes
domains[].certificate.statestringyesone of "none", "pending", "ready", "failed", "unavailable"
domains[].certificate.idstringno
domains[].certificate.expirystring (date-time)noUTC, ISO 8601.
domains[].certificate.checkedAtstring (date-time)yesUTC, ISO 8601.
domains[].routeobjectyes
domains[].route.statestringyesone of "applied", "pending", "inactive", "missing", "unavailable"
domains[].route.originstringno
domains[].route.appliedRevisionstringno
domains[].route.checkedAtstring (date-time)yesUTC, ISO 8601.
domains[].dnsobjectyes
domains[].dns.statestringyesone of "confirmed", "pending", "failed", "unknown", "unavailable"
domains[].dns.desiredSerialintegerno0 to ∞
domains[].dns.confirmedSerialintegerno0 to ∞
domains[].dns.confirmedAtstring (date-time)noUTC, ISO 8601.
domains[].dns.observedAnswersarray of stringno
domains[].dns.observedAtstring (date-time)noUTC, ISO 8601.
domains[].dns.secondariesAtSerialintegerno0 to ∞
domains[].dns.secondariesTotalintegerno0 to ∞
domains[].dns.secondariesAtstring (date-time)noUTC, ISO 8601.
domains[].dns.checkedAtstring (date-time)yesUTC, ISO 8601.
domains[].domainReadybooleanyes
domains[].domainObservedAtstring (date-time) or nullyes
previewStatestringyesone of "unrequested", "unavailable", "pending", "ready"
previewsarray of objectyes
previews[].urlstring (uri)yes
previews[].hostnameIdstringyesfor example "hostname_01h455vb4pex5vsknk084sn02q"
previews[].namestringyes
previews[].modestringyesone of "off", "prepared", "enabled"
previews[].phasestringyesone of "configured", "preparing", "ready", "awaiting_dns", "enabling", "enabled", "disabling"
previews[].publicationobjectyes
previews[].publication.statestringyesone of "published", "missing", "unselected"
previews[].publication.sequenceinteger or nullyes
previews[].publication.missingResourcesintegeryes0 to ∞
previews[].publication.publishedAtstring (date-time) or nullyes
previews[].publication.checkedAtstring (date-time)yesUTC, ISO 8601.
previews[].deliveryobjectyes
previews[].delivery.statestringyesone of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable"
previews[].delivery.readyintegeryes0 to ∞
previews[].delivery.totalintegeryes0 to ∞
previews[].delivery.oldestReportAtstring (date-time) or nullyes
previews[].delivery.checkedAtstring (date-time)yesUTC, ISO 8601.
previews[].servingobjectyes
previews[].serving.statestringyesone of "ready", "pending", "stale", "failing", "empty_pool", "unknown", "unavailable"
previews[].serving.readyintegeryes0 to ∞
previews[].serving.totalintegeryes0 to ∞
previews[].serving.oldestReportAtstring (date-time) or nullyes
previews[].serving.checkedAtstring (date-time)yesUTC, ISO 8601.
previews[].deliveredbooleanyes
previews[].livebooleanyes
previews[].certificateobjectyes
previews[].certificate.statestringyesone of "none", "pending", "ready", "failed", "unavailable"
previews[].certificate.idstringno
previews[].certificate.expirystring (date-time)noUTC, ISO 8601.
previews[].certificate.checkedAtstring (date-time)yesUTC, ISO 8601.
previews[].routeobjectyes
previews[].route.statestringyesone of "applied", "pending", "inactive", "missing", "unavailable"
previews[].route.originstringno
previews[].route.appliedRevisionstringno
previews[].route.checkedAtstring (date-time)yesUTC, ISO 8601.
previews[].dnsobjectyes
previews[].dns.statestringyesone of "confirmed", "pending", "failed", "unknown", "unavailable"
previews[].dns.desiredSerialintegerno0 to ∞
previews[].dns.confirmedSerialintegerno0 to ∞
previews[].dns.confirmedAtstring (date-time)noUTC, ISO 8601.
previews[].dns.observedAnswersarray of stringno
previews[].dns.observedAtstring (date-time)noUTC, ISO 8601.
previews[].dns.secondariesAtSerialintegerno0 to ∞
previews[].dns.secondariesTotalintegerno0 to ∞
previews[].dns.secondariesAtstring (date-time)noUTC, ISO 8601.
previews[].dns.checkedAtstring (date-time)yesUTC, ISO 8601.
previews[].domainReadybooleanyes
previews[].domainObservedAtstring (date-time) or nullyes
checkedAtstring (date-time)yesUTC, ISO 8601.