Version: 1.0.0

Bitrise Remote Dev Environments API

API for managing Bitrise Remote Dev Environments (RDE).

⚠️ Experimental API. Breaking changes may be introduced at any time without notice or a deprecation period.

Authentication

All endpoints require a Bitrise Personal Access Token (PAT) sent as a bearer token in the Authorization header:

Authorization: token <YOUR_PAT>

Generate a PAT from your Bitrise account settings.

Base URL

Production: https://api.bitrise.io/rde

Errors

Non-2xx responses share a single JSON envelope:

{
  "code": 5,
  "message": "template not found",
  "details": []
}

The code field is a numeric status code (not the HTTP status code). Clients should switch on code for programmatic handling and surface message to humans. Common values:

HTTP	code	Name	When
400	3	InvalidArgument	Request validation failed; per-field violations may appear in details.
401	16	Unauthenticated	Missing or invalid Authorization header / PAT.
403	7	PermissionDenied	The PAT does not have access to the requested workspace or resource.
404	5	NotFound	The resource does not exist (or is not visible to this PAT).
409	10	Aborted	Request conflicts with the current resource state (e.g. session already running).
412	9	FailedPrecondition	A precondition for the action was not met (e.g. session not running yet).
500	13	Internal	Unexpected server-side failure. Safe to retry with backoff.
503	14	Unavailable	A downstream dependency was temporarily unreachable. Safe to retry with backoff.

Authentication

API Key: BearerAuth

Bitrise Personal Access Token, sent as token <PAT>.

Security Scheme Type:	apiKey
Header parameter name:	Authorization