Skip to content

Get a single circuit breaker

GET
/v1/durable/circuit-breakers/{key}
curl --request GET \
--url https://app.everruns.com/api/v1/durable/circuit-breakers/example
key
required
string

Circuit breaker key

Circuit breaker details

Media type application/json

Circuit breaker response

object
failure_count
required

Count of consecutive failures observed within the current rolling window.

integer format: int32
half_open_at

Timestamp the breaker is eligible to transition to half_open and probe again (RFC 3339).

string | null format: date-time
key
required

Stable key identifying the dependency the breaker guards (e.g. provider URL or activity type).

string
last_failure_at

Timestamp of the most recent failure recorded against this breaker (RFC 3339).

string | null format: date-time
opened_at

Timestamp the breaker last transitioned to open (RFC 3339).

string | null format: date-time
state
required

Current breaker state (closed, open, or half_open).

string
success_count
required

Count of consecutive successes observed within the current rolling window.

integer format: int32
updated_at
required

Timestamp when this breaker state was last updated (RFC 3339).

string format: date-time
Example generated
{
"failure_count": 1,
"half_open_at": "2026-04-15T12:00:00Z",
"key": "example",
"last_failure_at": "2026-04-15T12:00:00Z",
"opened_at": "2026-04-15T12:00:00Z",
"state": "example",
"success_count": 1,
"updated_at": "2026-04-15T12:00:00Z"
}

Circuit breaker not found

Media type application/json

Standard error response.

Wire shape is RFC 9457 Problem Details: every error response includes title and status, and may include detail, code, allowed_actions, retry_after_seconds, instance, and type. The content type is rewritten to application/problem+json by [problem_json_content_type].

object
allowed_actions

Recovery actions the caller can take next.

Array<object>

Agent-actionable recovery hint attached to an error response.

object
hint

Short, agent-readable hint (e.g. “Shorten ‘name’ to <= 200 chars.”).

string | null
href

Optional absolute or relative URL the caller may invoke directly.

string | null
operation_id

OpenAPI operationId the caller should invoke to recover.

string | null
rel
required

Link relation describing the action (e.g. retry, get-existing, unarchive, retry-later).

string
code

Stable, machine-readable error code (snake_case).

string | null
detail

Human-readable explanation specific to this occurrence.

string | null
instance

Request URI for this occurrence.

string | null
retry_after_seconds

Seconds the caller should wait before retrying (429 / transient 503).

integer | null format: int32
status
required

HTTP status code; mirrors the response status line.

integer format: int32
title
required

Short, human-readable summary of the problem (e.g. “Not Found”).

string
type

RFC 9457 problem type URI. Optional; identifies the problem class.

string | null
Example generated
{
"allowed_actions": [
{
"hint": "example",
"href": "example",
"operation_id": "example",
"rel": "example"
}
],
"code": "example",
"detail": "example",
"instance": "example",
"retry_after_seconds": 1,
"status": 1,
"title": "example",
"type": "example"
}

Internal server error

Media type application/json

Standard error response.

Wire shape is RFC 9457 Problem Details: every error response includes title and status, and may include detail, code, allowed_actions, retry_after_seconds, instance, and type. The content type is rewritten to application/problem+json by [problem_json_content_type].

object
allowed_actions

Recovery actions the caller can take next.

Array<object>

Agent-actionable recovery hint attached to an error response.

object
hint

Short, agent-readable hint (e.g. “Shorten ‘name’ to <= 200 chars.”).

string | null
href

Optional absolute or relative URL the caller may invoke directly.

string | null
operation_id

OpenAPI operationId the caller should invoke to recover.

string | null
rel
required

Link relation describing the action (e.g. retry, get-existing, unarchive, retry-later).

string
code

Stable, machine-readable error code (snake_case).

string | null
detail

Human-readable explanation specific to this occurrence.

string | null
instance

Request URI for this occurrence.

string | null
retry_after_seconds

Seconds the caller should wait before retrying (429 / transient 503).

integer | null format: int32
status
required

HTTP status code; mirrors the response status line.

integer format: int32
title
required

Short, human-readable summary of the problem (e.g. “Not Found”).

string
type

RFC 9457 problem type URI. Optional; identifies the problem class.

string | null
Example generated
{
"allowed_actions": [
{
"hint": "example",
"href": "example",
"operation_id": "example",
"rel": "example"
}
],
"code": "example",
"detail": "example",
"instance": "example",
"retry_after_seconds": 1,
"status": 1,
"title": "example",
"type": "example"
}