Update a cluster

PUT

/api/v1/organizations/{orgID}/clusters/{clusterID}

curl --request PUT \
  --url https://api.aetherplatform.cloud/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "k8s_version": "example" }'

Authorizations

• bearerApiToken

Parameters

Path Parameters

orgID

required

string format: uuid

Organization UUID.

clusterID

required

string format: uuid

Cluster UUID.

Request Body ^required

Media type application/json

object

name

string

k8s_version

string

Example ^generated

{
  "name": "example",
  "k8s_version": "example"
}

Responses

200

The updated cluster.

Media type application/json

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

Example

{
  "status": "provisioning"
}

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

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"
      }
    ]
  }
}

409

The resource already exists or conflicts with current state.

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"
      }
    ]
  }
}