Web Scanners

Manage web scanners that crawl your sites for trackers, cookies, and third-party requests. Create a scanner against a root domain, edit its crawl scope, trigger a scan on demand, or delete it (which also removes its suppression rules).

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/web-scanners"

{
  "entities": [
    {
      "id": "string",
      "accountId": "string",
      "name": "string",
      "status": "Disabled",
      "rootDomain": "string",
      "excludedPatterns": [
        "string"
      ],
      "includedUrls": [
        "string"
      ],
      "urlLimit": 0,
      "scanStatus": "idle",
      "lastScannedAt": "string",
      "lastScanStartedAt": "string",
      "lastRunCookieCount": 0,
      "lastRunRequestCount": 0,
      "lastRunSuccessUrlCount": 0,
      "lastRunHighRiskRequestCount": 0,
      "createdAt": "string",
      "updatedAt": "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.

rootDomain*string

Root domain to crawl (e.g. example.com). Required on create. Missing or empty values fail request validation as HTTP 400. Present-but-malformed values are rejected as HTTP 400 with the validation reason in details.

Length1 <= length

name?|

status?string

Value in"Disabled" | "Enabled"

excludedPatterns?array<>|

URL glob patterns to skip during crawl. Max 100 entries.

includedUrls?array<>|

Additional seed URLs to include as crawl entry points. Each must be an http(s) URL. Max 100 entries.

urlLimit?|

Maximum URLs to crawl per scan (1–20,000). Defaults to 100 when omitted.

Response Body

`application/json`

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

{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "status": "Disabled",
  "rootDomain": "string",
  "excludedPatterns": [
    "string"
  ],
  "includedUrls": [
    "string"
  ],
  "urlLimit": 0,
  "scanStatus": "idle",
  "lastScannedAt": "string",
  "lastScanStartedAt": "string",
  "lastRunCookieCount": 0,
  "lastRunRequestCount": 0,
  "lastRunSuccessUrlCount": 0,
  "lastRunHighRiskRequestCount": 0,
  "createdAt": "string",
  "updatedAt": "string"
}

{
  "error": "string",
  "details": "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-scanners/string"

{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "status": "Disabled",
  "rootDomain": "string",
  "excludedPatterns": [
    "string"
  ],
  "includedUrls": [
    "string"
  ],
  "urlLimit": 0,
  "scanStatus": "idle",
  "lastScannedAt": "string",
  "lastScanStartedAt": "string",
  "lastRunCookieCount": 0,
  "lastRunRequestCount": 0,
  "lastRunSuccessUrlCount": 0,
  "lastRunHighRiskRequestCount": 0,
  "createdAt": "string",
  "updatedAt": "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.

rootDomain?|

Replace the scanner root domain. When provided, malformed values are rejected as HTTP 400 with the validation reason in details.

name?|

status?string

Value in"Disabled" | "Enabled"

excludedPatterns?array<>|

includedUrls?array<>|

urlLimit?|

Response Body

`application/json`

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

{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "status": "Disabled",
  "rootDomain": "string",
  "excludedPatterns": [
    "string"
  ],
  "includedUrls": [
    "string"
  ],
  "urlLimit": 0,
  "scanStatus": "idle",
  "lastScannedAt": "string",
  "lastScanStartedAt": "string",
  "lastRunCookieCount": 0,
  "lastRunRequestCount": 0,
  "lastRunSuccessUrlCount": 0,
  "lastRunHighRiskRequestCount": 0,
  "createdAt": "string",
  "updatedAt": "string"
}

{
  "error": "string",
  "details": "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-scanners/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"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://app.oursprivacy.com/rest/v1/web-scanners/string/trigger"

{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "status": "Disabled",
  "rootDomain": "string",
  "excludedPatterns": [
    "string"
  ],
  "includedUrls": [
    "string"
  ],
  "urlLimit": 0,
  "scanStatus": "idle",
  "lastScannedAt": "string",
  "lastScanStartedAt": "string",
  "lastRunCookieCount": 0,
  "lastRunRequestCount": 0,
  "lastRunSuccessUrlCount": 0,
  "lastRunHighRiskRequestCount": 0,
  "createdAt": "string",
  "updatedAt": "string"
}

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

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

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

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

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

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

Web Scanners

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/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

409application/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

409application/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`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`