API Endpoints
All endpoints are prefixed with /v1/ironflock. Authentication via Bearer token is required for every request.
For interactive documentation with request/response schemas, see api.ironflock.com/docs.
Devices
List All Devices
GET /devicesReturns all devices accessible by the authenticated user.
Get a Device
GET /devices/:device_keyCreate Devices
POST /swarms/:swarm_key/devicesCreate one or more devices in a project. The swarm_key is the project identifier.
Delete a Device
DELETE /swarms/:swarm_key/devices/:device_keyBulk Delete Devices
DELETE /swarms/:swarm_key/devices?ids=1,2,3Pass comma-separated device IDs as a query parameter.
Device Apps
List Apps on a Device
GET /devices/:device_key/appsAdd a Device to an App
POST /devices/:device_key/appsRequest body:
{
"app_key": 123
}Update App State on a Device
PUT /devices/:device_key/apps/:app_keyUninstall an App from a Device
DELETE /devices/:device_key/apps/:app_keyApps
List All Apps
GET /appsReturns all released apps accessible by the authenticated user.
Get an App
GET /apps/:app_keyCreate an App
POST /appsDelete an App
DELETE /apps/:app_keyReleases
Create a Release
POST /apps/:app_key/releasesBy default, this call is synchronous — it waits for the build to complete. Use ?wait=false for asynchronous behavior.
Optional query parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
wait | boolean | true | Wait for build to complete |
timeout | number | — | Max wait time in seconds (1–1800) |
List Releases
GET /apps/:app_key/releases?swarm_key=NGet a Release
GET /apps/:app_key/releases/:release_key?swarm_key=NDelete a Release
DELETE /apps/:app_key/releases/:release_keyCancel a Build
POST /apps/:app_key/releases/cancelCancels an in-progress release build.
Groups
List Groups in a Project
GET /swarms/:swarm_key/groupsGet a Group
GET /swarms/:swarm_key/groups/:group_keyAdd Device to Group
PUT /swarms/:swarm_key/groups/:group_key/devices/:device_keyRemove Device from Group
DELETE /swarms/:swarm_key/groups/:group_key/devices/:device_keyInstall App on Group
POST /swarms/:swarm_key/groups/:group_key/appsUpdate App on Group
PUT /swarms/:swarm_key/groups/:group_key/apps/:app_keyRemove App from Group
DELETE /swarms/:swarm_key/groups/:group_key/apps/:app_keyLast updated on