Sign in

v1

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

Schedule Website Scans

Use this API to schedule scans for the specified domains.

post/api/cmp/v1/webscans/domains/schedule

Request body

domainIdstring uuid required

The unique identifier of the domain.

emailRecipientstring

The email address that will receive notifications.

nextScanDatestring date-time

The date and time when the next scan is scheduled.

intervalType'MONTH' required

The frequency unit for recurring scans.

timeIntervalinteger required

The frequency at which recurring scans are performed.

geoLocation'northeurope' | 'eastus' required

The geographic location settings for the scan.

Example request

[
  {
    "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "emailRecipient": "user1@gmail.com,user2@gmail.com",
    "nextScanDate": "2025-04-25T10:15:30",
    "intervalType": "MONTH",
    "timeInterval": 2,
    "geoLocation": "eastus"
  }
]

Response

OK

entityIdstring uuid

The unique identifier of the entity.

entityType'SCAN' | 'DOMAIN' | 'COOKIE'

The type of entity such as cookie, tag, page, form, service, or storage.

action'ARCHIVE' | 'SCHEDULE' | 'SCHEDULE_CANCEL' | 'EDIT' | 'CREATE' | 'DELETE'

The action that was performed or is to be performed.

messagestring

The message or notification text.

contentobject

The main content or data payload of the response.

successboolean

This flag indicates whether the operation completed successfully.

Example response

[
  {
    "entityId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "entityType": "SCAN",
    "action": "ARCHIVE",
    "message": "Scan queued for archival"
  }
]