# Get started with Instatus API

Source: https://instatus.com/help/api

All endpoints are under the URL `https://api.instatus.com`. They generally follow the REST architecture.

All requests must be encoded as JSON with the `Content-Type: application/json` header.

Responses from the Instatus API, including errors, are encoded as JSON as well.

## Authentication

Requests to Instatus API must provide an API token through the Authorization header:

You can get your API key from User settings → [Developer settings](https://dashboard.instatus.com/developer)

```bash
Authorization: Bearer <API_KEY>
```

## Get your Page ID
Your Page ID can be found in the dashboard by following these steps:
1. Go to your dashboard.
2. Right-click your project in the top-left corner to open the menu.
3. Click **Copy Project ID** and your page ID is copied to your clipboard.

![Page ID](https://instatus.com/help/page_id.png)

## Errors

All API endpoints contain a code and message within the error responses.

```json
{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}
```

## Status Values

Possible page statuses. This is the granular `status` returned by the current API (v2 and later). The legacy `summary.json` endpoint and [webhook notifications](https://instatus.com/help/webhooks) use a condensed form with only `UP`, `HASISSUES` and `UNDERMAINTENANCE`.

- `UP`
- `HASISSUES`
- `ALLUNDERMAINTENANCE`
- `ALLDEGRADEDPERFORMANCE`
- `ALLPARTIALOUTAGE`
- `ALLMINOROUTAGE`
- `ALLMAJOROUTAGE`
- `SOMEUNDERMAINTENANCE`
- `SOMEDEGRADEDPERFORMANCE`
- `SOMEPARTIALOUTAGE`
- `SOMEMINOROUTAGE`
- `SOMEMAJOROUTAGE`
- `ONEUNDERMAINTENANCE`
- `ONEDEGRADEDPERFORMANCE`
- `ONEPARTIALOUTAGE`
- `ONEMINOROUTAGE`
- `ONEMAJOROUTAGE`

Possible component statuses:

- `OPERATIONAL`
- `UNDERMAINTENANCE`
- `DEGRADEDPERFORMANCE`
- `PARTIALOUTAGE`
- `MAJOROUTAGE`

Possible incident statuses:

- `INVESTIGATING`
- `IDENTIFIED`
- `MONITORING`
- `RESOLVED`

Possible maintenance statuses:

- `NOTSTARTEDYET`
- `INPROGRESS`
- `COMPLETED`

## Jump to endpoints:

- [Status pages](https://instatus.com/help/api/status-pages)
- [Workspaces](https://instatus.com/help/api/workspaces)
- [Components](https://instatus.com/help/api/components)
- [Incidents](https://instatus.com/help/api/incidents)
- [Incident updates](https://instatus.com/help/api/incident-updates)
- [Maintenances](https://instatus.com/help/api/maintenances)
- [Maintenance updates](https://instatus.com/help/api/maintenance-updates)
- [Templates](https://instatus.com/help/api/templates)
- [General notices](https://instatus.com/help/api/generic-notices)
- [Outages](https://instatus.com/help/api/outages)
- [Teammates](https://instatus.com/help/api/teammates)
- [Subscribers](https://instatus.com/help/api/subscribers)
- [Metrics](https://instatus.com/help/api/metrics)
- [User profile](https://instatus.com/help/api/user-profile)
- [Public data](https://instatus.com/help/api/public-data)
- [Private pages](https://instatus.com/help/api/private-pages)
- [Audience groups](https://instatus.com/help/api/audience-groups)
- [Monitors](https://instatus.com/help/api/monitors)
- [Monitoring integrations](https://instatus.com/help/api/monitoring-integrations)
- [Routing rules](https://instatus.com/help/api/routing-rules)
- [Escalation policies](https://instatus.com/help/api/escalation-policies)
- [On-call schedules](https://instatus.com/help/api/on-call-schedules)