GET /generateSecuredApiKey
Generates a secured API key without any requests to Algolia's servers.
Secured API keys are API keys that you generate on your server without any API request to Algolia. Use secured API keys when you can't update client-side code, such as in mobile apps, or when you need to restrict access to part of an index for each user.
When users start searching, your app requests a short-lived secured API key from your server instead of using the Search API key. Your server uses this method to generate the secured API key with restrictions such as filters, index access restrictions, or expiration times, and returns it to your app. The API key gets longer as you add restrictions.
You can't create secured API keys from other secured API keys or from your Admin API key. The generated API key can have the same restrictions as the parent API key, or be more restrictive.
Servers
- https://{appId}.algolia.net
- https://{appId}-1.algolianet.com
- https://{appId}-2.algolianet.com
- https://{appId}-3.algolianet.com
- https://{appId}-dsn.algolia.net
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
restrictions |
Object | Yes |
Restrictions to add to the API key. |
parentApiKey |
String | Yes |
API key from which the secured API key will inherit its restrictions. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.