コンテンツにスキップ
Yagra

get_node_status

GET
/api/v1/nodes/{node_id}/status
curl --request GET \
  --url https://example.com/api/v1/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
node_id
required
string format: uuid

Node id

Responses

Section titled “Responses”

200

Section titled “200”

The node’s display state and the alerts attributed to it

Media typeapplication/json

One node’s live status: its display state plus the alerts currently attributed to it, so node detail can show why it is down without re-deriving from the list.

object
alerts
required
Array<object>

A single alert produced by the engine.

object
at_unix_ms
required

When it fired (Unix ms, UTC).

integer format: int64
breach
One of:
null
check
required

The check that produced it.

string format: uuid
flapping
required

Whether the underlying check is currently flapping.

boolean
metric
required

Metric the check measured (e.g. "icmp_rtt_ms"; the liveness sentinel for up/down). Carried for the history log + notification payload so a human can read what fired — not part of alert identity (dedup/grouping ignore it).

string
node
required

What the alert is about: a node’s UUID, or pool:<name> for a poller-pool alert.

string
root_cause
One of:
null
severity
required

Severity (derived from the committed state).

string
Allowed values: info warning critical
state
required

The committed state that triggered the alert.

string
Allowed values: ok warning critical unknown unreachable maintenance
node_id
required

Stable identifier for a monitored node.

A UUID, not a name or address — both of which can change over a node’s life.

string format: uuid
state
required

The current state of a monitored node or check.

string
Allowed values: ok warning critical unknown unreachable maintenance
Example
{
  "alerts": [
    {
      "breach": {
        "direction": "above"
      },
      "severity": "info",
      "state": "ok"
    }
  ],
  "state": "ok"
}

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