Endpoint API

Tutti gli endpoint hanno il prefisso /v1/ironflock. L’autenticazione tramite Bearer token è richiesta per ogni richiesta.

Per la documentazione interattiva con gli schemi di richiesta/risposta, consulta api.ironflock.com/docs.

Dispositivi

Elenca Tutti i Dispositivi

GET /devices

Restituisce tutti i dispositivi accessibili dall’utente autenticato.

Ottieni un Dispositivo

GET /devices/:device_key

Crea Dispositivi

POST /swarms/:swarm_key/devices

Crea uno o più dispositivi in un progetto. Il swarm_key è l’identificatore del progetto.

Elimina un Dispositivo

DELETE /swarms/:swarm_key/devices/:device_key

Elimina Dispositivi in Blocco

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

Passa gli ID dei dispositivi separati da virgola come parametro di query.

App sui Dispositivi

Elenca le App su un Dispositivo

GET /devices/:device_key/apps

Aggiungi un Dispositivo a un’App

POST /devices/:device_key/apps

Corpo della richiesta:

{
    "app_key": 123
}

Aggiorna lo Stato dell’App su un Dispositivo

PUT /devices/:device_key/apps/:app_key

Disinstalla un’App da un Dispositivo

DELETE /devices/:device_key/apps/:app_key

App

Elenca Tutte le App

GET /apps

Restituisce tutte le app rilasciate accessibili dall’utente autenticato.

Ottieni un’App

GET /apps/:app_key

Crea un’App

POST /apps

Elimina un’App

DELETE /apps/:app_key

Release

Crea una Release

POST /apps/:app_key/releases

Per impostazione predefinita, questa chiamata è sincrona — attende il completamento della build. Usa ?wait=false per il comportamento asincrono.

Parametri di query facoltativi:

Elenca le Release

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

Ottieni una Release

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

Elimina una Release

DELETE /apps/:app_key/releases/:release_key

Annulla una Build

POST /apps/:app_key/releases/cancel

Annulla una build di release in corso.

Gruppi

Elenca i Gruppi in un Progetto

GET /swarms/:swarm_key/groups

Ottieni un Gruppo

GET /swarms/:swarm_key/groups/:group_key

Aggiungi un Dispositivo al Gruppo

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

Rimuovi un Dispositivo dal Gruppo

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

Installa un’App sul Gruppo

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

Aggiorna l’App sul Gruppo

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

Rimuovi l’App dal Gruppo

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