Skip to main content
POST
List Migrations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to list migrations with filters.

status
enum<string> | null

Filter by status

Available options:
draft,
validating,
pending,
in_progress,
completed,
failed,
cancelled
migration_type
enum<string> | null

Filter by type

Available options:
re_extract,
copy,
extend
source_namespace_id
string | null

Filter by source namespace

limit
integer
default:20

Maximum results

Required range: 1 <= x <= 1000
offset
integer
default:0

Result offset for pagination

Required range: x >= 0

Response

Successful Response

Response for listing migrations.

results
GetMigrationResponse · object[]
required

List of migrations

total
integer
required

Total count matching filters

limit
integer
required

Results limit

offset
integer
required

Results offset