Health APIs

The health endpoint provides the following APIs to get the status of the internals of the Informatics Gateway.

GET /health/

Returns the MONAI Deploy Informatics Gateway service readiness and liveness.

Parameters

N/A

Responses

Response Content Type: JSON

• Healthy: All services are running.
• Unhealthy: One or more services have stopped or crashed.

Code	Description
200	Service is healthy.
503	Service is unhealthy.
500	Server error. The response will be a Problem details object with server error details.

Example Request

curl --location --request GET 'http://localhost:5000/health'

Example Response

{
  "status": "Healthy",
  "checks": [
    {
      "check": "Informatics Gateway Services",
      "result": "Healthy"
    },
    {
      "check": "InformaticsGatewayContext",
      "result": "Healthy"
    },
    {
      "check": "minio",
      "result": "Healthy"
    },
    {
      "check": "Rabbit MQ Subscriber",
      "result": "Healthy"
    },
    {
      "check": "Rabbit MQ Publisher",
      "result": "Healthy"
    }
  ]
}

---

GET /health/status

Returns the MONAI Informatics Gateway service status:

• Active DICOM DIMSE associations
• Internal service status

Parameters

N/A

Responses

Response Content Type: JSON - HealthStatusResponse.

Code	Description
200	Status is available.
500	Server error. The response will be a Problem details object with server error details.

Example Request

curl --location --request GET 'http://localhost:5000/health/status'

Example Response

{
  "activeDimseConnections": 8,
  "services": {
    "Space Reclaimer Service": "Running",
    "DICOM SCP Service": "Running",
    "DICOMweb Export Service": "Running",
    "DICOM Export Service": "Running",
    "Data Retrieval Service": "Running",
    "Workload Manager Notification Service": "Running"
  }
}