Skip to main content
API Explorer|API Explorer
Infrastructure/Federation & SSO
GETFederationSince 1.0SynchronousAuth Required

GetCircuitBreakerConfig

Retrieve the circuit breaker configuration for a specific platform.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • platformIdStringRequired

    Platform identifier whose circuit breaker configuration is requested.

Responses

200 OK

On success, this API returns the following response structure.

  • failureThresholdInteger

    Number of failures required to open the circuit.

    Example: 5

  • successThresholdInteger

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

    Example: 2

  • initialBackoffSecInteger

    Initial backoff duration in seconds after the circuit first opens.

    Example: 10

  • maxBackoffSecInteger

    Maximum backoff duration in seconds for exponential backoff.

    Example: 300

  • backoffMultiplierLong

    Multiplier applied to backoff duration on each successive circuit open.

    Example: 2

Endpoint

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

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

Operation ID

GetCircuitBreakerConfig

Permalink

Request Example

curl -X GET '{host}/api/v1/platforms/{platformId}/circuit-breaker/config' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "failureThreshold": 5,
  "successThreshold": 2,
  "initialBackoffSec": 10,
  "maxBackoffSec": 300,
  "backoffMultiplier": 2.0
}

Change History

This API has no change history records yet.

View all change history