Export and import indices and settings
On this page
You can export the configuration of one index and import it in another index. This can be useful if you want to:
- Back up your index configuration
- Track changes to the index configuration—for example, with a version control system
- Apply the same configuration to multiple indices—for example, moving between staging and production environments, or when you have different indices for different geographical regions
If you want to copy an index’s settings to another index, see Copy indices.
Export records from your indices
You can export the records in your indices using one of these methods:
- Use the
algolia objects browse
command with the Algolia CLI - Use the
browse
method with an API client
You can’t export records with the Algolia dashboard.
Import records
If you want to upload records to Algolia, see these topics for more information:
What’s included in the index configuration
Your index configuration contains values for:
Export index configuration in the Algolia dashboard
To export the configuration of an index from the Algolia dashboard as a JSON file:
- Go to the Algolia dashboard and select your Algolia application.
- On the left sidebar, select Search.
-
Select the Algolia index you want to configure:
-
Select Manage index > Export Configuration.
-
Select what you want to export: Settings, Synonyms, or Rules.
- Click Export Configuration to download a JSON file with the index configuration.
Export index configuration with the API
Using the API, you can export the index settings, Rules, and synonyms in any format.
To export your settings, rules, and synonyms, you need an API key with settings
permissions.
You can obtain the configuration of an index with the following methods:
Algolia CLI | API clients | |
---|---|---|
Settings | algolia settings get |
getSettings |
Rules | algolia rules browse |
exportRules |
Synonyms | algolia synonyms browse |
exportSynonyms |
Check the Algolia CLI usage examples for more information.
Import index configuration in the Algolia dashboard
- Go to the Algolia dashboard and select your Algolia application.
- On the left sidebar, select Search.
-
Select the Algolia index you want to configure:
-
Select Manage index > Import Configuration.
- Select the JSON file you want to import.
- Choose what you want to import: Settings, Synonyms, or Rules.
-
Type
IMPORT
to confirm and click Import Configuration.Importing settings replaces all existing index settings with the imported ones. Synonyms and rules are replaced if the synonym or rule already exists. Otherwise, new synonyms or rules are added.
Import index configuration with the API
After importing a file with the index configuration,
you can use these methods to change the configuration.
You need an API key with editSettings
permissions.
Algolia CLI | API clients | |
---|---|---|
Update settings | algolia settings import |
setSettings |
Add rules | algolia rules import |
saveRule |
Add synonyms | algolia synonyms import |
saveSynonym |
Check the Algolia CLI usage examples for more information.