Skip to main content
PATCH
Update a schedule

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Safely retry a POST/PATCH; a replayed key returns the original response.

Maximum string length: 255

Path Parameters

id
string
required

Body

application/json
name
string
Minimum string length: 1
repository_ids
string<uuid>[]

Connected repository IDs to scan on each run, up to 100. All must use the same provider; a mix fails with 400 mixed_repository_providers.

Required array length: 1 - 100 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
cron_expression
string
Minimum string length: 1
branch
string | null
Minimum string length: 1
timezone
string | null
Minimum string length: 1
scan_mode
enum<string>
Available options:
full,
diff
model
enum<string> | null
Available options:
haiku,
sonnet,
opus
is_active
boolean

Response

Success

object
string
required
Allowed value: "schedule"
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
repository_ids
string<uuid>[]
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
branch
string | null
required
cron_expression
string
required
timezone
string | null
required
scan_mode
string
required
model
string | null
required
is_active
boolean
required
next_run_at
string | null
required
last_run_at
string | null
required
created_at
string
required