Storage: Databricks Files

✨ Create Databricks import storage

Changed on
<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 a Databricks Files import storage connection.
post/api/storages/databricks/

Request

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

Request body

auth_type'pat' | 'dbx_sp' | 'azure_ad_sp'
  • pat - Personal Access Token
  • dbx_sp - Databricks Service Principal
  • azure_ad_sp - Azure AD Service Principal
catalogstring required

UC catalog name

client_idstring

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

client_secretstring

Service principal client secret (required for SP modes)

descriptionstring nullable

Cloud storage description

hoststring required

Databricks workspace base URL (https://...)

prefixstring nullable

Path under the volume

presignboolean

Presign not supported; always proxied

presign_ttlinteger

Unused for Databricks; kept for compatibility

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean

Perform recursive scan

regex_filterstring nullable

Regex for filtering objects

request_timeout_sinteger
schemastring required

UC schema name

stream_chunk_bytesinteger
synchronizableboolean
tenant_idstring

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

titlestring nullable

Cloud storage title

tokenstring

Databricks personal access token (required for PAT mode)

use_blob_urlsboolean

Generate blob URLs in tasks

verify_tlsboolean

Verify TLS certificates

volumestring required

UC volume name

Response

auth_type'pat' | 'dbx_sp' | 'azure_ad_sp'
  • pat - Personal Access Token
  • dbx_sp - Databricks Service Principal
  • azure_ad_sp - Azure AD Service Principal
catalogstring required

UC catalog name

client_idstring

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

created_atstring date-time required

Creation time

descriptionstring nullable

Cloud storage description

hoststring required

Databricks workspace base URL (https://...)

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

Path under the volume

presignboolean

Presign not supported; always proxied

presign_ttlinteger

Unused for Databricks; kept for compatibility

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean

Perform recursive scan

regex_filterstring nullable

Regex for filtering objects

request_timeout_sinteger
schemastring required

UC schema name

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
stream_chunk_bytesinteger
synchronizableboolean
tenant_idstring

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

titlestring nullable

Cloud storage title

tracebackstring nullable

Traceback report for the last failed sync

typestring required
use_blob_urlsboolean

Generate blob URLs in tasks

verify_tlsboolean

Verify TLS certificates

volumestring required

UC volume name

Changes

  • e1ba2ecdbabbRevision changes
    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)