Sync export storage

POST

Sync tasks to an S3 export/target storage connection. You will need to provide the export storage ID. You can find this using List export storages.

Sync operations with external buckets only go one way. They either create tasks from objects in the bucket (source/import storage) or push annotations to the output bucket (export/target storage). Changing something on the bucket side doesn’t guarantee consistency in results.

Before proceeding, you should review How sync operations work - Source storage to ensure that your data remains secure and private.

Path parameters

idstringRequired

Response

This endpoint returns an object.
projectinteger
A unique integer value identifying this project.
idintegerOptional
typestringOptionalDefaults to s3
synchronizablebooleanOptional
last_syncdatetimeOptional
Last sync finished time
last_sync_countintegerOptional
Count of tasks synced last time
last_sync_jobstringOptional
Last sync job ID
statusenumOptional
Allowed values: initializedqueuedin_progressfailedcompleted
tracebackstringOptional
Traceback report for the last failed sync
metamap from strings to anyOptional
Meta and debug information about storage processes
titlestringOptional
Cloud storage title
descriptionstringOptional
Cloud storage description
created_atdatetimeOptional
Creation time
can_delete_objectsbooleanOptional
Deletion from storage enabled
bucketstringOptional
S3 bucket name
prefixstringOptional
S3 bucket prefix
regex_filterstringOptional
Cloud storage regex for filtering objects
use_blob_urlsbooleanOptional
Interpret objects as BLOBs and generate URLs
aws_access_key_idstringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_keystringOptional

AWS_SECRET_ACCESS_KEY

aws_session_tokenstringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_idstringOptional
AWS SSE KMS Key ID
region_namestringOptional
AWS Region
s3_endpointstringOptional
S3 Endpoint
Built with