Skip to main content
POST
/
api
/
v1
/
quick-deploy
cURL
curl --request POST \
  --url https://api.rigbox.dev/api/v1/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,
  "service_spec_ids": [
    "<string>"
  ],
  "setup_script_ids": [
    "<string>"
  ],
  "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,
    "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>"
  },
  "expected_apps": [
    {
      "allowed_emails": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "node_id": "<string>",
      "port": 1,
      "subdomain": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_id": "<string>",
      "workspace_id": "<string>",
      "app_kind": "<string>",
      "custom_domain": "<string>",
      "custom_domain_verified": true,
      "depends_on": [
        "<string>"
      ],
      "description": "<string>",
      "managed": true,
      "metadata": "<unknown>",
      "protocol": "<string>",
      "system_tags": [
        "<string>"
      ]
    }
  ],
  "installed_apps": [
    "<string>"
  ]
}

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.

This is the fastest way to get a workspace running. It provisions the workspace, applies template defaults, raises requested resources to the template/catalog floor when needed, and starts the workspace.

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
​
catalog_ids
string[]
​
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
​
service_spec_ids
string[] | null
​
setup_script_ids
string[] | null
​
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[]
​
installed_apps
string[]