Read auth service health

GET

/health

const url = 'https://auth.example.invalid/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://auth.example.invalid/health

GET only. This route permits Origin headers and returns readiness of the HTTP service, not an end-to-end broker health proof.

Responses

200

Successful response.

application/json

object

required

issuer

required

string

>= 1 characters

Example

{
  "ok": true
}

405

JSON error. Route guards run before proof evaluation; parser failures are 400 and byte overflow is 413. An unexpected failure is 400 unless a route handles it separately.

application/json

object

error

required

string

code

string

outcome

string

Allowed values: not-executed executed unknown

Example

{
  "outcome": "not-executed"
}

503

Public admission cap (64 in flight), 10 second request deadline, or a route-specific unavailable read/effect. A service authority 503 may follow a binding; retain the request identity.

application/json

object

error

required

string

code

string

outcome

string

Allowed values: not-executed executed unknown

Example

{
  "outcome": "not-executed"
}