GIgitlab
batched_background_migrations

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

Pause a batched background migration

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idinteger required

The batched background migration id

Request body

database'main' | 'ci' | 'sec' | 'embedding' | 'geo'

The name of the database

Response

Pause a batched background migration

idstring required
job_class_namestring required
table_namestring required
column_namestring required
statusstring required
progressnumber float required
created_atstring date-time required
estimated_time_remainingstring required

Example response

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

Changes

No recorded changes to this operation across all 5 revisions of this API.