Skip to main content
POST
/
api
/
workspaces
/
{id}
/
tools
/
{tool}
/
install
Install a tool asynchronously.
curl --request POST \
  --url https://api.rigbox.dev/api/workspaces/{id}/tools/{tool}/install \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "status": "<string>",
  "job_id": "<string>"
}
Installation runs asynchronously. Use Get Install Status to poll for completion.

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

​
tool
string
required

Tool ID

Response

200 - application/json

Tool install dispatched

​
message
string
required
​
status
string
required
​
job_id
string | null