diff options
Diffstat (limited to 'doc/ci/api/runners.md')
| -rw-r--r-- | doc/ci/api/runners.md | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/doc/ci/api/runners.md b/doc/ci/api/runners.md index c4716982357..2f01da4bd76 100644 --- a/doc/ci/api/runners.md +++ b/doc/ci/api/runners.md @@ -1,39 +1,46 @@ # Runners API -API used by runners to register and delete itselves. +API used by runners to register and delete themselves. _**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)._ +## Authentication + +This API uses two types of authentication: + +1. Unique runner's token + + Token assigned to runner after it has been registered. + +2. Using runners' registration token + + This is a token that can be found in project's settings. + It can be also found in Admin area » Runners settings. + + There are two types of tokens you can pass - shared runner registration + token or project specific registration token. + ## Runners ### Register a new runner -__Authentication is done with a shared runner registration token or a project -specific runner registration token.__ - Used to make GitLab CI aware of available runners. - POST /runners/register + POST /ci/api/v1/runners/register Parameters: - * `token` (required) - The registration token. + * `token` (required) - Registration token -It is 2 types of token you can pass here. - -1. Shared runner registration token -2. Project specific registration token ### Delete a runner -__Authentication is done by using runner token.__ - Used to remove runner. - DELETE /runners/delete + DELETE /ci/api/v1/runners/delete Parameters: - * `token` (required) - The runner token. + * `token` (required) - Unique runner token |