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 einen API-Schlüssel über den Authorization-Header übergeben:
Authorization: Bearer <API_KEY>
Schlüssel erstellen Sie unter Dashboard › Entwickler mit Schlüssel erstellen. Sie können mehrere Schlüssel haben, jeden mit eigenem Namen, etwa „GitHub Actions“ oder „Terraform“. Schlüssel beginnen mit inst_sk_.
Was ein Schlüssel darf
Jeder Schlüssel hat eigene Einstellungen:
- Rolle: Mitglied, Editor oder im Business-Tarif eine eigene Rolle. Die Rolle legt fest, was der Schlüssel ansehen und ändern darf, genau wie bei Personen. Schlüssel können nicht Eigentümer sein, Abrechnung, Rollen und das Löschen bleiben also Personen vorbehalten.
- Zugriff: Ansehen und ändern oder Nur ansehen. Ein Schlüssel mit „Nur ansehen“ kann nichts ändern, ganz gleich, was seine Rolle erlaubt.
- Projekte: alle Projekte, auch solche, die Sie später hinzufügen, oder nur die, die Sie auswählen.
- Ablaufdatum: der Tag, an dem der Schlüssel aufhört zu funktionieren. Im Free-Tarif gilt ein Schlüssel höchstens 90 Tage, im Pro-Tarif bis zu 1 Jahr und in den Tarifen Business und Enterprise beliebig lange, auch ohne Ablaufdatum. Ein Team-Eigentümer kann unter Team-Einstellungen › API-Schlüssel eine kürzere Grenze festlegen. Schlüssel, die vor den Schlüsseleinstellungen erstellt wurden, sind davon nicht betroffen, und bestehende Schlüssel behalten ihr Datum, wenn sich Ihr Tarif ändert.
- Erlaubte IPs: Im Business-Tarif funktioniert der Schlüssel nur von den IP-Adressen oder -Bereichen, die Sie angeben.
Ein Schlüssel gehört dem Team oder Ihnen:
- Team-Schlüssel funktionieren weiter, wenn die Person, die sie erstellt hat, das Team verlässt. Verwenden Sie sie für CI, Skripte und Integrationen.
- Persönliche Schlüssel handeln als Sie und können nie mehr als Sie. Sie können Wie du als Rolle verwenden und funktionieren nicht mehr, wenn Sie das Team verlassen.
Team-Eigentümer legen die Regeln für Schlüssel unter Team-Einstellungen › API-Schlüssel fest: wie lange ein Schlüssel höchstens gilt, ob Mitglieder Team-Schlüssel erstellen dürfen und ob persönliche Schlüssel erlaubt sind.
Wenn ein Schlüssel erstellt, geändert, rotiert oder widerrufen wird, steht das in der Aktivität des Teams, ebenso ein Schlüssel, der widerrufen wurde, weil er geleakt wurde. Alles, was über einen Schlüssel oder eine verbundene App geschieht, erscheint dort als Person über Name des Schlüssels oder der App.
Schlüssel sicher aufbewahren
- Ein Schlüssel wird nur einmal angezeigt, wenn Sie ihn erstellen. Kopieren Sie ihn dann und speichern Sie ihn als Secret.
- Um einen Schlüssel zu ersetzen, öffnen Sie ihn und klicken Sie auf Rotieren. Wählen Sie, wie lange der alte Schlüssel weiter funktioniert, bis zu 7 Tage, damit Sie Zeit haben, alles zu aktualisieren, was ihn verwendet.
- Widerrufen Sie einen Schlüssel über sein Menü, und er funktioniert sofort nicht mehr.
Schlüssel, die vor den Schlüsseleinstellungen erstellt wurden, funktionieren unverändert weiter. Sie erscheinen unter Entwickler als „Vor den Schlüsseleinstellungen erstellt“. Dort können Sie ihnen Grenzen hinzufügen oder sie durch einen neuen Schlüssel ersetzen.
Schlüsselfehler
Wenn ein Schlüssel eine Anfrage nicht stellen darf, enthält der Fehler einen dieser Codes, und die Meldung sagt, was Sie ändern müssen.
| Code | Status | Grund |
|---|---|---|
invalid_key | 401 | Der Schlüssel existiert nicht. Prüfen Sie, ob Sie ihn vollständig kopiert haben. |
key_expired | 401 | Das Ablaufdatum des Schlüssels ist überschritten. |
key_revoked | 401 | Der Schlüssel wurde widerrufen. |
key_owner_left | 401 | Die Person, als die ein persönlicher Schlüssel handelt, hat das Team verlassen. |
key_view_only | 403 | Der Schlüssel ist auf „Nur ansehen“ gesetzt, und die Anfrage ändert etwas. |
role_not_allowed | 403 | Die Rolle des Schlüssels darf das nicht ansehen oder ändern. |
ip_not_allowed | 403 | Die Anfrage kam von einer IP-Adresse, die der Schlüssel nicht erlaubt. |
page_not_allowed | 403 | Der Schlüssel darf dieses Projekt nicht verwenden. |
account_action_not_allowed | 403 | Schlüssel können keine Seiten, Teams oder Workspaces erstellen oder entfernen. Verwenden Sie das Dashboard. |
route_not_allowed | 403 | Die Route gehört nicht zur dokumentierten API. |
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.
UPHASISSUESALLUNDERMAINTENANCEALLDEGRADEDPERFORMANCEALLPARTIALOUTAGEALLMINOROUTAGEALLMAJOROUTAGESOMEUNDERMAINTENANCESOMEDEGRADEDPERFORMANCESOMEPARTIALOUTAGESOMEMINOROUTAGESOMEMAJOROUTAGEONEUNDERMAINTENANCEONEDEGRADEDPERFORMANCEONEPARTIALOUTAGEONEMINOROUTAGEONEMAJOROUTAGE
Mögliche Komponentenstatus:
OPERATIONALUNDERMAINTENANCEDEGRADEDPERFORMANCEPARTIALOUTAGEMAJOROUTAGE
Mögliche Vorfallsstatus:
INVESTIGATINGIDENTIFIEDMONITORINGRESOLVED
Mögliche Wartungsstatus:
NOTSTARTEDYETINPROGRESSCOMPLETED