⌘ K

Початок роботи з API Instatus

Усі ендпоінти доступні за URL 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.