API clients / Methods

Aug 14, 2024

API keys API client methods

List of methods

Create secured API key generateSecuredApiKey generateSecuredApiKey generateSecuredApiKey generate_secured_api_key generate_secured_api_key GenerateSecuredApiKey generateSecuredApiKey GenerateSecuredAPIKey generateSecuredApiKey generateSecuredApiKey	Generate a secured API key without any calls to Algolia’s servers.
Add API key addApiKey addApiKey addApiKey add_api_key add_api_key AddApiKey addApiKey AddAPIKey addAPIKey add key	Add a new API Key with specific permissions and restrictions.
Update API key updateApiKey updateApiKey updateApiKey update_api_key update_api_key UpdateApiKey updateApiKey UpdateAPIKey updateAPIKey update key	Replace every permission of an existing API key.
Delete API key deleteApiKey deleteApiKey deleteApiKey delete_api_key delete_api_key DeleteApiKey deleteApiKey DeleteAPIKey deleteAPIKey delete key	Delete an API Key.
Restore API key restoreApiKey restoreApiKey restoreApiKey restore_api_key restore_api_key RestoreApiKey restoreApiKey RestoreAPIKey restoreAPIKey restore key	Restore a deleted API key, along with its associated rights.
Get API key permissions getApiKey getApiKey getApiKey get_api_key get_api_key GetApiKey getApiKey GetAPIKey getAPIKey get key	Get the permissions of an API key.
List API keys listApiKeys listApiKeys listApiKeys list_api_keys list_api_keys ListApiKeys listApiKeys ListAPIKeys listAPIKeys list keys	Get a list of API keys.
Get secured API key remaining validity Get secured API key remaining validity Get secured API key remaining validity getSecuredApiKeyRemainingValidity Get secured API key remaining validity get_secured_api_key_remaining_validity Get secured API key remaining validity Get secured API key remaining validity Get secured API key remaining validity getSecuredApiKeyRemainingValidity Get secured API key remaining validity	Retrieve the remaining validity of a secured API key in seconds.

Difference between adding and generating (secure) API keys

You can create new API keys in two different ways: addApiKey and generateSecuredApiKey.

The differences are:

Add API key runs on Algolia’s servers; Generate Secured API key runs on your own server.
Added keys appear in the Algolia dashboard; generated keys don’t.
You add keys that are fixed and have very precise permissions. They’re often used to target specific indices, users, or application. They’re also used to generate secured API keys.

You should generate secured API keys when building mobile applications with Algolia.

Did you find this page helpful?