⌘ K

Erste Schritte mit der Instatus-API

Alle Endpunkte liegen unter der URL https://api.instatus.com. Sie folgen weitgehend der REST-Architektur.

Alle Anfragen müssen als JSON mit dem Header Content-Type: application/json kodiert sein.

Antworten der Instatus-API, einschließlich Fehlern, sind ebenfalls als JSON kodiert.

Authentifizierung

Anfragen an die Instatus-API müssen ein API-Token über den Authorization-Header übergeben:

Ihren API-Schlüssel erhalten Sie unter Benutzereinstellungen → Entwicklereinstellungen

Authorization: Bearer <API_KEY>

Ihre Seiten-ID finden

Ihre Seiten-ID finden Sie im Dashboard mit diesen Schritten:

Gehen Sie zu Ihrem Dashboard.
Klicken Sie mit der rechten Maustaste oben links auf Ihr Projekt, um das Menü zu öffnen.
Klicken Sie auf Projekt-ID kopieren; Ihre Seiten-ID liegt dann in der Zwischenablage.

Fehler

Alle API-Endpunkte liefern in Fehlerantworten einen Code und eine Nachricht.

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

Statuswerte

Mögliche Seitenstatus. Das ist der detaillierte status, den die aktuelle API (v2 und später) zurückgibt. Der ältere Endpunkt summary.json und Webhook-Benachrichtigungen verwenden eine verkürzte Form mit nur UP, HASISSUES und UNDERMAINTENANCE.