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

Усі ендпоінти доступні за URL https://api.instatus.com. Загалом вони відповідають архітектурі REST.

Усі запити мають бути закодовані як JSON із заголовком Content-Type: application/json.

Відповіді API Instatus, зокрема помилки, теж закодовані як JSON.

Автентифікація

У запитах до API Instatus потрібно передавати ключ API через заголовок Authorization:

Authorization: Bearer <API_KEY>

Створюйте ключі в панелі керування › Для розробників кнопкою Створити ключ. Ключів може бути кілька, і в кожного своя назва, наприклад «GitHub Actions» чи «Terraform». Ключі починаються з inst_sk_.

Що може ключ

У кожного ключа власні налаштування:

  • Роль: Учасник, Редактор або власна роль на тарифі Business. Роль визначає, що ключ може переглядати й змінювати, так само як і для людей. Ключ не може мати роль Власник, тож оплата, ролі та видалення залишаються за людьми.
  • Доступ: Перегляд і зміни або Лише перегляд. Ключ із доступом «Лише перегляд» нічого не може змінити, хай що дозволяє його роль.
  • Проєкти: усі проєкти, зокрема ті, які ви додасте пізніше, або лише вибрані.
  • Термін дії: дата, коли ключ перестає працювати. На тарифі Free ключ може діяти до 90 днів, на Pro — до 1 року, а на Business і Enterprise — скільки завгодно, зокрема безстроково. Власник команди може задати коротший термін у розділі «Налаштування команди» › «Ключі API». Це не стосується ключів, створених до появи налаштувань ключів, а наявні ключі зберігають свою дату, коли змінюється ваш тариф.
  • Дозволені IP: на тарифі Business ключ працює лише з IP-адрес чи діапазонів, які ви вкажете.

Ключ належить команді або вам:

  • Ключі команди працюють і далі, коли людина, яка їх створила, залишає команду. Використовуйте їх для CI, скриптів та інтеграцій.
  • Особисті ключі діють від вашого імені й ніколи не можуть більше, ніж ви. Їм можна призначити роль Як у вас, і вони перестають працювати, якщо ви залишите команду.

Власники команди задають правила для ключів у розділі «Налаштування команди» › «Ключі API»: найдовший термін дії ключа, чи можуть учасники створювати ключі команди і чи дозволено особисті ключі.

Створення, зміна, перевипуск і відкликання ключа видно в розділі «Активність» команди, як і ключ, відкликаний через витік. Усе, що зроблено через ключ або підключений застосунок, показано там як людина через назва ключа чи застосунку.

Як берегти ключі

  • Ключ показується лише один раз, коли ви його створюєте. Скопіюйте його одразу й зберігайте як секрет.
  • Щоб замінити ключ, відкрийте його й натисніть Перевипустити. Виберіть, скільки ще працюватиме старий ключ, до 7 днів, щоб устигнути оновити все, що його використовує.
  • Відкличте ключ у його меню, і він одразу перестане працювати.

Ключі, створені до появи налаштувань ключів, і далі працюють без змін. У розділі «Для розробників» вони позначені як «Створено до налаштувань ключів», і там можна додати до них обмеження або замінити їх новим ключем.

Помилки ключів

Коли ключ не може виконати запит, помилка містить один із цих кодів, а її повідомлення пояснює, що змінити.

КодСтатусПричина
invalid_key401Такого ключа немає. Перевірте, чи скопіювали його повністю.
key_expired401Термін дії ключа минув.
key_revoked401Ключ відкликано.
key_owner_left401Людина, від імені якої діє особистий ключ, залишила команду.
key_view_only403Ключ має доступ «Лише перегляд», а запит щось змінює.
role_not_allowed403Роль ключа не дозволяє це переглядати чи змінювати.
ip_not_allowed403Запит надійшов з IP-адреси, яку ключ не дозволяє.
page_not_allowed403Ключ не може працювати з цим проєктом.
account_action_not_allowed403Ключі не можуть створювати чи видаляти сторінки, команди або робочі простори. Скористайтеся панеллю керування.
route_not_allowed403Цей маршрут не входить до документованого API.

Отримати ID сторінки

ID сторінки можна знайти в панелі керування, виконавши такі кроки:

  1. Перейдіть до панелі керування.
  2. Клацніть проєкт у верхньому лівому куті правою кнопкою, щоб відкрити меню.
  3. Натисніть Copy Project ID — ID сторінки скопіюється в буфер обміну.
ID сторінки

Помилки

У відповідях з помилками всі ендпоінти API повертають код і повідомлення.

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

Значення статусів

Можливі статуси сторінки. Це деталізований status, який повертає поточна версія API (v2 і новіші). Застарілий ендпоінт summary.json і сповіщення через вебхуки використовують скорочену форму лише з 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

Перейти до ендпоінтів: