Websites V2
Get List of Websites
Use this API to retrieve a list of all websites in the scanner. The response will return websites in Pending and Completed status along with the corresponding domain ID, external organization ID, and last scanned date.
🗒 Things to Know
- It is recommended to use the page and size parameters if the number of domains is greater than 1,000.
get/v2/websites
Query parameters
externalOrgIdstring
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.
searchStrstring
Enter a URL to search for a specific domain.
pageinteger
This value can be used for getting a particular page of the paginated response.
sizeinteger
Number of records per page (0....N).
sort'ScanStatus,ASC' | 'ScanStatus,DESC' | 'Url,ASC' | 'Url,DESC' | 'PagesScanned,ASC' | 'PagesScanned,DESC' | 'TotalCookieCount,ASC' | 'TotalCookieCount,DESC' | 'ConsentPolicyName,ASC' | 'ConsentPolicyName,DESC' | 'ScheduledNextScanDate,ASC' | 'ScheduledNextScanDate,DESC'
The sorting criteria of the result list.
Response
OK
List of websites retrieved successfully.
Example response
{
"sort": {
"empty": true,
"sorted": true
}
}