Skip to main content
GET
/
api
/
workspaces
/
{id}
/
tools
/
{tool}
/
install-status
Poll the status of an async tool install job.
curl --request GET \
  --url https://api.rigbox.dev/api/workspaces/{id}/tools/{tool}/install-status \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "available": true,
  "exit_code": 123,
  "stdout_tail": "<string>"
}

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 status

​
status
string
required

"running", "done", "failed"

​
available
boolean | null

Whether the tool is now available after install

​
exit_code
integer<int32> | null

Exit code (only when done)

​
stdout_tail
string | null

Tail of stdout (only when done)