Get System Health Status

Description: Gets system health status report.

Note

Only admins can see detailed status of the services. Non-admin users can only see the general status of Pipelines services.

Security: Requires a valid user

Usage: GET api/v1/system/health

Consumes: application/json

Query Parameters: None

Produces: application/json

Sample Response (Admins):

{
    "isHealthy": true,
    "timestamp": "2021-04-19T10:28:08.788Z",
    "services": [
        {
            "name": "RabbitMQ HTTPS",
            "healthCheckEnabled": true,
            "isHealthy": true,
            "timestamp": "2021-04-19T10:28:08.626Z"
        },
        {
            "name": "RabbitMQ AMQPS",
            "healthCheckEnabled": true,
            "isHealthy": true,
            "timestamp": "2021-04-19T10:28:08.788Z"
        },
        {
            "name": "PostgresDB",
            "healthCheckEnabled": true,
            "isHealthy": true,
            "timestamp": "2021-04-19T10:27:09.653Z"
        },
        {
            "name": "Vault",
            "healthCheckEnabled": true,
            "isHealthy": true,
            "timestamp": "2021-04-19T10:28:08.619Z"
        },
        {
            "name": "Artifactory (Access)",
            "healthCheckEnabled": true,
            "isHealthy": true,
            "timestamp": "2021-04-19T10:27:08.979Z"
        }
    ]
}

Sample Response (Non-Admins):

{"status":"OK"}

Response Codes:

200: Success