Skip to main content

GET /api/health

Returns the current health status of the API, including database connectivity and basic application metadata. No authentication is required. This endpoint is designed for use with load balancers, uptime monitors, and deployment pipelines that need to verify the service is running correctly.

Authentication

None. This endpoint is publicly accessible.

Parameters

None.

Response

success
boolean
true when the request is processed successfully.
data
object

Errors

This endpoint always returns 200 OK. When the database is unreachable, data.status is degraded and data.database is disconnected — the HTTP status code remains 200 so that health check probes continue to receive a response.

Example

Healthy response

curl -X GET "https://task-forge-gbd6h8gtg8hchve9.chilecentral-01.azurewebsites.net/api/health"
{
  "success": true,
  "data": {
    "status": "healthy",
    "timestamp": "2024-01-15T10:30:00",
    "app_name": "TaskForge API",
    "version": "1.0.0",
    "database": "connected"
  }
}

Degraded response (database unreachable)

{
  "success": true,
  "data": {
    "status": "degraded",
    "timestamp": "2024-01-15T10:30:00",
    "app_name": "TaskForge API",
    "version": "1.0.0",
    "database": "disconnected"
  }
}

Build docs developers (and LLMs) love