Delete a replica index

Deleting a standard or virtual replica requires two steps:

1. Unlink the replica index from the primary index. This turns the replica index into a regular index.
2. Delete the replica index.

Unlink replicas in the dashboard

1. Go to the Algolia dashboard and select your Algolia application.
2. On the left sidebar, select Search.

3. Select the Algolia index you want to configure:

   

   Make sure to select the primary index.

4. On the Replicas tab, click Unlink Replica for the replica you want to unlink.

   

5. Save your changes.

Now, you can delete your replica index.

Unlink replica indices with the API

To unlink a replica index from its primary index, remove it from the replicas setting of the primary index, using the setSettings method:

1
2
3
$primary_index->setSettings([
  'replicas' => []
]);

1
2
3
primary_index.set_settings({
  replicas: []
})

1
2
3
primaryIndex.setSettings({
  replicas: []
});

1
2
3
primary_index.set_settings({
  'replicas': []
})

1
2
3
primary_index.setSettings([
  "replicas": []
])

1
2
3
4
5
6
7
8
9
10
IndexSettings settings = new IndexSettings
{
    Replicas = new List<string> {}
};

// Set Settings--Synchronous
primary_index.SetSettings(settings);

// Set Settings--Asynchronous
await primary_index.SetSettingsAsync(settings);

1
2
3
primary_index.setSettings(
  new IndexSettings().setReplicas(Arrays.asList(""))
);

1
2
3
res1, err := primaryIndex.SetSettings(search.Settings{
  Replicas: opt.Replicas(),
})

1
2
3
4
5
client.execute {
  changeSettings of "primary_index" `with` IndexSettings(
    replicas = Some(Seq(""))
  )
}

Now, you can delete your replica index.

If want to keep other replicas of the primary index, don’t remove them from the replicas setting. If you set replicas to an empty string or list, all replicas will be unlinked.