Skip to main content
POST
Create schedule

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required
Minimum string length: 1

Body

application/json
name
string
required

Human-readable schedule name.

Required string length: 1 - 255
target
object
required

Typed schedule target.

schedule
string
required

Schedule expression, for example a cron expression.

Required string length: 1 - 255
timezone
string

IANA timezone used to evaluate the schedule. Defaults to UTC.

Required string length: 1 - 128
runtime_target_kind
enum<string>

Runtime target kind for scheduled runs.

Available options:
main_branch,
environment,
preview_branch
runtime_target_environment_id
string<uuid> | null

Environment ID when runtime_target_kind is environment.

runtime_target_branch_id
string<uuid> | null

Branch ID when runtime_target_kind is preview_branch.

config
object

Run configuration. For agent schedules, put the run prompt in config.prompt.

timeout_seconds
integer

Per-run timeout in seconds.

backoff_limit
integer

Retry backoff limit for failed scheduled runs.

Required range: x >= 0
concurrency_policy
enum<string>

How overlapping scheduled runs are handled.

Available options:
Allow,
Forbid,
Replace
max_runs
integer | null

Optional maximum number of scheduled runs.

definition_source
enum<string>

manual (the default), or source to activate a schedule declared in source, which requires source_trigger_id, source_path and source_hash.

Available options:
manual,
source
source_trigger_id
string

Trigger id from the source definition. When a schedule with this id already exists, creating it from source can return that schedule with its current status; a paused schedule remains paused.

Required string length: 1 - 255
source_path
string

Source file path of the source schedule.

Required string length: 1 - 1024
source_hash
string

Source definition hash of the source schedule.

Required string length: 1 - 255

Response

Created an active recurring project schedule for a task, workflow, or agent target.

schedule
object
required

The created schedule. New schedules are active by default.