Get Index (Azure Cognitive Search REST API)

Article
05/09/2023

The Get Index operation gets the index definition from Azure Cognitive Search.

GET https://[service name].search.windows.net/indexes/[index name]?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.
index name	Required. The request URI specifies the name of the index to return.
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 Cognitive Search using key authentication for details.

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 Cognitive Search using key authentication for details.

Request Body

None.

Response

Status Code: "200 OK" is returned for a successful response. See the example request JSON in Create Index (Azure Cognitive Search REST API) for an example of the response payload. The Get Index response body and the Create Index response and response bodies are all of the same format.