GIgitlab
ci_lint

Validate existing CI/CD configuration

Validates the .gitlab-ci.yml configuration for a specified project.

get/api/v4/projects/{id}/ci/lint

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID or URL-encoded path of the project

Query parameters

shastring

Deprecated: Use content_ref instead

content_refstring

The CI/CD configuration content is taken from this commit SHA, branch or tag. Defaults to the HEAD of the project's default branch

dry_runboolean

Run pipeline creation simulation, or only do static check. This is false by default

include_jobsboolean

If the list of jobs that would exist in a static check or pipeline simulation should be included in the response. This is false by default

refstring

Deprecated: Use dry_run_ref instead

dry_run_refstring

Branch or tag used as context when executing a dry run. Defaults to the default branch of the project. Only used when dry_run is true

Response

Validate existing CI/CD configuration

validboolean required
errorsstring[] required
warningsstring[] required
merged_yamlstring required
jobsobject[]

Example response

{
  "errors": [
    "variables config should be a hash of key value pairs"
  ],
  "warnings": [
    "jobs:job may allow multiple pipelines ..."
  ],
  "merged_yaml": "---\\n:another_test:\\n  :stage: test\\n\n          :script: echo 2\\n:test:\\n  :stage: test\\n  :script: echo 1\\n",
  "includes": [
    {
      "blob": "https://gitlab.com/root/example-project/-/blob/..."
    }
  ],
  "jobs": [
    {
      "name": "test",
      "script": [
        "ls"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 5 revisions of this API.