Pause a batched background migration

PUT /admin/batched_background_migrations/{id}/pause

Pause a batched background migration

Path parameters

  • id integer(int32) Required

    The batched background migration id

application/json

Body

  • database string

    The name of the database

    Values are main, ci, embedding, main_clusterwide, or geo. Default value is main.

Responses

  • 200 application/json

    Pause a batched background migration

    Hide response attributes Show response attributes object
    • id string
    • job_class_name string
    • table_name string
    • status string
    • progress number(float)
    • created_at string(date-time)
  • 401

    401 Unauthorized

  • 403

    403 Forbidden

  • 404

    404 Not found

  • 422

    You can pause only active batched background migrations.

PUT /admin/batched_background_migrations/{id}/pause
curl \
 --request PUT 'https://www.gitlab.com/api/v4/admin/batched_background_migrations/{id}/pause' \
 --header "Private-Token: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"database":"main"}'
Request examples
{
  "database": "main"
}
Response examples (200)
{
  "id": "1234",
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "status": "active",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00"
}