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

# OpenAPI spec

A machine-readable OpenAPI 3.1 specification for import into Postman, Insomnia, or code generators.

# OpenAPI spec

A machine-readable OpenAPI 3.1 specification is available for import into Postman, Insomnia, or code generators.

```text URL
https://happyuptime.com/openapi.json
```

```bash cURL
curl https://happyuptime.com/openapi.json | jq .
```

```text Postman import
# In Postman: File → Import → Link
# Paste: https://happyuptime.com/openapi.json
```

## Spec details

- **Format:** OpenAPI 3.1.0
- **Server:** `https://happyuptime.com/api/v1`
- **Auth:** Bearer token (`hu_` prefix)
- **Tags:** Monitors, Incidents, Status Pages, Alerts, Analytics
- **Includes:** All schemas, request/response examples, parameter descriptions

Generate typed clients with tools like [`openapi-typescript`](https://github.com/drwpow/openapi-typescript), [`openapi-generator`](https://openapi-generator.tech/), or Stainless — they'll stay in sync as we ship new endpoints.