Skip to main content
POST
/
api
/
v1
/
workspaces
cURL
curl --request POST \
  --url https://api.rigbox.dev/api/v1/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "catalog_ids": [
    "<string>"
  ],
  "disk_size_mb": 1,
  "image": "<string>",
  "ram_mb": 1,
  "service_spec_ids": [
    "<string>"
  ],
  "setup_script_ids": [
    "<string>"
  ],
  "template_id": "<string>",
  "vcpu_count": 1
}
'
{
  "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.

The workspace starts in provisioned status. Pass template_id to create it from a template; requested RAM, vCPU, and disk values below the template/catalog floor are raised before the workspace is stored. Call Start Workspace to boot it.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
​
catalog_ids
string[] | null
​
disk_size_mb
integer<int32> | null
Required range: x >= 0
​
image
string | null
​
ram_mb
integer<int32> | null
Required range: x >= 0
​
service_spec_ids
string[] | null
​
setup_script_ids
string[] | null
​
template_id
string | null
​
vcpu_count
integer<int32> | null
Required range: x >= 0

Response

201 - application/json

Workspace created

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