Deleting a document

Use the DELETE method on the base URL of the Ingestion API to delete an index document. Use this method when you need to delete content quickly.

Important

When an administrator recrawls a pull source, either manually or through scheduled crawls, Search updates all index documents with the latest data from your original content. This action overwrites any updates you made through Ingestion API if they aren't also applied to the original content. To prevent this, we recommend that you always update the original content with changes made through the Ingestion API. This synchronization ensures that your modifications are maintained in future crawls.

To use the Ingestion API to delete a document, make a DELETE call to the Delete Document endpoint.

For the data model of this method and a description of objects and keys, see the Ingestion API reference. You can view your base URL in the Developer Resources section of Search.

You can partially update or delete documents in one, some, or all locales. To update or delete documents in more than one locale, in the request URL, pass the locales separated by an ampersand (&). For example, to partially update or delete documents in the English (US) and Japanese (Japan) locales, use locale=en_us&locale=ja_jp. To partially update or delete all locales, pass locale=all.

You can partially update or delete more than one locale at a time because index documents for multiple locales share the same index document ID. This is so that users don't see duplicate results and only see content that is relevant to their locale. You configure this when you set up the crawler source or create documents with the Ingestion API.

For example, you want to delete an index document for all locales.

Here is a sample DELETE cURL call:

RequestResponse

curl -X DELETE --location 'https://<base-url/domains/<domainID>/sources/<sourceID>/entities/<entity>/documents/<documentID>?locale=all' \
--header 'Content-Type: application/json' \
--header 'Authorization: <api-key>' \

Do you have some feedback for us?

If you have suggestions for improving this article,