Get a tool run

One tool run with its stored result.

Deprecated aliases: GET https://one.vigilbase.com/api/tool-runs/{id}. They answer with the same bodies, with a Deprecation header and a successor-version link to this URL.

GET/tool-runs/{runId}

Authorizations

Send one of these:

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login. Scope: one:api.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Read-only keys work. See organisation API keys.

AuthorizationstringMCP tokenheaderrequired

Vigilbase Identity access token issued to an MCP client (mcp.vigilbase.com). Scope: one:read.

Permissions checkedread:services

Path Parameters

runIdstringuuidrequired

Query Parameters

customerIdstringuuid

Response

application/json

Success

idstringuuidrequired

toolNamestringrequired

targetstringrequired

targetTypestringrequired

statusstringrequired

pending, running, completed, failed, …

gradestring | nullrequired

gradeScorenumber | nullrequired

sourceAppstring | nullrequired

emailstring | nullrequired

Who ran it.

createdAtanyrequired

startedAtanyrequired

completedAtanyrequired

customerIdanyrequired

unlockedbooleanrequired

errorMessagestring | nullrequired

resultsanyrequired

The tool’s stored result.

2 response headers

X-Request-Idstring

The request ID: yours when it was well-formed, otherwise a new one. Quote it to support.

API-Versionstring

The major API version (informational; the version is in the path).

More about this endpoint in the guide.

# Token from `vigilbase login`, or an API key (vb_one_…)
curl --request GET \
  --url 'https://api.vigilbase.com/one/v1/tool-runs/{runId}' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

Set VIGILBASE_TOKEN to an Identity access token or an organisation API key first, or use Try it.

{
  "id": "<uuid>",
  "toolName": "<string>",
  "target": "<string>",
  "targetType": "<string>",
  "status": "<string>",
  "grade": "<string>",
  "gradeScore": 123,
  "sourceApp": "<string>",
  "email": "<string>",
  "createdAt": "<any>",
  "startedAt": "<any>",
  "completedAt": "<any>",
  "customerId": "<any>",
  "unlocked": true,
  "errorMessage": "<string>",
  "results": "<any>"
}

Was this page helpful?