2020-08-04 06:10:16 +00:00
---
stage: Verify
2021-05-26 15:10:57 +00:00
group: Pipeline Execution
2020-11-26 06:09:20 +00: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 06:10:16 +00:00
---
2021-05-31 03:10:48 +00:00
# Jobs API **(FREE)**
2016-01-05 15:36:14 +00:00
2017-03-06 15:56:05 +00:00
## List project jobs
2016-01-05 15:36:14 +00:00
2019-12-11 12:08:10 +00:00
Get a list of jobs in a project. Jobs are sorted in descending order of their IDs.
2016-01-05 15:36:14 +00:00
2022-01-26 15:12:36 +00:00
By default, this request returns 20 results at a time because the API results [are paginated ](index.md#pagination )
2020-02-27 09:09:01 +00:00
```plaintext
2017-03-06 09:24:03 +00:00
GET /projects/:id/jobs
2016-01-05 15:36:14 +00:00
```
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|-----------|--------------------------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `scope` | string **or** array of strings | ** {dotted-circle}** 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 20:19:18 +00:00
2020-01-30 15:09:15 +00:00
```shell
2020-05-28 00:08:37 +00: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 20:19:18 +00:00
```
2016-02-10 13:31:30 +00:00
Example of response
2016-01-05 15:36:14 +00:00
2017-03-06 15:56:05 +00: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 09:21:53 +00:00
"allow_failure": false,
2019-12-11 12:08:10 +00: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,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.010,
2019-12-11 12:08:10 +00:00
"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 12:09:20 +00:00
"tag_list": [
"docker runner", "ubuntu18"
],
2019-12-11 12:08:10 +00:00
"id": 7,
"name": "teaspoon",
2017-03-06 15:56:05 +00:00
"pipeline": {
"id": 6,
2021-03-15 18:09:05 +00:00
"project_id": 1,
2021-05-27 15:10:39 +00:00
"ref": "main",
2017-03-06 15:56:05 +00:00
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
2021-05-27 15:10:39 +00:00
"ref": "main",
2017-03-06 15:56:05 +00:00
"runner": null,
"stage": "test",
"status": "failed",
2021-12-02 00:17:32 +00:00
"failure_reason": "script_failure",
2017-03-06 15:56:05 +00:00
"tag": false,
2019-12-11 12:08:10 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/7",
2017-03-06 15:56:05 +00:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 14:28:57 +00:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2017-03-06 15:56:05 +00:00
"web_url": "http://gitlab.dev/root",
2018-09-25 14:28:57 +00:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 16:40:24 +00:00
"public_email": "",
2018-09-25 14:28:57 +00:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2017-03-06 15:56:05 +00: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 09:21:53 +00:00
"allow_failure": false,
2019-12-11 12:08:10 +00: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,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.023,
2019-12-11 12:08:10 +00:00
"artifacts_expire_at": "2016-01-23T17:54:24.921Z",
2021-02-08 12:09:20 +00:00
"tag_list": [
"docker runner", "win10-2004"
],
2019-12-11 12:08:10 +00:00
"id": 6,
"name": "rspec:other",
2017-03-06 15:56:05 +00:00
"pipeline": {
"id": 6,
2021-03-15 18:09:05 +00:00
"project_id": 1,
2021-05-27 15:10:39 +00:00
"ref": "main",
2017-03-06 15:56:05 +00:00
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
2021-05-27 15:10:39 +00:00
"ref": "main",
2018-07-18 21:46:56 +00:00
"artifacts": [],
2017-03-06 15:56:05 +00:00
"runner": null,
"stage": "test",
"status": "failed",
2021-12-02 00:17:32 +00:00
"failure_reason": "stuck_or_timeout_failure",
2017-03-06 15:56:05 +00:00
"tag": false,
2019-12-11 12:08:10 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/6",
2017-03-06 15:56:05 +00:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 14:28:57 +00:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2017-03-06 15:56:05 +00:00
"web_url": "http://gitlab.dev/root",
2018-09-25 14:28:57 +00:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 16:40:24 +00:00
"public_email": "",
2018-09-25 14:28:57 +00:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2017-03-06 15:56:05 +00:00
}
}
]
```
## List pipeline jobs
Get a list of jobs for a pipeline.
2022-01-26 15:12:36 +00:00
By default, this request returns 20 results at a time because the API results [are paginated ](index.md#pagination )
2020-02-27 09:09:01 +00:00
```plaintext
2017-04-21 19:43:55 +00:00
GET /projects/:id/pipelines/:pipeline_id/jobs
2017-03-06 15:56:05 +00:00
```
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|-------------------|--------------------------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `pipeline_id` | integer | ** {check-circle}** Yes | ID of a pipeline. Can also be obtained in CI jobs via the [predefined CI variable ](../ci/variables/predefined_variables.md ) `CI_PIPELINE_ID` . |
| `scope` | string **or** array of strings | ** {dotted-circle}** 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 | ** {dotted-circle}** 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 15:56:05 +00:00
2020-01-30 15:09:15 +00:00
```shell
2020-05-28 00:08:37 +00: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 15:56:05 +00:00
```
Example of response
2016-01-05 15:36:14 +00:00
```json
[
2016-06-10 19:45:06 +00: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 09:21:53 +00:00
"allow_failure": false,
2018-07-03 13:42:40 +00:00
"created_at": "2015-12-24T15:51:21.727Z",
2018-09-09 09:49:44 +00:00
"started_at": "2015-12-24T17:54:24.729Z",
2018-07-03 13:42:40 +00:00
"finished_at": "2015-12-24T17:54:24.921Z",
2018-09-09 09:49:44 +00:00
"duration": 0.192,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.023,
2018-07-18 21:57:08 +00:00
"artifacts_expire_at": "2016-01-23T17:54:24.921Z",
2021-02-08 12:09:20 +00:00
"tag_list": [
"docker runner", "ubuntu18"
],
2018-07-03 13:42:40 +00:00
"id": 6,
"name": "rspec:other",
2016-09-23 23:43:57 +00:00
"pipeline": {
"id": 6,
2021-03-15 18:09:05 +00:00
"project_id": 1,
2021-05-27 15:10:39 +00:00
"ref": "main",
2016-09-23 23:43:57 +00:00
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
2016-11-15 10:40:36 +00:00
},
2021-05-27 15:10:39 +00:00
"ref": "main",
2018-07-18 21:46:56 +00:00
"artifacts": [],
2016-06-10 19:45:06 +00:00
"runner": null,
"stage": "test",
"status": "failed",
2021-12-02 00:17:32 +00:00
"failure_reason": "stuck_or_timeout_failure",
2016-06-10 19:45:06 +00:00
"tag": false,
2018-07-18 21:57:08 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/6",
2016-06-10 19:45:06 +00:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 14:28:57 +00:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2016-10-13 11:24:09 +00:00
"web_url": "http://gitlab.dev/root",
2018-09-25 14:28:57 +00:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 16:40:24 +00:00
"public_email": "",
2018-09-25 14:28:57 +00:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2016-06-10 19:45:06 +00: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 15:36:14 +00:00
},
2016-06-10 19:45:06 +00:00
"coverage": null,
2019-05-21 09:21:53 +00:00
"allow_failure": false,
2018-07-03 13:42:40 +00:00
"created_at": "2015-12-24T15:51:21.802Z",
2018-09-09 09:49:44 +00:00
"started_at": "2015-12-24T17:54:27.722Z",
"finished_at": "2015-12-24T17:54:27.895Z",
"duration": 0.173,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.023,
2018-07-03 13:42:40 +00:00
"artifacts_file": {
"filename": "artifacts.zip",
"size": 1000
},
2018-07-18 21:46:56 +00: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 21:57:08 +00:00
"artifacts_expire_at": "2016-01-23T17:54:27.895Z",
2021-02-08 12:09:20 +00:00
"tag_list": [
"docker runner", "ubuntu18"
],
2018-07-03 13:42:40 +00:00
"id": 7,
"name": "teaspoon",
2016-09-23 23:43:57 +00:00
"pipeline": {
"id": 6,
2021-03-15 18:09:05 +00:00
"project_id": 1,
2021-05-27 15:10:39 +00:00
"ref": "main",
2016-09-23 23:43:57 +00:00
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
2016-11-15 10:40:36 +00:00
},
2021-05-27 15:10:39 +00:00
"ref": "main",
2016-06-10 19:45:06 +00:00
"runner": null,
"stage": "test",
"status": "failed",
2021-12-02 00:17:32 +00:00
"failure_reason": "script_failure",
2016-06-10 19:45:06 +00:00
"tag": false,
2018-07-18 21:57:08 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/7",
2016-06-10 19:45:06 +00:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 14:28:57 +00:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2016-10-13 11:24:09 +00:00
"web_url": "http://gitlab.dev/root",
2018-09-25 14:28:57 +00:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 16:40:24 +00:00
"public_email": "",
2018-09-25 14:28:57 +00:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2016-01-05 15:36:14 +00:00
}
2016-06-10 19:45:06 +00:00
}
2016-01-05 15:36:14 +00:00
]
2016-01-12 10:50:14 +00:00
```
2021-11-09 03:42:22 +00:00
In GitLab 13.3 and later, this endpoint [returns data for any pipeline ](pipelines.md#get-a-single-pipeline )
2021-06-30 15:08:27 +00:00
including [child pipelines ](../ci/pipelines/parent_child_pipelines.md ).
2020-07-17 18:09:20 +00:00
2021-02-16 18:09:24 +00:00
In GitLab 13.5 and later, this endpoint does not return retried jobs in the response
2021-04-12 15:09:30 +00:00
by default. Additionally, jobs are sorted by ID in descending order (newest first).
In earlier GitLab versions, jobs are sorted by ID in ascending order (oldest first).
2021-02-16 18:09:24 +00:00
In GitLab 13.9 and later, this endpoint can include retried jobs in the response
with `include_retried` set to `true` .
2020-06-16 12:09:00 +00:00
## List pipeline bridges
Get a list of bridge jobs for a pipeline.
```plaintext
GET /projects/:id/pipelines/:pipeline_id/bridges
```
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|---------------|--------------------------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `pipeline_id` | integer | ** {check-circle}** Yes | ID of a pipeline. |
| `scope` | string **or** array of strings | ** {dotted-circle}** 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. |
2020-06-16 12:09:00 +00:00
```shell
2020-12-08 09:09:41 +00: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 12:09:00 +00: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,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.123,
2020-06-16 12:09:00 +00:00
"id": 7,
"name": "teaspoon",
"pipeline": {
"id": 6,
2021-03-15 18:09:05 +00:00
"project_id": 1,
2021-05-27 15:10:39 +00:00
"ref": "main",
2020-06-16 12:09:00 +00:00
"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"
},
2021-05-27 15:10:39 +00:00
"ref": "main",
2020-06-16 12:09:00 +00:00
"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",
2021-05-27 15:10:39 +00:00
"ref": "main",
2020-06-16 12:09:00 +00:00
"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"
}
}
]
```
2021-02-25 12:11:01 +00:00
## Get job token's job
2021-04-02 18:09:20 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/51727) in GitLab 13.10.
2021-02-25 12:11:01 +00:00
Retrieve the job that generated a job token.
```plaintext
GET /job
```
2021-10-19 15:12:08 +00:00
Examples (must run as part of the [`script` ](../ci/yaml/index.md#script ) section of a [CI/CD job ](../ci/jobs/index.md )):
2021-02-25 12:11:01 +00:00
```shell
2021-10-19 15:12:08 +00:00
curl --header "Authorization: Bearer $CI_JOB_TOKEN" "${CI_API_V4_URL}/job"
curl --header "JOB-TOKEN: $CI_JOB_TOKEN" "${CI_API_V4_URL}/job"
curl "${CI_API_V4_URL}/job?job_token=$CI_JOB_TOKEN"
2021-02-25 12:11:01 +00: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.880Z",
"started_at": "2015-12-24T17:54:30.733Z",
"finished_at": "2015-12-24T17:54:31.198Z",
"duration": 0.465,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.123,
2021-02-25 12:11:01 +00:00
"artifacts_expire_at": "2016-01-23T17:54:31.198Z",
"id": 8,
"name": "rubocop",
"pipeline": {
"id": 6,
2021-03-15 18:09:05 +00:00
"project_id": 1,
2021-05-27 15:10:39 +00:00
"ref": "main",
2021-02-25 12:11:01 +00:00
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
2021-05-27 15:10:39 +00:00
"ref": "main",
2021-02-25 12:11:01 +00:00
"artifacts": [],
"runner": null,
"stage": "test",
"status": "failed",
2021-12-02 00:17:32 +00:00
"failure_reason": "script_failure",
2021-02-25 12:11:01 +00:00
"tag": false,
"web_url": "https://example.com/foo/bar/-/jobs/8",
"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": ""
}
}
```
2022-02-22 00:14:20 +00:00
## Get GitLab agent by `CI_JOB_TOKEN` **(PREMIUM)**
2021-04-15 18:09:01 +00:00
2021-09-07 09:11:43 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/324269) in GitLab 13.11.
2021-04-15 18:09:01 +00:00
2021-12-09 21:11:06 +00:00
Retrieve the job that generated the `CI_JOB_TOKEN` , along with a list of allowed
[agents ](../user/clusters/agent/index.md ).
2021-04-15 18:09:01 +00:00
```plaintext
GET /job/allowed_agents
```
Supported attributes:
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|----------------|----------|------------------------|-------------|
| `CI_JOB_TOKEN` | string | ** {check-circle}** Yes | Token value associated with the GitLab-provided `CI_JOB_TOKEN` variable. |
2021-04-15 18:09:01 +00:00
Example request:
```shell
curl --header "JOB-TOKEN: < CI_JOB_TOKEN > " "https://gitlab.example.com/api/v4/job/allowed_agents"
curl "https://gitlab.example.com/api/v4/job/allowed_agents?job_token=< CI_JOB_TOKEN > "
```
Example response:
```json
{
"allowed_agents":
[
{
"id": 1,
"config_project": {
"id": 1,
"description": null,
"name": "project1",
"name_with_namespace": "John Doe2 / project1",
"path": "project1",
"path_with_namespace": "namespace1/project1",
"created_at": "2021-03-26T14:51:50.579Z"
}
}
],
"job": {
"id": 1,
"name": "test",
"stage": "test",
"project_id": 1,
"project_name": "project1"
},
"pipeline": {
"id": 1,
"project_id": 1,
"sha": "b83d6e391c22777fca1ed3012fce84f633d7fed0",
2021-05-27 15:10:39 +00:00
"ref": "main",
2021-04-15 18:09:01 +00:00
"status": "pending",
"created_at": "2021-03-26T14:51:51.107Z",
"updated_at": "2021-03-26T14:51:51.107Z",
"web_url": "http://localhost/namespace1/project1/-/pipelines/1"
},
"project": {
"id": 1,
"description": null,
"name": "project1",
"name_with_namespace": "John Doe2 / project1",
"path": "project1",
"path_with_namespace": "namespace1/project1",
"created_at": "2021-03-26T14:51:50.579Z"
},
"user": {
"id": 2,
"name": "John Doe3",
"username": "user2",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/10fc7f102b",
"web_url": "http://localhost/user2"
}
}
```
2017-03-06 09:24:03 +00:00
## Get a single job
2016-01-05 15:36:14 +00:00
2017-03-06 09:24:03 +00:00
Get a single job of a project
2016-01-05 15:36:14 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-03-06 09:24:03 +00:00
GET /projects/:id/jobs/:job_id
2016-01-05 15:36:14 +00:00
```
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | ** {check-circle}** Yes | ID of a job. |
2016-01-13 20:19:18 +00:00
2020-01-30 15:09:15 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/8"
2016-01-13 20:19:18 +00:00
```
2016-02-10 13:31:30 +00:00
Example of response
2016-01-05 15:36:14 +00:00
```json
{
2016-06-10 19:45:06 +00: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 09:21:53 +00:00
"allow_failure": false,
2016-06-10 19:45:06 +00:00
"created_at": "2015-12-24T15:51:21.880Z",
2018-09-09 09:49:44 +00:00
"started_at": "2015-12-24T17:54:30.733Z",
2016-06-10 19:45:06 +00:00
"finished_at": "2015-12-24T17:54:31.198Z",
2018-09-09 09:49:44 +00:00
"duration": 0.465,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.010,
2018-05-10 07:58:19 +00:00
"artifacts_expire_at": "2016-01-23T17:54:31.198Z",
2021-02-08 12:09:20 +00:00
"tag_list": [
"docker runner", "macos-10.15"
],
2016-06-10 19:45:06 +00:00
"id": 8,
"name": "rubocop",
2016-09-23 23:43:57 +00:00
"pipeline": {
"id": 6,
2021-03-15 18:09:05 +00:00
"project_id": 1,
2021-05-27 15:10:39 +00:00
"ref": "main",
2016-09-23 23:43:57 +00:00
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
2016-11-15 10:40:36 +00:00
},
2021-05-27 15:10:39 +00:00
"ref": "main",
2018-07-18 21:46:56 +00:00
"artifacts": [],
2016-06-10 19:45:06 +00:00
"runner": null,
"stage": "test",
"status": "failed",
"tag": false,
2018-07-18 21:57:08 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/8",
2016-06-10 19:45:06 +00:00
"user": {
"id": 1,
"name": "Administrator",
"username": "root",
2018-09-25 14:28:57 +00:00
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80& d=identicon",
2016-10-13 11:24:09 +00:00
"web_url": "http://gitlab.dev/root",
2018-09-25 14:28:57 +00:00
"created_at": "2015-12-21T13:14:24.077Z",
"bio": null,
"location": null,
2018-09-25 16:40:24 +00:00
"public_email": "",
2018-09-25 14:28:57 +00:00
"skype": "",
"linkedin": "",
"twitter": "",
"website_url": "",
"organization": ""
2016-06-10 19:45:06 +00:00
}
2016-01-05 15:36:14 +00:00
}
```
2019-10-18 00:07:45 +00:00
## Get a log file
2016-06-03 17:56:26 +00:00
2019-10-18 00:07:45 +00:00
Get a log (trace) of a specific job of a project:
2016-06-03 17:56:26 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-03-06 09:24:03 +00:00
GET /projects/:id/jobs/:job_id/trace
2016-06-03 17:56:26 +00:00
```
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | ** {check-circle}** Yes | ID of a job. |
2016-06-03 17:56:26 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-07-29 16:19:54 +00:00
curl --location --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/8/trace"
2016-06-03 17:56:26 +00:00
```
2018-12-05 10:08:39 +00:00
Possible response status codes:
2016-06-03 17:56:26 +00:00
2019-10-18 00:07:45 +00:00
| Status | Description |
|-----------|-------------------------------|
| 200 | Serves the log file |
| 404 | Job not found or no log file |
2016-06-03 17:56:26 +00:00
2017-03-06 09:24:03 +00:00
## Cancel a job
2016-01-05 15:36:14 +00:00
2017-03-06 09:24:03 +00:00
Cancel a single job of a project
2016-01-05 15:36:14 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-03-06 09:24:03 +00:00
POST /projects/:id/jobs/:job_id/cancel
2016-01-05 15:36:14 +00:00
```
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | ** {check-circle}** Yes | ID of a job. |
2016-01-13 20:19:18 +00:00
2020-01-30 15:09:15 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --request POST --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/1/cancel"
2016-01-13 20:19:18 +00:00
```
2016-01-05 15:36:14 +00:00
2016-02-10 13:31:30 +00:00
Example of response
2016-01-05 15:36:14 +00:00
```json
{
2016-06-10 19:45:06 +00: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 09:21:53 +00:00
"allow_failure": false,
2016-06-10 19:45:06 +00:00
"created_at": "2016-01-11T10:13:33.506Z",
2018-09-09 09:49:44 +00:00
"started_at": "2016-01-11T10:14:09.526Z",
"finished_at": null,
"duration": 8,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.010,
2022-06-30 03:08:59 +00:00
"id": 1,
2016-06-10 19:45:06 +00:00
"name": "rubocop",
2021-05-27 15:10:39 +00:00
"ref": "main",
2018-07-18 21:46:56 +00:00
"artifacts": [],
2016-06-10 19:45:06 +00:00
"runner": null,
"stage": "test",
"status": "canceled",
"tag": false,
2018-07-18 21:57:08 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/42",
2016-06-10 19:45:06 +00:00
"user": null
2016-01-05 15:36:14 +00:00
}
```
2017-03-06 09:24:03 +00:00
## Retry a job
2016-01-05 15:36:14 +00:00
2017-03-06 09:24:03 +00:00
Retry a single job of a project
2016-01-05 15:36:14 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-03-06 09:24:03 +00:00
POST /projects/:id/jobs/:job_id/retry
2016-01-05 15:36:14 +00:00
```
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | ** {check-circle}** Yes | ID of a job. |
2016-01-13 20:19:18 +00:00
2020-01-30 15:09:15 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --request POST --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/1/retry"
2016-01-13 20:19:18 +00:00
```
2016-01-05 15:36:14 +00:00
2016-02-10 13:31:30 +00:00
Example of response
2016-01-05 15:36:14 +00:00
```json
{
2016-06-10 19:45:06 +00: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 09:21:53 +00:00
"allow_failure": false,
2016-06-10 19:45:06 +00:00
"created_at": "2016-01-11T10:13:33.506Z",
2018-09-09 09:49:44 +00:00
"started_at": null,
2016-06-10 19:45:06 +00:00
"finished_at": null,
2018-09-09 09:49:44 +00:00
"duration": null,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.010,
2022-06-30 03:08:59 +00:00
"id": 1,
2016-06-10 19:45:06 +00:00
"name": "rubocop",
2021-05-27 15:10:39 +00:00
"ref": "main",
2018-07-18 21:46:56 +00:00
"artifacts": [],
2016-06-10 19:45:06 +00:00
"runner": null,
"stage": "test",
"status": "pending",
"tag": false,
2018-07-18 21:57:08 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/42",
2016-06-10 19:45:06 +00:00
"user": null
2016-01-05 15:36:14 +00:00
}
```
2016-02-04 11:03:47 +00:00
2017-03-06 09:24:03 +00:00
## Erase a job
2016-02-04 11:03:47 +00:00
2019-10-18 00:07:45 +00:00
Erase a single job of a project (remove job artifacts and a job log)
2016-02-04 11:03:47 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-03-06 09:24:03 +00:00
POST /projects/:id/jobs/:job_id/erase
2016-02-04 11:03:47 +00:00
```
Parameters
2022-01-26 15:12:36 +00:00
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | ** {check-circle}** Yes | ID of a job. |
2016-02-04 11:03:47 +00:00
Example of request
2020-01-30 15:09:15 +00:00
```shell
2018-12-27 09:03:08 +00:00
curl --request POST --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/jobs/1/erase"
2016-02-04 11:03:47 +00:00
```
Example of response
```json
{
2016-06-10 19:45:06 +00: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 09:21:53 +00:00
"allow_failure": false,
2016-06-10 19:45:06 +00:00
"download_url": null,
2022-06-30 03:08:59 +00:00
"id": 1,
2016-06-10 19:45:06 +00:00
"name": "rubocop",
2021-05-27 15:10:39 +00:00
"ref": "main",
2018-07-18 21:46:56 +00:00
"artifacts": [],
2016-06-10 19:45:06 +00: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 09:49:44 +00:00
"duration": 97.0,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.010,
2016-06-10 19:45:06 +00:00
"status": "failed",
"tag": false,
2018-07-18 21:57:08 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/42",
2016-06-10 19:45:06 +00:00
"user": null
2016-02-04 11:03:47 +00:00
}
```
2016-06-10 15:11:27 +00:00
2021-12-09 03:13:31 +00:00
NOTE:
You can't delete archived jobs with the API, but you can
[delete job artifacts and logs from jobs completed before a specific date ](../administration/job_artifacts.md#delete-job-artifacts-and-logs-from-jobs-completed-before-a-specific-date )
2022-03-14 18:07:46 +00:00
## Run a job
2016-08-16 08:11:32 +00:00
2017-03-06 09:24:03 +00:00
Triggers a manual action to start a job.
2016-08-16 08:11:32 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2017-03-06 09:24:03 +00:00
POST /projects/:id/jobs/:job_id/play
2016-08-16 08:11:32 +00:00
```
2022-03-02 18:16:35 +00:00
| Attribute | Type | Required | Description |
|----------------------------|-----------------|------------------------|-------------|
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user. |
| `job_id` | integer | ** {check-circle}** Yes | ID of a job. |
| `job_variables_attributes` | array of hashes | ** {dotted-circle}** No | An array containing the custom variables available to the job. [Introduced in ](https://gitlab.com/gitlab-org/gitlab/-/issues/37267 ) GitLab 14.9. |
Example request:
2016-08-16 08:11:32 +00:00
2020-01-30 15:09:15 +00:00
```shell
2022-03-02 18:16:35 +00:00
curl --request POST "https://gitlab.example.com/api/v4/projects/1/jobs/1/play
--header "PRIVATE-TOKEN: < your_access_token > "
--data @variables .json
2016-08-16 08:11:32 +00:00
```
2022-03-02 18:16:35 +00:00
`@variables.json` is structured like:
```json
{
"job_variables_attributes": [
{
"key": "TEST_VAR_1",
"value": "test1"
},
{
"key": "TEST_VAR_2",
"value": "test2"
}
]
}
```
Example response:
2016-08-16 08:11:32 +00: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 09:21:53 +00:00
"allow_failure": false,
2016-08-16 08:11:32 +00:00
"created_at": "2016-01-11T10:13:33.506Z",
2018-09-09 09:49:44 +00:00
"started_at": null,
2016-08-16 08:11:32 +00:00
"finished_at": null,
2018-09-09 09:49:44 +00:00
"duration": null,
2021-04-26 18:09:45 +00:00
"queued_duration": 0.010,
2022-06-30 03:08:59 +00:00
"id": 1,
2016-08-16 08:11:32 +00:00
"name": "rubocop",
2021-05-27 15:10:39 +00:00
"ref": "main",
2018-07-18 21:46:56 +00:00
"artifacts": [],
2016-08-16 08:11:32 +00:00
"runner": null,
"stage": "test",
2021-04-26 18:09:45 +00:00
"status": "pending",
2016-08-16 08:11:32 +00:00
"tag": false,
2018-07-18 21:57:08 +00:00
"web_url": "https://example.com/foo/bar/-/jobs/42",
2016-08-16 08:11:32 +00:00
"user": null
}
```