summaryrefslogtreecommitdiff
path: root/doc/api/runners.md
diff options
context:
space:
mode:
authorAlexis Reigel <alexis.reigel.ext@siemens.com>2018-06-11 13:37:47 +0200
committerAlexis Reigel <alexis.reigel.ext@siemens.com>2018-09-15 21:39:26 +0200
commit4b6619cfd3ca127d728d7277cac3da8ed54b99b0 (patch)
treeb590ee77d626f085443ffd9ea3b08c03078e5448 /doc/api/runners.md
parent65caacc600bc0a507a313e8be45021512260906e (diff)
downloadgitlab-ce-4b6619cfd3ca127d728d7277cac3da8ed54b99b0.tar.gz
add type param to runners api
Diffstat (limited to 'doc/api/runners.md')
-rw-r--r--doc/api/runners.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/runners.md b/doc/api/runners.md
index 66476e7db64..7763e6b2913 100644
--- a/doc/api/runners.md
+++ b/doc/api/runners.md
@@ -11,11 +11,13 @@ Get a list of specific runners available to the user.
```
GET /runners
GET /runners?scope=active
+GET /runners?type=project_type
```
| Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------|
| `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` |
```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners"
@@ -56,11 +58,13 @@ is restricted to users with `admin` privileges.
```
GET /runners/all
GET /runners/all?scope=online
+GET /runners/all?type=project_type
```
| Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------|
| `scope` | string | no | The scope of runners to show, one of: `specific`, `shared`, `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` |
```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners/all"