List inventory rules

Lists the rules that decide scripts automatically. Each rule matches script URLs against a pattern such as https://*.stripe.com/* and applies its text and tags during reconciliation, either justifying the script or excluding it from PCI scope. Rules are tried in sortOrder and the first match wins, whichever outcome it carries. Filter by action to see only one kind.

Requires the viewer role on the website and the compliance plan feature.

Authorization

AuthorizationBearer <token>

An OpenID Connect access token issued by Keycloak, acting as the signed-in user.

In: header

Path Parameters

workspaceId*string

websiteId*string

Query Parameters

cursor?string

The nextCursor of the previous page. Omit it to start from the beginning. A cursor encodes a position and is not meant to be built by hand.

limit*|

How many items to return, from 1 to 200.

Range1 <= value <= 200

Default50

q?string

Match part of the rule name.

Lengthlength <= 255

action?RuleActionFilter

Only return rules with this outcome.

Value in

"justify"
"exclude"

Response Body

`application/json`

curl -X GET "https://example.com/v1/workspaces/string/websites/string/compliance/rules?limit=50"

{  "data": [    {      "id": "string",      "workspaceId": "string",      "websiteId": "string",      "name": "Stripe",      "urlPattern": "https://*.stripe.com/*",      "patternType": "glob",      "action": "justify",      "justification": "string",      "tagIds": [        "string"      ],      "enabled": true,      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true,    "total": 0  }}