メインコンテンツまでスキップ

Remote Dev Environments API

Remote Dev Environments REST APIを使うと、セッション、テンプレート、保存済み入力をプログラムから管理したり、workspaceのアクティブなセッションによる消費量をレポートしたりできます。これは、CLI、Web UI、MCP サーバーが使用しているものと同じ API です。

Experimental API

RDE API は試験的な機能です。バージョン管理されていますが、エンドポイントやペイロードは予告なく後方互換性のない形で変更される可能性があります。連携は動作確認済みの挙動に固定し、更新が必要になることを想定してください。

ベースURLClick to copy link​

APIは次の場所で提供されています。

https://api.bitrise.io/rde

認証Click to copy link​

Bitrise personal access tokenで認証し、Authorization ヘッダーで送信します。

Authorization: token YOUR_BITRISE_PAT

Workspace使用状況レポートClick to copy link​

使用状況エンドポイントは、workspaceのアクティブなセッションについて、ある時点のスナップショットを返します。セッション数、vCPU とメモリの合計を、OS別、workspace全体、ユーザーごとに分けて取得できます。報告されるのは現時点でセッションが消費している量です。履歴や請求期間ごとのレポートではありません。

GET /v1/workspaces/{workspace_id}/usage

他のエンドポイントと異なり、このエンドポイントには請求情報の閲覧権限が必要です。workspaceのオーナーと、請求管理権限を持つカスタムロールのメンバーが呼び出せます。他のメンバーには 403 レスポンスが返されます。

Warm poolsClick to copy link​

warm poolエンドポイントは、事前に起動されたセッションのプールを管理します。セッションの作成リクエストとプレビューリンクの作成リクエストは、warm_pool_idを使用してプールからセッションを取得します。

GET /v1/workspaces/{workspace_id}/warm-pools
POST /v1/workspaces/{workspace_id}/warm-pools
GET /v1/workspaces/{workspace_id}/warm-pools/{warm_pool_id}
PATCH /v1/workspaces/{workspace_id}/warm-pools/{warm_pool_id}
DELETE /v1/workspaces/{workspace_id}/warm-pools/{warm_pool_id}
POST /v1/workspaces/{workspace_id}/warm-pools/{warm_pool_id}/retry

プールのstatusは、準備完了のセッション数とウォームアップ中のセッション数、ウォームアップされたセッション自体、および設定エラーを報告します。retryリクエストは、On createが3回連続で失敗して停止したプールのウォームアップを再開します。Warm poolsを参照してください。

ライフサイクルフックClick to copy link​

テンプレートはセットアップスクリプトをhooksオブジェクトに保持します。セッションを読み取るたびに、セットアップのフェーズとフックの実行結果がlifecycleフィールドで報告されます。2つのエンドポイントは失敗したセットアップを再実行し、1つはフックのログを読み取ります。

POST /v1/workspaces/{workspace_id}/sessions/{session_id}/hook-runs
POST /v1/workspaces/{workspace_id}/sessions/{session_id}/rebuild
GET /v1/workspaces/{workspace_id}/sessions/{session_id}/logs/{stage}

ライフサイクルフックを参照してください。

デバイスセッションClick to copy link​

セッション作成リクエストに device_spec を含めると、セッションとともに iOS シミュレーターまたは Android エミュレーターが起動します。artifact を含めると、そのデバイスにアプリのビルドがインストールされます。すべてのセッション読み取りに含まれる device フィールドには、デバイスの状態とインストールの状況が報告されます。Device sessionsをご覧ください。

プレビューリンクエンドポイントは、共有可能なリンクを発行します。受信者は、Bitrise にログインしなくても、ブラウザー上のデバイスでアプリのビルドを開けます。

POST /v1/workspaces/{workspace_id}/preview-links

他のエンドポイントと異なり、Remote Dev Environments アクセスで作成した Workspace API tokenも使用できます。CI パイプラインではこちらを使用してください。Device preview linksをご覧ください。

リファレンスClick to copy link​

エンドポイントの全一覧、リクエストとレスポンスのスキーマ、例については、インタラクティブな API リファレンスをご覧ください。

Remote Dev Environments API reference