API ReferenceImport StorageRedis

List import storages

You can connect your Redis database to Label Studio as a source storage or target storage. Use this API request to get a list of all Redis import (source) storage connections for a specific project.

The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects.

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

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Query parameters

projectintegerOptional
Project ID

Response

projectinteger
A unique integer value identifying this project.
idinteger or null
typestring or nullDefaults to redis
synchronizableboolean or nullDefaults to true
pathstring or null

Storage prefix (optional)

hoststring or null

Server Host IP (optional)

portstring or null

Server Port (optional)

passwordstring or null

Server Password (optional)

regex_filterstring or null
Cloud storage regex for filtering objects
use_blob_urlsboolean or null
Interpret objects as BLOBs and generate URLs
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
dbinteger or null
Server Database