{
"schema_version": 2,
"id": "operate/rs/references/rest-api/objects/bdb/replica_sync",
"title": "BDB replica sync field",
"url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/bdb/replica_sync/",
"summary": "Documents the bdb replica_sync field used with Redis Software REST API calls.",
"tags": [
"docs",
"operate",
"rs"
],
"last_updated": "2026-10-01T15:48:36+01:00",
"page_type": "content",
"content_hash": "c2540f433bc59c9710f3d9185154d33fb4c2f91e1b3abba83eb22e2ef8f672db",
"sections": [
{
"id": "content",
"title": "Content",
"role": "content",
"text": "The BDB `replica_sync` field relates to the [Replica Of](https://redis.io/docs/latest/operate/rs/databases/import-export/replica-of/create.md) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard).\n\nYou can use the `replica_sync` field to enable, disable, or pause the [Replica Of](https://redis.io/docs/latest/operate/rs/databases/import-export/replica-of/create.md) sync process. The BDB `crdt_sync` field has a similar purpose for the Redis CRDB.\n\nPossible BDB sync values:\n\n| Status | Description | Possible next status |\n|--------|-------------|----------------------|\n| 'disabled' | (default value) Disables the sync process and represents that no sync is currently configured or running. | 'enabled' |\n| 'enabled' | Enables the sync process and represents that the process is currently active. | 'stopped'
'paused' |\n| 'paused' | Pauses the sync process. The process is configured but is not currently executing any sync commands. | 'enabled'
'stopped' |\n| 'stopped' | An unrecoverable error occurred during the sync process, which caused the system to stop the sync. | 'enabled' |\n\n\n\nWhen the sync is in the 'stopped' or 'paused' state, then the `last_error` field in the relevant source entry in the `sync_sources` \"status\" field contains the detailed error message."
}
],
"examples": []
}