Get cluster API Reference

GET

/tenants/{tenant}/clusters/{name}

curl --request GET \
  --url https://api.kupe.cloud/api/v1/tenants/acme/clusters/production \
  --header 'Authorization: <Authorization>'

Retrieve details for a specific managed cluster including its configuration, resource allocations, Kubernetes version, endpoint URL, and current operational status.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

name

required

string

Cluster name

Responses

200

Cluster details

Media type application/json

object

alerts

object

key

additional properties

createdAt

string

displayName

Deprecated: always equal to name (the CRD has no display name; the cluster name is the identifier).

string

highAvailability

boolean

name

string

resourceVersion

string

resources

object

cpu

string

memory

string

storage

string

status

object

conditions

Array<object>

object

key

additional properties

endpoint

string

haConfigured

boolean

haPhase

HAPhase is the consumer-friendly HA rollup. One of pending, ha-healthy, ha-degraded, ha-unavailable. Empty for non-HA clusters.

string

kubernetesVersion

string

metrics

object

key

additional properties

phase

string

version

string

warnings

Warnings is an array of structured advisory messages. Always present (empty array when none). Populated today only by CREATE when a non-blocking advisory applies (e.g. HA_K8S_VERSION_RETIRING when HA is enabled on the oldest supported k8s minor). Each entry shares the same shape as a structured error envelope.

Array<object>

object

code

string

field

string

message

string

severity

string

Example

{
  "createdAt": "2026-02-01T14:00:00Z",
  "displayName": "production",
  "highAvailability": true,
  "name": "production",
  "resourceVersion": "294810",
  "resources": {
    "cpu": "4",
    "memory": "16Gi",
    "storage": "100Gi"
  },
  "status": {
    "endpoint": "https://production.acme.clusters.kupe.cloud",
    "haConfigured": true,
    "haPhase": "ha-healthy",
    "kubernetesVersion": "v1.32.3",
    "phase": "Running"
  },
  "version": "1.32",
  "warnings": [
    {
      "code": "HA_K8S_VERSION_RETIRING",
      "field": "spec.highAvailability",
      "message": "Cluster's Kubernetes version (1.33) is approaching end-of-life on this platform. Plan an upgrade before enabling high availability.",
      "severity": "warning"
    }
  ]
}

Headers

ETag

string

Resource version for optimistic locking

400

Invalid name

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Missing or invalid authentication

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Not a member of this tenant

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

404

Cluster not found

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Rate limit exceeded

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}