GET /replaceAllObjectsWithTransformation
Replace all records in your index with a new set of records by using the Transformation pipeline in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push).
This method replaces all records without downtime. It performs these operations:
- Copy settings, synonyms, and rules from your original index to a temporary index.
- Add your new records to the temporary index.
- Replace your original index with the temporary index.
Notes:
- Use the
safeparameter to run these (asynchronous) operations in sequence. - If there's an error during one of these steps, the temporary index isn't deleted.
- This operation is rate-limited.
- This method creates a temporary index, which temporarily doubles your record count.
- Algolia doesn't count the three days with the highest number of records toward your monthly usage.
- If you're on a legacy plan (before July 2020), this method counts two operations toward your usage (in addition to the number of records):
copySettingsandmoveIndex. - The API key you use for this operation must have access to the index
YourIndexand the temporary indexYourIndex_tmp.
Servers
- https://{appId}.algolia.net
- https://{appId}-1.algolianet.com
- https://{appId}-2.algolianet.com
- https://{appId}-3.algolianet.com
- https://{appId}-dsn.algolia.net
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
scopes[] |
Array | No |
List of scopes to keep in the index. Defaults to |
batchSize |
Integer | No |
The size of the chunk of Default value: 1000 |
indexName |
String | Yes |
The |
objects[] |
Array | Yes |
List of objects to replace the current objects with. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.