API keys
List of methods
| Create secured API Key |
Generate a secured API key without any call to our servers. |
| Add API Key |
Add a new API Key with specific permissions/restrictions. |
| Update API Key |
Replace every permission of an existing API key. Any unspecified field resets that permission to its default value. |
| Delete API Key |
Delete an existing API Key. |
| Restore API Key |
Restore a deleted API key, along with its associated rights. |
| Get API Key permissions |
Get the permissions of an API key. When initializing the client using the admin API key, you can request information for any of your application’s API keys. When using a non-admin API key, you can only retrieve information for this specific API key. |
| List API Keys |
Get the full list of API Keys. |
| Get secured API key remaining validity |
Retrieve the remaining validity of a secured API key in seconds. |
It’s recommended to use the Kotlin API client, which is better suited for Android development.
Adding and Generating API keys
It is important to understand the difference between the Add API Key and Generate secured API Key methods.
For example:
Add API keyis executed on the Algolia server;Generate Secured API keyis executed on your own server, not Algolia’s.- Keys added appear on the dashboard; keys generated don’t.
- You add keys that are fixed and have very precise permissions. They are often used to target specific indices, users, or application use-cases. They are also used to generate Secured API Keys.
