Deutsch English
Schemas

OpenAPI 3.1

Die komplette FireStatus Management API v1 ist als OpenAPI 3.1-Schema verfügbar. Der servers-Eintrag ist eine Template-URL mit einer Host-Variablen — im Beispiel https://status.example.com/api/v1, die du durch die Adresse deiner eigenen Statusseite ersetzt. Autorisiert wird über das Security-Scheme bearerAuth. Damit erzeugst du Postman-Collections, Insomnia-Workspaces, Mock-Server oder typsichere Clients in über 50 Programmiersprachen.

Verwendung

  1. Im Workspace oben links auf Import klicken.
  2. Im Reiter Link diese URL einfügen: https://docs.firestatus.de/openapi.json
  3. Mit Continue → Import bestätigen. Postman erzeugt eine Collection mit allen Endpunkten und Beispielanfragen.
  4. Unter Authorization den Typ Bearer Token wählen und deinen API-Key fs_… hinterlegen — Postman sendet ihn automatisch im Authorization-Header. Setze außerdem die Host-Variable der Server-URL auf die Adresse deiner eigenen Statusseite.
  1. Auf dem Dashboard auf Create → URL klicken.
  2. URL eintragen: https://docs.firestatus.de/openapi.json
  3. Mit Fetch and Import bestätigen. Insomnia erkennt das OpenAPI-Format automatisch und legt eine neue Collection an.

Öffne das Schema in Swagger UI, um alle Endpunkte direkt im Browser zu erkunden und interaktiv aufzurufen.

In Swagger UI öffnen

Der OpenAPI Generator erzeugt aus dem Schema typsichere Clients für beliebige Sprachen: 

npx @openapitools/openapi-generator-cli generate \
  -i https://docs.firestatus.de/openapi.json \
  -g typescript-fetch \
  -o ./firestatus-client

Verfügbare Generatoren u. a.: typescript-fetch, php, python, go, java, csharp, rust, kotlin, swift.