Skip to main content
PATCH
Update a job schedule

Authorizations

Authorization
string
header
required

Personal byk_ API key; user-principal, resolved to a tenant by org context.

Headers

X-Bonya-Organization-ID
string

Org context. Omitted means the caller's personal organization. A well-formed non-member org is 404; malformed is 400.

Path Parameters

schedule_id
string
required

Body

application/json

Exactly one of cron_expressions, interval_s, and run_at_unix_nanos is required.

job
object
required

Exactly one of existing_sandbox_id and new_sandbox is required. Exactly one of command and script is required.

cron_expressions
string[]
interval_s
integer
Required range: x >= 1
run_at_unix_nanos
integer

One-shot: a single future calendar time. Refused if in the past.

time_zone
string

IANA zone, e.g. US/Pacific. Empty is UTC.

jitter_s
integer
Required range: x >= 0
overlap
enum<string>
default:skip

What a fire does when the previous run is still going. skip (the default) drops the new fire.

Available options:
skip,
buffer_one,
allow_all
paused
boolean
default:false

Response

Schedule updated

schedule
object
required