debian-mirror-gitlab/doc/api/runners.md

557 lines
17 KiB
Markdown
Raw Normal View History

2016-04-02 18:10:28 +05:30
# Runners API
> [Introduced][ce-2640] in GitLab 8.5
2019-12-04 20:38:33 +05:30
[ce-2640]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/2640
2016-04-02 18:10:28 +05:30
2019-07-07 11:18:12 +05:30
## Registration and authentication tokens
There are two tokens to take into account when connecting a Runner with GitLab.
| Token | Description |
| ----- | ----------- |
| Registration token | Token used to [register the Runner](https://docs.gitlab.com/runner/register/). It can be [obtained through GitLab](../ci/runners/README.md). |
| Authentication token | Token used to authenticate the Runner with the GitLab instance. It is obtained either automatically when [registering a Runner](https://docs.gitlab.com/runner/register/), or manually when [registering the Runner via the Runners API](#register-a-new-runner). |
Here's an example of how the two tokens are used in Runner registration:
1. You register the Runner via the GitLab API using a registration token, and an
authentication token is returned.
1. You use that authentication token and add it to the
[Runner's configuration file](https://docs.gitlab.com/runner/commands/#configuration-file):
2019-09-30 21:07:59 +05:30
```toml
[[runners]]
token = "<authentication_token>"
```
2019-07-07 11:18:12 +05:30
GitLab and Runner are then connected.
2016-04-02 18:10:28 +05:30
## List owned runners
Get a list of specific runners available to the user.
```
GET /runners
GET /runners?scope=active
2018-12-05 23:21:45 +05:30
GET /runners?type=project_type
GET /runners?status=active
2019-07-07 11:18:12 +05:30
GET /runners?tag_list=tag1,tag2
2016-04-02 18:10:28 +05:30
```
2019-07-07 11:18:12 +05:30
| Attribute | Type | Required | Description |
|-------------|----------------|----------|---------------------|
| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided |
| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` |
| `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` |
2019-09-30 21:07:59 +05:30
| `tag_list` | string array | no | List of of the runner's tags |
2016-04-02 18:10:28 +05:30
```
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners"
2016-04-02 18:10:28 +05:30
```
Example response:
```json
[
{
"active": true,
"description": "test-1-20150125",
"id": 6,
"is_shared": false,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2018-03-17 18:26:18 +05:30
"name": null,
"online": true,
"status": "online"
2016-04-02 18:10:28 +05:30
},
{
"active": true,
"description": "test-2-20150125",
"id": 8,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": false,
2018-03-17 18:26:18 +05:30
"name": null,
"online": false,
"status": "offline"
2016-04-02 18:10:28 +05:30
}
]
```
## List all runners
Get a list of all runners in the GitLab instance (specific and shared). Access
is restricted to users with `admin` privileges.
```
GET /runners/all
GET /runners/all?scope=online
2018-12-05 23:21:45 +05:30
GET /runners/all?type=project_type
GET /runners/all?status=active
2019-07-07 11:18:12 +05:30
GET /runners/all?tag_list=tag1,tag2
2016-04-02 18:10:28 +05:30
```
2019-07-07 11:18:12 +05:30
| Attribute | Type | Required | Description |
|-------------|----------------|----------|---------------------|
| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to show, one of: `specific`, `shared`, `active`, `paused`, `online`, `offline`; showing all runners if none provided |
| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` |
| `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` |
2019-09-30 21:07:59 +05:30
| `tag_list` | string array | no | List of of the runner's tags |
2016-04-02 18:10:28 +05:30
```
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/all"
2016-04-02 18:10:28 +05:30
```
Example response:
```json
[
{
"active": true,
"description": "shared-runner-1",
"id": 1,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": true,
2018-03-17 18:26:18 +05:30
"name": null,
"online": true,
"status": "online"
2016-04-02 18:10:28 +05:30
},
{
"active": true,
"description": "shared-runner-2",
"id": 3,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": true,
2018-03-17 18:26:18 +05:30
"name": null,
"online": false
"status": "offline"
2016-04-02 18:10:28 +05:30
},
{
"active": true,
"description": "test-1-20150125",
"id": 6,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": false,
2018-03-17 18:26:18 +05:30
"name": null,
"online": true
"status": "paused"
2016-04-02 18:10:28 +05:30
},
{
"active": true,
"description": "test-2-20150125",
"id": 8,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": false,
2018-03-17 18:26:18 +05:30
"name": null,
"online": false,
"status": "offline"
2016-04-02 18:10:28 +05:30
}
]
```
## Get runner's details
Get details of a runner.
```
GET /runners/:id
```
| Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------|
| `id` | integer | yes | The ID of a runner |
```
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6"
2016-04-02 18:10:28 +05:30
```
Example response:
```json
{
"active": true,
"architecture": null,
"description": "test-1-20150125",
"id": 6,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": false,
"contacted_at": "2016-01-25T16:39:48.066Z",
"name": null,
2018-03-17 18:26:18 +05:30
"online": true,
"status": "online",
2016-04-02 18:10:28 +05:30
"platform": null,
"projects": [
{
"id": 1,
"name": "GitLab Community Edition",
"name_with_namespace": "GitLab.org / GitLab Community Edition",
2019-12-21 20:55:43 +05:30
"path": "gitlab-foss",
"path_with_namespace": "gitlab-org/gitlab-foss"
2016-04-02 18:10:28 +05:30
}
],
"token": "205086a8e3b9a2b818ffac9b89d102",
"revision": null,
"tag_list": [
"ruby",
"mysql"
],
2018-03-17 18:26:18 +05:30
"version": null,
2018-05-09 12:01:36 +05:30
"access_level": "ref_protected",
"maximum_timeout": 3600
2016-04-02 18:10:28 +05:30
}
```
## Update runner's details
Update details of a runner.
```
PUT /runners/:id
```
| Attribute | Type | Required | Description |
|---------------|---------|----------|---------------------|
| `id` | integer | yes | The ID of a runner |
| `description` | string | no | The description of a runner |
| `active` | boolean | no | The state of a runner; can be set to `true` or `false` |
| `tag_list` | array | no | The list of tags for a runner; put array of tags, that should be finally assigned to a runner |
2019-09-30 21:07:59 +05:30
| `run_untagged`| boolean | no | Flag indicating the runner can execute untagged jobs |
| `locked` | boolean | no | Flag indicating the runner is locked |
| `access_level` | string | no | The access_level of the runner; `not_protected` or `ref_protected` |
| `maximum_timeout` | integer | no | Maximum timeout set when this Runner will handle the job |
2016-04-02 18:10:28 +05:30
```
2019-02-15 15:39:39 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6" --form "description=test-1-20150125-test" --form "tag_list=ruby,mysql,tag1,tag2"
2016-04-02 18:10:28 +05:30
```
Example response:
```json
{
"active": true,
"architecture": null,
"description": "test-1-20150125-test",
"id": 6,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": false,
"contacted_at": "2016-01-25T16:39:48.066Z",
"name": null,
2018-03-17 18:26:18 +05:30
"online": true,
"status": "online",
2016-04-02 18:10:28 +05:30
"platform": null,
"projects": [
{
"id": 1,
"name": "GitLab Community Edition",
"name_with_namespace": "GitLab.org / GitLab Community Edition",
2019-12-21 20:55:43 +05:30
"path": "gitlab-foss",
"path_with_namespace": "gitlab-org/gitlab-foss"
2016-04-02 18:10:28 +05:30
}
],
"token": "205086a8e3b9a2b818ffac9b89d102",
"revision": null,
"tag_list": [
"ruby",
"mysql",
"tag1",
"tag2"
],
2018-03-17 18:26:18 +05:30
"version": null,
2018-05-09 12:01:36 +05:30
"access_level": "ref_protected",
"maximum_timeout": null
2016-04-02 18:10:28 +05:30
}
```
## Remove a runner
Remove a runner.
```
DELETE /runners/:id
```
| Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------|
| `id` | integer | yes | The ID of a runner |
```
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6"
2016-04-02 18:10:28 +05:30
```
2018-03-17 18:26:18 +05:30
## List runner's jobs
2019-12-04 20:38:33 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/15432) in GitLab 10.3.
2019-07-07 11:18:12 +05:30
2018-03-17 18:26:18 +05:30
List jobs that are being processed or were processed by specified Runner.
```
GET /runners/:id/jobs
```
| Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------|
| `id` | integer | yes | The ID of a runner |
| `status` | string | no | Status of the job; one of: `running`, `success`, `failed`, `canceled` |
2019-09-30 21:07:59 +05:30
| `order_by`| string | no | Order jobs by `id`. |
| `sort` | string | no | Sort jobs in `asc` or `desc` order (default: `desc`) |
2018-03-17 18:26:18 +05:30
```
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/1/jobs?status=running"
2018-03-17 18:26:18 +05:30
```
Example response:
```json
[
{
"id": 2,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2018-03-17 18:26:18 +05:30
"status": "running",
"stage": "test",
"name": "test",
"ref": "master",
"tag": false,
"coverage": null,
"created_at": "2017-11-16T08:50:29.000Z",
"started_at": "2017-11-16T08:51:29.000Z",
"finished_at": "2017-11-16T08:53:29.000Z",
"duration": 120,
"user": {
"id": 1,
"name": "John Doe2",
"username": "user2",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
"web_url": "http://localhost/user2",
"created_at": "2017-11-16T18:38:46.000Z",
"bio": null,
"location": null,
2018-12-05 23:21:45 +05:30
"public_email": "",
2018-03-17 18:26:18 +05:30
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": null
},
"commit": {
"id": "97de212e80737a608d939f648d959671fb0a0142",
"short_id": "97de212e",
"title": "Update configuration\r",
"created_at": "2017-11-16T08:50:28.000Z",
"parent_ids": [
"1b12f15a11fc6e62177bef08f47bc7b5ce50b141",
"498214de67004b1da3d820901307bed2a68a8ef6"
],
"message": "See merge request !123",
"author_name": "John Doe2",
"author_email": "user2@example.org",
"authored_date": "2017-11-16T08:50:27.000Z",
"committer_name": "John Doe2",
"committer_email": "user2@example.org",
"committed_date": "2017-11-16T08:50:27.000Z"
},
"pipeline": {
"id": 2,
"sha": "97de212e80737a608d939f648d959671fb0a0142",
"ref": "master",
"status": "running"
},
"project": {
"id": 1,
"description": null,
"name": "project1",
"name_with_namespace": "John Doe2 / project1",
"path": "project1",
"path_with_namespace": "namespace1/project1",
"created_at": "2017-11-16T18:38:46.620Z"
}
}
]
```
2016-04-02 18:10:28 +05:30
## List project's runners
List all runners (specific and shared) available in the project. Shared runners
2018-12-13 13:39:08 +05:30
are listed if at least one shared runner is defined.
2016-04-02 18:10:28 +05:30
```
GET /projects/:id/runners
2018-12-05 23:21:45 +05:30
GET /projects/:id/runners?scope=active
GET /projects/:id/runners?type=project_type
GET /projects/:id/runners?status=active
2019-07-07 11:18:12 +05:30
GET /projects/:id/runners?tag_list=tag1,tag2
2016-04-02 18:10:28 +05:30
```
2019-07-07 11:18:12 +05:30
| Attribute | Type | Required | Description |
|------------|----------------|----------|---------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided |
| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` |
| `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` |
2019-09-30 21:07:59 +05:30
| `tag_list` | string array | no | List of of the runner's tags |
2016-04-02 18:10:28 +05:30
```
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners"
2016-04-02 18:10:28 +05:30
```
Example response:
```json
[
{
"active": true,
"description": "test-2-20150125",
"id": 8,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": false,
2018-03-17 18:26:18 +05:30
"name": null,
"online": false,
"status": "offline"
2016-04-02 18:10:28 +05:30
},
{
"active": true,
"description": "development_runner",
"id": 5,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": true,
2018-03-17 18:26:18 +05:30
"name": null,
"online": true
"status": "paused"
2016-04-02 18:10:28 +05:30
}
]
```
## Enable a runner in project
Enable an available specific runner in the project.
```
POST /projects/:id/runners
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|---------------------|
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
2016-04-02 18:10:28 +05:30
| `runner_id` | integer | yes | The ID of a runner |
```
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners" --form "runner_id=9"
2016-04-02 18:10:28 +05:30
```
Example response:
```json
{
"active": true,
"description": "test-2016-02-01",
"id": 9,
2018-11-08 19:23:39 +05:30
"ip_address": "127.0.0.1",
2016-04-02 18:10:28 +05:30
"is_shared": false,
2018-03-17 18:26:18 +05:30
"name": null,
"online": true,
"status": "online"
2016-04-02 18:10:28 +05:30
}
```
## Disable a runner from project
Disable a specific runner from the project. It works only if the project isn't
the only project associated with the specified runner. If so, an error is
returned. Use the [Remove a runner](#remove-a-runner) call instead.
```
DELETE /projects/:id/runners/:runner_id
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|---------------------|
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
2016-04-02 18:10:28 +05:30
| `runner_id` | integer | yes | The ID of a runner |
```
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners/9"
2016-04-02 18:10:28 +05:30
```
2018-11-08 19:23:39 +05:30
## Register a new Runner
Register a new Runner for the instance.
```
POST /runners
```
2019-09-30 21:07:59 +05:30
| Attribute | Type | Required | Description |
|--------------|---------|----------|---------------------|
| `token` | string | yes | [Registration token](#registration-and-authentication-tokens). |
| `description`| string | no | Runner's description|
| `info` | hash | no | Runner's metadata |
| `active` | boolean | no | Whether the Runner is active |
| `locked` | boolean | no | Whether the Runner should be locked for current project |
| `run_untagged` | boolean | no | Whether the Runner should handle untagged jobs |
| `tag_list` | string array | no | List of Runner's tags |
| `access_level` | string | no | The access_level of the runner; `not_protected` or `ref_protected` |
| `maximum_timeout` | integer | no | Maximum timeout set when this Runner will handle the job |
2018-11-08 19:23:39 +05:30
```
2019-07-07 11:18:12 +05:30
curl --request POST "https://gitlab.example.com/api/v4/runners" --form "token=<registration_token>" --form "description=test-1-20150125-test" --form "tag_list=ruby,mysql,tag1,tag2"
2018-11-08 19:23:39 +05:30
```
Response:
| Status | Description |
|-----------|---------------------------------|
| 201 | Runner was created |
Example response:
```json
{
"id": "12345",
"token": "6337ff461c94fd3fa32ba3b1ff4125"
}
```
## Delete a registered Runner
2019-07-07 11:18:12 +05:30
Deletes a registered Runner.
2018-11-08 19:23:39 +05:30
```
DELETE /runners
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|---------------------|
2019-07-07 11:18:12 +05:30
| `token` | string | yes | Runner's [authentication token](#registration-and-authentication-tokens). |
2018-11-08 19:23:39 +05:30
```
2019-07-07 11:18:12 +05:30
curl --request DELETE "https://gitlab.example.com/api/v4/runners" --form "token=<authentication_token>"
2018-11-08 19:23:39 +05:30
```
Response:
| Status | Description |
|-----------|---------------------------------|
| 204 | Runner was deleted |
## Verify authentication for a registered Runner
Validates authentication credentials for a registered Runner.
```
POST /runners/verify
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|---------------------|
2019-07-07 11:18:12 +05:30
| `token` | string | yes | Runner's [authentication token](#registration-and-authentication-tokens). |
2018-11-08 19:23:39 +05:30
```
2019-07-07 11:18:12 +05:30
curl --request POST "https://gitlab.example.com/api/v4/runners/verify" --form "token=<authentication_token>"
2018-11-08 19:23:39 +05:30
```
Response:
| Status | Description |
|-----------|---------------------------------|
| 200 | Credentials are valid |
| 403 | Credentials are invalid |