Host CPU/load/memory/disk/network trends for one instance over `[from,to]` at `step`.
const url = 'https://example.com/api/v1/system/hosts/example/metrics/range';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/system/hosts/example/metrics/range \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”core, or the id of a poller the live registry knows
Query Parameters
Section titled “Query Parameters”Responses
Section titled “Responses”Scalar host trends, a per-mount filesystem trend, and network traffic per step (interface and core⇄poller bus bytes)
The scalar host trends, a per-mount filesystem trend and the network traffic, all over one window — one round trip per instance/range change.
object
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
A per-mount filesystem trend. The frontend derives % from the pair, or shows a bare-bytes trend
when size_bytes is all zero (the database size proxy has no capacity).
object
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
Network traffic over the same window.
object
Message-payload bytes this component received over the bus during each step. Payload only: protocol framing, TCP/IP and TLS overhead are not included, so this runs slightly below the same messages as seen on the interface.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
Message-payload bytes this component sent over the bus during each step.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
Bytes received on the counted network interfaces during each step. The counted interfaces are the physical ones when the host has any, otherwise every interface except loopback — so for a component running in a bridge-networked container, this is that container’s traffic.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
Bytes sent on the counted network interfaces during each step.
One point of a time series: Unix-seconds timestamp and value.
object
Unix timestamp in seconds.
Sample value.
How many seconds each point covers. This is the step the server actually used, after clamping, which can differ from the one requested.
Examplegenerated
{ "cpu_pct": [ { "t": 1, "v": 1 } ], "disks": [ { "mount": "example", "size_bytes": [ { "t": 1, "v": 1 } ], "used_bytes": [ { "t": 1, "v": 1 } ] } ], "instance": "example", "load1": [ { "t": 1, "v": 1 } ], "load15": [ { "t": 1, "v": 1 } ], "load5": [ { "t": 1, "v": 1 } ], "mem_total_bytes": [ { "t": 1, "v": 1 } ], "mem_used_bytes": [ { "t": 1, "v": 1 } ], "network": { "bus_rx_bytes": [ { "t": 1, "v": 1 } ], "bus_tx_bytes": [ { "t": 1, "v": 1 } ], "nic_rx_bytes": [ { "t": 1, "v": 1 } ], "nic_tx_bytes": [ { "t": 1, "v": 1 } ], "step_secs": 1 }}No valid bearer token
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}Role lacks the view permission
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}No such instance — resolved against the known set before any selector is built
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}