API reference · Static hosting
Whether a deployment is prepared, and what its preparation found
GET
/v1/orgs/{org}/zones/{zone}/origins/{origin}/deployments/{deployment}/report- Permission
hosting.deployments.read- Operation
hosting.deployments.report
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" |
preparation | string | yes | `uploading` while its upload is not complete, `pending` until the worker prepared it, `retrying` once a preparation of it failed and the worker tries again later, then `prepared`. One of "uploading", "pending", "retrying", "prepared" |
preparedAt | string (date-time) or null | yes | |
report | object or null | yes | |
report.rules | object | yes | |
report.rules.problems | array of object | yes | |
report.rules.problems[].file | string | yes | one of "_redirects", "_headers" |
report.rules.problems[].line | integer | yes | 0 to ∞ |
report.rules.problems[].reason | string | yes | |
report.rules.problems[].code | string | no | one of "basic_auth" |
report.hosts | array of object | no | 0 to 100 items |
report.hosts[].host | string | yes | |
report.hosts[].service | object or null | yes | |
report.hosts[].service.name | string | yes | |
report.hosts[].service.operator | string | yes | |
report.hosts[].service.category | string | yes | one of "fonts", "analytics", "tag manager", "video", "maps", "captcha", "script CDN", "social", "chat", "consent", "payments", "marketing", "scheduling" |
report.hosts[].references | array of string | yes | |
report.hosts[].inMarkup | boolean | yes | |
report.hosts[].files | array of string | yes | 0 to 10 items |
report.hosts[].fileCount | integer | yes | more than 0 |
report.hostCount | integer | no | 0 to ∞ |
report.scan | object | no | |
report.scan.files | integer | yes | 0 to ∞ |
report.scan.skipped | array of object | yes | |
report.scan.skipped[].path | string | yes | |
report.scan.skipped[].reason | string | yes | one of "too_large", "limit" |
report.metadata | object | no | |
report.metadata.files | integer | yes | 0 to ∞ |
report.metadata.cleaned | integer | yes | 0 to ∞ |
report.metadata.savedBytes | integer | yes | 0 to ∞ |
report.metadata.skipped | array of object | yes | 0 to 100 items |
report.metadata.skipped[].path | string | yes | |
report.metadata.skipped[].reason | string | yes | one of "malformed", "no_transform", "capacity", "derived_limit", "larger" |
report.metadata.skippedCount | integer | yes | 0 to ∞ |
report.fonts | object | no | |
report.fonts.families | array of object | yes | |
report.fonts.families[].family | string | yes | |
report.fonts.families[].package | string | yes | |
report.fonts.families[].license | string | yes | |
report.fonts.rewritten | integer | yes | 0 to ∞ |
report.fonts.untouched | array of object | yes | 0 to 100 items |
report.fonts.untouched[].path | string | yes | |
report.fonts.untouched[].address | string | yes | |
report.fonts.untouched[].reason | string | yes | one of "text", "effect", "icons", "color", "whole_font", "endpoint", "script", "markup", "syntax", "unknown_family", "unknown_style", "unsupported_axis", "catalog", "limit", "encoding", "integrity", "csp", "base", "no_transform", "capacity", "derived_limit" |
report.fonts.untouchedCount | integer | yes | 0 to ∞ |
encodings | object | yes | |
encodings.pending | integer | yes | 0 to ∞ |
encodings.kept | integer | yes | 0 to ∞ |
encodings.discarded | integer | yes | 0 to ∞ |
encodings.savedBytes | integer | yes | 0 to ∞ |
optimizationPaused | boolean | yes | True while the organization's derived bytes (fonts, cleaned images and Brotli bodies) leave no room under the platform cap `derivedBytes` for what this deployment still waits for: the allowance is spent, or smaller than a file whose Brotli body is still to make. New optimizations wait and the files they would change are served as uploaded, until deletions free room; what was optimized before stays. |