47c9b7d34c
- Move ci/api under api/ci - Clean up builds.md and runners.md - Replace old links with new ones - Add CI API links in ci/README.md
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# Runners API
|
|
|
|
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](../runners.md).
|
|
|
|
## Authentication
|
|
|
|
This API uses two types of authentication:
|
|
|
|
1. Unique Runner's token, which is the token assigned to the 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 also be found in the **Admin > Runners** settings area.
|
|
There are two types of tokens you can pass: shared Runner registration
|
|
token or project specific registration token.
|
|
|
|
## Register a new runner
|
|
|
|
Used to make GitLab CI aware of available runners.
|
|
|
|
```sh
|
|
POST /ci/api/v1/runners/register
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| --------- | ------- | --------- | ----------- |
|
|
| `token` | string | yes | Runner's registration token |
|
|
|
|
Example request:
|
|
|
|
```sh
|
|
curl -X POST "https://gitlab.example.com/ci/api/v1/runners/register" -F "token=t0k3n"
|
|
```
|
|
|
|
## Delete a Runner
|
|
|
|
Used to remove a Runner.
|
|
|
|
```sh
|
|
DELETE /ci/api/v1/runners/delete
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| --------- | ------- | --------- | ----------- |
|
|
| `token` | string | yes | Runner's registration token |
|
|
|
|
Example request:
|
|
|
|
```sh
|
|
curl -X DELETE "https://gitlab.example.com/ci/api/v1/runners/delete" -F "token=t0k3n"
|
|
```
|