diff options
| author | Alexis Reigel <alexis.reigel.ext@siemens.com> | 2018-06-11 15:17:46 +0200 |
|---|---|---|
| committer | Alexis Reigel <alexis.reigel.ext@siemens.com> | 2018-09-15 21:39:26 +0200 |
| commit | 82546888e81488ba7b2a60a970a1cc31febcc1e9 (patch) | |
| tree | af69a08e70434642862e57d549c514ff255b65cb /doc/api/runners.md | |
| parent | 048b4469e8c46327e3e3e9bbdfd7ef9bd27e047f (diff) | |
| download | gitlab-ce-82546888e81488ba7b2a60a970a1cc31febcc1e9.tar.gz | |
add status param to runners api
Diffstat (limited to 'doc/api/runners.md')
| -rw-r--r-- | doc/api/runners.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/runners.md b/doc/api/runners.md index 7763e6b2913..7a67b648b07 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -12,12 +12,14 @@ Get a list of specific runners available to the user. GET /runners GET /runners?scope=active GET /runners?type=project_type +GET /runners?status=active ``` | 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` | +| `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/runners" @@ -59,12 +61,14 @@ is restricted to users with `admin` privileges. GET /runners/all GET /runners/all?scope=online GET /runners/all?type=project_type +GET /runners/all?status=active ``` | 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` | +| `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/runners/all" |