BigW Consortium Gitlab

runners.md 1017 Bytes
Newer Older
1 2
# Runners API

3
API used by runners to register and delete themselves.
4

5 6 7
_**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)._
8

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
## 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.

25 26 27 28
## Runners

### Register a new runner

Robert Schilling committed
29
Used to make GitLab CI aware of available runners.
30

31
    POST /ci/api/v1/runners/register
32 33 34

Parameters:

35
  * `token` (required) - Registration token
36

37 38 39

### Delete a runner

40
Used to remove runner.
41

42
    DELETE /ci/api/v1/runners/delete
43 44 45

Parameters:

46
  * `token` (required) - Unique runner token