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.

Request body

Response

Returns an array of NodesRow objects, one per node snapshot. Each has these fields:

Query pod metrics

Returns one PodsRow per pod snapshot in the time range.

Request body

Response

Returns an array of PodsRow objects, one per pod snapshot. Each has these fields:

Query pod overview

Returns pod metadata and status rather than raw metrics, as one PodOverviewRow per pod.

Request body

Response

Returns an array of PodOverviewRow objects, one per pod. Each has these fields, which are all required:

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.