Skip to main content
POST
Install a catalog app into a workspace.
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 | null

User-supplied values for the app's configurable_params.

Response

200 - application/json

Catalog app installed successfully

app
object
required

OpenAPI-facing mirror of the canonical app payload.

Response types can keep serializing rig_data_store::models::App while pointing schema generation at this local mirror to avoid cross-crate derive coupling in utoipa.

live_installed
boolean
required

If workspace is running, whether live install was attempted.

message
string
required
credentials
object | null

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