Update a job definition
PUT/api/v1/jobs/{id}
Replaces editable job settings after EDIT permission and datasource capability checks. The job name is immutable. Protected mutations require the session cookie and CSRF header.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Job definition identifier.
Request Bodyrequired
Section titled “Request Bodyrequired”Create or update contract for one managed, single-table replication job.
object
Whether lease-expiry recovery may create another attempt.
Per-task bandwidth cap in KB/s; zero means unlimited.
Rows requested per source fetch.
Source column used to compute the next incremental watermark.
Initial committed watermark for the first managed run.
Parallel tasks inside this run.
Example
1Maximum attempts including the initial attempt.
Replication mode.
Example
completeImmutable display name. Required on create and omitted or unchanged on update.
Example
Nightly ordersDelay before an automatic retry becomes eligible, in seconds.
Ordered sink column mapping.
Sink datasource identifier.
Whether future attempts may resolve and use the sink binding.
Connector-specific escaping override.
Skip complete-mode sink truncation when supported.
Schema in which ReplicaDB may create a staging table.
Existing staging table managed by the operator.
Sink table, collection, topic, or object target.
Ordered source column selection or connector projection.
Source datasource identifier.
Whether future attempts may resolve and use the source binding.
Connector-specific free-form source query. Mutually exclusive with sourceTable.
Source table or collection. Mutually exclusive with sourceQuery.
Connector-specific source predicate without a WHERE keyword.
Enable verbose replication diagnostics.
Responses
Section titled “Responses”Job definition updated
Persisted managed job definition with resolved policy values and redacted datasource summaries.
object
Whether lease-expiry recovery may create another attempt.
Per-task bandwidth cap in KB/s; zero means unlimited.
Creation timestamp in UTC.
Rows requested per source fetch.
Job definition identifier.
Incremental watermark source column.
Initial committed watermark.
Parallel tasks inside each run.
Maximum attempts including the initial attempt.
Replication mode.
Mode-specific warning for destructive or indeterminate outcomes.
Immutable job display name.
Retry eligibility delay in seconds.
Ordered sink column mapping.
Redacted datasource identity embedded in a job response.
object
Registered connector wire name.
Datasource identifier.
Datasource display name.
Credential-redacted connection display.
Sink datasource identifier.
Whether future attempts may use the sink binding.
Whether connector escaping is disabled.
Whether complete-mode truncation is disabled.
Schema for generated staging tables.
Operator-managed staging table.
Sink target name.
Ordered source column selection.
Redacted datasource identity embedded in a job response.
object
Registered connector wire name.
Datasource identifier.
Datasource display name.
Credential-redacted connection display.
Source datasource identifier.
Whether future attempts may use the source binding.
Connector-specific free-form source query.
Source table or collection.
Connector-specific source predicate.
Last update timestamp in UTC.
Whether verbose replication diagnostics are enabled.
The request is malformed or fails validation.
RFC 7807 problem response. Dynamic detail text is credential-redacted.
object
Authentication is required or credentials are invalid.
RFC 7807 problem response. Dynamic detail text is credential-redacted.
object
The authenticated identity lacks the required permission.
RFC 7807 problem response. Dynamic detail text is credential-redacted.
object
The requested resource does not exist or is not visible.
RFC 7807 problem response. Dynamic detail text is credential-redacted.