Get all import storage | API Reference

curl -G http://localhost:8000/api/storages/gcs/ \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json" \
     -d project=1

[
  {
    "created_at": "2024-01-15T09:30:00Z",
    "id": 42,
    "project": 7,
    "type": "gcs",
    "bucket": "label-studio-datasets",
    "description": "Primary GCS bucket for project assets",
    "google_application_credentials": "{ \"type\": \"service_account\", \"project_id\": \"label-studio-12345\", \"private_key_id\": \"abcdef1234567890\", \"private_key\": \"-----BEGIN PRIVATE KEY-----\\nMIIEv...\\n-----END PRIVATE KEY-----\\n\", \"client_email\": \"label-studio@label-studio-12345.iam.gserviceaccount.com\", \"client_id\": \"1234567890\", \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\", \"token_uri\": \"https://oauth2.googleapis.com/token\", \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\", \"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/label-studio%40label-studio-12345.iam.gserviceaccount.com\" }",
    "google_project_id": "label-studio-12345",
    "last_sync": "2024-04-10T14:45:00Z",
    "last_sync_count": 150,
    "last_sync_job": "sync-job-20240410-1445",
    "meta": null,
    "prefix": "images/2024/",
    "presign": true,
    "presign_ttl": 60,
    "recursive_scan": true,
    "regex_filter": ".*\\.(jpg|png|jpeg)$",
    "status": "completed",
    "synchronizable": true,
    "title": "Project 7 GCS Storage",
    "traceback": null,
    "use_blob_urls": false
  }
]

Get a list of all GCS import storage connections.

Authentication

AuthorizationToken

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>

Query parameters

orderingstringOptional

Which field to use when ordering the results.

projectintegerRequired

Project ID

Response

created_atdatetimeRead-only

Creation time

idintegerRead-only

projectinteger

A unique integer value identifying this project.

typestringRead-onlyDefaults to gcs

bucketstring or null

GCS bucket name

descriptionstring or null

Cloud storage description

google_application_credentialsstring or null

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring or null

Google project ID

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

GCS bucket prefix

presignbooleanDefaults to true

presign_ttlinteger0-32767

Presigned URLs TTL (in minutes)

recursive_scanboolean or null

Perform recursive scan over the bucket content

regex_filterstring or null

Cloud storage regex for filtering objects

statusenum

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

synchronizablebooleanDefaults to true

titlestring or null<=256 characters

Cloud storage title

tracebackstring or null

Traceback report for the last failed sync

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs