Zacznij korzystać z API Instatus

Wszystkie endpointy znajdują się pod adresem https://api.instatus.com. Zasadniczo są zgodne z architekturą REST.

Wszystkie żądania muszą być zakodowane jako JSON, z nagłówkiem Content-Type: application/json.

Odpowiedzi API Instatus, łącznie z błędami, również są kodowane jako JSON.

Uwierzytelnianie

Żądania do API Instatus muszą przekazywać klucz API w nagłówku Authorization:

Authorization: Bearer <API_KEY>

Klucze tworzysz w panelu › Deweloper przyciskiem Utwórz klucz. Możesz mieć kilka kluczy, każdy z własną nazwą, np. „GitHub Actions” albo „Terraform”. Klucze zaczynają się od inst_sk_.

Co może klucz

Każdy klucz ma własne ustawienia:

  • Rola: Członek, Edytor albo rola niestandardowa w planie Business. Rola decyduje, co klucz może przeglądać i zmieniać, tak samo jak w przypadku ludzi. Klucz nie może być Właścicielem, więc rozliczenia, role i usuwanie zostają w rękach ludzi.
  • Dostęp: Wyświetlanie i zmiany albo Tylko wyświetlanie. Klucz z dostępem Tylko wyświetlanie nie może niczego zmienić, niezależnie od tego, na co pozwala jego rola.
  • Projekty: wszystkie projekty, łącznie z tymi dodanymi później, albo tylko wybrane przez Ciebie.
  • Ważność: data, od której klucz przestaje działać. W planie Free klucz może działać do 90 dni, w planie Pro do 1 roku, a w planach Business i Enterprise dowolnie długo, także bez terminu ważności. Właściciel zespołu może ustawić krótszy limit w sekcji Ustawienia zespołu › Klucze API. Nie dotyczy to kluczy utworzonych przed wprowadzeniem ustawień kluczy, a istniejące klucze zachowują swoją datę, gdy zmienia się Twój plan.
  • Dozwolone adresy IP: w planie Business klucz działa tylko z adresów IP lub zakresów, które podasz.

Klucz należy do zespołu albo do Ciebie:

  • Klucze zespołu działają dalej, gdy osoba, która je utworzyła, odejdzie z zespołu. Używaj ich w CI, skryptach i integracjach.
  • Klucze osobiste działają jako Ty i nigdy nie mogą więcej niż Ty. Mogą mieć rolę Taka jak Twoja i przestają działać, jeśli odejdziesz z zespołu.

Właściciele zespołu ustalają zasady dla kluczy w sekcji Ustawienia zespołu › Klucze API: jak długo najdłużej może działać klucz, czy członkowie mogą tworzyć klucze zespołu i czy klucze osobiste są dozwolone.

Utworzenie, zmiana, rotacja i unieważnienie klucza pojawiają się w Aktywności zespołu, podobnie jak klucz unieważniony z powodu wycieku. Wszystko, co zrobiono kluczem lub połączoną aplikacją, jest tam pokazane jako osoba przez nazwa klucza lub aplikacji.

Bezpieczeństwo kluczy

  • Klucz jest pokazywany tylko raz, przy tworzeniu. Skopiuj go wtedy i przechowuj jako sekret.
  • Aby wymienić klucz, otwórz go i kliknij Rotuj. Wybierz, jak długo stary klucz ma jeszcze działać, maksymalnie 7 dni, żeby zdążyć zaktualizować wszystko, co go używa.
  • Unieważnij klucz z jego menu, a przestanie działać od razu.

Klucze utworzone przed wprowadzeniem ustawień kluczy działają bez zmian. W sekcji Deweloper są oznaczone jako „Utworzony przed ustawieniami kluczy”. Możesz tam dodać do nich ograniczenia albo zastąpić je nowym kluczem.

Błędy kluczy

Gdy klucz nie może wykonać żądania, błąd ma jeden z tych kodów, a jego komunikat mówi, co zmienić.

KodStatusPowód
invalid_key401Klucz nie istnieje. Sprawdź, czy skopiowano go w całości.
key_expired401Minęła data ważności klucza.
key_revoked401Klucz został unieważniony.
key_owner_left401Osoba, jako którą działa klucz osobisty, odeszła z zespołu.
key_view_only403Klucz ma dostęp Tylko wyświetlanie, a żądanie coś zmienia.
role_not_allowed403Rola klucza nie pozwala tego przeglądać ani zmieniać.
ip_not_allowed403Żądanie przyszło z adresu IP, na który klucz nie pozwala.
page_not_allowed403Klucz nie może korzystać z tego projektu.
account_action_not_allowed403Klucze nie mogą tworzyć ani usuwać stron, zespołów ani workspace’ów. Użyj panelu.
route_not_allowed403Ta ścieżka nie należy do udokumentowanego API.

Znajdź swoje ID strony

ID strony znajdziesz w panelu, wykonując poniższe kroki:

  1. Przejdź do swojego panelu.
  2. Kliknij projekt w lewym górnym rogu prawym przyciskiem myszy, aby otworzyć menu.
  3. Kliknij Copy Project ID, a ID strony zostanie skopiowane do schowka.
ID strony

Błędy

Wszystkie endpointy API zwracają w odpowiedziach błędu kod i komunikat.

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

Wartości statusów

Możliwe statusy strony. To szczegółowy status zwracany przez bieżące API (v2 i nowsze). Starszy endpoint summary.json oraz powiadomienia webhook używają formy skróconej, obejmującej tylko UP, HASISSUES i UNDERMAINTENANCE.

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

Możliwe statusy komponentu:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Możliwe statusy incydentu:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Możliwe statusy przerwy technicznej:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Przejdź do endpointów: