Skip to main content
GET
/
machines
List machines
curl --request GET \
  --url https://api.akua.dev/v1/machines \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "cluster_id": "<string>",
      "compute_config_id": "<string>",
      "provider_id": "compute://hcloud/server-1234",
      "provider_resource": {
        "public_ip": "<string>",
        "floating_ip": {
          "id": "<string>",
          "ipv4": "<string>"
        }
      },
      "reconciling": true,
      "created_at": 1,
      "updated_at": 1,
      "etag": "<string>",
      "name": "<string>",
      "current_suspension": {
        "event_id": "<string>",
        "snapshot_ref": {
          "snapshot_id": 123,
          "size_gb": 123
        },
        "expires_at": 1,
        "monthly_cost_cents": 123
      }
    }
  ],
  "has_more": true,
  "next_cursor": "<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"

Query Parameters

​
cursor
string

Pagination cursor from a previous response's next_cursor.

​
limit
integer
default:50

Items per page (1-100, default 50)

Required range: 1 <= x <= 100
Example:

50

​
cluster_id
string
Required string length: 1 - 54
​
state
enum<string>

Machine lifecycle state.

Available options:
ACTIVE,
PROVISIONING,
SUSPENDING,
SUSPENDED,
RESUMING,
DELETING
​
view
enum<string>
default:basic
Available options:
basic,
full

Response

Machine list

​
data
object[]
required
​
has_more
boolean
required

True if more items exist after this page.

​
next_cursor
string | null
required

Opaque cursor for the next page, or null if no more pages.