Sync import storage | API Reference

Sync tasks from an S3 import storage connection.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

idintegerRequired

Storage ID

Response

created_atdatetime

Creation time

idinteger

projectinteger

A unique integer value identifying this project.

typestringDefaults to s3

aws_access_key_idstring or null

AWS_ACCESS_KEY_ID

aws_secret_access_keystring or null

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring or null

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring or null

AWS SSE KMS Key ID

bucketstring or null

S3 bucket name

descriptionstring or null

Cloud storage description

last_syncdatetime or null

Last sync finished time

last_sync_countinteger or null>=0<=2147483647

Count of tasks synced last time

last_sync_jobstring or null<=256 characters

Last sync job ID

metaany or null

prefixstring or null

S3 bucket prefix

presignboolean or nullDefaults to true

presign_ttlinteger or null>=0<=32767

Presigned URLs TTL (in minutes)

recursive_scanboolean or null

Perform recursive scan over the bucket content

regex_filterstring or null

Cloud storage regex for filtering objects

region_namestring or null

AWS Region

s3_endpointstring or null

S3 Endpoint

statusenum or null

initialized - Initialized
queued - Queued
in_progress - In progress
failed - Failed
completed - Completed
completed_with_errors - Completed with errors

* `initialized` - Initialized * `queued` - Queued * `in_progress` - In progress * `failed` - Failed * `completed` - Completed * `completed_with_errors` - Completed with errors

synchronizableboolean or nullDefaults to true

titlestring or null<=256 characters

Cloud storage title

tracebackstring or null

Traceback report for the last failed sync

use_blob_urlsboolean or null

Interpret objects as BLOBs and generate URLs

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

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