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

# Test warehouse connection

> Tests warehouse credentials without saving them. Reports each SSH tunnel hop and the database login separately so a broken bastion setup points at the step to fix.



## OpenAPI

````yaml https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json post /api/v1/projects/{projectUuid}/warehouse/test
openapi: 3.0.0
info:
  title: Lightdash API
  version: 2.167.4
  description: >
    Open API documentation for all public Lightdash API endpoints. #
    Authentication Before you get started, you might need to create a Personal
    Access Token to authenticate via the API. You can create a token by
    following this guide: https://docs.lightdash.com/references/personal_tokens
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
  - url: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/projects/{projectUuid}/warehouse/test:
    post:
      tags:
        - Projects
      summary: Test warehouse connection
      description: >-
        Tests warehouse credentials without saving them. Reports each SSH tunnel
        hop and the database login separately so a broken bastion setup points
        at the step to fix.
      operationId: testWarehouseConnection
      parameters:
        - in: path
          name: projectUuid
          required: true
          schema:
            $ref: '#/components/schemas/UUID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiWarehouseConnectionTestBody'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiWarehouseConnectionTestResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      security: []
components:
  schemas:
    UUID:
      type: string
      format: uuid
      description: |-
        Stringified UUIDv4.
        See [RFC 4112](https://tools.ietf.org/html/rfc4122)
      pattern: >-
        [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}
    ApiWarehouseConnectionTestBody:
      properties:
        warehouseConnection:
          $ref: '#/components/schemas/CreateWarehouseCredentials'
      required:
        - warehouseConnection
      type: object
    ApiWarehouseConnectionTestResponse:
      properties:
        results:
          $ref: '#/components/schemas/WarehouseConnectionTestResults'
        status:
          type: string
          enum:
            - ok
          nullable: false
      required:
        - results
        - status
      type: object
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
            - name
            - statusCode
          type: object
        status:
          type: string
          enum:
            - error
          nullable: false
      required:
        - error
        - status
      type: object
      description: |-
        The Error object is returned from the api any time there is an error.
        The message contains
    CreateWarehouseCredentials:
      anyOf:
        - $ref: '#/components/schemas/CreateRedshiftCredentials'
        - $ref: '#/components/schemas/CreateBigqueryCredentials'
        - $ref: '#/components/schemas/CreatePostgresCredentials'
        - $ref: '#/components/schemas/CreateSnowflakeCredentials'
        - $ref: '#/components/schemas/CreateDatabricksCredentials'
        - $ref: '#/components/schemas/CreateTrinoCredentials'
        - $ref: '#/components/schemas/CreateClickhouseCredentials'
        - $ref: '#/components/schemas/CreateAthenaCredentials'
        - $ref: '#/components/schemas/CreateDuckdbCredentials'
    WarehouseConnectionTestResults:
      properties:
        hops:
          items:
            $ref: '#/components/schemas/WarehouseConnectionHop'
          type: array
        ok:
          type: boolean
      required:
        - hops
        - ok
      type: object
    AnyType:
      description: |-
        This AnyType is an alias for any
        The goal is to make it easier to identify any type in the codebase
        without having to eslint-disable all the time
        These are only used on legacy `any` types, don't use it for new types.
        This is added on a separate file to avoid circular dependencies.
    CreateRedshiftCredentials:
      allOf:
        - $ref: '#/components/schemas/SshTunnelConfiguration'
        - properties:
            awsSsoRoleName:
              type: string
            awsSsoAccountId:
              type: string
            awsSsoRegion:
              type: string
            awsSsoStartUrl:
              type: string
            assumeRoleExternalId:
              type: string
            assumeRoleArn:
              type: string
            sessionToken:
              type: string
            secretAccessKey:
              type: string
            accessKeyId:
              type: string
            dbGroups:
              items:
                type: string
              type: array
            autoCreate:
              type: boolean
            workgroupName:
              type: string
            clusterIdentifier:
              type: string
            isServerless:
              type: boolean
            region:
              type: string
            authenticationType:
              $ref: '#/components/schemas/RedshiftAuthenticationType'
            timeoutSeconds:
              type: number
              format: double
            dataTimezone:
              type: string
            startOfWeek:
              allOf:
                - $ref: '#/components/schemas/WeekDay'
              nullable: true
            ra3Node:
              type: boolean
            sslmode:
              type: string
            keepalivesIdle:
              type: number
              format: double
            threads:
              type: number
              format: double
            schema:
              type: string
            dbname:
              type: string
            port:
              type: number
              format: double
            requireUserCredentials:
              type: boolean
            password:
              type: string
            user:
              type: string
            host:
              type: string
            type:
              $ref: '#/components/schemas/WarehouseTypes.REDSHIFT'
          required:
            - schema
            - dbname
            - port
            - user
            - host
            - type
          type: object
    CreateBigqueryCredentials:
      properties:
        accessUrl:
          type: string
        executionProject:
          type: string
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
            - $ref: '#/components/schemas/WeekDay'
          nullable: true
        maximumBytesBilled:
          type: number
          format: double
        location:
          type: string
        retries:
          type: number
          format: double
        requireUserCredentials:
          type: boolean
        keyfileContents:
          properties: {}
          additionalProperties:
            type: string
          type: object
        authenticationType:
          $ref: '#/components/schemas/BigqueryAuthenticationType'
        priority:
          type: string
          enum:
            - interactive
            - batch
        timeoutSeconds:
          type: number
          format: double
        threads:
          type: number
          format: double
        dataset:
          type: string
        project:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.BIGQUERY'
      required:
        - keyfileContents
        - dataset
        - project
        - type
      type: object
    CreatePostgresCredentials:
      allOf:
        - $ref: '#/components/schemas/SshTunnelConfiguration'
        - $ref: '#/components/schemas/SslConfiguration'
        - properties:
            timeoutSeconds:
              type: number
              format: double
            dataTimezone:
              type: string
            startOfWeek:
              allOf:
                - $ref: '#/components/schemas/WeekDay'
              nullable: true
            role:
              type: string
            searchPath:
              type: string
            keepalivesIdle:
              type: number
              format: double
            threads:
              type: number
              format: double
            schema:
              type: string
            dbname:
              type: string
            port:
              type: number
              format: double
            requireUserCredentials:
              type: boolean
            password:
              type: string
            user:
              type: string
            host:
              type: string
            type:
              $ref: '#/components/schemas/WarehouseTypes.POSTGRES'
          required:
            - schema
            - dbname
            - port
            - password
            - user
            - host
            - type
          type: object
    CreateSnowflakeCredentials:
      properties:
        organizationWarehouseCredentialsUuid:
          type: string
        override:
          type: boolean
        timeoutSeconds:
          type: number
          format: double
        disableTimestampConversion:
          type: boolean
        quotedIdentifiersIgnoreCase:
          type: boolean
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
            - $ref: '#/components/schemas/WeekDay'
          nullable: true
        accessUrl:
          type: string
        queryTag:
          type: string
        clientSessionKeepAlive:
          type: boolean
        threads:
          type: number
          format: double
        schema:
          type: string
        warehouse:
          type: string
        database:
          type: string
        role:
          type: string
        token:
          type: string
        refreshToken:
          type: string
        authenticationType:
          $ref: '#/components/schemas/SnowflakeAuthenticationType'
        privateKeyPass:
          type: string
        privateKey:
          type: string
        requireUserCredentials:
          type: boolean
        password:
          type: string
        user:
          type: string
        account:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.SNOWFLAKE'
      required:
        - schema
        - warehouse
        - database
        - user
        - account
        - type
      type: object
    CreateDatabricksCredentials:
      properties:
        compute:
          items:
            properties:
              httpPath:
                type: string
              name:
                type: string
            required:
              - httpPath
              - name
            type: object
          type: array
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
            - $ref: '#/components/schemas/WeekDay'
          nullable: true
        requireUserCredentials:
          type: boolean
        oauthClientSecret:
          type: string
        oauthClientId:
          type: string
        token:
          type: string
        refreshToken:
          type: string
        personalAccessToken:
          type: string
        authenticationType:
          $ref: '#/components/schemas/DatabricksAuthenticationType'
        httpPath:
          type: string
        serverHostName:
          type: string
        database:
          type: string
        catalog:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.DATABRICKS'
      required:
        - httpPath
        - serverHostName
        - database
        - type
      type: object
    CreateTrinoCredentials:
      properties:
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
            - $ref: '#/components/schemas/WeekDay'
          nullable: true
        source:
          type: string
        http_scheme:
          type: string
        schema:
          type: string
        dbname:
          type: string
        port:
          type: number
          format: double
        requireUserCredentials:
          type: boolean
        password:
          type: string
        user:
          type: string
        host:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.TRINO'
      required:
        - http_scheme
        - schema
        - dbname
        - port
        - password
        - user
        - host
        - type
      type: object
    CreateClickhouseCredentials:
      properties:
        timeoutSeconds:
          type: number
          format: double
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
            - $ref: '#/components/schemas/WeekDay'
          nullable: true
        secure:
          type: boolean
        schema:
          type: string
        port:
          type: number
          format: double
        requireUserCredentials:
          type: boolean
        password:
          type: string
        user:
          type: string
        host:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.CLICKHOUSE'
      required:
        - schema
        - port
        - password
        - user
        - host
        - type
      type: object
    CreateAthenaCredentials:
      properties:
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
            - $ref: '#/components/schemas/WeekDay'
          nullable: true
        requireUserCredentials:
          type: boolean
        numRetries:
          type: number
          format: double
        threads:
          type: number
          format: double
        workGroup:
          type: string
        assumeRoleExternalId:
          type: string
        assumeRoleArn:
          type: string
        sessionToken:
          type: string
        secretAccessKey:
          type: string
        accessKeyId:
          type: string
        authenticationType:
          $ref: '#/components/schemas/AthenaAuthenticationType'
        s3DataDir:
          type: string
        s3StagingDir:
          type: string
        schema:
          type: string
        database:
          type: string
        region:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.ATHENA'
      required:
        - s3StagingDir
        - schema
        - database
        - region
        - type
      type: object
    CreateDuckdbCredentials:
      anyOf:
        - $ref: '#/components/schemas/CreateDuckdbMotherduckCredentials'
        - $ref: '#/components/schemas/CreateDuckdbDucklakeCredentials'
        - $ref: '#/components/schemas/CreateDuckdbEmbeddedCredentials'
    WarehouseConnectionHop:
      properties:
        message:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/WarehouseConnectionHopStatus'
        stage:
          $ref: '#/components/schemas/WarehouseConnectionHopStage'
      required:
        - message
        - status
        - stage
      type: object
    SshTunnelConfiguration:
      properties:
        sshTunnelPrivateKey:
          type: string
        sshTunnelPublicKey:
          type: string
        sshTunnelUser:
          type: string
        sshTunnelPort:
          type: number
          format: double
        sshTunnelHost:
          type: string
        useSshTunnel:
          type: boolean
      type: object
    RedshiftAuthenticationType:
      enum:
        - password
        - iam
        - iam_browser
      type: string
    WeekDay:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
      type: number
    WarehouseTypes.REDSHIFT:
      enum:
        - redshift
      type: string
    BigqueryAuthenticationType:
      enum:
        - sso
        - private_key
        - adc
      type: string
    WarehouseTypes.BIGQUERY:
      enum:
        - bigquery
      type: string
    SslConfiguration:
      properties:
        sslrootcert:
          type: string
          nullable: true
        sslrootcertFileName:
          type: string
        sslkey:
          type: string
          nullable: true
        sslkeyFileName:
          type: string
        sslcert:
          type: string
          nullable: true
        sslcertFileName:
          type: string
        sslmode:
          type: string
      type: object
    WarehouseTypes.POSTGRES:
      enum:
        - postgres
      type: string
    SnowflakeAuthenticationType:
      enum:
        - password
        - private_key
        - sso
        - external_browser
        - oauth_authorization_code
        - none
      type: string
    WarehouseTypes.SNOWFLAKE:
      enum:
        - snowflake
      type: string
    DatabricksAuthenticationType:
      enum:
        - personal_access_token
        - oauth_m2m
        - oauth_u2m
      type: string
    WarehouseTypes.DATABRICKS:
      enum:
        - databricks
      type: string
    WarehouseTypes.TRINO:
      enum:
        - trino
      type: string
    WarehouseTypes.CLICKHOUSE:
      enum:
        - clickhouse
      type: string
    AthenaAuthenticationType:
      enum:
        - access_key
        - iam_role
      type: string
    WarehouseTypes.ATHENA:
      enum:
        - athena
      type: string
    CreateDuckdbMotherduckCredentials:
      properties:
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
            - $ref: '#/components/schemas/WeekDay'
          nullable: true
        requireUserCredentials:
          type: boolean
        threads:
          type: number
          format: double
        token:
          type: string
        schema:
          type: string
        database:
          type: string
        connectionType:
          $ref: '#/components/schemas/DuckdbConnectionType.MOTHERDUCK'
        type:
          $ref: '#/components/schemas/WarehouseTypes.DUCKDB'
      required:
        - token
        - schema
        - database
        - connectionType
        - type
      type: object
    CreateDuckdbDucklakeCredentials:
      properties:
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
            - $ref: '#/components/schemas/WeekDay'
          nullable: true
        requireUserCredentials:
          type: boolean
        threads:
          type: number
          format: double
        catalogAlias:
          type: string
        schema:
          type: string
        dataPath:
          $ref: '#/components/schemas/CreateDucklakeDataPath'
        catalog:
          $ref: '#/components/schemas/CreateDucklakeCatalog'
        connectionType:
          $ref: '#/components/schemas/DuckdbConnectionType.DUCKLAKE'
        type:
          $ref: '#/components/schemas/WarehouseTypes.DUCKDB'
      required:
        - schema
        - dataPath
        - catalog
        - connectionType
        - type
      type: object
    CreateDuckdbEmbeddedCredentials:
      properties:
        schema:
          type: string
        startOfWeek:
          type: number
          format: double
        dataTimezone:
          type: string
        requireUserCredentials:
          type: boolean
        dataset:
          type: string
        connectionType:
          $ref: '#/components/schemas/DuckdbConnectionType.EMBEDDED'
        type:
          $ref: '#/components/schemas/WarehouseTypes.DUCKDB'
      required:
        - dataset
        - connectionType
        - type
      type: object
    WarehouseConnectionHopStatus:
      type: string
      enum:
        - ok
        - failed
        - skipped
    WarehouseConnectionHopStage:
      anyOf:
        - $ref: '#/components/schemas/SshTunnelStage'
        - type: string
          enum:
            - database
    DuckdbConnectionType.MOTHERDUCK:
      enum:
        - motherduck
      type: string
    WarehouseTypes.DUCKDB:
      enum:
        - duckdb
      type: string
    CreateDucklakeDataPath:
      anyOf:
        - $ref: '#/components/schemas/CreateDucklakeDataPathS3'
        - $ref: '#/components/schemas/CreateDucklakeDataPathGcs'
        - $ref: '#/components/schemas/CreateDucklakeDataPathAzure'
        - $ref: '#/components/schemas/CreateDucklakeDataPathLocal'
    CreateDucklakeCatalog:
      anyOf:
        - $ref: '#/components/schemas/CreateDucklakeCatalogPostgres'
        - $ref: '#/components/schemas/CreateDucklakeCatalogSqlite'
        - $ref: '#/components/schemas/CreateDucklakeCatalogDuckdb'
    DuckdbConnectionType.DUCKLAKE:
      enum:
        - ducklake
      type: string
    DuckdbConnectionType.EMBEDDED:
      enum:
        - embedded
      type: string
    SshTunnelStage:
      type: string
      enum:
        - resolve
        - tcp
        - handshake
        - auth
        - forward
    CreateDucklakeDataPathS3:
      properties:
        useSsl:
          type: boolean
        forcePathStyle:
          type: boolean
        secretAccessKey:
          type: string
        accessKeyId:
          type: string
        region:
          type: string
        endpoint:
          type: string
        url:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.S3'
      required:
        - url
        - type
      type: object
    CreateDucklakeDataPathGcs:
      properties:
        hmacSecret:
          type: string
        hmacKeyId:
          type: string
        url:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.GCS'
      required:
        - url
        - type
      type: object
    CreateDucklakeDataPathAzure:
      properties:
        accountKey:
          type: string
        accountName:
          type: string
        connectionString:
          type: string
        url:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.AZURE'
      required:
        - url
        - type
      type: object
    CreateDucklakeDataPathLocal:
      properties:
        path:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.LOCAL'
      required:
        - path
        - type
      type: object
    CreateDucklakeCatalogPostgres:
      properties:
        password:
          type: string
        user:
          type: string
        database:
          type: string
        port:
          type: number
          format: double
        host:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeCatalogType.POSTGRES'
      required:
        - password
        - user
        - database
        - port
        - host
        - type
      type: object
    CreateDucklakeCatalogSqlite:
      properties:
        path:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeCatalogType.SQLITE'
      required:
        - path
        - type
      type: object
    CreateDucklakeCatalogDuckdb:
      properties:
        path:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeCatalogType.DUCKDB'
      required:
        - path
        - type
      type: object
    DucklakeDataPathType.S3:
      enum:
        - s3
      type: string
    DucklakeDataPathType.GCS:
      enum:
        - gcs
      type: string
    DucklakeDataPathType.AZURE:
      enum:
        - azure
      type: string
    DucklakeDataPathType.LOCAL:
      enum:
        - local
      type: string
    DucklakeCatalogType.POSTGRES:
      enum:
        - postgres
      type: string
    DucklakeCatalogType.SQLITE:
      enum:
        - sqlite
      type: string
    DucklakeCatalogType.DUCKDB:
      enum:
        - duckdb
      type: string

````