API reference · Static hosting
Give a deployment its preview address without serving it on the hostnames: files complete, rules read
POST
/v1/orgs/{org}/zones/{zone}/origins/{origin}/deployments/{deployment}/preview- Permission
hosting.deployments.manage- Budget
- 60 requests in 60 s per organization, shared as
hosting.changes - Audit log
hosting.deployment.preview- Operation
hosting.deployments.preview
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" |
Idempotency-Key | header | string | no | One key per intended mutation. A retry with the key replays the recorded response instead of executing again; the key with another request answers 422 idempotency_key_reused. For example "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 |
|---|---|---|---|
id | string | yes | for example "dep_01h455vb4pex5vsknk084sn02q" |
zoneId | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
originId | string | yes | for example "origin_01h455vb4pex5vsknk084sn02q" |
status | string | yes | `uploading` until every file is stored, then `ready`: it may be activated. One of "uploading", "ready" |
spa | boolean | yes | |
fileCount | integer | yes | 0 to ∞ |
totalSize | integer | yes | 0 to ∞ |
active | boolean | yes | |
createdAt | string (date-time) | yes | UTC, ISO 8601. |
expiresAt | string (date-time) or null | yes | |
activatedAt | string (date-time) or null | yes | |
previewedAt | string (date-time) or null | yes | |
previews | array of string (uri) | yes |