Skip to main content
GET
/
v1
/
apis
/
{api_id}
/
health
Get API health
curl --request GET \
  --url https://api.peel.sh/v1/apis/{api_id}/health \
  --header 'X-API-Key: <api-key>'
{
  "binding_id": "<string>",
  "version_id": "<string>",
  "success_count": 123,
  "error_count": 123,
  "timeout_count": 123,
  "last_success_at": "2023-11-07T05:31:56Z",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "quality_score": 123,
  "endpoints": [
    {
      "endpoint_name": "<string>",
      "success_count": 123,
      "error_count": 123,
      "last_status": "<string>",
      "last_status_code": 123,
      "last_run_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
api_id
string<uuid>
required

Response

API health report.

​
binding_id
string
required
​
version_id
string | null
required
​
status
enum<string>
required
Available options:
healthy,
degraded,
needs_rebuild
​
success_count
integer
required
​
error_count
integer
required
​
timeout_count
integer
required
​
last_success_at
string<date-time> | null
required
​
last_failure_at
string<date-time> | null
required
​
quality_score
number | null
required
​
recommended_action
enum<string>
required
Available options:
none,
rebuild
​
endpoints
object[]
required