Skip to main content
POST
/
api
/
v1
/
workspaces
/
{id}
/
start
cURL
curl --request POST \
  --url https://api.rigbox.dev/api/v1/workspaces/{id}/start \
  --header 'Authorization: Bearer <token>'
{
  "vm": {
    "created_at": "2023-11-07T05:31:56Z",
    "disk_size_mb": 1,
    "id": "<string>",
    "image": "<string>",
    "name": "<string>",
    "node_id": "<string>",
    "ram_mb": 1,
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "vcpu_count": 1,
    "ai_mode": "<string>",
    "creation_attempts": 123,
    "creation_started_at": "2023-11-07T05:31:56Z",
    "env_vars": {},
    "failure_code": "<string>",
    "failure_reason": "<string>",
    "ip_address": "<string>",
    "service_spec_ids": [
      "<string>"
    ],
    "setup_script_ids": [
      "<string>"
    ],
    "template_id": "<string>"
  },
  "failure": {
    "attempts": 123,
    "code": "<string>",
    "message": "<string>",
    "occurred_at": "2023-11-07T05:31:56Z",
    "retryable": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt

Use this file to discover all available pages before exploring further.

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
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.