コンテンツにスキップ
Yagra

Per-group health rollup for the site-matrix / region-rollup / geo-map widgets.

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

View-gated and works without the admin store — the node→group map comes from the shared NodeListing. The client joins these counts to the bounded group tree for names and geo, and sums descendants for the region rollup.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Per-group direct-member state tallies, keyed by group id

Media typeapplication/json

The per-group rollup response: group_id → direct-member state counts.

object
groups
required
object
key
additional properties

Per-group direct-member state tally. All six keys are always present (a missing state is 0) and they sum to the group’s direct-member count.

object
critical
required
integer format: int64
maintenance
required
integer format: int64
ok
required
integer format: int64
unknown
required
integer format: int64
unreachable
required
integer format: int64
warning
required
integer format: int64
Examplegenerated
{
  "groups": {
    "additionalProperty": {
      "critical": 1,
      "maintenance": 1,
      "ok": 1,
      "unknown": 1,
      "unreachable": 1,
      "warning": 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"
  }
}