Skip to content

Get a job definition

GET
/api/v1/jobs/{id}

Returns one job definition when the authenticated identity has VIEW permission. Datasource summaries are omitted when their metadata is not visible.

id
required
string format: uuid

Job definition identifier.

Job definition returned

Persisted managed job definition with resolved policy values and redacted datasource summaries.

object
automaticRetryEnabled

Whether lease-expiry recovery may create another attempt.

boolean
bandwidthThrottling

Per-task bandwidth cap in KB/s; zero means unlimited.

integer format: int32
createdAt

Creation timestamp in UTC.

string format: date-time
fetchSize

Rows requested per source fetch.

integer format: int32
>= 1
id

Job definition identifier.

string format: uuid
incrementalWatermarkColumn

Incremental watermark source column.

string
nullable
initialWatermarkValue

Initial committed watermark.

string
nullable
jobs

Parallel tasks inside each run.

integer format: int32
>= 1
maxAttempts

Maximum attempts including the initial attempt.

integer format: int32
>= 1
mode

Replication mode.

string
Allowed values: complete complete-atomic incremental
modeWarning

Mode-specific warning for destructive or indeterminate outcomes.

string
nullable
name

Immutable job display name.

string
retryBackoffSeconds

Retry eligibility delay in seconds.

integer format: int64
sinkColumns

Ordered sink column mapping.

string
nullable
sinkDatasource

Redacted datasource identity embedded in a job response.

object
connectorType

Registered connector wire name.

string
id

Datasource identifier.

string format: uuid
name

Datasource display name.

string
safeConnectDisplay

Credential-redacted connection display.

string
sinkDatasourceId

Sink datasource identifier.

string format: uuid
sinkDatasourceUseEnabled

Whether future attempts may use the sink binding.

boolean
sinkDisableEscape

Whether connector escaping is disabled.

boolean
sinkDisableTruncate

Whether complete-mode truncation is disabled.

boolean
sinkStagingSchema

Schema for generated staging tables.

string
nullable
sinkStagingTable

Operator-managed staging table.

string
nullable
sinkTable

Sink target name.

string
sourceColumns

Ordered source column selection.

string
nullable
sourceDatasource

Redacted datasource identity embedded in a job response.

object
connectorType

Registered connector wire name.

string
id

Datasource identifier.

string format: uuid
name

Datasource display name.

string
safeConnectDisplay

Credential-redacted connection display.

string
sourceDatasourceId

Source datasource identifier.

string format: uuid
sourceDatasourceUseEnabled

Whether future attempts may use the source binding.

boolean
sourceQuery

Connector-specific free-form source query.

string
nullable
sourceTable

Source table or collection.

string
nullable
sourceWhere

Connector-specific source predicate.

string
nullable
updatedAt

Last update timestamp in UTC.

string format: date-time
verbose

Whether verbose replication diagnostics are enabled.

boolean

Authentication is required or credentials are invalid.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

The authenticated identity lacks the required permission.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

The requested resource does not exist or is not visible.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference