API reference · Static hosting
Who may open a static site's previews, its links and the domains they are served under
GET
/v1/orgs/{org}/zones/{zone}/origins/{origin}/previews- Permission
hosting.deployments.read- Operation
hosting.previews.get
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" |
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 |
|---|---|---|---|
public | boolean | yes | |
password | boolean | yes | |
links | array of object | yes | |
links[].id | string | yes | for example "plink_01h455vb4pex5vsknk084sn02q" |
links[].name | string | yes | 1 to 64 characters |
links[].createdAt | string (date-time) | yes | UTC, ISO 8601. |
links[].expiresAt | string (date-time) or null | yes | |
links[].expired | boolean | yes | |
domains | array of string | yes |