Skip to main content
ZStack
Infrastructure/Federation & SSO

ListCircuitBreakerStatuses

List circuit breaker statuses for all registered platforms.

GET/api/v1/platforms/circuit-breakers

Operation ID

ListCircuitBreakerStatuses

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • state
      String

      Current circuit breaker state.

      Example: closed

    • failureCount
      Integer

      Consecutive failure count that contributed to the current state.

      Example: 5

    • lastFailureAt
      String

      Timestamp of the most recent failure that affected the circuit breaker.

      Example: 2026-01-15T08:00:00Z

    • nextRetryAt
      String

      Timestamp when the circuit breaker will attempt its next probe.

      Example: 2026-01-15T08:00:00Z

    • retryAfterSeconds
      Integer

      Seconds to wait before the next retry attempt.

      Example: 30

  • total
    Integer

    Total number of circuit breaker statuses available.

    Example: 10

  • limit
    Integer

    Maximum number of items returned in this page.

    Example: 20

  • offset
    Integer

    Zero-based offset of the first item in this page.

    Example: 20