> For the complete documentation index, see [llms.txt](https://docs.warpstream.com/warpstream/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.warpstream.com/warpstream/reference/api-reference/orbit-auto-migration/status.md).

# Status

Query the migration status of auto-migration topics.

```
POST /api/v1/orbit_topic_auto_migration_status
```

Returns the current migration state for every auto-migration topic in the cluster. This is the same data shown in the **Migration** tab of the WarpStream console. Read-only: accepts **admin**, **app**, **agent**, and **read-only** API keys scoped to the target virtual cluster.

### Request

| Parameter            | Type   | Required | Default | Description                                                         |
| -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `virtual_cluster_id` | string | Yes      | —       | Target virtual cluster, e.g. `vci_...`. Must be a well-formed VCID. |

#### Example

```bash
curl -X POST https://api.warpstream.com/api/v1/orbit_topic_auto_migration_status \
  -H "Authorization: Bearer <api-key>" -H "Content-Type: application/json" \
  -d '{ "virtual_cluster_id": "vci_..." }'
```

### Response

A `topics` array; each entry describes one topic:

| Field                | Type   | Description                                                               |
| -------------------- | ------ | ------------------------------------------------------------------------- |
| `name`               | string | Topic name.                                                               |
| `migration_state`    | string | One of `PROXY`, `MIGRATING`, `COMPLETE`                                   |
| `total_offset_lag`   | int    | Aggregate offset lag across partitions (zero once the topic is complete). |
| `time_lag_nanos`     | int    | Time lag in nanoseconds (max across partitions).                          |
| `initiated_at_unix`  | int    | Unix timestamp of the most recent initiation.                             |
| `completed_at_unix`  | int    | Unix timestamp when the topic reached `COMPLETE` state, if applicable.    |
| `has_lag`            | bool   | Whether the topic currently has measurable lag.                           |
| `migration_attempts` | int    | Number of times migration has been initiated for this topic.              |

```json
{
  "topics": [
    {
      "name": "orders-eu",
      "migration_state": "MIGRATING",
      "total_offset_lag": 1280,
      "time_lag_nanos": 4200000000,
      "initiated_at_unix": 1733155200,
      "completed_at_unix": 0,
      "has_lag": true,
      "migration_attempts": 1
    }
  ]
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.warpstream.com/warpstream/reference/api-reference/orbit-auto-migration/status.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.