Use this API to retrieve information about the current state of Sidekiq, including its jobs, queues, and processes, and to delete jobs from a queue.

Delete jobs from a Sidekiq queue

DELETE /api/v4/admin/sidekiq/queues/{queue_name}

Deletes jobs from a Sidekiq queue that match the specified metadata.

Parameters

NameTypeDescription
queue_name
Path, required		StringName of the queue to delete jobs from
organization_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
user
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
user_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
gl_user_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
scoped_user
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
scoped_user_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
project
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
root_namespace
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
gl_root_namespace_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
client_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
caller_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
remote_ip
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
job_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
pipeline_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
related_class
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
feature_category
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
artifact_size
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
artifact_used_cdn
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
artifacts_dependencies_size
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
artifacts_dependencies_count
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
root_caller_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
merge_action_status
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
bulk_import_entity_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
sidekiq_destination_shard_redis
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
kubernetes_agent_id
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
mvcc_manifest
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
client_type
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
client_name
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
client_version
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided
worker_class
Query		StringMetadata key to match. At least one of organization_id, user, user_id, gl_user_id, scoped_user, scoped_user_id, project, root_namespace, gl_root_namespace_id, client_id, caller_id, remote_ip, job_id, pipeline_id, related_class, feature_category, artifact_size, artifact_used_cdn, artifacts_dependencies_size, artifacts_dependencies_count, root_caller_id, merge_action_status, bulk_import_entity_id, sidekiq_destination_shard_redis, kubernetes_agent_id, mvcc_manifest, client_type, client_name, client_version, worker_class must be provided

Responses

CodeDescriptionSchema
204No Content—
400Bad Request—
404Not Found—

List all Sidekiq metrics

GET /api/v4/sidekiq/compound_metrics

Lists all Sidekiq metrics. Includes queue, process, and job completion metrics.

Responses

CodeDescriptionSchema
200OK—
401Unauthorized—
403Forbidden—

Retrieve job completion metrics

GET /api/v4/sidekiq/job_stats

Retrieves statistics on the completion status of all Sidekiq jobs.

Responses

CodeDescriptionSchema
200OK—
401Unauthorized—
403Forbidden—

List all Sidekiq processes

GET /api/v4/sidekiq/process_metrics

Lists all details about all registered Sidekiq worker processes, including hostname, process ID, queues, and concurrency settings.

Responses

CodeDescriptionSchema
200OK—
401Unauthorized—
403Forbidden—

List all job queue metrics

GET /api/v4/sidekiq/queue_metrics

Lists all details about all Sidekiq job queues, including backlog size and latency.

Responses

CodeDescriptionSchema
200OK—
401Unauthorized—
403Forbidden—
←
REST API / Service accounts
REST API / Snippets
→