For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

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.

Last updated

Was this helpful?