> ## Documentation Index
> Fetch the complete documentation index at: https://diameterpay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Check the Real-Time Operational Health of the Diameter API

> GET /health — Returns the operational status of the Diameter API and its service dependencies. No authentication required. Use for uptime monitoring.

The health endpoint provides a real-time snapshot of the Diameter API's operational status and the health of its underlying dependencies, such as database connections and external service integrations. No authentication is required, making it suitable for use in infrastructure monitoring, load balancer health probes, and uptime dashboards. A `status` of `ok` confirms all systems are functioning normally.

## Endpoint

```
GET /health
```

**Authentication:** None required.

## Response

Returns **HTTP 200 OK** under normal operating conditions. The response body describes the environment, overall status, and per-dependency health information.

**env** `string`

The environment the API is currently running in. Possible values:

* `local`
* `development`
* `staging`
* `production`
* `test`

**status** `string`

Overall operational status of the API:

* `ok` — all systems healthy
* `error` — one or more dependencies are degraded or unreachable
* `shutting_down` — the API is in the process of shutting down gracefully (e.g. during a deployment)

**info** `object`

An object where each key is a named dependency (e.g. `database`, `cache`) and each value describes that dependency's health status. Present for dependencies that are healthy or informational.

**errors** `object`

An object where each key is a named dependency and each value describes the error condition. Populated only when one or more dependencies are in an unhealthy state.

## Example

```bash cURL theme={null}
curl --request GET \
  --url https://api.diameterpay.com/health
```

### Response — Healthy

```json theme={null}
{
  "env": "production",
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    },
    "cache": {
      "status": "up"
    }
  },
  "errors": {}
}
```

### Response — Degraded

```json theme={null}
{
  "env": "production",
  "status": "error",
  "info": {
    "cache": {
      "status": "up"
    }
  },
  "errors": {
    "database": {
      "status": "down",
      "message": "Connection timeout after 5000ms"
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.