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

UpdateCircuitBreakerConfig

Update 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 will be updated.

Body Fields

  • failureThresholdIntegerRequired

    Number of failures required to open the circuit.

    Example: 5

  • successThresholdIntegerRequired

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

    Example: 2

  • initialBackoffSecIntegerRequired

    Initial backoff duration in seconds after the circuit first opens.

    Example: 10

  • maxBackoffSecIntegerRequired

    Maximum backoff duration in seconds for exponential backoff.

    Example: 300

  • backoffMultiplierLongRequired

    Multiplier applied to backoff duration on each successive circuit open.

    Example: 2

Responses

200 OK

On success, this API returns an empty JSON object {}.

Endpoint

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

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

Operation ID

UpdateCircuitBreakerConfig

Permalink

Request Example

curl -X PUT '{host}/api/v1/platforms/{platformId}/circuit-breaker/config' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"key": "value"}'

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history