v4

latestSwagger 2.02026-08-0343714211.7 MB

syncs

Syncs

List Syncs

get/syncs

Query parameters

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 or name.

If set, return records where the specified field is equal to the supplied value. Valid fields are workspace_id, disabled, src_remote_server_id or dest_remote_server_id. Valid field combinations are [ workspace_id, disabled ], [ workspace_id, src_remote_server_id ], [ workspace_id, dest_remote_server_id ], [ disabled, src_remote_server_id ], [ disabled, dest_remote_server_id ], [ workspace_id, disabled, src_remote_server_id ] or [ workspace_id, disabled, dest_remote_server_id ].

Response

A list of Syncs objects.

idinteger

Sync ID

namestring

Name for this sync job

descriptionstring

Description for this sync job

site_idinteger

Site ID this sync belongs to

workspace_idinteger

Workspace ID this sync belongs to

user_idinteger

User who created or owns this sync

src_pathstring

Absolute source path for the sync

dest_pathstring

Absolute destination path for the sync

src_remote_server_idinteger

Remote server ID for the source (if remote)

dest_remote_server_idinteger

Remote server ID for the destination (if remote)

src_site_idinteger

Source site ID if syncing from a child or partner site

dest_site_idinteger

Destination site ID if syncing to a child or partner site

two_wayboolean

Is this a two-way sync?

keep_after_copyboolean

Keep files after copying?

delete_empty_foldersboolean

Delete empty folders after sync?

disabledboolean

Is this sync disabled?

trigger'daily' | 'custom_schedule' | 'manual'

Trigger type: daily, custom_schedule, or manual

trigger_filestring

Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.

always_write_trigger_fileboolean

If true, the trigger file will be sent at the end of a successful sync even when no files were transferred.

include_patternsstring[]

Array of glob patterns to include

exclude_patternsstring[]

Array of glob patterns to exclude

created_atstring date-time

When this sync was created

updated_atstring date-time

When this sync was last updated

sync_interval_minutesinteger

Frequency in minutes between syncs. If set, this value must be greater than or equal to the remote_sync_interval value for the site's plan. If left blank, the plan's remote_sync_interval will be used. This setting is only used if trigger is empty.

intervalstring

If trigger is daily, this specifies how often to run this sync. One of: day, week, week_end, month, month_end, quarter, quarter_end, year, year_end

recurring_dayinteger

If trigger type is daily, this specifies a day number to run in one of the supported intervals: week, month, quarter, year.

schedule_days_of_weekinteger[]

If trigger is custom_schedule, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.

schedule_times_of_daystring[]

Times of day to run in HH:MM format. For custom_schedule, run at these times on specified days of week. For daily, run at these times on the scheduled interval date.

schedule_time_zonestring

Time zone for scheduled times. If not set, times are interpreted as UTC.

holiday_regionstring

Skip sync if there is a formal, observed holiday for this region.

Example response

[
  {
    "id": 1,
    "name": "example",
    "description": "example",
    "site_id": 1,
    "workspace_id": 1,
    "user_id": 1,
    "src_path": "example",
    "dest_path": "example",
    "src_remote_server_id": 1,
    "dest_remote_server_id": 1,
    "src_site_id": 1,
    "dest_site_id": 1,
    "two_way": true,
    "keep_after_copy": true,
    "delete_empty_folders": true,
    "disabled": true,
    "trigger": "example",
    "trigger_file": "example",
    "always_write_trigger_file": true,
    "include_patterns": [
      "example"
    ],
    "exclude_patterns": [
      "example"
    ],
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z",
    "sync_interval_minutes": 1,
    "interval": "week",
    "recurring_day": 25,
    "schedule_days_of_week": [
      0,
      2,
      4
    ],
    "schedule_times_of_day": [
      "06:30",
      "14:30"
    ],
    "schedule_time_zone": "Eastern Time (US & Canada)",
    "holiday_region": "us_dc",
    "latest_sync_run": {
      "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"
        }
      ]
    }
  }
]