API health status

GET

/v1/system/health

Returns health status for API backing services.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

All services healthy.

Bodyapplication/json

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/system/health' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "status": "healthy",
    "timestamp": "2026-04-29T12:00:00.000Z",
    "services": {
        "property1": "string",
        "property2": "string"
    },
    "error": "string"
}

Modified at 2026-05-04 04:11:55

Confirm API connectivity

List programs available to the caller