A node's collection items: its own overrides, or — with `?resolved=true` — the effective set after the profile's defaults are overridden by them. The resolved view is what the poller sees.

GET

/api/v1/nodes/{node_id}/collection

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

Authorizations

• bearer

Parameters

Path Parameters

node_id

required

string format: uuid

Node id

Query Parameters

resolved

boolean

Responses

200

The node’s own stored items, or — with ?resolved=true — the effective set the poller sees, which carries no item ids

Media typeapplication/json

One of:

Array

Default: the node’s own overrides, each with its id and scope.

Array

A stored collection item with its id and scope, for the API (the scheduler ignores id).

object

kind

required

Scalar GET vs table walk.

string

Allowed values: scalar table

metric_kind

required

Gauge vs raw counter — rates/utilization are derived at query time (ADR-012), never by the poller.

string

Allowed values: gauge counter

metric_name

required

Stable TSDB metric name (e.g. if_hc_in_octets). Bounded by convention to keep label cardinality controlled — never a free-text/device-supplied value (ADR-011).

string

oid

required

Dotted OID: a scalar instance OID ([CollectionKind::Scalar]) or a table column base ([CollectionKind::Table], the walk root).

string

enabled

required

boolean

id

required

string format: uuid

scope_id

required

string format: uuid

scope_level

required

The scope a threshold is defined at, ordered least → most specific so the derived Ord makes Node win over Group win over Profile.

string

Allowed values: profile group node

Array<object>

?resolved=true: the effective set after profile defaults, as the poller sees it.

Array<object>

One thing to collect: a stable metric name, the OID to collect it from, how to collect it (scalar GET vs table walk), and whether it is a gauge or a raw counter.

object

kind

required

Scalar GET vs table walk.

string

Allowed values: scalar table

metric_kind

required

Gauge vs raw counter — rates/utilization are derived at query time (ADR-012), never by the poller.

string

Allowed values: gauge counter

metric_name

required

Stable TSDB metric name (e.g. if_hc_in_octets). Bounded by convention to keep label cardinality controlled — never a free-text/device-supplied value (ADR-011).

string

oid

required

Dotted OID: a scalar instance OID ([CollectionKind::Scalar]) or a table column base ([CollectionKind::Table], the walk root).

string

Example

[
  {
    "kind": "scalar",
    "metric_kind": "gauge",
    "scope_level": "profile"
  }
]

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 ManageConfig

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 (resolved view only)

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