API ReferenceImport StorageS3

Validate import storage

Validate a specific S3 import storage connection.

Authentication

Authorizationstring
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Request

This endpoint expects an object.
aws_access_key_idstringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_keystringOptional

AWS_SECRET_ACCESS_KEY

aws_session_tokenstringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_idstringOptional
AWS SSE KMS Key ID
bucketstringOptional
S3 bucket name
descriptionstringOptional
Storage description
idintegerOptional
Storage ID. If set, storage with specified ID will be updated
prefixstringOptional
S3 bucket prefix
presignbooleanOptionalDefaults to true
Presign URLs for download
presign_ttlintegerOptionalDefaults to 1
Presign TTL in minutes
projectintegerOptional
Project ID
recursive_scanbooleanOptional
Scan recursively
regex_filterstringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
region_namestringOptional
AWS Region
s3_endpointstringOptional
S3 Endpoint
titlestringOptional<=2048 characters
Storage title
use_blob_urlsbooleanOptionalDefaults to false
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.

Response

Validation successful