Skip to content

Live configuration change feed (SSE): each event's `data` is `{"revision": N}`.

GET
/api/v1/stream/config
curl --request GET \
--url https://example.com/api/v1/stream/config \
--header 'Authorization: Bearer <token>'

Sent once on connect and again, at most once a second, whenever the revision moves. Compare it with the last one seen: a different number means inventory or configuration changed, so re-read what is on screen. The number is process-local and restarts from 0 with the process.

Server-sent event stream; each data is {"revision": N}, sent on connect and whenever configuration changes

Media typetext/event-stream

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
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Role lacks View, or the account is restricted to folders (scope_unsupported)

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
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}