Update import storage | API Reference

Update a specific local file import storage connection.

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>

Path parameters

idintegerRequired

Request

This endpoint expects an object.

descriptionstringOptional

Storage description

pathstringOptional

Path to local directory

projectintegerOptional

Project ID

regex_filterstringOptional

Regex for filtering objects

titlestringOptional<=2048 characters

Storage title

use_blob_urlsbooleanOptionalDefaults to false

Interpret objects as BLOBs and generate URLs. For example, if your directory 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 localfiles

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

pathstring or null

Local path

recursive_scanboolean or null

Perform recursive scan over the directory content

regex_filterstring or null

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	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.import_storage.local.update(
7	id=1,
8	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"project": 1,
5	"type": "localfiles",
6	"description": "string",
7	"last_sync": "2024-01-15T09:30:00Z",
8	"last_sync_count": 1,
9	"last_sync_job": "string",
10	"meta": null,
11	"path": "string",
12	"recursive_scan": true,
13	"regex_filter": "string",
14	"status": "initialized",
15	"synchronizable": true,
16	"title": "string",
17	"traceback": "string",
18	"use_blob_urls": true
19	}