Import StorageS3

Validate import storage

POST
Validate a specific S3 import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.

Request

This endpoint expects an object.
id
integerOptional
Storage ID. If set, storage with specified ID will be updated
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
POST
1curl -X POST http://localhost:8080/api/storages/s3/validate \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{}'