✨ Create Databricks import storage

POST

http://localhost:8000/api/storages/databricks/

POST

/api/storages/databricks/

$ curl -X POST http://localhost:8000/api/storages/databricks/ \
>      -H "Authorization: Token  <api_key>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "catalog": "string",
>   "host": "string",
>   "project": 1,
>   "schema": "string",
>   "volume": "string"
> }'

201Created

1 {
2   "catalog": "string",
3   "created_at": "2024-01-15T09:30:00Z",
4   "host": "string",
5   "id": 1,
6   "project": 1,
7   "schema": "string",
8   "type": "databricks",
9   "volume": "string",
10   "auth_type": "pat",
11   "client_id": "string",
12   "description": "string",
13   "last_sync": "2024-01-15T09:30:00Z",
14   "last_sync_count": 1,
15   "last_sync_job": "string",
16   "meta": null,
17   "prefix": "string",
18   "presign": true,
19   "presign_ttl": 1,
20   "recursive_scan": true,
21   "regex_filter": "string",
22   "request_timeout_s": 1,
23   "status": "initialized",
24   "stream_chunk_bytes": 1,
25   "synchronizable": true,
26   "tenant_id": "string",
27   "title": "string",
28   "traceback": "string",
29   "use_blob_urls": true,
30   "verify_tls": true
31 }

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

Create a Databricks Files import 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 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:

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_typeenumOptionalDefaults to pat

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

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

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

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)

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