List all project pipelines

GET

/api/v4/projects/{id}/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.

Authorizations

http
oauth2

Parameters

Path Parameters

required

string

The project ID or URL-encoded path

Example

Query Parameters

page

integer

default: 1 nullable

Current page number

Example

per_page

integer

default: 20 nullable

Number of items per page

Example

scope

string

nullable

Allowed values: running pending finished branches tags

The scope of pipelines

Example

pending

status

string

nullable

Allowed values: created waiting_for_resource preparing waiting_for_callback pending running success failed canceling canceled skipped manual scheduled

The status of pipelines

Example

pending

ref

string

nullable

The ref of pipelines

Example

develop

sha

string

nullable

The sha of pipelines

Example

a91957a858320c0e17f3a0eca7cfacbff50ea29a

yaml_errors

boolean

nullable

Returns pipelines with invalid configurations

Example

false

username

string

nullable

The username of the user who triggered pipelines

Example

root

updated_before

string format: date-time

nullable

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

Example

2015-12-24T15:51:21.880Z

updated_after

string format: date-time

nullable

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

Example

2015-12-24T15:51:21.880Z

created_before

string format: date-time

nullable

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

Example

2015-12-24T15:51:21.880Z

created_after

string format: date-time

nullable

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

Example

2015-12-24T15:51:21.880Z

order_by

string

default: id nullable

Allowed values: id status ref updated_at user_id

Order pipelines

Example

status

sort

string

default: desc nullable

Allowed values: asc desc

Sort pipelines

Example

asc

source

string

nullable

Allowed values: 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

Example

push

name

string

nullable

Filter pipelines by name

Example

Build pipeline

Responses

200

application/json

object

integer format: int64

iid

integer

project_id

integer format: int64

sha

string

ref

string

status

string

source

string

created_at

string format: date-time

updated_at

string format: date-time

web_url

string

Example

{
  "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"
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found