Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
gitlab-ce
Commits
43c8daf3
Commit
43c8daf3
authored
Feb 01, 2016
by
Tomasz Maczukin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add runners API documentation [ci-skip]
parent
53f775ae
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
235 additions
and
0 deletions
+235
-0
doc/api/README.md
doc/api/README.md
+1
-0
doc/api/runners.md
doc/api/runners.md
+234
-0
No files found.
doc/api/README.md
View file @
43c8daf3
...
@@ -32,6 +32,7 @@ following locations:
...
@@ -32,6 +32,7 @@ following locations:
-
[
Builds
](
builds.md
)
-
[
Builds
](
builds.md
)
-
[
Build triggers
](
build_triggers.md
)
-
[
Build triggers
](
build_triggers.md
)
-
[
Build Variables
](
build_variables.md
)
-
[
Build Variables
](
build_variables.md
)
-
[
Runners
](
runners.md
)
## Authentication
## Authentication
...
...
doc/api/runners.md
0 → 100644
View file @
43c8daf3
# Runners API
## List runners
Get a list of runners.
```
GET /runners
```
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
|
`scope`
| string | no | The scope of runners to show, one of:
`specific`
,
`shared`
,
`active`
,
`paused`
,
`online`
; showing all runners if none provided |
```
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners"
```
```
json
[
{
"active"
:
true
,
"description"
:
"test-1-20150125"
,
"id"
:
6
,
"is_shared"
:
false
,
"name"
:
null
},
{
"active"
:
true
,
"description"
:
"test-2-20150125"
,
"id"
:
8
,
"is_shared"
:
false
,
"name"
:
null
}
]
```
## Get runner's details
Get details of a runner.
```
GET /runners/:id
```
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a runner |
```
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6"
```
```
json
{
"active"
:
true
,
"architecture"
:
null
,
"description"
:
"test-1-20150125"
,
"id"
:
6
,
"is_shared"
:
false
,
"last_contact"
:
"2016-01-25T16:39:48.066Z"
,
"name"
:
null
,
"platform"
:
null
,
"revision"
:
null
,
"tag_list"
:
[
"ruby"
,
"mysql"
],
"version"
:
null
}
```
## Update runner's details
Update details of a runner.
```
PUT /runners/:id
```
| Attribute | Type | required | Description |
|---------------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a runner |
|
`description`
| string | no | The description of a runner |
|
`active`
| boolean | no | The state of a runner; can be set to
`true`
or
`false`
|
|
`tag_list`
| array | no | The list of tags for a runner; put array of tags, that should be finally assigned to a runner |
```
curl -X PUT -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6" -F "description=test-1-20150125-test" -F "tag_list=ruby,mysql,tag1,tag2"
```
```
json
{
"active"
:
true
,
"architecture"
:
null
,
"description"
:
"test-1-20150125-test"
,
"id"
:
6
,
"is_shared"
:
false
,
"last_contact"
:
"2016-01-25T16:39:48.066Z"
,
"name"
:
null
,
"platform"
:
null
,
"revision"
:
null
,
"tag_list"
:
[
"ruby"
,
"mysql"
,
"tag1"
,
"tag2"
],
"version"
:
null
}
```
## Remove a runner
Remove a runner.
```
DELETE /runners/:id
```
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a runner |
```
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6"
```
```
json
{
"active"
:
true
,
"architecture"
:
null
,
"description"
:
"test-1-20150125-test"
,
"id"
:
6
,
"is_shared"
:
false
,
"last_contact"
:
"2016-01-25T16:39:48.066Z"
,
"name"
:
null
,
"platform"
:
null
,
"revision"
:
null
,
"tag_list"
:
[],
"version"
:
null
}
```
## List project's runners
List all runners (
*shared*
and
*specific*
) available in project. Shared runners are listed if at least one shared runner
is defined
**and**
shared runners usage is enabled in project's settings.
```
GET /projects/:id/runners
```
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a project |
```
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners"
```
```
json
[
{
"active"
:
true
,
"description"
:
"test-2-20150125"
,
"id"
:
8
,
"is_shared"
:
false
,
"name"
:
null
},
{
"active"
:
true
,
"description"
:
"development_runner"
,
"id"
:
5
,
"is_shared"
:
true
,
"name"
:
null
}
]
```
## Enable a runner in project
Enable available specific runner in project.
```
PUT /projects/:id/runners/:runner_id
```
| Attribute | Type | required | Description |
|-------------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a project |
|
`runner_id`
| integer | yes | The ID of a runner |
```
curl -X PUT -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners/9"
```
```
json
{
"active"
:
true
,
"description"
:
"test-2016-02-01"
,
"id"
:
9
,
"is_shared"
:
false
,
"name"
:
null
}
```
## Disable a runner from project
Disable a specific runner from project. It works only, if the project isn't an only project associated with the
specified runner. If so, then an error is returned and user should use the
[
remove a runner
](
#remove-a-runner
)
feature.
```
PUT /projects/:id/runners/:runner_id
```
| Attribute | Type | required | Description |
|-------------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a project |
|
`runner_id`
| integer | yes | The ID of a runner |
```
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners/9"
```
```
json
{
"active"
:
true
,
"description"
:
"test-2016-02-01"
,
"id"
:
9
,
"is_shared"
:
false
,
"name"
:
null
}
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment