health

Health Check

Check the health status of the service.

get/api/v1/health

Request

  • Base URL: https://docs.thedrive.ai (the document declares no server; this is the origin it was published from)
  • URL: https://docs.thedrive.ai/api/v1/health
  • Auth: none declared

Response

Successful Response

status'healthy' | 'degraded' | 'unhealthy' required

Overall status

servicestring

Service name

versionstring required

Service version

checksobject required

Individual component checks

Example response

{
  "checks": {
    "handlers": {
      "message": "7 handlers registered",
      "status": "ok"
    },
    "storage": {
      "status": "ok"
    }
  },
  "service": "the-drive-api",
  "status": "healthy",
  "version": "3.0.0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.