Pipelines API

List project pipelines

Introducedin GitLab 8.11

GET /projects/:id/pipelines

Attribute	Type	Required	Description
id	integer/string	yes	The ID orURL-encoded path of the projectowned by the authenticated user
scope	string	no	之一,管道的范围:running,pending,finished,branches,tags
status	string	no	The status of pipelines, one of:running,pending,success,failed,canceled,skipped
ref	string	no	The ref of pipelines
sha	string	no	The sha or pipelines
yaml_errors	boolean	no	Returns pipelines with invalid configurations
name	string	no	The name of the user who triggered pipelines
username	string	no	The username of the user who triggered pipelines
order_by	string	no	Order pipelines byid,status,ref, oruser_id(default:id)
sort	string	no	Sort pipelines inascordescorder (default:desc)

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines"

Example of response

[{"id":47,"status":"pending",“ref”:"new-pipeline","sha":"a91957a858320c0e17f3a0eca7cfacbff50ea29a"},{"id":48,"status":"pending",“ref”:"new-pipeline","sha":"eb94b618fb5865b26e80fdd8ae531b7a63ad851a"}]

Get a single pipeline

Introducedin GitLab 8.11

GET /projects/:id/pipelines/:pipeline_id

Attribute	Type	Required	Description
id	integer/string	yes	The ID orURL-encoded path of the projectowned by the authenticated user
pipeline_id	integer	yes	The ID of a pipeline

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines/46"

Example of response

{"id":46,"status":"success",“ref”:"master","sha":"a91957a858320c0e17f3a0eca7cfacbff50ea29a",“before_sha”:"a91957a858320c0e17f3a0eca7cfacbff50ea29a","tag":false,"yaml_errors":null,"user":{"name":"Administrator","username":"root","id":1,"state":"active","avatar_url":"http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","web_url":"http://localhost:3000/root"},"created_at":"2016-08-11T11:28:34.085Z","updated_at":"2016-08-11T11:32:35.169Z","started_at":null,"finished_at":"2016-08-11T11:32:35.145Z","committed_at":null,"duration":null,"coverage":"30.0"}

Create a new pipeline

Introducedin GitLab 8.14

POST /projects/:id/pipeline

Attribute	Type	Required	Description
id	integer/string	yes	The ID orURL-encoded path of the projectowned by the authenticated user
ref	string	yes	Reference to commit

curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipeline?ref=master"

Example of response

{"id":61,"sha":"384c444e840a515b23f21915ee5766b87068a70d",“ref”:"master","status":"pending",“before_sha”:"0000000000000000000000000000000000000000","tag":false,"yaml_errors":null,"user":{"name":"Administrator","username":"root","id":1,"state":"active","avatar_url":"http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","web_url":"http://localhost:3000/root"},"created_at":"2016-11-04T09:36:13.747Z","updated_at":"2016-11-04T09:36:13.977Z","started_at":null,"finished_at":null,"committed_at":null,"duration":null,"coverage":null}

Retry jobs in a pipeline

Introducedin GitLab 8.11

POST /projects/:id/pipelines/:pipeline_id/retry

Attribute	Type	Required	Description
id	integer/string	yes	The ID orURL-encoded path of the projectowned by the authenticated user
pipeline_id	integer	yes	The ID of a pipeline

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines/46/retry"

Response:

{"id":46,"status":"pending",“ref”:"master","sha":"a91957a858320c0e17f3a0eca7cfacbff50ea29a",“before_sha”:"a91957a858320c0e17f3a0eca7cfacbff50ea29a","tag":false,"yaml_errors":null,"user":{"name":"Administrator","username":"root","id":1,"state":"active","avatar_url":"http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","web_url":"http://localhost:3000/root"},"created_at":"2016-08-11T11:28:34.085Z","updated_at":"2016-08-11T11:32:35.169Z","started_at":null,"finished_at":"2016-08-11T11:32:35.145Z","committed_at":null,"duration":null,"coverage":null}

Cancel a pipelines jobs

Introducedin GitLab 8.11

POST /projects/:id/pipelines/:pipeline_id/cancel

Attribute	Type	Required	Description
id	integer/string	yes	The ID orURL-encoded path of the projectowned by the authenticated user
pipeline_id	integer	yes	The ID of a pipeline

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines/46/cancel"

Response:

{"id":46,"status":"canceled",“ref”:"master","sha":"a91957a858320c0e17f3a0eca7cfacbff50ea29a",“before_sha”:"a91957a858320c0e17f3a0eca7cfacbff50ea29a","tag":false,"yaml_errors":null,"user":{"name":"Administrator","username":"root","id":1,"state":"active","avatar_url":"http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","web_url":"http://localhost:3000/root"},"created_at":"2016-08-11T11:28:34.085Z","updated_at":"2016-08-11T11:32:35.169Z","started_at":null,"finished_at":"2016-08-11T11:32:35.145Z","committed_at":null,"duration":null,"coverage":null}