Sign in
Storage: GCS

Update import storage

Update a specific GCS import storage connection.

patch/api/storages/gcs/{id}

Path parameters

idinteger required

Request body

bucketstring

GCS bucket name

descriptionstring

Storage description

google_application_credentialsstring

The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.

google_project_idstring

Google project ID

prefixstring

GCS bucket prefix

presignboolean

Presign URLs for direct download

presign_ttlinteger

Presign TTL in minutes

projectinteger

Project ID

regex_filterstring

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

titlestring

Storage title

use_blob_urlsboolean

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

bucketstring nullable

GCS bucket name

created_atstring date-time required

Creation time

descriptionstring nullable

Cloud storage description

google_application_credentialsstring nullable

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring nullable

Google project ID

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:GCSImportStorage:properties:meta","oasType":"schema","type":"unknown","description":"Meta and debug information about storage processes","nullable":true}
prefixstring nullable

GCS bucket prefix

presignboolean
presign_ttlinteger

Presigned URLs TTL (in minutes)

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean nullable

Perform recursive scan over the bucket content

regex_filterstring nullable

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