Skip to main content
POST
Complete Sync Operation
Notify that a sync operation completed and provide the file manifest. This is typically called after uploading or downloading files to finalize the sync state.

Path Parameters

filesystem_id
string
required

Body

application/json

Request model for completing a sync operation.

direction
string
required

Sync direction: 'UP' or 'DOWN'.

status
string
required

Sync status: 'SUCCESS' or 'FAILED'.

sync_id
string
required

Unique ID for this sync operation (idempotency key).

archive_checksum
string | null

SHA256 checksum of the archive.

archive_size_bytes
integer | null

Size of the archive in bytes.

files
FilesystemFile · object[] | null

List of files in the filesystem (empty if status is FAILED).

Response

Successful Response

Response model for sync-complete operation.

files_count
integer
required

Number of files processed.

filesystem_id
string
required

The filesystem ID.

status
string
required

Result status: 'COMPLETED' or 'ALREADY_PROCESSED'.

sync_id
string
required

The sync operation ID (for idempotency).