Skip to main content
POST
/
api
/
quick-deploy
Create a workspace from a template.
curl --request POST \
  --url https://api.rigbox.dev/api/quick-deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_id": "<string>",
  "app_params": {},
  "catalog_ids": [
    "<string>"
  ],
  "disk_size_mb": 1,
  "env_vars": {},
  "name": "<string>",
  "ram_mb": 1,
  "vcpu_count": 1
}
'
{
  "message": "<string>",
  "workspace": {
    "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>"
  },
  "expected_apps": [
    {
      "allowed_emails": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "node_id": "<string>",
      "port": 1,
      "status": "active",
      "subdomain": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_id": "<string>",
      "visibility": "private",
      "workspace_id": "<string>",
      "description": "<string>",
      "managed": true,
      "metadata": "<unknown>",
      "protocol": "<string>",
      "system_tags": [
        "<string>"
      ]
    }
  ],
  "installed_apps": [
    "<string>"
  ]
}
This is the fastest way to get a workspace running. It provisions the workspace, applies template defaults, and returns the workspace object ready to start.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
template_id
string
required
​
app_params
object

User-supplied parameter values for template expected apps, keyed by app name. E.g. { "gateway": { "ai_provider": "anthropic", "telegram_bot_token": "..." } }

​
catalog_ids
string[]

Optional catalog app IDs to pre-install (Phase 3 composition).

​
disk_size_mb
integer<int32> | null
Required range: x >= 0
​
env_vars
object
​
name
string | null
​
ram_mb
integer<int32> | null
Required range: x >= 0
​
vcpu_count
integer<int32> | null
Required range: x >= 0

Response

200 - application/json

Workspace created from template

​
message
string
required
​
workspace
object
required
​
expected_apps
object[]

Expected apps created for this template (status=Installing). Frontend should track these for install progress.

​
installed_apps
string[]

Catalog apps that were pre-installed.