Circuit Breaker
Check whether a request would be allowed
Evaluates the caller's scope hierarchy (global → tenant → client → policy) and reports whether an open circuit would block the request. Read-only; does not mutate circuit state. Enterprise only.
post/api/v1/circuit-breaker/check
Request
- Base URLhttps://agent.getaxonflow.com
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Authorizationstring required
Example:Basic bXktb3JnOkFYT04tVjIteHh4
OAuth2-style Basic authentication header. Format: Basic base64(clientId:clientSecret)
- clientId: Your organization identifier (required)
- clientSecret: Authentication credential (optional for community mode)
Not required when DEPLOYMENT_MODE=community.
Request body
Response
Check result (allowed, or blocked with the tripping circuit's details)
Changes
No recorded changes to this operation across all 1 revision of this API.