Get all export storage | API Reference

curl -G http://localhost:8000/api/storages/export/localfiles \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json" \
     -d project=1

[
  {
    "created_at": "2024-04-10T08:45:00Z",
    "id": 42,
    "project": 42,
    "type": "localfiles",
    "can_delete_objects": true,
    "description": "Local export storage for project assets",
    "last_sync": "2024-04-15T12:00:00Z",
    "last_sync_count": 150,
    "last_sync_job": "sync-job-20240415-1200",
    "meta": null,
    "path": "/mnt/data/exports/project42",
    "regex_filter": ".*\\.json$",
    "status": "completed",
    "synchronizable": true,
    "title": "Project 42 Export Storage",
    "traceback": null,
    "use_blob_urls": false
  }
]

Get a list of all local file export storage connections.

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>

Query parameters

orderingstringOptional

Which field to use when ordering the results.

projectintegerRequired

Project ID

Response

created_atdatetimeRead-only

Creation time

idintegerRead-only

projectinteger

A unique integer value identifying this project.

typestringRead-onlyDefaults to localfiles

can_delete_objectsboolean or null

Deletion from storage enabled

descriptionstring or null

Cloud storage description

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

pathstring or null

Local path

regex_filterstring or null

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