CentralCSP
APIInventory Rules

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 outcome, text and tags to matching scripts. Rules are tried in sortOrder and the first match wins.

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

GET
/v1/workspaces/{workspaceId}/websites/{websiteId}/compliance/rules

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

websiteId*string

The website's id.

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""reject""exclude"

Response Body

A page of inventory rules.

application/json
  1. response
data*array<>

The inventory rules on this page.

pagination*

Where this page sits in the full result set.

Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/websites/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/compliance/rules?limit=50'
Example Response
{  "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  }}