Health Check
This end-point will report on the health of the API and related services.
If one of the services is down but the API is still operational, the response will still return code 200
since the API should not be restarted but the corresponding "services_status" value will be set to Fail
.
GET /api/health/
Successful status: 200 OK
API's and external services' status with some API related info.
Name | Type | Description |
---|---|---|
| string | The API's version |
| dict | The Keycloak's info |
| dict | The external services status |
Example:
{
"version": "0.10.0",
"auth": {
"url": "https://staging.miniapps.ocp.ai/auth",
"realm": "master",
"client_id": "ocp"
},
"services_status": {
"redis": "OK",
"database": "OK"
}
}