Replication API Specification Reference
ReductStore supports append-only replication. This feature allows you to replicate records from one bucket to another. To use the replication feature, you must create a replication task with the source and destination buckets. This reference describes the API for managing replication tasks.
The API is available at the /api/v1/replications endpoint and requires an access token with full access.
For more information about replications, read the Replication Guide.
Get a List of Replication Tasks
The method returns a list of replication Task with their statuses.
Changes:
- v1.8: The endpoint was added
- v1.18: Added the
modefield to show whether replication isenabled,paused, ordisabled
Show Information about a Replication Task
This method provides complete information about a replication task, including diagnostics and settings.
Changes:
- v1.8: The endpoint was added
- v1.14: The
whenfield was added with conditional query to filter records - v1.18: Added the
modefield to the replication info and settings
Create a New Replication Task
The method creates a replication task with given settings.
Changes:
- v1.8: The endpoint was added
- v1.14: The
whenfield was added with conditional query to filter records - v1.18: Added optional
modeto start replications asenabled,paused, ordisabled
Update an Existing Replication Task
The method updates an existing replication task with given settings. To use this method, you need an access token with full access.
Changes:
- v1.8: The endpoint was added
- v1.14: The
whenfield was added with conditional query to filter records - v1.18: Added optional
modeto switch betweenenabled,paused, anddisabled
Update Replication Mode
Use this endpoint to switch a replication task between enabled, paused, and disabled without overwriting other settings.
Changes:
- v1.18: The endpoint was added
Delete a Replication Task
The method deletes a replication task.
Changes:
- v1.8: The endpoint was added