Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-02-04 12:08:32 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2020-02-04 12:08:32 +0300
commit7d19df2d34a9803d9f077c16315ba919b7ae2aa2 (patch)
tree80a824f477c1b450a1f082576a00d6851f3c6582 /doc/api/pipeline_schedules.md
parentcebee31a0483ef7f2cade3d6dde0a53a68e86cc6 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/pipeline_schedules.md')
-rw-r--r--doc/api/pipeline_schedules.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/api/pipeline_schedules.md b/doc/api/pipeline_schedules.md
index f859a01cd37..3624921fde7 100644
--- a/doc/api/pipeline_schedules.md
+++ b/doc/api/pipeline_schedules.md
@@ -279,6 +279,36 @@ curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gi
}
```
+## Run a scheduled pipeline immediately
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/201786) in GitLab 12.8.
+
+Trigger a new scheduled pipeline, which runs immediately. The next scheduled run
+of this pipeline is not affected.
+
+```text
+POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/play
+```
+
+| 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_schedule_id` | integer | yes | The pipeline schedule id |
+
+Example request:
+
+```sh
+curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/42/pipeline_schedules/1/play
+```
+
+Example response:
+
+```json
+{
+ "message": "201 Created"
+}
+```
+
## Pipeline schedule variables
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/34518) in GitLab 10.0.