Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
李少辉-开发者
gitlab-foss
提交
43c8daf3
G
gitlab-foss
项目概览
李少辉-开发者
/
gitlab-foss
通知
15
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
G
gitlab-foss
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
43c8daf3
编写于
2月 01, 2016
作者:
T
Tomasz Maczukin
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add runners API documentation [ci-skip]
上级
53f775ae
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
235 addition
and
0 deletion
+235
-0
doc/api/README.md
doc/api/README.md
+1
-0
doc/api/runners.md
doc/api/runners.md
+234
-0
未找到文件。
doc/api/README.md
浏览文件 @
43c8daf3
...
...
@@ -32,6 +32,7 @@ following locations:
-
[
Builds
](
builds.md
)
-
[
Build triggers
](
build_triggers.md
)
-
[
Build Variables
](
build_variables.md
)
-
[
Runners
](
runners.md
)
## Authentication
...
...
doc/api/runners.md
0 → 100644
浏览文件 @
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
}
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录