API reference · Proxy
Request a lifecycle mode; accepted with an operation id, never completed inline
PUT/v1/orgs/{org}/zones/{zone}/hostnames/{hostname}/proxy
- Permission
proxy.hostnames.manage- Audit log
proxy.mode.request- Operation
proxy.hostnames.set
Parameters
| Name | In | Type | Required | Notes |
|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_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 |
|---|
mode | string | yes | one of "off", "prepared", "enabled" |
revision | string | yes | Opaque revision: dot-joined counters. |
idempotencyKey | string (uuid) | no | |
acceptHttpsInterruption | boolean | no | |
previousTtl | integer | no | 0 to 86400 |
retry | boolean | no | |
Response 202
| Field | Type | Required | Notes |
|---|
operationId | string (uuid) | yes | |