GitLab CI jobs API

openapi: 3.2.0
info:
  title: GitLab REST CI jobs 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: CI jobs
  description: Use this API to interact with CI/CD jobs.
  x-displayName: CI jobs
  externalDocs:
    url: https://docs.gitlab.com/api/jobs/
paths:
  /api/v4/projects/{id}/jobs:
    get:
      operationId: getApiV4ProjectsIdJobs
      summary: List all jobs for a project
      description: Lists all jobs for a specified project. By default, this request returns 20 results at a time because the API results are paginated.
      tags:
      - CI jobs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesCiJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: scope
        required: false
        description: Filter jobs by status. Accepts a single value or an array of values. If omitted, returns all jobs.
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
            enum:
            - created
            - waiting_for_resource
            - preparing
            - waiting_for_callback
            - pending
            - running
            - success
            - failed
            - canceling
            - canceled
            - skipped
            - manual
            - scheduled
        in: query
        example:
        - pending
        - running
      - name: ref
        required: false
        description: Branch name (ref) to filter jobs by.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: feature-branch
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
  /api/v4/projects/{id}/jobs/{job_id}:
    get:
      operationId: getApiV4ProjectsIdJobsJobId
      summary: Retrieve a job
      description: Retrieves a job with the specified job ID.
      tags:
      - CI jobs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: job_id
        required: true
        description: ID of the job.
        schema:
          type: integer
        in: path
        example: 88
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
  /api/v4/projects/{id}/jobs/{job_id}/trace:
    get:
      operationId: getApiV4ProjectsIdJobsJobIdTrace
      summary: Get a trace of a specific job of a project
      description: Retrieves a log file for a job.
      tags:
      - CI jobs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: job_id
        required: true
        description: ID of the job.
        schema:
          type: integer
        in: path
        example: 88
      - name: byte_offset
        required: false
        description: Byte offset to start reading the trace from.
        schema:
          type:
          - integer
          - 'null'
          minimum: 0
        in: query
        example: 0
      - name: byte_limit
        required: false
        description: Maximum number of bytes to return.
        schema:
          type:
          - integer
          - 'null'
          minimum: 1
          maximum: 512000
        in: query
        example: 51200
  /api/v4/projects/{id}/jobs/{job_id}/cancel:
    post:
      operationId: postApiV4ProjectsIdJobsJobIdCancel
      summary: Cancel a job
      description: Cancels a specified job in a project.
      tags:
      - CI jobs
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too Many Requests
        '400':
          description: Bad Request
      parameters:
      - name: job_id
        required: true
        description: ID of the job.
        schema:
          type: integer
        in: path
        example: 88
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdJobsJobIdCancelRequest'
  /api/v4/projects/{id}/jobs/{job_id}/retry:
    post:
      operationId: postApiV4ProjectsIdJobsJobIdRetry
      summary: Retry a job
      description: Retries a specified job in a project.
      tags:
      - CI jobs
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too Many Requests
        '400':
          description: Bad Request
      parameters:
      - name: job_id
        required: true
        description: ID of the job.
        schema:
          type: integer
        in: path
        example: 88
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdJobsJobIdRetryRequest'
  /api/v4/projects/{id}/jobs/{job_id}/erase:
    post:
      operationId: postApiV4ProjectsIdJobsJobIdErase
      summary: Erase a job
      description: Erases a specified job in a project. This removes job artifacts and the job log.
      tags:
      - CI jobs
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Too Many Requests
        '400':
          description: Bad Request
      parameters:
      - name: job_id
        required: true
        description: ID of the job.
        schema:
          type: integer
        in: path
        example: 88
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
  /api/v4/projects/{id}/jobs/{job_id}/play:
    post:
      operationId: postApiV4ProjectsIdJobsJobIdPlay
      summary: Run a job
      description: Runs a specified job. For a job in manual status, triggers an action to start the job.
      tags:
      - CI jobs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiJobBasic'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too Many Requests
      parameters:
      - name: job_id
        required: true
        description: ID of the job.
        schema:
          type: integer
        in: path
        example: 88
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdJobsJobIdPlayRequest'
  /api/v4/job:
    get:
      operationId: getApiV4Job
      summary: Retrieve a job by job token
      description: Retrieves a job that was generated by a specified job token.
      tags:
      - CI jobs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiJob'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
components:
  schemas:
    APIEntitiesCommit:
      type: object
      properties:
        id:
          type: string
          example: 2695effb5807a22ff3d138d593fd856244e155e7
        short_id:
          type: string
          example: 2695effb
        created_at:
          type: string
          format: date-time
          example: '2017-07-26T11:08:53.000+02:00'
        parent_ids:
          type: array
          example:
          - 2a4b78934375d7f53875269ffd4f45fd83a84ebe
          items:
            type: string
        title:
          type: string
          example: Initial commit
        message:
          type: string
          example: Initial commit
        author_name:
          type: string
          example: John Smith
        author_email:
          type: string
          example: john@example.com
        authored_date:
          type: string
          format: date-time
          example: '2012-05-28T04:42:42-07:00'
        committer_name:
          type: string
          example: Jack Smith
        committer_email:
          type: string
          example: jack@example.com
        committed_date:
          type: string
          format: date-time
          example: '2012-05-28T04:42:42-07:00'
        trailers:
          type: object
          example:
            Merged-By: Jane Doe janedoe@gitlab.com
        extended_trailers:
          type: object
          example:
            Signed-off-by:
            - John Doe <johndoe@gitlab.com>
            - Jane Doe <janedoe@gitlab.com>
        web_url:
          type: string
          example: https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746
    APIEntitiesCiRunnerManager:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 8
        system_id:
          type: string
          example: runner-1
        version:
          type: string
          example: 16.11.0
        revision:
          type: string
          example: 91a27b2a
        platform:
          type: string
          example: linux
        architecture:
          type: string
          example: amd64
        created_at:
          type: string
          example: '2023-10-24T01:27:06.549Z'
        contacted_at:
          type: string
          example: '2023-10-24T01:27:06.549Z'
        ip_address:
          type: string
          example: 127.0.0.1
        status:
          type: string
          example: online
        job_execution_status:
          type: string
          enum:
          - active
          - idle
          example: idle
    postApiV4ProjectsIdJobsJobIdRetryRequest:
      type: object
      properties:
        inputs:
          type:
          - object
          - 'null'
          description: Input values for the job.
          example:
            environment: production
    APIEntitiesCustomAttribute:
      type: object
      properties:
        key:
          type: string
          example: foo
        value:
          type: string
          example: bar
    APIEntitiesCiRunner:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 8
        description:
          type: string
          example: test-1-20150125
        ip_address:
          type: string
          example: 127.0.0.1
        active:
          type: boolean
          example: true
        paused:
          type: boolean
          example: false
        is_shared:
          type: boolean
          example: true
        runner_type:
          type: string
          enum:
          - instance_type
          - group_type
          - project_type
          example: instance_type
        name:
          type: string
          example: test
        online:
          type: boolean
          example: true
        created_by:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        created_at:
          type: string
          format: date-time
          example: '2025-05-03T00:00:00.000Z'
        status:
          type: string
          example: online
        job_execution_status:
          type: string
          enum:
          - active
          - idle
          example: idle
    APIEntitiesCiJobArtifact:
      type: object
      properties:
        file_type:
          type: string
          enum:
          - archive
          - metadata
          - trace
          - junit
          - sast
          - dependency_scanning
          - container_scanning
          - dast
          - codequality
          - license_scanning
          - performance
          - metrics
          - metrics_referee
          - network_referee
          - lsif
          - dotenv
          - cobertura
          - terraform
          - accessibility
          - cluster_applications
          - secret_detection
          - requirements
          - coverage_fuzzing
          - browser_performance
          - load_performance
          - api_fuzzing
          - cluster_image_scanning
          - cyclonedx
          - requirements_v2
          - annotations
          - repository_xray
          - jacoco
          - sarif
          example: archive
        size:
          type: integer
          example: 1000
        filename:
          type: string
          example: artifacts.zip
        file_format:
          type: string
          enum:
          - raw
          - zip
          - gzip
          example: zip
    APIEntitiesCiJobArtifactFile:
      type: object
      properties:
        filename:
          type: string
          example: artifacts.zip
        size:
          type: integer
          example: 1000
    postApiV4ProjectsIdJobsJobIdCancelRequest:
      type: object
      properties:
        force:
          type:
          - boolean
          - 'null'
          description: If `true`, [forces cancellation](https://docs.gitlab.com/ci/jobs/#force-cancel-a-job) of a job in `canceling` state.
          example: true
    APIEntitiesCiJob:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        status:
          type: string
          example: waiting_for_resource
        stage:
          type: string
          example: deploy
        name:
          type: string
          example: deploy_to_production
        ref:
          type: string
          example: main
        tag:
          type: boolean
        coverage:
          type: number
          format: float
          example: 98.29
        allow_failure:
          type: boolean
        created_at:
          type: string
          format: date-time
          example: '2015-12-24T15:51:21.880Z'
        started_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:30.733Z'
        finished_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:31.198Z'
        erased_at:
          type: string
          format: date-time
          example: '2015-12-24T18:00:29.728Z'
        duration:
          type: number
          description: Time spent running
          format: float
          example: 0.465
        queued_duration:
          type: number
          description: Time spent enqueued
          format: float
          example: 0.123
        user:
          $ref: '#/components/schemas/APIEntitiesUser'
        commit:
          $ref: '#/components/schemas/APIEntitiesCommit'
        pipeline:
          $ref: '#/components/schemas/APIEntitiesCiPipelineBasic'
        failure_reason:
          type: string
          example: script_failure
        web_url:
          type: string
          example: https://example.com/foo/bar/-/jobs/1
        project:
          type: object
          properties:
            ci_job_token_scope_enabled:
              type: string
              example: false
        artifacts_file:
          $ref: '#/components/schemas/APIEntitiesCiJobArtifactFile'
        artifacts:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesCiJobArtifact'
        runner:
          $ref: '#/components/schemas/APIEntitiesCiRunner'
        runner_manager:
          $ref: '#/components/schemas/APIEntitiesCiRunnerManager'
        artifacts_expire_at:
          type: string
          format: date-time
          example: '2016-01-19T09:05:50.355Z'
        archived:
          type: boolean
          example: false
        tag_list:
          type: array
          example:
          - ubuntu18
          - docker runner
          items:
            type: string
    postApiV4ProjectsIdJobsJobIdPlayRequest:
      type: object
      properties:
        job_variables_attributes:
          type:
          - array
          - 'null'
          description: User-defined variables to include when running the job.
          items:
            type: object
            properties:
              key:
                type:
                - string
                - 'null'
                description: Name of the variable.
                example: foo
              value:
                type:
                - string
                - 'null'
                description: Value of the variable.
                example: bar
            required:
            - key
            - value
        job_inputs:
          type:
          - object
          - 'null'
          description: Hash of [job input](https://docs.gitlab.com/ci/jobs/job_inputs/) values to use when playing the job. [Introduced](https://gitlab.com/groups/gitlab-org/-/work_items/17833) in GitLab 18.10.
          example:
            environment: production
    APIEntitiesCiPipelineBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 2
        project_id:
          type: integer
          format: int64
          example: 3
        sha:
          type: string
          example: 0ec9e58fdfca6cdd6652c083c9edb53abc0bad52
        ref:
          type: string
          example: feature-branch
        status:
          type: string
          example: success
        source:
          type: string
          example: push
        created_at:
          type: string
          format: date-time
          example: '2022-10-21T16:49:48.000+02:00'
        updated_at:
          type: string
          format: date-time
          example: '2022-10-21T16:49:48.000+02:00'
        web_url:
          type: string
          example: https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61
    APIEntitiesCiJobBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        status:
          type: string
          example: waiting_for_resource
        stage:
          type: string
          example: deploy
        name:
          type: string
          example: deploy_to_production
        ref:
          type: string
          example: main
        tag:
          type: boolean
        coverage:
          type: number
          format: float
          example: 98.29
        allow_failure:
          type: boolean
        created_at:
          type: string
          format: date-time
          example: '2015-12-24T15:51:21.880Z'
        started_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:30.733Z'
        finished_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:31.198Z'
        erased_at:
          type: string
          format: date-time
          example: '2015-12-24T18:00:29.728Z'
        duration:
          type: number
          description: Time spent running
          format: float
          example: 0.465
        queued_duration:
          type: number
          description: Time spent enqueued
          format: float
          example: 0.123
        user:
          $ref: '#/components/schemas/APIEntitiesUser'
        commit:
          $ref: '#/components/schemas/APIEntitiesCommit'
        pipeline:
          $ref: '#/components/schemas/APIEntitiesCiPipelineBasic'
        failure_reason:
          type: string
          example: script_failure
        web_url:
          type: string
          example: https://example.com/foo/bar/-/jobs/1
        project:
          type: object
          properties:
            ci_job_token_scope_enabled:
              type: string
              example: false
    APIEntitiesUser:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        username:
          type: string
          example: admin
        public_email:
          type: string
          example: john@example.com
        name:
          type: string
          example: Administrator
        state:
          type: string
          example: active
        locked:
          type: boolean
        avatar_url:
          type: string
          example: https://gravatar.com/avatar/1
        avatar_path:
          type: string
          example: /user/avatar/28/The-Big-Lebowski-400-400.png
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        web_url:
          type: string
          example: https://gitlab.example.com/root
        created_at:
          type: string
        bio:
          type: string
        location:
          type: string
        linkedin:
          type: string
        twitter:
          type: string
        discord:
          type: string
        website_url:
          type: string
        github:
          type: string
        job_title:
          type: string
        pronouns:
          type: string
        organization:
          type: string
        bot:
          type: boolean
        work_information:
          type: string
        followers:
          type: string
        following:
          type: string
        is_followed:
          type: string
        local_time:
          type: string
    APIEntitiesUserBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        username:
          type: string
          example: admin
        public_email:
          type: string
          example: john@example.com
        name:
          type: string
          example: Administrator
        state:
          type: string
          example: active
        locked:
          type: boolean
        avatar_url:
          type: string
          example: https://gravatar.com/avatar/1
        avatar_path:
          type: string
          example: /user/avatar/28/The-Big-Lebowski-400-400.png
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        web_url:
          type: string
          example: https://gitlab.example.com/root
  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