Gitlab

Learn how to use Gitlab with Composio

Overview

Enum

GITLAB

Description

A web-based DevOps lifecycle tool that provides a Git repository manager providing wiki, issue-tracking, and CI/CD pipeline features.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to api,read_api,read_user,create_runner,manage_runner,k8s_proxy,read_repository,write_repository,read_registry,write_registry,read_virtual_registry,write_virtual_registry,read_observability,write_observability,ai_features,sudo,read_service_ping,profile,email
base_url
stringDefaults to https://gitlab.com/api/v4

Actions

This feature was introduced in gitlab 10.5

Action Parameters

confidential
booleanDefaults to True
name
stringRequired
redirect_uri
stringRequired
scopes
stringRequired

Action Response

data
object
error
string
successful
boolean
Create branch

Action Parameters

branch
stringRequired
id
stringRequired
ref
stringRequired

Action Response

data
object
error
string
successful
boolean
Get a project repository branches

Action Parameters

id
stringRequired
page
integerDefaults to 1
page_token
string
per_page
integerDefaults to 20
regex
string
search
string
sort
string

Action Response

data
object
error
string
successful
boolean
List all registered applications

Action Parameters

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

id
stringRequired
image_url
stringRequired
link_url
stringRequired
name
string

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

id
stringRequired
image_url
stringRequired
link_url
stringRequired
name
string

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 13.2. adds an existing kubernetes instance cluster.

Action Parameters

domain
string
enabled
booleanDefaults to True
environment_scope
stringDefaults to *
managed
booleanDefaults to True
management_project_id
integer
name
stringRequired
namespace_per_environment
booleanDefaults to True
platform__kubernetes__attributes__api__url
stringRequired
platform__kubernetes__attributes__authorization__type
stringDefaults to rbac
platform__kubernetes__attributes__ca__cert
string
platform__kubernetes__attributes__namespace
string
platform__kubernetes__attributes__token
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.11.

Action Parameters

access_level
integerDefaults to 30
id
stringRequired
user_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Workhorse authorize metric image file upload

Action Parameters

alert_iid
integerRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
Modify the limits of a plan on the gitlab instance.

Action Parameters

ci_active_jobs
integer
ci_needs_size_limit
integer
ci_pipeline_schedules
integer
ci_pipeline_size
integer
ci_project_subscriptions
integer
ci_registered_group_runners
integer
ci_registered_project_runners
integer
conan_max_file_size
integer
enforcement_limit
integer
generic_packages_max_file_size
integer
helm_max_file_size
integer
maven_max_file_size
integer
notification_limit
integer
npm_max_file_size
integer
nuget_max_file_size
integer
pipeline_hierarchy_size
integer
plan_name
stringRequired
pypi_max_file_size
integer
storage_size_limit
integer
terraform_module_max_file_size
integer

Action Response

data
object
error
string
successful
boolean
Check if a branch exists

Action Parameters

branch
stringRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.12.

Action Parameters

broadcast_type
string
color
string
dismissable
boolean
ends_at
string
font
string
message
stringRequired
starts_at
string
target_access_levels
array
target_path
string

Action Response

data
object
error
string
successful
boolean
Create a new instance-level variable

Action Parameters

key
stringRequired
masked
boolean
protected
boolean
raw
boolean
value
stringRequired
variable_type
string

Action Response

data
object
error
string
successful
boolean
Delete a specific application

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.12.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 13.2. deletes an existing instance cluster. does not remove existing resources within the connected kubernetes cluster.

Action Parameters

cluster_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Delete an existing instance-level variable

Action Parameters

key
stringRequired

Action Response

data
object
error
string
successful
boolean
Delete a branch

Action Parameters

branch
stringRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.11.

Action Parameters

id
stringRequired
user_id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 13.2. updates an existing instance cluster.

Action Parameters

cluster_id
integerRequired
domain
string
enabled
boolean
environment_scope
string
managed
boolean
management_project_id
integer
name
string
namespace_per_environment
booleanDefaults to True
platform__kubernetes__attributes__api__url
string
platform__kubernetes__attributes__ca__cert
string
platform__kubernetes__attributes__namespace
string
platform__kubernetes__attributes__token
string

Action Response

data
object
error
string
successful
boolean
Get the details of a specific instance-level variable

Action Parameters

key
stringRequired

Action Response

data
object
error
string
successful
boolean
Metric images for alert

Action Parameters

alert_iid
integerRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
Return avatar url for a user

Action Parameters

email
stringRequired
size
integer

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

badge_id
integerRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

badge_id
integerRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.11.

Action Parameters

id
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.11.

Action Parameters

id
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.12.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 13.2. returns a single instance cluster.

Action Parameters

cluster_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Retrieve detailed info for a specific job within a project using its respective ids. includes job metadata, commit details, and execution timestamps. requires project and job ids.

Action Parameters

id
integerRequired
job_id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.12.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
List the current limits of a plan on the gitlab instance.

Action Parameters

plan_name
stringDefaults to default

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 14.1.

Action Parameters

import_id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 14.1.

Action Parameters

entity_id
integerRequired
import_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Retrieve metadata information for this gitlab instance

Action Parameters

Action Response

data
object
error
string
successful
boolean
Retrieves version information for the gitlab instance. responds 200 ok for authenticated users.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Gets a list of badges viewable by the authenticated user. (introduced in gitlab 10.6.)

Action Parameters

id
stringRequired
name
string
page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.11.

Action Parameters

access_level
integerDefaults to 30
id
stringRequired
user_id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 14.1.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20
sort
stringDefaults to desc
status
string

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 14.1.

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20
sort
stringDefaults to desc
status
string

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

id
stringRequired
name
string
page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
object
error
string
successful
boolean
Get the list of batched background migrations

Action Parameters

database
stringDefaults to main

Action Response

data
object
error
string
successful
boolean
List all instance-level variables

Action Parameters

page
integerDefaults to 1
per_page
integerDefaults to 20

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 14.1.

Action Parameters

import_id
integerRequired
page
integerDefaults to 1
per_page
integerDefaults to 20
status
string

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 13.2. returns a list of instance clusters.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Retrieve a list of jobs related to a specific project by its id, with options to filter by job statuses. offers details like job name, status, stages, timestamps, commit info, and urls.

Action Parameters

id
integerRequired
scope
array

Action Response

data
object
error
string
successful
boolean
Mark the migration as successfully executed

Action Parameters

database
stringDefaults to main
timestamp
integerRequired

Action Response

data
object
error
string
successful
boolean
Modify appearance

Action Parameters

description
string
email_header_and_footer_enabled
boolean
favicon
object
footer_message
string
header_logo
object
header_message
string
logo
object
message_background_color
string
message_font_color
string
new_project_guidelines
string
profile_image_guidelines
string
pwa_description
string
pwa_icon
object
pwa_name
string
pwa_short_name
string
title
string

Action Response

data
object
error
string
successful
boolean
Pause a batched background migration

Action Parameters

database
stringDefaults to main
id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

id
stringRequired
image_url
stringRequired
link_url
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

id
stringRequired
image_url
stringRequired
link_url
stringRequired

Action Response

data
object
error
string
successful
boolean
Protect a single branch

Action Parameters

branch
stringRequired
developers_can_merge
boolean
developers_can_push
boolean
id
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.11.

Action Parameters

id
stringRequired
user_id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

badge_id
integerRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

badge_id
integerRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
Delete all merged branches

Action Parameters

id
stringRequired

Action Response

data
object
error
string
successful
boolean
Remove a metric image for an alert

Action Parameters

alert_iid
integerRequired
id
stringRequired
metric_image_id
integerRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.11.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
successful
boolean
Requests access for the authenticated user to a project

Action Parameters

id
stringRequired

Action Response

data
object
error
string
successful
boolean
Resume a batched background migration

Action Parameters

database
stringDefaults to main
id
integerRequired

Action Response

data
object
error
string
successful
boolean
Retrieve a batched background migration

Action Parameters

database
stringDefaults to main
id
integerRequired

Action Response

data
object
error
string
successful
boolean
Get the current appearance

Action Parameters

Action Response

data
object
error
string
successful
boolean
Retrieve dictionary details

Action Parameters

database_name
stringRequired
table_name
stringRequired

Action Response

data
object
error
string
successful
boolean
Get a single repository branch

Action Parameters

branch
integerRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
Trigger a manual job within a project by post to `/projects/{id}/jobs/{job id}/play`. specify project id and job id in the path. optional job variables can be passed in the query. returns a 200 response if the job starts successfully.

Action Parameters

id
integerRequired
job_id
integerRequired
job_variables_attributes
array

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 14.2.

Action Parameters

configuration__access__token
stringRequired
configuration__url
stringRequired
entities__destination__name
array
entities__destination__namespace
arrayRequired
entities__destination__slug
array
entities__migrate__projects
array
entities__source__full__path
arrayRequired
entities__source__type
arrayRequired

Action Response

data
object
error
string
successful
boolean
Unprotect a single branch

Action Parameters

branch
stringRequired
id
stringRequired

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

badge_id
integerRequired
id
stringRequired
image_url
string
link_url
string
name
string

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 10.6.

Action Parameters

badge_id
integerRequired
id
stringRequired
image_url
string
link_url
string
name
string

Action Response

data
object
error
string
successful
boolean
This feature was introduced in gitlab 8.12.

Action Parameters

broadcast_type
string
color
string
dismissable
boolean
ends_at
string
font
string
id
integerRequired
message
string
starts_at
string
target_access_levels
array
target_path
string

Action Response

data
object
error
string
successful
boolean
Update an instance-level variable

Action Parameters

key
stringRequired
masked
boolean
protected
boolean
raw
boolean
value
string
variable_type
string

Action Response

data
object
error
string
successful
boolean
Update a metric image for an alert

Action Parameters

alert_iid
integerRequired
id
stringRequired
metric_image_id
integerRequired
url
string
url_text
string

Action Response

data
object
error
string
successful
boolean
Upload a metric image for an alert

Action Parameters

alert_iid
integerRequired
file
object
id
stringRequired
url
string
url_text
string

Action Response

data
object
error
string
successful
boolean