Skip to main content
POST
/
v1
/
scans
/
schedule
Set Scan Schedule
curl --request POST \
  --url https://api.projectdiscovery.io/v1/scans/schedule \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "scan_id": "<string>",
  "scan_frequency": "hourly",
  "start_time": "<string>",
  "hourly_frequency": 12,
  "custom_weekdays": [
    3
  ]
}
'
{
  "message": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Team-Id
string

Retrieve the Team ID from: https://cloud.projectdiscovery.io/settings/team

Body

application/json
​
scan_id
string
required
​
scan_frequency
enum<string>
required

Allowed frequencies for the scheduler

Available options:
hourly,
daily,
weekly,
monthly,
custom
​
start_time
string<time>
​
hourly_frequency
integer
Required range: 1 <= x <= 24
​
custom_weekdays
integer[]

0-6 denoting Sunday-Saturday. It accepts an array of weekday

Required range: 0 <= x <= 6

Response

Example response

​
message
string
required