You're viewing an archived version of our docs. Check out our current documentation →

Retrieve index settings

Retrieves an object with non-null index settings.

Usage

Required ACL: settings
1
2
3
4
5
import { algoliasearch } from 'algoliasearch';

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

const response = await client.getSettings({ indexName: 'cts_e2e_settings', getVersion: 2 });
JavaScript API clients v5