API 端点
所有端点以 /v1/ironflock 为前缀。每个请求都需要 Bearer Token 认证。
交互式文档(包含请求/响应结构)请参阅 api.ironflock.com/docs。
设备
列出所有设备
GET /devices返回已认证用户可访问的所有设备。
获取单个设备
GET /devices/:device_key创建设备
POST /swarms/:swarm_key/devices在项目中创建一个或多个设备。swarm_key 为项目标识符。
删除设备
DELETE /swarms/:swarm_key/devices/:device_key批量删除设备
DELETE /swarms/:swarm_key/devices?ids=1,2,3通过查询参数传递以逗号分隔的设备 ID。
设备应用
列出设备上的应用
GET /devices/:device_key/apps为设备添加应用
POST /devices/:device_key/apps请求体:
{
"app_key": 123
}更新设备上的应用状态
PUT /devices/:device_key/apps/:app_key从设备卸载应用
DELETE /devices/:device_key/apps/:app_key应用
列出所有应用
GET /apps返回已认证用户可访问的所有已发布应用。
获取单个应用
GET /apps/:app_key创建应用
POST /apps删除应用
DELETE /apps/:app_key发布版本
创建发布版本
POST /apps/:app_key/releases默认情况下此调用是同步的——会等待构建完成。使用 ?wait=false 可改为异步行为。
可选查询参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
wait | boolean | true | 是否等待构建完成 |
timeout | number | — | 最大等待时间(秒),范围 1–1800 |
列出发布版本
GET /apps/:app_key/releases?swarm_key=N获取单个发布版本
GET /apps/:app_key/releases/:release_key?swarm_key=N删除发布版本
DELETE /apps/:app_key/releases/:release_key取消构建
POST /apps/:app_key/releases/cancel取消正在进行的发布版本构建。
设备组
列出项目中的设备组
GET /swarms/:swarm_key/groups获取单个设备组
GET /swarms/:swarm_key/groups/:group_key将设备添加到设备组
PUT /swarms/:swarm_key/groups/:group_key/devices/:device_key从设备组移除设备
DELETE /swarms/:swarm_key/groups/:group_key/devices/:device_key在设备组中安装应用
POST /swarms/:swarm_key/groups/:group_key/apps更新设备组中的应用
PUT /swarms/:swarm_key/groups/:group_key/apps/:app_key从设备组移除应用
DELETE /swarms/:swarm_key/groups/:group_key/apps/:app_keyLast updated on