Get export storage | API Reference

curl http://localhost:8000/api/storages/export/redis/1 \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json"

{
  "created_at": "2024-01-15T09:30:00Z",
  "id": 1,
  "project": 42,
  "type": "redis",
  "can_delete_objects": true,
  "db": 0,
  "description": "Primary Redis export storage for project data",
  "host": "192.168.1.100",
  "last_sync": "2024-04-20T16:45:00Z",
  "last_sync_count": 1250,
  "last_sync_job": "job-20240420-1645",
  "meta": null,
  "password": "s3cureP@ssw0rd!",
  "path": "exports/project_42/",
  "port": "6379",
  "regex_filter": "^export_.*\\.json$",
  "status": "completed",
  "synchronizable": true,
  "title": "Redis Export Storage - Project 42",
  "traceback": null,
  "use_blob_urls": true
}

Get a specific 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 null

Deletion from storage enabled

dbinteger0-32767

Server Database

descriptionstring or null

Cloud storage description

hoststring or null

Server Host IP (optional)

last_syncdatetime or null

Last sync finished time

last_sync_countinteger or null0-2147483647

Count of tasks synced last time

last_sync_jobstring or null<=256 characters

Last sync job ID

metaany or null

Meta and debug information about storage processes

passwordstring or null

Server Password (optional)

pathstring or null

Storage prefix (optional)

portstring or null

Server Port (optional)

regex_filterstring or null

Cloud storage regex for filtering objects

statusenum

initialized - Initialized
queued - Queued
in_progress - In progress
failed - Failed
completed - Completed
completed_with_errors - Completed with errors

synchronizablebooleanDefaults to true

titlestring or null<=256 characters

Cloud storage title

tracebackstring or null

Traceback report for the last failed sync

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs