List all pipelines triggered by a pipeline schedule

GET

/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/pipelines

• GitLab REST API

Lists all pipelines triggered by a pipeline schedule in a project.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

Example

18

pipeline_schedule_id

required

integer

The pipeline schedule ID

Example

13

Query Parameters

page

integer

default: 1 nullable

Current page number

Example

1

per_page

integer

default: 20 nullable

Number of items per page

Example

20

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

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

sort

string

default: asc nullable

Allowed values: asc desc

Sort pipelines

Example

desc

Responses

200

OK

Media type application/json

object

id

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