Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Scans

Scan Websites

Use this API to start scans for the specified domains.

post/api/cmp/v1/webscans

Query parameters

externalOrgIdstring

The external organization identifier.

Request body

domainstring

The website domain being managed.

numberOfPagesinteger required

The total number of web pages found during scanning.

independentPathsboolean

The unique URL paths discovered during the scanning process.

includedQueryParamsstring

The query parameters that are included in the scan.

siteMapsUrisstring

The URLs of sitemaps used for the scanning process.

geoLocationstring

The geographic location settings for the scan.

limitScanToSitemapboolean

This flag indicates whether to restrict scanning to sitemap URLs only.

googleLoginStateboolean

The login state for Google-authenticated scanning.

captureDelayedCookiesboolean

This flag indicates whether to capture cookies that load after the initial page load.

delayTimeInSecondsinteger

The time duration in seconds to wait before capturing delayed cookies.

Example request

[
  {
    "domain": "amazon.com",
    "numberOfPages": 100,
    "includedQueryParams": "_vercel_share=Hcj4MQ8SLN8pxXPrw7wbrCfxXBuZnPa6",
    "siteMapsUris": "https://preprod.johnniewalker.com/sitemap.xml ",
    "geoLocation": "northeurope",
    "captureDelayedCookies": true,
    "delayTimeInSeconds": 3,
    "targetPageInputs": [
      {
        "pageListName": "page list 1",
        "targetType": "Target",
        "urlType": "Page",
        "pageUrls": "https://service.braun.com/hr/en/products/6032"
      }
    ]
  }
]

Response

OK

consentPolicyIdstring

Consent policy associated with the scan.

domainIdstring uuid

ID of the domain under scan.

messagestring

Scan response message.

notificationTemplateIdstring

Notification template associated with the scan.

okboolean
rescanboolean

Flag to indicate if the rescan is required or not.