Create new storage | API Reference

Create new Azure import storage

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Request

This endpoint expects an object.

account_keystringOptional

Azure Blob account key

account_namestringOptional

Azure Blob account name

containerstringOptional

Azure blob container

descriptionstringOptional

Storage description

prefixstringOptional

Azure blob prefix name

presignbooleanOptionalDefaults to true

Presign URLs for direct download

presign_ttlintegerOptionalDefaults to 1

Presign TTL in minutes

projectintegerOptional

Project ID

regex_filterstringOptional

Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.

titlestringOptional<=2048 characters

Storage title

use_blob_urlsbooleanOptionalDefaults to false

Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.

Response

created_atdatetime

Creation time

idinteger

projectinteger

A unique integer value identifying this project.

typestringDefaults to azure

account_keystring or null

Azure Blob account key

account_namestring or null

Azure Blob account name

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

prefixstring or null

Azure blob prefix name

presignboolean or nullDefaults to true

presign_ttlinteger or null0-32767

Presigned URLs TTL (in minutes)

recursive_scanboolean or null

Perform recursive scan over the container content

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

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

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

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"project": 1,
5	"type": "type",
6	"account_key": "account_key",
7	"account_name": "account_name",
8	"container": "container",
9	"description": "description",
10	"last_sync": "2024-01-15T09:30:00Z",
11	"last_sync_count": 1,
12	"last_sync_job": "last_sync_job",
13	"meta": {
14	"key": "value"
15	},
16	"prefix": "prefix",
17	"presign": true,
18	"presign_ttl": 1,
19	"recursive_scan": true,
20	"regex_filter": "regex_filter",
21	"status": "initialized",
22	"synchronizable": true,
23	"title": "title",
24	"traceback": "traceback",
25	"use_blob_urls": true
26	}