API ReferenceExport StorageS3

Create new storage

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.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
can_delete_objectsbooleanOptional
Deletion from storage enabled.
titlestringOptional
Storage title
descriptionstringOptional
Storage description
projectintegerOptional
Project ID
bucketstringOptional
S3 bucket name
prefixstringOptional
S3 bucket prefix
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
region_namestringOptional
AWS Region
s3_endpointstringOptional
S3 Endpoint

Response

can_delete_objectsboolean or null
Deletion from storage enabled.
titlestring or null
Storage title
descriptionstring or null
Storage description
projectinteger or null
Project ID
bucketstring or null
S3 bucket name
prefixstring or null
S3 bucket prefix
aws_access_key_idstring or null

AWS_ACCESS_KEY_ID

aws_secret_access_keystring or null

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring or null

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring or null
AWS SSE KMS Key ID
region_namestring or null
AWS Region
s3_endpointstring or null
S3 Endpoint