Host CPU/load/mem/disk trends for one instance over `[from,to]` at `step`.

GET

/api/v1/system/hosts/{instance}/metrics/range

curl --request GET \
  --url https://example.com/api/v1/system/hosts/example/metrics/range \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Parameters

Path Parameters

instance

required

string

core, or the id of a poller the live registry knows

Query Parameters

from

integer format: int64

to

integer format: int64

step

integer format: int64

Responses

200

Scalar host trends plus a per-mount filesystem trend

Media typeapplication/json

The scalar host trends plus a per-mount filesystem trend, all over one window — one round trip per instance/range change.

object

cpu_pct

required

Array<object>

One point of a time series: Unix-seconds timestamp and value.

object

t

required

Unix timestamp in seconds.

integer format: int64

v

required

Sample value.

number format: double

disks

required

Array<object>

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

mount

required

string

size_bytes

required

Array<object>

One point of a time series: Unix-seconds timestamp and value.

object

t

required

Unix timestamp in seconds.

integer format: int64

v

required

Sample value.

number format: double

used_bytes

required

Array<object>

One point of a time series: Unix-seconds timestamp and value.

object

t

required

Unix timestamp in seconds.

integer format: int64

v

required

Sample value.

number format: double

instance

required

string

load1

required

Array<object>

One point of a time series: Unix-seconds timestamp and value.

object

t

required

Unix timestamp in seconds.

integer format: int64

v

required

Sample value.

number format: double

load15

required

Array<object>

One point of a time series: Unix-seconds timestamp and value.

object

t

required

Unix timestamp in seconds.

integer format: int64

v

required

Sample value.

number format: double

load5

required

Array<object>

One point of a time series: Unix-seconds timestamp and value.

object

t

required

Unix timestamp in seconds.

integer format: int64

v

required

Sample value.

number format: double

mem_total_bytes

required

Array<object>

One point of a time series: Unix-seconds timestamp and value.

object

t

required

Unix timestamp in seconds.

integer format: int64

v

required

Sample value.

number format: double

mem_used_bytes

required

Array<object>

One point of a time series: Unix-seconds timestamp and value.

object

t

required

Unix timestamp in seconds.

integer format: int64

v

required

Sample value.

number format: double

Example^generated

{
  "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
    }
  ]
}

401

No valid bearer token

Media typeapplication/json

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

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role lacks the view permission

Media typeapplication/json

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

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

No such instance — resolved against the known set before any selector is built

Media typeapplication/json

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

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}