> ## 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 datalake

> Retrieve an datalake.



## OpenAPI

````yaml /generated/openapi-import-generated-2023-12-01.json get /import/datalakes/{datalake_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/datalakes/{datalake_id}:
    get:
      tags:
        - Datalakes
      summary: Get datalake
      description: Retrieve an datalake.
      operationId: get-datalake
      parameters:
        - name: datalake_id
          in: path
          required: true
          description: Import Datalake ID.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    $ref: '#/components/schemas/GetDatalakeResponse'
                    $schema: https://json-schema.org/draft/2020-12/schema
                    $id: >-
                      https://github.com/prequel-co/datafeed/internal/import/api/models/get-datalake-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:
    GetDatalakeResponse:
      properties:
        datalake:
          $ref: '#/components/schemas/DatalakeResource'
      additionalProperties: false
      type: object
      required:
        - datalake
    DatalakeResource:
      oneOf:
        - $ref: '#/components/schemas/DatalakeResourceS3'
        - $ref: '#/components/schemas/DatalakeResourceS3Compatible'
        - $ref: '#/components/schemas/DatalakeResourceGCS'
        - $ref: '#/components/schemas/DatalakeResourceABS'
      discriminator:
        mapping:
          abs: '#/components/schemas/DatalakeResourceABS'
          gcs: '#/components/schemas/DatalakeResourceGCS'
          s3: '#/components/schemas/DatalakeResourceS3'
          s3_compatible: '#/components/schemas/DatalakeResourceS3Compatible'
        propertyName: storage
    ErrorResponse:
      properties:
        status:
          type: string
          const: error
        message:
          type: string
        data:
          type: 'null'
      type: object
      required:
        - status
        - message
    DatalakeResourceS3:
      properties:
        id:
          type: string
        name:
          type: string
          examples:
            - acme-datalake
        retention_window_days:
          type: integer
          examples:
            - 30
        created_at:
          type: string
        updated_at:
          type: string
        storage:
          type: string
          enum:
            - s3
            - s3_compatible
            - gcs
            - abs
          const: s3
        s3:
          $ref: '#/components/schemas/S3DatalakeResource'
      type: object
      required:
        - id
        - name
        - created_at
        - updated_at
        - storage
        - s3
      title: S3
      unevaluatedProperties: false
    DatalakeResourceS3Compatible:
      properties:
        id:
          type: string
        name:
          type: string
          examples:
            - acme-datalake
        retention_window_days:
          type: integer
          examples:
            - 30
        created_at:
          type: string
        updated_at:
          type: string
        storage:
          type: string
          enum:
            - s3_compatible
            - s3
            - gcs
            - abs
          const: s3_compatible
        s3_compatible:
          $ref: '#/components/schemas/S3CompatibleDatalakeResource'
      type: object
      required:
        - id
        - name
        - created_at
        - updated_at
        - storage
        - s3_compatible
      title: S3 Compatible
      unevaluatedProperties: false
    DatalakeResourceGCS:
      properties:
        id:
          type: string
        name:
          type: string
          examples:
            - acme-datalake
        retention_window_days:
          type: integer
          examples:
            - 30
        created_at:
          type: string
        updated_at:
          type: string
        storage:
          type: string
          enum:
            - gcs
            - s3
            - s3_compatible
            - abs
          const: gcs
        gcs:
          $ref: '#/components/schemas/GCSDatalakeResource'
      type: object
      required:
        - id
        - name
        - created_at
        - updated_at
        - storage
        - gcs
      title: GCS
      unevaluatedProperties: false
    DatalakeResourceABS:
      properties:
        id:
          type: string
        name:
          type: string
          examples:
            - acme-datalake
        retention_window_days:
          type: integer
          examples:
            - 30
        created_at:
          type: string
        updated_at:
          type: string
        storage:
          type: string
          enum:
            - abs
            - s3
            - s3_compatible
            - gcs
          const: abs
        abs:
          $ref: '#/components/schemas/ABSDatalakeResource'
      type: object
      required:
        - id
        - name
        - created_at
        - updated_at
        - storage
        - abs
      title: ABS
      unevaluatedProperties: false
    S3DatalakeResource:
      oneOf:
        - $ref: '#/components/schemas/S3DatalakeResourceAWSIAMRole'
        - $ref: '#/components/schemas/S3DatalakeResourceAWSAccessKeys'
      discriminator:
        mapping:
          aws_access_keys: '#/components/schemas/S3DatalakeResourceAWSAccessKeys'
          aws_iam_role: '#/components/schemas/S3DatalakeResourceAWSIAMRole'
        propertyName: auth_method
    S3CompatibleDatalakeResource:
      properties:
        prefix:
          type: string
          examples:
            - data_export
        bucket_name:
          type: string
          examples:
            - acme-data-export-staging
        bucket_region:
          type: string
          examples:
            - us-east-1
        bucket_host:
          type: string
          examples:
            - s3.us-east-1.amazonaws.com
        bucket_port:
          type: integer
          examples:
            - 443
        aws_access_keys:
          $ref: '#/components/schemas/AWSAccessKeysResource'
      additionalProperties: false
      type: object
      required:
        - prefix
        - bucket_name
        - bucket_region
        - bucket_host
        - bucket_port
        - aws_access_keys
    GCSDatalakeResource:
      oneOf:
        - $ref: '#/components/schemas/GCSDatalakeResourceGCPServiceAccountRole'
        - $ref: '#/components/schemas/GCSDatalakeResourceGCPServiceAccountKey'
        - $ref: >-
            #/components/schemas/GCSDatalakeResourceFederatedGCPServiceAccountRole
      discriminator:
        mapping:
          federated_gcp_service_account_role: >-
            #/components/schemas/GCSDatalakeResourceFederatedGCPServiceAccountRole
          gcp_service_account_key: '#/components/schemas/GCSDatalakeResourceGCPServiceAccountKey'
          gcp_service_account_role: '#/components/schemas/GCSDatalakeResourceGCPServiceAccountRole'
        propertyName: auth_method
    ABSDatalakeResource:
      properties:
        prefix:
          type: string
          examples:
            - data_export
        container_name:
          type: string
          examples:
            - data-export
        storage_account_name:
          type: string
          examples:
            - acmestorage
        auth_method:
          type: string
          enum:
            - azure_storage_account_access_key
          examples:
            - azure_storage_account_access_key
        azure_storage_account_access_key:
          $ref: '#/components/schemas/AzureStorageAccountAccessKeyResource'
      additionalProperties: false
      type: object
      required:
        - prefix
        - container_name
        - storage_account_name
        - auth_method
    S3DatalakeResourceAWSIAMRole:
      properties:
        prefix:
          type: string
          examples:
            - data_export
        bucket_name:
          type: string
          examples:
            - acme-data-export-staging
        bucket_region:
          type: string
          examples:
            - us-east-1
        auth_method:
          type: string
          enum:
            - aws_iam_role
            - aws_access_keys
          const: aws_iam_role
        aws_iam_role:
          $ref: '#/components/schemas/AWSIAMRoleResource'
      type: object
      required:
        - prefix
        - bucket_name
        - bucket_region
        - auth_method
        - aws_iam_role
      title: AWS IAM Role
      unevaluatedProperties: false
    S3DatalakeResourceAWSAccessKeys:
      properties:
        prefix:
          type: string
          examples:
            - data_export
        bucket_name:
          type: string
          examples:
            - acme-data-export-staging
        bucket_region:
          type: string
          examples:
            - us-east-1
        auth_method:
          type: string
          enum:
            - aws_access_keys
            - aws_iam_role
          const: aws_access_keys
        aws_access_keys:
          $ref: '#/components/schemas/AWSAccessKeysResource'
      type: object
      required:
        - prefix
        - bucket_name
        - bucket_region
        - auth_method
        - aws_access_keys
      title: AWS Access Keys
      unevaluatedProperties: false
    AWSAccessKeysResource:
      properties:
        access_id:
          type: string
          examples:
            - AKIAIOSFODNN7EXAMPLE
      additionalProperties: false
      type: object
      required:
        - access_id
    GCSDatalakeResourceGCPServiceAccountRole:
      properties:
        prefix:
          type: string
          examples:
            - data_export
        bucket_name:
          type: string
          examples:
            - acme-data-export-staging
        bucket_region:
          type: string
          examples:
            - us-central1
        auth_method:
          type: string
          enum:
            - gcp_service_account_role
            - gcp_service_account_key
            - federated_gcp_service_account_role
          const: gcp_service_account_role
        gcp_service_account_role:
          $ref: '#/components/schemas/GCPDatalakeServiceAccountRoleResource'
      type: object
      required:
        - prefix
        - bucket_name
        - bucket_region
        - auth_method
        - gcp_service_account_role
      title: GCP Service Account Role
      unevaluatedProperties: false
    GCSDatalakeResourceGCPServiceAccountKey:
      properties:
        prefix:
          type: string
          examples:
            - data_export
        bucket_name:
          type: string
          examples:
            - acme-data-export-staging
        bucket_region:
          type: string
          examples:
            - us-central1
        auth_method:
          type: string
          enum:
            - gcp_service_account_key
            - gcp_service_account_role
            - federated_gcp_service_account_role
          const: gcp_service_account_key
        gcp_service_account_key:
          $ref: '#/components/schemas/GCPDatalakeServiceAccountKeyResource'
      type: object
      required:
        - prefix
        - bucket_name
        - bucket_region
        - auth_method
        - gcp_service_account_key
      title: GCP Service Account Key
      unevaluatedProperties: false
    GCSDatalakeResourceFederatedGCPServiceAccountRole:
      properties:
        prefix:
          type: string
          examples:
            - data_export
        bucket_name:
          type: string
          examples:
            - acme-data-export-staging
        bucket_region:
          type: string
          examples:
            - us-central1
        auth_method:
          type: string
          enum:
            - federated_gcp_service_account_role
            - gcp_service_account_role
            - gcp_service_account_key
          const: federated_gcp_service_account_role
        federated_gcp_service_account_role:
          $ref: '#/components/schemas/FederatedGCPDatalakeServiceAccountRoleResource'
      type: object
      required:
        - prefix
        - bucket_name
        - bucket_region
        - auth_method
        - federated_gcp_service_account_role
      title: Federated GCP Service Account Role
      unevaluatedProperties: false
    AzureStorageAccountAccessKeyResource:
      properties: {}
      additionalProperties: false
      type: object
    AWSIAMRoleResource:
      properties:
        aws_iam_role_arn:
          type: string
          examples:
            - arn:aws:iam::123456789012:role/service-role/role-name
      additionalProperties: false
      type: object
      required:
        - aws_iam_role_arn
    GCPDatalakeServiceAccountRoleResource:
      properties:
        gcp_service_account_email:
          type: string
          examples:
            - data-export@acme-analytics-1234.iam.gserviceaccount.com
      additionalProperties: false
      type: object
      required:
        - gcp_service_account_email
    GCPDatalakeServiceAccountKeyResource:
      properties:
        service_account_email:
          type: string
          examples:
            - data-export@acme-analytics-1234.iam.gserviceaccount.com
      additionalProperties: false
      type: object
      required:
        - service_account_email
    FederatedGCPDatalakeServiceAccountRoleResource:
      properties:
        gcp_service_account_email:
          type: string
          examples:
            - data-export@acme-analytics-1234.iam.gserviceaccount.com
      additionalProperties: false
      type: object
      required:
        - gcp_service_account_email
  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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.