summaryrefslogtreecommitdiff
path: root/doc/api/runners.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/runners.md')
-rw-r--r--doc/api/runners.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/api/runners.md b/doc/api/runners.md
index 551a7580e54..fa4631c1bd2 100644
--- a/doc/api/runners.md
+++ b/doc/api/runners.md
@@ -471,6 +471,66 @@ DELETE /projects/:id/runners/:runner_id
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners/9"
```
+## List group's runners
+
+List all runners (specific and shared) available in the group as well it's ancestor groups.
+Shared runners are listed if at least one shared runner is defined.
+
+```plaintext
+GET /groups/:id/runners
+GET /groups/:id/runners?type=group_type
+GET /groups/:id/runners?status=active
+GET /groups/:id/runners?tag_list=tag1,tag2
+```
+
+| Attribute | Type | Required | Description |
+|------------|----------------|----------|---------------------|
+| `id` | integer | yes | The ID of the group owned by the authenticated user |
+| `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` |
+| `tag_list` | string array | no | List of of the runner's tags |
+
+```shell
+curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/9/runners"
+```
+
+Example response:
+
+```json
+[
+ {
+ "id": 3,
+ "description": "Shared",
+ "ip_address": "127.0.0.1",
+ "active": true,
+ "is_shared": true,
+ "name": "gitlab-runner",
+ "online": null,
+ "status": "not_connected"
+ },
+ {
+ "id": 6,
+ "description": "Test",
+ "ip_address": "127.0.0.1",
+ "active": true,
+ "is_shared": true,
+ "name": "gitlab-runner",
+ "online": false,
+ "status": "offline"
+ },
+ {
+ "id": 8,
+ "description": "Test 2",
+ "ip_address": "127.0.0.1",
+ "active": true,
+ "is_shared": false,
+ "name": "gitlab-runner",
+ "online": null,
+ "status": "not_connected"
+ }
+]
+```
+
## Register a new Runner
Register a new Runner for the instance.