---
title: "Get Data Source entity"
method: GET
path: "/api/v1/entities/dataSources/{id}"
tags: ["Data Source - Entity APIs"]
---

# Get Data Source entity

`GET /api/v1/entities/dataSources/{id}`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/dataSources/{id}`
- Auth: none declared

Data Source - represents data source for the workspace

## Path parameters

- `id` string, required

## Query parameters

- `filter` string
- `metaInclude` string[]: Included meta objects

## Response `200`

Request successfully processed

- JsonApiDataSourceOutDocument
  - `data` JsonApiDataSourceOut, required: JSON:API representation of dataSource entity.
    - `attributes` object, required
      - `alternativeDataSourceId` string, nullable: Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.
      - `authenticationType` 'USERNAME_PASSWORD' | 'TOKEN' | 'KEY_PAIR' | 'CLIENT_SECRET' | 'OIDC_PASSTHROUGH', nullable: Type of authentication used to connect to the database.
      - `cacheRetention` union: Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.
        - IndefiniteCacheRetention: The cache never expires on its own; it is kept per `cacheStrategy` and invalidated only explicitly. Equivalent to setting no policy at all.
          - `type` 'INDEFINITE', required: The cache retention type.
        - ScheduleCacheRetention: The cache expires according to a schedule.
          - `schedule` CacheRetentionSchedule, required: A schedule determining when the cached results of a data source expire.
            - `cron` string, required: Cron expression determining when the cached results expire.
            - `timezone` string, nullable: Timezone the cron expression is evaluated in. Defaults to UTC when not set.
          - `type` 'SCHEDULE', required: The cache retention type.
        - ValidityPeriodCacheRetention: The cache expires once a fixed period elapses since the results were computed.
          - `type` 'VALIDITY_PERIOD', required: The cache retention type.
          - `validityPeriod` string, duration, required: How long the cached results stay valid after they were computed.
      - `cacheStrategy` 'ALWAYS' | 'NEVER', nullable: Determines how the results coming from a particular datasource should be cached.
      - `clientId` string, nullable: The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).
      - `dateTimeSemantics` 'LOCAL' | 'UTC', nullable: Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.
      - `decodedParameters` object[], nullable: Decoded parameters to be used when connecting to the database providing the data for the data source.
        - `name` string, required
        - `value` string, required
      - `disableStatistics` boolean, nullable: Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.
      - `ignoreJwtAud` boolean, nullable: Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.
      - `managed` boolean: Whether the object is platform-managed and read-only.
      - `name` string, required: User-facing name of the data source.
      - `parameters` object[], nullable: Additional parameters to be used when connecting to the database providing the data for the data source.
        - `name` string, required
        - `value` string, required
      - `schema` string, required: The schema to use as the root of the data for the data source.
      - `type` 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'CRATEDB' | 'AILAKEHOUSE' | 'DENODO' | 'TRINO', required: Type of the database providing the data for the data source.
      - `url` string, nullable: The URL of the database providing the data for the data source.
      - `username` string, nullable: The username to use to connect to the database providing the data for the data source.
    - `id` string, required: API identifier of an object
    - `meta` object
      - `permissions` string[]: List of valid permissions for a logged-in user.
    - `type` 'dataSource', required: Object type
  - `links` ObjectLinks
    - `self` string, uri, required: A string containing the link's URL.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)