Create an API key

Creates a new API key with specific permissions and restrictions.

Usage

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

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

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