Skip to main content
Server path: /gitlab-cicd | Type: Application | PCID required: Yes

Tools

ToolDescription
gitlab_cicd_cancel_pipelineCancel all jobs for a pipeline
gitlab_cicd_create_pipelineCreate a new pipeline
gitlab_cicd_get_jobRetrieve a job
gitlab_cicd_get_job_logRetrieve a log file for a job
gitlab_cicd_get_pipelineGets a specific pipeline for the project
gitlab_cicd_get_pipeline_jobsGet pipeline jobs
gitlab_cicd_get_releaseRetrieve a release by tag name
gitlab_cicd_list_group_projectsGet a list of projects in this group.
gitlab_cicd_list_pipelinesGet all Pipelines of the project
gitlab_cicd_list_releasesList all releases in a project
gitlab_cicd_retry_jobRetry a job
gitlab_cicd_retry_pipelineRetry builds in the pipeline

gitlab_cicd_cancel_pipeline

Cancel all jobs for a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe project ID or URL-encoded path
pipeline_idintegerYesThe pipeline ID

gitlab_cicd_create_pipeline

Create a new pipeline Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe project ID or URL-encoded path
inputsobjectNoThe list of inputs to be used to create the pipeline.
refstringYesReference
variablesobject[]NoArray of variables available in the pipeline

gitlab_cicd_get_job

Retrieve a job Parameters:
ParameterTypeRequiredDefaultDescription
job_idintegerYesThe ID of a job
idintegerYesThe id value

gitlab_cicd_get_job_log

Retrieve a log file for a job Parameters:
ParameterTypeRequiredDefaultDescription
job_idintegerYesThe ID of a job
byte_offsetintegerNoByte offset to start reading from
byte_limitintegerNoMaximum number of bytes to return
idintegerYesThe id value

gitlab_cicd_get_pipeline

Gets a specific pipeline for the project Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe project ID or URL-encoded path
pipeline_idintegerYesThe pipeline ID

gitlab_cicd_get_pipeline_jobs

Get pipeline jobs Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe project ID or URL-encoded path
pipeline_idintegerYesThe pipeline ID
include_retriedbooleanNoIncludes retried jobs
scopestringNoThe scope of builds to show
pageintegerNoCurrent page number
per_pageintegerNoNumber of items per page

gitlab_cicd_get_release

Retrieve a release by tag name Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID or URL-encoded path of the project
tag_namestringYesThe Git tag the release is associated with
include_html_descriptionbooleanNoIf true, a response includes HTML rendered markdown of the release description

gitlab_cicd_list_group_projects

Get a list of projects in this group. Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of a group
activebooleanNoLimit by projects that are not archived and not marked for deletion
archivedbooleanNoLimit by archived status
visibilitystringNoLimit by visibility
searchstringNoReturn list of authorized projects matching the search criteria
order_bystringNoReturn projects ordered by field
sortstringNoReturn projects sorted in ascending and descending order
simplebooleanNoReturn only the ID, URL, name, and path of each project
ownedbooleanNoLimit by owned by authenticated user
starredbooleanNoLimit by starred status
with_issues_enabledbooleanNoLimit by enabled issues feature
with_merge_requests_enabledbooleanNoLimit by enabled merge requests feature
with_sharedbooleanNoInclude projects shared to this group
include_subgroupsbooleanNoIncludes projects in subgroups of this group
include_ancestor_groupsbooleanNoIncludes projects in ancestors of this group
min_access_levelintegerNoLimit by minimum access level of authenticated user on projects
pageintegerNoCurrent page number
per_pageintegerNoNumber of items per page
with_custom_attributesbooleanNoInclude custom attributes in the response
with_security_reportsbooleanNoReturn only projects having security report artifacts present

gitlab_cicd_list_pipelines

Get all Pipelines of the project Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe project ID or URL-encoded path
pageintegerNoCurrent page number
per_pageintegerNoNumber of items per page
scopestringNoThe scope of pipelines
statusstringNoThe status of pipelines
refstringNoThe ref of pipelines
shastringNoThe sha of pipelines
yaml_errorsbooleanNoReturns pipelines with invalid configurations
usernamestringNoThe username of the user who triggered pipelines
updated_beforestringNoReturn pipelines updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
updated_afterstringNoReturn pipelines updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
created_beforestringNoReturn pipelines created before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
created_afterstringNoReturn pipelines created after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
order_bystringNoOrder pipelines
sortstringNoSort pipelines
sourcestringNoThe source of pipelines
namestringNoFilter pipelines by name

gitlab_cicd_list_releases

List all releases in a project Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID or URL-encoded path of the project
pageintegerNoCurrent page number
per_pageintegerNoNumber of items per page
order_bystringNoThe field to use as order. Either released_at (default) or created_at
sortstringNoThe direction of the order. Either desc (default) for descending order or asc for ascending order
include_html_descriptionbooleanNoIf true, a response includes HTML rendered markdown of the release description
updated_beforestringNoReturn releases updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
updated_afterstringNoReturn releases updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

gitlab_cicd_retry_job

Retry a job Parameters:
ParameterTypeRequiredDefaultDescription
job_idintegerYesThe ID of a job
idintegerYesThe id value
inputsobjectNoInput values for the job

gitlab_cicd_retry_pipeline

Retry builds in the pipeline Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe project ID or URL-encoded path
pipeline_idintegerYesThe pipeline ID