Storage: GCS WIF

✨ Create GCS export storage with WIF authentication

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Create an GCS export storage connection with WIF authentication to store annotations.
post/api/storages/export/gcswif

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/storages/export/gcswif
  • Auth
    API key in header Authorization

Request body

bucketstring nullable

GCS bucket name

can_delete_objectsboolean nullable

Deletion from storage enabled

descriptionstring nullable

Cloud storage description

google_application_credentialsstring nullable

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring nullable

Google project ID

google_project_numberstring nullable

Google project number

google_service_account_emailstring nullable

Google service account email

google_wif_pool_idstring nullable

Google WIF pool ID

google_wif_provider_idstring nullable

Google WIF provider ID

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

metaunknown
prefixstring nullable

GCS bucket prefix

projectinteger required

A unique integer value identifying this project.

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

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

Response

bucketstring nullable

GCS bucket name

can_delete_objectsboolean nullable

Deletion from storage enabled

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

google_project_numberstring nullable

Google project number

google_service_account_emailstring nullable

Google service account email

google_wif_pool_idstring nullable

Google WIF pool ID

google_wif_provider_idstring nullable

Google WIF provider 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

metaunknown
prefixstring nullable

GCS bucket prefix

projectinteger required

A unique integer value identifying this project.

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

No operation changes recorded.