✨ Create Azure export storage with SPI authentication | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Create an Azure export storage connection with Service Principal authentication to store annotations.

<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> Create an Azure export storage connection with Service Principal authentication to store annotations.

Authentication

Authorizationstring

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:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

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

can_delete_objectsboolean or nullOptional

Deletion from storage enabled

client_idstring or nullOptional

Azure Blob Service Principal Client ID

client_secretstring or nullOptional

Azure Blob Service Principal Client Secret

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

* `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

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

created_atdatetime

Creation time

idinteger

projectinteger

A unique integer value identifying this project.

typestringDefaults to azure_spi

account_namestring or null

Azure Blob account name

can_delete_objectsboolean or null

Deletion from storage enabled

client_idstring or null

Azure Blob Service Principal Client ID

client_secretstring or null

Azure Blob Service Principal Client Secret

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 or null

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

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

synchronizableboolean or nullDefaults to true

tenant_idstring or null

Azure Tenant ID

titlestring or null<=256 characters

Cloud storage title

tracebackstring or null

Traceback report for the last failed sync

use_blob_urlsboolean or null

Interpret objects as BLOBs and generate URLs

user_delegation_keystring or null

User Delegation Key (Backend)

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.export_storage.azure_spi.create(
7	project=1,
8	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"project": 1,
5	"type": "azure_spi",
6	"account_name": "string",
7	"can_delete_objects": true,
8	"client_id": "string",
9	"client_secret": "string",
10	"container": "string",
11	"description": "string",
12	"last_sync": "2024-01-15T09:30:00Z",
13	"last_sync_count": 1,
14	"last_sync_job": "string",
15	"meta": null,
16	"prefix": "string",
17	"regex_filter": "string",
18	"status": "initialized",
19	"synchronizable": true,
20	"tenant_id": "string",
21	"title": "string",
22	"traceback": "string",
23	"use_blob_urls": true,
24	"user_delegation_key": "string"
25	}