Rules
List of methods
| Save rule |
Create or update a single Rule. |
| Batch Rules |
Create or update a specified set of Rules, or all Rules. |
| Get Rule |
Get the object/definition of a specific Rule. |
| Delete Rule |
Delete a specific Rule using its id. |
| Clear Rules |
Delete all Rules in an index. |
| Search rules |
Search for rules matching various criteria. |
| Replace all rules |
Push a new set of rules and erase all previous ones. |
| Copy rules |
Copy the rules of an index to another index on the same app. |
| Export Rules |
Get a list of all Rules defined on an index. |
It’s recommended to use the Kotlin API client, which is better suited for Android development.
We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.
We released a new version of the PHP API client in public beta. Read the beta documentation for more information.
We released a new version of the Java API client in public beta. Read the beta documentation for more information.
With Rules you can pre- and postprocess queries matching specific patterns.
Miscellaneous
Rules are applied at query time. You can use the Rules search API parameters to control how Rules are applied.
Methods that write Rules are asynchronous: they return a taskID, which you can use with the waitTask method.
