Aan de slag met de Instatus API

Alle endpoints staan onder de URL https://api.instatus.com. Ze volgen doorgaans de REST-architectuur.

Alle verzoeken moeten als JSON worden verstuurd met de header Content-Type: application/json.

Responses van de Instatus API, foutmeldingen inbegrepen, zijn eveneens als JSON gecodeerd.

Authenticatie

Verzoeken aan de Instatus API moeten een API-token meesturen via de Authorization-header:

Je API-sleutel vind je bij Gebruikersinstellingen → Ontwikkelaarsinstellingen

Authorization: Bearer <API_KEY>

Je Page ID ophalen

Je Page ID vind je in het dashboard via deze stappen:

1. Ga naar je dashboard.
2. Klik met rechts op je project linksboven om het menu te openen.
3. Klik op Copy Project ID; je pagina-ID wordt naar je klembord gekopieerd.

Fouten

Alle API-endpoints geven bij fouten een code en een bericht terug in de foutrespons.

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

Statuswaarden

Mogelijke paginastatussen. Dit is de gedetailleerde status die de huidige API (v2 en later) teruggeeft. Het oudere endpoint summary.json en webhook-notificaties gebruiken een beknopte vorm met alleen UP, HASISSUES en UNDERMAINTENANCE.

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

Mogelijke componentstatussen:

• OPERATIONAL
• UNDERMAINTENANCE
• DEGRADEDPERFORMANCE
• PARTIALOUTAGE
• MAJOROUTAGE

Mogelijke incidentstatussen:

• INVESTIGATING
• IDENTIFIED
• MONITORING
• RESOLVED

Mogelijke onderhoudsstatussen:

• NOTSTARTEDYET
• INPROGRESS
• COMPLETED

Spring naar de endpoints: