Skip to main content

List schedules

Required scope: schedules:read

Create a schedule

A schedule requires cron_expression, timezone, and at least one target (domain_ids or repository_ids).
Required scope: schedules:write

Get schedule detail

Required scope: schedules:read

Get a schedule’s editable configuration

This endpoint returns the full stored configuration of the schedule in a format that you can edit with PATCH. The configuration includes targets, prompts, test users, headers, scope, timing, notifications, and uploads. The response gives stored secrets (passwords, TOTP seeds, and header values) as metadata only, not in plaintext.
Required scope: schedules:read

Pause a schedule

To resume, use {"action": "resume"}. You can also update the schedule configuration (name, cron_expression, timezone, targets) in the same PATCH request. Required scope: schedules:write

Delete a schedule

Required scope: schedules:write

Trigger a schedule immediately

Run a scheduled pentest configuration immediately, before the next cron interval:
Required scope: schedules:write