> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.select.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Test a Databricks connection configuration

> Run every check against a proposed configuration, persisting nothing.



## OpenAPI

````yaml https://api.select.dev/v2/openapi.json post /databricks-connections/actions/test
openapi: 3.1.0
info:
  title: SELECT API (v2)
  version: 0.1.0
servers:
  - url: https://api.select.dev/v2
    description: SELECT API v2
security: []
paths:
  /databricks-connections/actions/test:
    post:
      tags:
        - databricks-connections
      summary: Test a Databricks connection configuration
      description: Run every check against a proposed configuration, persisting nothing.
      operationId: >-
        test_databricks_connection_config_route_databricks_connections_actions_test_post
      parameters:
        - name: x-tenant-id
          in: header
          required: true
          schema:
            type: string
            description: The organization ID the request is scoped to.
            title: X-Tenant-Id
          description: The organization ID the request is scoped to.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabricksConnectionCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabricksConnectionValidationReport'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '408':
          $ref: '#/components/responses/RequestTimeout'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - HTTPBearer: []
components:
  schemas:
    DatabricksConnectionCreate:
      properties:
        name:
          type: string
          title: Name
          description: Display name for the connection, as shown throughout SELECT.
        databricks_account_id:
          type: string
          pattern: ^[a-zA-Z0-9\-]+$
          title: Databricks Account Id
          description: >-
            The Databricks account to read usage and spend for. Letters, digits
            and hyphens only.
        primary_workspace_url:
          type: string
          title: Primary Workspace Url
          description: >-
            URL of the workspace to connect through, including the scheme — for
            example `https://my-workspace.cloud.databricks.com`. It must be in
            the region whose usage this connection should cover.
        warehouse_id:
          type: string
          pattern: ^[a-zA-Z0-9\-]+$
          title: Warehouse Id
          description: >-
            The SQL warehouse in that workspace to run queries on. Letters,
            digits and hyphens only.
        credentials:
          $ref: '#/components/schemas/DatabricksCredentials'
          description: >-
            The service principal SELECT authenticates as. Validated against
            Databricks before the connection is added.
        sync_enabled:
          type: boolean
          title: Sync Enabled
          description: Whether SELECT starts syncing data for this connection.
          default: true
        query_sanitization_enabled:
          type: boolean
          title: Query Sanitization Enabled
          description: Whether query text is sanitized before SELECT stores it.
          default: false
      type: object
      required:
        - name
        - databricks_account_id
        - primary_workspace_url
        - warehouse_id
        - credentials
      title: DatabricksConnectionCreate
      description: A Databricks connection to add.
    DatabricksConnectionValidationReport:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether every applicable check passed.
        checks:
          items:
            $ref: '#/components/schemas/DatabricksConnectionValidationCheck'
          type: array
          title: Checks
          description: >-
            The checks that ran, in the order they ran. Read top-down to find
            where setup stopped working.
      type: object
      required:
        - success
        - checks
      title: DatabricksConnectionValidationReport
      description: >-
        The result of validating a connection's configuration against
        Databricks.
    DatabricksCredentials:
      properties:
        client_id:
          type: string
          minLength: 1
          title: Client Id
          description: Client ID of the service principal SELECT authenticates as.
        client_secret:
          type: string
          minLength: 1
          title: Client Secret
          description: An OAuth secret generated for that service principal.
          writeOnly: true
          x-doit-confidentiality: sensitive
          x-terraform-sensitive: true
      type: object
      required:
        - client_id
        - client_secret
      title: DatabricksCredentials
      description: >-
        How SELECT authenticates to a Databricks account.


        An OAuth machine-to-machine service principal. Grant it access to the

        workspace's SQL warehouse and read access to the account's system
        tables;

        SELECT reads nothing else.
    DatabricksConnectionValidationCheck:
      properties:
        id:
          type: string
          enum:
            - connectivity
            - workspace_discovery
            - system_table_access
            - query_text_access
            - metastore
          title: Id
          description: Identifies which check this is.
        label:
          type: string
          title: Label
          description: Short human-readable name for the check.
        status:
          type: string
          enum:
            - passed
            - failed
            - skipped
          title: Status
          description: >-
            `passed`, `failed`, or `skipped`. A check is skipped only when an
            earlier check already failed and stopped the run.
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: >-
            What to change when the check failed, or why it was skipped. Null
            when the check passed with nothing worth noting.
        docs_link:
          anyOf:
            - type: string
            - type: 'null'
          title: Docs Link
          description: >-
            Link to the setup documentation covering what the check found. Null
            when no page addresses it specifically.
      type: object
      required:
        - id
        - label
        - status
      title: DatabricksConnectionValidationCheck
      description: One check SELECT runs against a connection's configuration.
    ProblemDetail:
      additionalProperties: true
      description: >-
        RFC 9457-style error payload, served as ``application/problem+json``.


        ``code`` is the stable, machine-readable identifier — consumers branch
        on it,

        never on ``title``. ``type`` stays ``about:blank``: we keep no per-error

        documentation pages. There is no ``instance``/request-id member (we
        don't run

        access logs). See the flat error-code catalogue in §4 of the standards
        doc.
      properties:
        type:
          default: about:blank
          title: Type
          type: string
        title:
          type: string
          title: Title
        status:
          title: Status
          type: integer
        detail:
          title: Detail
          type: string
        code:
          title: Code
          type: string
        retryable:
          title: Retryable
          type: boolean
        details:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          default: null
          title: Details
      required:
        - title
        - status
        - detail
        - code
        - retryable
      title: ProblemDetail
      type: object
  responses:
    BadRequest:
      description: Bad request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
      headers:
        WWW-Authenticate:
          description: Authentication challenge for the requested resource.
          required: true
          schema:
            type: string
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    NotFound:
      description: Not found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    MethodNotAllowed:
      description: Method not allowed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
      headers:
        Allow:
          description: HTTP methods supported by the requested resource.
          required: true
          schema:
            type: string
    RequestTimeout:
      description: Request Timeout
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    Conflict:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    ValidationFailed:
      description: Validation failed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    RateLimited:
      description: Rate limited
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request.
          required: true
          schema:
            type: integer
            minimum: 0
    InternalError:
      description: Internal error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    ServiceUnavailable:
      description: Service unavailable
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request.
          required: true
          schema:
            type: integer
            minimum: 0
  securitySchemes:
    HTTPBearer:
      type: http
      description: Organization API key (sl_…).
      scheme: bearer

````