Skip to main content
GET
/
v1
/
admin
/
providers
/
health
List provider health status
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keystoneos.xyz/v1/admin/providers/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "providers": [
    {
      "name": "<string>",
      "circuit_state": "<string>",
      "failure_count": 123,
      "success_count": 123,
      "last_failure_at": "2023-11-07T05:31:56Z",
      "last_success_at": "2023-11-07T05:31:56Z",
      "last_error": "<string>",
      "config": {
        "failure_threshold": 123,
        "reset_timeout_seconds": 123,
        "half_open_max_calls": 123
      }
    }
  ],
  "overall_status": "<string>"
}

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Response

200 - application/json

Successful Response

Aggregated health information for all providers.

providers
ProviderHealth · object[]
required
overall_status
string
required