Health

BrainEngine's System Health notifications alert you if the BrainEngine platform is not functioning correctly

Overview

BrainEngine's Health API allows external systems to retrieve the health status of the BrainEngine Platform.

Check the status of the BrainEngine Platform

curl -k -X GET "https://localhost:8080/health"

Example Response

{
    "status": "Healthy",
    "totalDuration": "00:00:00.1807254",
    "entries": {
        "V-Blaze": {
            "data": {},
            "description": "",
            "duration": "00:00:00.1804283",
            "status": "Healthy",
            "tags": [
                "services"
            ]
        },
        "Synapse-NLP": {
            "data": {},
            "description": "",
            "duration": "00:00:00.0834219",
            "status": "Healthy",
            "tags": [
                "services"
            ]
        },
        "Synapse-Healthcare": {
            "data": {},
            "description": "",
            "duration": "00:00:00.0827053",
            "status": "Healthy",
            "tags": [
                "services"
            ]
        }
    }
}

HealthChecks UI

https://localhost:8080/healthchecks-ui

Webhooks

BrainEngine supports real-time notifications via webhooks.