Skip to main content
POST
Start a workspace.
If a stopped workspace is below its template/catalog resource floor, Rigbox raises the stored RAM, vCPU, and disk values before booting. If the account cannot fit the raised resources, the start request fails before the VM is started.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Workspace ID

Response

200 - application/json

Workspace start queued

vm
object
required
failure
null | object

Structured failure info when vm.status == Failed. None otherwise. Computed from the workspace's failure_code, failure_reason, and creation_attempts fields plus the retryable allowlist policy.