✨ Get GCS WIF import storage

GET

http://localhost:8000/api/storages/gcswif/

GET

/api/storages/gcswif/

curl -G http://localhost:8000/api/storages/gcswif/ \
     -H "Authorization: Token  <api_key>" \
     -d project=1

200Retrieved

[
  {
    "created_at": "2024-01-15T09:30:00Z",
    "id": 1,
    "project": 1,
    "type": "gcswif",
    "bucket": "string",
    "description": "string",
    "google_application_credentials": "string",
    "google_project_id": "string",
    "google_project_number": "string",
    "google_service_account_email": "string",
    "google_wif_pool_id": "string",
    "google_wif_provider_id": "string",
    "last_sync": "2024-01-15T09:30:00Z",
    "last_sync_count": 1,
    "last_sync_job": "string",
    "meta": null,
    "prefix": "string",
    "presign": true,
    "presign_ttl": 1,
    "recursive_scan": true,
    "regex_filter": "string",
    "status": "initialized",
    "synchronizable": true,
    "title": "string",
    "traceback": "string",
    "use_blob_urls": true
  }
]

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Get list of all GCS import storage connections set up with WIF authentication.

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:

curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"

Query parameters

orderingstringOptional

Which field to use when ordering the results.

projectintegerRequired

Project ID

Response

This endpoint returns a list of objects.

created_atdatetimeRead-only

Creation time

idintegerRead-only

projectinteger

A unique integer value identifying this project.

typestringRead-onlyDefaults to gcswif

bucketstring or nullOptional

GCS bucket name

descriptionstring or nullOptional

Cloud storage description

google_application_credentialsstring or nullOptional

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring or nullOptional

Google project ID

google_project_numberstring or nullOptional

Google project number

google_service_account_emailstring or nullOptional

Google service account email

google_wif_pool_idstring or nullOptional

Google WIF pool ID

google_wif_provider_idstring or nullOptional

Google WIF provider ID

last_syncdatetime or nullOptional

Last sync finished time

last_sync_countinteger or nullOptional0-2147483647

Count of tasks synced last time

last_sync_jobstring or nullOptional<=256 characters

Last sync job ID

metaany or nullOptional

Meta and debug information about storage processes

prefixstring or nullOptional

GCS bucket prefix

presignbooleanOptionalDefaults to true

presign_ttlintegerOptional0-32767

Presigned URLs TTL (in minutes)

recursive_scanboolean or nullOptional

Perform recursive scan over the bucket content

regex_filterstring or nullOptional

Cloud storage regex for filtering objects

statusenumOptional

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

synchronizablebooleanOptionalDefaults to true

titlestring or nullOptional<=256 characters

Cloud storage title

tracebackstring or nullOptional

Traceback report for the last failed sync

use_blob_urlsbooleanOptional

Interpret objects as BLOBs and generate URLs