Ga naar inhoud
buildinglinksbuildinglinks

Health of a participant

GET
/api/v1/monitoring/participants/{did}
curl --request GET \
  --url https://example.com/api/v1/monitoring/participants/example \
  --cookie bl_authority_session=<bl_authority_session>

Its probes, the components and metrics it reports, and its recent activity.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
did
required
string

The DID of the participant.

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

GET /api/v1/monitoring/participants/{did}: documents the JSON built in [participant].

object
did
required
string
health
required

up, degraded, down or unknown.

string
last_seen_at
string | null format: date-time
version

The connector’s version, from its last heartbeat.

string | null
telemetry_level

health, metrics or activity.

string | null
components

The health of the connector’s components, from its last heartbeat.

object | null
uptime_24h

Share of the probes that found the connector up in the last 24 hours, 0 to 1.

number | null format: double
health_history
required

The last 200 probes, oldest first: at, health, latency_ms.

Array<object>
object
metrics

Shared metrics: negotiations_24h, transfers_24h, dataplane_requests_24h, errors_24h, p95_ms.

object | null
activity
required

The last 100 events.

Array<object>

An event a connector reported (metadata only, never payloads).

object
at
required
string format: date-time
kind
required

E.g. negotiation.finalized, transfer.started.

string
participant_did
required
string
participant_name
string | null
counterparty_did
string | null
counterparty_name
string | null
process_ref
string | null

Example generated

{
  "did": "example",
  "health": "example",
  "last_seen_at": "2026-04-15T12:00:00Z",
  "version": "example",
  "telemetry_level": "example",
  "components": "example",
  "uptime_24h": 1,
  "health_history": [
    {}
  ],
  "metrics": "example",
  "activity": [
    {
      "at": "2026-04-15T12:00:00Z",
      "kind": "example",
      "participant_did": "example",
      "participant_name": "example",
      "counterparty_did": "example",
      "counterparty_name": "example",
      "process_ref": "example"
    }
  ]
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}