Skip to main content
POST
/
clusters
/
{id}
/
worker_bootstraps
Create worker bootstrap
curl --request POST \
  --url https://api.akua.dev/v1/clusters/{id}/worker_bootstraps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ttl_seconds": 43230
}
'
{
  "id": "<string>",
  "cluster_id": "<string>",
  "created_at": 1,
  "updated_at": 1,
  "etag": "<string>",
  "expires_at": 1,
  "token": "<string>",
  "command": "<string>",
  "cloud_init": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.akua.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

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_j572abc123def456"

​
idempotency-key
string

Caller-supplied idempotency key. Repeated requests with the same key return the existing resource instead of creating a duplicate. Safe to retry after a timed-out or interrupted request.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

Path Parameters

​
id
string
required
Required string length: 1 - 54

Body

application/json
​
ttl_seconds
integer

Token TTL in seconds (optional).

Required range: 60 <= x <= 86400

Response

Worker bootstrap created

​
id
string
required
Required string length: 1 - 54
​
cluster_id
string
required
Required string length: 1 - 54
​
status
enum<string>
required

Lifecycle state for a one-time worker bootstrap token.

Available options:
active,
revoked,
expired
​
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
​
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
​
etag
string
required
​
expires_at
integer

Unix timestamp (seconds)

Required range: x >= 0
​
token
string

One-time-view bearer token. Populated only on the create response; never returned on subsequent GET/LIST/:revoke reads.

​
command
string

Bash bootstrap command with the token already substituted, ready to run on a worker node. Reveal-on-create only.

​
cloud_init
string

Cloud-init YAML with the token already substituted, ready to use as worker-node user-data. Reveal-on-create only.