Sync import storage

POST

Sync tasks from an S3 import storage connection. You will need to provide the import storage ID. You can find this using List import 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

idintegerRequired

Storage ID

Response

This endpoint returns an object.

projectinteger

A unique integer value identifying this project.

idintegerOptional

typestringOptionalDefaults to s3

synchronizablebooleanOptional

presignbooleanOptional

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

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

presign_ttlintegerOptional

Presigned URLs TTL (in minutes)

recursive_scanbooleanOptional

Perform recursive scan over the bucket content

POST

1 curl -X POST http://localhost:8080/api/storages/s3/1/sync \
2      -H "Authorization: Token  <api_key>"

200Successful

1 {
2   "project": 1,
3   "id": 1,
4   "type": "type",
5   "synchronizable": true,
6   "presign": true,
7   "last_sync": "2024-01-15T09:30:00Z",
8   "last_sync_count": 1,
9   "last_sync_job": "last_sync_job",
10   "status": "initialized",
11   "traceback": "traceback",
12   "meta": {
13     "key": "value"
14   },
15   "title": "title",
16   "description": "description",
17   "created_at": "2024-01-15T09:30:00Z",
18   "bucket": "bucket",
19   "prefix": "prefix",
20   "regex_filter": "regex_filter",
21   "use_blob_urls": true,
22   "aws_access_key_id": "aws_access_key_id",
23   "aws_secret_access_key": "aws_secret_access_key",
24   "aws_session_token": "aws_session_token",
25   "aws_sse_kms_key_id": "aws_sse_kms_key_id",
26   "region_name": "region_name",
27   "s3_endpoint": "s3_endpoint",
28   "presign_ttl": 1,
29   "recursive_scan": true
30 }

List import storages

Up Next

Built with

1	curl -X POST http://localhost:8080/api/storages/s3/1/sync \
2	-H "Authorization: Token <api_key>"

1	{
2	"project": 1,
3	"id": 1,
4	"type": "type",
5	"synchronizable": true,
6	"presign": true,
7	"last_sync": "2024-01-15T09:30:00Z",
8	"last_sync_count": 1,
9	"last_sync_job": "last_sync_job",
10	"status": "initialized",
11	"traceback": "traceback",
12	"meta": {
13	"key": "value"
14	},
15	"title": "title",
16	"description": "description",
17	"created_at": "2024-01-15T09:30:00Z",
18	"bucket": "bucket",
19	"prefix": "prefix",
20	"regex_filter": "regex_filter",
21	"use_blob_urls": true,
22	"aws_access_key_id": "aws_access_key_id",
23	"aws_secret_access_key": "aws_secret_access_key",
24	"aws_session_token": "aws_session_token",
25	"aws_sse_kms_key_id": "aws_sse_kms_key_id",
26	"region_name": "region_name",
27	"s3_endpoint": "s3_endpoint",
28	"presign_ttl": 1,
29	"recursive_scan": true
30	}