summaryrefslogtreecommitdiff
path: root/doc/ci/api/runners.md
blob: c4716982357da4f7dc784c1ebc9d3ab78c6886e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# 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
communication channel. For the consumer API see the
[new Runners API](../../api/runners.md)._

## 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

Parameters:

  * `token` (required) - The 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

Parameters:

  * `token` (required) - The runner token.