Skip to main content

Remote Dev Environments API

The Remote Dev Environments REST API lets you manage sessions, templates, and saved inputs programmatically, and report on what the workspace's active sessions consume. It's the same API that the CLI, the web UI, and the MCP server use.

Experimental API

The RDE API is experimental. Although it's versioned, endpoints and payloads can change in backwards-incompatible ways without notice. Pin your integrations to a known-good behavior and expect to update them.

Base URLClick to copy link​

The API is served at:

https://api.bitrise.io/rde

AuthenticationClick to copy link​

Authenticate with a Bitrise personal access token, sent in the Authorization header:

Authorization: token YOUR_BITRISE_PAT

Workspace usage reportClick to copy link​

The usage endpoint returns a point-in-time snapshot of the workspace's active sessions: session counts and vCPU and memory totals split by OS, workspace-wide and per user. It reports what the sessions consume right now — it's not a historical or billing-period report.

GET /v1/workspaces/{workspace_id}/usage

Unlike the other endpoints, this one requires billing visibility: workspace owners and members with a billing-managing custom role can call it. Other members get a 403 response.

Warm poolsClick to copy link​

The warm pool endpoints manage pools of pre-booted sessions, and the create session and create preview link requests claim from them with 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}

A pool's status reports how many sessions are ready and warming, the warm sessions themselves, and any configuration error. See Warm pools.

Device sessionsClick to copy link​

Include a device_spec in the create session request to boot an iOS simulator or Android emulator with the session, and an artifact to install an app build on it. The device field on every session read reports the device's state and the install status. See Device sessions.

The preview link endpoint mints a shareable link that opens an app build on a device in the recipient's browser, without a Bitrise login:

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

Unlike the other endpoints, it also accepts a Workspace API token created with Remote Dev Environments access, which is what a CI pipeline should use. See Device preview links.

ReferenceClick to copy link​

For the full list of endpoints, request and response schemas, and examples, see the interactive API reference:

Remote Dev Environments API reference

See also