Create or update a search rule
Partially update a search rule by replacing the provided fields. If the rule doesn’t exist, it will be created.
Authorizations
An API key is a token that you provide when making API calls. Read more about how to secure your project.
Include the API key to the Authorization header, for instance:
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
Path Parameters
Unique identifier of the search rule.
Body
Human-readable description of the dynamic search rule.
Precedence of the dynamic search rule. Lower numeric values take precedence over higher ones. If omitted, the rule is treated as having the lowest precedence. This precedence is used to resolve conflicts between matching rules:
- If the same document is selected by multiple rules, the smallest
prioritynumber wins - If different documents are pinned to the same position, they are ordered by ascending
priority
x >= 0Whether the dynamic search rule is active.
Conditions that must match before the dynamic search rule applies.
Actions to apply when the dynamic search rule matches.
Response
Task enqueued to update dynamic search rule.
A summarized view of a task, returned when a task is enqueued
Unique sequential identifier of the task.
x >= 0Status of the task. Possible values are enqueued, processing,
succeeded, failed, and canceled.
enqueued, processing, succeeded, failed, canceled "processing"
Type of operation performed by the task.
documentAdditionOrUpdate, documentEdition, documentDeletion, settingsUpdate, indexCreation, indexDeletion, indexUpdate, indexSwap, taskCancelation, taskDeletion, dumpCreation, snapshotCreation, export, upgradeDatabase, indexCompaction, networkTopologyChange, dsrUpdate, dsrClear "documentAdditionOrUpdate"
Date and time when the task was enqueued.
Unique identifier of the targeted index. Null for global tasks.
Custom metadata attached to this task at creation. Use it to associate tasks with external systems or add application-specific information.