Agent APIAgent tools

List agent tools

Returns the allowlisted non-intrusive tools agents may run, their skill and UI URLs, and the caller's rate limits. Anonymous calls get the free tier (10 requests a minute per IP); a developer API key from https://one.vigilbase.com/developers gets 30 a minute.

Deprecated aliases: GET https://vigilbase.com/api/v1/agent/tools (410 Gone from 2027-02-01), GET https://vigilbase.com/api/agent/tools (410 Gone from 2027-02-01). They answer with the same bodies, with a Deprecation header and a successor-version link to this URL. Until their Sunset date; from then on they answer 410 Gone with the successor URL.

GET/agent/tools

Authorizations

Optional. Without a key, requests use the anonymous free tier. Send one of these headers:

Authorizationstringheader

Developer API key (prefix vb_dev_), as a Bearer token or in the X-Api-Key header. Format: Bearer <token>. Scope: tools:read.

Response

application/json

Success

successbooleanrequired

Value:true

apiVersionstring

descriptionstring

openapistringuri

docsUrlstringuri

skillsIndexstringuri

toolsobject[]required

7 child attributes

toolNamestringrequired

namestringrequired

descriptionstringrequired

targetDescriptionstringrequired

uiUrlstringurirequired

skillUrlstringurirequired

executeUrlstringurirequired

Where to POST a scan, on api.vigilbase.com/tools/v1 whichever host served the catalogue.

authobject

4 child attributes

anonymousScopesstring[]

developerKeyScopesstring[]

headerstring

manageKeysstringuri

rateLimitobject

6 child attributes

windowSecondsinteger

minimum -9007199254740991maximum 9007199254740991

maxRequestsinteger

minimum -9007199254740991maximum 9007199254740991

tierstring

scopestring

scanQuotaobject

5 child attributes

windowSecondsinteger

minimum -9007199254740991maximum 9007199254740991

maxScansPerClientIpinteger

minimum -9007199254740991maximum 9007199254740991

maxScansPerTargetinteger

minimum -9007199254740991maximum 9007199254740991

maxScansOverallinteger

minimum -9007199254740991maximum 9007199254740991

scopestring

dailyAllowanceobject

The free daily scan allowance executes spend, shared with the vigilbase.com tools.

6 child attributes

tierstringrequired

anonymous (per network), signed_in (per Vigilbase account, for signed-in Vigilbase MCP users) or developer (a developer API key spends none).

limitinteger

Scans per UTC day: 5 anonymous, 50 signed in; absent for a developer key.

minimum -9007199254740991maximum 9007199254740991

usedinteger

minimum -9007199254740991maximum 9007199254740991

remaininginteger

minimum -9007199254740991maximum 9007199254740991

resetsAtstring

Next UTC midnight, ISO 8601. Absent with used and remaining when the limiter could not answer.

scopestring

deprecationobject

3 child attributes

legacybooleanrequired

Value:true

successorstringurirequired

sunsetstringrequired

4 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).

RateLimitstring

Remaining quota under the "default" policy (draft-ietf-httpapi-ratelimit-headers-11).

RateLimit-Policystring

The "default" policy: quota and window (draft-ietf-httpapi-ratelimit-headers-11).

curl --request GET \
  --url 'https://api.vigilbase.com/tools/v1/agent/tools'

{
  "success": true,
  "apiVersion": "<string>",
  "description": "<string>",
  "openapi": "<uri>",
  "docsUrl": "<uri>",
  "skillsIndex": "<uri>",
  "tools": [
    {
      "toolName": "security-headers",
      "name": "<string>",
      "description": "<string>",
      "targetDescription": "<string>",
      "uiUrl": "<uri>",
      "skillUrl": "<uri>",
      "executeUrl": "<uri>"
    }
  ],
  "auth": {
    "anonymousScopes": [
      "<string>"
    ],
    "developerKeyScopes": [
      "<string>"
    ],
    "header": "<string>",
    "manageKeys": "<uri>"
  },
  "rateLimit": {
    "windowSeconds": 123,
    "maxRequests": 123,
    "tier": "<string>",
    "scope": "<string>",
    "scanQuota": {
      "windowSeconds": 123,
      "maxScansPerClientIp": 123,
      "maxScansPerTarget": 123,
      "maxScansOverall": 123,
      "scope": "<string>"
    },
    "dailyAllowance": {
      "tier": "<string>",
      "limit": 123,
      "used": 123,
      "remaining": 123,
      "resetsAt": "<string>",
      "scope": "<string>"
    }
  },
  "deprecation": {
    "legacy": true,
    "successor": "<uri>",
    "sunset": "<string>"
  }
}

Was this page helpful?