Admin Sidekiq queues API
Note: This feature was introduced in GitLab 12.9
Delete jobs from a Sidekiq queue that match the given metadata.
The response has three fields:
-
deleted_jobs
- the number of jobs deleted by the request. -
queue_size
- the remaining size of the queue after processing the request. -
completed
- whether or not the request was able to process the entire queue in time. If not, retrying with the same parameters may delete further jobs (including those added after the first request was issued).
This API endpoint is only available to admin users.
DELETE /admin/sidekiq/queues/:queue_name
Attribute | Type | Required | Description |
---|---|---|---|
queue_name
| string | yes | The name of the queue to delete jobs from |
user
| string | no | The username of the user who scheduled the jobs |
project
| string | no | The full path of the project where the jobs were scheduled from |
root_namespace
| string | no | The root namespace of the project |
subscription_plan
| string | no | The subscription plan of the root namespace (GitLab.com only) |
caller_id
| string | no | The endpoint or background job that schedule the job (for example: ProjectsController#create , /api/:version/projects/:id , PostReceive )
|
At least one attribute, other than queue_name
, is required.
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/admin/sidekiq/queues/authorized_projects?user=root
Example response:
{
"completed": true,
"deleted_jobs": 7,
"queue_size": 14
}
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc