API ReferenceExport StorageGcs SA

✨ Validate GCS SA export storage

<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> Validate a specific GCS export storage connection set up with SA Impersonation.

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>

Request

This endpoint expects an object.
projectintegerRequired
A unique integer value identifying this project.
bucketstring or nullOptional
GCS bucket name
can_delete_objectsboolean or nullOptional
Deletion from storage enabled
descriptionstring or nullOptional
Cloud storage description
google_project_idstring or nullOptional
Google project 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
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
target_service_account_emailstring or nullOptional
Service account email to impersonate for GCS access
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

Response

Validation successful