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

GetCircuitBreakerStats

Retrieve aggregated statistics for a platform circuit breaker.

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 statistics are requested.

Responses

200 OK

On success, this API returns the following response structure.

  • platformIdString

    Platform identifier for which these stats are recorded.

    Example: platform-abc123

  • totalRequestsInteger

    Total number of requests processed by the circuit breaker.

    Example: 1000

  • totalSuccessesInteger

    Total number of successful requests.

    Example: 950

  • totalFailuresInteger

    Total number of failed requests.

    Example: 50

  • totalCircuitedInteger

    Total number of requests rejected due to an open circuit.

    Example: 20

  • stateTransitionsInteger

    Total number of state transitions recorded for the circuit.

    Example: 4

Endpoint

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

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

Operation ID

GetCircuitBreakerStats

Permalink

Request Example

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

Response Example

200
{
  "platformId": "platform-abc123",
  "totalRequests": 1000,
  "totalSuccesses": 950,
  "totalFailures": 50,
  "totalCircuited": 20,
  "stateTransitions": 4
}

Change History

This API has no change history records yet.

View all change history