Health

Description

Quick “ping” endpoint that reports the operational status of the AutoDriveDDF service. Ideal for monitoring tools, CI/CD health checks, or simple warm-up logic. It does not require authentication, but you may include the same Basic Auth header if your environment restricts anonymous calls.

HTTP Request

GET /health

No path variables, query parameters, or request body.

Authentication

In your REST client (Postman/Insomnia), select Basic Auth and enter your Username and Password.

The client will automatically generate the Authorization: Basic … header for you. Do not add that header manually.

Request Headers

Header	Example	Required	Notes
Accept	`application/json`	–	Ensures JSON response

Example Request (cURL)

curl https://api.autodriveddf.example/health

Success Response `200 OK`

{
  "status": "healthy",
  "timestamp": "2025-06-12T13:45:00Z"
}

status (string): "healthy" if the service is operating normally, otherwise "unhealthy".
timestamp (string): ISO-8601 timestamp of when the health check was performed.

Error Responses

Code	Reason	When it happens	Example Body
401	Unauthorized	Authentication required (if enforced)	`{ "status": "unhealthy", "detail": "Auth required" }`
503	Service Unavailable	The service is down or experiencing issues	`{ "status": "unhealthy", "detail": "Database not reachable" }`
500	Internal Server Error	Unexpected internal failure	`{ "status": "unhealthy", "detail": "Internal error" }`

Next Steps

If you receive "status": "healthy", proceed with your normal API calls. If "unhealthy" or a non-200 error appears, investigate the detail message or alert your operations team.