Skip to content
Aether Docs

List node pools

GET
/api/v1/organizations/{orgID}/clusters/{clusterID}/nodepools
 
curl --request GET \
  --url 'https://api.aetherplatform.cloud/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/nodepools?limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
orgID
required
string format: uuid

Organization UUID.

clusterID
required
string format: uuid

Cluster UUID.

Query Parameters

Section titled “Query Parameters ”
cursor
string format: uuid

Opaque cursor (a UUID) for pagination; pass back the prior page’s next_cursor.

limit
integer
default: 50 >= 1 <= 100

Maximum number of items per page (1-100, default 50).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A page of node pools.

Media type application/json
object
items
required
Array<object>
object
id
required
string format: uuid
cluster_id
required
string format: uuid
name
required
string
vcpus
required
integer
memory_gb
required
integer
disk_gb
required
integer
min_nodes
required
integer
max_nodes
required
integer
desired_nodes
required
integer
min_vcpus

Optional per-pool CPU autoscaling budget (total pool vCPUs); max > min ⇒ autoscaling.

integer
max_vcpus

Optional per-pool CPU autoscaling budget (total pool vCPUs); max > min ⇒ autoscaling.

integer
min_memory_gb

Optional per-pool memory autoscaling budget (total pool GB); max > min ⇒ autoscaling.

integer
max_memory_gb

Optional per-pool memory autoscaling budget (total pool GB); max > min ⇒ autoscaling.

integer
node_labels

Labels applied to the pool’s nodes at bootstrap.

object
key
additional properties
string
node_taints

Taints applied to the pool’s nodes at bootstrap (set at create; immutable).

Array<object>
object
key
required
string
value
string
effect
required
string
Allowed values: NoSchedule PreferNoSchedule NoExecute
current_nodes
required
integer
first_ready_at
string | null format: date-time
status
required
string
Allowed values: provisioning ready scaling deleting failed
status_message
string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
next_cursor
string | null
Example 
{
  "items": [
    {
      "node_taints": [
        {
          "effect": "NoSchedule"
        }
      ],
      "status": "provisioning"
    }
  ]
}

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
code
required

A stable, machine-readable error code.

string
message
required
string
details
Array<object>
object
field
required
string
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

404

Section titled “404 ”

The requested resource was not found.

Media type application/json
object
error
required
object
code
required

A stable, machine-readable error code.

string
message
required
string
details
Array<object>
object
field
required
string
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}