{
  "id": "migrations",
  "title": "Migrations requests",
  "url": "https://redis.io/docs/latest/operate/rs/8.0/references/rest-api/requests/migrations/",
  "summary": "REST API request to get the migration status of a database in the cluster when using Replica Of.",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-migrations) | `/v1/migrations/\u003cuid\u003e` | Get database migration status |\n\n## Get migration status {#get-migrations}\n\n```sh\nGET /v1/migrations/\u003cuid\u003e\n```\n\nGets the migration status of a database in the cluster when using Replica Of.\n\n#### Required permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [view_bdb_info](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#view_bdb_info) | admin\u003cbr /\u003ecluster_member\u003cbr /\u003ecluster_viewer\u003cbr /\u003edb_member\u003cbr /\u003edb_viewer\u003cbr /\u003euser_manager |\n\n### Request {#get-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/migrations/1\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| uid | integer | The database's unique ID |\n\n### Response {#get-response}\n\nReturns a JSON array with all data required by the migration orchestrator.\n\n#### Example response body\n\n```json\n{\n  \"migration\": {\n    \"status\": \"string\",\n    \"lag\": 0,\n    \"rdb_size\": 0,\n    \"rdb_transferred\": 0,\n    \"run_id\": \"string\",\n    \"flush_counter\": 0,\n    \"source_shards\": [\n      {\n        \"replication_id\": \"string\",\n        \"replication_offset\": 0\n      }\n    ],\n    \"error\": {\n      \"error_code\": \"string\",\n      \"message\": \"string\",\n      \"timestamp\": \"2019-08-24T14:15:22Z\"\n    }\n  }\n}\n```\n\n#### Status codes {#get-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error |\n| [404 Not Found](https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found) | Database does not exist |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-07-23T12:05:56-05:00",
  "children": []
}