Navigation
VigilbaseDocs

    Type at least two letters.

    Open Vigilbase One

    API reference

    The OpenAPI reference for the vigilbase.com public tools API, badges and agent endpoints.

    View as Markdown
    get/api/badge/{domain}

    Security verification badge

    Returns an SVG badge showing the most recent website-security grade for the given domain, as produced by https://vigilbase.com/tools/website-security. If no grade exists the badge renders a question mark.

    Parameters

    domain (path)*stringDomain to display on the badge. Schemes, `www.` prefixes, and trailing paths are normalised server-side.
    style (query)string: default, compact, miniBadge size variant.

    Responses

    200image/svg+xmlSVG badge image.
    get/api/v1/agent/tools

    List agent-executable tools

    Returns the allowlisted non-intrusive tools agents may run via POST /api/v1/agent/tools/{toolName}/execute, plus skill and UI URLs.

    Responses

    200application/jsonTool catalog.
    401application/problem+jsonInvalid API key.
    403application/problem+jsonMissing tools:read scope.
    429application/problem+jsonRate limit exceeded.
    post/api/v1/agent/tools/security-headers/execute

    Run security-headers scan (agent API)

    Non-intrusive HTTP security headers scan for autonomous agents. Anonymous free tier or Vigilbase One developer API key. Rate limited per IP/key.

    Request body (JSON)

    target*stringScan target. For security-headers prefer a full URL; for email-security use an apex domain.
    {
  "target": "https://example.com"
}

    Responses

    200application/jsonScan completed.
    400application/problem+jsonInvalid request body or malformed target. No scan ran.
    401application/problem+jsonInvalid API key.
    403application/problem+jsonAPI key missing required scope.
    404application/problem+jsonTool not on the agent allowlist.
    422application/problem+jsonScan ran but reported an error status. `grade` and `gradeScore` are null.
    429application/problem+jsonRate limit exceeded, or the hourly scan quota (20 scans per client IP and per target) is spent. Retry-After gives the time until it resets.
    503application/problem+jsonScan storage is temporarily unavailable. No scan ran; retry after the Retry-After delay.
    post/api/v1/agent/tools/email-security/execute

    Run email-security scan (agent API)

    Non-intrusive email authentication DNS scan for autonomous agents. Anonymous free tier or Vigilbase One developer API key. Rate limited per IP/key.

    Request body (JSON)

    target*stringScan target. For security-headers prefer a full URL; for email-security use an apex domain.
    {
  "target": "example.com"
}

    Responses

    200application/jsonScan completed.
    400application/problem+jsonInvalid request body or malformed target. No scan ran.
    401application/problem+jsonInvalid API key.
    403application/problem+jsonAPI key missing required scope.
    404application/problem+jsonTool not on the agent allowlist.
    422application/problem+jsonScan ran but reported an error status. `grade` and `gradeScore` are null.
    429application/problem+jsonRate limit exceeded, or the hourly scan quota (20 scans per client IP and per target) is spent. Retry-After gives the time until it resets.
    503application/problem+jsonScan storage is temporarily unavailable. No scan ran; retry after the Retry-After delay.
    post/api/v1/developer/keys

    Deprecated — create keys on Vigilbase One

    Returns 410 Gone. Self-serve API key minting moved to https://one.vigilbase.com/developers (Better Auth apiKey plugin, user-scoped keys with prefix vb_dev_).

    Responses

    410application/problem+jsonMinting moved to Vigilbase One.
    get/api/agent/tools

    List agent tools (legacy alias)

    Deprecated alias of GET /api/v1/agent/tools. Returns Deprecation/Sunset headers.

    Responses

    200Tool catalog (legacy).