Tool to create a new API key with specific permissions and restrictions. Use when you need to generate API keys with custom ACL permissions, index restrictions, rate limits, or expiration times.
aclRequiredarrayPermissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see access control list (ACL).
indexesarrayIndex names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (*): 'dev_*' matches all indices starting with 'dev_', '*_dev' matches all indices ending with '_dev'…
referersarrayAllowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (*): 'https://algolia.com/*' allows all referrers starting with 'https://algolia.com/', '*.algolia.com' allows all referrers ending with '.algolia…
validityintegerDuration (in seconds) after which the API key expires. By default, API keys don't expire.
descriptionstringDescription of an API key to help you identify this API key.
maxHitsPerQueryintegerMaximum number of results this API key can retrieve in one query. By default, there's no limit.
queryParametersstringQuery parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the restrictSources parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is ma…
maxQueriesPerIPPerHourintegerMaximum number of API requests allowed per IP address or user token per hour. If this limit is reached, the API returns an error with status code 429. By default, there's no limit.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.