GET /replaceAllObjects

Replace all records from your index with a new set of records.

This method lets you replace all records in your index without downtime. It performs these operations:

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

Use the safe parameter to ensure that these (asynchronous) operations are performed in sequence. If there's an error duing one of these steps, the temporary index won't be deleted. This operation is rate-limited. 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. If you're on a legacy plan (before July 2020), this method counts two operations towards your usage (in addition to the number of records): copySettings and moveIndex. The API key you use for this operation must have access to the index YourIndex and the temporary index YourIndex_tmp.

Servers

Query parameters

Name Type Required Description
scopes[] Array No

List of scopes to kepp 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.