Web Scanner Rules

Manage suppression rules attached to a web scanner. Rules tell the scanner to ignore specific cookies, hostnames, or full script URLs during crawl analysis. Rules are scoped to a parent scanner — list, find, create, update, or delete by rule id.

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

scannerId*string

The web scanner whose suppression rules should be returned.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/web-scanner-rules?scannerId=string"

{
  "entities": [
    {
      "id": "string",
      "scannerId": "string",
      "accountId": "string",
      "name": "string",
      "reason": "approved",
      "notes": "string",
      "priority": 0,
      "cookiePatterns": [
        "string"
      ],
      "domainPatterns": [
        "string"
      ],
      "scriptPatterns": [
        "string"
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "createdByUserId": "string",
      "updatedByUserId": "string"
    }
  ]
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

scannerId*string

The web scanner this rule belongs to.

Length1 <= length

name*string

User-friendly name for the suppression rule.

Length1 <= length <= 500

priority*integer

Rule priority (1–10,000). Lower numbers are evaluated first when multiple rules match.

Range1 <= value <= 10000

reason?|

Why this rule was added. Surfaced in audit views. Send null to clear an existing reason on patch.

notes?|

Free-form notes about why this rule exists or what it covers. Trimmed server-side; empty strings become null.

cookiePatterns?array<>

Glob patterns matched against cookie names (e.g. _ga*). Max 100 entries. When sent on PATCH, replaces the existing list wholesale.

Itemsitems <= 100

domainPatterns?array<>

Glob patterns matched against cookie domain / script hostname (e.g. *.google-analytics.com). Max 100 entries. When sent on PATCH, replaces the existing list wholesale.

Itemsitems <= 100

scriptPatterns?array<>

Glob patterns matched against full script URLs (e.g. https://www.googletagmanager.com/gtm.js?id=*). Max 100 entries. When sent on PATCH, replaces the existing list wholesale.

Itemsitems <= 100

Response Body

`application/json`

curl -X POST "https://app.oursprivacy.com/rest/v1/web-scanner-rules" \  -H "Content-Type: application/json" \  -d '{    "scannerId": "string",    "name": "string",    "priority": 1  }'

{
  "id": "string",
  "scannerId": "string",
  "accountId": "string",
  "name": "string",
  "reason": "approved",
  "notes": "string",
  "priority": 0,
  "cookiePatterns": [
    "string"
  ],
  "domainPatterns": [
    "string"
  ],
  "scriptPatterns": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "createdByUserId": "string",
  "updatedByUserId": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/web-scanner-rules/string"

{
  "id": "string",
  "scannerId": "string",
  "accountId": "string",
  "name": "string",
  "reason": "approved",
  "notes": "string",
  "priority": 0,
  "cookiePatterns": [
    "string"
  ],
  "domainPatterns": [
    "string"
  ],
  "scriptPatterns": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "createdByUserId": "string",
  "updatedByUserId": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 500

priority?integer

Range1 <= value <= 10000

reason?|

Why this rule was added. Surfaced in audit views. Send null to clear an existing reason on patch.

notes?|

Free-form notes about why this rule exists or what it covers. Trimmed server-side; empty strings become null.

cookiePatterns?array<>

Glob patterns matched against cookie names (e.g. _ga*). Max 100 entries. When sent on PATCH, replaces the existing list wholesale.

Itemsitems <= 100

domainPatterns?array<>

Glob patterns matched against cookie domain / script hostname (e.g. *.google-analytics.com). Max 100 entries. When sent on PATCH, replaces the existing list wholesale.

Itemsitems <= 100

scriptPatterns?array<>

Glob patterns matched against full script URLs (e.g. https://www.googletagmanager.com/gtm.js?id=*). Max 100 entries. When sent on PATCH, replaces the existing list wholesale.

Itemsitems <= 100

Response Body

`application/json`

curl -X PATCH "https://app.oursprivacy.com/rest/v1/web-scanner-rules/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "scannerId": "string",
  "accountId": "string",
  "name": "string",
  "reason": "approved",
  "notes": "string",
  "priority": 0,
  "cookiePatterns": [
    "string"
  ],
  "domainPatterns": [
    "string"
  ],
  "scriptPatterns": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "createdByUserId": "string",
  "updatedByUserId": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://app.oursprivacy.com/rest/v1/web-scanner-rules/string"

{
  "id": "string",
  "deleted": true
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Web Scanner Rules

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`