Health Check API

Poll this endpoint to verify that the MIRI API is reachable. The payload is intentionally small so it can be used by monitoring systems and deployment pipelines.

Authentication

(no authentication required)

The health check is public and responds without authentication.

Endpoint

GET /public/v1/health

Response (200 OK)

{
  "success": true,
  "data": {
    "status": "UP",
    "timestamp": "2025-09-19T10:15:23.456Z"
  },
  "message": null,
  "code": "SUCCESS"
}

Response Fields

Field	Type	Description
status	string	UP when the service is responding, DOWN during outages.
timestamp	string	ISO 8601 timestamp of the health snapshot.

Usage Notes

• Non-200 status codes or a status value other than UP indicate that traffic should be paused or retried later.
• Poll on a cadence that matches your monitoring needs (for example, every 30–60 seconds).