Storage: Local

Update import storage

Update a specific local file import storage connection.

patch/api/storages/localfiles/{id}

Path parameters

idinteger required

Request body

descriptionstring

Storage description

pathstring

Path to local directory

projectinteger

Project ID

regex_filterstring

Regex for filtering objects

titlestring

Storage title

use_blob_urlsboolean

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_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

{"stackTrail":"components:schemas:LocalFilesImportStorage:properties:meta","oasType":"schema","type":"unknown","description":"Meta and debug information about storage processes","nullable":true}
pathstring nullable

Local path

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean nullable

Perform recursive scan over the directory content

regex_filterstring nullable

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

Changes