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.boardList

Find an issue board list.

Returns BoardList.

Arguments

NameTypeDescription
id ListID!Global ID of the list.
issueFilters BoardIssueInputFilters applied when getting issue metadata in the board list.

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

NameTypeDescription
content String!Contents of .gitlab-ci.yml.
dryRun BooleanRun pipeline creation simulation, or only do static check.
projectPath ID!Project of the CI config.
sha StringSha for the pipeline.

Query.ciMinutesUsage

CI/CD minutes usage data for a namespace.

Returns CiMinutesNamespaceMonthlyUsageConnection.

This field returns a connection. It accepts the four standard pagination arguments: before: String, after: String, first: Int, last: Int.

Arguments

NameTypeDescription
namespaceId NamespaceIDGlobal ID of the Namespace for the monthly CI/CD minutes usage.

Query.ciVariables

List of the instance’s CI/CD variables.

Returns CiInstanceVariableConnection.

This field returns a connection. It accepts the four standard pagination arguments: before: String, after: String, first: Int, last: Int.

Query.containerRepository

Find a container repository.

Returns ContainerRepositoryDetails.

Arguments

NameTypeDescription
id ContainerRepositoryID!Global ID of the container repository.

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.devopsAdoptionEnabledNamespaces

Get configured DevOps adoption namespaces. BETA This endpoint is subject to change without notice.

Returns DevopsAdoptionEnabledNamespaceConnection.

This field returns a connection. It accepts the four standard pagination arguments: before: String, after: String, first: Int, last: Int.

Arguments

NameTypeDescription
displayNamespaceId NamespaceIDFilter by display namespace.

Query.echo

Testing endpoint to validate the API with.

Returns String!.

Arguments

NameTypeDescription
text String!Text to echo back.

Query.epicBoardList

Returns EpicList.

Arguments

NameTypeDescription
epicFilters EpicFiltersFilters applied when getting epic metadata in the epic board list.
id BoardsEpicListID!Global ID of the list.

Query.geoNode

Find a Geo node.

Returns GeoNode.

Arguments

NameTypeDescription
name StringName of the Geo node. Defaults to the current Geo node name.

Query.gitpodEnabled

Whether Gitpod is enabled in application settings.

Returns Boolean.

Query.group

Find a group.

Returns Group.

Arguments

NameTypeDescription
fullPath ID!Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss.

Query.instanceSecurityDashboard

Fields related to Instance Security Dashboard.

Returns InstanceSecurityDashboard.

Query.issue

Find an issue.

Returns Issue.

Arguments

NameTypeDescription
id IssueID!Global ID of the issue.

Query.iteration

Find an iteration.

Returns Iteration.

Arguments

NameTypeDescription
id IterationID!Find an iteration by its ID.

Query.jobs

All jobs on this GitLab instance.

Returns CiJobConnection.

This field returns a connection. It accepts the four standard pagination arguments: before: String, after: String, first: Int, last: Int.

Arguments

NameTypeDescription
statuses [CiJobStatus!]Filter jobs by status.

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

NameTypeDescription
id MergeRequestID!Global ID of the merge request.

Query.metadata

Metadata about GitLab.

Returns Metadata.

Query.milestone

Find a milestone.

Returns Milestone.

Arguments

NameTypeDescription
id MilestoneID!Find a milestone by its ID.

Query.namespace

Find a namespace.

Returns Namespace.

Arguments

NameTypeDescription
fullPath ID!Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss.

Query.package

Find a package. This field can only be resolved for one query in any single request.

Returns PackageDetailsType.

Arguments

NameTypeDescription
id PackagesPackageID!Global ID of the package.

Query.project

Find a project.

Returns Project.

Arguments

NameTypeDescription
fullPath ID!Full path of the project, group, or namespace. For example, 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

NameTypeDescription
ids [ID!]Filter projects by IDs.
membership BooleanReturn only projects that the current user is a member of.
search StringSearch query, which can be for the project name, a path, or a description.
searchNamespaces BooleanInclude namespace in project search.
sort StringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics [String!]Filter projects by topics.

Query.queryComplexity

Information about the complexity of the GraphQL query.

Returns QueryComplexity.

Query.runner

Find a runner.

Returns CiRunner.

Arguments

NameTypeDescription
id CiRunnerID!Runner ID.

Query.runnerPlatforms

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

NameTypeDescription
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.

Returns CiRunnerConnection.

This field returns a connection. It accepts the four standard pagination arguments: before: String, after: String, first: Int, last: Int.

Arguments

NameTypeDescription
active Boolean Deprecated in 14.8. This was renamed. Use: paused.
paused BooleanFilter runners by paused (true) or active (false) status.
search StringFilter by full token or partial text in description field.
sort CiRunnerSortSort order of results.
status CiRunnerStatusFilter runners by status.
tagList [String!]Filter by tags associated with the runner (comma-separated or array).
type CiRunnerTypeFilter runners by type.
upgradeStatus CiRunnerUpgradeStatusFilter by upgrade status.

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

NameTypeDescription
authorId UserIDID of an author.
explore BooleanExplore personal snippets.
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
projectId ProjectIDID of a project.
type TypeEnumType of snippet.
visibility VisibilityScopesEnumVisibility of the snippet.

Query.subscriptionFutureEntries

Fields related to entries in future subscriptions.

Returns SubscriptionFutureEntryConnection.

This field returns a connection. It accepts the four standard pagination arguments: before: String, after: String, first: Int, last: Int.

Query.timelogs

Find timelogs visible to the current user.

Returns TimelogConnection.

This field returns a connection. It accepts the four standard pagination arguments: before: String, after: String, first: Int, last: Int.

Arguments

NameTypeDescription
endDate TimeList timelogs within a date range where the logged date is equal to or before endDate.
endTime TimeList timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupIDList timelogs for a group.
projectId ProjectIDList timelogs for a project.
startDate TimeList timelogs within a date range where the logged date is equal to or after startDate.
startTime TimeList timelogs within a time range where the logged time is equal to or after startTime.
username StringList timelogs for a user.

Query.todo

Retrieve a single to-do item.

Returns Todo.

Arguments

NameTypeDescription
id TodoID!ID of the to-do item.

Query.topics

Find project topics.

Returns TopicConnection.

This field returns a connection. It accepts the four standard pagination arguments: before: String, after: String, first: Int, last: Int.

Arguments

NameTypeDescription
search StringSearch query for topic name.

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

NameTypeDescription
identifier MeasurementIdentifier!Type of measurement or statistics to retrieve.
recordedAfter TimeMeasurement recorded after this date.
recordedBefore TimeMeasurement recorded before this date.

Query.user

Find a user.

Returns UserCore.

Arguments

NameTypeDescription
id UserIDID of the User.
username StringUsername 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

NameTypeDescription
admins BooleanReturn only admin users.
ids [ID!]List of user Global IDs.
search StringQuery to search users by name, username, or primary email.
sort SortSort 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

NameTypeDescription
clusterAgentId [ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId [ClustersClusterID!]Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
hasIssues BooleanReturns only the vulnerabilities which have linked issues.
hasResolution BooleanReturns only the vulnerabilities which have been resolved on default branch.
image [String!]Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning, cluster_image_scanning.
projectId [ID!]Filter vulnerabilities by project.
reportType [VulnerabilityReportType!]Filter vulnerabilities by report type.
scanner [String!]Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId [VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity [VulnerabilitySeverity!]Filter vulnerabilities by severity.
sort VulnerabilitySortList vulnerabilities by sort order.
state [VulnerabilityState!]Filter vulnerabilities by state.

Query.vulnerabilitiesCountByDay

The historical 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

NameTypeDescription
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

NameTypeDescription
id VulnerabilityID!Global ID of the Vulnerability.

Query.workItem

Find a work item. Returns null if work_items feature flag is disabled.

caution
Introduced in 15.1. This feature is in Alpha. It can be changed or removed at any time.

Returns WorkItem.

Arguments

NameTypeDescription
id WorkItemID!Global ID of the work item.

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.addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ProjectID!ID of the project to be added to Instance Security Dashboard.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
project ProjectProject that was added to the Instance Security Dashboard.

Mutation.adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

Arguments

NameTypeDescription
artifactSize StringDelete jobs matching artifact_size in the context metadata.
artifactUsedCdn StringDelete jobs matching artifact_used_cdn in the context metadata.
artifactsDependenciesCount StringDelete jobs matching artifacts_dependencies_count in the context metadata.
artifactsDependenciesSize StringDelete jobs matching artifacts_dependencies_size in the context metadata.
callerId StringDelete jobs matching caller_id in the context metadata.
clientId StringDelete jobs matching client_id in the context metadata.
clientMutationId StringA unique identifier for the client performing the mutation.
featureCategory StringDelete jobs matching feature_category in the context metadata.
jobId StringDelete jobs matching job_id in the context metadata.
pipelineId StringDelete jobs matching pipeline_id in the context metadata.
project StringDelete jobs matching project in the context metadata.
queueName String!Name of the queue to delete jobs from.
relatedClass StringDelete jobs matching related_class in the context metadata.
remoteIp StringDelete jobs matching remote_ip in the context metadata.
rootCallerId StringDelete jobs matching root_caller_id in the context metadata.
rootNamespace StringDelete jobs matching root_namespace in the context metadata.
subscriptionPlan StringDelete jobs matching subscription_plan in the context metadata.
user StringDelete jobs matching user in the context metadata.
workerClass StringDelete jobs with the given worker class.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
result DeleteJobsResponseInformation about the status of the deletion request.

Mutation.alertSetAssignees

Input type: AlertSetAssigneesInput

Arguments

NameTypeDescription
assigneeUsernames [String!]!Usernames to assign to the alert. Replaces existing assignees by default.
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the alert to mutate.
operationMode MutationOperationModeOperation to perform. Defaults to REPLACE.
projectPath ID!Project the alert to mutate is in.

Fields

NameTypeDescription
alert AlertManagementAlertAlert after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue created after mutation.
todo TodoTo-do item after mutation.

Mutation.alertTodoCreate

Input type: AlertTodoCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the alert to mutate.
projectPath ID!Project the alert to mutate is in.

Fields

NameTypeDescription
alert AlertManagementAlertAlert after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue created after mutation.
todo TodoTo-do item after mutation.

Mutation.apiFuzzingCiConfigurationCreate

caution
Deprecated in 15.1. The configuration snippet is now generated client-side.

Input type: ApiFuzzingCiConfigurationCreateInput

Arguments

NameTypeDescription
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 StringCI variable containing the password for authenticating with the target API.
authUsername StringCI variable containing the username for authenticating with the target API.
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.
scanMode ApiFuzzingScanMode!Mode for API fuzzing scans.
scanProfile StringName of a default profile to use for scanning. Ex: Quick-10.
target String!URL for the target of API fuzzing scans.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
configurationYaml String Deprecated: The configuration snippet is now generated client-side. Deprecated in 14.6.
errors [String!]!Errors encountered during execution of the mutation.
gitlabCiYamlEditPath String Deprecated: The configuration snippet is now generated client-side. Deprecated in 14.6.

Mutation.artifactDestroy

Input type: ArtifactDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiJobArtifactID!ID of the artifact to delete.

Fields

NameTypeDescription
artifact CiJobArtifactDeleted artifact.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingHeadersCreate

Input type: AuditEventsStreamingHeadersCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID!Destination to associate header with.
key String!Header key.
value String!Header value.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
header AuditEventStreamingHeaderCreated header.

Mutation.auditEventsStreamingHeadersDestroy

Input type: AuditEventsStreamingHeadersDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
headerId AuditEventsStreamingHeaderID!Header to delete.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingHeadersUpdate

Input type: AuditEventsStreamingHeadersUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
headerId AuditEventsStreamingHeaderID!Header to update.
key String!Header key.
value String!Header value.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
header AuditEventStreamingHeaderUpdates header.

Mutation.awardEmojiAdd

Input type: AwardEmojiAddInput

Arguments

NameTypeDescription
awardableId AwardableID!Global ID of the awardable resource.
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Emoji name.

Fields

NameTypeDescription
awardEmoji AwardEmojiAward emoji after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.awardEmojiRemove

Input type: AwardEmojiRemoveInput

Arguments

NameTypeDescription
awardableId AwardableID!Global ID of the awardable resource.
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Emoji name.

Fields

NameTypeDescription
awardEmoji AwardEmojiAward emoji after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.awardEmojiToggle

Input type: AwardEmojiToggleInput

Arguments

NameTypeDescription
awardableId AwardableID!Global ID of the awardable resource.
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Emoji name.

Fields

NameTypeDescription
awardEmoji AwardEmojiAward emoji after mutation.
clientMutationId StringA 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.boardEpicCreate

Input type: BoardEpicCreateInput

Arguments

NameTypeDescription
boardId BoardsEpicBoardID!Global ID of the board that the epic is in.
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath ID!Group the epic to create is in.
listId BoardsEpicListID!Global ID of the epic board list in which epic will be created.
title String!Title of the epic.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epic EpicEpic after creation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.boardListCreate

Input type: BoardListCreateInput

Arguments

NameTypeDescription
assigneeId UserIDGlobal ID of an existing user.
backlog BooleanCreate the backlog list.
boardId BoardID!Global ID of the issue board to mutate.
clientMutationId StringA unique identifier for the client performing the mutation.
iterationId IterationIDGlobal ID of an existing iteration.
labelId LabelIDGlobal ID of an existing label.
milestoneId MilestoneIDGlobal ID of an existing milestone.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
list BoardListIssue list in the issue board.

Mutation.boardListUpdateLimitMetrics

Input type: BoardListUpdateLimitMetricsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
limitMetric ListLimitMetricNew limit metric type for the list.
listId ListID!Global ID of the list.
maxIssueCount IntNew maximum issue count limit.
maxIssueWeight IntNew maximum issue weight limit.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
list BoardListUpdated list.

Mutation.bulkEnableDevopsAdoptionNamespaces

BETA This endpoint is subject to change without notice.

Input type: BulkEnableDevopsAdoptionNamespacesInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
displayNamespaceId NamespaceIDDisplay namespace ID.
namespaceIds [NamespaceID!]!List of Namespace IDs.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
enabledNamespaces [DevopsAdoptionEnabledNamespace!]Enabled namespaces after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.bulkRunnerDelete

caution
Introduced in 15.3. This feature is in Alpha. It can be changed or removed at any time.

Input type: BulkRunnerDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
ids [CiRunnerID!]IDs of the runners to delete.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
deletedCount IntNumber of records effectively deleted. Only present if operation was performed synchronously.
deletedIds [CiRunnerID!]IDs of records effectively deleted. Only present if operation was performed synchronously.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.ciCdSettingsUpdate

caution
Deprecated in 15.0. This was renamed. Use: ProjectCiCdSettingsUpdate.

Input type: CiCdSettingsUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Full Path of the project the settings belong to.
jobTokenScopeEnabled BooleanIndicates CI job tokens generated in this project have restricted access to resources.
keepLatestArtifact BooleanIndicates if the latest artifact should be kept for this project.
mergePipelinesEnabled BooleanIndicates if merge pipelines are enabled for the project.
mergeTrainsEnabled BooleanIndicates if merge trains are enabled for the project.

Fields

NameTypeDescription
ciCdSettings ProjectCiCdSetting!CI/CD settings after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeAddProject

Input type: CiJobTokenScopeAddProjectInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Project that the CI job token scope belongs to.
targetProjectPath ID!Project to be added to the CI job token scope.

Fields

NameTypeDescription
ciJobTokenScope CiJobTokenScopeTypeCI job token’s scope of access.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeRemoveProject

Input type: CiJobTokenScopeRemoveProjectInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Project that the CI job token scope belongs to.
targetProjectPath ID!Project to be removed from the CI job token scope.

Fields

NameTypeDescription
ciJobTokenScope CiJobTokenScopeTypeCI job token’s scope of access.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.clusterAgentDelete

Input type: ClusterAgentDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ClustersAgentID!Global ID of the cluster agent that will be deleted.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.clusterAgentTokenCreate

Input type: ClusterAgentTokenCreateInput

Arguments

NameTypeDescription
clientMutationId StringA 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 StringDescription of the token.
name String!Name of the token.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
secret StringToken secret value. Make sure you save it - you won’t be able to access it again.
token ClusterAgentTokenToken created after mutation.

Mutation.clusterAgentTokenRevoke

Input type: ClusterAgentTokenRevokeInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ClustersAgentTokenID!Global ID of the agent token that will be revoked.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.commitCreate

Input type: CommitCreateInput

Arguments

NameTypeDescription
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 StringA unique identifier for the client performing the mutation.
message String!Raw commit message.
projectPath ID!Project full path the branch is associated with.
startBranch StringIf on a new branch, name of the original branch.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
commit CommitCommit after mutation.
commitPipelinePath StringETag path for the commit’s pipeline.
content [String!]Contents of the commit.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.configureContainerScanning

Configure Container Scanning for a project by enabling Container Scanning 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 part of the response.

Input type: ConfigureContainerScanningInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

Mutation.configureDependencyScanning

Configure Dependency Scanning for a project by enabling Dependency Scanning 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: ConfigureDependencyScanningInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

Mutation.configureSast

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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
configuration SastCiConfigurationInput!SAST CI configuration for the project.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

Mutation.configureSastIac

Enable SAST IaC for a project 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: ConfigureSastIacInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

Mutation.configureSecretDetection

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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

Mutation.corpusCreate

Input type: CorpusCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Project the corpus belongs to.
packageId PackagesPackageID!ID of the corpus package.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.createAlertIssue

Input type: CreateAlertIssueInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the alert to mutate.
projectPath ID!Project the alert to mutate is in.

Fields

NameTypeDescription
alert AlertManagementAlertAlert after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue created after mutation.
todo TodoTo-do item after mutation.

Mutation.createAnnotation

Input type: CreateAnnotationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
clusterId ClustersClusterIDGlobal ID of the cluster to add an annotation to.
dashboardPath String!Path to a file defining the dashboard on which the annotation should be added.
description String!Description of the annotation.
endingAt TimeTimestamp indicating ending moment to which the annotation relates.
environmentId EnvironmentIDGlobal ID of the environment to add an annotation to.
startingAt Time!Timestamp indicating starting moment to which the annotation relates.

Fields

NameTypeDescription
annotation MetricsDashboardAnnotationCreated annotation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.createBoard

Input type: CreateBoardInput

Arguments

NameTypeDescription
assigneeId UserIDID of user to be assigned to the board.
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath IDFull path of the group with which the resource is associated.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
iterationCadenceId IterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationId IterationIDID 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 MilestoneIDID of milestone to be assigned to the board.
name StringBoard name.
projectPath IDFull path of the project with which the resource is associated.
weight IntWeight value to be assigned to the board.

Fields

NameTypeDescription
board BoardBoard after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.createBranch

Input type: CreateBranchInput

Arguments

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
branch BranchBranch after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.createClusterAgent

Input type: CreateClusterAgentInput

Arguments

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
clusterAgent ClusterAgentCluster agent created after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.createComplianceFramework

Input type: CreateComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
framework ComplianceFrameworkCreated compliance framework.

Mutation.createCustomEmoji

caution
Introduced in 13.6. This feature is in Alpha. It can be changed or removed at any time.

Input type: CreateCustomEmojiInput

Arguments

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
customEmoji CustomEmojiNew custom emoji.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.createDiffNote

Input type: CreateDiffNoteInput

Arguments

NameTypeDescription
body String!Content of the note.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
internal BooleanInternal flag for a note. Default is false.
noteableId NoteableID!Global ID of the resource to add a note to.
position DiffPositionInput!Position of this note on a diff.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
note NoteNote after mutation.

Mutation.createEpic

Input type: CreateEpicInput

Arguments

NameTypeDescription
addLabelIds [ID!]IDs of labels to be added to the epic.
addLabels [String!]Array of labels to be added to the epic.
clientMutationId StringA unique identifier for the client performing the mutation.
color ColorColor of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
confidential BooleanIndicates if the epic is confidential.
description StringDescription of the epic.
dueDateFixed StringEnd date of the epic.
dueDateIsFixed BooleanIndicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath ID!Group the epic to mutate is in.
removeLabelIds [ID!]IDs of labels to be removed from the epic.
startDateFixed StringStart date of the epic.
startDateIsFixed BooleanIndicates start date should be sourced from start_date_fixed field not the issue milestones.
title StringTitle of the epic.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epic EpicCreated epic.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.createImageDiffNote

Input type: CreateImageDiffNoteInput

Arguments

NameTypeDescription
body String!Content of the note.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
internal BooleanInternal flag for a note. Default is false.
noteableId NoteableID!Global ID of the resource to add a note to.
position DiffImagePositionInput!Position of this note on a diff.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
note NoteNote after mutation.

Mutation.createIssue

Input type: CreateIssueInput

Arguments

NameTypeDescription
assigneeIds [UserID!]Array of user IDs to assign to the issue.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential BooleanIndicates the issue is confidential.
createdAt TimeTimestamp when the issue was created. Available only for admins and project owners.
description StringDescription of the issue.
discussionToResolve StringID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of.
dueDate ISO8601DateDue date of the issue.
epicId EpicIDID of an epic to associate the issue with.
healthStatus HealthStatusDesired health status.
iid IntIID (internal ID) of a project issue. Only admins and project owners can modify.
iterationCadenceId IterationsCadenceIDGlobal iteration cadence ID. Required when iterationWildcardId is provided.
iterationId IterationIDGlobal iteration ID. Mutually exlusive argument with iterationWildcardId.
iterationWildcardId IssueCreationIterationWildcardIdIteration wildcard ID. Supported values are: CURRENT. Mutually exclusive argument with iterationId. iterationCadenceId also required when this argument is provided.
labelIds [LabelID!]IDs of labels to be added to the issue.
labels [String!]Labels of the issue.
locked BooleanIndicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOf MergeRequestIDIID of a merge request for which to resolve discussions.
milestoneId MilestoneIDID of the milestone to assign to the issue. On update milestone will be removed if set to null.
moveAfterId IssueIDGlobal ID of issue that should be placed after the current issue.
moveBeforeId IssueIDGlobal ID of issue that should be placed before the current issue.
projectPath ID!Project full path the issue is associated with.
title String!Title of the issue.
type IssueTypeType of the issue.
weight IntWeight of the issue.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.createIteration

caution
Deprecated in 14.0. Use iterationCreate.

Input type: CreateIterationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration.
dueDate StringEnd date of the iteration.
groupPath IDFull path of the group with which the resource is associated.
iterationsCadenceId IterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPath IDFull path of the project with which the resource is associated.
startDate StringStart date of the iteration.
title StringTitle of the iteration.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
iteration IterationCreated iteration.

Mutation.createNote

Creates a Note. If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.

Input type: CreateNoteInput

Arguments

NameTypeDescription
body String!Content of the note.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
discussionId DiscussionIDGlobal ID of the discussion this note is in reply to.
internal BooleanInternal flag for a note. Default is false.
mergeRequestDiffHeadSha StringSHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent.
noteableId NoteableID!Global ID of the resource to add a note to.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
note NoteNote after mutation.

Mutation.createRequirement

Input type: CreateRequirementInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the requirement.
projectPath ID!Full project path the requirement is associated with.
title StringTitle of the requirement.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
requirement RequirementRequirement after mutation.

Mutation.createSnippet

Input type: CreateSnippetInput

Arguments

NameTypeDescription
blobActions [SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the snippet.
projectPath IDFull path of the project the snippet is associated with.
title String!Title of the snippet.
uploadedFiles [String!]Paths to files uploaded in the snippet description.
visibilityLevel VisibilityLevelsEnum!Visibility level of the snippet.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
snippet SnippetSnippet after mutation.

Mutation.createTestCase

Input type: CreateTestCaseInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringTest case description.
labelIds [ID!]IDs of labels to be added to the test case.
projectPath ID!Project full path to create the test case in.
title String!Test case title.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
testCase IssueTest case created.

Mutation.customerRelationsContactCreate

Input type: CustomerRelationsContactCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of or notes for the contact.
email StringEmail address of the contact.
firstName String!First name of the contact.
groupId GroupID!Group for the contact.
lastName String!Last name of the contact.
organizationId CustomerRelationsOrganizationIDOrganization for the contact.
phone StringPhone number of the contact.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
contact CustomerRelationsContactContact after the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.customerRelationsContactUpdate

Input type: CustomerRelationsContactUpdateInput

Arguments

NameTypeDescription
active BooleanState of the contact.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of or notes for the contact.
email StringEmail address of the contact.
firstName StringFirst name of the contact.
id CustomerRelationsContactID!Global ID of the contact.
lastName StringLast name of the contact.
organizationId CustomerRelationsOrganizationIDOrganization of the contact.
phone StringPhone number of the contact.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
contact CustomerRelationsContactContact after the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.customerRelationsOrganizationCreate

Input type: CustomerRelationsOrganizationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
defaultRate FloatStandard billing rate for the organization.
description StringDescription of or notes for the organization.
groupId GroupID!Group for the organization.
name String!Name of the organization.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
organization CustomerRelationsOrganizationOrganization after the mutation.

Mutation.customerRelationsOrganizationUpdate

Input type: CustomerRelationsOrganizationUpdateInput

Arguments

NameTypeDescription
active BooleanState of the organization.
clientMutationId StringA unique identifier for the client performing the mutation.
defaultRate FloatStandard billing rate for the organization.
description StringDescription of or notes for the organization.
id CustomerRelationsOrganizationID!Global ID of the organization.
name StringName of the organization.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
organization CustomerRelationsOrganization!Organization after the mutation.

Mutation.dastOnDemandScanCreate

Input type: DastOnDemandScanCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastScannerProfileId DastScannerProfileIDID 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!Project the site profile belongs to.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
pipelineUrl StringURL of the pipeline that was created.

Mutation.dastProfileCreate

Input type: DastProfileCreateInput

Arguments

NameTypeDescription
branchName StringAssociated branch.
clientMutationId StringA unique identifier for the client performing the mutation.
dastProfileSchedule DastProfileScheduleInputRepresents a DAST Profile Schedule.
dastScannerProfileId DastScannerProfileID!ID of the scanner profile to be associated.
dastSiteProfileId DastSiteProfileID!ID of the site profile to be associated.
description StringDescription of the profile. Defaults to an empty string.
fullPath ID!Project the profile belongs to.
name String!Name of the profile.
runAfterCreate BooleanRun scan using profile after creation. Defaults to false.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastProfile DastProfileCreated profile.
errors [String!]!Errors encountered during execution of the mutation.
pipelineUrl StringURL of the pipeline that was created. Requires runAfterCreate to be set to true.

Mutation.dastProfileDelete

Input type: DastProfileDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id DastProfileID!ID of the profile to be deleted.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.dastProfileRun

Input type: DastProfileRunInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastProfileID!ID of the profile to be used for the scan.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
pipelineUrl StringURL of the pipeline that was created.

Mutation.dastProfileUpdate

Input type: DastProfileUpdateInput

Arguments

NameTypeDescription
branchName StringAssociated branch.
clientMutationId StringA unique identifier for the client performing the mutation.
dastProfileSchedule DastProfileScheduleInputRepresents a DAST profile schedule.
dastScannerProfileId DastScannerProfileIDID of the scanner profile to be associated.
dastSiteProfileId DastSiteProfileIDID of the site profile to be associated.
description StringDescription of the profile. Defaults to an empty string.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastProfileID!ID of the profile to be deleted.
name StringName of the profile.
runAfterUpdate BooleanRun scan using profile after update. Defaults to false.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastProfile DastProfileUpdated profile.
errors [String!]!Errors encountered during execution of the mutation.
pipelineUrl StringThe 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Project the scanner profile belongs to.
profileName String!Name of the scanner profile.
scanType DastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages BooleanIndicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout IntMaximum number of minutes allowed for the spider to traverse the site.
targetTimeout IntMaximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider BooleanIndicates 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastScannerProfile DastScannerProfileCreated scanner profile.
errors [String!]!Errors encountered during execution of the mutation.
id DastScannerProfileID Deprecated: use dastScannerProfile field. Deprecated in 14.10.

Mutation.dastScannerProfileDelete

Input type: DastScannerProfileDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastScannerProfileID!ID of the scanner profile to be deleted.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.dastScannerProfileUpdate

Input type: DastScannerProfileUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastScannerProfileID!ID of the scanner profile to be updated.
profileName String!Name of the scanner profile.
scanType DastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages BooleanIndicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout Int!Maximum number of minutes allowed for the spider to traverse the site.
targetTimeout Int!Maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider BooleanIndicates 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastScannerProfile DastScannerProfileUpdated scanner profile.
errors [String!]!Errors encountered during execution of the mutation.
id DastScannerProfileID Deprecated: use dastScannerProfile field. Deprecated in 14.10.

Mutation.dastSiteProfileCreate

Input type: DastSiteProfileCreateInput

Arguments

NameTypeDescription
auth DastSiteProfileAuthInputParameters for authentication.
clientMutationId StringA unique identifier for the client performing the mutation.
excludedUrls [String!]URLs to skip during an authenticated scan. Defaults to [].
fullPath ID!Project the site profile belongs to.
profileName String!Name of the site profile.
requestHeaders StringComma-separated list of request header names and values to be added to every request made by DAST.
scanMethod DastScanMethodTypeScan method by the scanner. Is not saved or updated if dast_api_scanner feature flag is disabled.
targetType DastTargetTypeEnumType of target to be scanned.
targetUrl StringURL of the target to be scanned.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastSiteProfile DastSiteProfileSite Profile object.
errors [String!]!Errors encountered during execution of the mutation.
id DastSiteProfileID Deprecated: use dastSiteProfile.id field. Deprecated in 14.10.

Mutation.dastSiteProfileDelete

Input type: DastSiteProfileDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastSiteProfileID!ID of the site profile to be deleted.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.dastSiteProfileUpdate

Input type: DastSiteProfileUpdateInput

Arguments

NameTypeDescription
auth DastSiteProfileAuthInputParameters for authentication.
clientMutationId StringA unique identifier for the client performing the mutation.
excludedUrls [String!]URLs to skip during an authenticated scan.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastSiteProfileID!ID of the site profile to be updated.
profileName String!Name of the site profile.
requestHeaders StringComma-separated list of request header names and values to be added to every request made by DAST.
scanMethod DastScanMethodTypeScan method by the scanner. Is not saved or updated if dast_api_scanner feature flag is disabled.
targetType DastTargetTypeEnumType of target to be scanned.
targetUrl StringURL of the target to be scanned.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastSiteProfile DastSiteProfileSite profile object.
errors [String!]!Errors encountered during execution of the mutation.
id DastSiteProfileID Deprecated: use dastSiteProfile.id field. Deprecated in 14.10.

Mutation.dastSiteTokenCreate

Input type: DastSiteTokenCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Project the site token belongs to.
targetUrl StringURL of the target to be validated.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
id DastSiteTokenIDID of the site token.
status DastSiteProfileValidationStatusEnumCurrent validation status of the target.
token StringToken string.

Mutation.dastSiteValidationCreate

Input type: DastSiteValidationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastSiteTokenId DastSiteTokenID!ID of the site token.
fullPath ID!Project the site profile belongs to.
strategy DastSiteValidationStrategyEnumValidation strategy to be used.
validationPath String!Path to be requested during validation.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
id DastSiteValidationIDID of the site validation.
status DastSiteProfileValidationStatusEnumCurrent validation status.

Mutation.dastSiteValidationRevoke

Input type: DastSiteValidationRevokeInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Project the site validation belongs to.
normalizedTargetUrl String!Normalized URL of the target to be revoked.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.deleteAnnotation

Input type: DeleteAnnotationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id MetricsDashboardAnnotationID!Global ID of the annotation to delete.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.designManagementDelete

Input type: DesignManagementDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
filenames [String!]!Filenames of the designs to delete.
iid ID!IID of the issue to modify designs for.
projectPath ID!Project where the issue is to upload designs for.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
version DesignVersionNew version in which the designs are deleted.

Mutation.designManagementMove

Input type: DesignManagementMoveInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id DesignManagementDesignID!ID of the design to move.
next DesignManagementDesignIDID of the immediately following design.
previous DesignManagementDesignIDID of the immediately preceding design.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
designCollection DesignCollectionCurrent state of the collection.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.designManagementUpload

Input type: DesignManagementUploadInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
files [Upload!]!Files to upload.
iid ID!IID of the issue to modify designs for.
projectPath ID!Project where the issue is to upload designs for.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
designs [Design!]!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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id BoardID!Global ID of the board to destroy.

Fields

NameTypeDescription
board BoardBoard after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyBoardList

Input type: DestroyBoardListInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
listId ListID!Global ID of the list to destroy. Only label lists are accepted.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
list BoardListList after mutation.

Mutation.destroyComplianceFramework

Input type: DestroyComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ComplianceManagementFrameworkID!Global ID of the compliance framework to destroy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyContainerRepository

Input type: DestroyContainerRepositoryInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ContainerRepositoryID!ID of the container repository.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
containerRepository ContainerRepository!Container repository policy after scheduling the deletion.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyContainerRepositoryTags

Input type: DestroyContainerRepositoryTagsInput

Arguments

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
deletedTagNames [String!]!Deleted container repository tags.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyCustomEmoji

caution
Introduced in 13.6. This feature is in Alpha. It can be changed or removed at any time.

Input type: DestroyCustomEmojiInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CustomEmojiID!Global ID of the custom emoji to destroy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
customEmoji CustomEmojiDeleted custom emoji.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyEpicBoard

Input type: DestroyEpicBoardInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id BoardsEpicBoardID!Global ID of the board to destroy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epicBoard EpicBoardEpic board after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyNote

Input type: DestroyNoteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id NoteID!Global ID of the note to destroy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
note NoteNote after mutation.

Mutation.destroyPackage

Input type: DestroyPackageInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id PackagesPackageID!ID of the Package.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyPackageFile

Input type: DestroyPackageFileInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id PackagesPackageFileID!ID of the Package file.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyPackageFiles

Input type: DestroyPackageFilesInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
ids [PackagesPackageFileID!]!IDs of the Package file.
projectPath ID!Project path where the packages cleanup policy is located.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroySnippet

Input type: DestroySnippetInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id SnippetID!Global ID of the snippet to destroy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
snippet SnippetSnippet after mutation.

Mutation.disableDevopsAdoptionNamespace

BETA This endpoint is subject to change without notice.

Input type: DisableDevopsAdoptionNamespaceInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id [AnalyticsDevopsAdoptionEnabledNamespaceID!]!One or many IDs of the enabled namespaces to disable.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.discussionToggleResolve

Toggles the resolved state of a discussion.

Input type: DiscussionToggleResolveInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id DiscussionID!Global ID of the discussion.
resolve Boolean!Will resolve the discussion when true, and unresolve the discussion when false.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
discussion DiscussionDiscussion after mutation.
errors [String!]!Errors encountered during execution of the mutation.

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

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
clientMutationId StringA 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.enableDevopsAdoptionNamespace

BETA This endpoint is subject to change without notice.

Input type: EnableDevopsAdoptionNamespaceInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
displayNamespaceId NamespaceIDDisplay namespace ID.
namespaceId NamespaceID!Namespace ID.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
enabledNamespace DevopsAdoptionEnabledNamespaceEnabled namespace after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.environmentsCanaryIngressUpdate

Deprecated This endpoint is planned to be removed along with certificate-based clusters. See this epic for more information.

Input type: EnvironmentsCanaryIngressUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id EnvironmentID!Global ID of the environment to update.
weight Int!Weight of the Canary Ingress.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.epicAddIssue

Input type: EpicAddIssueInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath ID!Group the epic to mutate belongs to.
iid ID!IID of the epic to mutate.
issueIid String!IID of the issue to be added.
projectPath ID!Full path of the project the issue belongs to.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epic EpicEpic after mutation.
epicIssue EpicIssueEpic-issue relationship.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.epicBoardCreate

Input type: EpicBoardCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath IDFull path of the group with which the resource is associated.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
labelIds [LabelID!]IDs of labels to be added to the board.
labels [String!]Labels of the issue.
name StringBoard name.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epicBoard EpicBoardCreated epic board.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.epicBoardListCreate

Input type: EpicBoardListCreateInput

Arguments

NameTypeDescription
backlog BooleanCreate the backlog list.
boardId BoardsEpicBoardID!Global ID of the issue board to mutate.
clientMutationId StringA unique identifier for the client performing the mutation.
labelId LabelIDGlobal ID of an existing label.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
list EpicListEpic list in the epic board.

Mutation.epicBoardListDestroy

Destroys an epic board list.

Input type: EpicBoardListDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
listId BoardsEpicListID!Global ID of the epic board list to destroy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
list EpicListEpic board list. null if the board was destroyed successfully.

Mutation.epicBoardUpdate

Input type: EpicBoardUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
id BoardsEpicBoardID!Epic board global ID.
labelIds [LabelID!]IDs of labels to be added to the board.
labels [String!]Labels of the issue.
name StringBoard name.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epicBoard EpicBoardUpdated epic board.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.epicMoveList

Input type: EpicMoveListInput

Arguments

NameTypeDescription
boardId BoardsEpicBoardID!Global ID of the board that the epic is in.
clientMutationId StringA unique identifier for the client performing the mutation.
epicId EpicID!ID of the epic to mutate.
fromListId BoardsEpicListIDID of the board list that the epic will be moved from. Required if moving between lists.
moveAfterId EpicIDID of epic that should be placed after the current epic.
moveBeforeId EpicIDID of epic that should be placed before the current epic.
toListId BoardsEpicListID!ID of the list the epic will be in after mutation.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epic EpicEpic after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.epicSetSubscription

Input type: EpicSetSubscriptionInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath ID!Group the epic to mutate belongs to.
iid ID!IID of the epic to mutate.
subscribedState Boolean!Desired state of the subscription.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epic EpicEpic after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.epicTreeReorder

Input type: EpicTreeReorderInput

Arguments

NameTypeDescription
baseEpicId EpicID!ID of the base epic of the tree.
clientMutationId StringA unique identifier for the client performing the mutation.
moved EpicTreeNodeFieldsInputType!Parameters for updating the tree positions.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.escalationPolicyCreate

Input type: EscalationPolicyCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the escalation policy.
name String!Name of the escalation policy.
projectPath ID!Project to create the escalation policy for.
rules [EscalationRuleInput!]!Steps of the escalation policy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyTypeEscalation policy.

Mutation.escalationPolicyDestroy

Input type: EscalationPolicyDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IncidentManagementEscalationPolicyID!Escalation policy internal ID to remove.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyTypeEscalation policy.

Mutation.escalationPolicyUpdate

Input type: EscalationPolicyUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the escalation policy.
id IncidentManagementEscalationPolicyID!ID of the on-call schedule to create the on-call rotation in.
name StringName of the escalation policy.
rules [EscalationRuleInput!]Steps of the escalation policy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyTypeEscalation policy.

Mutation.exportRequirements

Input type: ExportRequirementsInput

Arguments

NameTypeDescription
authorUsername [String!]Filter requirements by author username.
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full project path the requirements are associated with.
search StringSearch query for requirement title.
selectedFields [String!]List of selected requirements fields to be exported.
sort SortList requirements by sort order.
state RequirementStateFilter requirements by state.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.externalAuditEventDestinationCreate

Input type: ExternalAuditEventDestinationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationUrl String!Destination URL.
groupPath ID!Group path.
verificationToken StringVerification token.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
externalAuditEventDestination ExternalAuditEventDestinationDestination created.

Mutation.externalAuditEventDestinationDestroy

Input type: ExternalAuditEventDestinationDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id AuditEventsExternalAuditEventDestinationID!ID of external audit event destination to destroy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.externalAuditEventDestinationUpdate

Input type: ExternalAuditEventDestinationUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationUrl StringDestination URL to change.
id AuditEventsExternalAuditEventDestinationID!ID of external audit event destination to update.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
externalAuditEventDestination ExternalAuditEventDestinationUpdated destination.

Mutation.gitlabSubscriptionActivate

Input type: GitlabSubscriptionActivateInput

Arguments

NameTypeDescription
activationCode String!Activation code received after purchasing a GitLab subscription.
clientMutationId StringA unique identifier for the client performing the mutation.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
license CurrentLicenseCurrent license.

Mutation.groupUpdate

Input type: GroupUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Full path of the group that will be updated.
sharedRunnersSetting SharedRunnersSetting!Shared runners availability for the namespace and its descendants.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
group GroupGroup after update.

Mutation.httpIntegrationCreate

Input type: HttpIntegrationCreateInput

Arguments

NameTypeDescription
active Boolean!Whether the integration is receiving alerts.
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Name of the integration.
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonStringExample of an alert payload.
projectPath ID!Project to create the integration in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegrationHTTP integration.

Mutation.httpIntegrationDestroy

Input type: HttpIntegrationDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID!ID of the integration to remove.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegrationHTTP integration.

Mutation.httpIntegrationResetToken

Input type: HttpIntegrationResetTokenInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID!ID of the integration to mutate.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegrationHTTP integration.

Mutation.httpIntegrationUpdate

Input type: HttpIntegrationUpdateInput

Arguments

NameTypeDescription
active BooleanWhether the integration is receiving alerts.
clientMutationId StringA unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID!ID of the integration to mutate.
name StringName of the integration.
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonStringExample of an alert payload.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegrationHTTP integration.

Mutation.issuableResourceLinkCreate

Input type: IssuableResourceLinkCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IssueID!Incident id to associate the resource link with.
link String!Link of the resource.
linkText StringLink text of the resource.
linkType IssuableResourceLinkTypeLink type of the resource.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issuableResourceLink IssuableResourceLinkIssuable resource link.

Mutation.issuableResourceLinkDestroy

Input type: IssuableResourceLinkDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IncidentManagementIssuableResourceLinkID!Issuable resource link ID to remove.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issuableResourceLink IssuableResourceLinkIssuable resource link.

Mutation.issueMove

Input type: IssueMoveInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
targetProjectPath ID!Project to move the issue to.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueMoveList

Input type: IssueMoveListInput

Arguments

NameTypeDescription
boardId BoardID!Global ID of the board that the issue is in.
clientMutationId StringA unique identifier for the client performing the mutation.
epicId EpicIDID of the parent epic. NULL when removing the association.
fromListId IDID of the board list that the issue will be moved from.
iid String!IID of the issue to mutate.
moveAfterId IDID of issue that should be placed after the current issue.
moveBeforeId IDID of issue that should be placed before the current issue.
positionInList IntPosition of issue within the board list. Positions start at 0. Use -1 to move to the end of the list.
projectPath ID!Project the issue to mutate is in.
toListId IDID of the board list that the issue will be moved to.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetAssignees

Input type: IssueSetAssigneesInput

Arguments

NameTypeDescription
assigneeUsernames [String!]!Usernames to assign to the resource. Replaces existing assignees by default.
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
operationMode MutationOperationModeOperation to perform. Defaults to REPLACE.
projectPath ID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetConfidential

Input type: IssueSetConfidentialInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean!Whether or not to set the issue as a confidential.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetCrmContacts

Input type: IssueSetCrmContactsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
contactIds [CustomerRelationsContactID!]!Customer relations contact IDs to set. Replaces existing contacts by default.
iid String!IID of the issue to mutate.
operationMode MutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPath ID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetDueDate

Input type: IssueSetDueDateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dueDate TimeDesired due date for the issue. Due date is removed if null.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetEpic

Input type: IssueSetEpicInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epicId EpicIDGlobal ID of the epic to be assigned to the issue, epic will be removed if absent or set to null.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetEscalationPolicy

Input type: IssueSetEscalationPolicyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
escalationPolicyId IncidentManagementEscalationPolicyIDGlobal ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetEscalationStatus

Input type: IssueSetEscalationStatusInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
status IssueEscalationStatus!Set the escalation status.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetIteration

Input type: IssueSetIterationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
iterationId IterationIDIteration to assign to the issue.
projectPath ID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetLocked

Input type: IssueSetLockedInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
locked Boolean!Whether or not to lock discussion on the issue.
projectPath ID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetSeverity

Input type: IssueSetSeverityInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
severity IssuableSeverity!Set the incident severity level.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetSubscription

Input type: IssueSetSubscriptionInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
subscribedState Boolean!Desired state of the subscription.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.issueSetWeight

Input type: IssueSetWeightInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
weight IntThe desired weight for the issue. If set to null, weight is removed.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue after mutation.

Mutation.iterationCadenceCreate

Input type: IterationCadenceCreateInput

Arguments

NameTypeDescription
active Boolean!Whether the iteration cadence is active.
automatic Boolean!Whether the iteration cadence should automatically generate upcoming iterations.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks IntDuration in weeks of the iterations within this cadence.
groupPath ID!Group where the iteration cadence is created.
iterationsInAdvance IntUpcoming iterations to be created when iteration cadence is set to automatic.
rollOver BooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDate TimeTimestamp of the automation start date.
title StringTitle of the iteration cadence.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
iterationCadence IterationCadenceCreated iteration cadence.

Mutation.iterationCadenceDestroy

Input type: IterationCadenceDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IterationsCadenceID!Global ID of the iteration cadence.

Fields

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
active BooleanWhether the iteration cadence is active.
automatic BooleanWhether the iteration cadence should automatically generate upcoming iterations.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks IntDuration in weeks of the iterations within this cadence.
id IterationsCadenceID!Global ID of the iteration cadence.
iterationsInAdvance IntUpcoming iterations to be created when iteration cadence is set to automatic.
rollOver BooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDate TimeTimestamp of the automation start date.
title StringTitle of the iteration cadence.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
iterationCadence IterationCadenceUpdated iteration cadence.

Mutation.iterationCreate

Input type: iterationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration.
dueDate Str