cluster

get/v1/api/cd/clusters/{id}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/api/cd/clusters/{id}
  • Auth: none declared

Path parameters

idstring required

Response

no description

availability_zonesstring[]

The availability zones this cluster is running in

cpu_totalnumber

The total CPU capacity of the cluster in cores

cpu_utilnumber

The current CPU utilization of the cluster as a percentage

current_versionstring

Current Kubernetes version as reported by the deployment operator

deleted_atstring date-time

Timestamp when this cluster was scheduled for deletion

distro'generic' | 'eks' | 'aks' | 'gke' | 'rke' | 'k3s' | 'openshift'

The distribution of kubernetes this cluster is running (generic, eks, aks, gke, rke, k3s, openshift)

handlestring

A short, unique human readable name used to identify this cluster

idstring

Unique identifier for the cluster

inserted_atstring date-time
installedboolean

Whether the deploy operator has been registered for this cluster

kubelet_versionstring

The lowest discovered kubelet version for all nodes in the cluster

memory_totalnumber

The total memory capacity of the cluster in bytes

memory_utilnumber

The current memory utilization of the cluster as a percentage

metadataobject

Arbitrary JSON metadata to store user-specific state of this cluster

namestring

Human readable name of this cluster, will also translate to cloud k8s name

namespace_countinteger

The number of namespaces in this cluster

node_countinteger

The number of nodes in this cluster

openshift_versionstring

The version of OpenShift this cluster is running, if applicable

pinged_atstring date-time

Timestamp of the last ping from the deploy operator

pod_countinteger

The number of pods in this cluster

project_idstring

ID of the project this cluster belongs to

protectboolean

If true, this cluster cannot be deleted

selfboolean

Whether this is the management cluster itself

updated_atstring date-time
versionstring

Desired Kubernetes version for the cluster

virtualboolean

Whether this is a virtual cluster

Changes

No recorded changes to this operation across all 22 revisions of this API.