Actions33
- Documents Actions
- General Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
Keys → Get An API Key
AI-generatedOverview
This node operation retrieves details of a specific API key from the Meilisearch service using its UID or key identifier. It is useful for managing and inspecting API keys within Meilisearch, such as verifying permissions or key metadata.
Use Case Examples
- Retrieve an API key's details by providing its UID to check its permissions and expiration.
- Use in workflows that audit or log API key usage by fetching key information dynamically.
Properties
| Name | Meaning |
|---|---|
| UID | The unique identifier or key of the API key to retrieve. This is a required string input. |
Output
JSON
json- The JSON response containing the details of the requested API key, including its UID, name, description, actions allowed, indexes it applies to, and expiration date if any.
Dependencies
- Requires Meilisearch API credentials (host URL and API key) to authenticate and authorize the request.
Troubleshooting
- If the UID is incorrect or the key does not exist, the node will throw an error indicating the key was not found.
- Ensure the Meilisearch API credentials are valid and have permission to access key information.
- Network issues or incorrect host URL configuration can cause request failures.
Links
- Meilisearch API - Get an API Key - Official documentation for the Meilisearch API endpoint to retrieve an API key.