Node pools

Create a node pool

Hosted Clusters. Creates node_count Machines of machine_type in the Cluster’s Region, each joined as a node, and returns the creation Operation; it succeeds once every node is ready. Machine creation needs an active billing account; the first cx23 of a person is the free trial. An unknown machine type or location is refused here (400, 422). Billing, quota and provider refusals fail the Operation instead: error.reason is billing-required, quota-exceeded, service-disabled or provider-refused, and error.message says what to do. Adding one Akua server is a pool of size 1.

POST

clusters

{id}

node_pools

Create a node pool

curl --request POST \
  --url https://api.akua.dev/v1/clusters/{id}/node_pools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "machine_type": "cx23",
  "node_count": 5,
  "locations": [
    "<string>"
  ],
  "image": "ubuntu-24.04",
  "labels": {
    "workload-class": "web"
  }
}
'

import requests

url = "https://api.akua.dev/v1/clusters/{id}/node_pools"

payload = {
    "machine_type": "cx23",
    "node_count": 5,
    "locations": ["<string>"],
    "image": "ubuntu-24.04",
    "labels": { "workload-class": "web" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    machine_type: 'cx23',
    node_count: 5,
    locations: ['<string>'],
    image: 'ubuntu-24.04',
    labels: {'workload-class': 'web'}
  })
};

fetch('https://api.akua.dev/v1/clusters/{id}/node_pools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.akua.dev/v1/clusters/{id}/node_pools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'machine_type' => 'cx23',
    'node_count' => 5,
    'locations' => [
        '<string>'
    ],
    'image' => 'ubuntu-24.04',
    'labels' => [
        'workload-class' => 'web'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.akua.dev/v1/clusters/{id}/node_pools"

	payload := strings.NewReader("{\n  \"machine_type\": \"cx23\",\n  \"node_count\": 5,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"image\": \"ubuntu-24.04\",\n  \"labels\": {\n    \"workload-class\": \"web\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.akua.dev/v1/clusters/{id}/node_pools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"machine_type\": \"cx23\",\n  \"node_count\": 5,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"image\": \"ubuntu-24.04\",\n  \"labels\": {\n    \"workload-class\": \"web\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/clusters/{id}/node_pools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"machine_type\": \"cx23\",\n  \"node_count\": 5,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"image\": \"ubuntu-24.04\",\n  \"labels\": {\n    \"workload-class\": \"web\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "organization_id": "<string>",
  "owner_type": "install",
  "owner_id": "<string>",
  "parent_operation_id": "<string>",
  "state": "RUNNING",
  "done": true,
  "html_url": "https://akua.dev/installs/inst_j572abc123def456?tab=operations",
  "metadata": {
    "type": "machine.create",
    "workspace_id": "<string>",
    "instance_type": "<string>",
    "managed": true,
    "request_fingerprint": "<string>",
    "cluster_id": "<string>",
    "compute_config_id": "<string>"
  },
  "response": {
    "type": "machine.create",
    "machine_id": "<string>",
    "provider_id": "<string>"
  },
  "error": {
    "message": "<string>",
    "code": 123,
    "reason": "billing-required"
  },
  "last_error": {
    "message": "<string>",
    "step_name": "<string>"
  },
  "started_at": 1,
  "completed_at": 1,
  "steps": [
    {
      "name": "<string>",
      "status": "pending",
      "execution_type": "system",
      "started_at": 1,
      "completed_at": 1,
      "error_message": "<string>",
      "retryable": true,
      "skippable": true
    }
  ]
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unauthorized",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "NotFound",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Conflict",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Gone",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unprocessable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "TooManyRequests",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "InternalServerError",
  "success": false,
  "errors": [
    {
      "code": 7009,
      "message": "Internal server error"
    }
  ],
  "result": {}
}

{
  "_tag": "ExternalServiceError",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ServiceUnavailable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "GatewayTimeout",
  "success": false,
  "errors": [],
  "result": {}
}

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

string

required

Required string length: 3 - 54

Query Parameters

node_pool_id

string

required

A DNS label of at most 40 characters, unique in the Cluster. Every node of the pool carries it as the label akua.dev/node-pool.

Pattern: ^[a-z](?:[-a-z0-9]{0,38}[a-z0-9])?$

Example:

"default"

Body

application/json

machine_type

string

required

Server type Akua orders for each node, in the Cluster’s Region. The free trial covers one cx23.

Pattern: ^[a-z][a-z0-9-]{0,31}$

Example:

"cx23"

node_count

integer

required

Number of nodes the pool keeps, 0 to 10 at launch.

Required range: 0 <= x <= 10

locations

string[]

Where the pool places its Machines in the Cluster’s Region; empty lets Akua choose. One location at launch.

Maximum array length: 1

Pattern: ^[a-z][a-z0-9-]{1,31}$

image

enum<string>

default:ubuntu-24.04

Available options:

ubuntu-24.04

labels

object

Show child attributes

Example:

{ "workload-class": "web" }

Response

Node pool creation accepted

string

required

Required string length: 2 - 192

workspace_id

string | null

required

Required string length: 1 - 53

organization_id

string | null

required

Required string length: 1 - 54

owner_type

enum<string>

required

Domain entity collection the operation acts on.

Available options:

install,

repository_change_request,

repository,

workspace,

machine,

cluster,

node_pool,

package,

sandbox,

opencode

owner_id

string

required

Prefixed ID of the entity this operation acts on. Prefix matches owner_type (ws_, mch_, clu_, pkg_, inst_, rcr_, repo_, sbx_, oc_); a node pool is clu_<id>/node_pools/<node pool id>.

parent_operation_id

string | null

required

ID of the chained parent operation, when present.

Required string length: 2 - 192

state

enum<string>

required

Lifecycle state. Past-participle terminal states per AIP-216.

Available options:

RUNNING,

SUCCEEDED,

FAILED,

CANCELLED

done

boolean

required

True iff state is a terminal value.

html_url

string<uri>

required

Deep link to the dashboard view of this operation's owning resource when available, otherwise the operation detail page.

Maximum string length: 2048

Example:

"https://akua.dev/installs/inst_j572abc123def456?tab=operations"

metadata

object

required

Show child attributes

response

object

required

Populated only when done && state === "SUCCEEDED". Discriminated by type.

Show child attributes

error

object | null

required

Populated when state is FAILED or CANCELLED.

Show child attributes

last_error

object | null

required

Latest error from any failed step. Populated even mid-flight; cleared when the step succeeds on retry.

Show child attributes

started_at

integer

required

Unix timestamp (seconds)

Required range: x >= 0

completed_at

integer | null

required

Unix timestamp (seconds)

Required range: x >= 0

steps

object[]

Show child attributes

Create a node pool

curl --request POST \
  --url https://api.akua.dev/v1/clusters/{id}/node_pools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "machine_type": "cx23",
  "node_count": 5,
  "locations": [
    "<string>"
  ],
  "image": "ubuntu-24.04",
  "labels": {
    "workload-class": "web"
  }
}
'

import requests

url = "https://api.akua.dev/v1/clusters/{id}/node_pools"

payload = {
    "machine_type": "cx23",
    "node_count": 5,
    "locations": ["<string>"],
    "image": "ubuntu-24.04",
    "labels": { "workload-class": "web" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    machine_type: 'cx23',
    node_count: 5,
    locations: ['<string>'],
    image: 'ubuntu-24.04',
    labels: {'workload-class': 'web'}
  })
};

fetch('https://api.akua.dev/v1/clusters/{id}/node_pools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.akua.dev/v1/clusters/{id}/node_pools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'machine_type' => 'cx23',
    'node_count' => 5,
    'locations' => [
        '<string>'
    ],
    'image' => 'ubuntu-24.04',
    'labels' => [
        'workload-class' => 'web'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.akua.dev/v1/clusters/{id}/node_pools"

	payload := strings.NewReader("{\n  \"machine_type\": \"cx23\",\n  \"node_count\": 5,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"image\": \"ubuntu-24.04\",\n  \"labels\": {\n    \"workload-class\": \"web\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.akua.dev/v1/clusters/{id}/node_pools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"machine_type\": \"cx23\",\n  \"node_count\": 5,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"image\": \"ubuntu-24.04\",\n  \"labels\": {\n    \"workload-class\": \"web\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/clusters/{id}/node_pools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"machine_type\": \"cx23\",\n  \"node_count\": 5,\n  \"locations\": [\n    \"<string>\"\n  ],\n  \"image\": \"ubuntu-24.04\",\n  \"labels\": {\n    \"workload-class\": \"web\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "organization_id": "<string>",
  "owner_type": "install",
  "owner_id": "<string>",
  "parent_operation_id": "<string>",
  "state": "RUNNING",
  "done": true,
  "html_url": "https://akua.dev/installs/inst_j572abc123def456?tab=operations",
  "metadata": {
    "type": "machine.create",
    "workspace_id": "<string>",
    "instance_type": "<string>",
    "managed": true,
    "request_fingerprint": "<string>",
    "cluster_id": "<string>",
    "compute_config_id": "<string>"
  },
  "response": {
    "type": "machine.create",
    "machine_id": "<string>",
    "provider_id": "<string>"
  },
  "error": {
    "message": "<string>",
    "code": 123,
    "reason": "billing-required"
  },
  "last_error": {
    "message": "<string>",
    "step_name": "<string>"
  },
  "started_at": 1,
  "completed_at": 1,
  "steps": [
    {
      "name": "<string>",
      "status": "pending",
      "execution_type": "system",
      "started_at": 1,
      "completed_at": 1,
      "error_message": "<string>",
      "retryable": true,
      "skippable": true
    }
  ]
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unauthorized",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "NotFound",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Conflict",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Gone",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unprocessable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "TooManyRequests",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "InternalServerError",
  "success": false,
  "errors": [
    {
      "code": 7009,
      "message": "Internal server error"
    }
  ],
  "result": {}
}

{
  "_tag": "ExternalServiceError",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ServiceUnavailable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "GatewayTimeout",
  "success": false,
  "errors": [],
  "result": {}
}