APIエンドポイント
すべてのエンドポイントは/v1/ironflockをプレフィックスとして使用します。すべてのリクエストにBearerトークンによる認証が必要です。
リクエスト/レスポンスのスキーマを含むインタラクティブなドキュメントはapi.ironflock.com/docsをご覧ください。
デバイス
すべてのデバイスを一覧取得
GET /devices認証されたユーザーがアクセス可能なすべてのデバイスを返します。
デバイスを取得
GET /devices/:device_keyデバイスを作成
POST /swarms/:swarm_key/devicesプロジェクト内に1つ以上のデバイスを作成します。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