Batch creation of scan schedules

This operation allows you to create or replace the scan schedule for the specified asset(s).
The requestBody contains information about the asset(s) and the new scan schedule for each asset.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body of the request holds the data to input when creating a schedule. The asset(s) that this schedule is created for is indicated in the request body assetID parameter. The assetID is the "id" field returned from a different request which is documented here:
https://apidocs.whitehatsec.com/whs/reference/assets

assetID
array of int64s
assetID
string
required
length ≤ 256

Name is the name of the schedule
Must contain only utf8 valid characters

in: body

specs
array of objects
required

Specs is a list of specs, each one being a discrete part of the schedule
Applications can only have a single spec, but sites can have multiple specs

in: body

specs*
string
required

TimeZone is the timezone for the schedule
Acceptable values are:
"America/New_York",
"America/Chicago",
"America/Denver",
"America/Los_Angeles",
"America/Anchorage",
"America/Lima",
"America/Santiago",
"America/Sao_Paulo",
"America/St_Johns",
"America/Tegucigalpa",
"America/Toronto",
"Africa/Cairo",
"Africa/Johannesburg",
"Asia/Bangkok",
"Asia/Calcutta",
"Asia/Colombo",
"Asia/Dubai",
"Asia/Hong_Kong",
"Asia/Jerusalem",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Singapore",
"Asia/Tokyo",
"Asia/Vladivostok",
"Australia/Adelaide",
"Australia/Sydney",
"Europe/Amsterdam",
"Europe/Athens",
"Europe/London",
"Europe/Moscow",
"Pacific/Auckland",
"Pacific/Honolulu"

in: body

Responses

401

UnauthorizedResponse signals an unauthorized API access

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized

500

GenericError generic error

Language
LoadingLoading…
Response
Choose an example:
application/json