Create circuit breaker policy

Creates a new circuit breaker policy and immediately activates it in the running gateway. Returns 409 if a policy with the same name already exists.

Request body

namestring required

Unique name for this policy.

enabledboolean

When false, the policy is registered but all hooks skip it.

primary_providerstring required

Provider to monitor (e.g. azure, openai).

primary_modelstring required

Model name as it appears in requests (e.g. gpt-4o-ptu).

primary_key_idsstring[]

API key UUIDs to track individually. Each key gets its own sub-circuit. The main circuit opens only when all listed keys have tripped. Leave empty to use a single shared circuit for all keys serving this provider+model.

fallback_providerstring required

Provider to route to when the circuit is open.

fallback_modelstring required

Model to request from the fallback provider when the circuit is open.

cooldown_headerstring

Response header whose value (in milliseconds) overrides default_cooldown. Falls back to default_cooldown when the header is absent or unparsable.

Response

Policy created