openapi: 3.2.0
info:
  description: 'Requirements:

    - Create your access token through the UI

    - Get your tenant name: if you access to Sifflet with `https://abcdef.siffletdata.com`, then your tenant would be `abcdef`'
  title: Sifflet Backend Sources (deprecated) API
  version: 1.0.0
servers:
- url: https://{tenant}.siffletdata.com/api
  description: Production tenant
  variables:
    tenant:
      description: if you access to Sifflet with `https://abcdef.siffletdata.com`, then your tenant would be `abcdef`
      default: publicdemo
- url: http://localhost:8090
  description: Dev server started in intellij
- url: http://localhost:8091
  description: Dev server started in docker compose
- url: http://localhost:8099
  description: Dev server started with api recorder
tags:
- name: Sources (deprecated)
paths:
  /v1/sources:
    post:
      deprecated: true
      description: This endpoint is deprecated and will be removed soon. Please use the Sources V2 endpoint instead - POST /api/v2/sources.
      operationId: publicCreateSource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCreateSourceDto'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicGetSourceDto'
          description: Source created
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Bad request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Create a source
      tags:
      - Sources (deprecated)
  /v1/sources/search:
    post:
      deprecated: true
      description: This endpoint is deprecated and will be removed soon. Please use the Sources V2 endpoint instead - GET /api/v2/sources.
      operationId: publicGetSources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicSourceSearchCriteriaDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPageDtoPublicGetSourceDto'
          description: Sources retrieved
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Bad request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Get search results for sources
      tags:
      - Sources (deprecated)
  /v1/sources/test-connection:
    post:
      deprecated: true
      description: This endpoint is deprecated and will be removed soon. Please use the Sources V2 endpoint instead
      operationId: testSourceConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCreateSourceDto'
        required: true
      responses:
        '204':
          description: Connection test result
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Bad request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Test connection with given source params
      tags:
      - Sources (deprecated)
  /v1/sources/{id}:
    delete:
      deprecated: true
      description: This endpoint is deprecated and will be removed soon. Please use the Sources V2 endpoint instead - DELETE /api/v2/sources/{id}.
      operationId: publicDeleteSourceById
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Source deleted
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Delete a source by id
      tags:
      - Sources (deprecated)
    get:
      deprecated: true
      description: This endpoint is deprecated and will be removed soon. Please use one of the Sources V2 endpoints instead - GET /api/v2/sources/ or GET /api/v2/sources/{id}.
      operationId: publicGetSource
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicGetSourceDto'
          description: Source retrieved
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Get a source by id
      tags:
      - Sources (deprecated)
    patch:
      deprecated: true
      description: This endpoint is deprecated and will be removed soon. Please use the Sources V2 endpoint instead - PATCH /api/v2/sources/{id}.
      operationId: publicEditSource
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicUpdateSourceDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicGetSourceDto'
          description: Source edited
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Bad request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Edit a source
      tags:
      - Sources (deprecated)
  /v1/sources/{id}/run:
    post:
      deprecated: true
      description: This endpoint is deprecated and will be removed soon. Please use the Sources V2 endpoint instead - POST /api/v2/sources/run-subsource.
      operationId: publicSourceIngestionManualRun
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Job triggered
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Manually trigger a source metadata ingestion job
      tags:
      - Sources (deprecated)
components:
  schemas:
    PublicTagReferenceDto:
      type: object
      properties:
        id:
          type: string
          description: Id of the referenced object
          format: uuid
        kind:
          type: string
          description: Type of the referenced tag
          enum:
          - TAG
          - CLASSIFICATION
        name:
          type: string
          description: Name of the referenced object
      description: Tags of the source. A tag can either be referenced by its id or its name or its name and kind.
      example:
      - id: 02a15477-1e58-490e-aa5c-1c7388fcb136
        name: PII
        kind: CLASSIFICATION
      - name: tag-name
      - name: PII
        kind: CLASSIFICATION
    ApiProblemSchema:
      type: object
      properties:
        detail:
          type: string
        response:
          type: string
        status:
          type: integer
          format: int32
        title:
          type: string
        type:
          type: string
    PublicSourceParametersDto:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          enum:
          - ATHENA
          - BIGQUERY
          - REDSHIFT
          - SNOWFLAKE
          - DATABRICKS
          - MSSQL
          - MYSQL
          - POSTGRESQL
          - ORACLE
          - SYNAPSE
          - LOOKER
          - TABLEAU
          - QUICKSIGHT
          - AIRFLOW
          - DBT
          - DBT_CLOUD
          - FIVETRAN
          - POWER_BI
          - DECLARATIVE
          - _UNKNOWN_
      description: Parameters of the source
      discriminator:
        mapping:
          AIRFLOW: '#/components/schemas/PublicAirflowParametersDto'
          ATHENA: '#/components/schemas/PublicAthenaParametersDto'
          BIGQUERY: '#/components/schemas/PublicBigQueryParametersDto'
          DATABRICKS: '#/components/schemas/PublicDatabricksParametersDto'
          DBT: '#/components/schemas/PublicDbtParametersDto'
          DBT_CLOUD: '#/components/schemas/PublicDbtCloudParametersDto'
          DECLARATIVE: '#/components/schemas/PublicDeclarativeParametersDto'
          FIVETRAN: '#/components/schemas/PublicFivetranParametersDto'
          LOOKER: '#/components/schemas/PublicLookerParametersDto'
          MSSQL: '#/components/schemas/PublicMssqlParametersDto'
          MYSQL: '#/components/schemas/PublicMysqlParametersDto'
          ORACLE: '#/components/schemas/PublicOracleParametersDto'
          POSTGRESQL: '#/components/schemas/PublicPostgresqlParametersDto'
          POWER_BI: '#/components/schemas/PublicPowerBiParametersDto'
          QUICKSIGHT: '#/components/schemas/PublicQuicksightParametersDto'
          REDSHIFT: '#/components/schemas/PublicRedshiftParametersDto'
          SNOWFLAKE: '#/components/schemas/PublicSnowflakeParametersDto'
          SYNAPSE: '#/components/schemas/PublicSynapseParametersDto'
          TABLEAU: '#/components/schemas/PublicTableauParametersDto'
        propertyName: type
    PublicSnowflakeParametersDto:
      required:
      - accountIdentifier
      - database
      - schema
      - type
      - warehouse
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          accountIdentifier:
            type: string
            description: Your Snowflake account identifier
            example: my_account_identifier
          database:
            type: string
            description: Your database name
            example: my_database
          schema:
            type: string
            description: Your schema name
            example: public
          warehouse:
            type: string
            description: Your Snowflake warehouse
            example: my_warehouse
    PublicAthenaParametersDto:
      required:
      - database
      - datasource
      - region
      - roleArn
      - s3OutputLocation
      - type
      - workgroup
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          database:
            type: string
            description: Your Athena database name
            example: my_database
          datasource:
            type: string
            description: Your Athena data source name
            example: AwsDataCatalog
          region:
            type: string
            description: Your Athena instance AWS region
            example: us-east-1
          roleArn:
            type: string
            description: ARN of the IAM role to use for Athena queries
            example: arn:aws:iam::123456789101:role/sifflet_athena_read_role
          s3OutputLocation:
            type: string
            description: The S3 location where Athena query results are stored
            example: s3://my-athena-bucket/
          vpcUrl:
            type: string
            description: Your VPC URL for Athena connection
          workgroup:
            type: string
            description: Your Athena workgroup name
            example: primary
    PublicDbtParametersDto:
      required:
      - projectName
      - target
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          projectName:
            type: string
            description: Your dbt project name (the 'name' value in your dbt_project.yml file)
            example: my_project
          target:
            type: string
            description: Your dbt target name (the 'target' value in your profiles.yml file)
            example: dev
    PublicPowerBiParametersDto:
      required:
      - clientId
      - tenantId
      - type
      - workspaceId
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          clientId:
            type: string
            description: Your Azure AD client ID
            example: 12345678-1234-1234-1234-123456789012
          tenantId:
            type: string
            description: Your Azure AD tenant ID
            example: 12345678-1234-1234-1234-123456789012
          workspaceId:
            type: string
            description: Your Power BI workspace ID
            example: 12345678-1234-1234-1234-123456789012
    PublicTableauParametersDto:
      required:
      - host
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          host:
            type: string
            description: Your Tableau Server hostname
            example: https://dub01.online.tableau.com
          site:
            type: string
            description: Your Tableau Server site. Leave empty if your Tableau environment is using the Default Site.
            example: my_site
    PublicQuicksightParametersDto:
      required:
      - accountId
      - awsRegion
      - roleArn
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          accountId:
            type: string
            description: Your AWS account ID
            example: '123456789101'
          awsRegion:
            type: string
            description: Your AWS region
            example: us-east-1
          roleArn:
            type: string
            description: The ARN for your QuickSight role
            example: arn:aws:iam::123456789101:role/sifflet_quicksight_read_role
    PublicMssqlParametersDto:
      required:
      - database
      - host
      - port
      - schema
      - ssl
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          database:
            type: string
            description: Your database name
            example: my_database
          host:
            type: string
            description: Your MSSQL server hostname
            example: my-mssql-server.com
          port:
            type: integer
            description: Your MSSQL server port
            format: int32
            example: 1433
          schema:
            type: string
            description: Your schema name
            example: public
          ssl:
            type: boolean
            description: 'Whether to use SSL to connect to your MSSQL server (recommended: true)'
    PublicBigQueryParametersDto:
      required:
      - datasetId
      - projectId
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          billingProjectId:
            type: string
            description: Your billing project ID
            example: gcp-billing-project-id
          datasetId:
            type: string
            description: Your BigQuery dataset ID
            example: dataset-id
          projectId:
            type: string
            description: Your BigQuery project ID
            example: gcp-project-id
          workerProjectIds:
            type: string
            description: Comma separated list of project ids where your queries run. Optional if it's the same as the projectId parameter
            example: gcp-worker-project-id-1,gcp-worker-project-id-2
    PublicDatabricksParametersDto:
      required:
      - catalog
      - host
      - httpPath
      - port
      - schema
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          catalog:
            type: string
            description: Your Databricks catalog
            example: main
          host:
            type: string
            description: Your Databricks server hostname
            example: abc-123ab1234-abc1.cloud.databricks.com
          httpPath:
            type: string
            description: Your Databricks HTTP path
            example: /sql/1.0/warehouses/0123456789
          port:
            type: integer
            description: Your Databricks server port
            format: int32
            example: 443
          schema:
            type: string
            description: Your Databricks schema
            example: default
    PublicSourcePaginationDto:
      type: object
      properties:
        itemsPerPage:
          type: integer
          description: Default value returns all items.
          format: int32
          default: -1
        page:
          type: integer
          format: int32
          default: 0
      description: Pagination to apply on the sources search
    GitConnection:
      required:
      - authType
      - secretId
      - url
      type: object
      properties:
        authType:
          type: string
          enum:
          - HTTP_AUTHORIZATION_HEADER
          - USER_PASSWORD
          - SSH
        branch:
          type: string
        secretId:
          type: string
        url:
          type: string
      description: 'The LookML configuration. See https://docs.siffletdata.com/docs/looker.

        If you don’t use LookML or omit this field, it will default to an empty list.

        '
    PublicPostgresqlParametersDto:
      required:
      - database
      - host
      - port
      - schema
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          database:
            type: string
            description: Your database name
            example: my_database
          host:
            type: string
            description: Your PostgreSQL server host
            example: my-postgresql-server.com
          port:
            type: integer
            description: Your PostgreSQL server port
            format: int32
            example: 5432
          schema:
            type: string
            description: Your schema name
            example: public
    PublicSourceSearchCriteriaDto:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/PublicSourceFilterDto'
        pagination:
          $ref: '#/components/schemas/PublicSourcePaginationDto'
        sort:
          type: array
          description: Sort to apply on the sources search
          example:
          - direction: ASC
            field: name
          items:
            type: string
            description: The resource field on which to apply the sort followed by the direction
            format: property,ASC|DESC
            example: name,ASC
    PublicUpdateSourceDto:
      type: object
      properties:
        credentials:
          type: string
          description: Credentials of the source. Required for all sources type except 'ATHENA', 'DBT', 'QUICKSIGHT'.
        description:
          type: string
          description: Description of the source
        name:
          type: string
          description: Name of the source
        parameters:
          oneOf:
          - $ref: '#/components/schemas/PublicAirflowParametersDto'
          - $ref: '#/components/schemas/PublicAthenaParametersDto'
          - $ref: '#/components/schemas/PublicBigQueryParametersDto'
          - $ref: '#/components/schemas/PublicDatabricksParametersDto'
          - $ref: '#/components/schemas/PublicDbtCloudParametersDto'
          - $ref: '#/components/schemas/PublicDbtParametersDto'
          - $ref: '#/components/schemas/PublicDeclarativeParametersDto'
          - $ref: '#/components/schemas/PublicFivetranParametersDto'
          - $ref: '#/components/schemas/PublicLookerParametersDto'
          - $ref: '#/components/schemas/PublicMssqlParametersDto'
          - $ref: '#/components/schemas/PublicMysqlParametersDto'
          - $ref: '#/components/schemas/PublicOracleParametersDto'
          - $ref: '#/components/schemas/PublicPostgresqlParametersDto'
          - $ref: '#/components/schemas/PublicPowerBiParametersDto'
          - $ref: '#/components/schemas/PublicQuicksightParametersDto'
          - $ref: '#/components/schemas/PublicRedshiftParametersDto'
          - $ref: '#/components/schemas/PublicSnowflakeParametersDto'
          - $ref: '#/components/schemas/PublicSynapseParametersDto'
          - $ref: '#/components/schemas/PublicTableauParametersDto'
        schedule:
          type: string
          description: Schedule of the source. Supports CRON syntax. If empty, the source won't be scheduled.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/PublicTagReferenceDto'
        timezone:
          type: string
          description: A string representing a timezone identifier (e.g. 'UTC' or 'Europe/Paris')
          example: UTC
          default: UTC
    PublicPageDtoPublicGetSourceDto:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicGetSourceDto'
        totalCount:
          type: integer
          format: int64
    PublicGetLastRunDto:
      type: object
      properties:
        status:
          type: string
          description: Last run status of the source
          enum:
          - PENDING
          - RUNNING
          - SUCCESS
          - FAILURE
          - SKIPPED_DATASOURCE_ALREADY_RUNNING
          - SKIPPED_DATASOURCE_DEACTIVATED
        timestamp:
          type: string
          description: Timestamp of the last update of the source
          format: date-time
      description: Information about the last run of the source
    PublicOracleParametersDto:
      required:
      - database
      - host
      - port
      - schema
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          database:
            type: string
            description: Your database name
            example: my_dergatabase
          host:
            type: string
            description: Your Oracle server hostname
            example: my-oracle-server.com
          port:
            type: integer
            description: Your Oracle server port
            format: int32
            example: 1521
          schema:
            type: string
            description: Your schema name
            example: default
    PublicAirflowParametersDto:
      required:
      - host
      - port
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          host:
            type: string
            description: Your Airflow server hostname
            example: airflow.example.com
          port:
            type: integer
            description: Your Airflow server port
            format: int32
            example: 8080
    PublicDeclarativeParametersDto:
      required:
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
    PublicCreateSourceDto:
      required:
      - name
      - parameters
      type: object
      properties:
        credentials:
          type: string
          description: Credentials of the source. Required for all sources type except 'ATHENA', 'DBT', 'QUICKSIGHT'.
        description:
          type: string
          description: Description of the source
        name:
          type: string
          description: Name of the source
        parameters:
          oneOf:
          - $ref: '#/components/schemas/PublicAirflowParametersDto'
          - $ref: '#/components/schemas/PublicAthenaParametersDto'
          - $ref: '#/components/schemas/PublicBigQueryParametersDto'
          - $ref: '#/components/schemas/PublicDatabricksParametersDto'
          - $ref: '#/components/schemas/PublicDbtCloudParametersDto'
          - $ref: '#/components/schemas/PublicDbtParametersDto'
          - $ref: '#/components/schemas/PublicDeclarativeParametersDto'
          - $ref: '#/components/schemas/PublicFivetranParametersDto'
          - $ref: '#/components/schemas/PublicLookerParametersDto'
          - $ref: '#/components/schemas/PublicMssqlParametersDto'
          - $ref: '#/components/schemas/PublicMysqlParametersDto'
          - $ref: '#/components/schemas/PublicOracleParametersDto'
          - $ref: '#/components/schemas/PublicPostgresqlParametersDto'
          - $ref: '#/components/schemas/PublicPowerBiParametersDto'
          - $ref: '#/components/schemas/PublicQuicksightParametersDto'
          - $ref: '#/components/schemas/PublicRedshiftParametersDto'
          - $ref: '#/components/schemas/PublicSnowflakeParametersDto'
          - $ref: '#/components/schemas/PublicSynapseParametersDto'
          - $ref: '#/components/schemas/PublicTableauParametersDto'
        schedule:
          type: string
          description: Schedule of the source. Supports CRON syntax. If empty, the source won't be scheduled.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/PublicTagReferenceDto'
        timezone:
          type: string
          description: A string representing a timezone identifier (e.g. 'UTC' or 'Europe/Paris')
          example: UTC
          default: UTC
    PublicSynapseParametersDto:
      required:
      - database
      - host
      - port
      - schema
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          database:
            type: string
            description: Your database name
            example: my_database
          host:
            type: string
            description: The host of your Synapse server
            example: synapse-company.sql.azuresynapse.net
          port:
            type: integer
            description: Your Synapse server port
            format: int32
            example: 1433
          schema:
            type: string
            description: Your schema name
            example: public
    PublicFivetranParametersDto:
      required:
      - host
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          host:
            type: string
            description: Your Fivetran environment URL
            example: https://api.fivetran.com
    PublicDbtCloudParametersDto:
      required:
      - accountId
      - baseUrl
      - projectId
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          accountId:
            type: string
            description: Your dbt Cloud account ID
            example: '12345'
          baseUrl:
            type: string
            description: Your dbt Cloud base URL
            example: https://cloud.getdbt.com/api/v2
          jobDefinitionId:
            type: string
            description: Your dbt Cloud job ID
            example: '223344'
          projectId:
            type: string
            description: Your dbt Cloud project ID
            example: '67890'
    PublicSourceFilterDto:
      type: object
      properties:
        tags:
          type: array
          description: List of tags to filter on
          items:
            $ref: '#/components/schemas/PublicTagReferenceDto'
        textSearch:
          type: string
          description: Text to search in the name of the sources
        types:
          type: array
          description: List of source types to filter on
          items:
            type: string
            description: List of source types to filter on
            enum:
            - ATHENA
            - BIGQUERY
            - REDSHIFT
            - SNOWFLAKE
            - DATABRICKS
            - MSSQL
            - MYSQL
            - POSTGRESQL
            - ORACLE
            - SYNAPSE
            - LOOKER
            - TABLEAU
            - QUICKSIGHT
            - AIRFLOW
            - DBT
            - DBT_CLOUD
            - FIVETRAN
            - POWER_BI
            - DECLARATIVE
            - _UNKNOWN_
      description: Filter to apply on the sources search
    PublicGetSourceDto:
      required:
      - id
      - name
      - parameters
      type: object
      properties:
        credentials:
          type: string
          description: Credentials of the source
        description:
          type: string
          description: Description of the source
        id:
          type: string
          format: uuid
        lastRun:
          $ref: '#/components/schemas/PublicGetLastRunDto'
        name:
          type: string
          description: Name of the source
        parameters:
          oneOf:
          - $ref: '#/components/schemas/PublicAirflowParametersDto'
          - $ref: '#/components/schemas/PublicAthenaParametersDto'
          - $ref: '#/components/schemas/PublicBigQueryParametersDto'
          - $ref: '#/components/schemas/PublicDatabricksParametersDto'
          - $ref: '#/components/schemas/PublicDbtCloudParametersDto'
          - $ref: '#/components/schemas/PublicDbtParametersDto'
          - $ref: '#/components/schemas/PublicDeclarativeParametersDto'
          - $ref: '#/components/schemas/PublicFivetranParametersDto'
          - $ref: '#/components/schemas/PublicLookerParametersDto'
          - $ref: '#/components/schemas/PublicMssqlParametersDto'
          - $ref: '#/components/schemas/PublicMysqlParametersDto'
          - $ref: '#/components/schemas/PublicOracleParametersDto'
          - $ref: '#/components/schemas/PublicPostgresqlParametersDto'
          - $ref: '#/components/schemas/PublicPowerBiParametersDto'
          - $ref: '#/components/schemas/PublicQuicksightParametersDto'
          - $ref: '#/components/schemas/PublicRedshiftParametersDto'
          - $ref: '#/components/schemas/PublicSnowflakeParametersDto'
          - $ref: '#/components/schemas/PublicSynapseParametersDto'
          - $ref: '#/components/schemas/PublicTableauParametersDto'
        schedule:
          type: string
          description: Schedule of the source. Supports CRON syntax. If empty, the source won't be scheduled.
        tags:
          type: array
          description: Tags of the source
          example:
          - id: 02a15477-1e58-490e-aa5c-1c7388fcb136
            kind: CLASSIFICATION
            name: PII
          items:
            $ref: '#/components/schemas/PublicTagReferenceDto'
        timezone:
          type: string
          description: A string representing a timezone identifier (e.g. 'UTC' or 'Europe/Paris')
          example: UTC
          default: UTC
    PublicLookerParametersDto:
      required:
      - gitConnections
      - host
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          gitConnections:
            type: array
            description: The LookML configuration. See https://docs.siffletdata.com/docs/looker. If you don't use LookML, use an empty list `[]`
            items:
              $ref: '#/components/schemas/GitConnection'
          host:
            type: string
            description: "URL of the Looker site and append at the end the following \"/api/4.0\".\nFor instance if you usually connect to Looker on \"https://abcdef.cloud.looker.com/\",\n then you should add the following on host: \"https://abcdef.cloud.looker.com/api/4.0\"\n"
            example: https://abcdef.cloud.looker.com/api/4.0
    PublicRedshiftParametersDto:
      required:
      - database
      - host
      - port
      - schema
      - ssl
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          database:
            type: string
            description: Your database name
            example: my_database
          host:
            type: string
            description: Your Redshift server host
            example: redshift.example.com
          port:
            type: integer
            description: Your Redshift server port
            format: int32
            example: 5439
          schema:
            type: string
            description: Your schema name
            example: public
          ssl:
            type: boolean
            description: Whether to use SSL to connect to your Redshift server
    PublicMysqlParametersDto:
      required:
      - database
      - host
      - mysqlTlsVersion
      - port
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicSourceParametersDto'
      - type: object
        properties:
          database:
            type: string
            description: Your database name
            example: my_database
          host:
            type: string
            description: Your MySQL server hostname
            example: my-mysql-server.com
          mysqlTlsVersion:
            type: string
            description: The TLS version to use to connect to your MySQL server
            example: TLS_V_1_2
            enum:
            - TLS_V_1_2
            - TLS_V_1_3
          port:
            type: integer
            description: Your MySQL server port
            format: int32
            example: 3306
  securitySchemes:
    JWT:
      bearerFormat: Bearer [token]
      description: JWT authentication with bearer token. [Create your access token through the UI](https://docs.siffletdata.com/docs/generate-an-api-token#create-an-api-token).
      scheme: bearer
      type: http
x-provenance:
  method: searched
  source: https://docs.siffletdata.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.siffletdata.com/reference/decryptrulegroups.md
  - https://docs.siffletdata.com/reference/decryptrulerungroups.md
  - https://docs.siffletdata.com/reference/getallmonitorsascode.md
  - https://docs.siffletdata.com/reference/getallrule.md
  - https://docs.siffletdata.com/reference/getsiffletruledetails.md
  - https://docs.siffletdata.com/reference/getsiffletruleinfo.md
  - https://docs.siffletdata.com/reference/getsiffletruleoverview.md
  - https://docs.siffletdata.com/reference/getsiffletrulerun.md
  - https://docs.siffletdata.com/reference/getsiffletruleruns.md
  - https://docs.siffletdata.com/reference/publiccreatecalendar.md
  - https://docs.siffletdata.com/reference/publiccreatecredentials.md
  - https://docs.siffletdata.com/reference/publiccreatedomain.md
  - https://docs.siffletdata.com/reference/publiccreatenotificationrule.md
  - https://docs.siffletdata.com/reference/publiccreatesource.md
  - https://docs.siffletdata.com/reference/publiccreatesourcev2.md
  - https://docs.siffletdata.com/reference/publiccreateteam.md
  - https://docs.siffletdata.com/reference/publiccreateuser.md
  - https://docs.siffletdata.com/reference/publicdeletecalendar.md
  - https://docs.siffletdata.com/reference/publicdeletecredentials.md
  - https://docs.siffletdata.com/reference/publicdeletedomain.md
  - https://docs.siffletdata.com/reference/publicdeletenotificationrule.md
  - https://docs.siffletdata.com/reference/publicdeletesourcebyid.md
  - https://docs.siffletdata.com/reference/publicdeletesourcev2.md
  - https://docs.siffletdata.com/reference/publicdeleteteam.md
  - https://docs.siffletdata.com/reference/publicdeleteuser.md
  - https://docs.siffletdata.com/reference/publicdeleteworkspace.md
  - https://docs.siffletdata.com/reference/publiceditasset-1.md
  - https://docs.siffletdata.com/reference/publiceditsource.md
  - https://docs.siffletdata.com/reference/publiceditsourcev2.md
  - https://docs.siffletdata.com/reference/publicgetallcredentials.md
  - https://docs.siffletdata.com/reference/publicgetasset-1.md
  - https://docs.siffletdata.com/reference/publicgetassets-1.md
  - https://docs.siffletdata.com/reference/publicgetcalendar.md
  - https://docs.siffletdata.com/reference/publicgetcalendars.md
  - https://docs.siffletdata.com/reference/publicgetcredentials.md
  - https://docs.siffletdata.com/reference/publicgetdomain.md
  - https://docs.siffletdata.com/reference/publicgetdomains.md
  - https://docs.siffletdata.com/reference/publicgetnotificationrule.md
  - https://docs.siffletdata.com/reference/publicgetnotificationrules.md
  - https://docs.siffletdata.com/reference/publicgetsource.md
  - https://docs.siffletdata.com/reference/publicgetsources.md
  - https://docs.siffletdata.com/reference/publicgetsourceschemalist.md
  - https://docs.siffletdata.com/reference/publicgetsourcesv2.md
  - https://docs.siffletdata.com/reference/publicgetsourcev2.md
  - https://docs.siffletdata.com/reference/publicgetteam.md
  - https://docs.siffletdata.com/reference/publicgetteams.md
  - https://docs.siffletdata.com/reference/publicgetuser.md
  - https://docs.siffletdata.com/reference/publicgetusers.md
  - https://docs.siffletdata.com/reference/publicimportexternalcatalog.md
  - https://docs.siffletdata.com/reference/publicresetuserpassword.md
  - https://docs.siffletdata.com/reference/publicrunsourcev2.md
  - https://docs.siffletdata.com/reference/publicrunsubsourcev2.md
  - https://docs.siffletdata.com/reference/publicsourceingestionmanualrun.md
  - https://docs.siffletdata.com/reference/publicsyncassets.md
  - https://docs.siffletdata.com/reference/publictestexistingsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publictestsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publictestsubsourceconnectionbyuriv2.md
  - https://docs.siffletdata.com/reference/publictestsubsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publicupdatecalendar.md
  - https://docs.siffletdata.com/reference/publicupdatecredentials.md
  - https://docs.siffletdata.com/reference/publicupdatedomain.md
  - https://docs.siffletdata.com/reference/publicupdatenotificationrule.md
  - https://docs.siffletdata.com/reference/publicupdateteam.md
  - https://docs.siffletdata.com/reference/publicupdateuser.md
  - https://docs.siffletdata.com/reference/siffletrulemanualrun.md
  - https://docs.siffletdata.com/reference/testsourceconnection.md
  - https://docs.siffletdata.com/reference/uploaddbtmetadatafiles.md
  merge:
    pages: 67
    deduped: 626
    conflicts_kept_first: 0