API reference · Origins and routes
Add an origin
POST
/v1/orgs/{org}/zones/{zone}/originsAdd an origin. Public addresses only; private networks are reached through a tunnel
- Permission
origins.origins.manage- Audit log
origins.origin.create- Operation
origins.origins.create
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_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 |
|---|---|---|---|
name | string | yes | 1 to 64 characters |
target | object or object or object or object or object | yes | |
target.kind | "address" | yes | |
target.host | string | yes | 1 to 253 characters |
target.scheme | string | no | one of "https", "http"; default "https" |
target.tlsVerify | boolean | no | default true |
target.tlsServerName | string or null | no | default null |
target.hostHeader | string or null | no | default null |
target.port | integer | no | 1 to 65535 |
target.connector | string | yes | for example "conn_01h455vb4pex5vsknk084sn02q" |
target.service | string | yes |
Response 201
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | for example "origin_01h455vb4pex5vsknk084sn02q" |
zoneId | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
name | string | yes | |
target | object or object or object or object or object | yes | |
target.kind | "address" | yes | |
target.host | string | yes | 1 to 253 characters |
target.scheme | string | yes | one of "https", "http"; default "https" |
target.tlsVerify | boolean | yes | default true |
target.tlsServerName | string or null | yes | default null |
target.hostHeader | string or null | yes | default null |
target.port | integer | yes | 1 to 65535 |
target.connector | string | yes | for example "conn_01h455vb4pex5vsknk084sn02q" |
target.service | string | yes | |
target.deployment | string or null | yes | |
target.allOrganizations | boolean | yes | |
protectionRequired | boolean | yes | |
revision | string | yes | Opaque revision: dot-joined counters. |
createdAt | string (date-time) | yes | UTC, ISO 8601. |
updatedAt | string (date-time) | yes | UTC, ISO 8601. |