Administration
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.
Circuit Breakers
Return the circuit-breaker status for each configured scanner on this instance.
| Method | URL |
|---|---|
GET | /pty/federated-guardrails/v1/admin/circuit-breakers |
Input Fields
None.
Output Fields
Circuit-breaker status for configured scanners on this instance.
SLA
Report SLA metrics for this instance only, including service availability and latency adherence.
| Method | URL |
|---|---|
GET | /pty/federated-guardrails/v1/admin/sla |
Input Fields
None.
Output Fields
Per-instance SLA metrics, including availability and latency adherence.
Statistics
Return summary metrics from this instance only.
| Method | URL |
|---|---|
GET | /pty/federated-guardrails/v1/admin/stats |
Input Fields
None.
Output Fields
Per-instance summary metrics.
Streaming Latency Estimate
Return per-profile estimated scan latency percentiles for streaming requests handled by this instance.
| Method | URL |
|---|---|
GET | /pty/federated-guardrails/v1/admin/streaming/latency-estimate |
Input Fields
None.
Output Fields
Per-profile estimated P50, P95, and P99 scan latency for this instance.
Response Codes
| Code | Description |
|---|---|
200 | Request completed successfully. |
401 | Authentication is missing or invalid. |
403 | The authenticated user is not authorized. |
500 | The administration operation failed. |
Feedback
Was this page helpful?