openapi: 3.2.0
info:
  title: Console Warehouse Connections API
  description: The "Console API" is the CRUD API for performing the actions offered on console.statsig.com without needing to go through the web UI.
  version: 20240601.0.0
  contact: {}
servers:
- url: https://statsigapi.net
tags:
- name: Warehouse Connections
paths:
  /console/v1/wh_connections:
    patch:
      summary: Update Warehouse Connection Parameters
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WhConnectionUpdateDto'
      responses:
        '200':
          description: Connection updated successfully
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                example:
                  message: Connection updated successfully
              example:
                message: Connection updated successfully
        '403':
          description: Insufficient permissions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    enum:
                    - 403
                  message:
                    type: string
                required:
                - status
                - message
              examples:
                Forbidden resource:
                  value:
                    status: 403
                    message: Forbidden. The request was valid, but the server is refusing action. You might not have the necessary permissions to access the resource.
      tags:
      - Warehouse Connections
      security:
      - STATSIG-API-KEY: []
      operationId: patchConsoleV1WhConnections
      x-operation-id-source: derived
components:
  schemas:
    WhConnectionUpdateDto:
      type: object
      properties:
        databricks:
          type: object
          properties:
            host:
              type: string
            path:
              type: string
            accessToken:
              type: string
            stagingDatabase:
              type: string
              description: Statsig will use this Database to save intermediate tables in the experimentation pipeline. Must be a database that the service user has write access to.
            oauthClientID:
              type:
              - string
              - 'null'
            consoleComputePath:
              type:
              - string
              - 'null'
              description: An optional separate path that Statsig will use to run interactive queries made from the Console.
        snowflake:
          type: object
          properties:
            accountName:
              type: string
            serviceUserName:
              type: string
            serviceUserPassword:
              type: string
            privateKey:
              type:
              - string
              - 'null'
            keyPassPhrase:
              type:
              - string
              - 'null'
            stagingDatabaseName:
              type: string
              description: The database containing the staging schema
            stagingSchemaName:
              type: string
              description: Statsig will use this Schema to save intermediate tables in the experimentation pipeline. Must be a schema that the service user has write access to.
            computeWarehouse:
              type: string
              description: The warehouse that Statsig will use to run queries. Must be a warehouse that the service user has access to.
            consoleComputeWarehouse:
              type:
              - string
              - 'null'
              description: An optional warehouse that Statsig will use to run interactive queries made from the Console.
        bigquery:
          type: object
          properties:
            privateKey:
              type: string
              description: Private key for a first-party service account to use for the BigQuery connection.
            project:
              type: string
              description: The project that Statsig will use to run queries.
            consoleComputeProject:
              type: string
              description: An optional project that Statsig will use to run interactive queries made from the Console.
            stagingDataset:
              type: string
              description: Statsig will use this dataset to save intermediate tables in the experimentation pipeline. Must be a dataset that the service user has write access to.
        redshift:
          type: object
          properties:
            host:
              type: string
              description: The name of the Redshift cluster.
            port:
              type: number
              description: The port of the Redshift cluster.
              format: double
            database:
              type: string
              description: The database of the Redshift cluster.
            username:
              type: string
              description: The username of the admin of the Redshift cluster.
            password:
              type: string
              description: The password of the admin.
            stagingSchema:
              type: string
              description: The schema to use for staging tables.
            useSshTunnel:
              type: boolean
            sshUsername:
              type: string
            sshPort:
              type: number
              format: double
            sshHost:
              type: string
            sshPrivateKey:
              type: string
            sshPublicKey:
              type: string
            verifyCA:
              type: boolean
              description: Whether to verify CA over SSL.
            useAssumeRole:
              type: boolean
              description: Whether to use an IAM role to connect to the Redshift cluster.
            roleArn:
              type: string
            region:
              type: string
              description: The AWS region of your Redshift cluster. Needed if using an IAM Role to connect.
        athena:
          type: object
          properties:
            region:
              type: string
              description: The AWS region of your resources.
            bucket:
              type: string
              description: The name of your S3 bucket.
            dataCatalog:
              type: string
              description: The name of your Athena Data Source/Catalog.
            useCatalogInQueryContext:
              type: boolean
              description: Whether to specify the Data Catalog when making calls to your Athena instance via the SDK. This can be helpful to avoid needing to specify the same catalog in SQL for all queries.
            database:
              type: string
              description: The name of the database to use for staging tables.
            queryResultLocation:
              type: string
              description: The S3 location for Athena query results.
            workgroup:
              type: string
              description: The name of the Athena Workgroup to use for query results.
            roleArn:
              type: string
  securitySchemes:
    STATSIG-API-KEY:
      type: apiKey
      name: STATSIG-API-KEY
      in: header