Punkty końcowe API
Wszystkie punkty końcowe mają prefiks /v1/ironflock. Uwierzytelnianie przez token Bearer jest wymagane dla każdego żądania.
Interaktywna dokumentacja ze schematami żądań/odpowiedzi dostępna jest pod adresem api.ironflock.com/docs.
Urządzenia
Wylistuj wszystkie urządzenia
GET /devicesPobierz urządzenie
GET /devices/:device_keyUtwórz urządzenia
POST /swarms/:swarm_key/devicesUtwórz jedno lub więcej urządzeń w projekcie. swarm_key to identyfikator projektu.
Usuń urządzenie
DELETE /swarms/:swarm_key/devices/:device_keyMasowe usuwanie urządzeń
DELETE /swarms/:swarm_key/devices?ids=1,2,3Aplikacje urządzeń
Wylistuj aplikacje na urządzeniu
GET /devices/:device_key/appsDodaj urządzenie do aplikacji
POST /devices/:device_key/appsTreść żądania:
{
"app_key": 123
}Zaktualizuj stan aplikacji na urządzeniu
PUT /devices/:device_key/apps/:app_keyOdinstaluj aplikację z urządzenia
DELETE /devices/:device_key/apps/:app_keyAplikacje
Wylistuj wszystkie aplikacje
GET /appsPobierz aplikację
GET /apps/:app_keyUtwórz aplikację
POST /appsUsuń aplikację
DELETE /apps/:app_keyWydania
Utwórz wydanie
POST /apps/:app_key/releasesDomyślnie to wywołanie jest synchroniczne — czeka na zakończenie builda. Użyj ?wait=false dla zachowania asynchronicznego.
Opcjonalne parametry zapytania:
| Parametr | Typ | Domyślny | Opis |
|---|---|---|---|
wait | boolean | true | Czekaj na zakończenie builda |
timeout | number | — | Maksymalny czas oczekiwania w sekundach (1–1800) |
Wylistuj wydania
GET /apps/:app_key/releases?swarm_key=NPobierz wydanie
GET /apps/:app_key/releases/:release_key?swarm_key=NUsuń wydanie
DELETE /apps/:app_key/releases/:release_keyAnuluj build
POST /apps/:app_key/releases/cancelGrupy
Wylistuj grupy w projekcie
GET /swarms/:swarm_key/groupsPobierz grupę
GET /swarms/:swarm_key/groups/:group_keyDodaj urządzenie do grupy
PUT /swarms/:swarm_key/groups/:group_key/devices/:device_keyUsuń urządzenie z grupy
DELETE /swarms/:swarm_key/groups/:group_key/devices/:device_keyZainstaluj aplikację w grupie
POST /swarms/:swarm_key/groups/:group_key/appsZaktualizuj aplikację w grupie
PUT /swarms/:swarm_key/groups/:group_key/apps/:app_keyUsuń aplikację z grupy
DELETE /swarms/:swarm_key/groups/:group_key/apps/:app_keyLast updated on