⌘ K

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

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

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

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

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

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

Получить API-ключ можно в разделе Настройки пользователя → Настройки разработчика

Authorization: Bearer <API_KEY>

Как узнать ID страницы

ID страницы можно найти в панели управления:

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

Ошибки

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

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

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

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