Skip to content
Yagra

Fleet-wide status summary, computed server-side from the live alert engine (S12).

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

View-gated and works without the admin store, so a public dashboard can render its status-summary / health-ring / nodes-down widgets.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Total node count plus a tally carrying all six states

Media typeapplication/json

Total node count plus a per-state tally.

The states keys are always all six and always sum to total, so a client can index them blind. Shared with the MCP get_fleet_summary tool, which used to build its own version that omitted zeroes.

object
states
required
object
key
additional properties
integer format: int64
total
required
integer format: int64
Examplegenerated
{
  "states": {
    "additionalProperty": 1
  },
  "total": 1
}

401

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

403

Section titled “403”

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