API ReferenceExport StorageDatabricks

✨ Get Databricks 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> Get a specific Databricks Files export storage connection.

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>

Path parameters

idintegerRequired

Response

catalogstring
UC catalog name
created_atdatetimeRead-only
Creation time
hoststring

Databricks workspace base URL (https://…)

idintegerRead-only
projectinteger
A unique integer value identifying this project.
schemastring
UC schema name
typestringRead-onlyDefaults to databricks
volumestring
UC volume name
auth_typeenum

Authentication method: PAT, Databricks SP, or Azure AD SP

  • pat - Personal Access Token
  • dbx_sp - Databricks Service Principal
  • azure_ad_sp - Azure AD Service Principal
Allowed values:
can_delete_objectsboolean or null
Deletion from storage enabled
client_idstring

Service principal client/application ID (required for SP modes)

descriptionstring or null
Cloud storage description
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
Export path prefix under the volume
regex_filterstring or null
Regex for filtering objects
request_timeout_sinteger0-2147483647
statusenum
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
stream_chunk_bytesinteger0-2147483647
synchronizablebooleanDefaults to true
tenant_idstring

Azure AD tenant ID (required for Azure AD SP mode)

titlestring or null<=256 characters
Cloud storage title
tracebackstring or null
Traceback report for the last failed sync
use_blob_urlsboolean
Generate blob URLs in tasks
verify_tlsboolean
Verify TLS certificates