How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitLab CI/CD pipelines API

Operations about pipelines

GitLab CI/CD pipelines API is one of 98 APIs that GitLab CI/CD publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pipelines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 13 operations across 12 paths, and defines 22 schemas. It is described by OpenAPI 2.0, at version v4.

Requests are made against the base URL https://gitlab.com/api/v4.

13 operations 12 paths 22 schemas 1 DELETE8 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v4
Base URL
https://gitlab.com/api/v4
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

GitLab CI/CD pipelines API declares 2 security schemes for authenticating requests. An API key is passed in the header as PRIVATE-TOKEN (access_token_header). An API key is passed in the query as private_token (access_token_query).

Paths & Operations 13

Across 12 paths, the API surfaces 13 operations — 1 DELETE, 8 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

pipelines 13

Operations about pipelines

GET
/api/v4/projects/{id}/pipelines
Get all Pipelines of the project
getApiV4ProjectsIdPipelines 17 params → 200401403
POST
/api/v4/projects/{id}/pipeline
Create a new pipeline
postApiV4ProjectsIdPipeline 2 params → 201400401403404
GET
/api/v4/projects/{id}/pipelines/latest
Gets the latest pipeline for the project branch
getApiV4ProjectsIdPipelinesLatest 2 params → 200401403404
GET
/api/v4/projects/{id}/pipelines/{pipeline_id}
Gets a specific pipeline for the project
getApiV4ProjectsIdPipelinesPipelineId 2 params → 200401403404
DELETE
/api/v4/projects/{id}/pipelines/{pipeline_id}
Deletes a pipeline
deleteApiV4ProjectsIdPipelinesPipelineId 2 params → 204403
GET
/api/v4/projects/{id}/pipelines/{pipeline_id}/jobs
Get pipeline jobs
getApiV4ProjectsIdPipelinesPipelineIdJobs 6 params → 200401403404
GET
/api/v4/projects/{id}/pipelines/{pipeline_id}/bridges
Get pipeline bridge jobs
getApiV4ProjectsIdPipelinesPipelineIdBridges 5 params → 200401403404
GET
/api/v4/projects/{id}/pipelines/{pipeline_id}/variables
Gets the variables for a given pipeline
getApiV4ProjectsIdPipelinesPipelineIdVariables 2 params → 200401403404
GET
/api/v4/projects/{id}/pipelines/{pipeline_id}/test_report
Gets the test report for a given pipeline
getApiV4ProjectsIdPipelinesPipelineIdTestReport 2 params → 200401403404
GET
/api/v4/projects/{id}/pipelines/{pipeline_id}/test_report_summary
Gets the test report summary for a given pipeline
getApiV4ProjectsIdPipelinesPipelineIdTestReportSummary 2 params → 200401403404
PUT
/api/v4/projects/{id}/pipelines/{pipeline_id}/metadata
Updates pipeline metadata
putApiV4ProjectsIdPipelinesPipelineIdMetadata 3 params → 200400401403404
POST
/api/v4/projects/{id}/pipelines/{pipeline_id}/retry
Retry builds in the pipeline
postApiV4ProjectsIdPipelinesPipelineIdRetry 2 params → 201401403404
POST
/api/v4/projects/{id}/pipelines/{pipeline_id}/cancel
Cancel all builds in the pipeline
postApiV4ProjectsIdPipelinesPipelineIdCancel 2 params → 201401403404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are API_Entities_Ci_Job (27 properties), API_Entities_User (27 properties), API_Entities_Ci_PipelineWithMetadata (23 properties), API_Entities_Ci_Pipeline (22 properties). Each schema is shown below with its type and property counts.

API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
API_Entities_Ci_Runner
object
APIEntitiesCiRunner model
13 properties 12 required
API_Entities_Ci_RunnerManager
object
APIEntitiesCiRunnerManager model
11 properties 11 required
API_Entities_UserBasic
object
APIEntitiesUserBasic model
10 properties 8 required
API_Entities_User
object
27 properties 21 required
API_Entities_Ci_Variable
object
APIEntitiesCiVariable model
9 properties 3 required
API_Entities_Ci_PipelineWithMetadata
object
APIEntitiesCiPipelineWithMetadata model
23 properties 23 required
API_Entities_Ci_PipelineBasic
object
APIEntitiesCiPipelineBasic model
10 properties 10 required
API_Entities_Ci_JobArtifact
object
4 properties 4 required
TestReportEntity
object
TestReportEntity model
7 properties 7 required
API_Entities_Commit
object
APIEntitiesCommit model
15 properties 15 required
TestSuiteSummaryEntity
object
10 properties 9 required
putApiV4ProjectsIdPipelinesPipelineIdMetadata
object
Updates pipeline metadata
1 property 1 required
TestReportSummaryEntity
object
TestReportSummaryEntity model
2 properties 2 required
postApiV4ProjectsIdPipeline
object
Create a new pipeline
3 properties 1 required
API_Entities_Ci_Bridge
object
APIEntitiesCiBridge model
21 properties 20 required
DetailedStatusEntity
object
10 properties 9 required
API_Entities_Ci_Pipeline
object
APIEntitiesCiPipeline model
22 properties 22 required
API_Entities_Ci_Job
object
APIEntitiesCiJob model
27 properties 24 required
API_Entities_Ci_JobArtifactFile
object
2 properties 2 required
TestCaseEntity
object
9 properties 8 required
TestSuiteEntity
object
9 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-pipelines-api-openapi.yml Raw ↑

Other APIs GitLab CI/CD publishes across the network.

GitLab GraphQL API
GitLab CI/CD access_requests API
GitLab CI/CD access_tokens API
GitLab CI/CD agents API
GitLab CI/CD alert_management API
GitLab CI/CD applications API
GitLab CI/CD attestations API
GitLab CI/CD audit_events API
GitLab CI/CD avatars API
GitLab CI/CD award_emoji API
GitLab CI/CD badges API
GitLab CI/CD batched_background_migrations API
Where this information came from

This is an independent, third-party profile of GitLab CI/CD pipelines API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.