Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Settings → Reset Index Settings

AI-generated

Overview

This node operation resets the settings of a specified index in Meilisearch to their default values. It is useful when you want to clear any custom configurations and revert the index settings back to the original state. For example, if you have modified ranking rules or searchable attributes and want to start fresh, this operation will reset those settings.

Use Case Examples

  1. Resetting the settings of an index named 'products' to default after testing various configurations.
  2. Reverting index settings to default before applying a new configuration to ensure no residual settings interfere.

Properties

Name Meaning
UID The unique identifier (name) of the index whose settings will be reset.
Wait for Completion Whether to wait for the reset task to complete before returning. If enabled, the node will poll the task status until it succeeds, fails, or is canceled.
Use Exponential Backoff If enabled, the polling interval for checking task status will gradually increase to reduce API calls. If disabled, a fixed polling interval is used.
Polling Interval (ms) Fixed interval between polling requests in milliseconds, used when exponential backoff is disabled.
Initial Polling Interval (ms) Starting interval between polling requests in milliseconds. The interval increases by 1.5x every 5 attempts when exponential backoff is enabled.
Max Polling Interval (ms) Maximum interval between polling requests. Exponential backoff will not exceed this value.
Timeout (seconds) Maximum time to wait for task completion in seconds (default is 5 minutes).

Output

JSON

  • json
    • status - The status of the reset task (e.g., succeeded, failed, canceled).
    • taskUid - The unique identifier of the reset task.
    • type - The type of task performed (reset settings).
    • indexUid - The UID of the index whose settings were reset.

Dependencies

  • Meilisearch API key credential

Troubleshooting

  • If the task does not complete within the specified timeout, a timeout error is thrown. Increase the timeout or check the Meilisearch server status.
  • If the specified index UID does not exist, the API will return an error. Ensure the UID is correct and the index exists.
  • If polling is enabled but the task status is never updated, check network connectivity and Meilisearch server health.

Links

Discussion