- CLI Reference
- Commands
- ironflow circuit-breaker
ironflow circuit-breaker
Manage circuit breakers that protect push endpoints from cascading failures. Circuit breaker state is persisted in the database and is cluster-consistent (consulted at dispatch reservation time).
ironflow circuit-breaker <subcommand> [flags]Aliases: cb
ironflow circuit-breaker list
Section titled “ironflow circuit-breaker list”List all circuit breakers with their function IDs, endpoints, states, and failure counts.
ironflow circuit-breaker list [flags]Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--server | -s | string | Server URL (default: IRONFLOW_SERVER_URL or http://localhost:9123) | |
--json | bool | false | Output as JSON |
Examples:
# List all circuit breakersironflow circuit-breaker list
# JSON outputironflow circuit-breaker list --json
# Custom serverironflow circuit-breaker list -s http://localhost:9000Output columns:
| Column | Description |
|---|---|
| FUNCTION_ID | The function that owns this circuit breaker |
| ENDPOINT | The push endpoint URL being protected |
| STATE | Current state: closed, open, or half-open |
| FAILS | Number of consecutive failures |
| LAST_FAILURE | Timestamp of the most recent failure |
ironflow circuit-breaker reset
Section titled “ironflow circuit-breaker reset”Reset a circuit breaker back to closed state, allowing requests to flow to the endpoint again. Accepts either an endpoint URL or a function ID. If the argument contains :// it is treated as an endpoint URL; otherwise it is treated as a function ID.
ironflow circuit-breaker reset <endpoint-url | function-id> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
endpoint-url | Yes* | The endpoint URL of the breaker to reset |
function-id | Yes* | The function ID of the breaker to reset |
*Provide either an endpoint URL or a function ID.
Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--server | -s | string | Server URL (default: IRONFLOW_SERVER_URL or http://localhost:9123) |
Examples:
# Reset a circuit breaker by endpoint URLironflow circuit-breaker reset https://my-app.example.com/api/handler
# Reset a circuit breaker by function IDironflow circuit-breaker reset my-function-id