Overview
Add GitLab to any ModuleX agent or workflow. Repository and project management platform for the GitLab REST API (gitlab.com/api/v4).
Categories: Developer Tools & Infrastructure · Version Control · Project Management · Auth: OAuth2 · Actions: 12
Authentication
OAuth2 Authentication
Connect using GitLab OAuth (recommended)Required Credentials
| Field | Description | Required | Format |
|---|---|---|---|
| Client ID | GitLab OAuth App Client ID | Yes | - |
| Client Secret | GitLab OAuth App Client Secret | Yes | - |
OAuth Configuration
- Authorization URL:
https://gitlab.com/oauth/authorize - Token URL:
https://gitlab.com/oauth/token - Scopes:
api
Available Actions
create_branch — Create a new branch in a GitLab repository
create_branch — Create a new branch in a GitLab repository
Parameters
integer
required
The project ID, as displayed in the main project page
string
required
The branch name or commit SHA to create the new branch from
string
required
The name of the branch to create
Response
{
"$defs": {
"BranchCommit": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Short Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"author_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Name"
},
"author_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Email"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message"
}
},
"title": "BranchCommit",
"type": "object"
},
"BranchSummary": {
"additionalProperties": false,
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"commit": {
"anyOf": [
{
"$ref": "#/$defs/BranchCommit"
},
{
"type": "null"
}
],
"default": null
},
"merged": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Merged"
},
"protected": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Protected"
},
"developers_can_push": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Developers Can Push"
},
"developers_can_merge": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Developers Can Merge"
},
"can_push": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Can Push"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
}
},
"title": "BranchSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"branch": {
"anyOf": [
{
"$ref": "#/$defs/BranchSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateBranchOutput",
"type": "object"
}
create_epic — Create a new epic in a GitLab group (requires GitLab Premium or Ultimate)
create_epic — Create a new epic in a GitLab group (requires GitLab Premium or Ultimate)
Parameters
string
required
The ID of the group
string
required
The title of the epic
string
The description of the epic
array
List of label names for the epic
string
The internal ID of the parent epic (requires GitLab Premium or Ultimate)
string
The color of the epic (introduced in GitLab 14.8)
boolean
Whether the epic should be confidential
string
When the epic was created, ISO 8601 format (requires admin or owner privileges)
boolean
Whether start date should be sourced from start_date_fixed or from milestones
boolean
Whether due date should be sourced from due_date_fixed or from milestones
string
The fixed start date of the epic, ISO 8601 format (relevant when start_date_is_fixed is true)
string
The fixed due date of the epic, ISO 8601 format (relevant when due_date_is_fixed is true)
Response
{
"$defs": {
"EpicSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"iid": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Iid"
},
"group_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Group Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"confidential": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Confidential"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"labels": {
"items": {
"type": "string"
},
"title": "Labels",
"type": "array"
}
},
"title": "EpicSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"epic": {
"anyOf": [
{
"$ref": "#/$defs/EpicSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateEpicOutput",
"type": "object"
}
create_issue — Create a new issue in a GitLab project
create_issue — Create a new issue in a GitLab project
Parameters
integer
required
The project ID, as displayed in the main project page
string
required
The title of the issue
string
The description of the issue
array
List of label names for the issue
array
List of user IDs to assign the issue to
Response
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"iid": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Iid"
},
"project_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"closed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Closed At"
},
"labels": {
"items": {
"type": "string"
},
"title": "Labels",
"type": "array"
},
"assignees": {
"items": {
"type": "string"
},
"title": "Assignees",
"type": "array"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issue": {
"anyOf": [
{
"$ref": "#/$defs/IssueSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateIssueOutput",
"type": "object"
}
get_issue — Get a single issue from a GitLab project
get_issue — Get a single issue from a GitLab project
Parameters
integer
required
The project ID, as displayed in the main project page
string
required
The internal ID of the project issue
Response
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"iid": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Iid"
},
"project_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"closed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Closed At"
},
"labels": {
"items": {
"type": "string"
},
"title": "Labels",
"type": "array"
},
"assignees": {
"items": {
"type": "string"
},
"title": "Assignees",
"type": "array"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issue": {
"anyOf": [
{
"$ref": "#/$defs/IssueSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetIssueOutput",
"type": "object"
}
get_repo_branch — Get a single repository branch from a GitLab project
get_repo_branch — Get a single repository branch from a GitLab project
Parameters
integer
required
The project ID, as displayed in the main project page
string
required
The name of the branch
Response
{
"$defs": {
"BranchCommit": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Short Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"author_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Name"
},
"author_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Email"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message"
}
},
"title": "BranchCommit",
"type": "object"
},
"BranchSummary": {
"additionalProperties": false,
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"commit": {
"anyOf": [
{
"$ref": "#/$defs/BranchCommit"
},
{
"type": "null"
}
],
"default": null
},
"merged": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Merged"
},
"protected": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Protected"
},
"developers_can_push": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Developers Can Push"
},
"developers_can_merge": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Developers Can Merge"
},
"can_push": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Can Push"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
}
},
"title": "BranchSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"branch": {
"anyOf": [
{
"$ref": "#/$defs/BranchSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetRepoBranchOutput",
"type": "object"
}
list_commits — List commits in a GitLab repository branch
list_commits — List commits in a GitLab repository branch
Parameters
integer
required
The project ID, as displayed in the main project page
string
The name of a repository branch, tag, or revision range; defaults to the default branch if not given
integer
Maximum number of commits to return (per_page) (Default:
100)Response
{
"$defs": {
"CommitSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Short Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"author_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Name"
},
"author_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Email"
},
"authored_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Authored Date"
},
"committed_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Committed Date"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
}
},
"title": "CommitSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"commits": {
"items": {
"$ref": "#/$defs/CommitSummary"
},
"title": "Commits",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListCommitsOutput",
"type": "object"
}
list_groups — List all groups accessible to the authenticated user
list_groups — List all groups accessible to the authenticated user
Parameters
integer
Limit to groups where the user has at least this access level: 10 (Guest), 20 (Reporter), 30 (Developer), 40 (Maintainer), 50 (Owner)
boolean
Limit to top-level groups, excluding all subgroups
string
Return groups matching this search string
string
Order groups by: name, path, id, or similarity (must be similarity when search is provided)
string
Sort order: asc or desc (Default:
asc)boolean
Limit to groups that are not archived and not marked for deletion
boolean
Limit to groups that are archived
Response
{
"$defs": {
"GroupSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Path"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"visibility": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Visibility"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
},
"full_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Full Name"
},
"full_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Full Path"
}
},
"title": "GroupSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"groups": {
"items": {
"$ref": "#/$defs/GroupSummary"
},
"title": "Groups",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListGroupsOutput",
"type": "object"
}
list_project_members — List all members of a GitLab project
list_project_members — List all members of a GitLab project
Parameters
integer
required
The project ID, as displayed in the main project page
string
Filter results by name, email, or username (partial values accepted)
array
List of user IDs to filter results to
array
List of user IDs to exclude from results
boolean
Return seat information for each member if available
Response
{
"$defs": {
"MemberSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"access_level": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Level"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
}
},
"title": "MemberSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"members": {
"items": {
"$ref": "#/$defs/MemberSummary"
},
"title": "Members",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListProjectMembersOutput",
"type": "object"
}
list_repo_branches — Get a list of repository branches from a GitLab project
list_repo_branches — Get a list of repository branches from a GitLab project
Parameters
integer
required
The project ID, as displayed in the main project page
string
Return branches containing this search string (use ^term and term$ for prefix/suffix matching)
Response
{
"$defs": {
"BranchCommit": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"short_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Short Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"author_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Name"
},
"author_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Email"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message"
}
},
"title": "BranchCommit",
"type": "object"
},
"BranchSummary": {
"additionalProperties": false,
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"commit": {
"anyOf": [
{
"$ref": "#/$defs/BranchCommit"
},
{
"type": "null"
}
],
"default": null
},
"merged": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Merged"
},
"protected": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Protected"
},
"developers_can_push": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Developers Can Push"
},
"developers_can_merge": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Developers Can Merge"
},
"can_push": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Can Push"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
}
},
"title": "BranchSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"branches": {
"items": {
"$ref": "#/$defs/BranchSummary"
},
"title": "Branches",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListRepoBranchesOutput",
"type": "object"
}
search_issues — Search for issues in a GitLab project
search_issues — Search for issues in a GitLab project
Parameters
integer
required
The project ID, as displayed in the main project page
string
Search issues against their title and description
array
List of label names; issues must have all labels to be returned
string
Return issues by state: all, opened, or closed (Default:
all)string
Return issues assigned to the given user ID
integer
Maximum number of issues to return (per_page) (Default:
100)Response
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"iid": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Iid"
},
"project_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"closed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Closed At"
},
"labels": {
"items": {
"type": "string"
},
"title": "Labels",
"type": "array"
},
"assignees": {
"items": {
"type": "string"
},
"title": "Assignees",
"type": "array"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issues": {
"items": {
"$ref": "#/$defs/IssueSummary"
},
"title": "Issues",
"type": "array"
}
},
"required": [
"success"
],
"title": "SearchIssuesOutput",
"type": "object"
}
update_epic — Update an existing epic in a GitLab group (requires GitLab Premium or Ultimate)
update_epic — Update an existing epic in a GitLab group (requires GitLab Premium or Ultimate)
Parameters
string
required
The ID of the group
string
required
The internal ID of the epic
string
The title of the epic
string
The description of the epic
array
List of label names for the epic (set empty to unassign all)
array
Labels to add to the epic
array
Labels to remove from the epic
string
The ID of a parent epic (available in GitLab 14.6+)
string
State event for the epic: close or reopen
boolean
Whether the epic should be confidential
string
The color of the epic
string
When the epic was updated, ISO 8601 format (requires admin or owner privileges)
boolean
Whether start date should be sourced from start_date_fixed or from milestones
boolean
Whether due date should be sourced from due_date_fixed or from milestones
string
The fixed start date of the epic, ISO 8601 format (relevant when start_date_is_fixed is true)
string
The fixed due date of the epic, ISO 8601 format (relevant when due_date_is_fixed is true)
Response
{
"$defs": {
"EpicSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"iid": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Iid"
},
"group_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Group Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"confidential": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Confidential"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"labels": {
"items": {
"type": "string"
},
"title": "Labels",
"type": "array"
}
},
"title": "EpicSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"epic": {
"anyOf": [
{
"$ref": "#/$defs/EpicSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "UpdateEpicOutput",
"type": "object"
}
update_issue — Update an existing issue in a GitLab project
update_issue — Update an existing issue in a GitLab project
Parameters
integer
required
The project ID, as displayed in the main project page
string
required
The internal ID of the issue
string
The title of the issue
string
The description of the issue
array
List of label names for the issue (set empty to unassign all)
array
List of user IDs to assign the issue to (set to 0 or empty to unassign all)
string
State event for the issue: close or reopen
boolean
Whether the issue discussion is locked (only project members can add or edit comments when locked)
Response
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"iid": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Iid"
},
"project_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"web_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Web Url"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"closed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Closed At"
},
"labels": {
"items": {
"type": "string"
},
"title": "Labels",
"type": "array"
},
"assignees": {
"items": {
"type": "string"
},
"title": "Assignees",
"type": "array"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issue": {
"anyOf": [
{
"$ref": "#/$defs/IssueSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "UpdateIssueOutput",
"type": "object"
}
Limits & Quotas
- Authenticated requests: 2,000 requests per minute per user (GitLab.com).
- Unauthenticated: 500 requests per minute.
- Epics API: restricted to GitLab Premium and Ultimate tiers.
- Error model: non-2xx responses raise
httpx.HTTPStatusError(Pattern A). The agent or runtime catches the exception at a higher layer.