Health check

GET

/health

const url = 'https://example.com/health';
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/health

Returns the health status of all infrastructure dependencies: database, Vault, and Redis. Returns HTTP 200 when all components are ok; HTTP 503 when any component is degraded.

Responses

200

All components healthy

application/json

object

status

string

Allowed values: ok degraded

components

object

database

string

Allowed values: ok degraded

vault

string

Allowed values: ok degraded

redis

string

Allowed values: ok degraded

timestamp

string format: date-time

Example

{
  "status": "ok",
  "components": {
    "database": "ok",
    "vault": "ok",
    "redis": "ok"
  }
}

503

One or more components degraded

application/json

object

status

string

Allowed values: degraded

components

object

database

string

Allowed values: ok degraded

vault

string

Allowed values: ok degraded

redis

string

Allowed values: ok degraded

timestamp

string format: date-time

Example

{
  "status": "degraded",
  "components": {
    "database": "ok",
    "vault": "ok",
    "redis": "ok"
  }
}