Get Index (Azure Search Service REST API)

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

GET https://[service name].search.windows.net/indexes/[index name]?api-version=[api-version]  
api-key: [admin key]  

Request

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

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

The api-version parameter is required. The current version is api-version=2016-09-01. See API versions in Azure Search for details.

Request Headers

The following table describes the required and optional request headers.

Request Header Description
api-key: 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 set to an admin key (as opposed to a query key).

You will also need the service name to construct the request URL. You can get the service name and api-key from your service dashboard in the Azure Preview Portal. See Create an Azure Search service in the portal for page navigation help.

Request Body

None.

Response

Status Code: "200 OK" is returned for a successful response. See the example JSON in Create Index (Azure Search Service REST API) for an example of the response payload.

Note

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