Algolia icon

Algolia

Use Algolia in your n8n workflows

Actions27

Api Keys → Update an API key

AI-generated

Overview

This node operation updates an existing API key in Algolia. It allows users to modify the permissions (ACL), description, accessible indexes, query limits, referrers, validity period, and other restrictions of the API key. This is useful for managing API key security and access control dynamically within workflows.

Use Case Examples

  1. Updating an API key to restrict its access to specific indexes and set a maximum number of queries per IP per hour.
  2. Modifying an API key's ACL to grant or revoke permissions for certain API operations.

Properties

Name Meaning
Acl Permissions that determine the type of API requests this key can make. The ACL must be provided as a JSON array and is required.
Key The API key string that identifies the key to update. This is required.
Description A description to help identify the API key.
Indexes Index names or patterns that this API key can access. Supports wildcards.
Max Hits Per Query Maximum number of results this API key can retrieve in one query.
Max Queries Per IPPer Hour Maximum number of API requests allowed per IP address or user token per hour.
Query Parameters Additional query parameters to add when making API requests with this API key, such as IP address restrictions.
Referers Allowed HTTP referrers for this API key, supporting wildcards.
Validity Duration in seconds after which the API key expires.

Output

JSON

  • json - Response from Algolia API after updating the API key, including updated key details and status.

Dependencies

  • Algolia API key credential

Troubleshooting

  • Ensure the ACL JSON is correctly formatted and includes required permissions for the intended API operations.
  • Verify the API key string is correct and exists in the Algolia application.
  • Check that any IP or referrer restrictions are valid and correctly formatted to avoid request failures.
  • If the API returns a 429 error, it means the max queries per IP per hour limit has been reached; adjust limits accordingly.

Links

Discussion