Clusters

Cluster management

List clusters

get

Lists all clusters

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters

namestringOptional

Filter by cluster name

binarystringOptional

Filter by binary

disabledbooleanOptional

Filter by disabled status

num_hostsintegerOptional

Filter by number of hosts

num_down_hostsintegerOptional

Filter by number of down hosts

is_upbooleanOptional

Filter by up status

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:

Responses

200

OK

application/json

get

/v3/clusters

HTTPcURLJavaScriptPython

GET /v3/v3/clusters HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "clusters": [
    {
      "name": "text",
      "binary": "text",
      "state": "text",
      "status": "text"
    }
  ]
}

Update cluster

put

Updates a cluster

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Body

application/json

Responses

200

OK

application/json

put

/v3/clusters

HTTPcURLJavaScriptPython

PUT /v3/v3/clusters HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "cluster": {
    "disabled": true,
    "disabled_reason": "text"
  }
}

200

OK

{
  "cluster": {
    "name": "text",
    "binary": "text",
    "state": "text",
    "status": "text",
    "num_hosts": 1,
    "num_down_hosts": 1,
    "last_heartbeat": "2025-11-28T20:20:03.639Z",
    "disabled_reason": "text",
    "created_at": "2025-11-28T20:20:03.639Z",
    "updated_at": "2025-11-28T20:20:03.639Z"
  }
}

List clusters with details

get

Lists all clusters with details

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters

namestringOptional

Filter by cluster name

binarystringOptional

Filter by binary

disabledbooleanOptional

Filter by disabled status

num_hostsintegerOptional

Filter by number of hosts

num_down_hostsintegerOptional

Filter by number of down hosts

is_upbooleanOptional

Filter by up status

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:

Responses

200

OK

application/json

get

/v3/clusters/detail

HTTPcURLJavaScriptPython

GET /v3/v3/clusters/detail HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "clusters": [
    {
      "name": "text",
      "binary": "text",
      "state": "text",
      "status": "text",
      "num_hosts": 1,
      "num_down_hosts": 1,
      "last_heartbeat": "2025-11-28T20:20:03.639Z",
      "disabled_reason": "text",
      "created_at": "2025-11-28T20:20:03.639Z",
      "updated_at": "2025-11-28T20:20:03.639Z"
    }
  ]
}

Show cluster details

get

Shows details for a cluster

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters

cluster_idstring · uuidRequired

The UUID of the cluster

Responses

200

OK

application/json

get

/v3/clusters/{cluster_id}

HTTPcURLJavaScriptPython

GET /v3/v3/clusters/{cluster_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "cluster": {
    "name": "text",
    "binary": "text",
    "state": "text",
    "status": "text",
    "num_hosts": 1,
    "num_down_hosts": 1,
    "last_heartbeat": "2025-11-28T20:20:03.639Z",
    "disabled_reason": "text",
    "created_at": "2025-11-28T20:20:03.639Z",
    "updated_at": "2025-11-28T20:20:03.639Z"
  }
}