Get Index (Azure Search Service REST API)

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


HTTPS is required for service requests. The Get Index request can be constructed using the GET method.

GET https://[service name][index name]?api-version=[api-version]  
api-key: [admin key]  

The [index name] in the request URI specifies which index to return from the indexes collection.

The [api-version] is required. The current version is 2019-05-06. See API versions in Azure Search for details.

Request Headers

The following list describes the required and optional request headers.

Request Header 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. The Get Index request must include an api-key header set to your admin key (as opposed to a query key).

You will also need the service name to construct the request URL. You can get both the service name and api-key from your service dashboard in the Azure portal. See Create an Azure Search services for details.

Request Body



Status Code: "200 OK" is returned for a successful response. See the example request JSON in Create Index (Azure Search Service 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.


You can use a diagnostic tool such as Fiddler to view the response payload. See How to use Fiddler to evaluate and test Azure Search REST APIs.

See also

Azure Search Service REST
HTTP status codes (Azure Search)
API versions in Azure Search