POST /1/indexes/{indexName}/operation
Copies or moves (renames) an index within the same Algolia application.
- Existing destination indices are overwritten, except for their analytics data.
- If the destination index doesn't exist yet, it'll be created.
- This operation is resource-intensive.
Copy
- Copying a source index that doesn't exist creates a new index with 0 records and default settings.
- The API keys of the source index are merged with the existing keys in the destination index.
- You can't copy the
enableReRanking,mode, andreplicassettings. - You can't copy to a destination index that already has replicas.
- Be aware of the size limits.
- Related guide: Copy indices
Move
- Moving a source index that doesn't exist is ignored without returning an error.
- When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name.
- If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices.
- Related guide: Move indices.
This operation is subject to indexing rate limits.
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
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
indexName |
String | Yes |
Name of the index on which to perform the operation. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
destination |
String | Yes |
Index name (case-sensitive). |
operation |
String | Yes |
Operation to perform on the index. Possible values:
|
scope[] |
Array | No |
Only for copying. If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged.
If you omit the |
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.