Skip to main content
GET
/
Health
Get Health Status
curl --request GET \
  --url https://localhost:44371/Health
{
  "status": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "responseTime": 123,
  "services": [
    {
      "name": "<string>",
      "status": "<string>",
      "message": "<string>",
      "responseTime": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.chargeworx.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

Returns a health check response detailing the operational status of the API and its dependencies. Used by infrastructure monitoring tools, load balancers, and orchestration platforms to determine if the API is operational.

​
Input

No input parameters required.

​
Output

Returns a HealthCheckResponse containing the overall health status and individual dependency statuses.

​
Example Request

GET /health

​
Example Response

{
  "status": "Healthy",
  "checks": {
    "database": "Healthy",
    "paymentGateway": "Healthy"
  }
}

​
Errors

  • 503 Service Unavailable — System is unhealthy; critical dependencies are down.
  • 500 Internal Server Error — Unexpected error occurred during health check.

​
Notes

  • Healthy and Degraded states both return HTTP 200.
  • Unhealthy states return HTTP 503.
  • This endpoint does not require authentication (AllowAnonymous).

Response

The system is healthy or degraded.

​
status
string | null
​
timestamp
string<date-time>
​
responseTime
integer<int64>
​
services
object[] | null