Indexers - Reset Docs

Service:

Search Service

API Version:

2023-10-01-Preview

Resets specific documents in the datasource to be selectively re-ingested by the indexer.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2023-10-01-Preview

With optional parameters:

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?overwrite={overwrite}&api-version=2023-10-01-Preview

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 reset documents for.
api-version	query	True	string	Client Api Version.
overwrite	query		boolean	If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string uuid	The tracking ID sent with the request to help with debugging.

Request Body

Name	Type	Description
datasourceDocumentIds	string[]	datasource document identifiers to be reset
documentKeys	string[]	document keys to be reset

Responses

Name	Type	Description
204 No Content
Other Status Codes	SearchError	Error response.

Examples

SearchServiceResetDocs

Sample request

HTTP

POST https://myservice.search.windows.net/indexers('myindexer')/search.resetdocs?overwrite=False&api-version=2023-10-01-Preview

{
  "documentKeys": [
    "documentKey1",
    "documentKey2"
  ]
}

Sample response

Status code:

204

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.