Sync connection
Imports an object from or exports a file to the connection. Returns the created sync; poll it for completion.
Path Parameters
URL-safe workspace identifier.
Opaque identifier of the connection.
^conn_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Body
Request payload to trigger a connection sync.
The direction is determined by the connection's configured sync_mode.
- Import connections need no body: the sync fetches every not-yet-imported object under the connection's root path.
- Export connections push one workspace file (
file_id) to one objectkey; both are required for export and ignored for import.
Request payload to trigger a connection sync.
The direction is determined by the connection's configured sync_mode.
- Import connections need no body: the sync fetches every not-yet-imported object under the connection's root path.
- Export connections push one workspace file (
file_id) to one objectkey; both are required for export and ignored for import.
Response
A connection sync (import or export).
A connection sync (import or export).
1-based attempt number; scheduled syncs may be retried on failure.
The connection this sync belongs to.
^conn_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Unique sync identifier.
Number of objects transferred so far.
When the sync started.
Current status of the sync.
"pending"How the sync was triggered.
"manual"Account that triggered the sync.
When the sync finished, if it has.
Failure reason when the sync failed; omitted otherwise.
