---
title: "Scan Websites"
method: POST
path: "/api/cmp/v1/webscans"
tags: ["Scans"]
---

# Scan Websites

`POST /api/cmp/v1/webscans`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/cmp/v1/webscans`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `COOKIE`

Use this API to start scans for the specified domains.

## Query parameters

- `externalOrgId` string

## Request body

- ScanWebsiteRequest[]
  - `domain` string: The website domain being managed.
  - `numberOfPages` integer, required: The total number of web pages found during scanning.
  - `independentPaths` boolean: The unique URL paths discovered during the scanning process.
  - `includedQueryParams` string: The query parameters that are included in the scan.
  - `siteMapsUris` string: The URLs of sitemaps used for the scanning process.
  - `geoLocation` string: The geographic location settings for the scan.
  - `limitScanToSitemap` boolean: This flag indicates whether to restrict scanning to sitemap URLs only.
  - `googleLoginState` boolean: The login state for Google-authenticated scanning.
  - `captureDelayedCookies` boolean: This flag indicates whether to capture cookies that load after the initial page load.
  - `delayTimeInSeconds` integer: The time duration in seconds to wait before capturing delayed cookies.
  - `targetPageInputs` TargetPagesScanEntityDto[]: The input parameters for specific pages to be scanned.
    - `pageListName` string: The name of the page list configuration.
    - `targetType` 'IncludeOnly' | 'Exclude' | 'Target': The type of target being scanned.
    - `urlType` 'Page' | 'Path' | 'Subdomain': The category or type of URL.
    - `pageUrls` string: The list of specific page URLs to be scanned.

## Response `200`

OK

- ServiceResponseDto[]
  - `message` string: The message or notification text.
  - `consentPolicyId` string: The unique identifier of the consent policy.
  - `domainId` string, uuid: The unique identifier of the domain.
  - `scanId` string, uuid: The unique identifier of the scan.
  - `scanType` integer: The type or method of scanning being performed.
  - `rescan` boolean: This flag indicates whether to perform the scan operation again.
  - `ok` boolean: This flag indicates whether the operation was successful.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/revisions/b4fb4606f973?raw)