Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
This API reference is for a legacy version. See Data plane REST operations for updated reference documentation. Use the filter on the top left to select a version.
The List Indexes operation returns a list of the indexes currently in your Azure AI 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 | 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
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.