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.

projectinteger

A unique integer value identifying this project.

idintegerOptional

synchronizablebooleanOptional

presignbooleanOptional

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

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

region_namestringOptional

AWS Region

external_idstringOptional

AWS External ID

role_arnstringOptional

AWS Role ARN

s3_endpointstringOptional

S3 Endpoint

presign_ttlintegerOptional

Presigned URLs TTL (in minutes)

recursive_scanbooleanOptional

Perform recursive scan over the bucket content

GET

1 curl http://localhost:8080/api/storages/s3s \
2      -H "Authorization: Token  <api_key>"

200Retrieved

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

Create import storage

Up Next

Built with

1	curl http://localhost:8080/api/storages/s3s \
2	-H "Authorization: Token <api_key>"

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