Healthcheck

GET

/health

const url = 'https://your-tenant-host/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://your-tenant-host/health

Unauthenticated. Returns 503 when the database cannot be reached, so a load balancer can act on it.

Responses

200

The API and its database are reachable.

application/json

object

status

required

Open: accept a member not listed. Known: ok, degraded.

string

database

required

Open: accept a member not listed. Known: up, down.

string

time

required

string format: date-time

Example

{
  "status": "ok",
  "database": "up"
}

503

The database is not reachable.

application/json

object

status

required

Open: accept a member not listed. Known: ok, degraded.

string

database

required

Open: accept a member not listed. Known: up, down.

string

time

required

string format: date-time

Example

{
  "status": "ok",
  "database": "up"
}