Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
sync_runs
Sync Runs

List Sync Runs

List Sync Runs

get/sync_runs

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are site_id, workspace_id, sync_id, created_at or status.

If set, return records where the specified field is equal to the supplied value. Valid fields are created_at, status, dry_run, workspace_id, src_remote_server_type, dest_remote_server_type or sync_id. Valid field combinations are [ status, created_at ], [ workspace_id, created_at ], [ src_remote_server_type, created_at ], [ dest_remote_server_type, created_at ], [ sync_id, created_at ], [ workspace_id, status ], [ src_remote_server_type, status ], [ dest_remote_server_type, status ], [ sync_id, status ], [ workspace_id, src_remote_server_type ], [ workspace_id, dest_remote_server_type ], [ workspace_id, sync_id ], [ workspace_id, status, created_at ], [ src_remote_server_type, status, created_at ], [ dest_remote_server_type, status, created_at ], [ sync_id, status, created_at ], [ workspace_id, src_remote_server_type, created_at ], [ workspace_id, dest_remote_server_type, created_at ], [ workspace_id, sync_id, created_at ], [ workspace_id, src_remote_server_type, status ], [ workspace_id, dest_remote_server_type, status ], [ workspace_id, sync_id, status ], [ workspace_id, src_remote_server_type, status, created_at ], [ workspace_id, dest_remote_server_type, status, created_at ] or [ workspace_id, sync_id, status, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

Response

A list of SyncRuns objects.

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"
      }
    ]
  }
]