[Go to site: main page, start]

Sync import storage

Sync tasks from an Azure import storage connection.

Authentication

AuthorizationToken
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>

Path parameters

idintegerRequired
Storage ID

Response

created_atdatetimeRead-only
Creation time
idintegerRead-only
projectinteger
A unique integer value identifying this project.
typestringRead-onlyDefaults to azure
account_keystring or nullOptional
Azure Blob account key
account_namestring or nullOptional
Azure Blob account name
containerstring or nullOptional
Azure blob container
descriptionstring or nullOptional
Cloud storage description
last_syncdatetime or nullOptional
Last sync finished time
last_sync_countinteger or nullOptional0-2147483647
Count of tasks synced last time
last_sync_jobstring or nullOptional<=256 characters
Last sync job ID
metaany or nullOptional
Meta and debug information about storage processes
prefixstring or nullOptional
Azure blob prefix name
presignbooleanOptionalDefaults to true
presign_ttlintegerOptional0-32767

Presigned URLs TTL (in minutes)

recursive_scanboolean or nullOptional
Perform recursive scan over the container content
regex_filterstring or nullOptional
Cloud storage regex for filtering objects
statusenumOptional
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizablebooleanOptionalDefaults to true
titlestring or nullOptional<=256 characters
Cloud storage title
tracebackstring or nullOptional
Traceback report for the last failed sync
use_blob_urlsbooleanOptional
Interpret objects as BLOBs and generate URLs