Get Index (Azure Cognitive Search REST API)
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]
|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 version is
The following table describes the required and optional request headers.
|Content-Type||Required. Set this to
|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 get the api-key value from your service dashboard in the Azure portal. For more information, see Find existing keys.
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.