Skip to main content
ZStack
Infrastructure/Federation & SSO

GetCircuitBreakerConfig

Retrieve the circuit breaker configuration for a specific platform.

GET/api/v1/platforms/{platformId}/circuit-breaker/config

Operation ID

GetCircuitBreakerConfig

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

Path Parameters

  • platformId
    StringRequired

    Platform identifier whose circuit breaker configuration is requested.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • failureThreshold
    Integer

    Number of failures required to open the circuit.

    Example: 5

  • successThreshold
    Integer

    Number of successes required to close the circuit from half-open.

    Example: 2

  • initialBackoffSec
    Integer

    Initial backoff duration in seconds after the circuit first opens.

    Example: 10

  • maxBackoffSec
    Integer

    Maximum backoff duration in seconds for exponential backoff.

    Example: 300

  • backoffMultiplier
    Long

    Multiplier applied to backoff duration on each successive circuit open.

    Example: 2