summaryrefslogtreecommitdiff
path: root/doc/api/pipelines.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/pipelines.md')
-rw-r--r--doc/api/pipelines.md24
1 files changed, 7 insertions, 17 deletions
diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md
index 497c70b19ba..57c356ccf29 100644
--- a/doc/api/pipelines.md
+++ b/doc/api/pipelines.md
@@ -1,10 +1,10 @@
---
stage: Verify
-group: Continuous Integration
+group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Pipelines API
+# Pipelines API **(FREE)**
## Single Pipeline Requests
@@ -23,8 +23,6 @@ Read more on [pagination](README.md#pagination).
## List project pipelines
-> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5837) in GitLab 8.11
-
```plaintext
GET /projects/:id/pipelines
```
@@ -77,8 +75,6 @@ Example of response
## Get a single pipeline
-> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5837) in GitLab 8.11
-
```plaintext
GET /projects/:id/pipelines/:pipeline_id
```
@@ -99,7 +95,7 @@ Example of response
"id": 46,
"project_id": 1,
"status": "success",
- "ref": "master",
+ "ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false,
@@ -213,8 +209,6 @@ Sample response:
## Create a new pipeline
-> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7209) in GitLab 8.14
-
```plaintext
POST /projects/:id/pipeline
```
@@ -226,7 +220,7 @@ POST /projects/:id/pipeline
| `variables` | array | no | An array containing the variables available in the pipeline, matching the structure `[{ 'key': 'UPLOAD_TO_S3', 'variable_type': 'file', 'value': 'true' }]` |
```shell
-curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipeline?ref=master"
+curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipeline?ref=main"
```
Example of response
@@ -236,7 +230,7 @@ Example of response
"id": 61,
"project_id": 1,
"sha": "384c444e840a515b23f21915ee5766b87068a70d",
- "ref": "master",
+ "ref": "main",
"status": "pending",
"before_sha": "0000000000000000000000000000000000000000",
"tag": false,
@@ -263,8 +257,6 @@ Example of response
## Retry jobs in a pipeline
-> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5837) in GitLab 8.11
-
```plaintext
POST /projects/:id/pipelines/:pipeline_id/retry
```
@@ -285,7 +277,7 @@ Response:
"id": 46,
"project_id": 1,
"status": "pending",
- "ref": "master",
+ "ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false,
@@ -312,8 +304,6 @@ Response:
## Cancel a pipeline's jobs
-> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5837) in GitLab 8.11
-
```plaintext
POST /projects/:id/pipelines/:pipeline_id/cancel
```
@@ -334,7 +324,7 @@ Response:
"id": 46,
"project_id": 1,
"status": "canceled",
- "ref": "master",
+ "ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false,