Skip to main content
Read Kubernetes node and pod metrics with the Public API (V2). All endpoints authenticate with your personal API token, are scoped to a single site_id, and take a from/to time range.

Query node metrics

Returns one NodesRow per node snapshot in the time range.
POST /api/v2/kubernetes/nodes

Request body

FieldTypeRequiredDescription
site_idstringYesSite to query.
fromstring (ISO 8601)YesTime range start (inclusive).
tostring (ISO 8601)YesTime range end (inclusive).
node_namestringNoFilter to a single node. An empty string means no filter.
{
  "site_id": "YOUR-SITE-ID",
  "from": "2026-06-22T00:00:00Z",
  "to": "2026-06-22T01:00:00Z",
  "node_name": ""
}

Response

Returns an array of NodesRow objects, one per node snapshot. Each has these fields:
FieldTypeDescription
timestampstring (ISO 8601)When the snapshot was taken.
node_namestringKubernetes node name.
cpu_usage_nano_coresnumberCPU usage in nanocores.
memory_rss_bytesnumberResident set size (RSS) memory in bytes.
memory_usage_bytesnumberTotal memory usage in bytes.
memory_working_set_bytesnumberWorking set memory in bytes.
memory_page_faultsnumberPage fault count.
memory_major_page_faultsnumberMajor page fault count.
fs_used_bytesnumberFilesystem space used in bytes.
fs_available_bytesnumberFilesystem space available in bytes.
fs_capacity_bytesnumberTotal filesystem capacity in bytes.
fs_inodes_freenumberFree filesystem inode count.
fs_inodes_usednumberUsed filesystem inode count.
fs_inodesnumberTotal filesystem inode count.
network_rx_bytesnumberNetwork bytes received.
network_tx_bytesnumberNetwork bytes transmitted.
phasenumberNode phase, as a numeric value.

Query pod metrics

Returns one PodsRow per pod snapshot in the time range.
POST /api/v2/kubernetes/pods

Request body

FieldTypeRequiredDescription
site_idstringYesSite to query.
fromstring (ISO 8601)YesTime range start (inclusive).
tostring (ISO 8601)YesTime range end (inclusive).
namespacesstring[]NoFilter to these namespaces. Empty means all namespaces.
pod_namestringNoFilter to a single pod. An empty string means no filter.
node_namesstring[]NoFilter to these nodes. Empty means all nodes.
statePodState or nullNoFilter to a single pod state. See pod state.

Response

Returns an array of PodsRow objects, one per pod snapshot. Each has these fields:
FieldTypeDescription
timestampstring (ISO 8601)When the snapshot was taken.
pod_namestringPod name.
pod_namespacestringKubernetes namespace the pod belongs to.
node_namestringNode name this pod runs on.
cpu_usage_nano_coresnumberCPU usage in nanocores.
cpu_usage_core_nano_secondsnumberCumulative CPU usage in core-nanoseconds.
memory_rss_bytesnumberResident set size (RSS) memory in bytes.
memory_usage_bytesnumberTotal memory usage in bytes.
memory_working_set_bytesnumberWorking set memory in bytes.
memory_page_faultsnumberPage fault count.
memory_major_page_faultsnumberMajor page fault count.
ephemeral_storage_used_bytesnumberEphemeral storage used in bytes.
ephemeral_storage_capacity_bytesnumberEphemeral storage capacity in bytes.
network_rx_bytesnumberNetwork bytes received.
network_tx_bytesnumberNetwork bytes transmitted.
process_countnumberRunning process count.
phasePodPhaseCurrent lifecycle phase. See pod phase.
statePodStateDerived pod state. See pod state.
containersContainer[]Containers running in this pod. See container.
pod_restart_countnumberTotal container restarts for this pod.
pod_uptime_secondsnumberPod uptime in seconds.

Query pod overview

Returns pod metadata and status rather than raw metrics, as one PodOverviewRow per pod.
POST /api/v2/kubernetes/pods/overview

Request body

FieldTypeRequiredDescription
site_idstringYesSite to query.
fromstring (ISO 8601)YesTime range start (inclusive).
tostring (ISO 8601)YesTime range end (inclusive).
namespacesstring[]NoFilter to these namespaces. Empty means all namespaces.
querystringNoFree-text search query for filtering pods.

Response

Returns an array of PodOverviewRow objects, one per pod. Each has these fields, which are all required:
FieldTypeDescription
timestampstring (ISO 8601)When the snapshot was taken.
node_namestringNode name this pod runs on.
pod_namestringPod name.
pod_namespacestringKubernetes namespace the pod belongs to.
pod_uuidstringUnique pod identifier.
phasePodPhaseCurrent lifecycle phase. See pod phase.
labelsobjectKubernetes labels attached to the pod.
owner_referencesOwnerReference[]Owner references for this pod. See owner reference.
containersContainer[]Containers running in this pod. See container.
statePodStateDerived pod state. See pod state.
pod_restart_countnumberTotal container restarts for this pod.
pod_uptime_secondsnumberPod uptime in seconds.

Reference

Pod phase

phase is the Kubernetes lifecycle phase: Running, Succeeded, Pending, Failed, or Unknown.

Pod state

state is a derived state combining phase and container statuses: Running, Succeeded, Pending, Failed, or Unknown.

Container

Each entry in containers has a name, a status (Running, Terminated, Waiting, or Unknown), an exit_code (0 means success), and a human-readable reason.

Owner reference

Each entry in owner_references has the owning resource’s name, kind (such as ReplicaSet or DaemonSet), and namespace.