API Reference
/
API Methods
/
Api Keys
Jun. 03, 2019
Api Keys
List of methods
| Create secured API Key |
Generate a virtual API Key without any call to the server. |
| Add API Key |
Add a new API Key with specific permissions/restrictions. |
| Update API Key |
Update the permissions of an existing API Key. |
| 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 on any of your application’s API keys. When using a non-admin API key, you can only retrieve information on this specific API key. |
| List API Keys |
Get the full list of API Keys. |
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.
