Pause a batched background migration

PUT

/api/v4/admin/batched_background_migrations/{id}/pause

• GitLab REST API

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

integer

The batched background migration id

Request Body

Media type application/json

object

database

The name of the database

string

default: main nullable

Allowed values: main ci sec embedding geo

Responses

200

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"
}

400

Bad Request

401

401 Unauthorized

403

403 Forbidden

404

404 Not found

422

You can pause only active batched background migrations.