Copy and move indices

You can copy (duplicate) or move (rename) indices, including their associated , settings, synonyms, and rules, using the Algolia dashboard or one of the API clients.

Copying or moving an is resource-intensive and rate-limited.

Move or rename indices

You can move or rename an index within the same Algolia in the Algolia dashboard or with an API client.

Moving or renaming an index leaves its existing analytics associated with the original index name. Algolia starts a new set of analytics under the new name. For more information, see Indices and analytics.

Rename indices in the Algolia dashboard

In the Algolia dashboard, you can’t rename replica indices. You also can’t rename primary indices that have replicas.

Go to the Algolia dashboard and select your Algolia application.
On the left sidebar, select Search.
Select your Algolia index.
Select Manage index > Rename.
If the destination index already exists, this operation overwrites it.
Enter the current and new index names and click Rename.

Rename indices with an API client

To run the code examples on this page, install the latest API client. To rename or move an index with the API, you can use:

API clients: operationIndex
Algolia CLI: algolia indices move

You can’t move an index between different Algolia applications but you can create a copy and delete the original index. For more information, see Copy indices between apps.

If the destination index already exists, this operation overwrites it. To avoid overwriting existing indices, check if an index exists with indexExists.

var response = await client.OperationIndexAsync(
  "<SOURCE_INDEX_NAME>",
  new OperationIndexParams
  {
    Operation = Enum.Parse<OperationType>("Move"),
    Destination = "<DESTINATION_INDEX_NAME>",
  }
);

final response = await client.operationIndex(
  indexName: "<SOURCE_INDEX_NAME>",
  operationIndexParams: OperationIndexParams(
    operation: OperationType.fromJson("move"),
    destination: "<DESTINATION_INDEX_NAME>",
  ),
);

response, err := client.OperationIndex(client.NewApiOperationIndexRequest(
  "<SOURCE_INDEX_NAME>",
  search.NewEmptyOperationIndexParams().SetOperation(search.OperationType("move")).SetDestination("<DESTINATION_INDEX_NAME>")))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.operationIndex(
  "<SOURCE_INDEX_NAME>",
  new OperationIndexParams().setOperation(OperationType.MOVE).setDestination("<DESTINATION_INDEX_NAME>")
);

const response = await client.operationIndex({
  indexName: '<SOURCE_INDEX_NAME>',
  operationIndexParams: { operation: 'move', destination: '<DESTINATION_INDEX_NAME>' },
});

var response =
  client.operationIndex(
    indexName = "<SOURCE_INDEX_NAME>",
    operationIndexParams =
      OperationIndexParams(
        operation = OperationType.entries.first { it.value == "move" },
        destination = "<DESTINATION_INDEX_NAME>",
      ),
  )

$response = $client->operationIndex(
    '<SOURCE_INDEX_NAME>',
    ['operation' => 'move',
        'destination' => '<DESTINATION_INDEX_NAME>',
    ],
);

response = client.operation_index(
    index_name="<SOURCE_INDEX_NAME>",
    operation_index_params={
        "operation": "move",
        "destination": "<DESTINATION_INDEX_NAME>",
    },
)

response = client.operation_index(
  "<SOURCE_INDEX_NAME>",
  Algolia::Search::OperationIndexParams.new(operation: "move", destination: "<DESTINATION_INDEX_NAME>")
)

val response = Await.result(
  client.operationIndex(
    indexName = "<SOURCE_INDEX_NAME>",
    operationIndexParams = OperationIndexParams(
      operation = OperationType.withName("move"),
      destination = "<DESTINATION_INDEX_NAME>"
    )
  ),
  Duration(100, "sec")
)

let response = try await client.operationIndex(
    indexName: "<SOURCE_INDEX_NAME>",
    operationIndexParams: OperationIndexParams(
        operation: OperationType.move,
        destination: "<DESTINATION_INDEX_NAME>"
    )
)

If the source index doesn’t exist, Algolia ignores the move operation.

Rename indices with replicas

Renaming replica indices requires several steps. You can’t move a source index with replicas. You can move an index to a destination index with replicas. Algolia replaces the destination index’s data with the source index’s data, then copies it to the destination’s replicas. Don’t rename an index used as a data source for Recommend models. Renaming it breaks the relationship between recommended records and their source. Instead:

Copy the index.
To keep the events you already collected, train a new model on the copied index using the original index as an additional events source.
After training, switch your apps and services to use the new index.
Delete the old index and the old model (from the Algolia dashboard).

Copy indices

You can copy an index in the Algolia dashboard or with an API client. Copying an index works as follows:

Copying an index duplicates the records and configuration, including synonyms and rules of an existing index.
Copying an index doesn’t create a replica. The new index is an independent copy.
To copy an index between two Algolia applications, use the Algolia CLI.

Copying an index doesn’t copy its analytics data.

Copy indices in the Algolia dashboard

Go to the Algolia dashboard and select your Algolia application.
On the left sidebar, select Search.
Select the Algolia index that you want to copy.
Select Manage index > Duplicate.
Select Create a new index or Overwrite an existing index and enter the destination index name.
If you’re overwriting an existing index, enter DUPLICATE to confirm.
Click Duplicate.

Copy indices with an API client

To copy indices, you can use:

API clients: operationIndex
Algolia CLI: algolia indices copy

To copy only settings, synonyms, or rules, specify them in the scope parameter. Omit scope to copy the entire index. When copying an index with the API, Algolia doesn’t copy the enableReRanking, mode, or replicas settings.

Copy entire indices

To copy an index including records, settings, synonyms, and rules:

var response = await client.OperationIndexAsync(
  "<SOURCE_INDEX_NAME>",
  new OperationIndexParams
  {
    Operation = Enum.Parse<OperationType>("Copy"),
    Destination = "<DESTINATION_INDEX_NAME>",
  }
);

final response = await client.operationIndex(
  indexName: "<SOURCE_INDEX_NAME>",
  operationIndexParams: OperationIndexParams(
    operation: OperationType.fromJson("copy"),
    destination: "<DESTINATION_INDEX_NAME>",
  ),
);

response, err := client.OperationIndex(client.NewApiOperationIndexRequest(
  "<SOURCE_INDEX_NAME>",
  search.NewEmptyOperationIndexParams().SetOperation(search.OperationType("copy")).SetDestination("<DESTINATION_INDEX_NAME>")))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.operationIndex(
  "<SOURCE_INDEX_NAME>",
  new OperationIndexParams().setOperation(OperationType.COPY).setDestination("<DESTINATION_INDEX_NAME>")
);

const response = await client.operationIndex({
  indexName: '<SOURCE_INDEX_NAME>',
  operationIndexParams: { operation: 'copy', destination: '<DESTINATION_INDEX_NAME>' },
});

var response =
  client.operationIndex(
    indexName = "<SOURCE_INDEX_NAME>",
    operationIndexParams =
      OperationIndexParams(
        operation = OperationType.entries.first { it.value == "copy" },
        destination = "<DESTINATION_INDEX_NAME>",
      ),
  )

$response = $client->operationIndex(
    '<SOURCE_INDEX_NAME>',
    ['operation' => 'copy',
        'destination' => '<DESTINATION_INDEX_NAME>',
    ],
);

response = client.operation_index(
    index_name="<SOURCE_INDEX_NAME>",
    operation_index_params={
        "operation": "copy",
        "destination": "<DESTINATION_INDEX_NAME>",
    },
)

response = client.operation_index(
  "<SOURCE_INDEX_NAME>",
  Algolia::Search::OperationIndexParams.new(operation: "copy", destination: "<DESTINATION_INDEX_NAME>")
)

val response = Await.result(
  client.operationIndex(
    indexName = "<SOURCE_INDEX_NAME>",
    operationIndexParams = OperationIndexParams(
      operation = OperationType.withName("copy"),
      destination = "<DESTINATION_INDEX_NAME>"
    )
  ),
  Duration(100, "sec")
)

let response = try await client.operationIndex(
    indexName: "<SOURCE_INDEX_NAME>",
    operationIndexParams: OperationIndexParams(
        operation: OperationType.copy,
        destination: "<DESTINATION_INDEX_NAME>"
    )
)

If the destination index already exists, this operation overwrites it. To avoid overwriting an index, check whether it exists with indexExists.

Copy index settings, synonyms, or rules

To copy parts of an index, use the scope parameter of the operationIndex method. For example, to copy only the synonyms and settings between indices, but not records or rules:

var response = await client.OperationIndexAsync(
  "<SOURCE_INDEX_NAME>",
  new OperationIndexParams
  {
    Operation = Enum.Parse<OperationType>("Move"),
    Destination = "<DESTINATION_INDEX_NAME>",
    Scope = new List<ScopeType>
    {
      Enum.Parse<ScopeType>("Rules"),
      Enum.Parse<ScopeType>("Settings"),
    },
  }
);

final response = await client.operationIndex(
  indexName: "<SOURCE_INDEX_NAME>",
  operationIndexParams: OperationIndexParams(
    operation: OperationType.fromJson("move"),
    destination: "<DESTINATION_INDEX_NAME>",
    scope: [
      ScopeType.fromJson("rules"),
      ScopeType.fromJson("settings"),
    ],
  ),
);

response, err := client.OperationIndex(client.NewApiOperationIndexRequest(
  "<SOURCE_INDEX_NAME>",
  search.NewEmptyOperationIndexParams().SetOperation(search.OperationType("move")).SetDestination("<DESTINATION_INDEX_NAME>").SetScope(
    []search.ScopeType{search.ScopeType("rules"), search.ScopeType("settings")})))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.operationIndex(
  "<SOURCE_INDEX_NAME>",
  new OperationIndexParams()
    .setOperation(OperationType.MOVE)
    .setDestination("<DESTINATION_INDEX_NAME>")
    .setScope(Arrays.asList(ScopeType.RULES, ScopeType.SETTINGS))
);

const response = await client.operationIndex({
  indexName: '<SOURCE_INDEX_NAME>',
  operationIndexParams: { operation: 'move', destination: '<DESTINATION_INDEX_NAME>', scope: ['rules', 'settings'] },
});

var response =
  client.operationIndex(
    indexName = "<SOURCE_INDEX_NAME>",
    operationIndexParams =
      OperationIndexParams(
        operation = OperationType.entries.first { it.value == "move" },
        destination = "<DESTINATION_INDEX_NAME>",
        scope =
          listOf(
            ScopeType.entries.first { it.value == "rules" },
            ScopeType.entries.first { it.value == "settings" },
          ),
      ),
  )

$response = $client->operationIndex(
    '<SOURCE_INDEX_NAME>',
    ['operation' => 'move',
        'destination' => '<DESTINATION_INDEX_NAME>',
        'scope' => [
            'rules',

            'settings',
        ],
    ],
);

response = client.operation_index(
    index_name="<SOURCE_INDEX_NAME>",
    operation_index_params={
        "operation": "move",
        "destination": "<DESTINATION_INDEX_NAME>",
        "scope": [
            "rules",
            "settings",
        ],
    },
)

response = client.operation_index(
  "<SOURCE_INDEX_NAME>",
  Algolia::Search::OperationIndexParams.new(
    operation: "move",
    destination: "<DESTINATION_INDEX_NAME>",
    scope: ["rules", "settings"]
  )
)

val response = Await.result(
  client.operationIndex(
    indexName = "<SOURCE_INDEX_NAME>",
    operationIndexParams = OperationIndexParams(
      operation = OperationType.withName("move"),
      destination = "<DESTINATION_INDEX_NAME>",
      scope = Some(Seq(ScopeType.withName("rules"), ScopeType.withName("settings")))
    )
  ),
  Duration(100, "sec")
)

let response = try await client.operationIndex(
    indexName: "<SOURCE_INDEX_NAME>",
    operationIndexParams: OperationIndexParams(
        operation: OperationType.move,
        destination: "<DESTINATION_INDEX_NAME>",
        scope: [ScopeType.rules, ScopeType.settings]
    )
)

If you specify scope, Algolia replaces the selected settings, synonyms, or rules in the destination index. Records, settings, synonyms, and rules outside the selected scopes remain unchanged. For example, if you use the settings scope, Algolia copies only the settings to the destination index and leaves that index’s records, synonyms, and rules unchanged.

Copy indices with replicas

Copying a source index that has replicas copies the index’s data, but not its replicas. The destination index won’t have replicas. You can’t copy to a destination index with replicas.

Copy indices between different applications

To copy an index between different Algolia applications, use the Algolia CLI.

Search and Discovery platform

Optimization and Personalization

AI-powered experiences

Production and scale

Copy and move indices

Move or rename indices

Rename indices in the Algolia dashboard

Rename indices with an API client

Rename indices with replicas

Copy indices

Copy indices in the Algolia dashboard

Copy indices with an API client

Copy entire indices

Copy index settings, synonyms, or rules

Copy indices with replicas

Copy indices between different applications

​Move or rename indices

​Rename indices in the Algolia dashboard

​Rename indices with an API client

​Rename indices with replicas

​Indices used as a Recommend data source

​Copy indices

​Copy indices in the Algolia dashboard

​Copy indices with an API client

​Copy entire indices

​Copy index settings, synonyms, or rules

​Copy indices with replicas

​Copy indices between different applications

Move or rename indices

Rename indices in the Algolia dashboard

Rename indices with an API client

Rename indices with replicas

Indices used as a Recommend data source

Copy indices

Copy indices in the Algolia dashboard

Copy indices with an API client

Copy entire indices

Copy index settings, synonyms, or rules

Copy indices with replicas

Copy indices between different applications