# Uptizm API quickstart

Uptizm checks that websites and APIs are up, opens incidents when they are not, notifies the right people and publishes status pages. The REST API gives a team API key the same monitors, metrics, incidents, status pages, maintenance windows, notification channels, on-call schedules and escalation policies the app uses.

- Base URL: `https://api.uptizm.com/v1`
- Format: JSON in and out. Send `Accept: application/json` so errors come back as JSON.
- Index of every endpoint: https://uptizm.com/llms.txt
- API reference, one Markdown file per resource: https://uptizm.com/docs/api.md
- OpenAPI 3.1 spec: https://uptizm.com/docs/openapi.json

## Four steps

1. Create a key in the app, under **Settings, Team, API keys**. [Authentication](https://uptizm.com/docs/authentication.md) covers the presets and the abilities.
2. Call `GET /me` with the key as a bearer token to check it works and what it can do. [Authentication](https://uptizm.com/docs/authentication.md) shows the request.
3. Create a monitor with `POST /monitors`, optionally from an AI proposal. [Create monitors](https://uptizm.com/docs/create-monitors.md) walks through both ways.
4. Read incidents with `GET /incidents`. The [Incidents API](https://uptizm.com/docs/api/incidents.md) lists every call, and [Pagination](https://uptizm.com/docs/pagination.md) explains how to page through the list.

More guides: [Errors](https://uptizm.com/docs/errors.md), [Rate limits](https://uptizm.com/docs/rate-limits.md), [Idempotency](https://uptizm.com/docs/idempotency.md) and [Anonymous workspaces for agents](https://uptizm.com/docs/anonymous-workspaces.md).