Report health

POST

/api/v1/telemetry/heartbeat

curl --request POST \
  --url https://example.com/api/v1/telemetry/heartbeat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "version": "example", "level": "example", "health": {}, "metrics": {} }'

A member’s connector reports its health, and metrics if its level includes them.

Authorizations

• dcp

Request Body^required

Media typeapplication/json

object

version

The connector’s version.

string | null

level

health (default), metrics or activity: what the participant shares.

string

health

Health per component: ok or something else.

object

metrics

Counts, only kept from level metrics up.

object

Example ^generated

{
  "version": "example",
  "level": "example",
  "health": {},
  "metrics": {}
}

Responses

200

OK.

Media typeapplication/json

object

received

required

boolean

Example ^generated

{
  "received": true
}

401

Not authenticated.

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

Not an active member.

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