Navigation
VigilbaseDocs

    Type at least two letters.

    Open Vigilbase One
    Agent APIBadges

    Get a security badge

    An SVG badge with the most recent website-security grade for the domain, as produced by https://vigilbase.com/tools/website-security; a question mark when there is none. Cached 24 hours for a grade, 1 hour for a question mark. Errors are plain text: 400 Invalid domain for anything but a bare domain name, 429 after 60 badges a minute from one client.

    GET/badge/{domain}

    Authorizations

    None. This endpoint is public and reads no API key.

    Path Parameters

    domainstringrequired

    Bare domain name. Letter case, a leading www. and a trailing dot are ignored; a scheme, port or path is refused.

    min length 3max length 255

    Query Parameters

    stylestring

    Badge size.

    One of:defaultcompactmini

    Response

    image/svg+xml

    The SVG badge. X-Vigilbase-Grade names the grade shown.

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

    Was this page helpful?