API Reference

HTTP endpoints exposed by each operating mode.

Agent

Default: 0.0.0.0:4241

GET /

Returns the Rezolus version string.

GET /metrics/json

JSON snapshot of all current metric values including counters, gauges, and histograms.

GET /metrics/binary

Msgpack-encoded binary snapshot. Used internally by the exporter, recorder, and hindsight modes.

Default: 0.0.0.0:4242

GET /metrics

Prometheus-format metrics. Histograms converted to summary percentiles as configured.

GET /metrics/json

Proxied JSON metrics from the upstream agent.

GET /metrics/binary

Proxied msgpack metrics from the upstream agent.

Optional HTTP API, default: 0.0.0.0:4242

GET /status

Buffer status including time range of stored data.

GET /dump

Download ring buffer contents as Parquet.

last — Duration window, e.g. ?last=5m

start — Start timestamp, e.g. ?start=2024-01-01T12:00:00Z

end — End timestamp

POST /dump/file

Write ring buffer to the configured output file on disk.

Local web server

GET /api/v1/query

PromQL instant query against the built-in TSDB.

GET /api/v1/query_range

PromQL range query for time-series data.

GET /api/v1/labels

All available label names.

GET /api/v1/label/{name}/values

All values for a specific label.

GET /api/v1/metadata

Time range metadata for the loaded recording.