List audit rules

The rule catalogue, for building enabledRulePatterns and disabledRulePatterns

GET/v1/rules

The rule catalogue, grouped by category and sorted by category priority. Use it to build `enabledRulePatterns` and `disabledRulePatterns` for `POST /v1/agent-runs`: a pattern is a category code (`ax`), a category glob (`ax/*`) or an exact rule `id` (`core/robots-meta`). Each rule says whether it `requiresCloud` (reads a cloud-backed step: slower and credit-metered) and whether it `requiresRender` (reads the render step, so it is skipped on a run with `render: false`). The catalogue is the same for every caller and changes only when a new engine version ships, so the response is cacheable (`Cache-Control: public, max-age=3600`). Opt-in rules (`gaps/*`) are not listed and cannot be selected. The hosted MCP `list_rules` and `get_rule` tools return the same fields as `requires_cloud` and `requires_render`.

Responses

The rule catalogue.

totalRulesintegerrequired

Rules in the catalogue, across all categories.

categoriesobject[]required

curl --request GET \
  --url "https://api.squirrelscan.com/v1/rules"

const res = await fetch("https://api.squirrelscan.com/v1/rules", {
  method: "GET",
});
const data = await res.json();

import requests


r = requests.get("https://api.squirrelscan.com/v1/rules")
r.raise_for_status()
data = r.json()

{
  "totalRules": 123,
  "categories": []
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

Edit this page