Pipelines

Use this API to manage CI/CD pipelines and the jobs they run.

List pipelines triggered by the authenticated user

GET /api/v4/pipelines

Lists recently created pipelines across all projects that were triggered by the authenticated user. By default, child pipelines are not included in the results. To return child pipelines, set source to parent_pipeline. This endpoint only supports keyset pagination.

Parameters

Name	Type	Description
`source` Query	String	The source of pipelines Allowed values: `unknown`, `push`, `web`, `trigger`, `schedule`, `api`, `external`, `pipeline`, `chat`, `webide`, `merge_request_event`, `external_pull_request_event`, `parent_pipeline`, `ondemand_dast_scan`, `ondemand_dast_validation`, `security_orchestration_policy`, `container_registry_push`, `duo_workflow`, `pipeline_execution_policy_schedule`, `dependency_management_security_update` Example: `push`
`created_before` Query	String (date-time)	Return pipelines created before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ Example: `2015-12-24T15:51:21.880Z`
`created_after` Query	String (date-time)	Return pipelines created after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ Example: `2015-12-24T15:51:21.880Z`
`order_by` Query	String	Return pipelines ordered by `created_at` Allowed values: `created_at` Default: `created_at` Example: `created_at`
`sort` Query	String	Return pipelines sorted in `desc` order Allowed values: `desc` Default: `desc` Example: `desc`
`cursor` Query	String	Cursor for obtaining the next set of records Example: `eyJpZCI6IjE0In0`
`per_page` Query	Integer	Number of items per page Default: `20` Maximum: `100` Minimum: `1` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiUserPipeline
`400`	Bad Request	—
`401`	Unauthorized	—

Create a pipeline

POST /api/v4/projects/{id}/pipeline

Creates a pipeline in the specified project.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`

Request body (application/json)

Property	Type	Description
`inputs`	Object	The list of inputs to be used to create the pipeline
`ref` Required	String	Reference Example: `develop`
`variables`	Array of objects	Array of variables available in the pipeline
`variables[].key`	String	The key of the variable Example: `UPLOAD_TO_S3`
`variables[].value`	String	The value of the variable Example: `true`
`variables[].variable_type`	String	The type of variable, must be one of env_var or file. Defaults to env_var Allowed values: `env_var`, `file` Default: `env_var`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiPipeline
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

List all project pipelines

GET /api/v4/projects/{id}/pipelines

Lists all pipelines in a project. By default, child pipelines are not included in the results. To return child pipelines, set source to parent_pipeline.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`scope` Query	String	The scope of pipelines Allowed values: `running`, `pending`, `finished`, `branches`, `tags` Example: `pending`
`status` Query	String	The status of pipelines Allowed values: `created`, `waiting_for_resource`, `preparing`, `waiting_for_callback`, `pending`, `running`, `success`, `failed`, `canceling`, `canceled`, `skipped`, `manual`, `scheduled` Example: `pending`
`ref` Query	String	The ref of pipelines Example: `develop`
`sha` Query	String	The sha of pipelines Example: `a91957a858320c0e17f3a0eca7cfacbff50ea29a`
`yaml_errors` Query	Boolean	Returns pipelines with invalid configurations Example: `false`
`username` Query	String	The username of the user who triggered pipelines Example: `root`
`updated_before` Query	String (date-time)	Return pipelines updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ Example: `2015-12-24T15:51:21.880Z`
`updated_after` Query	String (date-time)	Return pipelines updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ Example: `2015-12-24T15:51:21.880Z`
`created_before` Query	String (date-time)	Return pipelines created before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ Example: `2015-12-24T15:51:21.880Z`
`created_after` Query	String (date-time)	Return pipelines created after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ Example: `2015-12-24T15:51:21.880Z`
`order_by` Query	String	Order pipelines Allowed values: `id`, `status`, `ref`, `updated_at`, `user_id` Default: `id` Example: `status`
`sort` Query	String	Sort pipelines Allowed values: `asc`, `desc` Default: `desc` Example: `asc`
`source` Query	String	The source of pipelines Allowed values: `unknown`, `push`, `web`, `trigger`, `schedule`, `api`, `external`, `pipeline`, `chat`, `webide`, `merge_request_event`, `external_pull_request_event`, `parent_pipeline`, `ondemand_dast_scan`, `ondemand_dast_validation`, `security_orchestration_policy`, `container_registry_push`, `duo_workflow`, `pipeline_execution_policy_schedule`, `dependency_management_security_update` Example: `push`
`name` Query	String	Filter pipelines by name Example: `Build pipeline`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiPipelineBasic
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Retrieve the latest pipeline

GET /api/v4/projects/{id}/pipelines/latest

Retrieves the latest pipeline for the most recent commit on a specified ref in a project. If no pipeline exists for the commit, a 403 status code is returned. Use the page and per_page pagination parameters to control the pagination of results.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`ref` Query	String	Branch ref of pipeline. Uses project default branch if not specified Example: `develop`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiPipelineWithMetadata
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Retrieve a pipeline

GET /api/v4/projects/{id}/pipelines/{pipeline_id}

Retrieves a specified pipeline from a project. You can also get a child pipeline.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiPipelineWithMetadata
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Delete a pipeline

DELETE /api/v4/projects/{id}/pipelines/{pipeline_id}

Deletes a specified pipeline for a project.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`

Responses

Code	Description	Schema
`204`	Pipeline was deleted	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

List all bridge jobs by pipeline (deprecated)

GET /api/v4/projects/{id}/pipelines/{pipeline_id}/bridges

Deprecated in GitLab 19.2. Use trigger_jobs endpoint instead.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`
`scope` Query	String or array of strings	The scope of builds to show Example: `["pending","running"]`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiBridge
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Cancel all jobs for a pipeline

POST /api/v4/projects/{id}/pipelines/{pipeline_id}/cancel

Cancels all jobs in a specified pipeline.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiPipeline
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

List all jobs by pipeline

GET /api/v4/projects/{id}/pipelines/{pipeline_id}/jobs

Lists all jobs for a specified pipeline.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`
`include_retried` Query	Boolean	Includes retried jobs Default: `false`
`scope` Query	String or array of strings	The scope of builds to show Example: `["pending","running"]`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiJob
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Update pipeline metadata

PUT /api/v4/projects/{id}/pipelines/{pipeline_id}/metadata

Updates pipeline metadata. The metadata contains the name of the pipeline. This feature was introduced in GitLab 16.6.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`

Request body (application/json)

Property	Type	Description
`name` Required	String	The name of the pipeline Example: `Deployment to production`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiPipelineWithMetadata
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Retry jobs in a pipeline

POST /api/v4/projects/{id}/pipelines/{pipeline_id}/retry

Retries failed or canceled jobs in a pipeline. If there are no failed or canceled jobs in the pipeline, calling this endpoint has no effect.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiPipeline
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Retrieve a test report for a pipeline

GET /api/v4/projects/{id}/pipelines/{pipeline_id}/test_report

Retrieves a test report for a pipeline.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`

Responses

Code	Description	Schema
`200`	OK	TestReportEntity
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Retrieve a test report summary for a pipeline

GET /api/v4/projects/{id}/pipelines/{pipeline_id}/test_report_summary

Retrieves a test report summary for a pipeline.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`

Responses

Code	Description	Schema
`200`	OK	TestReportSummaryEntity
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

List all trigger jobs by pipeline

GET /api/v4/projects/{id}/pipelines/{pipeline_id}/trigger_jobs

Lists all trigger jobs for a specified pipeline.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`
`scope` Query	String or array of strings	The scope of builds to show Example: `["pending","running"]`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiBridge
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

List all pipeline variables

GET /api/v4/projects/{id}/pipelines/{pipeline_id}/variables

Lists all pipeline variables for a specified pipeline. Use the page and per_page pagination parameters to control the pagination of results.

Parameters

Name	Type	Description
`id` Path, required	String	The project ID or URL-encoded path Example: `11`
`pipeline_id` Path, required	Integer	The pipeline ID Example: `18`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiVariable
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesCiBridge

Property	Type	Description
`allow_failure`	Boolean	—
`commit`	APIEntitiesCommit	—
`coverage`	Number (float)	Example: `98.29`
`created_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`downstream_pipeline`	APIEntitiesCiPipelineBasic	—
`duration`	Number (float)	Time spent running Example: `0.465`
`erased_at`	String (date-time)	Example: `2015-12-24T18:00:29.728Z`
`failure_reason`	String	Example: `script_failure`
`finished_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `deploy_to_production`
`pipeline`	APIEntitiesCiPipelineBasic	—
`project`	Object	—
`project.ci_job_token_scope_enabled`	String	Example: `false`
`queued_duration`	Number (float)	Time spent enqueued Example: `0.123`
`ref`	String	Example: `main`
`stage`	String	Example: `deploy`
`started_at`	String (date-time)	Example: `2015-12-24T17:54:30.733Z`
`status`	String	Example: `waiting_for_resource`
`tag`	Boolean	—
`user`	APIEntitiesUser	—
`web_url`	String	Example: `https://example.com/foo/bar/-/jobs/1`

APIEntitiesCiJob

Property	Type	Description
`allow_failure`	Boolean	—
`archived`	Boolean	Example: `false`
`artifacts`	Array of APIEntitiesCiJobArtifact	—
`artifacts_expire_at`	String (date-time)	Example: `2016-01-19T09:05:50.355Z`
`artifacts_file`	APIEntitiesCiJobArtifactFile	—
`commit`	APIEntitiesCommit	—
`coverage`	Number (float)	Example: `98.29`
`created_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`duration`	Number (float)	Time spent running Example: `0.465`
`erased_at`	String (date-time)	Example: `2015-12-24T18:00:29.728Z`
`failure_reason`	String	Example: `script_failure`
`finished_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `deploy_to_production`
`pipeline`	APIEntitiesCiPipelineBasic	—
`project`	Object	—
`project.ci_job_token_scope_enabled`	String	Example: `false`
`queued_duration`	Number (float)	Time spent enqueued Example: `0.123`
`ref`	String	Example: `main`
`runner`	APIEntitiesCiRunner	—
`runner_manager`	APIEntitiesCiRunnerManager	—
`stage`	String	Example: `deploy`
`started_at`	String (date-time)	Example: `2015-12-24T17:54:30.733Z`
`status`	String	Example: `waiting_for_resource`
`tag`	Boolean	—
`tag_list`	Array of strings	Example: `["ubuntu18","docker runner"]`
`user`	APIEntitiesUser	—
`web_url`	String	Example: `https://example.com/foo/bar/-/jobs/1`

APIEntitiesCiJobArtifact

Property	Type	Description
`file_format`	String	Allowed values: `raw`, `zip`, `gzip` Example: `zip`
`file_type`	String	Allowed values: `archive`, `metadata`, `trace`, `junit`, `sast`, `dependency_scanning`, `container_scanning`, `dast`, `codequality`, `license_scanning`, `performance`, `metrics`, `metrics_referee`, `network_referee`, `lsif`, `dotenv`, `cobertura`, `terraform`, `accessibility`, `cluster_applications`, `secret_detection`, `requirements`, `coverage_fuzzing`, `browser_performance`, `load_performance`, `api_fuzzing`, `cluster_image_scanning`, `cyclonedx`, `requirements_v2`, `annotations`, `repository_xray`, `jacoco`, `sarif` Example: `archive`
`filename`	String	Example: `artifacts.zip`
`size`	Integer	Example: `1000`

APIEntitiesCiJobArtifactFile

Property	Type	Description
`filename`	String	Example: `artifacts.zip`
`size`	Integer	Example: `1000`

APIEntitiesCiPipeline

Property	Type	Description
`archived`	Boolean	Example: `false`
`before_sha`	String	Example: `a91957a858320c0e17f3a0eca7cfacbff50ea29a`
`committed_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`coverage`	Number (float)	Example: `98.29`
`created_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`detailed_status`	DetailedStatusEntity	—
`duration`	Integer	Time spent running in seconds Example: `127`
`finished_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`id`	Integer (int64)	Example: `1`
`iid`	Integer	Example: `2`
`project_id`	Integer (int64)	Example: `3`
`queued_duration`	Integer	Time spent enqueued in seconds Example: `63`
`ref`	String	Example: `feature-branch`
`sha`	String	Example: `0ec9e58fdfca6cdd6652c083c9edb53abc0bad52`
`source`	String	Example: `push`
`started_at`	String (date-time)	Example: `2015-12-24T17:54:30.733Z`
`status`	String	Example: `success`
`tag`	Boolean	Example: `false`
`updated_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`user`	APIEntitiesUserBasic	—
`web_url`	String	Example: `https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61`
`yaml_errors`	String	Example: `widgets:build: needs 'widgets:test'`

APIEntitiesCiPipelineBasic

Property	Type	Description
`created_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`id`	Integer (int64)	Example: `1`
`iid`	Integer	Example: `2`
`project_id`	Integer (int64)	Example: `3`
`ref`	String	Example: `feature-branch`
`sha`	String	Example: `0ec9e58fdfca6cdd6652c083c9edb53abc0bad52`
`source`	String	Example: `push`
`status`	String	Example: `success`
`updated_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`web_url`	String	Example: `https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61`

APIEntitiesCiPipelineMergeRequest

Property	Type	Description
`iid`	Integer	Example: `14`
`title`	String	Example: `Add rate limiting to the public API`
`web_url`	String	Example: `https://gitlab.example.com/foo/bar/-/merge_requests/14`

APIEntitiesCiPipelineWithMetadata

Property	Type	Description
`archived`	Boolean	Example: `false`
`before_sha`	String	Example: `a91957a858320c0e17f3a0eca7cfacbff50ea29a`
`committed_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`coverage`	Number (float)	Example: `98.29`
`created_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`detailed_status`	DetailedStatusEntity	—
`duration`	Integer	Time spent running in seconds Example: `127`
`finished_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`id`	Integer (int64)	Example: `1`
`iid`	Integer	Example: `2`
`name`	String	Example: `Build pipeline`
`project_id`	Integer (int64)	Example: `3`
`queued_duration`	Integer	Time spent enqueued in seconds Example: `63`
`ref`	String	Example: `feature-branch`
`sha`	String	Example: `0ec9e58fdfca6cdd6652c083c9edb53abc0bad52`
`source`	String	Example: `push`
`started_at`	String (date-time)	Example: `2015-12-24T17:54:30.733Z`
`status`	String	Example: `success`
`tag`	Boolean	Example: `false`
`updated_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`user`	APIEntitiesUserBasic	—
`web_url`	String	Example: `https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61`
`yaml_errors`	String	Example: `widgets:build: needs 'widgets:test'`

APIEntitiesCiRunner

Property	Type	Description
`active`	Boolean	Example: `true`
`created_at`	String (date-time)	Example: `2025-05-03T00:00:00.000Z`
`created_by`	APIEntitiesUserBasic	—
`description`	String	Example: `test-1-20150125`
`id`	Integer (int64)	Example: `8`
`ip_address`	String	Example: `127.0.0.1`
`is_shared`	Boolean	Example: `true`
`job_execution_status`	String	Allowed values: `active`, `idle` Example: `idle`
`name`	String	Example: `test`
`online`	Boolean	Example: `true`
`paused`	Boolean	Example: `false`
`runner_type`	String	Allowed values: `instance_type`, `group_type`, `project_type` Example: `instance_type`
`status`	String	Example: `online`

APIEntitiesCiRunnerManager

Property	Type	Description
`architecture`	String	Example: `amd64`
`contacted_at`	String	Example: `2023-10-24T01:27:06.549Z`
`created_at`	String	Example: `2023-10-24T01:27:06.549Z`
`id`	Integer (int64)	Example: `8`
`ip_address`	String	Example: `127.0.0.1`
`job_execution_status`	String	Allowed values: `active`, `idle` Example: `idle`
`platform`	String	Example: `linux`
`revision`	String	Example: `91a27b2a`
`status`	String	Example: `online`
`system_id`	String	Example: `runner-1`
`version`	String	Example: `16.11.0`

APIEntitiesCiUserPipeline

Property	Type	Description
`created_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`detailed_status`	DetailedStatusEntity	—
`duration`	Integer	Time spent running in seconds Example: `127`
`finished_at`	String (date-time)	Example: `2022-10-21T16:52:12.000+02:00`
`id`	Integer (int64)	Example: `1`
`iid`	Integer	Example: `2`
`merge_request`	APIEntitiesCiPipelineMergeRequest	—
`name`	String	Example: `Build pipeline`
`project`	APIEntitiesProjectIdentity	—
`project_id`	Integer (int64)	Example: `3`
`queued_duration`	Integer	Time spent queued in seconds Example: `63`
`ref`	String	Example: `feature-branch`
`sha`	String	Example: `0ec9e58fdfca6cdd6652c083c9edb53abc0bad52`
`source`	String	Example: `push`
`started_at`	String (date-time)	Example: `2022-10-21T16:49:50.000+02:00`
`status`	String	Example: `success`
`updated_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`web_url`	String	Example: `https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61`

APIEntitiesCiVariable

Property	Type	Description
`description`	String	Example: `This variable is being used for ...`
`environment_scope`	String	Example: `*`
`hidden`	Boolean	—
`key`	String	Example: `TEST_VARIABLE_1`
`masked`	Boolean	—
`protected`	Boolean	—
`raw`	Boolean	—
`value`	String	Example: `TEST_1`
`variable_type`	String	Example: `env_var`

APIEntitiesCommit

Property	Type	Description
`author_email`	String	Example: `john@example.com`
`author_name`	String	Example: `John Smith`
`authored_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committed_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committer_email`	String	Example: `jack@example.com`
`committer_name`	String	Example: `Jack Smith`
`created_at`	String (date-time)	Example: `2017-07-26T11:08:53.000+02:00`
`extended_trailers`	Object	Example: `{"Signed-off-by":["John Doe \u003cjohndoe@gitlab.com\u003e","Jane Doe \u003cjanedoe@gitlab.com\u003e"]}`
`id`	String	Example: `2695effb5807a22ff3d138d593fd856244e155e7`
`message`	String	Example: `Initial commit`
`parent_ids`	Array of strings	Example: `["2a4b78934375d7f53875269ffd4f45fd83a84ebe"]`
`short_id`	String	Example: `2695effb`
`title`	String	Example: `Initial commit`
`trailers`	Object	Example: `{"Merged-By":"Jane Doe janedoe@gitlab.com"}`
`web_url`	String	Example: `https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746`

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesProjectIdentity

Property	Type	Description
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`description`	String	Example: `desc`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`

APIEntitiesUser

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`bio`	String	—
`bot`	Boolean	—
`created_at`	String	—
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`discord`	String	—
`followers`	String	—
`following`	String	—
`github`	String	—
`id`	Integer (int64)	Example: `1`
`is_followed`	String	—
`job_title`	String	—
`linkedin`	String	—
`local_time`	String	—
`location`	String	—
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`organization`	String	—
`pronouns`	String	—
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`twitter`	String	—
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`
`website_url`	String	—
`work_information`	String	—

APIEntitiesUserBasic

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`id`	Integer (int64)	Example: `1`
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`

DetailedStatusEntity

Property	Type	Description
`action`	Object	—
`action.button_title`	String	Example: `Cancel this job`
`action.confirmation_message`	String	Example: `Are you sure?`
`action.icon`	String	Example: `cancel`
`action.method`	String	Example: `post`
`action.path`	String	Example: `/namespace1/project1/-/jobs/2/cancel`
`action.title`	String	Example: `Cancel`
`details_path`	String	Example: `/test-group/test-project/-/pipelines/287`
`favicon`	String	Example: `/assets/ci_favicons/favicon_status_success.png`
`group`	String	Example: `success`
`has_details`	Boolean	Example: `true`
`icon`	String	Example: `status_success`
`illustration`	Object	Example: `{"content":"This job depends on upstream jobs that need to succeed in order for this job to be triggered","image":"illustrations/empty-state/empty-job-not-triggered-md.svg","size":"","title":"This job has not been triggered yet"}`
`label`	String	Example: `passed`
`text`	String	Example: `passed`
`tooltip`	String	Example: `passed`

TestCaseEntity

Property	Type	Description
`attachment_url`	String	Example: `http://localhost/namespace1/project1/-/jobs/1/artifacts/file/some/path.png`
`classname`	String	Example: `vulnerability_management_spec`
`execution_time`	Integer	Example: `180`
`file`	String	Example: `./spec/test_spec.rb`
`name`	String	Default: `(No name)` Example: `Security Reports can create an auto-remediation MR`
`recent_failures`	Object	Example: `{"base_branch":"develop","count":3}`
`severity`	String	Example: `low`
`stack_trace`	String	Example: `Failure/Error: is_expected.to eq(3)`
`status`	String	Example: `success`
`system_output`	String	Example: `Failure/Error: is_expected.to eq(3)`

TestReportEntity

Property	Type	Description
`error_count`	Integer	Example: `0`
`failed_count`	Integer	Example: `0`
`skipped_count`	Integer	Example: `0`
`success_count`	Integer	Example: `1`
`test_suites`	Array of TestSuiteEntity	—
`total_count`	Integer	Example: `1`
`total_time`	Integer	Example: `180`

TestReportSummaryEntity

Property	Type	Description
`test_suites`	TestSuiteSummaryEntity	—
`total`	Object	Example: `{"count":2,"error":0,"failed":0,"skipped":0,"success":2,"suite_error":null,"time":0.42}`

TestSuiteEntity

Property	Type	Description
`error_count`	Integer	Example: `0`
`failed_count`	Integer	Example: `0`
`name`	String	Example: `test`
`skipped_count`	Integer	Example: `12`
`success_count`	Integer	Example: `3351`
`suite_error`	String	Example: `JUnit XML parsing failed: 1:1: FATAL: Document is empty`
`test_cases`	Array of TestCaseEntity	—
`total_count`	Integer	Example: `3363`
`total_time`	Integer	Example: `1904`

TestSuiteSummaryEntity

Property	Type	Description
`build_ids`	Array of integers	Example: `[66004]`
`error_count`	Integer	Example: `0`
`failed_count`	Integer	Example: `0`
`name`	String	Example: `test`
`severity_counts`	Object	Example: `{"critical":{"errored":0,"failed":1}}`
`skipped_count`	Integer	Example: `12`
`success_count`	Integer	Example: `3351`
`suite_error`	String	Example: `JUnit XML parsing failed: 1:1: FATAL: Document is empty`
`test_cases`	Array of TestCaseEntity	—
`total_count`	Integer	Example: `3363`
`total_time`	Integer	Example: `1904`

List pipelines triggered by the authenticated user

Create a pipeline

List all project pipelines

Retrieve the latest pipeline

Retrieve a pipeline

Delete a pipeline

List all bridge jobs by pipeline (deprecated)

Cancel all jobs for a pipeline

List all jobs by pipeline

Update pipeline metadata

Retry jobs in a pipeline

Retrieve a test report for a pipeline

Retrieve a test report summary for a pipeline

List all trigger jobs by pipeline

List all pipeline variables

Schemas

APIEntitiesCiBridge

APIEntitiesCiJob

APIEntitiesCiJobArtifact

APIEntitiesCiJobArtifactFile

APIEntitiesCiPipeline

APIEntitiesCiPipelineBasic

APIEntitiesCiPipelineMergeRequest

APIEntitiesCiPipelineWithMetadata

APIEntitiesCiRunner

APIEntitiesCiRunnerManager

APIEntitiesCiUserPipeline

APIEntitiesCiVariable

APIEntitiesCommit

APIEntitiesCustomAttribute

APIEntitiesProjectIdentity

APIEntitiesUser

APIEntitiesUserBasic

DetailedStatusEntity

TestCaseEntity

TestReportEntity

TestReportSummaryEntity

TestSuiteEntity

TestSuiteSummaryEntity

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error