# Начало работы с API Instatus

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

Все эндпоинты находятся по адресу `https://api.instatus.com`. В целом они следуют архитектуре REST.

Все запросы должны быть в формате JSON с заголовком `Content-Type: application/json`.

Ответы API Instatus, включая ошибки, также приходят в формате JSON.

## Аутентификация

Запросы к API Instatus должны передавать API-токен в заголовке Authorization:

Получить API-ключ можно в разделе Настройки пользователя → [Настройки разработчика](https://dashboard.instatus.com/developer)

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

## Как узнать ID страницы
ID страницы можно найти в панели управления:
1. Откройте панель управления.
2. Нажмите правой кнопкой по проекту в левом верхнем углу, чтобы открыть меню.
3. Нажмите **Copy Project ID** — ID страницы скопируется в буфер обмена.

![ID страницы](https://instatus.com/help/page_id.png)

## Ошибки

Все эндпоинты API возвращают код и сообщение в ответах об ошибке.

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

## Значения статусов

Возможные статусы страницы. Это подробный `status`, который возвращает актуальный API (v2 и новее). Устаревший эндпоинт `summary.json` и [уведомления через вебхуки](https://instatus.com/help/ru/webhooks) используют сокращённый набор — только `UP`, `HASISSUES` и `UNDERMAINTENANCE`.

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

Возможные статусы компонента:

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

Возможные статусы инцидента:

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

Возможные статусы обслуживания:

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

## Перейти к эндпоинтам:

- [Страницы статуса](https://instatus.com/help/ru/api/status-pages)
- [Рабочие пространства](https://instatus.com/help/ru/api/workspaces)
- [Компоненты](https://instatus.com/help/ru/api/components)
- [Инциденты](https://instatus.com/help/ru/api/incidents)
- [Обновления инцидентов](https://instatus.com/help/ru/api/incident-updates)
- [Техработы](https://instatus.com/help/ru/api/maintenances)
- [Обновления обслуживания](https://instatus.com/help/ru/api/maintenance-updates)
- [Шаблоны](https://instatus.com/help/ru/api/templates)
- [Общие уведомления](https://instatus.com/help/ru/api/generic-notices)
- [Сбои](https://instatus.com/help/ru/api/outages)
- [Участники команды](https://instatus.com/help/ru/api/teammates)
- [Подписчики](https://instatus.com/help/ru/api/subscribers)
- [Метрики](https://instatus.com/help/ru/api/metrics)
- [Профиль пользователя](https://instatus.com/help/ru/api/user-profile)
- [Публичные данные](https://instatus.com/help/ru/api/public-data)
- [Приватные страницы](https://instatus.com/help/ru/api/private-pages)
- [Группы аудитории](https://instatus.com/help/ru/api/audience-groups)
- [Мониторы](https://instatus.com/help/ru/api/monitors)
- [Интеграции мониторинга](https://instatus.com/help/ru/api/monitoring-integrations)
- [Правила маршрутизации](https://instatus.com/help/ru/api/routing-rules)
- [Политики эскалации](https://instatus.com/help/ru/api/escalation-policies)
- [Графики дежурств](https://instatus.com/help/ru/api/on-call-schedules)