GIgitlab
batched_background_operations

Restart a batched background operation

This feature was introduced in GitLab 19.2.

put/api/v4/admin/batched_background_operations/{id}/restart

Request

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

Path parameters

idinteger required

The batched background operation id

Request body

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

The name of the database

Response

Restart a batched background operation

idstring required
partitioninteger required
job_class_namestring required
table_namestring required
column_namestring required
statusstring required
created_atstring date-time required
started_atstring date-time required
finished_atstring date-time required
on_hold_untilstring date-time required

Example response

{
  "id": "<cluster>:<partition_id>:<id/uuid>",
  "partition": 1,
  "job_class_name": "UsersDeleteUnconfirmedSecondaryEmails",
  "table_name": "users",
  "column_name": "id",
  "status": "active",
  "created_at": "2025-05-15T10:00:00Z",
  "started_at": "2025-05-15T10:05:00Z",
  "finished_at": "2025-05-15T11:00:00Z",
  "on_hold_until": "2025-05-15T10:15:00Z"
}

Changes

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