コンテンツにスキップ
Yagra

Which nodes have (not) reported ICMP within the freshness window — low coverage means the monitoring itself is missing data. Admin-only data source (full inventory).

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Fresh vs total node counts plus the capped stale watchlist

Media typeapplication/json

Fleet data-coverage summary: fresh vs total nodes + the stale watchlist.

object
coverage_pct
required

Percent of nodes reporting fresh data (100 when the inventory is empty).

integer format: int64
fresh
required
integer
stale
required

The stale nodes by name, capped at [STALE_WATCHLIST_MAX]; total - fresh is the real count, so a truncated list is still legible against the totals above it.

Array<object>

A node returning no fresh data (silent failure / blind spot).

object
name
required
string
node_id
required
string format: uuid
total
required
integer
Examplegenerated
{
  "coverage_pct": 1,
  "fresh": 1,
  "stale": [
    {
      "name": "example",
      "node_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "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"
  }
}

503

Section titled “503”

Skeleton mode has no inventory to measure coverage against

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"
  }
}