API reference · Origins and routes
The origins of a zone, alphabetical, with search
GET
/v1/orgs/{org}/zones/{zone}/origins- Permission
origins.origins.read- Operation
origins.origins.list
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
limit | query | integer | no | 1 to 100; default 50 |
cursor | query | string | no | 0 to 200 characters |
q | query | string | no | 0 to 64 characters |
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 |
|---|---|---|---|
items | array of object | yes | |
items[].id | string | yes | for example "origin_01h455vb4pex5vsknk084sn02q" |
items[].zoneId | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
items[].name | string | yes | |
items[].target | object or object or object or object or object | yes | |
items[].target.kind | "address" | yes | |
items[].target.host | string | yes | 1 to 253 characters |
items[].target.scheme | string | yes | one of "https", "http"; default "https" |
items[].target.tlsVerify | boolean | yes | default true |
items[].target.tlsServerName | string or null | yes | default null |
items[].target.hostHeader | string or null | yes | default null |
items[].target.port | integer | yes | 1 to 65535 |
items[].target.connector | string | yes | for example "conn_01h455vb4pex5vsknk084sn02q" |
items[].target.service | string | yes | |
items[].target.deployment | string or null | yes | |
items[].target.allOrganizations | boolean | yes | |
items[].protectionRequired | boolean | yes | |
items[].revision | string | yes | Opaque revision: dot-joined counters. |
items[].createdAt | string (date-time) | yes | UTC, ISO 8601. |
items[].updatedAt | string (date-time) | yes | UTC, ISO 8601. |
nextCursor | string or null | yes |