Health check

GET /health

Check if the service is healthy (available on both backend and collect servers)

Responses

200 application/json

Service is healthy
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null
  
  Health data (collect includes worker metrics)
404 application/json

Endpoint not found
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null
500 application/json

Internal server error
Hide response attributes Show response attributes object
- code integer
- message string
- data object | null
503 application/json

Service is unhealthy (collect service only)
Hide response attributes Show response attributes object
- code integer
  
  HTTP error code
- message string
  
  Error message
- data object
  
  Hide data attributes Show data attributes object
  
  type string
  
  Type of error
  
  Values are validation_error or external_api_error.
  
  errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  key string
  
  Field name that failed validation
  
  message string
  
  Error code or message
  
  value string
  
  Value that failed validation
  
  details
  
  Additional error details

GET /health

curl \
 --request GET 'https://api.your-domain.com/api/health'

Response examples (200)

{
  "code": 200,
  "message": "service healthy",
  "data": {}
}

Response examples (404)

{
  "code": 404,
  "message": "endpoint not found",
  "data": {}
}

Response examples (500)

{
  "code": 500,
  "message": "internal server error",
  "data": {}
}

Response examples (503)

{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}