✨ Create Databricks export storage | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Create a Databricks Files export storage connection.

<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 export storage connection.

Authentication

Authorizationstring

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:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

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

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 nullOptional

Deletion from storage enabled

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

Export path prefix under the volume

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

* `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

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 or null

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

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 or null

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_sinteger or null0-2147483647

statusenum or null

initialized - Initialized
queued - Queued
in_progress - In progress
failed - Failed
completed - Completed
completed_with_errors - Completed with errors

* `initialized` - Initialized * `queued` - Queued * `in_progress` - In progress * `failed` - Failed * `completed` - Completed * `completed_with_errors` - Completed with errors

stream_chunk_bytesinteger or null0-2147483647

synchronizableboolean or nullDefaults to true

tenant_idstring or null

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 or null

Generate blob URLs in tasks

verify_tlsboolean or null

Verify TLS certificates

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	base_url="http://localhost:8000",
5	api_key="YOUR_API_KEY_HERE"
6	)
7
8	client.export_storage.databricks.create(
9	catalog="analytics_catalog",
10	host="https://adb-1234567890123456.7.azuredatabricks.net",
11	project=42,
12	schema="sales_schema",
13	volume="data_volume_01"
14	)

1	{
2	"catalog": "analytics_catalog",
3	"created_at": "2024-01-15T09:30:00Z",
4	"host": "https://adb-1234567890123456.7.azuredatabricks.net",
5	"id": 42,
6	"project": 42,
7	"schema": "sales_schema",
8	"type": "databricks",
9	"volume": "data_volume_01",
10	"auth_type": "pat",
11	"can_delete_objects": true,
12	"client_id": "sp-client-9876543210",
13	"description": "Databricks export storage for sales data",
14	"last_sync": "2024-04-20T14:45:00Z",
15	"last_sync_count": 1500,
16	"last_sync_job": "sync-job-20240420-1445",
17	"meta": null,
18	"prefix": "exports/sales",
19	"regex_filter": "^sales_data_.*\\.csv$",
20	"request_timeout_s": 120,
21	"status": "initialized",
22	"stream_chunk_bytes": 1048576,
23	"synchronizable": true,
24	"tenant_id": "72f988bf-86f1-41af-91ab-2d7cd011db47",
25	"title": "Sales Data Export Storage",
26	"traceback": "",
27	"use_blob_urls": true,
28	"verify_tls": true
29	}