Skip to content
Aether Docs

List clusters

GET
/api/v1/organizations/{orgID}/clusters
 
curl --request GET \
  --url 'https://api.aetherplatform.cloud/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/clusters?limit=50&status=provisioning' \
  --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.

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).

status
string
Allowed values: provisioning running upgrading degraded deleting failed

Filter clusters by status.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A page of clusters.

Media type application/json
object
items
required
Array<object>
object
id
required
string format: uuid
org_id
required
string format: uuid
name
required
string
region
required
string
k8s_version
required
string
status
required
string
Allowed values: provisioning running upgrading degraded deleting failed
status_message
string | null
endpoint
string | null
observed_kubernetes_version

The version aether-operator reports once a rollout settles.

string | null
capi_cluster_name
string | null
keycloak_realm
string | null
harbor_project
string | null
ceph_pool
string | null
lb_subnet
string | null
worker_subnet

The per-cluster worker /24 (read-only; allocated at create time).

string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
next_cursor
string | null
Example 
{
  "items": [
    {
      "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"
      }
    ]
  }
}