Liveness and DB reachability

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

Responses

200

Successful Response

application/json

HealthResponse

object

status

required

Status

string

Allowed values: ok degraded

database

required

Database

string

Allowed values: ok unreachable

engine_version

Any of:

string
null

string

Example

{
  "database": "ok",
  "engine_version": "0.4.0",
  "status": "ok"
}