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í obsahovat API token v hlavičce Authorization:

Svůj API klíč najdete v Nastavení uživatele → Nastavení pro vývojáře

Authorization: Bearer <API_KEY>

Získání ID stránky

ID stránky najdete v dashboardu takto:

1. Přejděte do dashboardu.
2. Klikněte pravým tlačítkem na projekt v levém horním rohu a otevřete menu.
3. 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.

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

Možné stavy komponenty:

• OPERATIONAL
• UNDERMAINTENANCE
• DEGRADEDPERFORMANCE
• PARTIALOUTAGE
• MAJOROUTAGE

Možné stavy incidentu:

• INVESTIGATING
• IDENTIFIED
• MONITORING
• RESOLVED

Možné stavy údržby:

• NOTSTARTEDYET
• INPROGRESS
• COMPLETED

Přejít na endpointy: