Skip to main content
GET
/
api
/
workspaces
/
{id}
/
tools
List available tools and their status for a workspace.
curl --request GET \
  --url https://api.rigbox.dev/api/workspaces/{id}/tools \
  --header 'Authorization: Bearer <token>'
{
  "tools": [
    {
      "category": "<string>",
      "description": "<string>",
      "discovery": {
        "filenames": [
          "<string>"
        ],
        "max_depth": 1,
        "max_projects": 1,
        "type": "FilePresence",
        "exclude_paths": [
          "<string>"
        ]
      },
      "icon": "<string>",
      "id": "<string>",
      "name": "<string>",
      "port": 1,
      "subdomain_suffix": "<string>",
      "available": true,
      "project_roots_truncated": true,
      "running": true,
      "install_hint": "<string>",
      "tags": [
        "<string>"
      ],
      "needs_install": true,
      "project_roots": [
        "<string>"
      ],
      "started_at_ms": 1,
      "status_sys": "<string>",
      "unavailable_reason": "<string>",
      "url": "<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

Response

200 - application/json

List of available workspace tools with status

tools
object[]
required