Liveness probe

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

Responses

200

Process status

application/json

object

status

required

Allowed values: ok ready

Example

{
  "status": "ok"
}

Headers

Cache-Control

string

Allowed value: no-store

Pragma

string

Allowed value: no-cache

408

The configured request deadline elapsed

application/json

object

error

required

Allowed values: invalid_request invalid_token unsupported_grant_type invalid_grant invalid_credential_request invalid_proof invalid_nonce credential_request_denied temporarily_unavailable server_error

error_description

required

string

Example

{
  "error": "invalid_request"
}

Headers

Cache-Control

string

Allowed value: no-store

Pragma

string

Allowed value: no-cache