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

# Get import source

> Retrieve an import source.



## OpenAPI

````yaml /generated/openapi-import-generated-2023-12-01.json get /import/sources/{id}
openapi: 3.1.0
info:
  title: Prequel Data Import
  description: Data Import API spec
  version: '2023-12-01'
servers:
  - url: https://api.prequel.co
    description: Cloud-hosted server (US)
  - url: https://eu-api.prequel.co
    description: Cloud-hosted server (EU)
  - url: https://{custom_host}
    description: Self-hosted Prequel API host
security:
  - ApiKeyAuth: []
paths:
  /import/sources/{id}:
    get:
      tags:
        - Import Sources
      summary: Get import source
      description: Retrieve an import source.
      operationId: get-import-source
      parameters:
        - name: id
          in: path
          required: true
          description: Import Source ID.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    $ref: '#/components/schemas/GetSourceResponse'
                    $schema: https://json-schema.org/draft/2020-12/schema
                    $id: >-
                      https://github.com/prequel-co/datafeed/internal/import/api/models/get-source-response
                  message:
                    type: string
                type: object
                required:
                  - status
                  - data
                  - message
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    GetSourceResponse:
      properties:
        source:
          $ref: '#/components/schemas/SourceResource'
      additionalProperties: false
      type: object
      required:
        - source
    SourceResource:
      oneOf:
        - properties:
            vendor:
              const: postgres
            postgres:
              $ref: '#/components/schemas/PostgresSourceResource'
          required:
            - vendor
            - postgres
          title: postgres
        - properties:
            vendor:
              const: redshift
            redshift:
              $ref: '#/components/schemas/RedshiftSourceResource'
          required:
            - vendor
            - redshift
          title: redshift
        - properties:
            vendor:
              const: redshift_serverless
            redshift_serverless:
              $ref: '#/components/schemas/RedshiftServerlessSourceResource'
          required:
            - vendor
            - redshift_serverless
          title: redshift_serverless
        - properties:
            vendor:
              const: bigquery
            bigquery:
              $ref: '#/components/schemas/BigQuerySourceResource'
          required:
            - vendor
            - bigquery
          title: bigquery
        - properties:
            vendor:
              const: s3
            s3:
              $ref: '#/components/schemas/S3SourceResource'
          required:
            - vendor
            - s3
          title: s3
        - properties:
            vendor:
              const: abs
            abs:
              $ref: '#/components/schemas/ABSSourceResource'
          required:
            - vendor
            - abs
          title: abs
        - properties:
            vendor:
              const: sftp
            sftp:
              $ref: '#/components/schemas/SFTPSourceResource'
          required:
            - vendor
            - sftp
          title: sftp
        - properties:
            vendor:
              const: gcs
            gcs:
              $ref: '#/components/schemas/GCSSourceResource'
          required:
            - vendor
            - gcs
          title: gcs
        - properties:
            vendor:
              const: s3_compatible
            s3_compatible:
              $ref: '#/components/schemas/S3CompatibleSourceResource'
          required:
            - vendor
            - s3_compatible
          title: s3_compatible
        - properties:
            vendor:
              const: snowflake
            snowflake:
              $ref: '#/components/schemas/SnowflakeSourceResource'
          required:
            - vendor
            - snowflake
          title: snowflake
        - properties:
            vendor:
              const: delta_sharing
            delta_sharing:
              $ref: '#/components/schemas/DeltaSharingSourceResource'
          required:
            - vendor
            - delta_sharing
          title: delta_sharing
      properties:
        id:
          type: string
        provider_id:
          type: string
        name:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      type: object
      required:
        - id
        - provider_id
        - name
        - created_at
        - updated_at
      unevaluatedProperties: false
    ErrorResponse:
      properties:
        status:
          type: string
          const: error
        message:
          type: string
        data:
          type: 'null'
      type: object
      required:
        - status
        - message
    PostgresSourceResource:
      properties:
        is_valid:
          type: boolean
        host:
          type: string
        port:
          type: integer
        database:
          type: string
        username:
          type: string
        auth_method:
          type: string
        use_ssh_tunnel:
          type: boolean
        ssh_tunnel:
          $ref: '#/components/schemas/SSHTunnelResource'
        disable_ssl:
          type: boolean
        connection_timeout_in_seconds:
          type: integer
      additionalProperties: false
      type: object
      required:
        - is_valid
        - host
        - port
        - database
        - username
        - auth_method
        - use_ssh_tunnel
        - disable_ssl
        - connection_timeout_in_seconds
    RedshiftSourceResource:
      properties:
        is_valid:
          type: boolean
        host:
          type: string
        port:
          type: integer
        database:
          type: string
        cluster:
          type: string
        region:
          type: string
        workgroup:
          type: string
        username:
          type: string
        auth_method:
          type: string
        aws_iam_role:
          $ref: '#/components/schemas/AWSIAMRoleResource'
        aws_access_keys:
          $ref: '#/components/schemas/RedshiftAccessKeysResource'
        use_ssh_tunnel:
          type: boolean
        ssh_tunnel:
          $ref: '#/components/schemas/SSHTunnelResource'
        disable_ssl:
          type: boolean
        connection_timeout_in_seconds:
          type: integer
      additionalProperties: false
      type: object
      required:
        - is_valid
        - host
        - port
        - database
        - auth_method
        - use_ssh_tunnel
        - disable_ssl
        - connection_timeout_in_seconds
    RedshiftServerlessSourceResource:
      properties:
        is_valid:
          type: boolean
        host:
          type: string
        port:
          type: integer
        database:
          type: string
        region:
          type: string
        workgroup:
          type: string
        auth_method:
          type: string
        aws_iam_role:
          $ref: '#/components/schemas/AWSIAMRoleResource'
        aws_access_keys:
          $ref: '#/components/schemas/RedshiftAccessKeysResource'
        use_ssh_tunnel:
          type: boolean
        ssh_tunnel:
          $ref: '#/components/schemas/SSHTunnelResource'
        disable_ssl:
          type: boolean
        connection_timeout_in_seconds:
          type: integer
      additionalProperties: false
      type: object
      required:
        - is_valid
        - host
        - port
        - database
        - workgroup
        - auth_method
        - use_ssh_tunnel
        - disable_ssl
        - connection_timeout_in_seconds
    BigQuerySourceResource:
      oneOf:
        - $ref: '#/components/schemas/BigQuerySourceResourceGCPServiceAccountRole'
        - $ref: >-
            #/components/schemas/BigQuerySourceResourceFederatedGCPServiceAccountRole
        - $ref: '#/components/schemas/BigQuerySourceResourceGCPServiceAccountKey'
      discriminator:
        mapping:
          federated_gcp_service_account_role:
            $ref: >-
              #/components/schemas/BigQuerySourceResourceFederatedGCPServiceAccountRole
          gcp_service_account_key:
            $ref: '#/components/schemas/BigQuerySourceResourceGCPServiceAccountKey'
          gcp_service_account_role:
            $ref: '#/components/schemas/BigQuerySourceResourceGCPServiceAccountRole'
        propertyName: auth_method
    S3SourceResource:
      properties:
        is_valid:
          type: boolean
        bucket_name:
          type: string
        region:
          type: string
        auth_method:
          type: string
        aws_iam_role:
          $ref: '#/components/schemas/AWSIAMRoleResource'
        aws_access_keys:
          $ref: '#/components/schemas/AWSAccessKeysResource'
        bucket_host:
          type: string
        use_ssh_tunnel:
          type: boolean
        ssh_tunnel:
          $ref: '#/components/schemas/SSHTunnelResource'
      additionalProperties: false
      type: object
      required:
        - is_valid
        - bucket_name
        - region
        - auth_method
        - use_ssh_tunnel
    ABSSourceResource:
      properties:
        is_valid:
          type: boolean
        bucket_name:
          type: string
        storage_account_name:
          type: string
        auth_method:
          type: string
      additionalProperties: false
      type: object
      required:
        - is_valid
        - bucket_name
        - storage_account_name
        - auth_method
    SFTPSourceResource:
      properties:
        is_valid:
          type: boolean
        username:
          type: string
        host:
          type: string
        port:
          type: integer
        auth_method:
          type: string
      additionalProperties: false
      type: object
      required:
        - is_valid
        - username
        - host
        - port
        - auth_method
    GCSSourceResource:
      properties:
        is_valid:
          type: boolean
        bucket_name:
          type: string
        region:
          type: string
        auth_method:
          type: string
        gcp_service_account_role:
          $ref: '#/components/schemas/GCPServiceAccountRoleResource'
        federated_gcp_service_account_role:
          $ref: '#/components/schemas/FederatedGCPServiceAccountRoleResource'
        gcs_hmac_keys:
          $ref: '#/components/schemas/GCSAccessKeysResource'
        gcp_service_account_key:
          $ref: '#/components/schemas/GCPServiceAccountKeyResource'
      additionalProperties: false
      type: object
      required:
        - is_valid
        - bucket_name
        - region
        - auth_method
    S3CompatibleSourceResource:
      properties:
        is_valid:
          type: boolean
        host:
          type: string
        port:
          type: integer
        bucket_name:
          type: string
        auth_method:
          type: string
        aws_access_keys:
          $ref: '#/components/schemas/AWSAccessKeysResource'
        disable_ssl:
          type: boolean
        use_ssh_tunnel:
          type: boolean
        ssh_tunnel:
          $ref: '#/components/schemas/SSHTunnelResource'
      additionalProperties: false
      type: object
      required:
        - is_valid
        - host
        - port
        - bucket_name
        - auth_method
        - disable_ssl
        - use_ssh_tunnel
    SnowflakeSourceResource:
      properties:
        is_valid:
          type: boolean
        host:
          type: string
        port:
          type: integer
        database:
          type: string
        username:
          type: string
        auth_method:
          type: string
          enum:
            - public_key_auth
        public_key_auth:
          $ref: '#/components/schemas/PublicKeyAuthResource'
      additionalProperties: false
      type: object
      required:
        - is_valid
        - host
        - port
        - database
        - username
        - auth_method
    DeltaSharingSourceResource:
      properties:
        is_valid:
          type: boolean
        host:
          type: string
        port:
          type: integer
        auth_method:
          type: string
        oauth_client_id:
          type: string
      additionalProperties: false
      type: object
      required:
        - is_valid
        - host
        - port
        - auth_method
    SSHTunnelResource:
      properties:
        ssh_tunnel_host:
          type: string
        ssh_tunnel_port:
          type: integer
        ssh_tunnel_username:
          type: string
        ssh_public_key:
          type: string
      additionalProperties: false
      type: object
    AWSIAMRoleResource:
      properties:
        aws_iam_role:
          type: string
      additionalProperties: false
      type: object
      required:
        - aws_iam_role
    RedshiftAccessKeysResource:
      properties:
        access_id:
          type: string
      additionalProperties: false
      type: object
      required:
        - access_id
    BigQuerySourceResourceGCPServiceAccountRole:
      properties:
        project_id:
          type: string
        region:
          type: string
        auth_method:
          const: gcp_service_account_role
        gcp_service_account_role:
          $ref: '#/components/schemas/GCPServiceAccountRoleResource'
      type: object
      required:
        - project_id
        - region
        - auth_method
        - gcp_service_account_role
      unevaluatedProperties: false
    BigQuerySourceResourceFederatedGCPServiceAccountRole:
      properties:
        project_id:
          type: string
        region:
          type: string
        auth_method:
          const: federated_gcp_service_account_role
        federated_gcp_service_account_role:
          $ref: '#/components/schemas/FederatedGCPServiceAccountRoleResource'
      type: object
      required:
        - project_id
        - region
        - auth_method
        - federated_gcp_service_account_role
      unevaluatedProperties: false
    BigQuerySourceResourceGCPServiceAccountKey:
      properties:
        project_id:
          type: string
        region:
          type: string
        auth_method:
          const: gcp_service_account_key
        gcp_service_account_key:
          $ref: '#/components/schemas/GCPServiceAccountKeyResource'
      type: object
      required:
        - project_id
        - region
        - auth_method
        - gcp_service_account_key
      unevaluatedProperties: false
    AWSAccessKeysResource:
      properties:
        access_key_id:
          type: string
      additionalProperties: false
      type: object
      required:
        - access_key_id
    GCPServiceAccountRoleResource:
      properties:
        service_account_email:
          type: string
      additionalProperties: false
      type: object
      required:
        - service_account_email
    FederatedGCPServiceAccountRoleResource:
      properties:
        service_account_email:
          type: string
      additionalProperties: false
      type: object
      required:
        - service_account_email
    GCSAccessKeysResource:
      properties:
        access_id:
          type: string
      additionalProperties: false
      type: object
      required:
        - access_id
    GCPServiceAccountKeyResource:
      properties:
        service_account_email:
          type: string
      additionalProperties: false
      type: object
      required:
        - service_account_email
    PublicKeyAuthResource:
      properties:
        public_key:
          type: string
      additionalProperties: false
      type: object
      required:
        - public_key
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````