GitLab Sidekiq API

openapi: 3.2.0
info:
  title: GitLab REST Sidekiq API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Sidekiq
  description: '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.'
  x-displayName: Sidekiq
  externalDocs:
    url: https://docs.gitlab.com/api/sidekiq_metrics/
paths:
  /api/v4/sidekiq/queue_metrics:
    get:
      operationId: getApiV4SidekiqQueueMetrics
      summary: List all job queue metrics
      description: Lists all details about all Sidekiq job queues, including backlog size and latency.
      tags:
      - Sidekiq
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/v4/sidekiq/process_metrics:
    get:
      operationId: getApiV4SidekiqProcessMetrics
      summary: List all Sidekiq processes
      description: Lists all details about all registered Sidekiq worker processes, including hostname, process ID, queues, and concurrency settings.
      tags:
      - Sidekiq
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/v4/sidekiq/job_stats:
    get:
      operationId: getApiV4SidekiqJobStats
      summary: Retrieve job completion metrics
      description: Retrieves statistics on the completion status of all Sidekiq jobs.
      tags:
      - Sidekiq
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/v4/sidekiq/compound_metrics:
    get:
      operationId: getApiV4SidekiqCompoundMetrics
      summary: List all Sidekiq metrics
      description: Lists all Sidekiq metrics. Includes queue, process, and job completion metrics.
      tags:
      - Sidekiq
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/v4/admin/sidekiq/queues/{queue_name}:
    delete:
      operationId: deleteApiV4AdminSidekiqQueuesQueueName
      summary: Delete jobs from a Sidekiq queue
      description: Deletes jobs from a Sidekiq queue that match the specified metadata. At least one of 32 related parameters must be provided.
      tags:
      - Sidekiq
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: queue_name
        required: true
        description: Name of the queue to delete jobs from.
        schema:
          type: string
        in: path
      - name: organization_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: user
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: user_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: gl_user_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: scoped_user
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: scoped_user_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: project
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: root_namespace
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: gl_root_namespace_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: client_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: caller_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: remote_ip
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: job_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: pipeline_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: related_class
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: feature_category
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: artifact_size
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: artifact_used_cdn
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: artifacts_dependencies_size
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: artifacts_dependencies_count
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: root_caller_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: merge_action_status
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: bulk_import_entity_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: sidekiq_destination_shard_redis
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: kubernetes_agent_id
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: mvcc_manifest
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: client_type
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: client_name
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: client_version
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: subscription_plan
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: ai_resource
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: worker_class
        required: false
        description: Metadata key to match
        schema:
          type:
          - string
          - 'null'
        in: query
components:
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header