Import StorageS3

List import 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 Google import (source) 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
project
integer
A unique integer value identifying this project.
id
integerOptional
type
stringOptionalDefaults to s3
synchronizable
booleanOptional
presign
booleanOptional
last_sync
datetimeOptional
Last sync finished time
last_sync_count
integerOptional
Count of tasks synced last time
last_sync_job
stringOptional
Last sync job ID
status
enumOptional
Allowed values: initializedqueuedin_progressfailedcompleted
traceback
stringOptional
Traceback report for the last failed sync
meta
map from strings to anyOptional
Meta and debug information about storage processes
title
stringOptional
Cloud storage title
description
stringOptional
Cloud storage description
created_at
datetimeOptional
Creation time
bucket
stringOptional
S3 bucket name
prefix
stringOptional
S3 bucket prefix
regex_filter
stringOptional
Cloud storage regex for filtering objects
use_blob_urls
booleanOptional
Interpret objects as BLOBs and generate URLs
aws_access_key_id
stringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_key
stringOptional

AWS_SECRET_ACCESS_KEY

aws_session_token
stringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_id
stringOptional
AWS SSE KMS Key ID
region_name
stringOptional
AWS Region
s3_endpoint
stringOptional
S3 Endpoint
presign_ttl
integerOptional
Presigned URLs TTL (in minutes)
recursive_scan
booleanOptional
Perform recursive scan over the bucket content
GET
1curl http://localhost:8080/api/storages/s3/ \
2 -H "Authorization: Token <api_key>"
200Retrieved
1[
2 {
3 "project": 1,
4 "id": 1,
5 "type": "type",
6 "synchronizable": true,
7 "presign": true,
8 "last_sync": "2024-01-15T09:30:00Z",
9 "last_sync_count": 1,
10 "last_sync_job": "last_sync_job",
11 "status": "initialized",
12 "traceback": "traceback",
13 "meta": {
14 "meta": {
15 "key": "value"
16 }
17 },
18 "title": "title",
19 "description": "description",
20 "created_at": "2024-01-15T09:30:00Z",
21 "bucket": "bucket",
22 "prefix": "prefix",
23 "regex_filter": "regex_filter",
24 "use_blob_urls": true,
25 "aws_access_key_id": "aws_access_key_id",
26 "aws_secret_access_key": "aws_secret_access_key",
27 "aws_session_token": "aws_session_token",
28 "aws_sse_kms_key_id": "aws_sse_kms_key_id",
29 "region_name": "region_name",
30 "s3_endpoint": "s3_endpoint",
31 "presign_ttl": 1,
32 "recursive_scan": true
33 }
34]