{
  "id": "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-04-01T08:10:08-05:00",
  "page_type": "content",
  "content_hash": "d464fd0c6006e14cf8d509159bc7bafc7cbb76173d036836fcb607bea8922682",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "The BDB `replica_sync` field relates to the [Replica Of]() 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]() 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' <br />'paused' |\n| 'paused' | Pauses the sync process. The process is configured but is not currently executing any sync commands. | 'enabled' <br />'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": []
}