Skip to main content
POST
/
api
/
workspaces
Create a new workspace.
curl --request POST \
  --url https://api.rigbox.dev/api/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>"
  ],
  "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,
    "status": "provisioned",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "vcpu_count": 1,
    "env_vars": {},
    "ip_address": "<string>",
    "service_spec_ids": [
      "<string>"
    ],
    "setup_script_ids": [
      "<string>"
    ],
    "template_id": "<string>"
  }
}
The workspace starts in provisioned status. 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
vcpu_count
integer<int32> | null
Required range: x >= 0

Response

Workspace created

vm
object
required