Overview

This node operation retrieves detailed information about a specific index in Meilisearch by its UID. It is useful for scenarios where you need to fetch metadata or configuration details of an existing index, such as its primary key or other index-specific settings. For example, you might use this operation to verify the existence of an index or to inspect its properties before performing further actions like updating or deleting the index.

Use Case Examples

1. Fetch details of an index named 'products' to check its primary key and status.
2. Retrieve metadata of a user data index to confirm its configuration.

Properties

Output

JSON

• uid - The unique identifier of the index.
• primaryKey - The primary key field of the index, if set.
• createdAt - Timestamp when the index was created.
• updatedAt - Timestamp when the index was last updated.

Dependencies

• Requires Meilisearch API credentials for authentication.

Troubleshooting

• Common issues include providing an invalid or non-existent UID, which results in an error from the Meilisearch API indicating the index was not found.
• Ensure the API credentials are correctly configured and have sufficient permissions to access index information.
• Timeouts or network issues may cause the request to fail; verify connectivity to the Meilisearch server.