get_interface_series

GET

/api/v1/nodes/{node_id}/interfaces/{ifindex}/series

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

Authorizations

• bearer

Parameters

Path Parameters

node_id

required

string format: uuid

Node id

ifindex

required

integer format: int32

SNMP ifIndex of the interface

Query Parameters

from

integer format: int64

to

integer format: int64

step

integer format: int64

Responses

200

In/out throughput and error rates on one shared timestamp axis

Media typeapplication/json

Per-interface time-series for the node-detail Interfaces pane: In/Out throughput (bits/sec, from rate() of the octet counters) and In/Out errors (per second).

All four share one timestamps axis — the union of returned points, with null in the gaps — so the chart gets aligned series rather than four independently-indexed ones. Derived at query time (ADR-012); empty when there is no history.

object

in_bps

required

Array<number | null>

in_errors

required

Array<number | null>

out_bps

required

Array<number | null>

out_errors

required

Array<number | null>

timestamps

required

Array<integer>

Example^generated

{
  "in_bps": [
    1
  ],
  "in_errors": [
    1
  ],
  "out_bps": [
    1
  ],
  "out_errors": [
    1
  ],
  "timestamps": [
    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 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"
  }
}