Skip to main content
PUT
Error

Authorizations

x-cdata-authtoken
string
header
required

A Sync user auth token. Generate one via POST /v2/users/generate-token.

Path Parameters

job_id
string
required

Job identifier.

Body

application/json
name
string
required
type
string
required

Job type, e.g. "Standard", "EnhancedCDC", "LoadFolder".

source_connection
object
required

References a connection by id or name. One of id or name is required.

destination_connection
object
required

References a connection by id or name. One of id or name is required.

queries
string[]
labels
string[]
pipeline_id
string
schedule
object
settings
object
replicate_options
object
alerts
object
resync_options
object
cdc_engine_settings
object

Source CDC engine settings. Applicable fields depend on the source provider (PostgreSQL, Oracle, DB2 for i, etc.).

pre_job_event
object
post_job_event
object

Response

One or more jobs

id
string
workspace_id
string
name
string
type
string
source_connection
object

A lightweight reference to a related resource.

destination_connection
object

A lightweight reference to a related resource.

schedule
object
replicate_options
object
alerts
object
settings
object
pre_job_event
object | null
post_job_event
object | null
cdc_engine_settings
object

Source CDC engine settings. Applicable fields depend on the source provider (PostgreSQL, Oracle, DB2 for i, etc.).

permissions
object
labels
string[]
license_state
string
license_message
string
pipeline_id
string
last_run
object | null
created_at
string<date-time>
updated_at
string<date-time>