v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Bucket Syncs

Get Sync Job

Get details for a specific sync job.

Returns the full job record including status, file counts, start/completion times, and any error messages.

get/v1/buckets/{bucket_id}/syncs/{sync_config_id}/jobs/{sync_job_id}

Path parameters

bucket_idstring required

sync_config_idstring required

sync_job_idstring required

Response

Successful Response

sync_job_idstring

Unique identifier for the sync job.

sync_config_idstring required

Identifier of the sync configuration that spawned this job.

internal_idstring required

Organization scope identifier.

namespace_idstring required

Namespace scope identifier.

status'running' | 'completed' | 'failed' | 'interrupted'

Lifecycle states for individual storage sync jobs.

phasestring nullable

Human-readable phase within a RUNNING job for observability (e.g. 'discovering', 'downloading', 'verifying', 're-verifying', 'idle'). Optional and descriptive — distinct from status, which is the coarse lifecycle state. Lets a sync that is re-verifying already-synced files (low net-new throughput, low percent) read as healthy rather than stuck. Back-compatible: older jobs have None.

total_filesinteger nullable

Total files expected for this sync run.

files_syncedinteger

Number of files synced successfully in this job.

files_failedinteger

Number of files that failed to sync in this job.

started_atstring date-time

Timestamp when the job started.

completed_atstring date-time nullable

Timestamp when the job completed.

updated_atstring date-time nullable

Last progress update timestamp for this job.

errorstring nullable

Last error encountered during the job.

metadataobject

Optional metadata captured during execution (provider stats, cursors, etc.).

progress_percentnumber nullable

Derived percent complete when total_files is known.

throughput_files_per_minnumber nullable

Derived successful-file throughput for the job.

lag_secondsinteger nullable

Seconds since the latest progress update for running jobs.

current_cursorstring nullable

Latest provider cursor/page token captured for this job.

progressobject

Derived progress summary for API observability.