API Reference on

Health

Mon, 01 Jan 0001 00:00:00 +0000

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.

Administration

Mon, 01 Jan 0001 00:00:00 +0000

Administration endpoints operate on one gateway instance at a time. A request routed through a load-balanced service may reach any replica; these endpoints do not provide cluster-wide state. When an admin token is configured, send Authorization: Bearer <admin-token>. POST, PUT, PATCH, and DELETE requests also require X-Requested-With: XMLHttpRequest.

Reload Policy

Reload the YAML policy on the gateway instance that receives the request.

Method	URL
`POST`	`/pty/federated-guardrails/v1/admin/reload`

Input Fields

None.

Output Fields

Policy reload status.

Policy

Mon, 01 Jan 0001 00:00:00 +0000

Policy endpoints operate on one gateway instance at a time. A request routed through a load-balanced service may reach any replica. Manage YAML policy through Helm values and the gateway ConfigMap; Cedar policy comes from Policy. When an admin token is configured, send Authorization: Bearer <admin-token>. Mutating requests also require X-Requested-With: XMLHttpRequest.

Get YAML Policy

Retrieve the active YAML policy from the gateway instance handling the request. Use the deployment’s Helm values and ConfigMap to manage policy changes.