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 URL

The API is served at:

https://api.bitrise.io/rde

Authentication

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

Authorization: token YOUR_BITRISE_PAT

Workspace usage report

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.

Reference

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

Remote Dev Environments API reference