Skip to main content
POST
Create Scan Schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string | null
Required string length: 8 - 200
X-Correlation-ID
string | null
authorization
string | null

Body

application/json
repository_id
string
required
workspace_id
string
required
cadence
string
default:weekly
Pattern: ^(daily|weekly|monthly)$
client_request_id
string | null
Required string length: 8 - 200
config
Config · object
day_of_month
integer | null
Required range: 1 <= x <= 28
hour
integer
default:2
Required range: 0 <= x <= 23
minute
integer
default:0
Required range: 0 <= x <= 59
scan_type
string
default:security
Pattern: ^(security|onboarding|full)$
source_ref
string | null
Maximum string length: 256
state
string
default:active
Pattern: ^(active|paused)$
timezone_name
string
default:UTC
Required string length: 1 - 100
weekday
integer | null
default:0
Required range: 0 <= x <= 6

Response

Successful Response

The response is of type Response Create Scan Schedule Api V1 Scan Schedules Post · object.

Last modified on July 28, 2026