v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Websites V2

Add Websites to Scan

Use this API to add a website or multiple websites to the scanner.

post/v2/websites

Query parameters

externalOrgIdstring required

The value defaults to the organization from which the client credentials were generated. Enter a specific sub-org ID if the filter results are desired.

Request body

domainstring required

Domain name of the website to scan.

numberOfPagesinteger required

Number of pages to scan. Number of pages depend on page limit set for each tenant. If a higher value is provided, then the page limit will have priority.

independentPathsboolean required

Whether to scan independent paths.

includedQueryParamsstring

Query parameters to include in the scan.

siteMapsUrisstring

URIs for the sitemaps.

geoLocationstring

Geographical location for the scan.

uniqueUserAgentboolean

Indicates if a unique user agent should be used.

limitScanToSitemapboolean

Limits the scan to the sitemap.

googleLoginStateboolean

Indicates if Google login is required.

Response

OK