summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTomasz Maczukin <tomasz@maczukin.pl>2017-11-16 17:12:33 +0100
committerTomasz Maczukin <tomasz@maczukin.pl>2017-11-28 00:36:48 +0100
commit623eb68195d51ea50e09970771442d992ff19a4a (patch)
treeb8778abd2aabd5a80867f9250884f39b506fa861 /doc
parent8e7e2aeb4f0f9e1e61366a62e41fd15936593cfd (diff)
downloadgitlab-ce-623eb68195d51ea50e09970771442d992ff19a4a.tar.gz
Add new API endpoint - list jobs of a specified runner
Diffstat (limited to 'doc')
-rw-r--r--doc/api/runners.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/api/runners.md b/doc/api/runners.md
index 6304a496f94..171857ef49e 100644
--- a/doc/api/runners.md
+++ b/doc/api/runners.md
@@ -215,6 +215,57 @@ DELETE /runners/:id
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners/6"
```
+## List runner's running jobs
+
+List running jobs assigned to the specified Runner.
+
+```
+GET /runners/:id/jobs
+```
+
+| Attribute | Type | Required | Description |
+|-----------|---------|----------|---------------------|
+| `id` | integer | yes | The ID of a runner |
+
+```
+curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners/1/jobs"
+```
+
+Example response:
+
+```json
+[
+ {
+ "id": 2,
+ "status": "running",
+ "stage": "test",
+ "name": "test",
+ "ref": "master",
+ "tag": false,
+ "coverage": null,
+ "created_at": "2017-11-16T08:50:29.000Z",
+ "started_at": "2017-11-16T08:51:29.000Z",
+ "finished_at": "2017-11-16T08:53:29.000Z",
+ "duration": 120,
+ "user": null,
+ "commit": null,
+ "runner": {
+ "id": 1,
+ "description": "My runner1",
+ "active": true,
+ "is_shared": true,
+ "name": null
+ },
+ "pipeline": {
+ "id": 2,
+ "sha": "97de212e80737a608d939f648d959671fb0a0142",
+ "ref": "master",
+ "status": "pending"
+ }
+ }
+]
+```
+
## List project's runners
List all runners (specific and shared) available in the project. Shared runners