Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Body

application/json

At least one target (domain_ids, repository_ids, or internal_targets) should be provided.

​
cron_expression
string
required

Cron expression, e.g. 0 9 * * 1.

​
timezone
string
required

IANA timezone, e.g. America/New_York.

​
engagement_type
enum<string>
default:live_test

Which engagement type this run is. Defaults to live_test server-side.

Available options:
code_review,
live_test,
internal_infra,
compliance_pentest
​
domain_ids
string<uuid>[]
​
domain_paths
object

Map of domain ID to specific paths to scan.

​
repository_ids
string<uuid>[]
​
repository_branches
object

Map of repository ID to branch name.

​
credentials
object[]
​
headers
object[]
​
concerns
string
​
focus
string
​
context
string
​
upload_ids
string[]
​
connector_id
string
​
internal_targets
string[]
​
org_knowledge_enabled
boolean
​
notify_on_completion
boolean

Email the scan creator when the pentest finishes.

​
notification_emails
string<email>[]

Extra addresses to CC on the completion email. Validated only when notify_on_completion is true.

​
name
string
​
also_run_now
boolean

If true, immediately launch a scan in addition to creating the schedule.

Response

Schedule created.

​
schedule_id
string
required
​
name
string
required
​
scan_id
string | null

Set when also_run_now was true and scan launched successfully.

​
scan_error
string | null