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-sleutel meesturen via de Authorization-header:
Authorization: Bearer <API_KEY>
Maak sleutels aan in Dashboard › Ontwikkelaars met Sleutel maken. Je kunt meerdere sleutels hebben, elk met een eigen naam, zoals "GitHub Actions" of "Terraform". Sleutels beginnen met inst_sk_.
Wat een sleutel kan
Elke sleutel heeft eigen instellingen:
- Rol: Lid, Redacteur of een aangepaste rol op het Business-abonnement. De rol bepaalt wat de sleutel kan bekijken en wijzigen, net als bij mensen. Sleutels kunnen geen Eigenaar zijn, dus facturatie, rollen en verwijderen blijven bij mensen.
- Toegang: Bekijken en wijzigen of Alleen bekijken. Een sleutel met Alleen bekijken kan niets wijzigen, wat de rol ook toestaat.
- Projecten: alle projecten, ook projecten die je later toevoegt, of alleen de projecten die je kiest.
- Vervaldatum: de datum waarop de sleutel ophoudt te werken. Op het Free-abonnement is een sleutel maximaal 90 dagen geldig, op Pro maximaal 1 jaar en op Business en Enterprise zo lang als je wilt, ook zonder vervaldatum. Een teameigenaar kan in Teaminstellingen › API-sleutels een kortere limiet instellen. Sleutels die zijn gemaakt vóór de sleutelinstellingen vallen hier niet onder, en bestaande sleutels houden hun datum als je abonnement verandert.
- Toegestane IP's: op het Business-abonnement werkt de sleutel alleen vanaf de IP-adressen of reeksen die je opgeeft.
Een sleutel hoort bij het team of bij jou:
- Teamsleutels blijven werken als degene die ze heeft gemaakt het team verlaat. Gebruik ze voor CI, scripts en integraties.
- Persoonlijke sleutels handelen namens jou en doen nooit meer dan jij kunt. Ze kunnen Hetzelfde als jij als rol gebruiken en werken niet meer als je het team verlaat.
Teameigenaren bepalen de regels voor sleutels in Teaminstellingen › API-sleutels: hoe lang een sleutel maximaal geldig is, of leden teamsleutels mogen maken en of persoonlijke sleutels zijn toegestaan.
Het aanmaken, wijzigen, roteren en intrekken van een sleutel verschijnt in de Activiteit van het team, net als een sleutel die is ingetrokken omdat hij is uitgelekt. Alles wat via een sleutel of een gekoppelde app gebeurt, staat daar als persoon via naam van de sleutel of app.
Houd sleutels veilig
- Een sleutel wordt één keer getoond, als je hem aanmaakt. Kopieer hem meteen en bewaar hem als geheim.
- Wil je een sleutel vervangen, open hem dan en klik op Roteren. Kies hoe lang de oude sleutel blijft werken, tot maximaal 7 dagen, zodat je tijd hebt om alles bij te werken wat hem gebruikt.
- Trek een sleutel in via het menu en hij werkt meteen niet meer.
Sleutels die zijn gemaakt vóór de sleutelinstellingen blijven ongewijzigd werken. In Ontwikkelaars staan ze als "Gemaakt vóór sleutelinstellingen". Daar kun je er limieten aan toevoegen of ze vervangen door een nieuwe sleutel.
Sleutelfouten
Als een sleutel een verzoek niet mag doen, heeft de fout een van deze codes en vertelt het bericht wat je moet aanpassen.
| Code | Status | Waarom |
|---|---|---|
invalid_key | 401 | De sleutel bestaat niet. Controleer of je hem helemaal hebt gekopieerd. |
key_expired | 401 | De vervaldatum van de sleutel is verstreken. |
key_revoked | 401 | De sleutel is ingetrokken. |
key_owner_left | 401 | De persoon namens wie een persoonlijke sleutel handelt, heeft het team verlaten. |
key_view_only | 403 | De sleutel heeft Alleen bekijken en het verzoek wijzigt iets. |
role_not_allowed | 403 | De rol van de sleutel mag dit niet bekijken of wijzigen. |
ip_not_allowed | 403 | Het verzoek kwam van een IP-adres dat de sleutel niet toestaat. |
page_not_allowed | 403 | De sleutel mag dit project niet gebruiken. |
account_action_not_allowed | 403 | Sleutels kunnen geen pagina's, teams of workspaces aanmaken of verwijderen. Gebruik het dashboard. |
route_not_allowed | 403 | De route hoort niet bij de gedocumenteerde API. |
Je Page ID ophalen
Je Page ID vind je in het dashboard via deze stappen:
- Ga naar je dashboard.
- Klik met rechts op je project linksboven om het menu te openen.
- 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.
UPHASISSUESALLUNDERMAINTENANCEALLDEGRADEDPERFORMANCEALLPARTIALOUTAGEALLMINOROUTAGEALLMAJOROUTAGESOMEUNDERMAINTENANCESOMEDEGRADEDPERFORMANCESOMEPARTIALOUTAGESOMEMINOROUTAGESOMEMAJOROUTAGEONEUNDERMAINTENANCEONEDEGRADEDPERFORMANCEONEPARTIALOUTAGEONEMINOROUTAGEONEMAJOROUTAGE
Mogelijke componentstatussen:
OPERATIONALUNDERMAINTENANCEDEGRADEDPERFORMANCEPARTIALOUTAGEMAJOROUTAGE
Mogelijke incidentstatussen:
INVESTIGATINGIDENTIFIEDMONITORINGRESOLVED
Mogelijke onderhoudsstatussen:
NOTSTARTEDYETINPROGRESSCOMPLETED