Error
A valid request URL is required to generate request examples{
"circuits": {}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>"
}
}Circuit Breaker
Get circuit breaker state
Returns a snapshot of all currently-open circuits.
Main circuits are keyed by policy name. Per-key sub-circuits are keyed by "<policy_name>\x00<key_id>".
Circuits not present in the map are closed.
GET
/
api
/
circuit-breaker
/
state
Error
A valid request URL is required to generate request examples{
"circuits": {}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>"
}
}This endpoint is available in Bifrost Enterprise only.
Authorizations
ManagementBearerAuthBasicAuth
Management API authentication for /api/* endpoints. Use the Authorization header
with Bearer <token>, where <token> is one of:
- a Bifrost management API key,
- a dashboard session token issued by
POST /api/session/login, - base64 of
<admin-username>:<admin-password>(legacy equivalent ofBasicAuth).
Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs -
the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.
Response
Successful response
Map of circuit keys to their current state.
Main circuit key: the policy name.
Sub-circuit key: "<policy_name>\x00<key_id>".
Show child attributes
Show child attributes
Was this page helpful?