2015-09-25 12:07:36 +05:30
|
|
|
# Runners API
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
API used by runners to register and delete themselves.
|
|
|
|
|
2016-04-02 18:10:28 +05:30
|
|
|
_**Note:** This API is intended to be used only by Runners as their own
|
|
|
|
communication channel. For the consumer API see the
|
|
|
|
[new Runners API](../../api/runners.md)._
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
## Authentication
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
This API uses two types of authentication:
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
1. Unique runner's token
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
Token assigned to runner after it has been registered.
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
2. Using runners' registration token
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
This is a token that can be found in project's settings.
|
|
|
|
It can be also found in Admin area » Runners settings.
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
There are two types of tokens you can pass - shared runner registration
|
|
|
|
token or project specific registration token.
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
## Runners
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
### Register a new runner
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2015-11-26 14:37:03 +05:30
|
|
|
Used to make GitLab CI aware of available runners.
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
POST /ci/api/v1/runners/register
|
2015-09-25 12:07:36 +05:30
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
* `token` (required) - Registration token
|
2015-09-25 12:07:36 +05:30
|
|
|
|
|
|
|
|
|
|
|
### Delete a runner
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
Used to remove runner.
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
DELETE /ci/api/v1/runners/delete
|
2015-09-25 12:07:36 +05:30
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
* `token` (required) - Unique runner token
|