Sidekiq

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

Name	Type	Description
`queue_name` Path, required	String	The Sidekiq queue name
`organization_id` Query	String	Metadata key to match
`user` Query	String	Metadata key to match
`user_id` Query	String	Metadata key to match
`gl_user_id` Query	String	Metadata key to match
`scoped_user` Query	String	Metadata key to match
`scoped_user_id` Query	String	Metadata key to match
`project` Query	String	Metadata key to match
`root_namespace` Query	String	Metadata key to match
`gl_root_namespace_id` Query	String	Metadata key to match
`client_id` Query	String	Metadata key to match
`caller_id` Query	String	Metadata key to match
`remote_ip` Query	String	Metadata key to match
`job_id` Query	String	Metadata key to match
`pipeline_id` Query	String	Metadata key to match
`related_class` Query	String	Metadata key to match
`feature_category` Query	String	Metadata key to match
`artifact_size` Query	String	Metadata key to match
`artifact_used_cdn` Query	String	Metadata key to match
`artifacts_dependencies_size` Query	String	Metadata key to match
`artifacts_dependencies_count` Query	String	Metadata key to match
`root_caller_id` Query	String	Metadata key to match
`merge_action_status` Query	String	Metadata key to match
`bulk_import_entity_id` Query	String	Metadata key to match
`sidekiq_destination_shard_redis` Query	String	Metadata key to match
`kubernetes_agent_id` Query	String	Metadata key to match
`mvcc_manifest` Query	String	Metadata key to match
`worker_class` Query	String	Metadata key to match

Responses

GET /api/v4/sidekiq/compound_metrics

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

Responses

GET /api/v4/sidekiq/job_stats

Retrieves statistics on the completion status of all Sidekiq jobs.

Responses

GET /api/v4/sidekiq/process_metrics

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

Responses

GET /api/v4/sidekiq/queue_metrics

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

Responses