Storage: S3

Sync import storage

Sync tasks from an S3 import storage connection.

post/api/storages/s3/{id}/sync

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/storages/s3/{id}/sync
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Storage ID

Response

aws_access_key_idstring nullable

AWS_ACCESS_KEY_ID

aws_secret_access_keystring nullable

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring nullable

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring nullable

AWS SSE KMS Key ID

bucketstring nullable

S3 bucket name

created_atstring date-time required

Creation time

descriptionstring nullable

Cloud storage description

idinteger required
last_syncstring date-time nullable

Last sync finished time

last_sync_countinteger nullable

Count of tasks synced last time

last_sync_jobstring nullable

Last sync job ID

metaunknown
prefixstring nullable

S3 bucket prefix

presignboolean
presign_ttlinteger

Presigned URLs TTL (in minutes)

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean

Perform recursive scan over the bucket content

regex_filterstring nullable

Cloud storage regex for filtering objects

region_namestring nullable

AWS Region

s3_endpointstring nullable

S3 Endpoint

status'initialized' | 'queued' | 'in_progress' | 'failed' | 'completed' | 'completed_with_errors'
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizableboolean
titlestring nullable

Cloud storage title

tracebackstring nullable

Traceback report for the last failed sync

typestring required
use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

Changes

No operation changes recorded.