Update an API key

Replaces the permissions of an existing API key.

Any unspecified attribute resets that attribute to its default value.

Usage

Requires Admin API key
1
2
3
4
5
6
7
8
9
import { algoliasearch } from 'algoliasearch';

//
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

const response = await client.updateApiKey({
  key: 'ALGOLIA_API_KEY',
  apiKey: { acl: ['search', 'addObject'], validity: 300, maxQueriesPerIPPerHour: 100, maxHitsPerQuery: 20 },
});
Did you find this page helpful?
JavaScript API clients v5