Skip to main content
GET
/
api
/
workspaces
/
{id}
/
tools
/
{tool}
/
status
Get the status of a specific tool.
curl --request GET \
  --url https://api.rigbox.dev/api/workspaces/{id}/tools/{tool}/status \
  --header 'Authorization: Bearer <token>'
{
  "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

​
tool
string
required

Tool ID

Response

200 - application/json

Tool status

​
category
string
required
​
description
string
required
​
discovery
object
required

How this tool detects availability.

​
icon
string
required
​
id
string
required
​
name
string
required
​
port
integer<int32>
required

Port the tool listens on inside the VM.

Required range: x >= 0
​
subdomain_suffix
string
required

Subdomain suffix — e.g. "arch" → arch-{ws_id}.rigbox.dev

​
available
boolean
required
​
project_roots_truncated
boolean
required
​
running
boolean
required
​
install_hint
string | null

User-facing install command when the tool needs setup. Shown in the UI when the tool is unavailable or partially available.

​
tags
string[]

Tags indicating supported languages, runtimes, etc.

​
needs_install
boolean

True if the tool requires setup before it can analyze/launch. Discovery may still work but full functionality needs install.

​
project_roots
string[]
​
started_at_ms
integer<int64> | null
Required range: x >= 0
​
status_sys
string | null

Lifecycle state reported by the tool's background process. Values are tool-defined (e.g. "analyzing", "installing", "building"). None when idle or no background process is running.

​
unavailable_reason
string | null

Brief explanation of why the tool is unavailable.

​
url
string | null