Skip to content

Get the list of batched background migrations

GET
/api/v4/admin/batched_background_migrations
database
string
default: main nullable
Allowed values: main ci sec embedding geo

The name of the database, the default main

job_class_name
string
nullable

Filter migrations by job class name.

OK

Media type application/json
object
id
string
job_class_name
string
table_name
string
column_name
string
status
string
progress
number
created_at
string format: date-time
estimated_time_remaining
string
Example
{
"id": "1234",
"job_class_name": "CopyColumnUsingBackgroundMigrationJob",
"table_name": "events",
"column_name": "id",
"status": "active",
"progress": 50,
"created_at": "2022-11-28T16:26:39+02:00",
"estimated_time_remaining": "1 day"
}

Bad Request

401 Unauthorized

403 Forbidden