Update export storage | API Reference

curl -X PATCH http://localhost:8000/api/storages/export/azure/1 \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "created_at": "2024-01-15T09:30:00Z",
  "id": 1,
  "project": 42,
  "type": "azure",
  "account_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "account_name": "labelstudioexport",
  "can_delete_objects": true,
  "container": "export-data",
  "description": "Azure Blob storage for exporting labeled data",
  "last_sync": "2024-04-20T14:45:00Z",
  "last_sync_count": 125,
  "last_sync_job": "sync-job-20240420-1445",
  "meta": null,
  "prefix": "exports/2024/",
  "regex_filter": "^.*\\.json$",
  "status": "initialized",
  "synchronizable": true,
  "title": "Azure Export Storage - Project 42",
  "traceback": "",
  "use_blob_urls": true
}

Update a specific Azure 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

Request

This endpoint expects an object.

account_keystringOptional

Azure Blob account key

account_namestringOptional

Azure Blob account name

can_delete_objectsbooleanOptionalDefaults to false

Deletion from storage enabled

containerstringOptional

Azure blob container

descriptionstringOptional

Storage description

prefixstringOptional

Azure blob prefix name

projectintegerOptional

Project ID

titlestringOptional<=2048 characters

Storage title

Response

created_atdatetimeRead-only

Creation time

idintegerRead-only

projectinteger

A unique integer value identifying this project.

typestringRead-onlyDefaults to azure

account_keystring or null

Azure Blob account key

account_namestring or null

Azure Blob account name

can_delete_objectsboolean or null

Deletion from storage enabled

containerstring or null

Azure blob container

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

prefixstring or null

Azure blob prefix name

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