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

Liveness probe — process is up and serving requests. No external dependencies checked.

Unauthenticated, so it reveals nothing beyond the status (version and uptime are available to signed-in users on /api/v1/system/info).

Responses

200

Successful Response

application/json

Example ^generated

example

Health Check

Responses

200

Example generated

Example ^generated