List Data Sources (Azure AI Search REST API)

  • Article

The List Data Sources operation returns a list of the data sources in your Azure AI Search service.

GET https://[service name].search.windows.net/datasources?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

URI Parameters

Parameter Description
service name Required. Set this to the unique, user-defined name of your search service.
api-version Required. The current stable version is api-version=2020-06-30. See API versions for more versions.

Request Headers

The following table describes the required and optional request headers.

Fields Description
Content-Type Required. Set this to application/json
api-key Optional if you're using Azure roles and a bearer token is provided on the request, otherwise a key is required. An api-key is a unique, system-generated string that authenticates the request to your search service. Get requests for an object definition must include an api-key field set to your admin key (as opposed to a query key). See Connect to Azure AI Search using key authentication for details.

Request Body

None.

Response

For a successful request: 200 OK. Here is an example response body:

    {  
      "value" : [  
        {  
          "name": "datasource1",  
          "type": "azuresql",  
          ... other data source properties  
        }]  
    }

You can filter the response down to just the properties you're interested in. For example, if you want only a list of data source names, use the OData select query option:

GET /datasources?api-version=2020-06-30&$select=name

In this case, the response from the above example would appear as follows:

    {  
      "value" : [ { "name": "datasource1" }, ... ]  
    }

Note

If a data source has an encryption key, the search service must have access to the encryption key to retrieve encrypted properties in that data source's definition. Without access to the encryption key, an "<encrypted>" placeholder is returned in place of the encrypted properties. Restoring access to the key allows the search service to retrieve the complete data source definition again.

See also