diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-10-07 21:08:34 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-10-07 21:08:34 +0300 |
| commit | 1850d48925997ccc467fe0cbe6144d1d67fbdb55 (patch) | |
| tree | 1c2081b4f9b986e9017761db5b6915ff3db8de79 /doc/api/runners.md | |
| parent | 1d3a583ac1d4affb8871a76121815b1c104ef93a (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/runners.md')
| -rw-r--r-- | doc/api/runners.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/api/runners.md b/doc/api/runners.md index 55dcf1dc3ee..778ec406622 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -271,6 +271,22 @@ Example response: } ``` +### Pause a runner + +Pause a specific runner. + +```plaintext +PUT --form "active=false" /runners/:runner_id +``` + +| Attribute | Type | Required | Description | +|-------------|---------|----------|---------------------| +| `runner_id` | integer | yes | The ID of a runner | + +```shell +curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "active=false" "https://gitlab.example.com/api/v4/runners/6" +``` + ## List runner's jobs > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15432) in GitLab 10.3. |