Type at least two letters.

    ↑ ↓ to moveEnter to open

    Rules API

    The check catalogue of the live profile.

    Updated

    1 live operation. Built from the OpenAPI contract at every release, so this page never lists an endpoint that does not work. Paths are relative to the base URL.

    To try these with your own account, sign in and open Automation → Try the API in the app.

    Every check, its audit level and what it means

    GET/api/v1/rules
    PublicoperationId: listRules

    Responses

    200object

    Rule catalogue

    1 field
    dataarray of Rule
    8 fields of data
    idstring
    versionstring
    areastring

    One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure

    titlestring
    whyItMattersstring
    defaultSeveritystring

    One of: info, low, medium, high

    levelstring

    `passive` reads what every visitor sees and runs on any public site. `deep` adds requests a visitor would not make (for example files that should not be public) and runs only on a verified site.

    One of: passive, deep

    creditsinteger

    What running this check costs: 1 when it is read from the page that is fetched anyway, 2 when it needs its own lookup or request, 3 to 5 for deep requests.

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.