GEgetaxonflow
Circuit Breaker

Emergency stop (alias of circuit-breaker trip)

Clearer Article 14 naming for POST /api/v1/circuit-breaker/trip — identical handler, request body, and responses. Enterprise only.

post/api/v1/emergency-stop

Request

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

scope'global' | 'tenant' | 'client' | 'policy'

Blast radius of the stop

scope_idstring

Required for non-global scopes (tenant/client/policy ID)

reason'manual' | 'policy_violation' | 'risk_level' | 'error_rate'
commentstring

Free-text audit-trail comment

duration_minutesinteger

Auto-expire after N minutes; 0 or omitted = indefinite

Response

Emergency stop activated (see the trip endpoint for the body shape)

Changes

No recorded changes to this operation across all 1 revision of this API.