v2

latestOpenAPI 3.1.02026-07-31822441.6 KB

Create jobs schedule

Create a new schedule for a tenant

put/{env_id}/{flow_id}/{tenant}/jobs/schedule

env_idstring required

ID of environment

flow_idstring required

ID of flow

tenantstring required

ID of tenant

schedule_expressionstring required

cron expression defining how often sync should occur e.g. cron(0 0 * * *)

job_type'read' | 'write'

For v2 flows, defines the type of job. Accepts "read" or "write."

state'DISABLED' | 'ENABLED'

Whether this schedule should be DISABLED or ENABLED

connector_idstring

Optional specific connector or tap ID to set the schedule on

override_start_datestring date-time

Optional override for the start_date that jobs will run with. This will ignore state bookmarks and any start_date in the config.

override_selected_tablesobject

Override the unified schema selection for this schedule

override_field_mapobject

Override the field map selection for this schedule

environment_variablesobject

Set optional environment variables for the job to use (generally for use in the ETL).

schedule_jitter_minutesinteger nullable

Jitter window in minutes for default schedules. Only allowed when tenant is default; set to null to clear.

200

object required