Export StorageS3

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
project
integer
A unique integer value identifying this project.
id
integerOptional
type
stringOptionalDefaults to s3
synchronizable
booleanOptional
last_sync
datetimeOptional
Last sync finished time
last_sync_count
integerOptional
Count of tasks synced last time
last_sync_job
stringOptional
Last sync job ID
status
enumOptional
Allowed values: initializedqueuedin_progressfailedcompleted
traceback
stringOptional
Traceback report for the last failed sync
meta
map from strings to anyOptional
Meta and debug information about storage processes
title
stringOptional
Cloud storage title
description
stringOptional
Cloud storage description
created_at
datetimeOptional
Creation time
can_delete_objects
booleanOptional
Deletion from storage enabled
bucket
stringOptional
S3 bucket name
prefix
stringOptional
S3 bucket prefix
regex_filter
stringOptional
Cloud storage regex for filtering objects
use_blob_urls
booleanOptional
Interpret objects as BLOBs and generate URLs
aws_access_key_id
stringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_key
stringOptional

AWS_SECRET_ACCESS_KEY

aws_session_token
stringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_id
stringOptional
AWS SSE KMS Key ID
region_name
stringOptional
AWS Region
s3_endpoint
stringOptional
S3 Endpoint
POST
1curl -X POST http://localhost:8080/api/storages/export/s3/id/sync \
2 -H "Authorization: Token <api_key>"
200Successful
1{
2 "project": 1,
3 "id": 1,
4 "type": "type",
5 "synchronizable": true,
6 "last_sync": "2024-01-15T09:30:00Z",
7 "last_sync_count": 1,
8 "last_sync_job": "last_sync_job",
9 "status": "initialized",
10 "traceback": "traceback",
11 "meta": {
12 "meta": {
13 "key": "value"
14 }
15 },
16 "title": "title",
17 "description": "description",
18 "created_at": "2024-01-15T09:30:00Z",
19 "can_delete_objects": true,
20 "bucket": "bucket",
21 "prefix": "prefix",
22 "regex_filter": "regex_filter",
23 "use_blob_urls": true,
24 "aws_access_key_id": "aws_access_key_id",
25 "aws_secret_access_key": "aws_secret_access_key",
26 "aws_session_token": "aws_session_token",
27 "aws_sse_kms_key_id": "aws_sse_kms_key_id",
28 "region_name": "region_name",
29 "s3_endpoint": "s3_endpoint"
30}