Health
Health and readiness endpoints.
The health and readiness endpoints report the status of the gateway instance that handles the request. They are not cluster-wide checks; a request through a load-balanced service may reach any replica.
Health
Return the current health status of the gateway process.
| Method | URL |
|---|---|
GET | /pty/federated-guardrails/v1/health |
Input Fields
None.
Output Fields
| Field | Type | Description |
|---|---|---|
status | string | Gateway process health status. |
Ready
Return the current readiness status of the gateway process, including verification of the YAML policy, scanners, and policy state.
| Method | URL |
|---|---|
GET | /pty/federated-guardrails/v1/ready |
Input Fields
None.
Output Fields
Readiness status indicating whether the YAML policy, scanners, and policy state are acceptable.
Response Codes
The health and readiness endpoints return the following HTTP status codes to indicate the outcome of a request.
| Code | Description |
|---|---|
200 | Request completed successfully. |
503 | The gateway is not ready. |
Feedback
Was this page helpful?