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 manage Algolia API keys within your n8n workflows. Specifically, the "Get api key" operation retrieves the permissions and restrictions associated with a specified API key in your Algolia application. This is useful for auditing or verifying the access control of your API keys.
Common scenarios include:
- Checking the details of an existing API key to understand its permissions.
- Verifying that an API key has the correct restrictions before using it in other operations.
- Auditing API keys programmatically as part of security or compliance workflows.
Example: You have multiple API keys for different environments or teams, and you want to fetch the details of a particular key to confirm its ACLs and restrictions before granting access.
Properties
| Name | Meaning |
|---|---|
| Key | The specific API key string whose permissions and restrictions you want to retrieve. |
Output
The node outputs JSON data containing the details of the requested API key. This includes information such as:
- Permissions (access control lists) granted to the key.
- Restrictions like allowed indices, referers, IP addresses, query parameters, and validity period.
- Description of the key (may be redacted if not authenticated with an admin key).
No binary data output is involved.
Dependencies
- Requires an API authentication token credential configured in n8n to authenticate requests to the Algolia API.
- Needs the Algolia Application ID and API key credentials set up in n8n.
- The base URL for API requests is constructed using the Algolia Application ID.
Troubleshooting
- Invalid API Key: If the provided key string is incorrect or does not exist, the API will return an error. Verify the key value.
- Insufficient Permissions: If the authentication token used does not have admin privileges, the description field of the returned key info may be redacted or limited.
- Network Issues: Ensure that n8n can reach the Algolia API endpoint (
https://<appId>.algolia.net). - Missing Credentials: Make sure the required Algolia API credentials are properly configured in n8n.
Links and References
This summary covers the "Api Keys" resource and the "Get api key" operation specifically, based on the provided property definition and bundled source code metadata.