API ReferenceExport StorageAzure Spi

✨ Validate Azure SPI export storage

<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> Validate a specific Azure export 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.

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>

Request

This endpoint expects an object.
projectintegerRequired
A unique integer value identifying this project.
account_namestring or nullOptional
Azure Blob account name
auth_modeenum or nullOptional

Authentication mode. service_principal uses a client secret. workload_identity uses constrained DefaultAzureCredential (workload identity + managed identity only). Defaults to service_principal.

  • service_principal - Service Principal
  • workload_identity - Workload identity
can_delete_objectsboolean or nullOptional
Deletion from storage enabled
client_idstring or nullOptional

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

client_secretstring or nullOptional

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 or nullOptional
Azure blob container
descriptionstring or nullOptional
Cloud storage description
last_syncdatetime or nullOptional
Last sync finished time
last_sync_countinteger or nullOptional0-2147483647
Count of tasks synced last time
last_sync_jobstring or nullOptional<=256 characters
Last sync job ID
metaany or nullOptional
Meta and debug information about storage processes
prefixstring or nullOptional
Azure blob prefix name
regex_filterstring or nullOptional
Cloud storage regex for filtering objects
statusenumOptional
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizablebooleanOptionalDefaults to true
tenant_idstring or nullOptional

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

titlestring or nullOptional<=256 characters
Cloud storage title
tracebackstring or nullOptional
Traceback report for the last failed sync
use_blob_urlsbooleanOptional
Interpret objects as BLOBs and generate URLs
user_delegation_keystring or nullOptional

User Delegation Key (Backend)

Response

Validation successful