Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
sync_runs
Sync Runs

Show Sync Run

Show Sync Run

get/sync_runs/{id}

Path parameters

idinteger required

Sync Run ID.

Response

The SyncRuns object.

idinteger

SyncRun ID

bodystring

Log or summary body for this run

bytes_syncedinteger

Total bytes synced in this run

compared_filesinteger

Number of files compared

compared_foldersinteger

Number of folders compared

completed_atstring date-time

When this run was completed

created_atstring date-time

When this run was created

dest_remote_server_type'ftp' | 'sftp' | 's3' | 'google_cloud_storage' | 'webdav' | 'wasabi' | 'backblaze_b2' | 'one_drive' | 'box' | 'dropbox' | 'google_drive' | 'azure' | 'sharepoint' | 's3_compatible' | 'azure_files' | 'files_agent' | 'filebase' | 'cloudflare' | 'linode' | 'files_com'

Destination remote server type, if any

dry_runboolean

Whether this run was a dry run (no actual changes made)

errored_filesinteger

Number of files that errored

estimated_bytes_countinteger

Estimated bytes count for this run

event_errorsstring[]

Array of errors encountered during the run

log_urlstring

Link to external log file.

runtimenumber double

Total runtime in seconds

site_idinteger

Site ID

workspace_idinteger

Workspace ID

src_remote_server_type'ftp' | 'sftp' | 's3' | 'google_cloud_storage' | 'webdav' | 'wasabi' | 'backblaze_b2' | 'one_drive' | 'box' | 'dropbox' | 'google_drive' | 'azure' | 'sharepoint' | 's3_compatible' | 'azure_files' | 'files_agent' | 'filebase' | 'cloudflare' | 'linode' | 'files_com'

Source remote server type, if any

status'success' | 'failure' | 'partial_failure' | 'in_progress' | 'skipped'

Status of the sync run (success, failure, partial_failure, in_progress, skipped)

successful_filesinteger

Number of files successfully synced

sync_idinteger

ID of the Sync this run belongs to

sync_namestring

Name of the Sync this run belongs to

updated_atstring date-time

When this run was last updated

Example response

{
  "id": 1,
  "body": "example",
  "bytes_synced": 1,
  "compared_files": 1,
  "compared_folders": 1,
  "completed_at": "2000-01-01T01:00:00Z",
  "created_at": "2000-01-01T01:00:00Z",
  "dest_remote_server_type": "example",
  "dry_run": true,
  "errored_files": 1,
  "estimated_bytes_count": 1,
  "event_errors": [
    "example"
  ],
  "log_url": "https://www.example.com/log_file.txt",
  "runtime": 1,
  "site_id": 1,
  "workspace_id": 1,
  "src_remote_server_type": "example",
  "status": "example",
  "successful_files": 1,
  "sync_id": 1,
  "sync_name": "Azure to SharePoint Sync",
  "updated_at": "2000-01-01T01:00:00Z",
  "live_transfers": [
    {
      "path": "example",
      "status": "example",
      "bytes_copied": 1,
      "bytes_total": 1,
      "percentage": 1,
      "eta": "example",
      "started_at": "example"
    }
  ]
}