Skip to main content
POST
Create a join token

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def4"

idempotency-key
string

Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

Path Parameters

id
string
required
Required string length: 3 - 54

Body

application/json
ttl_seconds
integer
required

Lifetime of the token in seconds.

Required range: 60 <= x <= 86400

Response

Join token and its join command

token
object
required
command
string
required

Sensitive command that joins a server as a node. Returned only here.

expires_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0