Health of the connector

GET

/healthz

const url = 'https://example.com/healthz';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/healthz

Public, for probes. status is degraded when the database or the evidence log fails: without evidence no protocol message gets through. The components also cover Redis, anchoring, the data plane and the authority. Always answers 200.

Authorizations

None

Responses

200

OK.

application/json

/healthz: documents the JSON built in [healthz].

object

status

required

ok or degraded.

string

did

required

string

version

required

string

components

required

Per component (database, redis, evidence, anchoring, dataplane, authority): ok, degraded or down.

object

key

additional properties

string

Example ^generated

{
  "status": "example",
  "did": "example",
  "version": "example",
  "components": {
    "additionalProperty": "example"
  }
}

Health of the connector

Authorizations

Responses

200

Example generated

Example ^generated