Actions27
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
Api Keys → List API keys
AI-generatedOverview
This node operation lists all API keys associated with your Algolia application, including their permissions and restrictions. It is useful for managing and auditing API keys to ensure proper access control and security within your Algolia environment.
Use Case Examples
- Retrieve a list of all API keys to review their permissions and usage limits.
- Audit API keys to identify and remove unused or overly permissive keys.
Properties
| Name | Meaning |
|---|---|
| Request Options | Options to customize the API request behavior, including batching, SSL certificate validation, proxy settings, and request timeout. |
Output
JSON
json- The JSON response containing the list of API keys with their details such as permissions, restrictions, and metadata.
Dependencies
- An API key credential for authenticating requests to the Algolia API
Troubleshooting
- Ensure the API key credential used has the necessary permissions to list API keys; otherwise, the request will fail with an authorization error.
- If the request times out, consider increasing the timeout setting or checking network connectivity.
- If SSL certificate validation fails and you trust the endpoint, enable the option to ignore SSL issues, but be aware of the security implications.
Links
- Algolia API - List API Keys - Official Algolia API documentation for listing API keys, including request and response details.