2020-08-04 02:10:16 -04:00
---
stage: Verify
group: Continuous Integration
2020-11-26 01:09:20 -05:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-08-04 02:10:16 -04:00
---
2017-03-06 04:24:03 -05:00
# Jobs API
2016-01-05 10:36:14 -05:00
2017-03-06 10:56:05 -05:00
## List project jobs
2016-01-05 10:36:14 -05:00
2019-12-11 07:08:10 -05:00
Get a list of jobs in a project. Jobs are sorted in descending order of their IDs.
2016-01-05 10:36:14 -05:00
2020-02-27 04:09:01 -05:00
```plaintext
2017-03-06 04:24:03 -05:00
GET /projects/:id/jobs
2016-01-05 10:36:14 -05:00
```
2018-12-05 05:08:39 -05:00
| Attribute | Type | Required | Description |
|-----------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2019-03-06 06:06:21 -05:00
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
2018-12-05 05:08:39 -05:00
| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created` , `pending` , `running` , `failed` , `success` , `canceled` , `skipped` , or `manual` . All jobs are returned if `scope` is not provided. |
2016-01-13 15:19:18 -05:00
2020-01-30 10:09:15 -05:00
```shell
2020-05-27 20:08:37 -04:00
curl --globoff --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs?scope[]=pending& scope[]=running"
2016-01-13 15:19:18 -05:00
```
2016-02-10 08:31:30 -05:00
Example of response
2016-01-05 10:36:14 -05:00
2017-03-06 10:56:05 -05:00
```json
[
{
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2019-12-11 07:08:10 -05:00
"created_at": "2015-12-24T15:51:21.802Z",
"started_at": "2015-12-24T17:54:27.722Z",
"finished_at": "2015-12-24T17:54:27.895Z",
"duration": 0.173,
"artifacts_file": {
"filename": "artifacts.zip",
"size": 1000
},
"artifacts": [
{"file_type": "archive", "size": 1000, "filename": "artifacts.zip", "file_format": "zip"},
{"file_type": "metadata", "size": 186, "filename": "metadata.gz", "file_format": "gzip"},
{"file_type": "trace", "size": 1500, "filename": "job.log", "file_format": "raw"},
{"file_type": "junit", "size": 750, "filename": "junit.xml.gz", "file_format": "gzip"}
],
"artifacts_expire_at": "2016-01-23T17:54:27.895Z",
2021-02-08 07:09:20 -05:00
"tag_list": [
"docker runner", "ubuntu18"
],
2019-12-11 07:08:10 -05:00
"id": 7,
"name": "teaspoon",
2017-03-06 10:56:05 -05:00
"pipeline": {
"id": 6,
"ref": "master",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
"ref": "master",
2018-07-18 17:46:56 -04:00
"artifacts": [],
2017-03-06 10:56:05 -05:00
"runner": null,
"stage": "test",
"status": "failed",
"tag": false,
2019-12-11 07:08:10 -05:00
"web_url": "https://example.com/foo/bar/-/jobs/7",
2017-03-06 10:56:05 -05:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 10:28:57 -04:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2017-03-06 10:56:05 -05:00
"web_url": "http://gitlab.dev/root",
2018-09-25 10:28:57 -04:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 12:40:24 -04:00
"public_email": "",
2018-09-25 10:28:57 -04:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2017-03-06 10:56:05 -05:00
}
},
{
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2019-12-11 07:08:10 -05:00
"created_at": "2015-12-24T15:51:21.727Z",
"started_at": "2015-12-24T17:54:24.729Z",
"finished_at": "2015-12-24T17:54:24.921Z",
"duration": 0.192,
"artifacts_expire_at": "2016-01-23T17:54:24.921Z",
2021-02-08 07:09:20 -05:00
"tag_list": [
"docker runner", "win10-2004"
],
2019-12-11 07:08:10 -05:00
"id": 6,
"name": "rspec:other",
2017-03-06 10:56:05 -05:00
"pipeline": {
"id": 6,
"ref": "master",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
"ref": "master",
2018-07-18 17:46:56 -04:00
"artifacts": [],
2017-03-06 10:56:05 -05:00
"runner": null,
"stage": "test",
"status": "failed",
"tag": false,
2019-12-11 07:08:10 -05:00
"web_url": "https://example.com/foo/bar/-/jobs/6",
2017-03-06 10:56:05 -05:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 10:28:57 -04:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2017-03-06 10:56:05 -05:00
"web_url": "http://gitlab.dev/root",
2018-09-25 10:28:57 -04:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 12:40:24 -04:00
"public_email": "",
2018-09-25 10:28:57 -04:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2017-03-06 10:56:05 -05:00
}
}
]
```
## List pipeline jobs
Get a list of jobs for a pipeline.
2020-02-27 04:09:01 -05:00
```plaintext
2017-04-21 15:43:55 -04:00
GET /projects/:id/pipelines/:pipeline_id/jobs
2017-03-06 10:56:05 -05:00
```
2021-02-16 13:09:24 -05:00
| Attribute | Type | Required | Description |
|-------------------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
| `pipeline_id` | integer | yes | ID of a pipeline. |
| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created` , `pending` , `running` , `failed` , `success` , `canceled` , `skipped` , or `manual` . All jobs are returned if `scope` is not provided. |
| `include_retried` | boolean | no | Include retried jobs in the response. Defaults to `false` . [Introduced ](https://gitlab.com/gitlab-org/gitlab/-/issues/272627 ) in GitLab 13.9. |
2017-03-06 10:56:05 -05:00
2020-01-30 10:09:15 -05:00
```shell
2020-05-27 20:08:37 -04:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/pipelines/6/jobs?scope[]=pending& scope[]=running"
2017-03-06 10:56:05 -05:00
```
Example of response
2016-01-05 10:36:14 -05:00
```json
[
2016-06-10 15:45:06 -04:00
{
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2018-07-03 09:42:40 -04:00
"created_at": "2015-12-24T15:51:21.727Z",
2018-09-09 05:49:44 -04:00
"started_at": "2015-12-24T17:54:24.729Z",
2018-07-03 09:42:40 -04:00
"finished_at": "2015-12-24T17:54:24.921Z",
2018-09-09 05:49:44 -04:00
"duration": 0.192,
2018-07-18 17:57:08 -04:00
"artifacts_expire_at": "2016-01-23T17:54:24.921Z",
2021-02-08 07:09:20 -05:00
"tag_list": [
"docker runner", "ubuntu18"
],
2018-07-03 09:42:40 -04:00
"id": 6,
"name": "rspec:other",
2016-09-23 19:43:57 -04:00
"pipeline": {
"id": 6,
"ref": "master",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
2016-11-15 05:40:36 -05:00
},
2016-06-10 15:45:06 -04:00
"ref": "master",
2018-07-18 17:46:56 -04:00
"artifacts": [],
2016-06-10 15:45:06 -04:00
"runner": null,
"stage": "test",
"status": "failed",
"tag": false,
2018-07-18 17:57:08 -04:00
"web_url": "https://example.com/foo/bar/-/jobs/6",
2016-06-10 15:45:06 -04:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 10:28:57 -04:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2016-10-13 07:24:09 -04:00
"web_url": "http://gitlab.dev/root",
2018-09-25 10:28:57 -04:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 12:40:24 -04:00
"public_email": "",
2018-09-25 10:28:57 -04:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2016-06-10 15:45:06 -04:00
}
},
{
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
2016-01-05 10:36:14 -05:00
},
2016-06-10 15:45:06 -04:00
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2018-07-03 09:42:40 -04:00
"created_at": "2015-12-24T15:51:21.802Z",
2018-09-09 05:49:44 -04:00
"started_at": "2015-12-24T17:54:27.722Z",
"finished_at": "2015-12-24T17:54:27.895Z",
"duration": 0.173,
2018-07-03 09:42:40 -04:00
"artifacts_file": {
"filename": "artifacts.zip",
"size": 1000
},
2018-07-18 17:46:56 -04:00
"artifacts": [
{"file_type": "archive", "size": 1000, "filename": "artifacts.zip", "file_format": "zip"},
{"file_type": "metadata", "size": 186, "filename": "metadata.gz", "file_format": "gzip"},
{"file_type": "trace", "size": 1500, "filename": "job.log", "file_format": "raw"},
{"file_type": "junit", "size": 750, "filename": "junit.xml.gz", "file_format": "gzip"}
],
2018-07-18 17:57:08 -04:00
"artifacts_expire_at": "2016-01-23T17:54:27.895Z",
2021-02-08 07:09:20 -05:00
"tag_list": [
"docker runner", "ubuntu18"
],
2018-07-03 09:42:40 -04:00
"id": 7,
"name": "teaspoon",
2016-09-23 19:43:57 -04:00
"pipeline": {
"id": 6,
"ref": "master",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
2016-11-15 05:40:36 -05:00
},
2016-06-10 15:45:06 -04:00
"ref": "master",
"runner": null,
"stage": "test",
"status": "failed",
"tag": false,
2018-07-18 17:57:08 -04:00
"web_url": "https://example.com/foo/bar/-/jobs/7",
2016-06-10 15:45:06 -04:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 10:28:57 -04:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2016-10-13 07:24:09 -04:00
"web_url": "http://gitlab.dev/root",
2018-09-25 10:28:57 -04:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 12:40:24 -04:00
"public_email": "",
2018-09-25 10:28:57 -04:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2016-01-05 10:36:14 -05:00
}
2016-06-10 15:45:06 -04:00
}
2016-01-05 10:36:14 -05:00
]
2016-01-12 05:50:14 -05:00
```
2020-07-24 20:09:23 -04:00
In GitLab 13.3 and later, this endpoint [returns data for any pipeline ](pipelines.md#single-pipeline-requests )
2020-07-17 14:09:20 -04:00
including [child pipelines ](../ci/parent_child_pipelines.md ).
2021-02-16 13:09:24 -05:00
In GitLab 13.5 and later, this endpoint does not return retried jobs in the response
by default.
In GitLab 13.9 and later, this endpoint can include retried jobs in the response
with `include_retried` set to `true` .
2020-06-16 08:09:00 -04:00
## List pipeline bridges
Get a list of bridge jobs for a pipeline.
```plaintext
GET /projects/:id/pipelines/:pipeline_id/bridges
```
| Attribute | Type | Required | Description |
|---------------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
| `pipeline_id` | integer | yes | ID of a pipeline. |
| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created` , `pending` , `running` , `failed` , `success` , `canceled` , `skipped` , or `manual` . All jobs are returned if `scope` is not provided. |
```shell
2020-12-08 04:09:41 -05:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/pipelines/6/bridges?scope[]=pending& scope[]=running"
2020-06-16 08:09:00 -04:00
```
Example of response
```json
[
{
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
"allow_failure": false,
"created_at": "2015-12-24T15:51:21.802Z",
"started_at": "2015-12-24T17:54:27.722Z",
"finished_at": "2015-12-24T17:58:27.895Z",
"duration": 240,
"id": 7,
"name": "teaspoon",
"pipeline": {
"id": 6,
"ref": "master",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending",
"created_at": "2015-12-24T15:50:16.123Z",
"updated_at": "2015-12-24T18:00:44.432Z",
"web_url": "https://example.com/foo/bar/pipelines/6"
},
"ref": "master",
"stage": "test",
"status": "pending",
"tag": false,
"web_url": "https://example.com/foo/bar/-/jobs/7",
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
"web_url": "http://gitlab.dev/root",
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
"public_email": "",
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
},
"downstream_pipeline": {
"id": 5,
"sha": "f62a4b2fb89754372a346f24659212eb8da13601",
"ref": "master",
"status": "pending",
"created_at": "2015-12-24T17:54:27.722Z",
"updated_at": "2015-12-24T17:58:27.896Z",
"web_url": "https://example.com/diaspora/diaspora-client/pipelines/5"
}
}
]
```
2017-03-06 04:24:03 -05:00
## Get a single job
2016-01-05 10:36:14 -05:00
2017-03-06 04:24:03 -05:00
Get a single job of a project
2016-01-05 10:36:14 -05:00
2020-02-27 04:09:01 -05:00
```plaintext
2017-03-06 04:24:03 -05:00
GET /projects/:id/jobs/:job_id
2016-01-05 10:36:14 -05:00
```
2018-12-05 05:08:39 -05:00
| Attribute | Type | Required | Description |
|-----------|----------------|----------|------------------------------------------------------------------------------------------------------------------|
2019-03-06 06:06:21 -05:00
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | yes | ID of a job. |
2016-01-13 15:19:18 -05:00
2020-01-30 10:09:15 -05:00
```shell
2018-12-27 04:03:08 -05:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/8"
2016-01-13 15:19:18 -05:00
```
2016-02-10 08:31:30 -05:00
Example of response
2016-01-05 10:36:14 -05:00
```json
{
2016-06-10 15:45:06 -04:00
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2016-06-10 15:45:06 -04:00
"created_at": "2015-12-24T15:51:21.880Z",
2018-09-09 05:49:44 -04:00
"started_at": "2015-12-24T17:54:30.733Z",
2016-06-10 15:45:06 -04:00
"finished_at": "2015-12-24T17:54:31.198Z",
2018-09-09 05:49:44 -04:00
"duration": 0.465,
2018-05-10 03:58:19 -04:00
"artifacts_expire_at": "2016-01-23T17:54:31.198Z",
2021-02-08 07:09:20 -05:00
"tag_list": [
"docker runner", "macos-10.15"
],
2016-06-10 15:45:06 -04:00
"id": 8,
"name": "rubocop",
2016-09-23 19:43:57 -04:00
"pipeline": {
"id": 6,
"ref": "master",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
2016-11-15 05:40:36 -05:00
},
2016-06-10 15:45:06 -04:00
"ref": "master",
2018-07-18 17:46:56 -04:00
"artifacts": [],
2016-06-10 15:45:06 -04:00
"runner": null,
"stage": "test",
"status": "failed",
"tag": false,
2018-07-18 17:57:08 -04:00
"web_url": "https://example.com/foo/bar/-/jobs/8",
2016-06-10 15:45:06 -04:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 10:28:57 -04:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2016-10-13 07:24:09 -04:00
"web_url": "http://gitlab.dev/root",
2018-09-25 10:28:57 -04:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 12:40:24 -04:00
"public_email": "",
2018-09-25 10:28:57 -04:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2016-06-10 15:45:06 -04:00
}
2016-01-05 10:36:14 -05:00
}
```
2019-10-17 20:07:45 -04:00
## Get a log file
2016-06-03 13:56:26 -04:00
2019-10-17 20:07:45 -04:00
Get a log (trace) of a specific job of a project:
2016-06-03 13:56:26 -04:00
2020-02-27 04:09:01 -05:00
```plaintext
2017-03-06 04:24:03 -05:00
GET /projects/:id/jobs/:job_id/trace
2016-06-03 13:56:26 -04:00
```
2018-12-05 05:08:39 -05:00
| Attribute | Type | Required | Description |
|-----------|----------------|----------|------------------------------------------------------------------------------------------------------------------|
2020-05-07 02:09:38 -04:00
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | yes | ID of a job. |
2016-06-03 13:56:26 -04:00
2020-01-30 10:09:15 -05:00
```shell
2019-07-29 12:19:54 -04:00
curl --location --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/8/trace"
2016-06-03 13:56:26 -04:00
```
2018-12-05 05:08:39 -05:00
Possible response status codes:
2016-06-03 13:56:26 -04:00
2019-10-17 20:07:45 -04:00
| Status | Description |
|-----------|-------------------------------|
| 200 | Serves the log file |
| 404 | Job not found or no log file |
2016-06-03 13:56:26 -04:00
2017-03-06 04:24:03 -05:00
## Cancel a job
2016-01-05 10:36:14 -05:00
2017-03-06 04:24:03 -05:00
Cancel a single job of a project
2016-01-05 10:36:14 -05:00
2020-02-27 04:09:01 -05:00
```plaintext
2017-03-06 04:24:03 -05:00
POST /projects/:id/jobs/:job_id/cancel
2016-01-05 10:36:14 -05:00
```
2018-12-05 05:08:39 -05:00
| Attribute | Type | Required | Description |
|-----------|----------------|----------|------------------------------------------------------------------------------------------------------------------|
2019-03-06 06:06:21 -05:00
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | yes | ID of a job. |
2016-01-13 15:19:18 -05:00
2020-01-30 10:09:15 -05:00
```shell
2018-12-27 04:03:08 -05:00
curl --request POST --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/1/cancel"
2016-01-13 15:19:18 -05:00
```
2016-01-05 10:36:14 -05:00
2016-02-10 08:31:30 -05:00
Example of response
2016-01-05 10:36:14 -05:00
```json
{
2016-06-10 15:45:06 -04:00
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2016-06-10 15:45:06 -04:00
"created_at": "2016-01-11T10:13:33.506Z",
2018-09-09 05:49:44 -04:00
"started_at": "2016-01-11T10:14:09.526Z",
"finished_at": null,
"duration": 8,
2018-07-18 17:57:08 -04:00
"id": 42,
2016-06-10 15:45:06 -04:00
"name": "rubocop",
"ref": "master",
2018-07-18 17:46:56 -04:00
"artifacts": [],
2016-06-10 15:45:06 -04:00
"runner": null,
"stage": "test",
"status": "canceled",
"tag": false,
2018-07-18 17:57:08 -04:00
"web_url": "https://example.com/foo/bar/-/jobs/42",
2016-06-10 15:45:06 -04:00
"user": null
2016-01-05 10:36:14 -05:00
}
```
2017-03-06 04:24:03 -05:00
## Retry a job
2016-01-05 10:36:14 -05:00
2017-03-06 04:24:03 -05:00
Retry a single job of a project
2016-01-05 10:36:14 -05:00
2020-02-27 04:09:01 -05:00
```plaintext
2017-03-06 04:24:03 -05:00
POST /projects/:id/jobs/:job_id/retry
2016-01-05 10:36:14 -05:00
```
2018-12-05 05:08:39 -05:00
| Attribute | Type | Required | Description |
|-----------|----------------|----------|------------------------------------------------------------------------------------------------------------------|
2019-03-06 06:06:21 -05:00
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | yes | ID of a job. |
2016-01-13 15:19:18 -05:00
2020-01-30 10:09:15 -05:00
```shell
2018-12-27 04:03:08 -05:00
curl --request POST --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/1/retry"
2016-01-13 15:19:18 -05:00
```
2016-01-05 10:36:14 -05:00
2016-02-10 08:31:30 -05:00
Example of response
2016-01-05 10:36:14 -05:00
```json
{
2016-06-10 15:45:06 -04:00
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2016-06-10 15:45:06 -04:00
"created_at": "2016-01-11T10:13:33.506Z",
2018-09-09 05:49:44 -04:00
"started_at": null,
2016-06-10 15:45:06 -04:00
"finished_at": null,
2018-09-09 05:49:44 -04:00
"duration": null,
2018-07-18 17:57:08 -04:00
"id": 42,
2016-06-10 15:45:06 -04:00
"name": "rubocop",
"ref": "master",
2018-07-18 17:46:56 -04:00
"artifacts": [],
2016-06-10 15:45:06 -04:00
"runner": null,
"stage": "test",
"status": "pending",
"tag": false,
2018-07-18 17:57:08 -04:00
"web_url": "https://example.com/foo/bar/-/jobs/42",
2016-06-10 15:45:06 -04:00
"user": null
2016-01-05 10:36:14 -05:00
}
```
2016-02-04 06:03:47 -05:00
2017-03-06 04:24:03 -05:00
## Erase a job
2016-02-04 06:03:47 -05:00
2019-10-17 20:07:45 -04:00
Erase a single job of a project (remove job artifacts and a job log)
2016-02-04 06:03:47 -05:00
2020-02-27 04:09:01 -05:00
```plaintext
2017-03-06 04:24:03 -05:00
POST /projects/:id/jobs/:job_id/erase
2016-02-04 06:03:47 -05:00
```
Parameters
2018-12-05 05:08:39 -05:00
| Attribute | Type | Required | Description |
|-----------|----------------|----------|------------------------------------------------------------------------------------------------------------------|
2019-03-06 06:06:21 -05:00
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | yes | ID of a job. |
2016-02-04 06:03:47 -05:00
Example of request
2020-01-30 10:09:15 -05:00
```shell
2018-12-27 04:03:08 -05:00
curl --request POST --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/1/erase"
2016-02-04 06:03:47 -05:00
```
Example of response
```json
{
2016-06-10 15:45:06 -04:00
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2016-06-10 15:45:06 -04:00
"download_url": null,
2018-07-18 17:57:08 -04:00
"id": 42,
2016-06-10 15:45:06 -04:00
"name": "rubocop",
"ref": "master",
2018-07-18 17:46:56 -04:00
"artifacts": [],
2016-06-10 15:45:06 -04:00
"runner": null,
"stage": "test",
"created_at": "2016-01-11T10:13:33.506Z",
"started_at": "2016-01-11T10:13:33.506Z",
"finished_at": "2016-01-11T10:15:10.506Z",
2018-09-09 05:49:44 -04:00
"duration": 97.0,
2016-06-10 15:45:06 -04:00
"status": "failed",
"tag": false,
2018-07-18 17:57:08 -04:00
"web_url": "https://example.com/foo/bar/-/jobs/42",
2016-06-10 15:45:06 -04:00
"user": null
2016-02-04 06:03:47 -05:00
}
```
2016-06-10 11:11:27 -04:00
2017-03-06 04:24:03 -05:00
## Play a job
2016-08-16 04:11:32 -04:00
2017-03-06 04:24:03 -05:00
Triggers a manual action to start a job.
2016-08-16 04:11:32 -04:00
2020-02-27 04:09:01 -05:00
```plaintext
2017-03-06 04:24:03 -05:00
POST /projects/:id/jobs/:job_id/play
2016-08-16 04:11:32 -04:00
```
2018-12-05 05:08:39 -05:00
| Attribute | Type | Required | Description |
|-----------|----------------|----------|------------------------------------------------------------------------------------------------------------------|
2019-03-06 06:06:21 -05:00
| `id` | integer/string | yes | ID or [URL-encoded path of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | yes | ID of a job. |
2016-08-16 04:11:32 -04:00
2020-01-30 10:09:15 -05:00
```shell
2018-12-27 04:03:08 -05:00
curl --request POST --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/1/play"
2016-08-16 04:11:32 -04:00
```
Example of response
```json
{
"commit": {
"author_email": "admin@example.com",
"author_name": "Administrator",
"created_at": "2015-12-24T16:51:14.000+01:00",
"id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"message": "Test the CI integration.",
"short_id": "0ff3ae19",
"title": "Test the CI integration."
},
"coverage": null,
2019-05-21 05:21:53 -04:00
"allow_failure": false,
2016-08-16 04:11:32 -04:00
"created_at": "2016-01-11T10:13:33.506Z",
2018-09-09 05:49:44 -04:00
"started_at": null,
2016-08-16 04:11:32 -04:00
"finished_at": null,
2018-09-09 05:49:44 -04:00
"duration": null,
2018-07-18 17:57:08 -04:00
"id": 42,
2016-08-16 04:11:32 -04:00
"name": "rubocop",
"ref": "master",
2018-07-18 17:46:56 -04:00
"artifacts": [],
2016-08-16 04:11:32 -04:00
"runner": null,
"stage": "test",
"status": "started",
"tag": false,
2018-07-18 17:57:08 -04:00
"web_url": "https://example.com/foo/bar/-/jobs/42",
2016-08-16 04:11:32 -04:00
"user": null
}
```