Skip to content
/System

System

System endpoints for service health and monitoring

Operations

Health check

Request

The health endpoint provides a real-time status of the API, indicating whether the system is Healthy, Degraded, or Unhealthy based on the performance of recent requests.
Note: The service health calculation includes all Discovery endpoints but excludes Raw Data endpoints.

Security
accessToken
GET
/health
curl -i -X GET \
  https://api.modash.io/v1/health \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Bodyapplication/json
statusstringrequired

API health status:

  • healthy indicates that the system is operating normally.
  • degraded indicates a moderate level of failures or slow responses in one or more endpoints.
  • unhealthy indicates a high level of failures or significant performance issues in one or more endpoints.

Enum:"healthy""degraded""unhealthy"
Example:"healthy"
detailsArray of objects(HealthDetail)required

Health details by endpoint

Example:
[
  {
    "endpoint": "email-search",
    "status": "healthy"
  }
]
Response
{
  "status": "healthy",
  "details": [
    { … }
  ]
}