API ReferenceImport StorageS3s

Update import storage

Update a specific S3 import storage connection. You will need to provide the import storage ID. You can find this using List import storages.

For more information about working with external storage, see Sync data from external storage.

Path parameters

idintegerRequired
Import storage ID

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
regex_filterstringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
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.
presignbooleanOptionalDefaults to true
Presign URLs for download
presign_ttlintegerOptionalDefaults to 1
Presign TTL in minutes
recursive_scanbooleanOptional
Scan recursively
titlestringOptional
Storage title
descriptionstringOptional
Storage description
projectintegerOptional
Project ID
bucketstringOptional
S3 bucket name
prefixstringOptional
S3 bucket prefix
external_idstringOptional
AWS External ID
role_arnstringOptional
AWS Role ARN
region_namestringOptional
AWS Region
s3_endpointstringOptional
S3 Endpoint

Response

projectinteger
A unique integer value identifying this project.
idinteger or null
synchronizableboolean or nullDefaults to true
presignboolean or nullDefaults to true
last_syncdatetime or null
Last sync finished time
last_sync_countinteger or null
Count of tasks synced last time
last_sync_jobstring or null<=256 characters
Last sync job ID
statusenum or null
Allowed values:
tracebackstring or null
Traceback report for the last failed sync
metamap from strings to any or null
Meta and debug information about storage processes
titlestring or null<=256 characters
Cloud storage title
descriptionstring or null
Cloud storage description
created_atdatetime or null
Creation time
bucketstring or null
S3 bucket name
prefixstring or null
S3 bucket prefix
regex_filterstring or null
Cloud storage regex for filtering objects
use_blob_urlsboolean or null
Interpret objects as BLOBs and generate URLs
region_namestring or null
AWS Region
external_idstring or null
AWS External ID
role_arnstring or null
AWS Role ARN
s3_endpointstring or null
S3 Endpoint
presign_ttlinteger or null

Presigned URLs TTL (in minutes)

recursive_scanboolean or null
Perform recursive scan over the bucket content