Indexers - Run

Runs an indexer on-demand.

POST {endpoint}/indexers('{indexerName}')/search.run?api-version=2023-11-01

URI Parameters

Name In Required Type Description
endpoint
path True

string

The endpoint URL of the search service.

indexerName
path True

string

The name of the indexer to run.

api-version
query True

string

Client Api Version.

Request Header

Name Required Type Description
x-ms-client-request-id

string

uuid

The tracking ID sent with the request to help with debugging.

Responses

Name Type Description
202 Accepted
Other Status Codes

SearchError

Error response.

Examples

SearchServiceRunIndexer

Sample request

POST https://myservice.search.windows.net/indexers('myindexer')/search.run?api-version=2023-11-01

Sample response

Definitions

SearchError

Describes an error condition for the API.

Name Type Description
code

string

One of a server-defined set of error codes.

details

SearchError[]

An array of details about specific errors that led to this reported error.

message

string

A human-readable representation of the error.