List Indexes (Azure Cognitive Search REST API)

Article
04/07/2022
2 minutes to read

The List Indexes operation returns a list of the indexes currently in your Azure Cognitive Search service.

GET https://[service name].search.windows.net/indexes?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	Required. The api-key is used to authenticate the request to your Search service. It is a string value, unique to your service. Get requests about objects in your service must include an api-key field set to your admin key (as opposed to a query key). You can find the API key in your search service dashboard in the Azure portal.

Request Body

None.

Response

Status Code: "200 OK" is returned for a successful response.

Examples

{  
  "value": [  
    {  
      "name": "Books",  
      "fields": [  
        {"name": "ISBN", ...},  
        ...  
      ]  
    },  
    {  
      "name": "Games",  
      ...  
    },  
    ...  
  ]  
}

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

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

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

{  
  "value": [  
    {"name": "Books"},  
    {"name": "Games"},  
    ...  
  ]  
}

This is a useful technique to save bandwidth if you have a lot of indexes in your Search service.