diff options
| author | Alexis Reigel <alexis.reigel.ext@siemens.com> | 2018-06-11 15:25:00 +0200 |
|---|---|---|
| committer | Alexis Reigel <alexis.reigel.ext@siemens.com> | 2018-09-15 21:39:26 +0200 |
| commit | 641012c6383a1facf79b1c57a7163cb519b477de (patch) | |
| tree | 8ad147e9db7bc7bad16a510b27ea32b24c278e23 | |
| parent | 82546888e81488ba7b2a60a970a1cc31febcc1e9 (diff) | |
| download | gitlab-ce-641012c6383a1facf79b1c57a7163cb519b477de.tar.gz | |
add missing params to runners api doc
| -rw-r--r-- | doc/api/runners.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/api/runners.md b/doc/api/runners.md index 7a67b648b07..54568607a87 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -344,11 +344,17 @@ usage is enabled in the project's settings. ``` GET /projects/:id/runners +GET /projects/:id/runners?scope=active +GET /projects/:id/runners?type=project_type +GET /projects/:id/runners?status=active ``` -| Attribute | Type | Required | Description | -|-----------|---------|----------|---------------------| +| 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 | +| `scope` | string | no | The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided | +| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | +| `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | ``` curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/9/runners" |