Get Index (Azure Cognitive Search REST API)
The Get Index operation gets the index definition from Azure Cognitive Search.
HTTPS is required for service requests. The Get Index request can be constructed using the GET method.
GET https://[service name].search.windows.net/indexes/[index name]?api-version=[api-version] api-key: [admin key]
[index name] in the request URI specifies which index to return from the indexes collection.
[api-version] is required. The current version is
2019-05-06. See API versions in Azure Cognitive Search for details.
The following list describes the required and optional request headers.
|Content-Type:||Required. Set this to
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 Cognitive Search service for details.
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.
You can use a diagnostic tool such as Postman to view the response payload. See Create an Azure Cognitive Search index in Postman using REST APIs.