GIgitlab
pipelines

List all project pipelines

Lists all pipelines in a project. By default, child pipelines are not included in the results. To return child pipelines, set source to parent_pipeline.

get/api/v4/projects/{id}/pipelines

Request

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

Path parameters

idstring required

The project ID or URL-encoded path

Query parameters

pageinteger

Current page number

per_pageinteger

Number of items per page

scope'running' | 'pending' | 'finished' | 'branches' | 'tags'

The scope of pipelines

status'created' | 'waiting_for_resource' | 'preparing' | 'waiting_for_callback' | 'pending' | 'running' | 'success' | 'failed' | 'canceling' | 'canceled' | 'skipped' | 'manual' | 'scheduled'

The status of pipelines

refstring

The ref of pipelines

shastring

The sha of pipelines

yaml_errorsboolean

Returns pipelines with invalid configurations

usernamestring

The username of the user who triggered pipelines

updated_beforestring date-time

Return pipelines updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

updated_afterstring date-time

Return pipelines updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

created_beforestring date-time

Return pipelines created before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

created_afterstring date-time

Return pipelines created after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

order_by'id' | 'status' | 'ref' | 'updated_at' | 'user_id'

Order pipelines

sort'asc' | 'desc'

Sort pipelines

source'unknown' | 'push' | 'web' | 'trigger' | 'schedule' | 'api' | 'external' | 'pipeline' | 'chat' | 'webide' | 'merge_request_event' | 'external_pull_request_event' | 'parent_pipeline' | 'ondemand_dast_scan' | 'ondemand_dast_validation' | 'security_orchestration_policy' | 'container_registry_push' | 'duo_workflow' | 'pipeline_execution_policy_schedule' | 'dependency_management_security_update'

The source of pipelines

namestring

Filter pipelines by name

Response

List all project pipelines

idinteger required
iidinteger required
project_idinteger required
shastring required
refstring required
statusstring required
sourcestring required
created_atstring date-time required
updated_atstring date-time required
web_urlstring required

Example response

[
  {
    "id": 1,
    "iid": 2,
    "project_id": 3,
    "sha": "0ec9e58fdfca6cdd6652c083c9edb53abc0bad52",
    "ref": "feature-branch",
    "status": "success",
    "source": "push",
    "created_at": "2022-10-21T16:49:48.000+02:00",
    "updated_at": "2022-10-21T16:49:48.000+02:00",
    "web_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61"
  }
]

Changes

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