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

# API overview

> Authenticate, call, and explore the StatusStack REST API.

The StatusStack API is a REST interface over JSON. Use it to manage stacks, sources, uptime monitors, incidents, and related resources from your own tools.

Base URL: `https://statusstack.com/api`

Versioned operations live under `/v1`. A few unversioned routes (`/health`, `/api-keys`, `/sso/discover`) sit directly on that base.

## Authenticate

Send an API key as a Bearer token. Keys are created in the dashboard under **Settings** → **API Keys**, and most v1 operations require a key scoped to a team.

```bash theme={null}
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://statusstack.com/api/v1/stacks
```

> **[Authentication](https://docs.statusstack.com/api-reference/authentication.md)**
>
> API key permissions, team scope, and MCP credentials.

## What is documented

This reference is generated from the OpenAPI contract (`openapi/api-docs.yaml`, v1.4.0). Only the operations documented here are part of the supported public API; any other endpoint is unstable and may change without a version bump.

Documented groups include:

* **Stacks** — create, update, attach sources and components, export configuration
* **Sources** — catalog and custom sources, components, analytics
* **Website monitors** — URL health checks, pause and resume
* **Incidents** — list, detail, history, and updates
* **Status overrides** and **provider impact** advisories
* **API keys**, **tags**, and **categories**
* **MCP** — manifest, JSON-RPC messages, tools, and resources

`/v1/tickers` still works as a deprecated alias of `/v1/stacks`. Use the stacks paths.

> [!NOTE]
>
> Operations such as activity log, AI summaries, dependencies, and the newer `/v1/monitors` family exist in the product but are not yet in this contract. Treat them as unstable until they appear here.

## Conventions

> **JSON and HTTPS**
>
> Request and response bodies are JSON unless an export returns CSV. Always use HTTPS.

> **Pagination**
>
> List endpoints that paginate accept `page` and `per_page` (default 15, maximum 100 on stacks).

> **IDs**
>
> Resource IDs are UUIDs. Path parameters use names such as `stack_id`, `source_id`, and `monitor_id`.

> **Rate limits**
>
> Versioned v1 operations share a **120 requests per minute** limit and return `429` with `Retry-After`. See [Rate limits](https://docs.statusstack.com/api-reference/rate-limits.md).

> **Errors**
>
> Authentication failures and missing API-key permissions return `{ "error": "..." }`. Most other failures return `{ "message": "..." }` and may include `errors`. See [Errors](https://docs.statusstack.com/api-reference/errors.md).

## Try an endpoint

The pages in this tab include an interactive playground. Create a key, then list the stacks in that team:

```bash theme={null}
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://statusstack.com/api/v1/stacks?per_page=15"
```


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