GraphQL API Resources
This documentation is self-generated based on GitLab current GraphQL schema.
The API can be explored interactively using the GraphiQL IDE .
Each table below documents a GraphQL type. Types match loosely to models, but not all
fields and methods on a model are available via GraphQL.
caution Fields that are deprecated are marked with
.
Items (fields, enums, etc) that have been removed according to our
deprecation process can be found
in
Removed Items .
Query
type
The Query
type contains the API’s top-level entry points for all executable queries.
Query.ciApplicationSettings
CI related settings that apply to the entire instance.
Returns CiApplicationSettings
.
Query.ciConfig
Linted and processed contents of a CI config.
Should not be requested more than once per request.
Returns CiConfig
.
Arguments
Name
Type
Description
content
String!
Contents of .gitlab-ci.yml
.
dryRun
Boolean
Run pipeline creation simulation, or only do static check.
projectPath
ID!
The project of the CI config.
Query.containerRepository
Find a container repository.
Returns ContainerRepositoryDetails
.
Arguments
Query.currentLicense
Fields related to the current license.
Returns CurrentLicense
.
Query.currentUser
Get information about current user.
Returns UserCore
.
Query.designManagement
Fields related to design management.
Returns DesignManagement!
.
Query.devopsAdoptionSegments
Get configured DevOps adoption segments on the instance. BETA This endpoint is subject to change without notice.
Returns DevopsAdoptionSegmentConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
directDescendantsOnly
Boolean
Limits segments to direct descendants of specified parent.
parentNamespaceId
NamespaceID
Filter by ancestor namespace.
Query.echo
Testing endpoint to validate the API with.
Returns String!
.
Arguments
Name
Type
Description
text
String!
Text to echo back.
Query.geoNode
Find a Geo node.
Returns GeoNode
.
Arguments
Name
Type
Description
name
String
The name of the Geo node. Defaults to the current Geo node name.
Query.group
Find a group.
Returns Group
.
Arguments
Name
Type
Description
fullPath
ID!
The full path of the project, group or namespace, e.g., gitlab-org/gitlab-foss
.
Query.instanceSecurityDashboard
Fields related to Instance Security Dashboard.
Returns InstanceSecurityDashboard
.
Query.instanceStatisticsMeasurements
Get statistics on the instance.
Returns UsageTrendsMeasurementConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
identifier
MeasurementIdentifier!
The type of measurement/statistics to retrieve.
recordedAfter
Time
Measurement recorded after this date.
recordedBefore
Time
Measurement recorded before this date.
Query.issue
Find an issue.
Returns Issue
.
Arguments
Name
Type
Description
id
IssueID!
The global ID of the issue.
Query.iteration
Find an iteration.
Returns Iteration
.
Arguments
Name
Type
Description
id
IterationID!
Find an iteration by its ID.
Query.licenseHistoryEntries
Fields related to entries in the license history.
Returns LicenseHistoryEntryConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Query.mergeRequest
Find a merge request.
Returns MergeRequest
.
Arguments
Name
Type
Description
id
MergeRequestID!
The global ID of the merge request.
Metadata about GitLab.
Returns Metadata
.
Query.milestone
Find a milestone.
Returns Milestone
.
Arguments
Name
Type
Description
id
MilestoneID!
Find a milestone by its ID.
Query.namespace
Find a namespace.
Returns Namespace
.
Arguments
Name
Type
Description
fullPath
ID!
The full path of the project, group or namespace, e.g., gitlab-org/gitlab-foss
.
Query.package
Find a package.
Returns PackageDetailsType
.
Arguments
Query.project
Find a project.
Returns Project
.
Arguments
Name
Type
Description
fullPath
ID!
The full path of the project, group or namespace, e.g., gitlab-org/gitlab-foss
.
Query.projects
Find projects visible to the current user.
Returns ProjectConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
ids
[ID!]
Filter projects by IDs.
membership
Boolean
Limit projects that the current user is a member of.
search
String
Search query for project name, path, or description.
searchNamespaces
Boolean
Include namespace in project search.
sort
String
Sort order of results.
Query.runner
Find a runner. Available only when feature flag runner_graphql_query
is enabled.
Returns CiRunner
.
Arguments
Supported runner platforms.
Returns RunnerPlatformConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Query.runnerSetup
Runner setup instructions.
Returns RunnerSetup
.
Arguments
Name
Type
Description
architecture
String!
Architecture to generate the instructions for.
groupId
GroupID
Deprecated in 13.11. No longer used.
platform
String!
Platform to generate the instructions for.
projectId
ProjectID
Deprecated in 13.11. No longer used.
Query.runners
Find runners visible to the current user. Available only when feature flag runner_graphql_query
is enabled.
Returns CiRunnerConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
sort
CiRunnerSort
Sort order of results.
status
CiRunnerStatus
Filter runners by status.
tagList
[String!]
Filter by tags associated with the runner (comma-separated or array).
type
CiRunnerType
Filter runners by type.
Query.snippets
Find Snippets visible to the current user.
Returns SnippetConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
authorId
UserID
The ID of an author.
explore
Boolean
Explore personal snippets.
ids
[SnippetID!]
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1
.
projectId
ProjectID
The ID of a project.
type
TypeEnum
The type of snippet.
visibility
VisibilityScopesEnum
The visibility of the snippet.
Query.usageTrendsMeasurements
Get statistics on the instance.
Returns UsageTrendsMeasurementConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
identifier
MeasurementIdentifier!
The type of measurement/statistics to retrieve.
recordedAfter
Time
Measurement recorded after this date.
recordedBefore
Time
Measurement recorded before this date.
Query.user
Find a user.
Returns UserCore
.
Arguments
Name
Type
Description
id
UserID
ID of the User.
username
String
Username of the User.
Query.users
Find users.
Returns UserCoreConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
admins
Boolean
Return only admin users.
ids
[ID!]
List of user Global IDs.
search
String
Query to search users by name, username, or primary email.
sort
Sort
Sort users by this criteria.
usernames
[String!]
List of usernames.
Query.vulnerabilities
Vulnerabilities reported on projects on the current user’s instance security dashboard.
Returns VulnerabilityConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Query.vulnerabilitiesCountByDay
Number of vulnerabilities per day for the projects on the current user’s instance security dashboard.
Returns VulnerabilitiesCountByDayConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
endDate
ISO8601Date!
Last day for which to fetch vulnerability history.
startDate
ISO8601Date!
First day for which to fetch vulnerability history.
Query.vulnerabilitiesCountByDayAndSeverity
Number of vulnerabilities per severity level, per day, for the projects on the
current user’s instance security dashboard.
.
Returns VulnerabilitiesCountByDayAndSeverityConnection
.
This field returns a connection . It accepts the
four standard pagination arguments :
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name
Type
Description
endDate
ISO8601Date!
Last day for which to fetch vulnerability history.
startDate
ISO8601Date!
First day for which to fetch vulnerability history.
Query.vulnerability
Find a vulnerability.
Returns Vulnerability
.
Arguments
Mutation
type
The Mutation
type contains all the mutations you can execute.
All mutations receive their arguments in a single input object named input
, and all mutations
support at least a return field errors
containing a list of error messages.
All input objects may have a clientMutationId: String
field, identifying the mutation.
For example:
mutation ( $id : NoteableID !, $body : String !) {
createNote ( input : { noteableId : $id , body : $body }) {
errors
}
}
Mutation.addAwardEmoji
caution Deprecated in 13.2.
Use awardEmojiAdd.
Input type: AddAwardEmojiInput
Arguments
Name
Type
Description
awardableId
AwardableID!
The global ID of the awardable resource.
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
The emoji name.
Fields
Name
Type
Description
awardEmoji
AwardEmoji
The award emoji after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.addProjectToSecurityDashboard
Input type: AddProjectToSecurityDashboardInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
ProjectID!
ID of the project to be added to Instance Security Dashboard.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
project
Project
Project that was added to the Instance Security Dashboard.
Mutation.adminSidekiqQueuesDeleteJobs
Input type: AdminSidekiqQueuesDeleteJobsInput
Arguments
Name
Type
Description
callerId
String
Delete jobs matching caller_id in the context metadata.
clientId
String
Delete jobs matching client_id in the context metadata.
clientMutationId
String
A unique identifier for the client performing the mutation.
featureCategory
String
Delete jobs matching feature_category in the context metadata.
project
String
Delete jobs matching project in the context metadata.
queueName
String!
The name of the queue to delete jobs from.
relatedClass
String
Delete jobs matching related_class in the context metadata.
remoteIp
String
Delete jobs matching remote_ip in the context metadata.
rootNamespace
String
Delete jobs matching root_namespace in the context metadata.
subscriptionPlan
String
Delete jobs matching subscription_plan in the context metadata.
user
String
Delete jobs matching user in the context metadata.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
result
DeleteJobsResponse
Information about the status of the deletion request.
Mutation.alertSetAssignees
Input type: AlertSetAssigneesInput
Arguments
Name
Type
Description
assigneeUsernames
[String!]!
The usernames to assign to the alert. Replaces existing assignees by default.
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the alert to mutate.
operationMode
MutationOperationMode
The operation to perform. Defaults to REPLACE.
projectPath
ID!
The project the alert to mutate is in.
Fields
Name
Type
Description
alert
AlertManagementAlert
The alert after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue created after mutation.
todo
Todo
The to-do item after mutation.
Mutation.alertTodoCreate
Input type: AlertTodoCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the alert to mutate.
projectPath
ID!
The project the alert to mutate is in.
Fields
Name
Type
Description
alert
AlertManagementAlert
The alert after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue created after mutation.
todo
Todo
The to-do item after mutation.
Mutation.apiFuzzingCiConfigurationCreate
Input type: ApiFuzzingCiConfigurationCreateInput
Arguments
Name
Type
Description
apiSpecificationFile
String!
File path or URL to the file that defines the API surface for scanning. Must be in the format specified by the scanMode
argument.
authPassword
String
CI variable containing the password for authenticating with the target API.
authUsername
String
CI variable containing the username for authenticating with the target API.
clientMutationId
String
A unique identifier for the client performing the mutation.
projectPath
ID!
Full path of the project.
scanMode
ApiFuzzingScanMode!
The mode for API fuzzing scans.
scanProfile
String
Name of a default profile to use for scanning. Ex: Quick-10.
target
String!
URL for the target of API fuzzing scans.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
configurationYaml
String
A YAML snippet that can be inserted into the project’s .gitlab-ci.yml
to set up API fuzzing scans.
errors
[String!]!
Errors encountered during execution of the mutation.
gitlabCiYamlEditPath
String
The location at which the project’s .gitlab-ci.yml
file can be edited in the browser.
Mutation.awardEmojiAdd
Input type: AwardEmojiAddInput
Arguments
Name
Type
Description
awardableId
AwardableID!
The global ID of the awardable resource.
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
The emoji name.
Fields
Name
Type
Description
awardEmoji
AwardEmoji
The award emoji after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.awardEmojiRemove
Input type: AwardEmojiRemoveInput
Arguments
Name
Type
Description
awardableId
AwardableID!
The global ID of the awardable resource.
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
The emoji name.
Fields
Name
Type
Description
awardEmoji
AwardEmoji
The award emoji after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.awardEmojiToggle
Input type: AwardEmojiToggleInput
Arguments
Name
Type
Description
awardableId
AwardableID!
The global ID of the awardable resource.
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
The emoji name.
Fields
Name
Type
Description
awardEmoji
AwardEmoji
The award emoji after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
toggledOn
Boolean!
Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.
Mutation.boardListCreate
Input type: BoardListCreateInput
Arguments
Name
Type
Description
assigneeId
UserID
Global ID of an existing user.
backlog
Boolean
Create the backlog list.
boardId
BoardID!
Global ID of the issue board to mutate.
clientMutationId
String
A unique identifier for the client performing the mutation.
iterationId
IterationID
Global ID of an existing iteration.
labelId
LabelID
Global ID of an existing label.
milestoneId
MilestoneID
Global ID of an existing milestone.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
list
BoardList
Issue list in the issue board.
Mutation.boardListUpdateLimitMetrics
Input type: BoardListUpdateLimitMetricsInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
limitMetric
ListLimitMetric
The new limit metric type for the list.
listId
ListID!
The global ID of the list.
maxIssueCount
Int
The new maximum issue count limit.
maxIssueWeight
Int
The new maximum issue weight limit.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
list
BoardList
The updated list.
Mutation.bulkFindOrCreateDevopsAdoptionSegments
BETA This endpoint is subject to change without notice.
Input type: BulkFindOrCreateDevopsAdoptionSegmentsInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
namespaceIds
[NamespaceID!]!
List of Namespace IDs for the segments.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
segments
[DevopsAdoptionSegment!]
Created segments after mutation.
Mutation.ciCdSettingsUpdate
Input type: CiCdSettingsUpdateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
fullPath
ID!
Full Path of the project the settings belong to.
keepLatestArtifact
Boolean
Indicates if the latest artifact should be kept for this project.
mergePipelinesEnabled
Boolean
Indicates if merge pipelines are enabled for the project.
mergeTrainsEnabled
Boolean
Indicates if merge trains are enabled for the project.
Fields
Name
Type
Description
ciCdSettings
ProjectCiCdSetting!
The CI/CD settings after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.clusterAgentDelete
Input type: ClusterAgentDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
ClustersAgentID!
Global ID of the cluster agent that will be deleted.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.clusterAgentTokenCreate
Input type: ClusterAgentTokenCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
clusterAgentId
ClustersAgentID!
Global ID of the cluster agent that will be associated with the new token.
description
String
Description of the token.
name
String!
Name of the token.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
secret
String
Token secret value. Make sure you save it - you won’t be able to access it again.
token
ClusterAgentToken
Token created after mutation.
Mutation.clusterAgentTokenDelete
Input type: ClusterAgentTokenDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
ClustersAgentTokenID!
Global ID of the cluster agent token that will be deleted.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.commitCreate
Input type: CommitCreateInput
Arguments
Name
Type
Description
actions
[CommitAction!]!
Array of action hashes to commit as a batch.
branch
String!
Name of the branch to commit into, it can be a new branch.
clientMutationId
String
A unique identifier for the client performing the mutation.
message
String!
Raw commit message.
projectPath
ID!
Project full path the branch is associated with.
startBranch
String
If on a new branch, name of the original branch.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
commit
Commit
The commit after mutation.
commitPipelinePath
String
ETag path for the commit’s pipeline.
errors
[String!]!
Errors encountered during execution of the mutation.
Configure SAST for a project by enabling SAST in a new or modified
.gitlab-ci.yml
file in a new branch. The new branch and a URL to
create a Merge Request are a part of the response.
Input type: ConfigureSastInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
configuration
SastCiConfigurationInput!
SAST CI configuration for the project.
projectPath
ID!
Full path of the project.
Fields
Name
Type
Description
branch
String
Branch that has the new/modified .gitlab-ci.yml
file.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
successPath
String
Redirect path to use when the response is successful.
Configure Secret Detection for a project by enabling Secret Detection
in a new or modified .gitlab-ci.yml
file in a new branch. The new
branch and a URL to create a Merge Request are a part of the
response.
Input type: ConfigureSecretDetectionInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
projectPath
ID!
Full path of the project.
Fields
Name
Type
Description
branch
String
Branch that has the new/modified .gitlab-ci.yml
file.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
successPath
String
Redirect path to use when the response is successful.
Mutation.createAlertIssue
Input type: CreateAlertIssueInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the alert to mutate.
projectPath
ID!
The project the alert to mutate is in.
Fields
Name
Type
Description
alert
AlertManagementAlert
The alert after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue created after mutation.
todo
Todo
The to-do item after mutation.
Mutation.createAnnotation
Input type: CreateAnnotationInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
clusterId
ClustersClusterID
The global ID of the cluster to add an annotation to.
dashboardPath
String!
The path to a file defining the dashboard on which the annotation should be added.
description
String!
The description of the annotation.
endingAt
Time
Timestamp indicating ending moment to which the annotation relates.
environmentId
EnvironmentID
The global ID of the environment to add an annotation to.
startingAt
Time!
Timestamp indicating starting moment to which the annotation relates.
Fields
Name
Type
Description
annotation
MetricsDashboardAnnotation
The created annotation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.createBoard
Input type: CreateBoardInput
Arguments
Name
Type
Description
assigneeId
UserID
ID of user to be assigned to the board.
clientMutationId
String
A unique identifier for the client performing the mutation.
groupPath
ID
Full path of the group with which the resource is associated.
hideBacklogList
Boolean
Whether or not backlog list is hidden.
hideClosedList
Boolean
Whether or not closed list is hidden.
iterationId
IterationID
ID of iteration to be assigned to the board.
labelIds
[LabelID!]
IDs of labels to be added to the board.
labels
[String!]
Labels of the issue.
milestoneId
MilestoneID
ID of milestone to be assigned to the board.
name
String
The board name.
projectPath
ID
Full path of the project with which the resource is associated.
weight
Int
Weight value to be assigned to the board.
Fields
Name
Type
Description
board
Board
The board after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.createBranch
Input type: CreateBranchInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
Name of the branch.
projectPath
ID!
Project full path the branch is associated with.
ref
String!
Branch name or commit SHA to create branch from.
Fields
Name
Type
Description
branch
Branch
Branch after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.createClusterAgent
Input type: CreateClusterAgentInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
Name of the cluster agent.
projectPath
ID!
Full path of the associated project for this cluster agent.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
clusterAgent
ClusterAgent
Cluster agent created after mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.createComplianceFramework
Input type: CreateComplianceFrameworkInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
namespacePath
ID!
Full path of the namespace to add the compliance framework to.
params
ComplianceFrameworkInput!
Parameters to update the compliance framework with.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
framework
ComplianceFramework
The created compliance framework.
Mutation.createCustomEmoji
Available only when feature flag custom_emoji
is enabled.
Input type: CreateCustomEmojiInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
groupPath
ID!
Namespace full path the emoji is associated with.
name
String!
Name of the emoji.
url
String!
Location of the emoji file.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
customEmoji
CustomEmoji
The new custom emoji.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.createDevopsAdoptionSegment
BETA This endpoint is subject to change without notice.
Input type: CreateDevopsAdoptionSegmentInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
namespaceId
NamespaceID!
Namespace ID to set for the segment.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
segment
DevopsAdoptionSegment
The segment after mutation.
Mutation.createDiffNote
Input type: CreateDiffNoteInput
Arguments
Name
Type
Description
body
String!
Content of the note.
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean
The confidentiality flag of a note. Default is false.
noteableId
NoteableID!
The global ID of the resource to add a note to.
position
DiffPositionInput!
The position of this note on a diff.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
note
Note
The note after mutation.
Mutation.createEpic
Input type: CreateEpicInput
Arguments
Name
Type
Description
addLabelIds
[ID!]
The IDs of labels to be added to the epic.
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean
Indicates if the epic is confidential.
description
String
The description of the epic.
dueDateFixed
String
The end date of the epic.
dueDateIsFixed
Boolean
Indicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath
ID!
The group the epic to mutate is in.
removeLabelIds
[ID!]
The IDs of labels to be removed from the epic.
startDateFixed
String
The start date of the epic.
startDateIsFixed
Boolean
Indicates start date should be sourced from start_date_fixed field not the issue milestones.
title
String
The title of the epic.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epic
Epic
The created epic.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.createImageDiffNote
Input type: CreateImageDiffNoteInput
Arguments
Name
Type
Description
body
String!
Content of the note.
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean
The confidentiality flag of a note. Default is false.
noteableId
NoteableID!
The global ID of the resource to add a note to.
position
DiffImagePositionInput!
The position of this note on a diff.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
note
Note
The note after mutation.
Mutation.createIssue
Input type: CreateIssueInput
Arguments
Name
Type
Description
assigneeIds
[UserID!]
The array of user IDs to assign to the issue.
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean
Indicates the issue is confidential.
createdAt
Time
Timestamp when the issue was created. Available only for admins and project owners.
description
String
Description of the issue.
discussionToResolve
String
The ID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of
.
dueDate
ISO8601Date
Due date of the issue.
epicId
EpicID
The ID of an epic to associate the issue with.
healthStatus
HealthStatus
The desired health status.
iid
Int
The IID (internal ID) of a project issue. Only admins and project owners can modify.
labelIds
[LabelID!]
The IDs of labels to be added to the issue.
labels
[String!]
Labels of the issue.
locked
Boolean
Indicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOf
MergeRequestID
The IID of a merge request for which to resolve discussions.
milestoneId
MilestoneID
The ID of the milestone to assign to the issue. On update milestone will be removed if set to null.
projectPath
ID!
Project full path the issue is associated with.
title
String!
Title of the issue.
type
IssueType
Type of the issue.
weight
Int
The weight of the issue.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.createIteration
Input type: CreateIterationInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
The description of the iteration.
dueDate
String
The end date of the iteration.
groupPath
ID
Full path of the group with which the resource is associated.
projectPath
ID
Full path of the project with which the resource is associated.
startDate
String
The start date of the iteration.
title
String
The title of the iteration.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
iteration
Iteration
The created iteration.
Mutation.createNote
Input type: CreateNoteInput
Arguments
Name
Type
Description
body
String!
Content of the note.
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean
The confidentiality flag of a note. Default is false.
discussionId
DiscussionID
The global ID of the discussion this note is in reply to.
noteableId
NoteableID!
The global ID of the resource to add a note to.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
note
Note
The note after mutation.
Mutation.createRequirement
Input type: CreateRequirementInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the requirement.
projectPath
ID!
Full project path the requirement is associated with.
title
String
Title of the requirement.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
requirement
Requirement
Requirement after mutation.
Mutation.createSnippet
Input type: CreateSnippetInput
Arguments
Name
Type
Description
blobActions
[SnippetBlobActionInputType!]
Actions to perform over the snippet repository and blobs.
captchaResponse
String
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the snippet.
projectPath
ID
The project full path the snippet is associated with.
spamLogId
Int
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
title
String!
Title of the snippet.
uploadedFiles
[String!]
The paths to files uploaded in the snippet description.
visibilityLevel
VisibilityLevelsEnum!
The visibility level of the snippet.
Fields
Name
Type
Description
captchaSiteKey
String
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
needsCaptchaResponse
Boolean
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
snippet
Snippet
The snippet after mutation.
spam
Boolean
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
spamLogId
Int
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
Mutation.createTestCase
Input type: CreateTestCaseInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
The test case description.
labelIds
[ID!]
The IDs of labels to be added to the test case.
projectPath
ID!
The project full path to create the test case.
title
String!
The test case title.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
testCase
Issue
The test case created.
Mutation.dastOnDemandScanCreate
Input type: DastOnDemandScanCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
dastScannerProfileId
DastScannerProfileID
ID of the scanner profile to be used for the scan.
dastSiteProfileId
DastSiteProfileID!
ID of the site profile to be used for the scan.
fullPath
ID!
The project the site profile belongs to.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
pipelineUrl
String
URL of the pipeline that was created.
Mutation.dastProfileCreate
Input type: DastProfileCreateInput
Arguments
Name
Type
Description
branchName
String
The associated branch.
clientMutationId
String
A unique identifier for the client performing the mutation.
dastScannerProfileId
DastScannerProfileID!
ID of the scanner profile to be associated.
dastSiteProfileId
DastSiteProfileID!
ID of the site profile to be associated.
description
String
The description of the profile. Defaults to an empty string.
fullPath
ID!
The project the profile belongs to.
name
String!
The name of the profile.
runAfterCreate
Boolean
Run scan using profile after creation. Defaults to false.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
dastProfile
DastProfile
The created profile.
errors
[String!]!
Errors encountered during execution of the mutation.
pipelineUrl
String
The URL of the pipeline that was created. Requires runAfterCreate
to be set to true
.
Mutation.dastProfileDelete
Input type: DastProfileDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
DastProfileID!
ID of the profile to be deleted.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.dastProfileRun
Input type: DastProfileRunInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
fullPath
ID!
Full path for the project the scanner profile belongs to.
id
DastProfileID!
ID of the profile to be used for the scan.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
pipelineUrl
String
URL of the pipeline that was created.
Mutation.dastProfileUpdate
Input type: DastProfileUpdateInput
Arguments
Name
Type
Description
branchName
String
The associated branch.
clientMutationId
String
A unique identifier for the client performing the mutation.
dastScannerProfileId
DastScannerProfileID
ID of the scanner profile to be associated.
dastSiteProfileId
DastSiteProfileID
ID of the site profile to be associated.
description
String
The description of the profile. Defaults to an empty string.
fullPath
ID!
The project the profile belongs to.
id
DastProfileID!
ID of the profile to be deleted.
name
String
The name of the profile.
runAfterUpdate
Boolean
Run scan using profile after update. Defaults to false.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
dastProfile
DastProfile
The updated profile.
errors
[String!]!
Errors encountered during execution of the mutation.
pipelineUrl
String
The URL of the pipeline that was created. Requires the input argument runAfterUpdate
to be set to true
when calling the mutation, otherwise no pipeline will be created.
Mutation.dastScannerProfileCreate
Input type: DastScannerProfileCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
fullPath
ID!
The project the scanner profile belongs to.
profileName
String!
The name of the scanner profile.
scanType
DastScanTypeEnum
Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages
Boolean
Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout
Int
The maximum number of minutes allowed for the spider to traverse the site.
targetTimeout
Int
The maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider
Boolean
Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
globalId
DastScannerProfileID
Deprecated: Use id
. Deprecated in 13.6.
id
DastScannerProfileID
ID of the scanner profile.
Mutation.dastScannerProfileDelete
Input type: DastScannerProfileDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
fullPath
ID!
Full path for the project the scanner profile belongs to.
id
DastScannerProfileID!
ID of the scanner profile to be deleted.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.dastScannerProfileUpdate
Input type: DastScannerProfileUpdateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
fullPath
ID!
The project the scanner profile belongs to.
id
DastScannerProfileID!
ID of the scanner profile to be updated.
profileName
String!
The name of the scanner profile.
scanType
DastScanTypeEnum
Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages
Boolean
Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout
Int!
The maximum number of minutes allowed for the spider to traverse the site.
targetTimeout
Int!
The maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider
Boolean
Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
id
DastScannerProfileID
ID of the scanner profile.
Mutation.dastSiteProfileCreate
Input type: DastSiteProfileCreateInput
Arguments
Name
Type
Description
auth
DastSiteProfileAuthInput
Parameters for authentication. Will be ignored if security_dast_site_profiles_additional_fields
feature flag is disabled.
clientMutationId
String
A unique identifier for the client performing the mutation.
excludedUrls
[String!]
The URLs to skip during an authenticated scan. Defaults to []
. Will be ignored if security_dast_site_profiles_additional_fields
feature flag is disabled.
fullPath
ID!
The project the site profile belongs to.
profileName
String!
The name of the site profile.
requestHeaders
String
Comma-separated list of request header names and values to be added to every request made by DAST. Will be ignored if security_dast_site_profiles_additional_fields
feature flag is disabled.
targetType
DastTargetTypeEnum
The type of target to be scanned. Will be ignored if security_dast_site_profiles_api_option
feature flag is disabled.
targetUrl
String
The URL of the target to be scanned.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
id
DastSiteProfileID
ID of the site profile.
Mutation.dastSiteProfileDelete
Input type: DastSiteProfileDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
fullPath
ID!
The project the site profile belongs to.
id
DastSiteProfileID!
ID of the site profile to be deleted.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.dastSiteProfileUpdate
Input type: DastSiteProfileUpdateInput
Arguments
Name
Type
Description
auth
DastSiteProfileAuthInput
Parameters for authentication. Will be ignored if security_dast_site_profiles_additional_fields
feature flag is disabled.
clientMutationId
String
A unique identifier for the client performing the mutation.
excludedUrls
[String!]
The URLs to skip during an authenticated scan. Will be ignored if security_dast_site_profiles_additional_fields
feature flag is disabled.
fullPath
ID!
The project the site profile belongs to.
id
DastSiteProfileID!
ID of the site profile to be updated.
profileName
String!
The name of the site profile.
requestHeaders
String
Comma-separated list of request header names and values to be added to every request made by DAST. Will be ignored if security_dast_site_profiles_additional_fields
feature flag is disabled.
targetType
DastTargetTypeEnum
The type of target to be scanned. Will be ignored if security_dast_site_profiles_api_option
feature flag is disabled.
targetUrl
String
The URL of the target to be scanned.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
id
DastSiteProfileID
ID of the site profile.
Mutation.dastSiteTokenCreate
Input type: DastSiteTokenCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
fullPath
ID!
The project the site token belongs to.
targetUrl
String
The URL of the target to be validated.
Fields
Mutation.dastSiteValidationCreate
Input type: DastSiteValidationCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
dastSiteTokenId
DastSiteTokenID!
ID of the site token.
fullPath
ID!
The project the site profile belongs to.
strategy
DastSiteValidationStrategyEnum
The validation strategy to be used.
validationPath
String!
The path to be requested during validation.
Fields
Mutation.dastSiteValidationRevoke
Input type: DastSiteValidationRevokeInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
fullPath
ID!
The project the site validation belongs to.
normalizedTargetUrl
String!
Normalized URL of the target to be revoked.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.deleteAnnotation
Input type: DeleteAnnotationInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
MetricsDashboardAnnotationID!
Global ID of the annotation to delete.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.deleteDevopsAdoptionSegment
BETA This endpoint is subject to change without notice.
Input type: DeleteDevopsAdoptionSegmentInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.designManagementDelete
Input type: DesignManagementDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
filenames
[String!]!
The filenames of the designs to delete.
iid
ID!
The IID of the issue to modify designs for.
projectPath
ID!
The project where the issue is to upload designs for.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
version
DesignVersion
The new version in which the designs are deleted.
Mutation.designManagementMove
Input type: DesignManagementMoveInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
designCollection
DesignCollection
The current state of the collection.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.designManagementUpload
Input type: DesignManagementUploadInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
files
[Upload!]!
The files to upload.
iid
ID!
The IID of the issue to modify designs for.
projectPath
ID!
The project where the issue is to upload designs for.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
designs
[Design!]!
The designs that were uploaded by the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
skippedDesigns
[Design!]!
Any designs that were skipped from the upload due to there being no change to their content since their last version.
Mutation.destroyBoard
Input type: DestroyBoardInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
BoardID!
The global ID of the board to destroy.
Fields
Name
Type
Description
board
Board
The board after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.destroyBoardList
Input type: DestroyBoardListInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
listId
ListID!
Global ID of the list to destroy. Only label lists are accepted.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
list
BoardList
The list after mutation.
Mutation.destroyComplianceFramework
Input type: DestroyComplianceFrameworkInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
ComplianceManagementFrameworkID!
The global ID of the compliance framework to destroy.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.destroyContainerRepository
Input type: DestroyContainerRepositoryInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
ContainerRepositoryID!
ID of the container repository.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
containerRepository
ContainerRepository!
The container repository policy after scheduling the deletion.
errors
[String!]!
Errors encountered during execution of the mutation.
Input type: DestroyContainerRepositoryTagsInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
ContainerRepositoryID!
ID of the container repository.
tagNames
[String!]!
Container repository tag(s) to delete. Total number can’t be greater than 20.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
deletedTagNames
[String!]!
Deleted container repository tags.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.destroyEpicBoard
Input type: DestroyEpicBoardInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
BoardsEpicBoardID!
Global ID of the board to destroy.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epicBoard
EpicBoard
Epic board after mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.destroyNote
Input type: DestroyNoteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
NoteID!
The global ID of the note to destroy.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
note
Note
The note after mutation.
Mutation.destroySnippet
Input type: DestroySnippetInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
SnippetID!
The global ID of the snippet to destroy.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
snippet
Snippet
The snippet after mutation.
Mutation.discussionToggleResolve
Toggles the resolved state of a discussion.
Input type: DiscussionToggleResolveInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
DiscussionID!
The global ID of the discussion.
resolve
Boolean!
Will resolve the discussion when true, and unresolve the discussion when false.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
discussion
Discussion
The discussion after mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.dismissVulnerability
caution Deprecated in 13.5.
Use vulnerabilityDismiss.
Input type: DismissVulnerabilityInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
comment
String
Comment why vulnerability should be dismissed.
dismissalReason
VulnerabilityDismissalReason
Reason why vulnerability should be dismissed.
id
VulnerabilityID!
ID of the vulnerability to be dismissed.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
vulnerability
Vulnerability
The vulnerability after dismissal.
Mutation.echoCreate
A mutation that does not perform any changes.
This is expected to be used for testing of endpoints, to verify
that a user has mutation access.
Input type: EchoCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]
Errors to return to the user.
messages
[String!]
Messages to return to the user.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
echoes
[String!]
Messages returned to the user.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.environmentsCanaryIngressUpdate
Input type: EnvironmentsCanaryIngressUpdateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
EnvironmentID!
The global ID of the environment to update.
weight
Int!
The weight of the Canary Ingress.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.epicAddIssue
Input type: EpicAddIssueInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
groupPath
ID!
The group the epic to mutate belongs to.
iid
ID!
The IID of the epic to mutate.
issueIid
String!
The IID of the issue to be added.
projectPath
ID!
The full path of the project the issue belongs to.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epic
Epic
The epic after mutation.
epicIssue
EpicIssue
The epic-issue relation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.epicBoardCreate
Input type: EpicBoardCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
groupPath
ID
Full path of the group with which the resource is associated.
hideBacklogList
Boolean
Whether or not backlog list is hidden.
hideClosedList
Boolean
Whether or not closed list is hidden.
labelIds
[LabelID!]
IDs of labels to be added to the board.
labels
[String!]
Labels of the issue.
name
String
The board name.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epicBoard
EpicBoard
The created epic board.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.epicBoardListCreate
Input type: EpicBoardListCreateInput
Arguments
Name
Type
Description
backlog
Boolean
Create the backlog list.
boardId
BoardsEpicBoardID!
Global ID of the issue board to mutate.
clientMutationId
String
A unique identifier for the client performing the mutation.
labelId
LabelID
Global ID of an existing label.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
list
EpicList
Epic list in the epic board.
Mutation.epicBoardListDestroy
Destroys an epic board list.
Input type: EpicBoardListDestroyInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
listId
BoardsEpicListID!
Global ID of the epic board list to destroy.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
list
EpicList
The epic board list. null
if the board was destroyed successfully.
Mutation.epicBoardUpdate
Input type: EpicBoardUpdateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
hideBacklogList
Boolean
Whether or not backlog list is hidden.
hideClosedList
Boolean
Whether or not closed list is hidden.
id
BoardsEpicBoardID!
The epic board global ID.
labelIds
[LabelID!]
IDs of labels to be added to the board.
labels
[String!]
Labels of the issue.
name
String
The board name.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epicBoard
EpicBoard
The updated epic board.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.epicMoveList
Input type: EpicMoveListInput
Arguments
Name
Type
Description
boardId
BoardsEpicBoardID!
Global ID of the board that the epic is in.
clientMutationId
String
A unique identifier for the client performing the mutation.
epicId
EpicID!
ID of the epic to mutate.
fromListId
BoardsEpicListID!
ID of the board list that the epic will be moved from.
toListId
BoardsEpicListID!
ID of the board list that the epic will be moved to.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.epicSetSubscription
Input type: EpicSetSubscriptionInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
groupPath
ID!
The group the epic to mutate belongs to.
iid
ID!
The IID of the epic to mutate.
subscribedState
Boolean!
The desired state of the subscription.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epic
Epic
The epic after mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.epicTreeReorder
Input type: EpicTreeReorderInput
Arguments
Name
Type
Description
baseEpicId
EpicID!
The ID of the base epic of the tree.
clientMutationId
String
A unique identifier for the client performing the mutation.
moved
EpicTreeNodeFieldsInputType!
Parameters for updating the tree positions.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.exportRequirements
Input type: ExportRequirementsInput
Arguments
Name
Type
Description
authorUsername
[String!]
Filter requirements by author username.
clientMutationId
String
A unique identifier for the client performing the mutation.
projectPath
ID!
Full project path the requirements are associated with.
search
String
Search query for requirement title.
selectedFields
[String!]
List of selected requirements fields to be exported.
sort
Sort
List requirements by sort order.
state
RequirementState
Filter requirements by state.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.gitlabSubscriptionActivate
Input type: GitlabSubscriptionActivateInput
Arguments
Name
Type
Description
activationCode
String!
Activation code received after purchasing a GitLab subscription.
clientMutationId
String
A unique identifier for the client performing the mutation.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
license
CurrentLicense
The current license.
Mutation.httpIntegrationCreate
Input type: HttpIntegrationCreateInput
Arguments
Name
Type
Description
active
Boolean!
Whether the integration is receiving alerts.
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
The name of the integration.
payloadAttributeMappings
[AlertManagementPayloadAlertFieldInput!]
The custom mapping of GitLab alert attributes to fields from the payload_example.
payloadExample
JsonString
The example of an alert payload.
projectPath
ID!
The project to create the integration in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
integration
AlertManagementHttpIntegration
The HTTP integration.
Mutation.httpIntegrationDestroy
Input type: HttpIntegrationDestroyInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
integration
AlertManagementHttpIntegration
The HTTP integration.
Mutation.httpIntegrationResetToken
Input type: HttpIntegrationResetTokenInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
integration
AlertManagementHttpIntegration
The HTTP integration.
Mutation.httpIntegrationUpdate
Input type: HttpIntegrationUpdateInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
integration
AlertManagementHttpIntegration
The HTTP integration.
Mutation.issueMove
Input type: IssueMoveInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the issue to mutate.
projectPath
ID!
The project the issue to mutate is in.
targetProjectPath
ID!
The project to move the issue to.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueMoveList
Input type: IssueMoveListInput
Arguments
Name
Type
Description
boardId
BoardID!
Global ID of the board that the issue is in.
clientMutationId
String
A unique identifier for the client performing the mutation.
epicId
EpicID
The ID of the parent epic. NULL when removing the association.
fromListId
ID
ID of the board list that the issue will be moved from.
iid
String!
IID of the issue to mutate.
moveAfterId
ID
ID of issue that should be placed after the current issue.
moveBeforeId
ID
ID of issue that should be placed before the current issue.
projectPath
ID!
Project the issue to mutate is in.
toListId
ID
ID of the board list that the issue will be moved to.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetAssignees
Input type: IssueSetAssigneesInput
Arguments
Name
Type
Description
assigneeUsernames
[String!]!
The usernames to assign to the resource. Replaces existing assignees by default.
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the issue to mutate.
operationMode
MutationOperationMode
The operation to perform. Defaults to REPLACE.
projectPath
ID!
The project the issue to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetConfidential
Input type: IssueSetConfidentialInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean!
Whether or not to set the issue as a confidential.
iid
String!
The IID of the issue to mutate.
projectPath
ID!
The project the issue to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetDueDate
Input type: IssueSetDueDateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
dueDate
Time
The desired due date for the issue, due date will be removed if absent or set to null.
iid
String!
The IID of the issue to mutate.
projectPath
ID!
The project the issue to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetEpic
Input type: IssueSetEpicInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epicId
EpicID
Global ID of the epic to be assigned to the issue, epic will be removed if absent or set to null.
iid
String!
The IID of the issue to mutate.
projectPath
ID!
The project the issue to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetIteration
Input type: IssueSetIterationInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the issue to mutate.
iterationId
IterationID
The iteration to assign to the issue.
projectPath
ID!
The project the issue to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetLocked
Input type: IssueSetLockedInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the issue to mutate.
locked
Boolean!
Whether or not to lock discussion on the issue.
projectPath
ID!
The project the issue to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetSeverity
Input type: IssueSetSeverityInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the issue to mutate.
projectPath
ID!
The project the issue to mutate is in.
severity
IssuableSeverity!
Set the incident severity level.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetSubscription
Input type: IssueSetSubscriptionInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the issue to mutate.
projectPath
ID!
The project the issue to mutate is in.
subscribedState
Boolean!
The desired state of the subscription.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.issueSetWeight
Input type: IssueSetWeightInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the issue to mutate.
projectPath
ID!
The project the issue to mutate is in.
weight
Int!
The desired weight for the issue.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.iterationCadenceCreate
Input type: IterationCadenceCreateInput
Arguments
Name
Type
Description
active
Boolean!
Whether the iteration cadence is active.
automatic
Boolean!
Whether the iteration cadence should automatically generate future iterations.
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks
Int
Duration in weeks of the iterations within this cadence.
groupPath
ID!
The group where the iteration cadence is created.
iterationsInAdvance
Int
Future iterations to be created when iteration cadence is set to automatic.
rollOver
Boolean
Whether the iteration cadence should roll over issues to the next iteration or not.
startDate
Time
Timestamp of the iteration cadence start date.
title
String
Title of the iteration cadence.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
iterationCadence
IterationCadence
The created iteration cadence.
Mutation.iterationCadenceDestroy
Input type: IterationCadenceDestroyInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
IterationsCadenceID!
Global ID of the iteration cadence.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
group
Group!
Group the iteration cadence belongs to.
Mutation.iterationCadenceUpdate
Input type: IterationCadenceUpdateInput
Arguments
Name
Type
Description
active
Boolean
Whether the iteration cadence is active.
automatic
Boolean
Whether the iteration cadence should automatically generate future iterations.
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks
Int
Duration in weeks of the iterations within this cadence.
id
IterationsCadenceID!
Global ID of the iteration cadence.
iterationsInAdvance
Int
Future iterations to be created when iteration cadence is set to automatic.
rollOver
Boolean
Whether the iteration cadence should roll over issues to the next iteration or not.
startDate
Time
Timestamp of the iteration cadence start date.
title
String
Title of the iteration cadence.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
iterationCadence
IterationCadence
The updated iteration cadence.
Mutation.iterationDelete
Input type: IterationDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
IterationID!
ID of the iteration.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
group
Group!
Group the iteration belongs to.
Mutation.jiraImportStart
Input type: JiraImportStartInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
jiraProjectKey
String!
Project key of the importer Jira project.
jiraProjectName
String
Project name of the importer Jira project.
projectPath
ID!
The project to import the Jira project into.
usersMapping
[JiraUsersMappingInputType!]
The mapping of Jira to GitLab users.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
jiraImport
JiraImport
The Jira import data after mutation.
Mutation.jiraImportUsers
Input type: JiraImportUsersInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
projectPath
ID!
The project to import the Jira users into.
startAt
Int
The index of the record the import should started at, default 0 (50 records returned).
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
jiraUsers
[JiraUser!]
Users returned from Jira, matched by email and name if possible.
Mutation.jobPlay
Input type: JobPlayInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
CiBuildID!
The ID of the job to mutate.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
job
CiJob
The job after the mutation.
Mutation.jobRetry
Input type: JobRetryInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
CiBuildID!
The ID of the job to mutate.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
job
CiJob
The job after the mutation.
Mutation.labelCreate
Input type: LabelCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
color
String
The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB
) or one of the CSS color names.
description
String
Description of the label.
groupPath
ID
Full path of the group with which the resource is associated.
projectPath
ID
Full path of the project with which the resource is associated.
removeOnClose
Boolean
Whether the label should be removed from an issue when the issue is closed.
title
String!
Title of the label.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
label
Label
The label after mutation.
Mutation.markAsSpamSnippet
Input type: MarkAsSpamSnippetInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
SnippetID!
The global ID of the snippet to update.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
snippet
Snippet
The snippet after mutation.
Mutation.mergeRequestAccept
Accepts a merge request.
When accepted, the source branch will be merged into the target branch, either
immediately if possible, or using one of the automatic merge strategies.
Input type: MergeRequestAcceptInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
commitMessage
String
Custom merge commit message.
iid
String!
The IID of the merge request to mutate.
projectPath
ID!
The project the merge request to mutate is in.
sha
String!
The HEAD SHA at the time when this merge was requested.
shouldRemoveSourceBranch
Boolean
Should the source branch be removed.
squash
Boolean
Squash commits on the source branch before merge.
squashCommitMessage
String
Custom squash commit message (if squash is true).
strategy
MergeStrategyEnum
How to merge this merge request.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestCreate
Input type: MergeRequestCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the merge request (Markdown rendered as HTML for caching).
labels
[String!]
Labels of the merge request.
projectPath
ID!
Project full path the merge request is associated with.
sourceBranch
String!
Source branch of the merge request.
targetBranch
String!
Target branch of the merge request.
title
String!
Title of the merge request.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestReviewerRereview
Input type: MergeRequestReviewerRereviewInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the merge request to mutate.
projectPath
ID!
The project the merge request to mutate is in.
userId
UserID!
The user ID for the user that has been requested for a new review.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestSetAssignees
Input type: MergeRequestSetAssigneesInput
Arguments
Name
Type
Description
assigneeUsernames
[String!]!
The usernames to assign to the resource. Replaces existing assignees by default.
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the merge request to mutate.
operationMode
MutationOperationMode
The operation to perform. Defaults to REPLACE.
projectPath
ID!
The project the merge request to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestSetDraft
Input type: MergeRequestSetDraftInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
draft
Boolean!
Whether or not to set the merge request as a draft.
iid
String!
The IID of the merge request to mutate.
projectPath
ID!
The project the merge request to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestSetLabels
Input type: MergeRequestSetLabelsInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the merge request to mutate.
labelIds
[LabelID!]!
The Label IDs to set. Replaces existing labels by default.
operationMode
MutationOperationMode
Changes the operation mode. Defaults to REPLACE.
projectPath
ID!
The project the merge request to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestSetLocked
Input type: MergeRequestSetLockedInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the merge request to mutate.
locked
Boolean!
Whether or not to lock the merge request.
projectPath
ID!
The project the merge request to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestSetMilestone
Input type: MergeRequestSetMilestoneInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the merge request to mutate.
milestoneId
MilestoneID
The milestone to assign to the merge request.
projectPath
ID!
The project the merge request to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestSetSubscription
Input type: MergeRequestSetSubscriptionInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the merge request to mutate.
projectPath
ID!
The project the merge request to mutate is in.
subscribedState
Boolean!
The desired state of the subscription.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestSetWip
caution Deprecated in 13.12.
Use mergeRequestSetDraft.
Input type: MergeRequestSetWipInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the merge request to mutate.
projectPath
ID!
The project the merge request to mutate is in.
wip
Boolean!
Whether or not to set the merge request as a draft.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.mergeRequestUpdate
Update attributes of a merge request.
Input type: MergeRequestUpdateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the merge request (Markdown rendered as HTML for caching).
iid
String!
The IID of the merge request to mutate.
projectPath
ID!
The project the merge request to mutate is in.
state
MergeRequestNewState
The action to perform to change the state.
targetBranch
String
Target branch of the merge request.
title
String
Title of the merge request.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
mergeRequest
MergeRequest
The merge request after mutation.
Mutation.namespaceIncreaseStorageTemporarily
Input type: NamespaceIncreaseStorageTemporarilyInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
NamespaceID!
The global ID of the namespace to mutate.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
namespace
Namespace
The namespace after mutation.
Mutation.oncallRotationCreate
Input type: OncallRotationCreateInput
Arguments
Name
Type
Description
activePeriod
OncallRotationActivePeriodInputType
The active period of time that the on-call rotation should take place.
clientMutationId
String
A unique identifier for the client performing the mutation.
endsAt
OncallRotationDateInputType
The end date and time of the on-call rotation, in the timezone of the on-call schedule.
name
String!
The name of the on-call rotation.
participants
[OncallUserInputType!]!
The usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
projectPath
ID!
The project to create the on-call schedule in.
rotationLength
OncallRotationLengthInputType!
The rotation length of the on-call rotation.
scheduleIid
String!
The IID of the on-call schedule to create the on-call rotation in.
startsAt
OncallRotationDateInputType!
The start date and time of the on-call rotation, in the timezone of the on-call schedule.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
oncallRotation
IncidentManagementOncallRotation
The on-call rotation.
Mutation.oncallRotationDestroy
Input type: OncallRotationDestroyInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
IncidentManagementOncallRotationID!
The ID of the on-call rotation to remove.
projectPath
ID!
The project to remove the on-call schedule from.
scheduleIid
String!
The IID of the on-call schedule to the on-call rotation belongs to.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
oncallRotation
IncidentManagementOncallRotation
The on-call rotation.
Mutation.oncallRotationUpdate
Input type: OncallRotationUpdateInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
oncallRotation
IncidentManagementOncallRotation
The on-call rotation.
Mutation.oncallScheduleCreate
Input type: OncallScheduleCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
The description of the on-call schedule.
name
String!
The name of the on-call schedule.
projectPath
ID!
The project to create the on-call schedule in.
timezone
String!
The timezone of the on-call schedule.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
oncallSchedule
IncidentManagementOncallSchedule
The on-call schedule.
Mutation.oncallScheduleDestroy
Input type: OncallScheduleDestroyInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The on-call schedule internal ID to remove.
projectPath
ID!
The project to remove the on-call schedule from.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
oncallSchedule
IncidentManagementOncallSchedule
The on-call schedule.
Mutation.oncallScheduleUpdate
Input type: OncallScheduleUpdateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
The description of the on-call schedule.
iid
String!
The on-call schedule internal ID to update.
name
String
The name of the on-call schedule.
projectPath
ID!
The project to update the on-call schedule in.
timezone
String
The timezone of the on-call schedule.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
oncallSchedule
IncidentManagementOncallSchedule
The on-call schedule.
Mutation.pipelineCancel
Input type: PipelineCancelInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
CiPipelineID!
The ID of the pipeline to mutate.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.pipelineDestroy
Input type: PipelineDestroyInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
CiPipelineID!
The ID of the pipeline to mutate.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.pipelineRetry
Input type: PipelineRetryInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
CiPipelineID!
The ID of the pipeline to mutate.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
pipeline
Pipeline
The pipeline after mutation.
Mutation.prometheusIntegrationCreate
Input type: PrometheusIntegrationCreateInput
Arguments
Name
Type
Description
active
Boolean!
Whether the integration is receiving alerts.
apiUrl
String!
Endpoint at which Prometheus can be queried.
clientMutationId
String
A unique identifier for the client performing the mutation.
projectPath
ID!
The project to create the integration in.
Fields
Mutation.prometheusIntegrationResetToken
Input type: PrometheusIntegrationResetTokenInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
PrometheusServiceID!
The ID of the integration to mutate.
Fields
Mutation.prometheusIntegrationUpdate
Input type: PrometheusIntegrationUpdateInput
Arguments
Name
Type
Description
active
Boolean
Whether the integration is receiving alerts.
apiUrl
String
Endpoint at which Prometheus can be queried.
clientMutationId
String
A unique identifier for the client performing the mutation.
id
PrometheusServiceID!
The ID of the integration to mutate.
Fields
Input type: PromoteToEpicInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
groupPath
ID
The group the promoted epic will belong to.
iid
String!
The IID of the issue to mutate.
projectPath
ID!
The project the issue to mutate is in.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epic
Epic
The epic after issue promotion.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.releaseAssetLinkCreate
Input type: ReleaseAssetLinkCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
directAssetPath
String
Relative path for a direct asset link.
linkType
ReleaseAssetLinkType
The type of the asset link.
name
String!
Name of the asset link.
projectPath
ID!
Full path of the project the asset link is associated with.
tagName
String!
Name of the associated release’s tag.
url
String!
URL of the asset link.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
link
ReleaseAssetLink
The asset link after mutation.
Mutation.releaseAssetLinkDelete
Input type: ReleaseAssetLinkDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
ReleasesLinkID!
ID of the release asset link to delete.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
link
ReleaseAssetLink
The deleted release asset link.
Mutation.releaseAssetLinkUpdate
Input type: ReleaseAssetLinkUpdateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
directAssetPath
String
Relative path for a direct asset link.
id
ReleasesLinkID!
ID of the release asset link to update.
linkType
ReleaseAssetLinkType
The type of the asset link.
name
String
Name of the asset link.
url
String
URL of the asset link.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
link
ReleaseAssetLink
The asset link after mutation.
Mutation.releaseCreate
Input type: ReleaseCreateInput
Arguments
Name
Type
Description
assets
ReleaseAssetsInput
Assets associated to the release.
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description (also known as “release notes”) of the release.
milestones
[String!]
The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
name
String
Name of the release.
projectPath
ID!
Full path of the project the release is associated with.
ref
String
The commit SHA or branch name to use if creating a new tag.
releasedAt
Time
The date when the release will be/was ready. Defaults to the current time.
tagName
String!
Name of the tag to associate with the release.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
release
Release
The release after mutation.
Mutation.releaseDelete
Input type: ReleaseDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
projectPath
ID!
Full path of the project the release is associated with.
tagName
String!
Name of the tag associated with the release to delete.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
release
Release
The deleted release.
Mutation.releaseUpdate
Input type: ReleaseUpdateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description (release notes) of the release.
milestones
[String!]
The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
name
String
Name of the release.
projectPath
ID!
Full path of the project the release is associated with.
releasedAt
Time
The release date.
tagName
String!
Name of the tag associated with the release.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
release
Release
The release after mutation.
Mutation.removeAwardEmoji
caution Deprecated in 13.2.
Use awardEmojiRemove.
Input type: RemoveAwardEmojiInput
Arguments
Name
Type
Description
awardableId
AwardableID!
The global ID of the awardable resource.
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
The emoji name.
Fields
Name
Type
Description
awardEmoji
AwardEmoji
The award emoji after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.removeProjectFromSecurityDashboard
Input type: RemoveProjectFromSecurityDashboardInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
ProjectID!
ID of the project to remove from the Instance Security Dashboard.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.repositionImageDiffNote
Repositions a DiffNote on an image (a Note
where the position.positionType
is "image"
).
Input type: RepositionImageDiffNoteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
DiffNoteID!
The global ID of the DiffNote to update.
position
UpdateDiffImagePositionInput!
The position of this note on a diff.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
note
Note
The note after mutation.
Mutation.revertVulnerabilityToDetected
caution Deprecated in 13.5.
Use vulnerabilityRevertToDetected.
Input type: RevertVulnerabilityToDetectedInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
VulnerabilityID!
ID of the vulnerability to be reverted.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
vulnerability
Vulnerability
The vulnerability after revert.
Mutation.runDastScan
caution Deprecated in 13.4.
Use DastOnDemandScanCreate.
Input type: RunDASTScanInput
Arguments
Name
Type
Description
branch
String!
The branch to be associated with the scan.
clientMutationId
String
A unique identifier for the client performing the mutation.
projectPath
ID!
The project the DAST scan belongs to.
scanType
DastScanTypeEnum!
The type of scan to be run.
targetUrl
String!
The URL of the target to be scanned.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
pipelineUrl
String
URL of the pipeline that was created.
Input type: TerraformStateDeleteInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
TerraformStateID!
Global ID of the Terraform state.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Input type: TerraformStateLockInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
TerraformStateID!
Global ID of the Terraform state.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Input type: TerraformStateUnlockInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
TerraformStateID!
Global ID of the Terraform state.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.todoCreate
Input type: TodoCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
targetId
TodoableID!
The global ID of the to-do item’s parent. Issues, merge requests, designs and epics are supported.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
todo
Todo
The to-do item created.
Mutation.todoMarkDone
Input type: TodoMarkDoneInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
TodoID!
The global ID of the to-do item to mark as done.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
todo
Todo!
The requested to-do item.
Mutation.todoRestore
Input type: TodoRestoreInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
TodoID!
The global ID of the to-do item to restore.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
todo
Todo!
The requested to-do item.
Mutation.todoRestoreMany
Input type: TodoRestoreManyInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
ids
[TodoID!]!
The global IDs of the to-do items to restore (a maximum of 50 is supported at once).
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
todos
[Todo!]!
Updated to-do items.
updatedIds
[TodoID!]!
Deprecated: Use to-do items. Deprecated in 13.2.
Mutation.todosMarkAllDone
Input type: TodosMarkAllDoneInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
todos
[Todo!]!
Updated to-do items.
updatedIds
[TodoID!]!
Deprecated: Use to-do items. Deprecated in 13.2.
Mutation.toggleAwardEmoji
caution Deprecated in 13.2.
Use awardEmojiToggle.
Input type: ToggleAwardEmojiInput
Arguments
Name
Type
Description
awardableId
AwardableID!
The global ID of the awardable resource.
clientMutationId
String
A unique identifier for the client performing the mutation.
name
String!
The emoji name.
Fields
Name
Type
Description
awardEmoji
AwardEmoji
The award emoji after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
toggledOn
Boolean!
Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.
Mutation.updateAlertStatus
Input type: UpdateAlertStatusInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
iid
String!
The IID of the alert to mutate.
projectPath
ID!
The project the alert to mutate is in.
status
AlertManagementStatus!
The status to set the alert.
Fields
Name
Type
Description
alert
AlertManagementAlert
The alert after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue created after mutation.
todo
Todo
The to-do item after mutation.
Mutation.updateBoard
Input type: UpdateBoardInput
Arguments
Name
Type
Description
assigneeId
UserID
ID of user to be assigned to the board.
clientMutationId
String
A unique identifier for the client performing the mutation.
hideBacklogList
Boolean
Whether or not backlog list is hidden.
hideClosedList
Boolean
Whether or not closed list is hidden.
id
BoardID!
The board global ID.
iterationId
IterationID
ID of iteration to be assigned to the board.
labelIds
[LabelID!]
IDs of labels to be added to the board.
labels
[String!]
Labels of the issue.
milestoneId
MilestoneID
ID of milestone to be assigned to the board.
name
String
The board name.
weight
Int
Weight value to be assigned to the board.
Fields
Name
Type
Description
board
Board
The board after mutation.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.updateBoardEpicUserPreferences
Input type: UpdateBoardEpicUserPreferencesInput
Arguments
Name
Type
Description
boardId
BoardID!
The board global ID.
clientMutationId
String
A unique identifier for the client performing the mutation.
collapsed
Boolean!
Whether the epic should be collapsed in the board.
epicId
EpicID!
ID of an epic to set preferences for.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epicUserPreferences
BoardEpicUserPreferences
User preferences for the epic in the board after mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.updateBoardList
Input type: UpdateBoardListInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
collapsed
Boolean
Indicates if the list is collapsed for this user.
listId
ListID!
Global ID of the list.
position
Int
Position of list within the board.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
list
BoardList
Mutated list.
Mutation.updateComplianceFramework
Input type: UpdateComplianceFrameworkInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
complianceFramework
ComplianceFramework
The compliance framework after mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.updateContainerExpirationPolicy
Input type: UpdateContainerExpirationPolicyInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
containerExpirationPolicy
ContainerExpirationPolicy
The container expiration policy after mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.updateEpic
Input type: UpdateEpicInput
Arguments
Name
Type
Description
addLabelIds
[ID!]
The IDs of labels to be added to the epic.
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean
Indicates if the epic is confidential.
description
String
The description of the epic.
dueDateFixed
String
The end date of the epic.
dueDateIsFixed
Boolean
Indicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath
ID!
The group the epic to mutate is in.
iid
ID!
The IID of the epic to mutate.
removeLabelIds
[ID!]
The IDs of labels to be removed from the epic.
startDateFixed
String
The start date of the epic.
startDateIsFixed
Boolean
Indicates start date should be sourced from start_date_fixed field not the issue milestones.
stateEvent
EpicStateEvent
State event for the epic.
title
String
The title of the epic.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
epic
Epic
The epic after mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.updateEpicBoardList
Input type: UpdateEpicBoardListInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
collapsed
Boolean
Indicates if the list is collapsed for this user.
listId
BoardsEpicListID!
Global ID of the epic list.
position
Int
Position of list within the board.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
list
EpicList
Mutated epic list.
Mutation.updateImageDiffNote
Updates a DiffNote on an image (a Note
where the position.positionType
is "image"
).
If the body of the Note contains only quick actions,
the Note will be destroyed during the update, and no Note will be
returned.
Input type: UpdateImageDiffNoteInput
Arguments
Name
Type
Description
body
String
Content of the note.
clientMutationId
String
A unique identifier for the client performing the mutation.
id
NoteID!
The global ID of the note to update.
position
UpdateDiffImagePositionInput
The position of this note on a diff.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
note
Note
The note after mutation.
Mutation.updateIssue
Input type: UpdateIssueInput
Arguments
Name
Type
Description
addLabelIds
[ID!]
The IDs of labels to be added to the issue.
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean
Indicates the issue is confidential.
description
String
Description of the issue.
dueDate
ISO8601Date
Due date of the issue.
epicId
EpicID
The ID of the parent epic. NULL when removing the association.
healthStatus
HealthStatus
The desired health status.
iid
String!
The IID of the issue to mutate.
locked
Boolean
Indicates discussion is locked on the issue.
milestoneId
ID
The ID of the milestone to assign to the issue. On update milestone will be removed if set to null.
projectPath
ID!
The project the issue to mutate is in.
removeLabelIds
[ID!]
The IDs of labels to be removed from the issue.
stateEvent
IssueStateEvent
Close or reopen an issue.
title
String
Title of the issue.
type
IssueType
Type of the issue.
weight
Int
The weight of the issue.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
issue
Issue
The issue after mutation.
Mutation.updateIteration
Input type: UpdateIterationInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the iteration.
dueDate
String
End date of the iteration.
groupPath
ID!
Group of the iteration.
id
ID!
Global ID of the iteration.
startDate
String
Start date of the iteration.
title
String
Title of the iteration.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
iteration
Iteration
Updated iteration.
Mutation.updateNamespacePackageSettings
Input type: UpdateNamespacePackageSettingsInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
genericDuplicateExceptionRegex
UntrustedRegexp
When generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
genericDuplicatesAllowed
Boolean
Indicates whether duplicate generic packages are allowed for this namespace.
mavenDuplicateExceptionRegex
UntrustedRegexp
When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
mavenDuplicatesAllowed
Boolean
Indicates whether duplicate Maven packages are allowed for this namespace.
namespacePath
ID!
The namespace path where the namespace package setting is located.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
packageSettings
PackageSettings
The namespace package setting after mutation.
Mutation.updateNote
Updates a Note.
If the body of the Note contains only quick actions,
the Note will be destroyed during the update, and no Note will be
returned.
Input type: UpdateNoteInput
Arguments
Name
Type
Description
body
String
Content of the note.
clientMutationId
String
A unique identifier for the client performing the mutation.
confidential
Boolean
The confidentiality flag of a note. Default is false.
id
NoteID!
The global ID of the note to update.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
note
Note
The note after mutation.
Mutation.updateRequirement
Input type: UpdateRequirementInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the requirement.
iid
String!
The IID of the requirement to update.
lastTestReportState
TestReportState
Creates a test report for the requirement with the given state.
projectPath
ID!
Full project path the requirement is associated with.
state
RequirementState
State of the requirement.
title
String
Title of the requirement.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
requirement
Requirement
Requirement after mutation.
Mutation.updateSnippet
Input type: UpdateSnippetInput
Arguments
Name
Type
Description
blobActions
[SnippetBlobActionInputType!]
Actions to perform over the snippet repository and blobs.
captchaResponse
String
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
clientMutationId
String
A unique identifier for the client performing the mutation.
description
String
Description of the snippet.
id
SnippetID!
The global ID of the snippet to update.
spamLogId
Int
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
title
String
Title of the snippet.
visibilityLevel
VisibilityLevelsEnum
The visibility level of the snippet.
Fields
Name
Type
Description
captchaSiteKey
String
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
needsCaptchaResponse
Boolean
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
snippet
Snippet
The snippet after mutation.
spam
Boolean
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
spamLogId
Int
Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11.
Mutation.userCalloutCreate
Input type: UserCalloutCreateInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
featureName
String!
The feature name you want to dismiss the callout for.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
userCallout
UserCallout!
The user callout dismissed.
Mutation.vulnerabilityConfirm
Input type: VulnerabilityConfirmInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
VulnerabilityID!
ID of the vulnerability to be confirmed.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
vulnerability
Vulnerability
The vulnerability after state change.
Mutation.vulnerabilityDismiss
Input type: VulnerabilityDismissInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
comment
String
Comment why vulnerability should be dismissed.
dismissalReason
VulnerabilityDismissalReason
Reason why vulnerability should be dismissed.
id
VulnerabilityID!
ID of the vulnerability to be dismissed.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
vulnerability
Vulnerability
The vulnerability after dismissal.
Mutation.vulnerabilityExternalIssueLinkCreate
Input type: VulnerabilityExternalIssueLinkCreateInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
externalIssueLink
VulnerabilityExternalIssueLink
The created external issue link.
Mutation.vulnerabilityExternalIssueLinkDestroy
Input type: VulnerabilityExternalIssueLinkDestroyInput
Arguments
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
Mutation.vulnerabilityResolve
Input type: VulnerabilityResolveInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
VulnerabilityID!
ID of the vulnerability to be resolved.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
vulnerability
Vulnerability
The vulnerability after state change.
Mutation.vulnerabilityRevertToDetected
Input type: VulnerabilityRevertToDetectedInput
Arguments
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
id
VulnerabilityID!
ID of the vulnerability to be reverted.
Fields
Name
Type
Description
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
Errors encountered during execution of the mutation.
vulnerability
Vulnerability
The vulnerability after revert.
Connections
Some types in our schema are Connection
types - they represent a paginated
collection of edges between two nodes in the graph. These follow the
Relay cursor connections specification .
All connection fields support the following pagination arguments:
Name
Type
Description
after
String
Returns the elements in the list that come after the specified cursor.
before
String
Returns the elements in the list that come before the specified cursor.
first
Int
Returns the first n elements from the list.
last
Int
Returns the last n elements from the list.
Since these arguments are common to all connection fields, they are not repeated for each connection.
Connection fields
All connections have at least the following fields:
Name
Type
Description
pageInfo
PageInfo!
Pagination information.
edges
[edge!]
The edges.
nodes
[item!]
The items in the current page.
The precise type of Edge
and Item
depends on the kind of connection. A
ProjectConnection
will have nodes that have the type
[Project!]
, and edges that have the type ProjectEdge
.
Connection types
Some of the types in the schema exist solely to model connections. Each connection
has a distinct, named type, with a distinct named edge type. These are listed separately
below.
AlertManagementAlertConnection
The connection type for AlertManagementAlert
.
Fields
AlertManagementAlertEdge
The edge type for AlertManagementAlert
.
Fields
AlertManagementHttpIntegrationConnection
The connection type for AlertManagementHttpIntegration
.
Fields
AlertManagementHttpIntegrationEdge
The edge type for AlertManagementHttpIntegration
.
Fields
AlertManagementIntegrationConnection
The connection type for AlertManagementIntegration
.
Fields
AlertManagementIntegrationEdge
The edge type for AlertManagementIntegration
.
Fields
AwardEmojiConnection
The connection type for AwardEmoji
.
Fields
AwardEmojiEdge
The edge type for AwardEmoji
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
AwardEmoji
The item at the end of the edge.
BlobConnection
The connection type for Blob
.
Fields
Name
Type
Description
edges
[BlobEdge]
A list of edges.
nodes
[Blob]
A list of nodes.
pageInfo
PageInfo!
Information to aid in pagination.
BlobEdge
The edge type for Blob
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
Blob
The item at the end of the edge.
BoardConnection
The connection type for Board
.
Fields
Name
Type
Description
edges
[BoardEdge]
A list of edges.
nodes
[Board]
A list of nodes.
pageInfo
PageInfo!
Information to aid in pagination.
BoardEdge
The edge type for Board
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
Board
The item at the end of the edge.
BoardEpicConnection
The connection type for BoardEpic
.
Fields
BoardEpicEdge
The edge type for BoardEpic
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
BoardEpic
The item at the end of the edge.
BoardListConnection
The connection type for BoardList
.
Fields
BoardListEdge
The edge type for BoardList
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
BoardList
The item at the end of the edge.
CiBuildNeedConnection
The connection type for CiBuildNeed
.
Fields
CiBuildNeedEdge
The edge type for CiBuildNeed
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiBuildNeed
The item at the end of the edge.
CiConfigGroupConnection
The connection type for CiConfigGroup
.
Fields
CiConfigGroupEdge
The edge type for CiConfigGroup
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiConfigGroup
The item at the end of the edge.
CiConfigJobConnection
The connection type for CiConfigJob
.
Fields
CiConfigJobEdge
The edge type for CiConfigJob
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiConfigJob
The item at the end of the edge.
CiConfigNeedConnection
The connection type for CiConfigNeed
.
Fields
CiConfigNeedEdge
The edge type for CiConfigNeed
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiConfigNeed
The item at the end of the edge.
CiConfigStageConnection
The connection type for CiConfigStage
.
Fields
CiConfigStageEdge
The edge type for CiConfigStage
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiConfigStage
The item at the end of the edge.
CiGroupConnection
The connection type for CiGroup
.
Fields
CiGroupEdge
The edge type for CiGroup
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiGroup
The item at the end of the edge.
CiJobArtifactConnection
The connection type for CiJobArtifact
.
Fields
CiJobArtifactEdge
The edge type for CiJobArtifact
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiJobArtifact
The item at the end of the edge.
CiJobConnection
The connection type for CiJob
.
Fields
Name
Type
Description
count
Int!
Total count of collection.
edges
[CiJobEdge]
A list of edges.
nodes
[CiJob]
A list of nodes.
pageInfo
PageInfo!
Information to aid in pagination.
CiJobEdge
The edge type for CiJob
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiJob
The item at the end of the edge.
CiRunnerConnection
The connection type for CiRunner
.
Fields
CiRunnerEdge
The edge type for CiRunner
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiRunner
The item at the end of the edge.
CiStageConnection
The connection type for CiStage
.
Fields
CiStageEdge
The edge type for CiStage
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CiStage
The item at the end of the edge.
ClusterAgentConnection
The connection type for ClusterAgent
.
Fields
ClusterAgentEdge
The edge type for ClusterAgent
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
ClusterAgent
The item at the end of the edge.
ClusterAgentTokenConnection
The connection type for ClusterAgentToken
.
Fields
ClusterAgentTokenEdge
The edge type for ClusterAgentToken
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
ClusterAgentToken
The item at the end of the edge.
CodeCoverageActivityConnection
The connection type for CodeCoverageActivity
.
Fields
CodeCoverageActivityEdge
The edge type for CodeCoverageActivity
.
Fields
CodeQualityDegradationConnection
The connection type for CodeQualityDegradation
.
Fields
CodeQualityDegradationEdge
The edge type for CodeQualityDegradation
.
Fields
CommitConnection
The connection type for Commit
.
Fields
CommitEdge
The edge type for Commit
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
Commit
The item at the end of the edge.
ComplianceFrameworkConnection
The connection type for ComplianceFramework
.
Fields
ComplianceFrameworkEdge
The edge type for ComplianceFramework
.
Fields
ContainerRepositoryConnection
The connection type for ContainerRepository
.
Fields
ContainerRepositoryEdge
The edge type for ContainerRepository
.
Fields
ContainerRepositoryTagConnection
The connection type for ContainerRepositoryTag
.
Fields
ContainerRepositoryTagEdge
The edge type for ContainerRepositoryTag
.
Fields
CustomEmojiConnection
The connection type for CustomEmoji
.
Fields
CustomEmojiEdge
The edge type for CustomEmoji
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
CustomEmoji
The item at the end of the edge.
DastProfileConnection
The connection type for DastProfile
.
Fields
DastProfileEdge
The edge type for DastProfile
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
DastProfile
The item at the end of the edge.
DastScannerProfileConnection
The connection type for DastScannerProfile
.
Fields
DastScannerProfileEdge
The edge type for DastScannerProfile
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
DastScannerProfile
The item at the end of the edge.
DastSiteProfileConnection
The connection type for DastSiteProfile
.
Fields
DastSiteProfileEdge
The edge type for DastSiteProfile
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
DastSiteProfile
The item at the end of the edge.
DastSiteValidationConnection
The connection type for DastSiteValidation
.
Fields
DastSiteValidationEdge
The edge type for DastSiteValidation
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
DastSiteValidation
The item at the end of the edge.
DesignAtVersionConnection
The connection type for DesignAtVersion
.
Fields
DesignAtVersionEdge
The edge type for DesignAtVersion
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
DesignAtVersion
The item at the end of the edge.
DesignConnection
The connection type for Design
.
Fields
DesignEdge
The edge type for Design
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
Design
The item at the end of the edge.
DesignVersionConnection
The connection type for DesignVersion
.
Fields
DesignVersionEdge
The edge type for DesignVersion
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
DesignVersion
The item at the end of the edge.
DevopsAdoptionSegmentConnection
The connection type for DevopsAdoptionSegment
.
Fields
DevopsAdoptionSegmentEdge
The edge type for DevopsAdoptionSegment
.
Fields
DiscussionConnection
The connection type for Discussion
.
Fields
DiscussionEdge
The edge type for Discussion
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
Discussion
The item at the end of the edge.
EnvironmentConnection
The connection type for Environment
.
Fields
EnvironmentEdge
The edge type for Environment
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
Environment
The item at the end of the edge.
EpicBoardConnection
The connection type for EpicBoard
.
Fields
EpicBoardEdge
The edge type for EpicBoard
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
EpicBoard
The item at the end of the edge.
EpicConnection
The connection type for Epic
.
Fields
Name
Type
Description
edges
[EpicEdge]
A list of edges.
nodes
[Epic]
A list of nodes.
pageInfo
PageInfo!
Information to aid in pagination.
EpicEdge
The edge type for Epic
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
Epic
The item at the end of the edge.
EpicIssueConnection
The connection type for EpicIssue
.
Fields
Name
Type
Description
count
Int!
Total count of collection.
edges
[EpicIssueEdge]
A list of edges.
nodes
[EpicIssue]
A list of nodes.
pageInfo
PageInfo!
Information to aid in pagination.
weight
Int!
Total weight of issues collection.
EpicIssueEdge
The edge type for EpicIssue
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
EpicIssue
The item at the end of the edge.
EpicListConnection
The connection type for EpicList
.
Fields
EpicListEdge
The edge type for EpicList
.
Fields
Name
Type
Description
cursor
String!
A cursor for use in pagination.
node
EpicList
The item at the end of the edge.
EventConnection
The connection type for Event
.
Fields
Name
Type
Description
edges
[EventEdge]
A list of edges.
nodes
[Event]
A list of nodes.
pageInfo
PageInfo!
Information to aid in pagination.