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 allows you to interact with Algolia indices, specifically to retrieve the settings of a given index. It is useful when you want to programmatically fetch the configuration details of an Algolia index, such as ranking criteria, searchable attributes, custom settings, and other index-specific configurations.
Typical use cases include:
- Auditing or monitoring index settings in automated workflows.
- Synchronizing or backing up index configurations.
- Dynamically adjusting application behavior based on index settings.
For example, you might use this node to get the current settings of a product search index before applying updates or to verify that certain features like typo tolerance or synonyms are enabled.
Properties
| Name | Meaning |
|---|---|
| Index Name | The name of the Algolia index whose settings you want to retrieve. This is a required field and must be selected from available indices. |
| Get Version | (Optional) A number indicating the version of the settings to retrieve. Defaults to 1 if not specified. |
Output
The node outputs the JSON response from Algolia's API containing the non-null settings of the specified index. This includes all configured parameters such as ranking rules, searchable attributes, custom ranking, synonyms, replicas, and other index-specific options.
The output is structured as a JSON object representing the index settings exactly as returned by Algolia.
Dependencies
- Requires an Algolia API key credential with appropriate permissions to access index settings.
- Requires the Algolia Application ID to construct the base URL for API requests.
- The node uses Algolia's REST API endpoint
/1/indexes/{indexName}/settingswith a GET method.
Troubleshooting
- Invalid Index Name: If the specified index does not exist, the API will return an error. Ensure the index name is correct and accessible with your API key.
- Authentication Errors: Make sure the API key credential has permission to read index settings.
- Network Issues: Verify network connectivity to Algolia's servers.
- Version Parameter: Providing an invalid or unsupported version number may cause errors; typically, this parameter can be omitted or set to 1.
Links and References
This summary covers the "Indices" resource with the "Get settings" operation, focusing on retrieving index configuration details from Algolia.