Docs

API reference · Tunnels

Mint a one-time token that enrolls one agent

POST/v1/orgs/{org}/connectors/enrollment-tokens

Mint a one-time token that enrolls one agent. Shown once

Permission
tunnels.connectors.manage
Audit log
tunnels.enrollment_token.create
Operation
tunnels.enrollment_tokens.create

Parameters

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
Idempotency-KeyheaderstringnoOne key per intended mutation. A retry with the key never executes twice; its response carries a secret and is not replayed: a duplicate answers 409 idempotency_outcome_committed. For example "01h455vb4pex5vsknk084sn02q"
x-obhut-management-assignmentheaderstringnoSelect 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

FieldTypeRequiredNotes
ttlHoursintegerno1 to 168; default 24

Response 201

FieldTypeRequiredNotes
idstringyesfor example "tunnel_01h455vb4pex5vsknk084sn02q"
tokenstringyes
expiresAtstring (date-time)yesUTC, ISO 8601.
downloadOriginstring (uri) or nullyes