diff options
author | Matija Čupić <matteeyah@gmail.com> | 2018-11-12 19:40:56 +0100 |
---|---|---|
committer | Matija Čupić <matteeyah@gmail.com> | 2018-11-12 19:46:32 +0100 |
commit | 22aa5c5594745fe0ea92716f12b4a001b934f5f1 (patch) | |
tree | 2144e8e14c0a2122d010e97920b216aeedaf8683 | |
parent | de1a3a3e18c452d0eeffafdc5e7a8a555ef582f3 (diff) | |
download | gitlab-ce-22aa5c5594745fe0ea92716f12b4a001b934f5f1.tar.gz |
Add docs for deleting a pipeline via API
-rw-r--r-- | doc/api/pipelines.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 574be52801c..c91875fd2db 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -93,6 +93,23 @@ Example of response } ``` +## Delete a pipeline + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/22988) in GitLab 11.6 + +``` +DELETE /projects/:id/pipelines/:pipeline_id +``` + +| Attribute | Type | Required | Description | +|------------|---------|----------|---------------------| +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `pipeline_id` | integer | yes | The ID of a pipeline | + +``` +curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --request "DELETE" "https://gitlab.example.com/api/v4/projects/1/pipelines/46" +``` + ## Create a new pipeline > [Introduced][ce-7209] in GitLab 8.14 |