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

GetCircuitBreakerStatus

Retrieve the current circuit breaker status 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 status is requested.

Responses

200 OK

On success, this API returns the following response structure.

  • stateString

    Current circuit breaker state.

    Example: closed

  • failureCountInteger

    Consecutive failure count that contributed to the current state.

    Example: 5

  • lastFailureAtString

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

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

  • nextRetryAtString

    Timestamp when the circuit breaker will attempt its next probe.

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

  • retryAfterSecondsInteger

    Seconds to wait before the next retry attempt.

    Example: 30

Endpoint

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

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

Operation ID

GetCircuitBreakerStatus

Permalink

Request Example

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

Response Example

200
{
  "state": "closed",
  "failureCount": 5,
  "lastFailureAt": "example",
  "nextRetryAt": "example",
  "retryAfterSeconds": 30
}

Change History

This API has no change history records yet.

View all change history