Skip to main content
POST
Query Kubernetes pod metrics
For authentication and the other Kubernetes endpoints, see the Public API (V2) overview.

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>

Body

application/json

Query for fetching detailed Kubernetes pod metrics.

site_id
string
required

Site identifier to query pods for.

from
string<date-time>
required

Start of the time range (inclusive).

to
string<date-time>
required

End of the time range (exclusive).

namespaces
string[]

Optional namespace filter. Empty means all namespaces.

pod_name
string

Optional substring of the pod name to match. Empty means all pods.

node_names
string[]

Optional node name filter. Empty means all nodes.

state
null | enum<string>

Optional pod state filter, applied to every snapshot in the time range rather than only the latest.

Available options:
Unknown,
Pending,
Running,
Succeeded,
Failed

Response

One row per pod, ordered by namespace and pod name.

timestamp
string<date-time>
required

Timestamp of the metrics snapshot.

pod_name
string
required

Name of the pod.

pod_namespace
string
required

Kubernetes namespace the pod belongs to.

node_name
string
required

Name of the node this pod is running on.

cpu_usage_nano_cores
number<double>
required

CPU usage in nanocores.

cpu_usage_core_nano_seconds
number<double>
required

Cumulative CPU usage in core-nanoseconds.

memory_rss_bytes
number<double>
required

Resident set size (RSS) memory in bytes.

memory_usage_bytes
number<double>
required

Total memory usage in bytes.

memory_working_set_bytes
number<double>
required

Working set memory in bytes.

memory_page_faults
number<double>
required

Number of page faults.

memory_major_page_faults
number<double>
required

Number of major page faults.

ephemeral_storage_used_bytes
number<double>
required

Ephemeral storage used in bytes.

ephemeral_storage_capacity_bytes
number<double>
required

Ephemeral storage capacity in bytes.

network_rx_bytes
number<double>
required

Network bytes received.

network_tx_bytes
number<double>
required

Network bytes transmitted.

process_count
number<double>
required

Number of running processes.

phase
enum<string>
required

Current phase of the pod lifecycle.

Available options:
Running,
Succeeded,
Pending,
Failed,
Unknown
state
enum<string>
required

Derived pod state based on phase and container statuses.

Available options:
Unknown,
Pending,
Running,
Succeeded,
Failed
containers
object[]
required

Containers running in this pod.

pod_restart_count
integer<u-int32>
required

Total number of container restarts for this pod.

Required range: x >= 0
pod_uptime_seconds
integer<u-int64>
required

Pod uptime in seconds.

Required range: x >= 0