Actions52
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
- Records Actions
- Rules Actions
- Search Actions
- Synonyms Actions
- Vaults Actions
Overview
This node operation deletes a specific rule from an Algolia index by its unique identifier. Rules in Algolia are conditional statements used to customize search results, such as boosting certain facets or changing the order of results based on conditions. Deleting a rule removes this customization from the specified index.
Use cases:
- Removing outdated or incorrect merchandising rules.
- Cleaning up rules that no longer apply to your search experience.
- Managing and maintaining the relevance of search results by deleting unnecessary rules.
Example:
If you have a rule that boosts products tagged as "featured" but want to remove it, you can use this operation to delete that rule by specifying its object ID and the index name.
Properties
| Name | Meaning |
|---|---|
| Index Name | The name of the Algolia index where the rule exists. |
| Object ID | The unique identifier of the rule to be deleted. |
| Forward To Replicas | (Optional) Boolean flag indicating whether the deletion should also be forwarded to replica indices. |
Output
The output will contain the JSON response from the Algolia API after attempting to delete the rule. This typically includes information about the task status or confirmation of deletion. No binary data is involved.
Dependencies
- Requires an Algolia application with appropriate API credentials (API key and Application ID).
- The node must be configured with these credentials to authenticate requests.
- The Algolia API endpoint is constructed using the provided Application ID.
- The user must have permission to delete rules in the specified index.
Troubleshooting
- Invalid Object ID: If the specified rule ID does not exist, the API may return an error or ignore the request silently. Verify the rule ID before attempting deletion.
- Insufficient Permissions: Ensure the API key used has permissions to delete rules.
- Index Not Found: If the specified index does not exist, the deletion will fail. Confirm the index name is correct.
- Forward To Replicas Flag: If set incorrectly, changes might not propagate to replicas as expected. Use with caution.
Links and References
This summary focuses on the "Rules" resource and the "Delete rule" operation as requested, based on the provided properties and bundled source code metadata.