Stop a batched background operation

PUT

/api/v4/admin/batched_background_operations/{id}/stop

• GitLab REST API

This feature was introduced in GitLab 19.2.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

integer

The batched background operation 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

partition

integer

job_class_name

string

table_name

string

column_name

string

status

string

created_at

string format: date-time

started_at

string format: date-time

finished_at

string format: date-time

on_hold_until

string format: date-time

Example

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

400

Bad Request

401

401 Unauthorized

403

403 Forbidden

404

404 Not found

422

You can stop only queued, active or paused operations.