Health Check

GET	{{baseUrl}}/orchestrator/api/health/	Reports 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 the success response 200 OK since the API should not be restarted, but the corresponding "services_status" value will be set to Fail.

Response (Success)

JSON

HTTP/1.1 200 OK

Parameters

Name	Type	Description
`version`	string	The API's version.
`auth`	dict	The Keycloak's info.
`services_status`	dict	The external services status.

Example

JSON

{
    "version": "0.10.0",
    "auth": {
        "url": "https://staging.miniapps.ocp.ai/auth",
        "realm": "master",
        "client_id": "ocp"
    },
    "services_status": {
        "redis": "OK",
        "database": "OK"
    }
}