Ga naar inhoud
buildinglinksbuildinglinks

Overview of the dataspace

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

Health of the participants and the activity of the last 24 hours.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

GET /api/v1/monitoring/overview: documents the JSON built in [overview].

object
participants
required

Counts: total, up, degraded, down, suspended.

object
events_24h
required

The events of the last 24 hours, per kind.

object
negotiations_24h
required
integer format: int64
transfers_24h
required
integer format: int64
dataplane_requests_24h
required

As reported by participants that share metrics.

integer format: int64
pending_applications
required
integer format: int64
anchors_24h
required
integer format: int64
series
required

24 hourly buckets, oldest first: at, negotiations, transfers, dataplane_requests.

Array<object>
object

Example generated

{
  "participants": {},
  "events_24h": {},
  "negotiations_24h": 1,
  "transfers_24h": 1,
  "dataplane_requests_24h": 1,
  "pending_applications": 1,
  "anchors_24h": 1,
  "series": [
    {}
  ]
}

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