Skip to main content
Related concepts: Crawler, Document and fields.
Related guide: Pushing Content — end-to-end examples for replace, partial update, delete, bulk delete, and queueing URLs.
See Authentication for credential setup. Manage documents in your search index. Replace, partially update, or delete documents individually or in bulk.
Index Management endpoints require Basic authentication. SiteKey tokens are not accepted.

​
Replace documents

PUT /api/v4/{customerId}/index/{crawlerId}/documents Replace or create documents in the index. If a document with the same ID exists, it is deleted first and then re-indexed (upsert). The request body is a JSON array of document objects with id and fields. Each document may optionally include a top-level type ("PageContent" or "FileContent", defaults to "PageContent") as a sibling of id and fields to mark a document as a file (e.g. PDF or DOCX).

​
Partial update documents

PATCH /api/v4/{customerId}/index/{crawlerId}/documents Merge specific fields into existing documents without replacing the entire document. Only include the fields you want to update. The optional top-level type ("PageContent" or "FileContent") is accepted here as well and behaves the same as on replace.

​
Delete single document

DELETE /api/v4/{customerId}/index/{crawlerId}/documents?documentId={id} Delete a single document by its ID.

​
Bulk delete documents

POST /api/v4/{customerId}/index/{crawlerId}/documents/bulk-delete Delete documents matching an advanced filter with AND/OR logic.