diff options
| author | Ido Leibovich <ileibovich@yotpo.com> | 2016-10-31 22:38:24 +0200 |
|---|---|---|
| committer | Ido Leibovich <ileibovich@yotpo.com> | 2016-11-18 23:12:21 +0200 |
| commit | fbfc7523cb0119ac3a0d02cd04dc12e453ad3ad6 (patch) | |
| tree | 1b34fee3275f5e14eec71452628252384876c352 /doc/api/pipelines.md | |
| parent | 75c8faf7ba76563a175766495e132b2f6bdc95d4 (diff) | |
| download | gitlab-ce-fbfc7523cb0119ac3a0d02cd04dc12e453ad3ad6.tar.gz | |
Add api endpoint for creating a pipeline
Add a new endpoint in the new API for creating a new pipeline, and return the details of that pipeline.
Diffstat (limited to 'doc/api/pipelines.md')
| -rw-r--r-- | doc/api/pipelines.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index a29b3eb6f44..6455c333faf 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -114,6 +114,51 @@ Example of response } ``` +## Create a new pipeline + +> [Introduced][ce-7209] in GitLab 8.14 + +``` +POST /projects/:id/pipeline +``` + +| Attribute | Type | Required | Description | +|------------|---------|----------|---------------------| +| `id` | integer | yes | The ID of a project | +| `ref` | string | yes | Reference to commit | + +``` +curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/pipeline?ref=master" +``` + +Example of response + +```json +{ + "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 +} +``` + ## Retry failed builds in a pipeline > [Introduced][ce-5837] in GitLab 8.11 @@ -205,3 +250,4 @@ Response: ``` [ce-5837]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5837 +[ce-7209]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7209 |