Skip to main content
POST
/
api
/
workspaces
/
{id}
/
install-app
Install a catalog app into a workspace.
curl --request POST \
  --url https://api.rigbox.dev/api/workspaces/{id}/install-app \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "catalog_id": "<string>",
  "params": {}
}
'
{
  "app": {
    "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>"
    ]
  },
  "live_installed": true,
  "message": "<string>",
  "credentials": {},
  "job_id": "<string>"
}
Installation runs as a background job. Use Get Job Status to track progress.

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

Body

application/json
catalog_id
string
required
params
object

User-supplied values for the app's configurable_params.

Response

200 - application/json

Catalog app installed successfully

app
object
required
live_installed
boolean
required

If workspace is running, whether live install was attempted.

message
string
required
credentials
object

Credentials generated at install time (only for apps that require login).

job_id
string | null

Job ID for async install — frontend should poll GET /workspaces/{id}/jobs/{job_id}.