Vigilbase One APITools

Execute a tool

Authenticated tool execution for Vigilbase One + CLI. Access is gated by requireToolRunAccessContext (read:services) — same bar as listing/viewing tool runs. write:services is reserved for mutating customer service integrations, not for launching scanners.

POST/api/tools/{toolName}/execute

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.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Needs a key with write access: read-only keys get 403 with the code read_only_key. See organisation API keys.

Path Parameters

toolNamestringrequired

Body

application/json

targetstringrequired

min length 1

metadataobject

Response

Success

More about this endpoint in the guide.

# Token from `vigilbase login`, or a write API key (vb_one_…)
curl --request POST \
  --url 'https://one.vigilbase.com/api/tools/{toolName}/execute' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"target":"<string>","metadata":{}}'

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

Responses

200Success

401Authentication required

403Not permitted

The catalog doesn't include example response bodies for this endpoint.

Was this page helpful?