Guides / Sending and managing data / Manage indices and apps / Manage indices

Export and Import Indices and Settings

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, including its records and settings, see Copy indices.

You can also export the records from an index, for example, as a backup, or to use the data outside of Algolia.

Export records from an index

You can’t export records from an index from the Algolia dashboard. Instead, use an API client and the browse method with an empty query to retrieve all records from an index. Once you have all records, you can save them to a file, an external database, or any other destination.

API reference Browse

Import records to an index

You can import records into an index in the Algolia dashboard or using the API.

What’s included in the index configuration

Your index configuration contains values for:

Export index configuration from the Algolia dashboard

To export the configuration of an index from the Algolia dashboard as a JSON file:

  1. Go to the Algolia dashboard and select your index from the Index menu.
  2. Select Manage index > Export Configuration.

    Select an index and export its configuration as JSON file in the Algolia dashboard

  3. Choose what you want to export: Settings, Synonyms, or Rules.

    Select if you want to export Settings, Syonyms, or Rules and confirm

  4. Click Export Configuration to download a JSON file with the index configuration.

Export index configuration using the API

You can get the index settings, Rules, and synonyms from the API and export the settings in any format you like. To read settings, Rules, and synonyms, you need an API key with settings permissions.

You can obtain the configuration of an index with the following methods:

Import index configuration from the Algolia dashboard

To import the configuration of an index from a JSON file in the Algolia dashboard:

  1. Go to the Algolia dashboard and select your index from the Index menu.
  2. Select Manage index > Import Configuration.

    Import an index configuration from a JSON file

  3. Select the JSON file you want to import. Choose what you want to import: Settings, Synonyms, or Rules.

    Select what you want to import from a JSON file, settings, synonyms, or Rules

  4. 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 using 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.

Did you find this page helpful?