Sign in
Kubernetes

Get a Kubernetes cluster

Needs clusters:read on an API key, or any organization role on a session.

get/v1/kubernetes/clusters/{id}

Path parameters

idstring required

Response

The cluster

createdAtstring required
idstring uuid required

Cluster id. It is also the first label of the API server hostname.

kubernetesVersionstring required

Kubernetes version of the control plane and every node, for example v1.37.1.

locationIdstring required

The data center the cluster's nodes run in. A cluster never spans data centers.

namestring required
orgIdstring required
status'creating' | 'ready' | 'updating' | 'degraded' | 'deleting' | 'failed' required

creating: the control plane is being provisioned, and stays creating until it is serving and authorizes the platform's own writes. ready: fully operational. updating: a control-plane change is in progress. degraded: partially operational, for example the control plane stopped serving or its datastore is write-limited. deleting: deletion is in progress and final. failed: an unrecoverable error.

updatedAtstring required

Changes

Changed in 1 of the 40 revisions of this API.1