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 /devicesGibt alle Geräte zurück, auf die der authentifizierte Benutzer Zugriff hat.
Ein Gerät abrufen
GET /devices/:device_keyGeräte erstellen
POST /swarms/:swarm_key/devicesErstellt 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_keyMehrere 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/appsEin Gerät einer App hinzufügen
POST /devices/:device_key/appsAnfragekörper:
{
"app_key": 123
}App-Status auf einem Gerät aktualisieren
PUT /devices/:device_key/apps/:app_keyEine App von einem Gerät deinstallieren
DELETE /devices/:device_key/apps/:app_keyApps
Alle Apps auflisten
GET /appsGibt alle veröffentlichten Apps zurück, auf die der authentifizierte Benutzer Zugriff hat.
Eine App abrufen
GET /apps/:app_keyEine App erstellen
POST /appsEine App löschen
DELETE /apps/:app_keyReleases
Ein Release erstellen
POST /apps/:app_key/releasesStandardmäßig ist dieser Aufruf synchron — er wartet auf den Abschluss des Builds. Verwenden Sie ?wait=false für asynchrones Verhalten.
Optionale Query-Parameter:
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
wait | boolean | true | Auf Build-Abschluss warten |
timeout | number | — | Maximale Wartezeit in Sekunden (1–1800) |
Releases auflisten
GET /apps/:app_key/releases?swarm_key=NEin Release abrufen
GET /apps/:app_key/releases/:release_key?swarm_key=NEin Release löschen
DELETE /apps/:app_key/releases/:release_keyEinen Build abbrechen
POST /apps/:app_key/releases/cancelBricht einen laufenden Release-Build ab.
Gruppen
Gruppen in einem Projekt auflisten
GET /swarms/:swarm_key/groupsEine Gruppe abrufen
GET /swarms/:swarm_key/groups/:group_keyGerät einer Gruppe hinzufügen
PUT /swarms/:swarm_key/groups/:group_key/devices/:device_keyGerät aus einer Gruppe entfernen
DELETE /swarms/:swarm_key/groups/:group_key/devices/:device_keyApp in einer Gruppe installieren
POST /swarms/:swarm_key/groups/:group_key/appsApp in einer Gruppe aktualisieren
PUT /swarms/:swarm_key/groups/:group_key/apps/:app_keyApp aus einer Gruppe entfernen
DELETE /swarms/:swarm_key/groups/:group_key/apps/:app_keyLast updated on