GET /replaceAllObjects

This method replaces all records in an index without interrupting ongoing searches.

It combines batch and copy/move index operations:

  1. Copy settings, synonyms, and rules to a temporary index.
  2. Add the records from the objects parameter to the temporary index.
  3. Replace the original index with the temporary one.

If there's an error during one of these steps, the temporary index is deleted if your API key has the deleteIndex ACL.

If your API key restricts access to specific indices, make sure it also grants access to the temporary index INDEX_NAME_tmp_* (replace INDEX_NAME with the name of your original index).

This method is subject to indexing rate limits.

The response includes the results of the individual API requests.

This method creates a temporary index: your record count is temporarily doubled. Algolia doesn't count the three days with the highest number of records towards your monthly usage.

Servers

Query parameters

Name Type Required Description
scopes[] Array No

List of scopes to keep in the index. Defaults to settings, synonyms, and rules.

batchSize Integer No

The size of the chunk of objects. The number of batch calls will be equal to length(objects) / batchSize. Defaults to 1000.

Default value: 1000

indexName String Yes

The indexName to replace objects in.

objects[] Array Yes

List of objects to replace the current objects with.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.