List export storages

GET

You can connect your S3 bucket to Label Studio as a source storage or target storage. Use this API request to get a list of all S3 export (target) storage connections for a specific project.

The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects.

For more information about working with external storage, see Sync data from external storage.

Query parameters

projectintegerOptional

Project ID

Response

This endpoint returns a list of objects.
projectinteger

A unique integer value identifying this project.

idintegerOptional
typestringOptionalDefaults to s3
synchronizablebooleanOptional
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

can_delete_objectsbooleanOptional

Deletion from storage enabled

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