Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/gitlab-ci-pipelines-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: GitLab access_requests Pipelines API
version: v4
description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: pipelines
description: Operations about pipelines
paths:
/api/v4/projects/{id}/pipelines:
get:
summary: Get all Pipelines of the project
description: This feature was introduced in GitLab 8.11.
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: query
name: page
description: Current page number
required: false
example: 1
schema:
type: integer
format: int32
default: 1
- in: query
name: per_page
description: Number of items per page
required: false
example: 20
schema:
type: integer
format: int32
default: 20
- in: query
name: scope
description: The scope of pipelines
required: false
example: pending
schema:
type: string
enum:
- running
- pending
- finished
- branches
- tags
- in: query
name: status
description: The status of pipelines
required: false
example: pending
schema:
type: string
enum:
- created
- waiting_for_resource
- preparing
- waiting_for_callback
- pending
- running
- success
- failed
- canceling
- canceled
- skipped
- manual
- scheduled
- in: query
name: ref
description: The ref of pipelines
required: false
example: develop
schema:
type: string
- in: query
name: sha
description: The sha of pipelines
required: false
example: a91957a858320c0e17f3a0eca7cfacbff50ea29a
schema:
type: string
- in: query
name: yaml_errors
description: Returns pipelines with invalid configurations
required: false
schema:
type: boolean
- in: query
name: username
description: The username of the user who triggered pipelines
required: false
example: root
schema:
type: string
- in: query
name: updated_before
description: 'Return pipelines updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
required: false
example: '2015-12-24T15:51:21.880Z'
schema:
type: string
format: date-time
- in: query
name: updated_after
description: 'Return pipelines updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
required: false
example: '2015-12-24T15:51:21.880Z'
schema:
type: string
format: date-time
- in: query
name: created_before
description: 'Return pipelines created before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
required: false
example: '2015-12-24T15:51:21.880Z'
schema:
type: string
format: date-time
- in: query
name: created_after
description: 'Return pipelines created after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
required: false
example: '2015-12-24T15:51:21.880Z'
schema:
type: string
format: date-time
- in: query
name: order_by
description: Order pipelines
required: false
example: status
schema:
type: string
enum:
- id
- status
- ref
- updated_at
- user_id
default: id
- in: query
name: sort
description: Sort pipelines
required: false
example: asc
schema:
type: string
enum:
- asc
- desc
default: desc
- in: query
name: source
description: The source of pipelines
required: false
example: push
schema:
type: string
enum:
- 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
- in: query
name: name
description: Filter pipelines by name
required: false
example: Build pipeline
schema:
type: string
responses:
'200':
description: Get all Pipelines of the project
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Ci_PipelineBasic'
'401':
description: Unauthorized
'403':
description: Forbidden
tags:
- pipelines
operationId: getApiV4ProjectsIdPipelines
/api/v4/projects/{id}/pipeline:
post:
summary: Create a new pipeline
description: This feature was introduced in GitLab 8.14
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
responses:
'201':
description: Create a new pipeline
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_Pipeline'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: postApiV4ProjectsIdPipeline
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/postApiV4ProjectsIdPipeline'
required: true
/api/v4/projects/{id}/pipelines/latest:
get:
summary: Gets the latest pipeline for the project branch
description: This feature was introduced in GitLab 12.3
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: query
name: ref
description: Branch ref of pipeline. Uses project default branch if not specified.
required: false
example: develop
schema:
type: string
responses:
'200':
description: Gets the latest pipeline for the project branch
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_PipelineWithMetadata'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: getApiV4ProjectsIdPipelinesLatest
/api/v4/projects/{id}/pipelines/{pipeline_id}:
get:
summary: Gets a specific pipeline for the project
description: This feature was introduced in GitLab 8.11
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
responses:
'200':
description: Gets a specific pipeline for the project
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_PipelineWithMetadata'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: getApiV4ProjectsIdPipelinesPipelineId
delete:
summary: Deletes a pipeline
description: This feature was introduced in GitLab 11.6
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
responses:
'204':
description: Pipeline was deleted
'403':
description: Forbidden
tags:
- pipelines
operationId: deleteApiV4ProjectsIdPipelinesPipelineId
/api/v4/projects/{id}/pipelines/{pipeline_id}/jobs:
get:
description: Get pipeline jobs
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
- in: query
name: include_retried
description: Includes retried jobs
required: false
schema:
type: boolean
default: false
- in: query
name: scope
description: The scope of builds to show
required: false
example:
- pending
- running
schema:
type: string
enum:
- created
- waiting_for_resource
- preparing
- waiting_for_callback
- pending
- running
- success
- failed
- canceling
- canceled
- skipped
- manual
- scheduled
- in: query
name: page
description: Current page number
required: false
example: 1
schema:
type: integer
format: int32
default: 1
- in: query
name: per_page
description: Number of items per page
required: false
example: 20
schema:
type: integer
format: int32
default: 20
responses:
'200':
description: Get pipeline jobs
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Ci_Job'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: getApiV4ProjectsIdPipelinesPipelineIdJobs
/api/v4/projects/{id}/pipelines/{pipeline_id}/bridges:
get:
description: Get pipeline bridge jobs
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
- in: query
name: scope
description: The scope of builds to show
required: false
example:
- pending
- running
schema:
type: string
enum:
- created
- waiting_for_resource
- preparing
- waiting_for_callback
- pending
- running
- success
- failed
- canceling
- canceled
- skipped
- manual
- scheduled
- in: query
name: page
description: Current page number
required: false
example: 1
schema:
type: integer
format: int32
default: 1
- in: query
name: per_page
description: Number of items per page
required: false
example: 20
schema:
type: integer
format: int32
default: 20
responses:
'200':
description: Get pipeline bridge jobs
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Ci_Bridge'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: getApiV4ProjectsIdPipelinesPipelineIdBridges
/api/v4/projects/{id}/pipelines/{pipeline_id}/variables:
get:
summary: Gets the variables for a given pipeline
description: This feature was introduced in GitLab 11.11
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
responses:
'200':
description: Gets the variables for a given pipeline
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Ci_Variable'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: getApiV4ProjectsIdPipelinesPipelineIdVariables
/api/v4/projects/{id}/pipelines/{pipeline_id}/test_report:
get:
summary: Gets the test report for a given pipeline
description: This feature was introduced in GitLab 13.0.
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
responses:
'200':
description: Gets the test report for a given pipeline
content:
application/json:
schema:
$ref: '#/components/schemas/TestReportEntity'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: getApiV4ProjectsIdPipelinesPipelineIdTestReport
/api/v4/projects/{id}/pipelines/{pipeline_id}/test_report_summary:
get:
summary: Gets the test report summary for a given pipeline
description: This feature was introduced in GitLab 14.2
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
responses:
'200':
description: Gets the test report summary for a given pipeline
content:
application/json:
schema:
$ref: '#/components/schemas/TestReportSummaryEntity'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: getApiV4ProjectsIdPipelinesPipelineIdTestReportSummary
/api/v4/projects/{id}/pipelines/{pipeline_id}/metadata:
put:
summary: Updates pipeline metadata
description: This feature was introduced in GitLab 16.6
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
responses:
'200':
description: Updates pipeline metadata
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_PipelineWithMetadata'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: putApiV4ProjectsIdPipelinesPipelineIdMetadata
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/putApiV4ProjectsIdPipelinesPipelineIdMetadata'
required: true
/api/v4/projects/{id}/pipelines/{pipeline_id}/retry:
post:
summary: Retry builds in the pipeline
description: This feature was introduced in GitLab 8.11.
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
responses:
'201':
description: Retry builds in the pipeline
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_Pipeline'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: postApiV4ProjectsIdPipelinesPipelineIdRetry
/api/v4/projects/{id}/pipelines/{pipeline_id}/cancel:
post:
summary: Cancel all builds in the pipeline
description: This feature was introduced in GitLab 8.11.
parameters:
- in: path
name: id
description: The project ID or URL-encoded path
required: true
example: 11
schema:
type: string
- in: path
name: pipeline_id
description: The pipeline ID
required: true
example: 18
schema:
type: integer
format: int32
responses:
'201':
description: Cancel all builds in the pipeline
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_Pipeline'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- pipelines
operationId: postApiV4ProjectsIdPipelinesPipelineIdCancel
components:
schemas:
API_Entities_Ci_Pipeline:
type: object
properties:
id:
type: integer
format: int32
example: 1
iid:
type: integer
format: int32
example: 2
project_id:
type: integer
format: int32
example: 3
sha:
type: string
example: 0ec9e58fdfca6cdd6652c083c9edb53abc0bad52
ref:
type: string
example: feature-branch
status:
type: string
example: success
source:
type: string
example: push
created_at:
type: string
format: date-time
example: '2015-12-24T15:51:21.880Z'
updated_at:
type: string
format: date-time
example: '2015-12-24T17:54:31.198Z'
web_url:
type: string
example: https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61
before_sha:
type: string
example: a91957a858320c0e17f3a0eca7cfacbff50ea29a
tag:
type: boolean
example: false
yaml_errors:
type: string
example: 'widgets:build: needs ''widgets:test'''
user:
$ref: '#/components/schemas/API_Entities_UserBasic'
started_at:
type: string
format: date-time
example: '2015-12-24T17:54:30.733Z'
finished_at:
type: string
format: date-time
example: '2015-12-24T17:54:31.198Z'
committed_at:
type: string
format: date-time
example: '2015-12-24T15:51:21.880Z'
duration:
type: integer
format: int32
example: 127
description: Time spent running in seconds
queued_duration:
type: integer
format: int32
example: 63
description: Time spent enqueued in seconds
coverage:
type: number
format: float
example: 98.29
detailed_status:
$ref: '#/components/schemas/DetailedStatusEntity'
archived:
type: boolean
example: false
required:
- id
- iid
- project_id
- sha
- ref
- status
- source
- created_at
- updated_at
- web_url
- before_sha
- tag
- yaml_errors
- user
- started_at
- finished_at
- committed_at
- duration
- queued_duration
- coverage
- detailed_status
- archived
description: API_Entities_Ci_Pipeline model
API_Entities_Ci_Bridge:
type: object
properties:
id:
type: integer
format: int32
example: 1
status:
type: string
example: waiting_for_resource
stage:
type: string
example: deploy
name:
type: string
example: deploy_to_production
ref:
type: string
example: main
tag:
type: boolean
coverage:
type: number
format: float
example: 98.29
allow_failure:
type: boolean
created_at:
type: string
format: date-time
example: '2015-12-24T15:51:21.880Z'
started_at:
type: string
format: date-time
example: '2015-12-24T17:54:30.733Z'
finished_at:
type: string
format: date-time
example: '2015-12-24T17:54:31.198Z'
erased_at:
type: string
format: date-time
example: '2015-12-24T18:00:29.728Z'
duration:
type: number
format: float
example: 0.465
description: Time spent running
queued_duration:
type: number
format: float
example: 0.123
description: Time spent enqueued
user:
$ref: '#/components/schemas/API_Entities_User'
commit:
$ref: '#/components/schemas/API_Entities_Commit'
pipeline:
$ref: '#/components/schemas/API_Entities_Ci_PipelineBasic'
failure_reason:
type: string
example: script_failure
web_url:
type: string
example: https://example.com/foo/bar/-/jobs/1
project:
type: object
properties:
ci_job_token_scope_enabled:
type: string
example: false
required:
- ci_job_token_scope_enabled
downstream_pipeline:
$ref: '#/components/schemas/API_Entities_Ci_PipelineBasic'
required:
- id
- status
- stage
- name
- ref
- tag
- coverage
- allow_failure
- created_at
- started_at
- finished_at
- erased_at
- duration
- queued_duration
- user
- commit
- pipeline
- web_url
- project
- downstream_pipeline
description: API_Entities_Ci_Bridge model
putApiV4ProjectsIdPipelinesPipelineIdMetadata:
type: object
properties:
name:
type: string
description: The name of the pipeline
example: Deployment to production
required:
- name
description: Updates pipeline metadata
TestReportEntity:
type: object
properties:
total_time:
type: integer
format: int32
example: 180
total_count:
type: integer
format: int32
example: 1
success_count:
type: integer
format: int32
example: 1
failed_count:
type: integer
format: int32
example: 0
skipped_count:
type: integer
format: int32
example: 0
error_count:
type: integer
format: int32
example: 0
test_suites:
type: array
items:
$ref: '#/components/schemas/TestSuiteEntity'
required:
- total_time
- total_count
- success_count
- failed_count
- skipped_count
- error_count
- test_suites
description: TestReportEntity model
API_Entities_Ci_Job:
type: object
properties:
id:
type: integer
format: int32
example: 1
status:
type: string
example: waiting_for_resource
stage:
type: string
example: deploy
name:
type: string
example: deploy_to_production
ref:
type: string
example: main
tag:
type: boolean
coverage:
type: number
format: float
example: 98.29
allow_failure:
type: boolean
created_at:
type: string
format: date-time
example: '2015-12-24T15:51:21.880Z'
started_at:
type: string
format: date-time
example: '2015-12-24T17:54:30.733Z'
finished_at:
type: string
format: date-time
example: '2015-12-24T17:54:31.198Z'
erased_at:
type: string
format: date-time
example: '2015-12-24T18:00:29.728Z'
duration:
type: number
format: float
example: 0.465
description: Time spent running
queued_duration:
type: number
format: float
example: 0.123
description: Time spent enqueued
user:
$ref: '#/components/schemas/API_Entities_User'
commit:
$ref: '#/components/schemas/API_Entities_Commit'
pipeline:
$ref: '#/components/schemas/API_Entities_Ci_PipelineBasic'
failure_reason:
type: string
example: script_failure
web_url:
type: string
example: https://example.com/foo/bar/-/jobs/1
project:
type: object
properties:
ci_job_token_scope_enabled:
type: string
example: false
required:
- ci_job_token_scope_enabled
artifacts_file:
$ref: '#/components/schemas/API_Entities_Ci_JobArtifactFile'
artifacts:
type: array
items:
$ref: '#/components/schemas/API_Entities_Ci_JobArtifact'
runner:
$ref: '#/components/schemas/API_Entities_Ci_Runner'
runner_manager:
$ref: '#/components/schemas/API_Entities_Ci_RunnerManager'
artifacts_expire_at:
type: string
format: date-time
example: '2016-01-19T09:05:50.355Z'
archived:
type: boolean
example: false
tag_list:
type: array
items:
type: string
example:
- ubuntu18
- docker runner
required:
- id
- status
- stage
- name
- ref
- tag
- coverage
- allow_failure
- created_at
- started_at
- finished_at
- erased_at
- duration
- queued_duration
- user
- commit
- pipeline
- web_url
- project
- artifacts
- runner
- artifacts_expire_at
- archived
- tag_list
description: API_Entities_Ci_Job model
API_Entities_UserBasic:
type: object
properties:
id:
type: integer
format: int32
example: 1
username:
type: string
example: admin
public_email:
type: string
example: john@example.com
name:
type: string
example: Administrator
state:
type: string
example: active
locked:
type: boolean
avatar_url:
type: string
example: https://gravatar.com/avatar/1
avatar_path:
type: string
example: /user/avatar/28/The-Big-Lebowski-400-400.png
custom_attributes:
type: array
items:
$ref: '#/components/schemas/API_Entities_CustomAttribute'
web_url:
type: string
example: https://gitlab.example.com/root
required:
- id
- username
- public_email
- name
- state
- locked
- avatar_url
- web_url
description: API_Entities_UserBasic model
DetailedStatusEntity:
type: object
properties:
icon:
type: string
example: status_success
text:
type: string
example: passed
label:
type: string
example: passed
group:
type: string
example: success
tooltip:
type: string
example: passed
has_details:
type: boolean
example: true
details_path:
type: string
example: /test-group/test-project/-/pipelines/287
illustration:
type: object
example:
image: illustrations/empty-state/empty-job-not-triggered-md.svg
size: ''
title: This job has not been triggered yet
content: This job depends on upstream jobs that need to succeed in order for this job to be triggered
favicon:
type: string
example: /assets/ci_favicons/favicon_status_success.png
action:
type: object
properties:
icon:
type: string
example: cancel
title:
type: string
example: Cancel
path:
type: string
example: /namespace1/project1/-/jobs/2/cancel
method:
type: string
example: post
button_title:
type: string
example: Cancel this job
confirmation_message:
type: string
example: Are you sure?
required:
- icon
- title
- path
- method
- button_title
- confirmation_message
required:
- icon
- text
- label
- group
- tooltip
- has_details
- details_path
- illustration
- favicon
API_Entities_Ci_RunnerManager:
type: object
properties:
id:
type: integer
format: int32
example: 8
system_id:
type: string
example: runner-1
version:
type: string
example: 16.11.0
revision:
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/openapi/gitlab-ci-pipelines-api-openapi.yml