Label Studio subpackage_importStorage.subpackage_importStorage/databricks API
The subpackage_importStorage.subpackage_importStorage/databricks API from Label Studio — 4 operation(s) for subpackage_importstorage.subpackage_importstorage/databricks.
OpenAPI Specification
openapi: 3.1.0
info:
title: API Reference subpackage_actions subpackage_importStorage.subpackage_importStorage/databricks API
version: 1.0.0
servers:
- url: http://localhost:8000
tags:
- name: subpackage_importStorage.subpackage_importStorage/databricks
paths:
/api/storages/databricks/:
get:
operationId: list
summary: ✨ List Databricks import storages
description: "<Card href=\"https://humansignal.com/goenterprise\">\n <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n <p style=\"margin-top: 10px; font-size: 14px;\">\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n </p>\n </Card>\nGet list of all Databricks Files import storage connections."
tags:
- subpackage_importStorage.subpackage_importStorage/databricks
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
schema:
type: string
- name: project
in: query
description: Project ID
required: true
schema:
type: integer
- name: Authorization
in: header
description: '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>'
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DatabricksImportStorage'
post:
operationId: create
summary: ✨ Create Databricks import storage
description: "<Card href=\"https://humansignal.com/goenterprise\">\n <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n <p style=\"margin-top: 10px; font-size: 14px;\">\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n </p>\n </Card>\nCreate a Databricks Files import storage connection."
tags:
- subpackage_importStorage.subpackage_importStorage/databricks
parameters:
- name: Authorization
in: header
description: '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>'
required: true
schema:
type: string
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorageRequest'
/api/storages/databricks/validate:
post:
operationId: validate
summary: ✨ Validate Databricks import storage
description: "<Card href=\"https://humansignal.com/goenterprise\">\n <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n <p style=\"margin-top: 10px; font-size: 14px;\">\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n </p>\n </Card>\nValidate a specific Databricks Files import storage connection."
tags:
- subpackage_importStorage.subpackage_importStorage/databricks
parameters:
- name: Authorization
in: header
description: '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>'
required: true
schema:
type: string
responses:
'200':
description: Validation successful
content:
application/json:
schema:
$ref: '#/components/schemas/import_storage_databricks_validate_Response_200'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorageRequest'
/api/storages/databricks/{id}:
get:
operationId: get
summary: ✨ Get Databricks import storage
description: "<Card href=\"https://humansignal.com/goenterprise\">\n <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n <p style=\"margin-top: 10px; font-size: 14px;\">\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n </p>\n </Card>\nGet a specific Databricks Files import storage connection."
tags:
- subpackage_importStorage.subpackage_importStorage/databricks
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: Authorization
in: header
description: '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>'
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorage'
delete:
operationId: delete
summary: ✨ Delete Databricks import storage
description: "<Card href=\"https://humansignal.com/goenterprise\">\n <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n <p style=\"margin-top: 10px; font-size: 14px;\">\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n </p>\n </Card>\nDelete a specific Databricks Files import storage connection."
tags:
- subpackage_importStorage.subpackage_importStorage/databricks
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: Authorization
in: header
description: '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>'
required: true
schema:
type: string
responses:
'200':
description: Successful response
patch:
operationId: update
summary: ✨ Update Databricks import storage
description: "<Card href=\"https://humansignal.com/goenterprise\">\n <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n <p style=\"margin-top: 10px; font-size: 14px;\">\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n </p>\n </Card>\nUpdate a specific Databricks Files import storage connection."
tags:
- subpackage_importStorage.subpackage_importStorage/databricks
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: Authorization
in: header
description: '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>'
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDatabricksImportStorageRequest'
/api/storages/databricks/{id}/sync:
post:
operationId: sync
summary: ✨ Sync Databricks import storage
description: "<Card href=\"https://humansignal.com/goenterprise\">\n <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n <p style=\"margin-top: 10px; font-size: 14px;\">\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n </p>\n </Card>\nSync tasks from a Databricks Files import storage."
tags:
- subpackage_importStorage.subpackage_importStorage/databricks
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: Authorization
in: header
description: '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>'
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorage'
components:
schemas:
DatabricksImportStorage:
type: object
properties:
auth_type:
$ref: '#/components/schemas/AuthTypeEnum'
description: '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'
catalog:
type: string
description: UC catalog name
client_id:
type: string
description: Service principal client/application ID (required for SP modes)
created_at:
type: string
format: date-time
description: Creation time
description:
type:
- string
- 'null'
description: Cloud storage description
host:
type: string
description: Databricks workspace base URL (https://...)
id:
type: integer
last_sync:
type:
- string
- 'null'
format: date-time
description: Last sync finished time
last_sync_count:
type:
- integer
- 'null'
description: Count of tasks synced last time
last_sync_job:
type:
- string
- 'null'
description: Last sync job ID
meta:
oneOf:
- description: Any type
- type: 'null'
description: Meta and debug information about storage processes
prefix:
type:
- string
- 'null'
description: Path under the volume
presign:
type: boolean
description: Presign not supported; always proxied
presign_ttl:
type: integer
description: Unused for Databricks; kept for compatibility
project:
type: integer
description: A unique integer value identifying this project.
recursive_scan:
type: boolean
description: Perform recursive scan
regex_filter:
type:
- string
- 'null'
description: Regex for filtering objects
request_timeout_s:
type: integer
schema:
type: string
description: UC schema name
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
type: integer
synchronizable:
type: boolean
default: true
tenant_id:
type: string
description: Azure AD tenant ID (required for Azure AD SP mode)
title:
type:
- string
- 'null'
description: Cloud storage title
traceback:
type:
- string
- 'null'
description: Traceback report for the last failed sync
type:
type: string
default: databricks
use_blob_urls:
type: boolean
description: Generate blob URLs in tasks
verify_tls:
type: boolean
description: Verify TLS certificates
volume:
type: string
description: UC volume name
required:
- catalog
- created_at
- host
- id
- project
- schema
- type
- volume
description: Serializer for Databricks import storage with multi-auth support.
title: DatabricksImportStorage
AuthTypeEnum:
type: string
enum:
- pat
- dbx_sp
- azure_ad_sp
description: '* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal'
title: AuthTypeEnum
DatabricksImportStorageRequest:
type: object
properties:
auth_type:
$ref: '#/components/schemas/AuthTypeEnum'
description: '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'
catalog:
type: string
description: UC catalog name
client_id:
type: string
description: Service principal client/application ID (required for SP modes)
client_secret:
type: string
description: Service principal client secret (required for SP modes)
description:
type:
- string
- 'null'
description: Cloud storage description
host:
type: string
description: Databricks workspace base URL (https://...)
last_sync:
type:
- string
- 'null'
format: date-time
description: Last sync finished time
last_sync_count:
type:
- integer
- 'null'
description: Count of tasks synced last time
last_sync_job:
type:
- string
- 'null'
description: Last sync job ID
meta:
oneOf:
- description: Any type
- type: 'null'
description: Meta and debug information about storage processes
prefix:
type:
- string
- 'null'
description: Path under the volume
presign:
type: boolean
description: Presign not supported; always proxied
presign_ttl:
type: integer
description: Unused for Databricks; kept for compatibility
project:
type: integer
description: A unique integer value identifying this project.
recursive_scan:
type: boolean
description: Perform recursive scan
regex_filter:
type:
- string
- 'null'
description: Regex for filtering objects
request_timeout_s:
type: integer
schema:
type: string
description: UC schema name
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
type: integer
synchronizable:
type: boolean
default: true
tenant_id:
type: string
description: Azure AD tenant ID (required for Azure AD SP mode)
title:
type:
- string
- 'null'
description: Cloud storage title
token:
type: string
description: Databricks personal access token (required for PAT mode)
traceback:
type:
- string
- 'null'
description: Traceback report for the last failed sync
use_blob_urls:
type: boolean
description: Generate blob URLs in tasks
verify_tls:
type: boolean
description: Verify TLS certificates
volume:
type: string
description: UC volume name
required:
- catalog
- host
- project
- schema
- volume
description: Serializer for Databricks import storage with multi-auth support.
title: DatabricksImportStorageRequest
import_storage_databricks_validate_Response_200:
type: object
properties: {}
description: Empty response body
title: import_storage_databricks_validate_Response_200
PatchedDatabricksImportStorageRequest:
type: object
properties:
auth_type:
$ref: '#/components/schemas/AuthTypeEnum'
description: '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'
catalog:
type: string
description: UC catalog name
client_id:
type: string
description: Service principal client/application ID (required for SP modes)
client_secret:
type: string
description: Service principal client secret (required for SP modes)
description:
type:
- string
- 'null'
description: Cloud storage description
host:
type: string
description: Databricks workspace base URL (https://...)
last_sync:
type:
- string
- 'null'
format: date-time
description: Last sync finished time
last_sync_count:
type:
- integer
- 'null'
description: Count of tasks synced last time
last_sync_job:
type:
- string
- 'null'
description: Last sync job ID
meta:
oneOf:
- description: Any type
- type: 'null'
description: Meta and debug information about storage processes
prefix:
type:
- string
- 'null'
description: Path under the volume
presign:
type: boolean
description: Presign not supported; always proxied
presign_ttl:
type: integer
description: Unused for Databricks; kept for compatibility
project:
type: integer
description: A unique integer value identifying this project.
recursive_scan:
type: boolean
description: Perform recursive scan
regex_filter:
type:
- string
- 'null'
description: Regex for filtering objects
request_timeout_s:
type: integer
schema:
type: string
description: UC schema name
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
type: integer
synchronizable:
type: boolean
default: true
tenant_id:
type: string
description: Azure AD tenant ID (required for Azure AD SP mode)
title:
type:
- string
- 'null'
description: Cloud storage title
token:
type: string
description: Databricks personal access token (required for PAT mode)
traceback:
type:
- string
- 'null'
description: Traceback report for the last failed sync
use_blob_urls:
type: boolean
description: Generate blob URLs in tasks
verify_tls:
type: boolean
description: Verify TLS certificates
volume:
type: string
description: UC volume name
description: Serializer for Databricks import storage with multi-auth support.
title: PatchedDatabricksImportStorageRequest
StatusC5aEnum:
type: string
enum:
- initialized
- queued
- in_progress
- failed
- completed
- completed_with_errors
description: '* `initialized` - Initialized
* `queued` - Queued
* `in_progress` - In progress
* `failed` - Failed
* `completed` - Completed
* `completed_with_errors` - Completed with errors'
title: StatusC5aEnum
securitySchemes:
Token:
type: apiKey
in: header
name: Authorization
description: '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>'