Retrieve a batched background migration

GET /admin/batched_background_migrations/{id}

Api key auth

Path parameters

id integer(int32) Required

The batched background migration id

Query parameters

database string

The name of the database

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

Responses

200 application/json

Retrieve 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

GET /admin/batched_background_migrations/{id}

curl \
 --request GET 'https://www.gitlab.com/api/v4/admin/batched_background_migrations/{id}' \
 --header "Private-Token: $API_KEY"

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