Skip to main content
Skip table of contents

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

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"
    }
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.