Reset Indexer (Azure AI Search REST API)

Important

This API reference is for a legacy version. See Data plane REST operations for updated reference documentation. Use the filter on the top left to select a version.

The Reset Indexer operation resets the change tracking state of indexed documents so that you can rebuild the index from scratch on the next run. A reset might be required if the data source schema has changed, or if you are modifying the change detection policy. For information about change tracking state, see Create Data Source.

POST https://[service name].search.windows.net/indexers/[indexer name]/reset?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.
indexer name Required. The request URI specifies the name of the indexer to reset.
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. Reset 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 Azure AI Search using key authentication for details.

Request Body

None.

Response

Status Code: 204 No Content for a successful response.

See also