Skip to main content

GET /v1/health

Returns the health status of the API and its dependencies. This endpoint does not require authentication and is intended for monitoring and uptime checks.

Parameters

No parameters required.

Response

FieldTypeDescription
statusstringOverall API health. One of healthy or degraded.
databasestringDatabase connection status. One of connected or disconnected.
redisstringRedis cache status. One of connected or disconnected.
timestampstringISO 8601 timestamp of the health check.

Examples

curl
curl -X GET "https://api.moxiemetrx.com/v1/health"
Python
import requests

response = requests.get("https://api.moxiemetrx.com/v1/health")
print(response.json())

Response:

{
"status": "healthy",
"database": "connected",
"redis": "connected",
"timestamp": "2026-03-23T12:00:00Z"
}
note

This endpoint is not rate limited and does not require an API key. Use it freely in your health check or monitoring pipelines.