---
title: "Set Scan Schedule"
method: POST
path: "/v1/scans/schedule"
tags: ["scans"]
---

# Set Scan Schedule

`POST /v1/scans/schedule`

set a scan schedule for a user

## Headers

- `X-Team-Id` string

## Request body

- object
  - `scan_id` string, required
  - `scan_frequency` 'hourly' | 'daily' | 'weekly' | 'monthly' | 'custom', required — Allowed frequencies for the scheduler
  - `start_time` string, time
  - `hourly_frequency` integer
  - `custom_weekdays` integer[] — 0-6 denoting Sunday-Saturday. It accepts an array of weekday

## Response `200`

Example response

- object
  - `message` string, required

## Other responses

- `400` — Example response
- `401` — Example response
- `500` — Example response
- `default` — Example response

## Changes

- **2025-08-13** `c41cd7ae7718` — 18 info
  - added the optional property `code` to the response with the `400` status
  - added the optional property `code` to the response with the `401` status
  - added the optional property `code` to the response with the `500` status
  - added the optional property `error` to the response with the `400` status
  - …14 more
- **2024-09-22** `407b73d9ce28` — 1 info
  - added the new optional `header` request parameter `X-Team-Id`
- **2024-04-19** `ba8a20839440` — 1 breaking, 8 info
  - request property `scan_frequency` was restricted to a list of enum values
  - added the new optional request property `custom_weekdays`
  - added the new optional request property `hourly_frequency`
  - added the new optional request property `start_time`
  - …5 more
- **2024-01-31** `4f557b176ebd` — 5 breaking, 6 warning, 4 info
  - the request property `scan_id` became required
  - removed the enum value `daily` of the request property `scan_frequency`
  - removed the enum value `monthly` of the request property `scan_frequency`
  - removed the enum value `weekly` of the request property `scan_frequency`
  - …11 more
- **2023-12-06** `35be9c1301b7` — 1 info
  - api tag `scans` added

[Full history](https://skmtc.dev/projectdiscovery/apis/pdcp-api/changes/v1/scans/schedule/post.md)

---

[API](https://skmtc.dev/projectdiscovery/apis/pdcp-api.md) · [All operations](https://skmtc.dev/projectdiscovery/apis/pdcp-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/projectdiscovery/pdcp-api/revisions/220f0adf9efd/schema)