GitLab API

GitlabTool

Actions1095

Ci_lint → getApiV4ProjectsIdCiLint

AI-generated

Summary

Runs GitLab’s CI lint endpoint for a project to check its CI/CD configuration, with optional pipeline simulation and job details. The project ID is required; query parameters select the configuration ref and lint behavior.

Inputs

  • id (required) — Project ID used in the endpoint path.
  • content_ref — Commit SHA, branch, or tag whose CI/CD configuration to check; defaults to the project’s default branch HEAD.
  • sha — Deprecated alternative for content_ref.
  • dry_run — Whether to simulate pipeline creation; defaults to false, which performs only a static check.
  • dry_run_ref — Branch or tag used as context for a dry run; only applies when dry_run is true and defaults to the project’s default branch.
  • include_jobs — Whether to include the jobs that would exist in the static check or pipeline simulation; defaults to false.
  • ref — Deprecated alternative for dry_run_ref.
  • Authentication — GitLab API credentials are used unless Skip Authentication is enabled.
  • Skip Authentication — Defaults to false; when enabled, skips credential authentication.

Output shape

A single response object from the GitLab CI lint endpoint.

The response fields depend on GitLab’s result for the supplied configuration and options. The node’s source delegates request handling to its OpenAPI tool base class.

Links

Discussion