Sync export storage | API Reference

curl -X POST http://localhost:8000/api/storages/export/s3/1/sync \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "created_at": "2024-01-15T09:30:00Z",
  "id": 1,
  "project": 42,
  "type": "s3",
  "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
  "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  "aws_session_token": "FQoGZXIvYXdzEJr//////////wEaDK1v7EXAMPLE",
  "aws_sse_kms_key_id": "arn:aws:kms:us-west-2:123456789012:key/abcd1234-a123-456a-a12b-a123b4cd56ef",
  "bucket": "label-studio-exports",
  "can_delete_objects": true,
  "description": "S3 export storage for project 42",
  "last_sync": "2024-04-20T14:45:00Z",
  "last_sync_count": 125,
  "last_sync_job": "sync-job-20240420-1445",
  "meta": null,
  "prefix": "exports/annotations/",
  "regex_filter": ".*\\.json$",
  "region_name": "us-west-2",
  "s3_endpoint": "https://s3.us-west-2.amazonaws.com",
  "status": "completed",
  "synchronizable": true,
  "title": "Project 42 S3 Export Storage",
  "traceback": null,
  "use_blob_urls": true
}

Sync tasks from an S3 export storage connection.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

Response

created_atdatetimeRead-only

Creation time

idintegerRead-only

projectinteger

A unique integer value identifying this project.

typestringRead-onlyDefaults 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

can_delete_objectsboolean or null

Deletion from storage enabled

descriptionstring or null

Cloud storage description

last_syncdatetime or null

Last sync finished time

last_sync_countinteger or null0-2147483647

Count of tasks synced last time

last_sync_jobstring or null<=256 characters

Last sync job ID

metaany or null

Meta and debug information about storage processes

prefixstring or null

S3 bucket prefix

regex_filterstring or null

Cloud storage regex for filtering objects

region_namestring or null

AWS Region

s3_endpointstring or null

S3 Endpoint

statusenum

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

synchronizablebooleanDefaults to true

titlestring or null<=256 characters

Cloud storage title

tracebackstring or null

Traceback report for the last failed sync

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs