---
title: "Schedule Website Scans"
method: POST
path: "/api/cmp/v1/webscans/domains/schedule"
tags: ["Domains"]
---

# Schedule Website Scans

`POST /api/cmp/v1/webscans/domains/schedule`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/cmp/v1/webscans/domains/schedule`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `COOKIE`

Use this API to schedule scans for the specified domains.

## Request body

- DomainScheduleRequest[]
  - `domainId` string, uuid, required: The unique identifier of the domain.
  - `emailRecipient` string: The email address that will receive notifications.
  - `nextScanDate` string, date-time: The date and time when the next scan is scheduled.
  - `intervalType` 'MONTH', required: The frequency unit for recurring scans.
  - `timeInterval` integer, required: The frequency at which recurring scans are performed.
  - `geoLocation` 'northeurope' | 'eastus', required: The geographic location settings for the scan.

## Response `200`

OK

- EntityActionResponseDto[]
  - `entityId` string, 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.
  - `message` string: The message or notification text.
  - `content` object: The main content or data payload of the response.
  - `success` boolean: This flag indicates whether the operation completed successfully.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/revisions/b4fb4606f973?raw)