Skip to main content
GET
Get cluster metrics
Updated August 24, 2026

Authorizations

X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Headers

X-Project-ID
string<uuid>
required

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

Path Parameters

cluster_id
string
required

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

Response

Cluster metrics

success
boolean
cpu_used_millicores
integer
cpu_capacity_millicores
integer
mem_used_bytes
integer
mem_capacity_bytes
integer
pod_count
integer
pod_capacity
integer
nodes_ready
integer
nodes_total
integer
nodes
object[]
control_plane
object

24-hour control-plane health summary, sampled every minute. Absent until the first sample after the cluster starts running.

Last modified on August 24, 2026