Import StorageS3

Update import storage

PATCH

Path parameters

idintegerRequired
A unique integer value identifying this s3 import storage.

Request

This endpoint expects an object.
regex_filter
stringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urls
booleanOptional
Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
presign
booleanOptional
Presign URLs for download
presign_ttl
integerOptionalDefaults to 1
Presign TTL in minutes
recursive_scan
booleanOptional
Scan recursively
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
regex_filter
stringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urls
booleanOptional
Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
presign
booleanOptional
Presign URLs for download
presign_ttl
integerOptionalDefaults to 1
Presign TTL in minutes
recursive_scan
booleanOptional
Scan recursively
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
PATCH
1curl -X PATCH http://localhost:8080/api/storages/s3/1 \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Updated
1{
2 "regex_filter": "regex_filter",
3 "use_blob_urls": true,
4 "presign": true,
5 "presign_ttl": 1,
6 "recursive_scan": true,
7 "title": "title",
8 "description": "description",
9 "project": 1,
10 "bucket": "bucket",
11 "prefix": "prefix",
12 "aws_access_key_id": "aws_access_key_id",
13 "aws_secret_access_key": "aws_secret_access_key",
14 "aws_session_token": "aws_session_token",
15 "aws_sse_kms_key_id": "aws_sse_kms_key_id",
16 "region_name": "region_name",
17 "s3_endpoint": "s3_endpoint"
18}