From 52ca0f9a084e69c7893e763f9381937aeef43e9a Mon Sep 17 00:00:00 2001
From: "redis-enterprise-doc-sync[bot]"
 <246451900+redis-enterprise-doc-sync[bot]@users.noreply.github.com>
Date: Tue, 28 Jul 2026 06:50:28 +0000
Subject: [PATCH] Update Redis Enterprise API specification

---
 .../rest-api/api-reference/openapi.json       | 162 ++++++++++++++++++
 1 file changed, 162 insertions(+)

diff --git a/content/operate/rs/references/rest-api/api-reference/openapi.json b/content/operate/rs/references/rest-api/api-reference/openapi.json
index efecd305e1..927c7e741d 100644
--- a/content/operate/rs/references/rest-api/api-reference/openapi.json
+++ b/content/operate/rs/references/rest-api/api-reference/openapi.json
@@ -961,6 +961,101 @@
         ],
         "type": "object"
       },
+      "Migration": {
+        "description": "Object structure for migration status.",
+        "properties": {
+          "error": {
+            "$ref": "#/components/schemas/MigrationError"
+          },
+          "flush_counter": {
+            "description": "How many times syncer had to restart.",
+            "nullable": true,
+            "readOnly": true,
+            "type": "integer",
+            "x-omitempty": true
+          },
+          "lag": {
+            "description": "Lag in milliseconds between source and destination (while synced).",
+            "nullable": true,
+            "readOnly": true,
+            "type": "integer",
+            "x-omitempty": true
+          },
+          "rdb_size": {
+            "description": "Number of source bytes.",
+            "nullable": true,
+            "readOnly": true,
+            "type": "integer",
+            "x-omitempty": true
+          },
+          "rdb_transferred": {
+            "description": "Number of source bytes transferred.",
+            "nullable": true,
+            "readOnly": true,
+            "type": "integer",
+            "x-omitempty": true
+          },
+          "run_id": {
+            "description": "Syncer run id.",
+            "nullable": true,
+            "readOnly": true,
+            "type": "string",
+            "x-omitempty": true
+          },
+          "source_shards": {
+            "items": {
+              "$ref": "#/components/schemas/SourceShard"
+            },
+            "readOnly": true,
+            "type": "array"
+          },
+          "status": {
+            "description": "Sync status of this source.",
+            "nullable": true,
+            "readOnly": true,
+            "type": "string",
+            "x-omitempty": true
+          }
+        },
+        "type": "object"
+      },
+      "MigrationError": {
+        "description": "Error information for migration operations",
+        "properties": {
+          "error_code": {
+            "description": "Error code identifying the specific error",
+            "nullable": true,
+            "readOnly": true,
+            "type": "string",
+            "x-omitempty": true
+          },
+          "message": {
+            "description": "Human-readable error message",
+            "nullable": true,
+            "readOnly": true,
+            "type": "string",
+            "x-omitempty": true
+          },
+          "timestamp": {
+            "description": "Timestamp when the error occurred",
+            "format": "date-time",
+            "nullable": true,
+            "readOnly": true,
+            "type": "string",
+            "x-omitempty": true
+          }
+        },
+        "type": "object"
+      },
+      "MigrationResponse": {
+        "description": "Response wrapper for migration endpoint",
+        "properties": {
+          "migration": {
+            "$ref": "#/components/schemas/Migration"
+          }
+        },
+        "type": "object"
+      },
       "NodeHealthReport": {
         "description": "Node information.",
         "properties": {
@@ -1452,6 +1547,23 @@
         ],
         "type": "object"
       },
+      "SourceShard": {
+        "description": "Replication shard with its metadata",
+        "properties": {
+          "replication_id": {
+            "description": "Replication id",
+            "readOnly": true,
+            "type": "string"
+          },
+          "replication_offset": {
+            "description": "Replication offset",
+            "format": "uint64",
+            "readOnly": true,
+            "type": "integer"
+          }
+        },
+        "type": "object"
+      },
       "StateMachine": {
         "description": "State machine information",
         "properties": {
@@ -2794,6 +2906,56 @@
         "x-stability-level": "stable"
       }
     },
+    "/v1/migrations/{uid}": {
+      "get": {
+        "description": "Migration status of a bdb in the cluster",
+        "operationId": "cluster_get_migration",
+        "parameters": [
+          {
+            "description": "The migration unique ID",
+            "example": 1,
+            "in": "path",
+            "name": "uid",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "x-go-type": "json.Number"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MigrationResponse"
+                }
+              }
+            },
+            "description": "migration information"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFound"
+          }
+        },
+        "security": [
+          {
+            "Auth": [
+              "view_bdb_info"
+            ]
+          }
+        ],
+        "summary": "Get migration status of a bdb in the cluster",
+        "tags": [
+          "Migrations"
+        ],
+        "x-publish-docs": true,
+        "x-stability-level": "stable"
+      }
+    },
     "/v1/ocsp": {
       "get": {
         "description": "Get the OCSP configuration for the cluster",