API reference · Access
Set the public paths of a guarded hostname against its reviewed origin and revision
PUT/v1/orgs/{org}/access/hostnames/{hostname}
- Permission
access.protection.manage- Audit log
access.hostname.configure- Operation
access.hostnames.configure
Parameters
| Name | In | Type | Required | Notes |
|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
hostname | path | string | yes | for example "hostname_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 |
|---|
zone | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
origin | string | yes | for example "origin_01h455vb4pex5vsknk084sn02q" |
publicPrefixes | array of string | yes | 0 to 32 items |
revision | string or null | yes | |
Response 200
| Field | Type | Required | Notes |
|---|
id | string | yes | for example "hostname_01h455vb4pex5vsknk084sn02q" |
name | string | yes | |
zone | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
origin | string | yes | for example "origin_01h455vb4pex5vsknk084sn02q" |
applications | array of object | yes | |
applications[].id | string | yes | for example "app_01h455vb4pex5vsknk084sn02q" |
applications[].pathPrefixes | array of string | yes | 1 to 16 items |
publicPrefixes | array of string | yes | 0 to 32 items |
lapsedPublicPrefixes | array of string | yes | 0 to 32 items |
revision | string or null | yes | |