sync-jobs
Inspect and cancel sync jobs — the read-only executions produced by syncs run. Each sync job tracks extraction, loading, and error counts across a sync's tables. Use this command to list a sync's jobs, fetch one by ID, read its errors, and cancel a job that is still running.
REST API: Syncs
celigo sync-jobs <subcommand> [args] [flags]Supports all global flags.
Subcommands
list
List the jobs for a sync, newest first.
get <syncJobId>
Get a sync job by ID.
errors <syncJobId>
List errors for a sync job.
cancel <syncJobId>
Cancel a single sync job.
celigo sync-jobs list
List the jobs for a sync, newest first. Pass the sync with --sync, and optionally bound the window with --created-gte / --created-lte.
Signature
celigo sync-jobs list --sync <syncId> [flags]Arguments
None.
Flags
--sync <syncId>
string
—
Sync whose jobs to list.
--created-gte <date>
string
—
Only jobs created on/after this date (ISO 8601, plain date, or epoch ms).
--created-lte <date>
string
—
Only jobs created on/before this date.
Example
Corresponds to: GET /v1/syncs/{_syncId}/syncJobs (operationId: listSyncJobs)
celigo sync-jobs get
Get a single sync job by ID.
Signature
Arguments
<syncJobId>
string
Yes
Sync job ID.
Example
Corresponds to: GET /v1/syncJobs/{_syncJobId} (operationId: getSyncJobById)
celigo sync-jobs errors
List the errors recorded for a sync job.
Signature
Arguments
<syncJobId>
string
Yes
Sync job ID.
Example
Corresponds to: GET /v1/syncJobs/{_parentJobId}/errors (operationId: listSyncJobErrors)
celigo sync-jobs cancel
Cancel a single sync job by ID. Prompts for confirmation unless -y is passed.
⚠️ Cancelling a sync job cannot be undone. Extraction and loading stop immediately, which can leave data partially synced. Re-run the sync to finish.
Signature
Arguments
<syncJobId>
string
Yes
Sync job ID.
Flags
-y, --yes
boolean
false
Skip confirmation.
Example
Corresponds to: PUT /v1/syncJobs/{_syncJobId}/cancel (operationId: cancelSyncJob)
Gotchas
Sync jobs are read-only executions. They are produced by
syncs run, not created directly.cancelis the only mutating subcommand here.listrequires--sync. Jobs are scoped to a sync; pass the sync ID with--syncto list its jobs.cancelvssyncs cancel-jobs.sync-jobs cancel <syncJobId>cancels one job;syncs cancel-jobs <syncId>cancels every running job for a sync.Errors are read from the parent job. The errors endpoint keys off the parent job ID — pass the job ID returned by
listorrun.
Related
syncs — trigger runs, cancel all jobs for a sync, and discover supported source/destination apps.
integrations — the container that owns syncs.
jobs — flow execution history (distinct from sync jobs).
Last updated
Was this helpful?