[Go to site: main page, start]
API ReferenceExport StorageRedis

Sync export storage

Sync tasks from a Redis export 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

Response

created_atdatetimeRead-only
Creation time
idintegerRead-only
projectinteger
A unique integer value identifying this project.
typestringRead-onlyDefaults to redis
can_delete_objectsboolean or nullOptional
Deletion from storage enabled
dbintegerOptional0-32767
Server Database
descriptionstring or nullOptional
Cloud storage description
hoststring or nullOptional

Server Host IP (optional)

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
passwordstring or nullOptional

Server Password (optional)

pathstring or nullOptional

Storage prefix (optional)

portstring or nullOptional

Server Port (optional)

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