Every metric this node is configured to collect or has data for, with the status of each.

GET

/api/v1/nodes/{node_id}/metrics

curl --request GET \
  --url https://example.com/api/v1/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/metrics \
  --header 'Authorization: Bearer <token>'

Answers what there is to look at for a node, including metrics that come from its checks rather than from a collection set and so appear in no collection listing.

Authorizations

• bearer

Parameters

Path Parameters

node_id

required

string format: uuid

Node id

Query Parameters

within_secs

integer format: int64

Responses

200

The node’s metrics, name-ordered

Media typeapplication/json

Array<object>

One metric on one node: what it is, whether it has data, and how it must be read.

object

dimension

required

The dimension a metric’s series carry, which decides how it can be read.

string

Allowed values: none interface entity

metric

required

The TSDB metric name.

string

metric_kind

required

Gauge vs raw counter. A counter’s stored value is an odometer reading, so chart it with rate=true rather than plotting it directly.

string

Allowed values: gauge counter

series_count

required

How many series share this name on this node — the fan-out behind one entry.

integer format: int32

status

required

Whether a metric is configured for collection, has data, or both.

string

Allowed values: ok no_data unconfigured

Example

[
  {
    "dimension": "none",
    "metric_kind": "gauge",
    "status": "ok"
  }
]

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 read 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 node

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

503

Skeleton mode: no write side

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