Skip to Content

API-Endpunkte

Alle Endpunkte haben das Präfix /v1/ironflock. Für jede Anfrage ist eine Authentifizierung per Bearer-Token erforderlich.

Interaktive Dokumentation mit Anfrage-/Antwort-Schemas finden Sie unter api.ironflock.com/docs.

Geräte

Alle Geräte auflisten

GET /devices

Gibt alle Geräte zurück, auf die der authentifizierte Benutzer Zugriff hat.

Ein Gerät abrufen

GET /devices/:device_key

Geräte erstellen

POST /swarms/:swarm_key/devices

Erstellt ein oder mehrere Geräte in einem Projekt. Der swarm_key ist die Projektkennung.

Ein Gerät löschen

DELETE /swarms/:swarm_key/devices/:device_key

Mehrere Geräte löschen

DELETE /swarms/:swarm_key/devices?ids=1,2,3

Übergeben Sie kommagetrennte Geräte-IDs als Query-Parameter.


Geräte-Apps

Apps auf einem Gerät auflisten

GET /devices/:device_key/apps

Ein Gerät einer App hinzufügen

POST /devices/:device_key/apps

Anfragekörper:

{ "app_key": 123 }

App-Status auf einem Gerät aktualisieren

PUT /devices/:device_key/apps/:app_key

Eine App von einem Gerät deinstallieren

DELETE /devices/:device_key/apps/:app_key

Apps

Alle Apps auflisten

GET /apps

Gibt alle veröffentlichten Apps zurück, auf die der authentifizierte Benutzer Zugriff hat.

Eine App abrufen

GET /apps/:app_key

Eine App erstellen

POST /apps

Eine App löschen

DELETE /apps/:app_key

Releases

Ein Release erstellen

POST /apps/:app_key/releases

Standardmäßig ist dieser Aufruf synchron — er wartet auf den Abschluss des Builds. Verwenden Sie ?wait=false für asynchrones Verhalten.

Optionale Query-Parameter:

ParameterTypStandardBeschreibung
waitbooleantrueAuf Build-Abschluss warten
timeoutnumberMaximale Wartezeit in Sekunden (1–1800)

Releases auflisten

GET /apps/:app_key/releases?swarm_key=N

Ein Release abrufen

GET /apps/:app_key/releases/:release_key?swarm_key=N

Ein Release löschen

DELETE /apps/:app_key/releases/:release_key

Einen Build abbrechen

POST /apps/:app_key/releases/cancel

Bricht einen laufenden Release-Build ab.


Gruppen

Gruppen in einem Projekt auflisten

GET /swarms/:swarm_key/groups

Eine Gruppe abrufen

GET /swarms/:swarm_key/groups/:group_key

Gerät einer Gruppe hinzufügen

PUT /swarms/:swarm_key/groups/:group_key/devices/:device_key

Gerät aus einer Gruppe entfernen

DELETE /swarms/:swarm_key/groups/:group_key/devices/:device_key

App in einer Gruppe installieren

POST /swarms/:swarm_key/groups/:group_key/apps

App in einer Gruppe aktualisieren

PUT /swarms/:swarm_key/groups/:group_key/apps/:app_key

App aus einer Gruppe entfernen

DELETE /swarms/:swarm_key/groups/:group_key/apps/:app_key
Last updated on