Run Indexer (Azure Cognitive Search REST API)

In addition to running periodically on a schedule, an indexer can also be invoked on demand via the Run Indexer operation.

POST https://[service name].search.windows.net/indexers/[indexer name]/run?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 run.
api-version Required. The current version is api-version=2020-06-30. See API versions in Azure Cognitive Search for a list of available 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 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.

Request Body

None.

Response

Status Code: 202 Accepted is returned for a successful response.

See also

Azure Cognitive Search REST APIs
HTTP status codes (Azure Cognitive Search)
Indexer operations (Azure Cognitive Search REST API)
Naming rules (Azure Cognitive Search)