# List datasources

Launch stage: Beta

`GET /api/2.0/lakewatch/datasources`

Lists the datasources in a Unity Catalog catalog, optionally narrowed to one schema or
 filtered by name. Results are paginated. Datasources that are still being created or
 deleted are not listed.

API scopes: lakewatch

## Query parameters

- `page_size` (int32, optional)
  Maximum number of results to return in one page. This is a best-effort upper
   bound, not a guarantee: the server may return fewer items than requested (even
   zero) while more results still exist. If unset or 0, the server picks a default.
- `page_token` (string, optional)
- `filter` (string, optional)
  Filter expression that restricts the results to datasources with a given name, for example
   `datasource_name = "my_source"`. Only a single exact-match comparison on `datasource_name`
   is supported, and it matches the datasource's current Unity Catalog name, which reads report
   in `effective_datasource_name`. Filtered results are returned in a single page.
- `catalog_name` (string, required)
  Name of the Unity Catalog catalog to list datasources from. Required; each request lists the
   datasources of a single catalog.
- `schema_name` (string, optional)
  Name of a Unity Catalog schema in `catalog_name`. Optional; if set, only the datasources in
   this schema are returned, and if omitted, the datasources in all schemas of the catalog are
   returned.
- `view` (string, optional)
  Which fields to return for each datasource. Defaults to `DATASOURCE_VIEW_FULL`.
   `DATASOURCE_VIEW_BASIC` returns only the identity and Unity Catalog location fields.
  Possible values:
  - `DATASOURCE_VIEW_BASIC`
  - `DATASOURCE_VIEW_FULL`

## Returns

Returns a list of Datasource objects.

## Response

```json
{
  "datasources": [
    {
      "name": "datasources/550e8400-e29b-41d4-a716-446655440000",
      "datasource_id": "string",
      "catalog_name": "string",
      "schema_name": "string",
      "effective_catalog_name": "string",
      "effective_schema_name": "string",
      "datasource_name": "string",
      "effective_datasource_name": "string",
      "description": "string",
      "version": 0,
      "create_time": "string",
      "update_time": "string",
      "created_by": {},
      "updated_by": {},
      "etag": "string",
      "annotations": {},
      "owner": {},
      "run_as_principal": "string",
      "effective_run_as_principal": "string",
      "autoloader": {},
      "unity_catalog_connection": {},
      "existing_table": {},
      "parsers": [
        {}
      ],
      "schedule": {},
      "compute_mode": "DS_COMPUTE_STANDARD",
      "status": {},
      "compute_workspace_id": "string"
    }
  ],
  "next_page_token": "string"
}
```

