Authenticated health check endpoint

GET /api/v0/health

Authenticated health check endpoint

cURL

curl --request GET \
  --url https://api.devdraft.ai/api/v0/health \
  --header 'x-client-secret: <api-key>'

200

{
  "status": "ok",
  "timestamp": "2023-07-01T12:00:00.000Z",
  "version": "1.0.0",
  "database": "connected",
  "message": "Service is up and running",
  "authenticated": true
}

Authorizations

x-client-secretx-client-key

x-client-secret · string · header · required

Your secret API key. Keep this secure and never expose it in client-side code.

Response

200

application/json

Service is up and running

status · enum<string> · required

Overall health status of the service. Returns "ok" when healthy, "error" when issues detected.

Available options: ok, error

Example:

"ok"

timestamp · string<date-time> · required

ISO 8601 timestamp when the health check was performed.

Example:

"2023-07-01T12:00:00.000Z"

version · string · required

Current version of the API service. Useful for debugging and compatibility checks.

Example:

"1.0.0"

database · enum<string> · required

Database connectivity status. Shows "connected" when database is accessible, "error" when connection fails.

Available options: connected, error

Example:

"connected"

message · string · required

Human-readable message describing the current health status and any issues.

Example:

"Service is up and running"

authenticated · boolean · required

Indicates whether the request was properly authenticated. Always true for this endpoint since authentication is required.

Example:

true