API reference · Static hosting
Make a site's previews public or private, or set or remove their password; a new password ends every session
PATCH
/v1/orgs/{org}/zones/{zone}/origins/{origin}/previews- Permission
hosting.previews.manage- Budget
- 60 requests in 60 s per organization, shared as
hosting.changes - Audit log
hosting.previews.update- Operation
hosting.previews.update
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" |
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" |
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
public | boolean | no | |
password | string or null | no |
Response 204
No body.