Začínáme s API Instatusu
Všechny endpointy jsou pod URL https://api.instatus.com. Obecně se drží architektury REST.
Všechny požadavky musí být zakódované jako JSON s hlavičkou Content-Type: application/json.
Odpovědi z API Instatusu, včetně chyb, jsou také zakódované jako JSON.
Ověřování
Požadavky na API Instatusu musí posílat API klíč v hlavičce Authorization:
Authorization: Bearer <API_KEY>
Klíče vytvoříte v dashboardu v sekci Vývojáři tlačítkem Vytvořit klíč. Můžete mít víc klíčů, každý s vlastním názvem, třeba „GitHub Actions“ nebo „Terraform“. Klíče začínají na inst_sk_.
Co klíč smí
Každý klíč má vlastní nastavení:
- Role: Člen, Editor nebo v tarifu Business vlastní role. Role určuje, co klíč smí zobrazit a měnit, stejně jako u lidí. Klíč nemůže být Vlastník, takže fakturace, role a mazání zůstávají lidem.
- Přístup: Zobrazit a měnit, nebo Jen zobrazit. Klíč s přístupem Jen zobrazit nemůže nic měnit, ať jeho role dovoluje cokoli.
- Projekty: všechny projekty včetně těch, které přidáte později, nebo jen ty, které vyberete.
- Platnost: datum, kdy klíč přestane fungovat. V tarifu Free může klíč platit nejvýš 90 dní, v tarifu Pro nejvýš 1 rok a v tarifech Business a Enterprise libovolně dlouho, i bez konce platnosti. Vlastník týmu může v Nastavení týmu › API klíče nastavit kratší limit. Klíčů vytvořených před nastavením klíčů se to netýká a stávající klíče si při změně tarifu ponechají své datum.
- Povolené IP adresy: v tarifu Business klíč funguje jen z IP adres nebo rozsahů, které uvedete.
Klíč patří týmu, nebo vám:
- Týmové klíče fungují dál, i když člověk, který je vytvořil, z týmu odejde. Používejte je pro CI, skripty a integrace.
- Osobní klíče jednají jako vy a nikdy nesmí víc než vy. Jako roli mohou použít Stejná jako vy a přestanou fungovat, pokud z týmu odejdete.
Vlastníci týmu nastavují pravidla pro klíče v Nastavení týmu › API klíče: jak dlouho může klíč nejdéle platit, zda členové smí vytvářet týmové klíče a zda jsou povolené osobní klíče.
Vytvoření, změna, rotace a zrušení klíče se zobrazí v Aktivitě týmu, stejně jako klíč zrušený kvůli úniku. Vše, co se udělá přes klíč nebo připojenou aplikaci, se tam zobrazí jako osoba přes název klíče nebo aplikace.
Bezpečné zacházení s klíči
- Klíč se zobrazí jen jednou, při vytvoření. Hned ho zkopírujte a uložte jako tajný údaj.
- Pokud chcete klíč vyměnit, otevřete ho a klikněte na Rotovat. Zvolte, jak dlouho bude starý klíč ještě fungovat, nejvýš 7 dní, abyste stihli aktualizovat vše, co ho používá.
- Klíč zrušíte v jeho menu a přestane fungovat okamžitě.
Klíče vytvořené před nastavením klíčů fungují beze změny. Ve Vývojářích jsou označené „Vytvořen před nastavením klíčů“ a můžete jim tam přidat omezení nebo je nahradit novým klíčem.
Chyby klíčů
Když klíč nesmí provést požadavek, chyba obsahuje jeden z těchto kódů a její zpráva říká, co změnit.
| Kód | Stav | Proč |
|---|---|---|
invalid_key | 401 | Klíč neexistuje. Zkontrolujte, že jste ho zkopírovali celý. |
key_expired | 401 | Klíči vypršela platnost. |
key_revoked | 401 | Klíč byl zrušen. |
key_owner_left | 401 | Člověk, za kterého osobní klíč jedná, odešel z týmu. |
key_view_only | 403 | Klíč má přístup Jen zobrazit a požadavek něco mění. |
role_not_allowed | 403 | Role klíče tohle nesmí zobrazit nebo měnit. |
ip_not_allowed | 403 | Požadavek přišel z IP adresy, kterou klíč nepovoluje. |
page_not_allowed | 403 | Klíč nesmí používat tento projekt. |
account_action_not_allowed | 403 | Klíče nemohou vytvářet ani odebírat stránky, týmy nebo pracovní prostory. Použijte dashboard. |
route_not_allowed | 403 | Cesta není součástí zdokumentovaného API. |
Získání ID stránky
ID stránky najdete v dashboardu takto:
- Přejděte do dashboardu.
- Klikněte pravým tlačítkem na projekt v levém horním rohu a otevřete menu.
- Klikněte na Copy Project ID a ID stránky se zkopíruje do schránky.

Chyby
Všechny endpointy API vracejí v chybových odpovědích kód a zprávu.
{"error": {"code": "forbidden","message": "Not authorized"}}
Hodnoty stavů
Možné stavy stránky. Tohle je podrobný status, který vrací současné API (v2 a novější). Starší endpoint summary.json a oznámení přes webhook používají zjednodušenou podobu jen s UP, HASISSUES a UNDERMAINTENANCE.
UPHASISSUESALLUNDERMAINTENANCEALLDEGRADEDPERFORMANCEALLPARTIALOUTAGEALLMINOROUTAGEALLMAJOROUTAGESOMEUNDERMAINTENANCESOMEDEGRADEDPERFORMANCESOMEPARTIALOUTAGESOMEMINOROUTAGESOMEMAJOROUTAGEONEUNDERMAINTENANCEONEDEGRADEDPERFORMANCEONEPARTIALOUTAGEONEMINOROUTAGEONEMAJOROUTAGE
Možné stavy komponenty:
OPERATIONALUNDERMAINTENANCEDEGRADEDPERFORMANCEPARTIALOUTAGEMAJOROUTAGE
Možné stavy incidentu:
INVESTIGATINGIDENTIFIEDMONITORINGRESOLVED
Možné stavy údržby:
NOTSTARTEDYETINPROGRESSCOMPLETED