Storage: Azure SPI

✨ Update Azure SPI import storage

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Update a specific Azure import storage connection (Service Principal or workload-identity). Supports auth_mode=service_principal (default; requires tenant_id, client_id, and client_secret) and auth_mode=workload_identity (secretless; client_secret must be omitted, tenant_id is not required, optional client_id selects a user-assigned managed identity). GET responses never include client_secret.
patch/api/storages/azure_spi/{id}

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/storages/azure_spi/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Request body

account_namestring nullable

Azure Blob account name

auth_mode'service_principal' | 'workload_identity'
  • service_principal - Service Principal
  • workload_identity - Workload identity
client_idstring nullable

For service_principal: Azure app registration client ID. For workload_identity: optional user-assigned managed identity client ID.

client_secretstring nullable

Azure Blob Service Principal client secret. Required when auth_mode is service_principal (or omitted). Must be omitted when auth_mode is workload_identity.

containerstring nullable

Azure blob container

descriptionstring nullable

Cloud storage description

last_syncstring date-time nullable

Last sync finished time

last_sync_countinteger nullable

Count of tasks synced last time

last_sync_jobstring nullable

Last sync job ID

metaunknown
prefixstring nullable

Azure blob prefix name

presignboolean
presign_ttlinteger

Presigned URLs TTL (in minutes)

projectinteger

A unique integer value identifying this project.

recursive_scanboolean nullable

Perform recursive scan

regex_filterstring nullable

Cloud storage regex for filtering objects

status'initialized' | 'queued' | 'in_progress' | 'failed' | 'completed' | 'completed_with_errors'
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizableboolean
tenant_idstring nullable

Azure Tenant ID. Required for service_principal; not used for workload_identity.

titlestring nullable

Cloud storage title

tracebackstring nullable

Traceback report for the last failed sync

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

user_delegation_keystring nullable

User Delegation Key (Backend)

Response

account_namestring nullable

Azure Blob account name

auth_mode'service_principal' | 'workload_identity'
  • service_principal - Service Principal
  • workload_identity - Workload identity
client_idstring nullable

For service_principal: Azure app registration client ID. For workload_identity: optional user-assigned managed identity client ID.

client_secretstring nullable

Azure Blob Service Principal client secret. Required when auth_mode is service_principal (or omitted). Must be omitted when auth_mode is workload_identity.

containerstring nullable

Azure blob container

created_atstring date-time required

Creation time

descriptionstring nullable

Cloud storage description

idinteger required
last_syncstring date-time nullable

Last sync finished time

last_sync_countinteger nullable

Count of tasks synced last time

last_sync_jobstring nullable

Last sync job ID

metaunknown
prefixstring nullable

Azure blob prefix name

presignboolean
presign_ttlinteger

Presigned URLs TTL (in minutes)

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean nullable

Perform recursive scan

regex_filterstring nullable

Cloud storage regex for filtering objects

status'initialized' | 'queued' | 'in_progress' | 'failed' | 'completed' | 'completed_with_errors'
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizableboolean
tenant_idstring nullable

Azure Tenant ID. Required for service_principal; not used for workload_identity.

titlestring nullable

Cloud storage title

tracebackstring nullable

Traceback report for the last failed sync

typestring required
use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

user_delegation_keystring nullable

User Delegation Key (Backend)

Changes

  • b5c41e1b64a6Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status