Sign in
Kubernetes

Get cluster metrics

Live utilization (CPU, memory, pods, per-node breakdown) plus a 24-hour control-plane health summary. Values refresh every 60 seconds.

get/api/v1/k8s/clusters/{cluster_id}/metrics

Path parameters

cluster_idstring required

Cluster ID (short id, e.g. q7z7zg)

Headers

X-Project-IDstring uuid required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Response

Cluster metrics

successboolean
cpu_used_millicoresinteger
cpu_capacity_millicoresinteger
mem_used_bytesinteger
mem_capacity_bytesinteger
pod_countinteger
pod_capacityinteger
nodes_readyinteger
nodes_totalinteger

Example response

{
  "nodes": [
    {
      "roles": "control-plane,etcd"
    }
  ]
}

Changes

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