GitLab CI lint API

openapi: 3.2.0
info:
  title: GitLab REST CI lint 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 lint
  description: 'Use this API to validate a GitLab CI/CD configuration.


    These endpoints take JSON-encoded YAML content. To preserve the formatting of your CI/CD

    configuration, it can help to escape and encode the YAML with a third-party tool such as

    `jq` before you make the request.'
  x-displayName: CI lint
  externalDocs:
    url: https://docs.gitlab.com/api/lint/
paths:
  /api/v4/projects/{id}/ci/lint:
    get:
      operationId: getApiV4ProjectsIdCiLint
      summary: Validate existing CI/CD configuration
      description: Validates the `.gitlab-ci.yml` configuration for a specified project.
      tags:
      - CI lint
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiLintResult'
        '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: sha
        required: false
        description: Commit SHA, branch, or tag that the CI/CD configuration content is taken from. Defaults to the head of the project's default branch. Deprecated. Use `content_ref` instead. Mutually exclusive with `content_ref`.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: content_ref
        required: false
        description: Commit SHA, branch, or tag that the CI/CD configuration content is taken from. Defaults to the head of the project's default branch. Mutually exclusive with `sha`.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: dry_run
        required: false
        description: If `true`, runs a [pipeline creation simulation](https://docs.gitlab.com/ci/yaml/lint/#simulate-a-pipeline). If `false`, runs only a static check.
        schema:
          type: boolean
          default: false
        in: query
      - name: include_jobs
        required: false
        description: If `true`, includes the list of jobs that would exist in a static check or pipeline simulation.
        schema:
          type:
          - boolean
          - 'null'
        in: query
      - name: ref
        required: false
        description: If `dry_run` is `true`, sets the branch or tag to use to validate the CI/CD YAML configuration. Defaults to the project's default branch. Deprecated. Use `dry_run_ref` instead. Mutually exclusive with `dry_run_ref`.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: dry_run_ref
        required: false
        description: If `dry_run` is `true`, sets the branch or tag to use to validate the CI/CD YAML configuration. Defaults to the project's default branch. Mutually exclusive with `ref`.
        schema:
          type:
          - string
          - 'null'
        in: query
    post:
      operationId: postApiV4ProjectsIdCiLint
      summary: Validate a CI/CD configuration
      description: Validates a provided CI/CD configuration in the context of a specified project.
      tags:
      - CI lint
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiLintResult'
        '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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdCiLintRequest'
components:
  schemas:
    APIEntitiesCiLintResult:
      type: object
      properties:
        valid:
          type: boolean
        errors:
          type: array
          example:
          - variables config should be a hash of key value pairs
          items:
            type: string
        warnings:
          type: array
          example:
          - jobs:job may allow multiple pipelines ...
          items:
            type: string
        merged_yaml:
          type: string
          example: "---\\n:another_test:\\n  :stage: test\\n\n          :script: echo 2\\n:test:\\n  :stage: test\\n  :script: echo 1\\n"
        includes:
          type: array
          example:
          - blob: https://gitlab.com/root/example-project/-/blob/...
          items:
            $ref: '#/components/schemas/APIEntitiesCiLintResultInclude'
        jobs:
          type: array
          example:
          - name: test
            script:
            - ls
          items:
            type: object
    APIEntitiesCiLintResultInclude:
      type: object
      properties:
        type:
          type: string
          example: local
        location:
          type: string
          example: .gitlab/ci/build-images.gitlab-ci.yml
        blob:
          type: string
          example: https://gitlab.com/gitlab-org/gitlab/-/blob/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml
        raw:
          type: string
          example: https://gitlab.com/gitlab-org/gitlab/-/raw/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml
        extra:
          type: object
          example:
            job_name: test
            project: gitlab-org/gitlab
            ref: master
        context_project:
          type: string
          example: gitlab-org/gitlab
        context_sha:
          type: string
          example: e52d6d0246d7375291850e61f0abc101fbda9dc2
    postApiV4ProjectsIdCiLintRequest:
      type: object
      properties:
        content:
          type:
          - string
          - 'null'
          description: CI/CD configuration content.
        dry_run:
          type: boolean
          description: If `true`, runs a [pipeline creation simulation](https://docs.gitlab.com/ci/yaml/lint/#simulate-a-pipeline). If `false`, runs only a static check.
          default: false
        include_jobs:
          type:
          - boolean
          - 'null'
          description: If `true`, includes the list of jobs that would exist in a static check or pipeline simulation.
        ref:
          type:
          - string
          - 'null'
          description: If `dry_run` is `true`, sets the branch or tag to use to validate the CI/CD YAML configuration. Defaults to the project's default branch.
      required:
      - content
  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