API ReferenceImport StorageDatabricks

✨ Validate Databricks import 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 Databricks Files import 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>

Request

This endpoint expects an object.
catalogstringRequired>=1 character
UC catalog name
hoststringRequired>=1 character

Databricks workspace base URL (https://…)

projectintegerRequired
A unique integer value identifying this project.
schemastringRequired>=1 character
UC schema name
volumestringRequired>=1 character
UC volume name
auth_typeenumOptional

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:
client_idstringOptional

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

client_secretstringOptional

Service principal client secret (required for SP modes)

descriptionstring or nullOptional
Cloud storage description
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
Path under the volume
presignbooleanOptional

Presign not supported; always proxied

presign_ttlintegerOptional0-32767

Unused for Databricks; kept for compatibility

recursive_scanbooleanOptional
Perform recursive scan
regex_filterstring or nullOptional
Regex for filtering objects
request_timeout_sintegerOptional0-2147483647
statusenumOptional
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
stream_chunk_bytesintegerOptional0-2147483647
synchronizablebooleanOptionalDefaults to true
tenant_idstringOptional

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

titlestring or nullOptional<=256 characters
Cloud storage title
tokenstringOptional

Databricks personal access token (required for PAT mode)

tracebackstring or nullOptional
Traceback report for the last failed sync
use_blob_urlsbooleanOptional
Generate blob URLs in tasks
verify_tlsbooleanOptional
Verify TLS certificates

Response

Validation successful