GitLab API

GitlabTool

Actions1095

Projects → getApiV4ProjectsIdPipelines

AI-generated

Summary

Retrieve a list of pipelines for a specified GitLab project, optionally filtered and paginated by various query parameters.

Inputs

  • id (required) — The project ID or URL-encoded path to identify the GitLab project for which to list pipelines.
  • page — The page number of results to retrieve (pagination).
  • per_page — Number of pipeline items to return per page (pagination).
  • scope — Filter pipelines by scope such as running, pending, finished, branches, or tags.
  • status — Filter pipelines by status, e.g., running, success, failed, canceled, manual, or scheduled.
  • ref — Filter pipelines by Git reference name (branch or tag).
  • sha — Filter pipelines by commit SHA hash.
  • yaml_errors — Return only pipelines with invalid configuration (YAML errors) if true.
  • username — Filter pipelines triggered by a specific username.
  • updated_before — Return pipelines updated before this ISO 8601 datetime.
  • updated_after — Return pipelines updated after this ISO 8601 datetime.
  • order_by — Order pipelines by specified field, e.g., id, status, ref, updated_at, or user_id.
  • sort — Sort direction for results, ascending or descending.
  • source — Filter pipelines by source event type, e.g., push, web, trigger.
  • name — Filter pipelines by name.

Output shape

a list of pipeline objects for the given project matching the optional filters and pagination settings

The operation supports pagination through 'page' and 'per_page' query parameters. Filters like scope, status, ref, sha, updated_before, and updated_after refine the returned pipelines. Returned data depends on GitLab API v4 pipeline object schema.

Links

Discussion