ONonetrust
Scans

Scan Websites

Use this API to start scans for the specified domains.

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

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

messagestring

The message or notification text.

consentPolicyIdstring

The unique identifier of the consent policy.

domainIdstring uuid

The unique identifier of the domain.

scanIdstring uuid

The unique identifier of the scan.

scanTypeinteger

The type or method of scanning being performed.

rescanboolean

This flag indicates whether to perform the scan operation again.

okboolean

This flag indicates whether the operation was successful.

Example response

[
  {
    "message": "Scan initiated successfully.",
    "consentPolicyId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "scanId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "scanType": 1
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.