Skip to Content

Endpoints de la API

Todos los endpoints tienen el prefijo /v1/ironflock. Se requiere autenticación mediante Bearer token en cada solicitud.

Para documentación interactiva con esquemas de solicitud/respuesta, consulta api.ironflock.com/docs.

Dispositivos

Listar todos los dispositivos

GET /devices

Devuelve todos los dispositivos accesibles por el usuario autenticado.

Obtener un dispositivo

GET /devices/:device_key

Crear dispositivos

POST /swarms/:swarm_key/devices

Crea uno o más dispositivos en un proyecto. El swarm_key es el identificador del proyecto.

Eliminar un dispositivo

DELETE /swarms/:swarm_key/devices/:device_key

Eliminación masiva de dispositivos

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

Pasa los IDs de dispositivos separados por comas como parámetro de consulta.


Apps en dispositivos

Listar apps en un dispositivo

GET /devices/:device_key/apps

Agregar un dispositivo a una app

POST /devices/:device_key/apps

Cuerpo de la solicitud:

{ "app_key": 123 }

Actualizar el estado de una app en un dispositivo

PUT /devices/:device_key/apps/:app_key

Desinstalar una app de un dispositivo

DELETE /devices/:device_key/apps/:app_key

Apps

Listar todas las apps

GET /apps

Devuelve todas las apps publicadas accesibles por el usuario autenticado.

Obtener una app

GET /apps/:app_key

Crear una app

POST /apps

Eliminar una app

DELETE /apps/:app_key

Releases

Crear un release

POST /apps/:app_key/releases

Por defecto, esta llamada es sincrónica — espera a que la compilación se complete. Usa ?wait=false para un comportamiento asincrónico.

Parámetros de consulta opcionales:

ParámetroTipoPredeterminadoDescripción
waitbooleantrueEsperar a que la compilación se complete
timeoutnumberTiempo máximo de espera en segundos (1–1800)

Listar releases

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

Obtener un release

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

Eliminar un release

DELETE /apps/:app_key/releases/:release_key

Cancelar una compilación

POST /apps/:app_key/releases/cancel

Cancela una compilación de release en progreso.


Grupos

Listar grupos en un proyecto

GET /swarms/:swarm_key/groups

Obtener un grupo

GET /swarms/:swarm_key/groups/:group_key

Agregar dispositivo a un grupo

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

Eliminar dispositivo de un grupo

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

Instalar app en un grupo

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

Actualizar app en un grupo

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

Eliminar app de un grupo

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