Skip to Content

Endpoints de l’API

Tous les endpoints sont préfixés par /v1/ironflock. L’authentification via token Bearer est requise pour chaque requête.

Pour la documentation interactive avec les schémas de requête/réponse, voir api.ironflock.com/docs.

Appareils

Lister tous les appareils

GET /devices

Obtenir un appareil

GET /devices/:device_key

Créer des appareils

POST /swarms/:swarm_key/devices

Supprimer un appareil

DELETE /swarms/:swarm_key/devices/:device_key

Suppression en masse d’appareils

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

Applications des appareils

Lister les applications d’un appareil

GET /devices/:device_key/apps

Ajouter un appareil à une application

POST /devices/:device_key/apps

Mettre à jour l’état d’une application sur un appareil

PUT /devices/:device_key/apps/:app_key

Désinstaller une application d’un appareil

DELETE /devices/:device_key/apps/:app_key

Applications

Lister toutes les applications

GET /apps

Obtenir une application

GET /apps/:app_key

Créer une application

POST /apps

Supprimer une application

DELETE /apps/:app_key

Versions

Créer une version

POST /apps/:app_key/releases

Par défaut, cet appel est synchrone — il attend la fin de la construction. Utilisez ?wait=false pour un comportement asynchrone.

Lister les versions

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

Obtenir une version

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

Supprimer une version

DELETE /apps/:app_key/releases/:release_key

Annuler une construction

POST /apps/:app_key/releases/cancel

Groupes

Lister les groupes d’un projet

GET /swarms/:swarm_key/groups

Obtenir un groupe

GET /swarms/:swarm_key/groups/:group_key

Ajouter un appareil à un groupe

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

Retirer un appareil d’un groupe

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

Installer une application sur un groupe

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

Mettre à jour une application sur un groupe

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

Supprimer une application d’un groupe

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