Export StorageS3

Create new storage

POST

Create a new target storage connection to S3 storage.

For information about the required fields and prerequisites, see Amazon S3 in the Label Studio documentation.

After you add the storage, you should validate the connection before attempting to sync your data. Your data will not be exported until you sync your connection.

Request

This endpoint expects an object.
can_delete_objects
booleanOptional
Deletion from storage enabled.
title
stringOptional
Storage title
description
stringOptional
Storage description
project
integerOptional
Project ID
bucket
stringOptional
S3 bucket name
prefix
stringOptional
S3 bucket prefix
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

Response

This endpoint returns an object
can_delete_objects
booleanOptional
Deletion from storage enabled.
title
stringOptional
Storage title
description
stringOptional
Storage description
project
integerOptional
Project ID
bucket
stringOptional
S3 bucket name
prefix
stringOptional
S3 bucket prefix
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
POST
1curl -X POST http://localhost:8080/api/storages/export/s3 \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "can_delete_objects": true,
3 "title": "title",
4 "description": "description",
5 "project": 1,
6 "bucket": "bucket",
7 "prefix": "prefix",
8 "aws_access_key_id": "aws_access_key_id",
9 "aws_secret_access_key": "aws_secret_access_key",
10 "aws_session_token": "aws_session_token",
11 "aws_sse_kms_key_id": "aws_sse_kms_key_id",
12 "region_name": "region_name",
13 "s3_endpoint": "s3_endpoint"
14}