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

Readiness gate: healthy only once the auth-store DB pool is up — so no /v1 traffic is served before API keys can actually be resolved.

Responses

200

Successful Response

application/json

Response Health Health Get

object

key

additional properties

any

Example^generated

{}

Health check

Responses

200

Examplegenerated

Example^generated