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
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Tatuya Kamada
gitlab-ce
Commits
5b3b4ff6
Commit
5b3b4ff6
authored
Feb 29, 2016
by
Grzegorz Bizon
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update CI API documentation for runners
[ci skip]
parent
cf73dc34
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
53 deletions
+11
-53
doc/ci/api/runners.md
doc/ci/api/runners.md
+11
-53
No files found.
doc/ci/api/runners.md
View file @
5b3b4ff6
# Runners API
# Runners API
API used by runners to register and delete itselves.
_
**Note:**
This API is intended to be used only by Runners as their own
_
**Note:**
This API is intended to be used only by Runners as their own
communication channel. For the consumer API see the
communication channel. For the consumer API see the
[
new Runners API
](
../../api/runners.md
)
._
[
new Runners API
](
../../api/runners.md
)
._
## Runners
## Runners
### Retrieve all runners
__Authentication is done by GitLab user token & GitLab url__
Used to get information about all runners registered on the GitLab CI
instance.
GET /ci/runners
Returns:
```
json
[
{
"id"
:
85
,
"token"
:
"12b68e90394084703135"
},
{
"id"
:
86
,
"token"
:
"76bf894e969364709864"
},
]
```
### Register a new runner
### Register a new runner
__
Authentication is done with a shared runner registration token or a project
__Authentication is done with a Shared runner registration token or a project Specific runner registration token
__
specific runner registration token.
__
Used to make GitLab CI aware of available runners.
Used to make GitLab CI aware of available runners.
POST /
ci/
runners/register
POST /runners/register
Parameters:
Parameters:
*
`token`
(required) - The registration token. It is 2 types of token you can pass here.
*
`token`
(required) - The registration token.
It is 2 types of token you can pass here.
1.
Shared runner registration token
1.
Shared runner registration token
2.
Project specific registration token
2.
Project specific registration token
Returns:
```
json
{
"id"
:
85
,
"token"
:
"12b68e90394084703135"
}
```
### Delete a runner
### Delete a runner
__Authentication is done by using runner token.__
__Authentication is done by runner token__
Used to remove runner.
Used to removing runners.
DELETE /
ci/
runners/delete
DELETE /runners/delete
Parameters:
Parameters:
*
`token`
(required) - The runner token.
*
`token`
(required) - The runner token.
Returns:
```
json
{
"id"
:
1
,
"token"
:
"d14963981a428f70121777e50643d1"
,
"created_at"
:
"2015-02-26T11:39:39.232Z"
,
"updated_at"
:
"2015-02-26T11:39:39.232Z"
,
"description"
:
"awesome runner"
}
```
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