Skip to content

The text is longer than 1048576 characters and has been visually truncated.

GraphQL API resources

This documentation is self-generated based on GitLab current GraphQL schema.

The API can be explored using the interactive GraphQL explorer.

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.

WARNING: Fields that are deprecated are marked with {warning-solid}. 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.abuseReport

Find an abuse report.

NOTE: Introduced in 16.3. Status: Experiment.

Returns AbuseReport.

Arguments

Name Type Description
id AbuseReportID! ID of the abuse report.

Query.abuseReportLabels

Abuse report labels.

NOTE: Introduced in 16.3. Status: Experiment.

Returns LabelConnection.

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

Arguments

Name Type Description
searchTerm String Search term to find labels with.

Query.addOnPurchase

Retrieve the active add-on purchase. This query can be used in GitLab SaaS and self-managed environments.

NOTE: Introduced in 16.7. Status: Experiment.

Returns AddOnPurchase.

Arguments

Name Type Description
addOnType GitlabSubscriptionsAddOnType! Type of add-on for the add-on purchase.
namespaceId NamespaceID ID of namespace that the add-on was purchased for.

Query.aiMessages

Find GitLab Duo Chat messages.

NOTE: Introduced in 16.1. Status: Experiment.

Returns AiMessageConnection!.

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

Arguments

Name Type Description
requestIds [ID!] Array of request IDs to fetch.
roles [AiMessageRole!] Array of roles to fetch.

Query.auditEventDefinitions

Definitions for all audit events available on the instance.

Returns AuditEventDefinitionConnection!.

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

Query.auditEventsInstanceAmazonS3Configurations

Instance-level Amazon S3 configurations for audit events.

Returns InstanceAmazonS3ConfigurationTypeConnection.

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

Query.boardList

Find an issue board list.

Returns BoardList.

Arguments

Name Type Description
id ListID! Global ID of the list.
issueFilters BoardIssueInput Filters applied when getting issue metadata in the board list.

Query.ciApplicationSettings

CI related settings that apply to the entire instance.

Returns CiApplicationSettings.

Query.ciCatalogResource

A single CI/CD Catalog resource visible to an authorized user.

NOTE: Introduced in 16.1. Status: Experiment.

Returns CiCatalogResource.

Arguments

Name Type Description
fullPath ID CI/CD Catalog resource full path.
id CiCatalogResourceID CI/CD Catalog resource global ID.

Query.ciCatalogResources

All CI/CD Catalog resources under a common namespace, visible to an authorized user.

NOTE: Introduced in 15.11. Status: Experiment.

Returns CiCatalogResourceConnection.

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

Arguments

Name Type Description
scope CiCatalogResourceScope Scope of the returned catalog resources.
search String Search term to filter the catalog resources by name or description.
sort CiCatalogResourceSort Sort catalog resources by given criteria.

Query.ciConfig

Linted and processed contents of a CI config. Should not be requested more than once per request.

Returns CiConfig.

Arguments

Name Type Description
content String! Contents of .gitlab-ci.yml.
dryRun Boolean Run pipeline creation simulation, or only do static check.
projectPath ID! Project of the CI config.
sha String Sha for the pipeline.
skipVerifyProjectSha {warning-solid} Boolean Introduced in 16.5. Status: Experiment. If the provided sha is found in the project's repository but is not associated with a Git reference (a detached commit), the verification fails and a validation error is returned. Otherwise, verification passes, even if the sha is invalid. Set to true to skip this verification process.

Query.ciMinutesUsage

Compute 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, and last: Int.

Arguments

Name Type Description
date Date Date for which to retrieve the usage data, should be the first day of a month.
namespaceId NamespaceID Global ID of the Namespace for the monthly compute usage.

Query.ciPipelineStage

Stage belonging to a CI pipeline.

Returns CiStage.

Arguments

Name Type Description
id CiStageID! Global ID of the CI stage.

Query.ciQueueingHistory

Time it took for ci job to be picked up by runner in percentiles.

NOTE: Introduced in 16.4. Status: Experiment.

Returns QueueingDelayHistory.

Arguments

Name Type Description
fromTime Time Start of the requested time frame. Defaults to 3 hours ago.
runnerType CiRunnerType Filter jobs by the type of runner that executed them.
toTime Time End of the requested time frame. Defaults to current time.

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, and last: Int.

Arguments

Name Type Description
sort CiVariableSort Sort order of results.

Query.containerRepository

Find a container repository.

Returns ContainerRepositoryDetails.

Arguments

Name Type Description
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 CurrentUser.

Query.designManagement

Fields related to design management.

Returns DesignManagement!.

Query.devopsAdoptionEnabledNamespaces

Get configured DevOps adoption namespaces. Status: 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, and last: Int.

Arguments

Name Type Description
displayNamespaceId NamespaceID Filter by display namespace.

Query.echo

Testing endpoint to validate the API with.

Returns String!.

Arguments

Name Type Description
text String! Text to echo back.

Query.epicBoardList

Returns EpicList.

Arguments

Name Type Description
epicFilters EpicFilters Filters applied when getting epic metadata in the epic board list.
id BoardsEpicListID! Global ID of the list.

Query.explainVulnerabilityPrompt

GitLab Duo Vulnerability summary prompt for a specified vulnerability.

NOTE: Introduced in 16.2. Status: Experiment.

Returns ExplainVulnerabilityPrompt.

Arguments

Name Type Description
vulnerabilityId VulnerabilityID! Vulnerability to generate a prompt for.

Query.frecentGroups

A user's frecently visited groups.

Returns [Group!].

Query.frecentProjects

A user's frecently visited projects.

Returns [Project!].

Query.geoNode

Find a Geo node.

Returns GeoNode.

Arguments

Name Type Description
name String Name 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

Name Type Description
fullPath ID! Full path of the group. For example, gitlab-org/gitlab-foss.

Query.groups

Find groups.

Returns GroupConnection.

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

Arguments

Name Type Description
search String Search query for group name or group full path.

Query.instanceExternalAuditEventDestinations

Instance level external audit event destinations.

Returns InstanceExternalAuditEventDestinationConnection.

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

Query.instanceGoogleCloudLoggingConfigurations

Instance level google cloud logging configurations.

Returns InstanceGoogleCloudLoggingConfigurationTypeConnection.

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

Query.instanceSecurityDashboard

Fields related to Instance Security Dashboard.

Returns InstanceSecurityDashboard.

Query.issue

Find an issue.

Returns Issue.

Arguments

Name Type Description
id IssueID! Global ID of the issue.

Query.issues

Find issues visible to the current user. At least one filter must be provided.

NOTE: Introduced in 15.6. Status: Experiment.

Returns IssueConnection.

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

Arguments

Name Type Description
assigneeId String ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername {warning-solid} String Deprecated in 13.11. Use assigneeUsernames.
assigneeUsernames [String!] Usernames of users assigned to the issue.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername String Username of the author of the issue.
closedAfter Time Issues closed after this date.
closedBefore Time Issues closed before this date.
confidential Boolean Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter Time Issues created after this date.
createdBefore Time Issues created before this date.
crmContactId String ID of a contact assigned to the issues.
crmOrganizationId String ID of an organization assigned to the issues.
epicId String ID of an epic associated with the issues, "none" and "any" values are supported.
epicWildcardId EpicWildcardId Filter by epic ID wildcard. Incompatible with epicId.
healthStatusFilter HealthStatusFilter Health status of the issue, "none" and "any" values are supported.
iid String IID of the issue. For example, "1".
iids [String!] List of IIDs of issues. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived Boolean Whether to include issues from archived projects. Defaults to false.
includeSubepics Boolean Whether to include subepics when filtering issues by epicId.
iterationCadenceId [IterationsCadenceID!] Filter by a list of iteration cadence IDs.
iterationId [ID] List of iteration Global IDs applied to the issue.
iterationTitle String Filter by iteration title.
iterationWildcardId IterationWildcardId Filter by iteration ID wildcard.
labelName [String] Labels applied to this issue.
milestoneTitle [String] Milestone applied to this issue.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported.
not NegatedIssueFilterInput Negated arguments.
or UnionedIssueFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort IssueSort Sort issues by this criteria.
state IssuableState Current state of this issue.
types [IssueType!] Filter issues by the given issue types.
updatedAfter Time Issues updated after this date.
updatedBefore Time Issues updated before this date.
weight String Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId WeightWildcardId Filter by weight ID wildcard. Incompatible with weight.

Query.iteration

Find an iteration.

Returns Iteration.

Arguments

Name Type Description
id IterationID! Find an iteration by its ID.

Query.jobs

All jobs on this GitLab instance. Returns an empty result for users without administrator access.

Returns CiJobConnection.

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

Arguments

Name Type Description
failureReason {warning-solid} CiJobFailureReason Introduced in 16.4. Status: Experiment. Filter jobs by failure reason. Currently only RUNNER_SYSTEM_FAILURE together with runnerTypes: INSTANCE_TYPE is supported.
runnerTypes {warning-solid} [CiRunnerType!] Introduced in 16.4. Status: Experiment. Filter jobs by runner type if feature flag :admin_jobs_filter_runner_type is enabled.
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, and last: Int.

Query.memberRole

Finds a single custom role.

NOTE: Introduced in 16.6. Status: Experiment.

Returns MemberRole.

Arguments

Name Type Description
id MemberRoleID Global ID of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

Query.memberRolePermissions

List of all customizable permissions.

NOTE: Introduced in 16.4. Status: Experiment.

Returns CustomizablePermissionConnection.

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

Query.memberRoles

Member roles available for the instance.

NOTE: Introduced in 16.7. Status: Experiment.

Returns MemberRoleConnection.

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

Arguments

Name Type Description
id MemberRoleID Global ID of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

Query.mergeRequest

Find a merge request.

Returns MergeRequest.

Arguments

Name Type Description
id MergeRequestID! Global ID of the merge request.

Query.metadata

Metadata about GitLab.

Returns Metadata.

Query.milestone

Find a milestone.

Returns Milestone.

Arguments

Name Type Description
id MilestoneID! Find a milestone by its ID.

Query.mlModel

Find machine learning models.

NOTE: Introduced in 16.7. Status: Experiment.

Returns MlModel.

Arguments

Name Type Description
id MlModelID! ID of the model.

Query.namespace

Find a namespace.

Returns Namespace.

Arguments

Name Type Description
fullPath ID! Full path of the namespace. For example, gitlab-org/gitlab-foss.

Query.note

Find a note.

NOTE: Introduced in 15.9. Status: Experiment.

Returns Note.

Arguments

Name Type Description
id NoteID! Global ID of the note.

Query.organization

Find an organization.

NOTE: Introduced in 16.4. Status: Experiment.

Returns Organization.

Arguments

Name Type Description
id OrganizationsOrganizationID! ID of the organization.

Query.organizations

List organizations.

NOTE: Introduced in 16.8. Status: Experiment.

Returns OrganizationConnection.

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

Query.package

Find a package. This field can only be resolved for one query in any single request. Returns null if a package has no default status.

Returns PackageDetailsType.

Arguments

Name Type Description
id PackagesPackageID! Global ID of the package.

Query.project

Find a project.

Returns Project.

Arguments

Name Type Description
fullPath ID! Full path of the project. 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, and last: Int.

Arguments

Name Type Description
fullPaths [String!] Filter projects by full paths. You cannot provide more than 50 full paths.
ids [ID!] Filter projects by IDs.
membership Boolean Return only projects that the current user is a member of.
search String Search query, which can be for the project name, a path, or a description.
searchNamespaces Boolean Include namespace in project search.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics [String!] Filter projects by topics.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.

Query.queryComplexity

Information about the complexity of the GraphQL query.

Returns QueryComplexity.

Query.runner

Find a runner.

Returns CiRunner.

Arguments

Name Type Description
id CiRunnerID! Runner ID.

Query.runnerPlatforms

Supported runner platforms.

NOTE: Deprecated in 15.9. No longer used, use gitlab-runner documentation to learn about supported platforms.

Returns RunnerPlatformConnection.

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

Query.runnerSetup

Runner setup instructions.

NOTE: Deprecated in 15.9. No longer used, use gitlab-runner documentation to learn about runner registration commands.

Returns RunnerSetup.

Arguments

Name Type Description
architecture String! Architecture to generate the instructions for.
groupId {warning-solid} GroupID Deprecated in 13.11. No longer used.
platform String! Platform to generate the instructions for.
projectId {warning-solid} ProjectID Deprecated in 13.11. No longer used.

Query.runnerUsage

Runner usage by runner.

NOTE: Introduced in 16.9. Status: Experiment.

Returns [CiRunnerUsage!].

Arguments

Name Type Description
fromDate Date Start of the requested date frame. Defaults to the start of the previous calendar month.
runnerType CiRunnerType Filter runners by the type.
runnersLimit Int Maximum number of runners to return. Other runners will be aggregated to a runner: null entry. Defaults to 5 if unspecified. Maximum of 500.
toDate Date End of the requested date frame. Defaults to the end of the previous calendar month.

Query.runnerUsageByProject

Runner usage by project.

NOTE: Introduced in 16.9. Status: Experiment.

Returns [CiRunnerUsageByProject!].

Arguments

Name Type Description
fromDate Date Start of the requested date frame. Defaults to the start of the previous calendar month.
projectsLimit Int Maximum number of projects to return.Other projects will be aggregated to a project: null entry. Defaults to 5 if unspecified. Maximum of 500.
runnerType CiRunnerType Filter jobs by the type of runner that executed them.
toDate Date End of the requested date frame. Defaults to the end of the previous calendar month.

Query.runners

Get all runners in the GitLab instance (project and shared). Access is restricted to users with administrator access.

Returns CiRunnerConnection.

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

Arguments

Name Type Description
active {warning-solid} Boolean Deprecated in 14.8. This was renamed. Use: paused.
creatorId UserID Filter runners by creator ID.
creatorUsername {warning-solid} String Introduced in 16.7. Status: Experiment. Filter runners by creator username.
paused Boolean Filter runners by paused (true) or active (false) status.
search String Filter by full token or partial text in description field.
sort CiRunnerSort Sort order of results.
status CiRunnerStatus Filter runners by status.
tagList [String!] Filter by tags associated with the runner (comma-separated or array).
type CiRunnerType Filter runners by type.
upgradeStatus CiRunnerUpgradeStatus Filter by upgrade status.
versionPrefix {warning-solid} String Introduced in 16.6. Status: Experiment. Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term '14.' returns runner managers with versions '14.11.1' and '14.2.3'.

Query.selfManagedAddOnEligibleUsers

Users within the self-managed instance who are eligible for add-ons.

NOTE: Introduced in 16.7. Status: Experiment.

Returns AddOnUserConnection.

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

Arguments

Name Type Description
addOnType GitlabSubscriptionsAddOnType! Type of add on to filter the eligible users by.
search String Search the user list.

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, and last: Int.

Arguments

Name Type Description
authorId UserID ID of an author.
explore Boolean Explore personal snippets.
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
projectId ProjectID ID of a project.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility 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, and last: Int.

Query.syntheticNote

Find a synthetic note.

NOTE: Introduced in 15.9. Status: Experiment.

Returns Note.

Arguments

Name Type Description
noteableId NoteableID! Global ID of the resource to search synthetic note on.
sha String! Global ID of the note.

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, and last: Int.

Arguments

Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.

Query.todo

Retrieve a single to-do item.

Returns Todo.

Arguments

Name Type Description
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, and last: Int.

Arguments

Name Type Description
search String Search 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, and last: Int.

Arguments

Name Type Description
identifier MeasurementIdentifier! Type of measurement or statistics to retrieve.
recordedAfter Time Measurement recorded after this date.
recordedBefore Time Measurement recorded before this date.

Query.user

Find a user.

Returns UserCore.

Arguments

Name Type Description
id UserID ID of the User.
username String Username of the User.

Query.users

Find users.

Returns UserCoreConnection.

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

Arguments

Name Type Description
admins Boolean Return only admin users.
groupId GroupID Return users member of a given group.
ids [ID!] List of user Global IDs.
search String Query to search users by name, username, or primary email.
sort Sort Sort users by this criteria.
usernames [String!] List of usernames.

Query.vulnerabilities

Vulnerabilities reported on projects on the current user's instance security dashboard.

Returns VulnerabilityConnection.

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

Arguments

Name Type Description
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.
dismissalReason [VulnerabilityDismissalReason!] Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
hasIssues Boolean Returns only the vulnerabilities which have linked issues.
hasMergeRequest Boolean Returns only the vulnerabilities which have linked merge requests.
hasRemediations Boolean Returns only the vulnerabilities which have remediations.
hasResolution Boolean Returns 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.
owaspTopTen [VulnerabilityOwaspTop10!] Filter vulnerabilities by OWASP Top 10 category.
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 VulnerabilitySort List 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, and last: Int.

Arguments

Name Type Description
endDate ISO8601Date! Last day for which to fetch vulnerability history.
startDate ISO8601Date! First day for which to fetch vulnerability history.

Query.vulnerability

Find a vulnerability.

Returns Vulnerability.

Arguments

Name Type Description
id VulnerabilityID! Global ID of the Vulnerability.

Query.workItem

Find a work item.

NOTE: Introduced in 15.1. Status: Experiment.

Returns WorkItem.

Arguments

Name Type Description
id WorkItemID! Global ID of the work item.

Query.workItemsByReference

Find work items by their reference.

NOTE: Introduced in 16.7. Status: Experiment.

Returns WorkItemConnection.

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

Arguments

Name Type Description
contextNamespacePath ID Full path of the context namespace (project or group).
refs [String!]! Work item references. Can be either a short reference or URL.

Query.workspace

Find a workspace.

Returns Workspace.

Arguments

Name Type Description
id RemoteDevelopmentWorkspaceID! Find a workspace by its ID.

Query.workspaces

Find workspaces across the entire instance. This field is only available to instance admins, it will return an empty result for all non-admins.

Returns WorkspaceConnection.

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

Arguments

Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {warning-solid} [String!] Deprecated in 16.7. Use actual_states instead.
projectIds [ProjectID!] Filter workspaces by project GlobalIDs.
userIds [ProjectID!] Filter workspaces by user GlobalIDs.

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

NOTE: Introduced in 16.4. Status: Experiment.

Input type: AbuseReportLabelCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
color String The color of the label given in 6-digit hex notation with leading '#' sign (for example, #FFAABB) or one of the CSS color names.
title String! Title of the label.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
label Label Label after mutation.

Mutation.achievementsAward

NOTE: Introduced in 15.10. Status: Experiment.

Input type: AchievementsAwardInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being awarded.
clientMutationId String A unique identifier for the client performing the mutation.
userId UserID! Global ID of the user being awarded the achievement.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievement UserAchievement Achievement award.

Mutation.achievementsCreate

NOTE: Introduced in 15.8. Status: Experiment.

Input type: AchievementsCreateInput

Arguments

Name Type Description
avatar Upload Avatar for the achievement.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the achievement.
name String! Name for the achievement.
namespaceId NamespaceID! Namespace for the achievement.

Fields

Name Type Description
achievement Achievement Achievement created.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.achievementsDelete

NOTE: Introduced in 15.11. Status: Experiment.

Input type: AchievementsDeleteInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being deleted.
clientMutationId String A unique identifier for the client performing the mutation.

Fields

Name Type Description
achievement Achievement Achievement.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.achievementsRevoke

NOTE: Introduced in 15.10. Status: Experiment.

Input type: AchievementsRevokeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
userAchievementId AchievementsUserAchievementID! Global ID of the user achievement being revoked.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievement UserAchievement Achievement award.

Mutation.achievementsUpdate

NOTE: Introduced in 15.11. Status: Experiment.

Input type: AchievementsUpdateInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being updated.
avatar Upload Avatar for the achievement.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the achievement.
name String Name for the achievement.

Fields

Name Type Description
achievement Achievement Achievement.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectID! ID of the project to be added to Instance Security Dashboard.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Project that was added to the Instance Security Dashboard.

Mutation.adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

Arguments

Name Type Description
aiResource String Delete jobs matching ai_resource in the context metadata.
artifactSize String Delete jobs matching artifact_size in the context metadata.
artifactUsedCdn String Delete jobs matching artifact_used_cdn in the context metadata.
artifactsDependenciesCount String Delete jobs matching artifacts_dependencies_count in the context metadata.
artifactsDependenciesSize String Delete jobs matching artifacts_dependencies_size in the context metadata.
bulkImportEntityId String Delete jobs matching bulk_import_entity_id in the context metadata.
callerId String Delete jobs matching caller_id in the context metadata.
clientId String Delete jobs matching client_id in the context metadata.
clientMutationId String A unique identifier for the client performing the mutation.
featureCategory String Delete jobs matching feature_category in the context metadata.
jobId String Delete jobs matching job_id in the context metadata.
mergeActionStatus String Delete jobs matching merge_action_status in the context metadata.
pipelineId String Delete jobs matching pipeline_id in the context metadata.
project String Delete jobs matching project in the context metadata.
queueName String! Name of the queue to delete jobs from.
relatedClass String Delete jobs matching related_class in the context metadata.
remoteIp String Delete jobs matching remote_ip in the context metadata.
rootCallerId String Delete jobs matching root_caller_id in the context metadata.
rootNamespace String Delete jobs matching root_namespace in the context metadata.
subscriptionPlan String Delete jobs matching subscription_plan in the context metadata.
user String Delete jobs matching user in the context metadata.
userId String Delete jobs matching user_id in the context metadata.
workerClass String Delete jobs with the given worker class.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
result DeleteJobsResponse Information about the status of the deletion request.

Mutation.aiAction

NOTE: Introduced in 15.11. Status: Experiment.

Input type: AiActionInput

Arguments

Name Type Description
analyzeCiJobFailure AnalyzeCiJobFailureInput Input for analyze_ci_job_failure AI action.
chat AiChatInput Input for chat AI action.
clientMutationId String A unique identifier for the client performing the mutation.
clientSubscriptionId String Client generated ID that can be subscribed to, to receive a response for the mutation.
explainCode AiExplainCodeInput Input for explain_code AI action.
explainVulnerability AiExplainVulnerabilityInput Input for explain_vulnerability AI action.
fillInMergeRequestTemplate AiFillInMergeRequestTemplateInput Input for fill_in_merge_request_template AI action.
generateCommitMessage AiGenerateCommitMessageInput Input for generate_commit_message AI action.
generateCubeQuery AiGenerateCubeQueryInput Input for generate_cube_query AI action.
generateDescription AiGenerateDescriptionInput Input for generate_description AI action.
resolveVulnerability AiResolveVulnerabilityInput Input for resolve_vulnerability AI action.
summarizeComments AiSummarizeCommentsInput Input for summarize_comments AI action.
summarizeReview AiSummarizeReviewInput Input for summarize_review AI action.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requestId String ID of the request.

Mutation.aiAgentCreate

NOTE: Introduced in 16.8. Status: Experiment.

Input type: AiAgentCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Name of the agent.
projectPath ID! Project to which the agent belongs.
prompt String! Prompt for the agent.

Fields

Name Type Description
agent AiAgent Agent after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.alertSetAssignees

Input type: AlertSetAssigneesInput

Arguments

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

Fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.alertTodoCreate

Input type: AlertTodoCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the alert to mutate.
projectPath ID! Project the alert to mutate is in.

Fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.approveDeployment

Input type: ApproveDeploymentInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment to go with the approval.
id DeploymentID! ID of the deployment.
representedAs String Name of the User/Group/Role to use for the approval, when the user belongs to multiple approval rules.
status DeploymentsApprovalStatus! Status of the approval (either APPROVED or REJECTED).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
deploymentApproval DeploymentApproval! DeploymentApproval after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.artifactDestroy

Input type: ArtifactDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiJobArtifactID! ID of the artifact to delete.

Fields

Name Type Description
artifact CiJobArtifact Deleted artifact.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsAmazonS3ConfigurationCreate

Input type: AuditEventsAmazonS3ConfigurationCreateInput

Arguments

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
awsRegion String! AWS region where the bucket is created.
bucketName String! Name of the bucket where the audit events would be logged.
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID! Group path.
name String Destination name.
secretAccessKey String! Secret access key of the Amazon S3 account.

Fields

Name Type Description
amazonS3Configuration AmazonS3ConfigurationType configuration created.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsAmazonS3ConfigurationDelete

Input type: AuditEventsAmazonS3ConfigurationDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsAmazonS3ConfigurationID! ID of the Amazon S3 configuration to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsAmazonS3ConfigurationUpdate

Input type: AuditEventsAmazonS3ConfigurationUpdateInput

Arguments

Name Type Description
accessKeyXid String Access key ID of the Amazon S3 account.
awsRegion String AWS region where the bucket is created.
bucketName String Name of the bucket where the audit events would be logged.
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsAmazonS3ConfigurationID! ID of the Amazon S3 configuration to update.
name String Destination name.
secretAccessKey String Secret access key of the Amazon S3 account.

Fields

Name Type Description
amazonS3Configuration AmazonS3ConfigurationType Updated Amazon S3 configuration.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsInstanceAmazonS3ConfigurationCreate

Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput

Arguments

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
awsRegion String! AWS region where the bucket is created.
bucketName String! Name of the bucket where the audit events would be logged.
clientMutationId String A unique identifier for the client performing the mutation.
name String Destination name.
secretAccessKey String! Secret access key of the Amazon S3 account.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceAmazonS3Configuration InstanceAmazonS3ConfigurationType Created instance Amazon S3 configuration.

Mutation.auditEventsInstanceAmazonS3ConfigurationDelete

Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceAmazonS3ConfigurationID! ID of the instance-level Amazon S3 configuration to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsInstanceAmazonS3ConfigurationUpdate

Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput

Arguments

Name Type Description
accessKeyXid String Access key ID of the Amazon S3 account.
awsRegion String AWS region where the bucket is created.
bucketName String Name of the bucket where the audit events would be logged.
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceAmazonS3ConfigurationID! ID of the instance-level Amazon S3 configuration to update.
name String Destination name.
secretAccessKey String Secret access key of the Amazon S3 account.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceAmazonS3Configuration InstanceAmazonS3ConfigurationType Updated instance-level Amazon S3 configuration.

Mutation.auditEventsStreamingDestinationEventsAdd

Input type: AuditEventsStreamingDestinationEventsAddInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

Mutation.auditEventsStreamingDestinationEventsRemove

Input type: AuditEventsStreamingDestinationEventsRemoveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingDestinationInstanceEventsAdd

Input type: AuditEventsStreamingDestinationInstanceEventsAddInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

Mutation.auditEventsStreamingDestinationInstanceEventsRemove

Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingHeadersCreate

Input type: AuditEventsStreamingHeadersCreateInput

Arguments

Name Type Description
active Boolean Boolean option determining whether header is active or not.
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID! Destination to associate header with.
key String! Header key.
value String! Header value.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
header AuditEventStreamingHeader Created header.

Mutation.auditEventsStreamingHeadersDestroy

Input type: AuditEventsStreamingHeadersDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
headerId AuditEventsStreamingHeaderID! Header to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingHeadersUpdate

Input type: AuditEventsStreamingHeadersUpdateInput

Arguments

Name Type Description
active Boolean Boolean option determining whether header is active or not.
clientMutationId String A unique identifier for the client performing the mutation.
headerId AuditEventsStreamingHeaderID! Header to update.
key String Header key.
value String Header value.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
header AuditEventStreamingHeader Updates header.

Mutation.auditEventsStreamingHttpNamespaceFiltersAdd

Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID! Destination ID.
groupPath ID Full path of the group.
projectPath ID Full path of the project.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceFilter AuditEventStreamingHTTPNamespaceFilter Namespace filter created.

Mutation.auditEventsStreamingHttpNamespaceFiltersDelete

Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespaceFilterId AuditEventsStreamingHTTPNamespaceFilterID! Namespace filter ID.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingInstanceHeadersCreate

Input type: AuditEventsStreamingInstanceHeadersCreateInput

Arguments

Name Type Description
active Boolean Boolean option determining whether header is active or not.
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Instance level external destination to associate header with.
key String! Header key.
value String! Header value.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
header AuditEventsStreamingInstanceHeader Created header.

Mutation.auditEventsStreamingInstanceHeadersDestroy

Input type: AuditEventsStreamingInstanceHeadersDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
headerId AuditEventsStreamingInstanceHeaderID! Header to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingInstanceHeadersUpdate

Input type: AuditEventsStreamingInstanceHeadersUpdateInput

Arguments

Name Type Description
active Boolean Boolean option determining whether header is active or not.
clientMutationId String A unique identifier for the client performing the mutation.
headerId AuditEventsStreamingInstanceHeaderID! Header to update.
key String Header key.
value String Header value.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
header AuditEventsStreamingInstanceHeader Updates header.

Mutation.awardEmojiAdd

Input type: AwardEmojiAddInput

Arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
clientMutationId String A unique identifier for the client performing the mutation.
name String! Emoji name.

Fields

Name Type Description
awardEmoji AwardEmoji Emoji reactions after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.awardEmojiRemove

Input type: AwardEmojiRemoveInput

Arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
clientMutationId String A unique identifier for the client performing the mutation.
name String! Emoji name.

Fields

Name Type Description
awardEmoji AwardEmoji Emoji reactions after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.awardEmojiToggle

Input type: AwardEmojiToggleInput

Arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
clientMutationId String A unique identifier for the client performing the mutation.
name String! Emoji name.

Fields

Name Type Description
awardEmoji AwardEmoji Emoji reactions after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
toggledOn Boolean! Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.

Mutation.boardEpicCreate

Input type: BoardEpicCreateInput

Arguments

Name Type Description
boardId BoardsEpicBoardID! Global ID of the board that the epic is in.
clientMutationId String A unique identifier for the client performing the mutation.
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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after creation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.boardListCreate

Input type: BoardListCreateInput

Arguments

Name Type Description
assigneeId UserID Global ID of an existing user.
backlog Boolean Create the backlog list.
boardId BoardID! Global ID of the issue board to mutate.
clientMutationId String A unique identifier for the client performing the mutation.
iterationId IterationID Global ID of an existing iteration.
labelId LabelID Global ID of an existing label.
milestoneId MilestoneID Global ID of an existing milestone.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list BoardList Issue list in the issue board.

Mutation.boardListUpdateLimitMetrics

Input type: BoardListUpdateLimitMetricsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
limitMetric ListLimitMetric New limit metric type for the list.
listId ListID! Global ID of the list.
maxIssueCount Int New maximum issue count limit.
maxIssueWeight Int New maximum issue weight limit.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list BoardList Updated list.

Mutation.branchRuleCreate

NOTE: Introduced in 16.7. Status: Experiment.

Input type: BranchRuleCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Branch name, with wildcards, for the branch rules.
projectPath ID! Full path to the project that the branch is associated with.

Fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.branchRuleDelete

NOTE: Introduced in 16.9. Status: Experiment.

Input type: BranchRuleDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectsBranchRuleID! Global ID of the branch rule to destroy.

Fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.branchRuleUpdate

NOTE: Introduced in 16.7. Status: Experiment.

Input type: BranchRuleUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProtectedBranchID! Global ID of the protected branch.
name String! Branch name, with wildcards, for the branch rules.
projectPath ID! Full path to the project that the branch is associated with.

Fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.buildForecast

NOTE: Introduced in 16.0. Status: Experiment.

Input type: BuildForecastInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
contextId GlobalID! Global ID of the context for the forecast to pick an appropriate model.
horizon Int! Number of data points to forecast.
type String! Type of the forecast.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
forecast Forecast! Created forecast.

Mutation.bulkDestroyJobArtifacts

NOTE: Introduced in 15.10. Status: Experiment.

Input type: BulkDestroyJobArtifactsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [CiJobArtifactID!]! Global IDs of the job artifacts to destroy.
projectId ProjectID! Global Project ID of the job artifacts to destroy. Incompatible with projectPath.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destroyedCount Int Number of job artifacts deleted.
destroyedIds [CiJobArtifactID!] IDs of job artifacts that were deleted.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.bulkEnableDevopsAdoptionNamespaces

Status: Beta.

Input type: BulkEnableDevopsAdoptionNamespacesInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
displayNamespaceId NamespaceID Display namespace ID.
namespaceIds [NamespaceID!]! List of Namespace IDs.

Fields

Name Type Description
clientMutationId String A 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

NOTE: Introduced in 15.3. Status: Experiment.

Input type: BulkRunnerDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [CiRunnerID!] IDs of the runners to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
deletedCount Int Number 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.catalogResourcesCreate

NOTE: Introduced in 15.11. Status: Experiment.

Input type: CatalogResourcesCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project path belonging to the catalog resource.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.catalogResourcesDestroy

NOTE: Introduced in 16.6. Status: Experiment.

Input type: CatalogResourcesDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project path belonging to the catalog resource.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeAddGroupOrProject

Input type: CiJobTokenScopeAddGroupOrProjectInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project that the CI job token scope belongs to.
targetPath ID! Group or project to be added to the CI job token scope.

Fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token's access scope.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeAddProject

Input type: CiJobTokenScopeAddProjectInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
direction {warning-solid} CiJobTokenScopeDirection Deprecated: Outbound job token scope is being removed. This field can now only be set to INBOUND. Deprecated in 16.0.
projectPath ID! Project that the CI job token scope belongs to.
targetProjectPath ID! Project to be added to the CI job token scope.

Fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token's access scope.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeRemoveGroup

Input type: CiJobTokenScopeRemoveGroupInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project that the CI job token scope belongs to.
targetGroupPath ID! Group to be removed from the CI job token scope.

Fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token's access scope.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeRemoveProject

Input type: CiJobTokenScopeRemoveProjectInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
direction CiJobTokenScopeDirection Direction of access, which defaults to outbound.
projectPath ID! Project that the CI job token scope belongs to.
targetProjectPath ID! Project to be removed from the CI job token scope.

Fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token's scope of access.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.clusterAgentDelete

Input type: ClusterAgentDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ClustersAgentID! Global ID of the cluster agent that will be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.clusterAgentTokenCreate

Input type: ClusterAgentTokenCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID! Global ID of the cluster agent that will be associated with the new token.
description String Description of the token.
name String! Name of the token.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
secret String Token secret value. Make sure you save it - you won't be able to access it again.
token ClusterAgentToken Token created after mutation.

Mutation.clusterAgentTokenRevoke

Input type: ClusterAgentTokenRevokeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ClustersAgentTokenID! Global ID of the agent token that will be revoked.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.commitCreate

Input type: CommitCreateInput

Arguments

Name Type Description
actions [CommitAction!]! Array of action hashes to commit as a batch.
branch String! Name of the branch to commit into, it can be a new branch.
clientMutationId String A unique identifier for the client performing the mutation.
message String! Raw commit message.
projectPath ID! Project full path the branch is associated with.
startBranch String If on a new branch, name of the original branch.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
commit Commit Commit after mutation.
commitPipelinePath String ETag 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
configuration SastCiConfigurationInput! SAST CI configuration for the project.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

Mutation.corpusCreate

Input type: CorpusCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Project the corpus belongs to.
packageId PackagesPackageID! ID of the corpus package.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createAlertIssue

Input type: CreateAlertIssueInput

Arguments

Name Type Description
clientMutationId String A 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

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.createAnnotation

NOTE: Deprecated in 16.0. Underlying feature was removed in 16.0.

Input type: CreateAnnotationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterId ClustersClusterID Global 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 Time Timestamp indicating ending moment to which the annotation relates.
environmentId EnvironmentID Global ID of the environment to add an annotation to.
startingAt Time! Timestamp indicating starting moment to which the annotation relates.

Fields

Name Type Description
annotation MetricsDashboardAnnotation Created annotation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createBoard

Input type: CreateBoardInput

Arguments

Name Type Description
assigneeId UserID ID of user to be assigned to the board.
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID Full path of the group with which the resource is associated.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
iterationCadenceId IterationsCadenceID ID of iteration cadence to be assigned to the board.
iterationId IterationID ID of iteration to be assigned to the board.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
milestoneId MilestoneID ID of milestone to be assigned to the board.
name String Board name.
projectPath ID Full path of the project with which the resource is associated.
weight Int Weight value to be assigned to the board.

Fields

Name Type Description
board Board Board after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createBranch

Input type: CreateBranchInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Name of the branch.
projectPath ID! Project full path the branch is associated with.
ref String! Branch name or commit SHA to create branch from.

Fields

Name Type Description
branch Branch Branch after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createClusterAgent

Input type: CreateClusterAgentInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Name of the cluster agent.
projectPath ID! Full path of the associated project for the cluster agent.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgent ClusterAgent Cluster agent created after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createComplianceFramework

Input type: CreateComplianceFrameworkInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespacePath ID! Full path of the namespace to add the compliance framework to.
params ComplianceFrameworkInput! Parameters to update the compliance framework with.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
framework ComplianceFramework Created compliance framework.

Mutation.createContainerRegistryProtectionRule

Creates a protection rule to restrict access to a project's container registry. Available only when feature flag container_registry_protected_containers is enabled.

NOTE: Introduced in 16.6. Status: Experiment.

Input type: CreateContainerRegistryProtectionRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
deleteProtectedUpToAccessLevel ContainerRegistryProtectionRuleAccessLevel! Max GitLab access level to prevent from deleting container images in the container registry. For example DEVELOPER, MAINTAINER, OWNER.
projectPath ID! Full path of the project where a protection rule is located.
pushProtectedUpToAccessLevel ContainerRegistryProtectionRuleAccessLevel! Max GitLab access level to prevent from pushing container images to the container registry. For example DEVELOPER, MAINTAINER, OWNER.
repositoryPathPattern String! Container repository path pattern protected by the protection rule. For example my-project/my-container-*. Wildcard character * allowed.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerRegistryProtectionRule ContainerRegistryProtectionRule Container registry protection rule after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createCustomEmoji

Input type: CreateCustomEmojiInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID! Namespace full path the emoji is associated with.
name String! Name of the emoji.
url String! Location of the emoji file.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
customEmoji CustomEmoji New custom emoji.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createDiffNote

Input type: CreateDiffNoteInput

Arguments

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
confidential {warning-solid} Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
internal Boolean Internal 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.

Mutation.createDiscussion

Input type: CreateDiscussionInput

Arguments

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
confidential {warning-solid} Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
internal Boolean Internal flag for a note. Default is false.
noteableId NoteableID! Global ID of the resource to add a note to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.

Mutation.createEpic

Input type: CreateEpicInput

Arguments

Name Type Description
addLabelIds [ID!] IDs of labels to be added to the epic.
addLabels [String!] Array of labels to be added to the epic.
clientMutationId String A unique identifier for the client performing the mutation.
color Color Color 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 Boolean Indicates if the epic is confidential.
description String Description of the epic.
dueDateFixed String End date of the epic.
dueDateIsFixed Boolean Indicates 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 String Start date of the epic.
startDateIsFixed Boolean Indicates start date should be sourced from start_date_fixed field not the issue milestones.
title String Title of the epic.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Created epic.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createImageDiffNote

Input type: CreateImageDiffNoteInput

Arguments

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
confidential {warning-solid} Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
internal Boolean Internal 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.

Mutation.createIssue

Input type: CreateIssueInput

Arguments

Name Type Description
assigneeIds [UserID!] Array of user IDs to assign to the issue.
clientMutationId String A unique identifier for the client performing the mutation.
confidential Boolean Indicates the issue is confidential.
createdAt Time Timestamp when the issue was created. Available only for admins and project owners.
description String Description of the issue.
discussionToResolve String ID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of.
dueDate ISO8601Date Due date of the issue.
epicId EpicID ID of an epic to associate the issue with.
healthStatus HealthStatus Desired health status.
iid Int IID (internal ID) of a project issue. Only admins and project owners can modify.
iterationCadenceId IterationsCadenceID Global iteration cadence ID. Required when iterationWildcardId is provided.
iterationId IterationID Global iteration ID. Mutually exlusive argument with iterationWildcardId.
iterationWildcardId IssueCreationIterationWildcardId Iteration 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 Boolean Indicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOf MergeRequestID IID of a merge request for which to resolve discussions.
milestoneId MilestoneID ID of the milestone to assign to the issue. On update milestone will be removed if set to null.
moveAfterId IssueID Global ID of issue that should be placed after the current issue.
moveBeforeId IssueID Global 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 IssueType Type of the issue.
weight Int Weight of the issue.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.createIteration

NOTE: Deprecated in 14.0. Use iterationCreate.

Input type: CreateIterationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the iteration.
dueDate String End date of the iteration.
groupPath ID Full path of the group with which the resource is associated.
iterationsCadenceId IterationsCadenceID Global ID of the iteration cadence to be assigned to the new iteration.
projectPath ID Full path of the project with which the resource is associated.
startDate String Start date of the iteration.
title String Title of the iteration.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
iteration Iteration Created 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

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
confidential {warning-solid} Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
discussionId DiscussionID Global ID of the discussion the note is in reply to.
internal Boolean Internal flag for a note. Default is false.
mergeRequestDiffHeadSha String SHA 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.

Mutation.createPackagesProtectionRule

Creates a protection rule to restrict access to project packages. Available only when feature flag packages_protected_packages is enabled.

NOTE: Introduced in 16.5. Status: Experiment.

Input type: CreatePackagesProtectionRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
packageNamePattern String! Package name protected by the protection rule. For example @my-scope/my-package-*. Wildcard character * allowed.
packageType PackagesProtectionRulePackageType! Package type protected by the protection rule. For example NPM.
projectPath ID! Full path of the project where a protection rule is located.
pushProtectedUpToAccessLevel PackagesProtectionRuleAccessLevel! Max GitLab access level unable to push a package. For example DEVELOPER, MAINTAINER, OWNER.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
packageProtectionRule PackagesProtectionRule Packages protection rule after mutation.

Mutation.createRequirement

Input type: CreateRequirementInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the requirement.
projectPath ID! Full project path the requirement is associated with.
title String Title of the requirement.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requirement Requirement Requirement after mutation.

Mutation.createSnippet

Input type: CreateSnippetInput

Arguments

Name Type Description
blobActions [SnippetBlobActionInputType!] Actions to perform over the snippet repository and blobs.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the snippet.
projectPath ID Full 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
snippet Snippet Snippet after mutation.

Mutation.createTestCase

Input type: CreateTestCaseInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
confidential Boolean Sets the test case confidentiality.
description String Test 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
testCase Issue Test case created.

Mutation.customerRelationsContactCreate

Input type: CustomerRelationsContactCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the contact.
email String Email 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 CustomerRelationsOrganizationID Organization for the contact.
phone String Phone number of the contact.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
contact CustomerRelationsContact Contact after the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.customerRelationsContactUpdate

Input type: CustomerRelationsContactUpdateInput

Arguments

Name Type Description
active Boolean State of the contact.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the contact.
email String Email address of the contact.
firstName String First name of the contact.
id CustomerRelationsContactID! Global ID of the contact.
lastName String Last name of the contact.
organizationId CustomerRelationsOrganizationID Organization of the contact.
phone String Phone number of the contact.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
contact CustomerRelationsContact Contact after the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.customerRelationsOrganizationCreate

Input type: CustomerRelationsOrganizationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
defaultRate Float Standard billing rate for the organization.
description String Description of or notes for the organization.
groupId GroupID! Group for the organization.
name String! Name of the organization.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
organization CustomerRelationsOrganization Organization after the mutation.

Mutation.customerRelationsOrganizationUpdate

Input type: CustomerRelationsOrganizationUpdateInput

Arguments

Name Type Description
active Boolean State of the organization.
clientMutationId String A unique identifier for the client performing the mutation.
defaultRate Float Standard billing rate for the organization.
description String Description of or notes for the organization.
id CustomerRelationsOrganizationID! Global ID of the organization.
name String Name of the organization.

Fields

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastScannerProfileId DastScannerProfileID ID of the scanner profile to be used for the scan.
dastSiteProfileId DastSiteProfileID! ID of the site profile to be used for the scan.
fullPath ID! Project the site profile belongs to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineUrl String URL of the pipeline that was created.

Mutation.dastProfileCreate

Input type: DastProfileCreateInput

Arguments

Name Type Description
branchName String Associated branch.
clientMutationId String A unique identifier for the client performing the mutation.
dastProfileSchedule DastProfileScheduleInput Represents 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 String Description of the profile. Defaults to an empty string.
fullPath ID! Project the profile belongs to.
name String! Name of the profile.
runAfterCreate Boolean Run scan using profile after creation. Defaults to false.
tagList [String!] Indicates the runner tags associated with the profile.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastProfile DastProfile Created profile.
errors [String!]! Errors encountered during execution of the mutation.
pipelineUrl String URL of the pipeline that was created. Requires runAfterCreate to be set to true.

Mutation.dastProfileDelete

Input type: DastProfileDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id DastProfileID! ID of the profile to be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.dastProfileRun

Input type: DastProfileRunInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath {warning-solid} 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineUrl String URL of the pipeline that was created.

Mutation.dastProfileUpdate

Input type: DastProfileUpdateInput

Arguments

Name Type Description
branchName String Associated branch.
clientMutationId String A unique identifier for the client performing the mutation.
dastProfileSchedule DastProfileScheduleInput Represents 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 String Description of the profile. Defaults to an empty string.
fullPath {warning-solid} ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastProfileID! ID of the profile to be deleted.
name String Name of the profile.
runAfterUpdate Boolean Run scan using profile after update. Defaults to false.
tagList [String!] Indicates the runner tags associated with the profile.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastProfile DastProfile Updated profile.
errors [String!]! Errors encountered during execution of the mutation.
pipelineUrl String The URL of the pipeline that was created. Requires the input argument runAfterUpdate to be set to true when calling the mutation, otherwise no pipeline will be created.

Mutation.dastScannerProfileCreate

Input type: DastScannerProfileCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Project the scanner profile belongs to.
profileName String! Name of the scanner profile.
scanType DastScanTypeEnum Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages Boolean Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout Int Maximum number of minutes allowed for the spider to traverse the site.
tagList {warning-solid} [String!] Deprecated: Moved to DastProfile. Deprecated in 15.8.
targetTimeout Int Maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider Boolean Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastScannerProfile DastScannerProfile Created scanner profile.
errors [String!]! Errors encountered during execution of the mutation.
id {warning-solid} DastScannerProfileID Deprecated: use dastScannerProfile field. Deprecated in 14.10.

Mutation.dastScannerProfileDelete

Input type: DastScannerProfileDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath {warning-solid} 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.dastScannerProfileUpdate

Input type: DastScannerProfileUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath {warning-solid} 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 DastScanTypeEnum Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages Boolean Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout Int! Maximum number of minutes allowed for the spider to traverse the site.
tagList {warning-solid} [String!] Deprecated: Moved to DastProfile. Deprecated in 15.8.
targetTimeout Int! Maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider Boolean Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastScannerProfile DastScannerProfile Updated scanner profile.
errors [String!]! Errors encountered during execution of the mutation.
id {warning-solid} DastScannerProfileID Deprecated: use dastScannerProfile field. Deprecated in 14.10.

Mutation.dastSiteProfileCreate

Input type: DastSiteProfileCreateInput

Arguments

Name Type Description
auth DastSiteProfileAuthInput Parameters for authentication.
clientMutationId String A 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 String Comma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath String File Path or URL used as input for the scan method.
scanMethod DastScanMethodType Scan method by the scanner.
targetType DastTargetTypeEnum Type of target to be scanned.
targetUrl String URL of the target to be scanned.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastSiteProfile DastSiteProfile Site Profile object.
errors [String!]! Errors encountered during execution of the mutation.
id {warning-solid} DastSiteProfileID Deprecated: use dastSiteProfile.id field. Deprecated in 14.10.

Mutation.dastSiteProfileDelete

Input type: DastSiteProfileDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath {warning-solid} 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.dastSiteProfileUpdate

Input type: DastSiteProfileUpdateInput

Arguments

Name Type Description
auth DastSiteProfileAuthInput Parameters for authentication.
clientMutationId String A unique identifier for the client performing the mutation.
excludedUrls [String!] URLs to skip during an authenticated scan.
fullPath {warning-solid} 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 String Comma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath String File Path or URL used as input for the scan method.
scanMethod DastScanMethodType Scan method by the scanner.
targetType DastTargetTypeEnum Type of target to be scanned.
targetUrl String URL of the target to be scanned.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastSiteProfile DastSiteProfile Site profile object.
errors [String!]! Errors encountered during execution of the mutation.
id {warning-solid} DastSiteProfileID Deprecated: use dastSiteProfile.id field. Deprecated in 14.10.

Mutation.dastSiteTokenCreate

Input type: DastSiteTokenCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Project the site token belongs to.
targetUrl String URL of the target to be validated.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
id DastSiteTokenID ID of the site token.
status DastSiteProfileValidationStatusEnum Current validation status of the target.
token String Token string.

Mutation.dastSiteValidationCreate

Input type: DastSiteValidationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastSiteTokenId DastSiteTokenID! ID of the site token.
fullPath ID! Project the site profile belongs to.
strategy DastSiteValidationStrategyEnum Validation strategy to be used.
validationPath String! Path to be requested during validation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
id DastSiteValidationID ID of the site validation.
status DastSiteProfileValidationStatusEnum Current validation status.

Mutation.dastSiteValidationRevoke

Input type: DastSiteValidationRevokeInput

Arguments

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.deleteAnnotation

NOTE: Deprecated in 16.0. Underlying feature was removed in 16.0.

Input type: DeleteAnnotationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id String! Global ID of the annotation to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.deleteContainerRegistryProtectionRule

Deletes a container registry protection rule. Available only when feature flag container_registry_protected_containers is enabled.

NOTE: Introduced in 16.7. Status: Experiment.

Input type: DeleteContainerRegistryProtectionRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ContainerRegistryProtectionRuleID! Global ID of the container registry protection rule to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerRegistryProtectionRule ContainerRegistryProtectionRule Container registry protection rule that was deleted successfully.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.deletePackagesProtectionRule

Deletes a protection rule for packages. Available only when feature flag packages_protected_packages is enabled.

NOTE: Introduced in 16.6. Status: Experiment.

Input type: DeletePackagesProtectionRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PackagesProtectionRuleID! Global ID of the package protection rule to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
packageProtectionRule PackagesProtectionRule Packages protection rule that was deleted successfully.

Mutation.designManagementDelete

Input type: DesignManagementDeleteInput

Arguments

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
version DesignVersion New version in which the designs are deleted.

Mutation.designManagementMove

Input type: DesignManagementMoveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id DesignManagementDesignID! ID of the design to move.
next DesignManagementDesignID ID of the immediately following design.
previous DesignManagementDesignID ID of the immediately preceding design.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
designCollection DesignCollection Current state of the collection.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.designManagementUpdate

Input type: DesignManagementUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the design.
id DesignManagementDesignID! ID of the design to update.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
design Design! Updated design.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.designManagementUpload

Input type: DesignManagementUploadInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
files [Upload!]! 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

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id BoardID! Global ID of the board to destroy.

Fields

Name Type Description
board Board Board after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyBoardList

Input type: DestroyBoardListInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
listId ListID! Global ID of the list to destroy. Only label lists are accepted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list BoardList List after mutation.

Mutation.destroyComplianceFramework

Input type: DestroyComplianceFrameworkInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ComplianceManagementFrameworkID! Global ID of the compliance framework to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyContainerRepository

Input type: DestroyContainerRepositoryInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ContainerRepositoryID! ID of the container repository.

Fields

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

Mutation.destroyContainerRepositoryTags

Input type: DestroyContainerRepositoryTagsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ContainerRepositoryID! ID of the container repository.
tagNames [String!]! Container repository tag(s) to delete. Total number can't be greater than 20.

Fields

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

Mutation.destroyCustomEmoji

Input type: DestroyCustomEmojiInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CustomEmojiID! Global ID of the custom emoji to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
customEmoji CustomEmoji Deleted custom emoji.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyEpicBoard

Input type: DestroyEpicBoardInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id BoardsEpicBoardID! Global ID of the board to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicBoard EpicBoard Epic board after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyNote

Input type: DestroyNoteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id NoteID! Global ID of the note to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.

Mutation.destroyPackage

Input type: DestroyPackageInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PackagesPackageID! ID of the Package.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyPackageFile

Input type: DestroyPackageFileInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PackagesPackageFileID! ID of the Package file.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyPackageFiles

Input type: DestroyPackageFilesInput

Arguments

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyPackages

Input type: DestroyPackagesInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [PackagesPackageID!]! Global IDs of the Packages. Max 20.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroySnippet

Input type: DestroySnippetInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id SnippetID! Global ID of the snippet to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
snippet Snippet Snippet after mutation.

Mutation.disableDevopsAdoptionNamespace

Status: Beta.

Input type: DisableDevopsAdoptionNamespaceInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id [AnalyticsDevopsAdoptionEnabledNamespaceID!]! One or many IDs of the enabled namespaces to disable.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.discussionToggleResolve

Toggles the resolved state of a discussion.

Input type: DiscussionToggleResolveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id DiscussionID! Global ID of the discussion.
resolve Boolean! Will resolve the discussion when true, and unresolve the discussion when false.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
discussion Discussion Discussion 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!] Errors to return to the user.
messages [String!] Messages to return to the user.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
echoes [String!] Messages returned to the user.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.enableDevopsAdoptionNamespace

Status: Beta.

Input type: EnableDevopsAdoptionNamespaceInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
displayNamespaceId NamespaceID Display namespace ID.
namespaceId NamespaceID! Namespace ID.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enabledNamespace DevopsAdoptionEnabledNamespace Enabled namespace after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentCreate

Create an environment.

Input type: EnvironmentCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID Cluster agent of the environment.
externalUrl String External URL of the environment.
fluxResourcePath String Flux resource path of the environment.
kubernetesNamespace String Kubernetes namespace of the environment.
name String! Name of the environment.
projectPath ID! Full path of the project.
tier DeploymentTier Tier of the environment.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
environment Environment Created environment.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentDelete

Delete an environment.

Input type: EnvironmentDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id EnvironmentID! Global ID of the environment to Delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentStop

Stop an environment.

Input type: EnvironmentStopInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
force Boolean Force environment to stop without executing on_stop actions.
id EnvironmentID! Global ID of the environment to stop.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
environment Environment Environment after attempt to stop.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentUpdate

Update an environment.

Input type: EnvironmentUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID Cluster agent of the environment.
externalUrl String External URL of the environment.
fluxResourcePath String Flux resource path of the environment.
id EnvironmentID! Global ID of the environment to update.
kubernetesNamespace String Kubernetes namespace of the environment.
tier DeploymentTier Tier of the environment.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
environment Environment Environment after attempt to update.
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

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicAddIssue

Input type: EpicAddIssueInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID! 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after mutation.
epicIssue EpicIssue Epic-issue relationship.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicBoardCreate

Input type: EpicBoardCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
displayColors Boolean Whether or not display epic colors. Ignored unless epic_color_highlight flag is enabled.
groupPath ID Full path of the group with which the resource is associated.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
name String Board name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicBoard EpicBoard Created epic board.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicBoardListCreate

Input type: EpicBoardListCreateInput

Arguments

Name Type Description
backlog Boolean Create the backlog list.
boardId BoardsEpicBoardID! Global ID of the issue board to mutate.
clientMutationId String A unique identifier for the client performing the mutation.
labelId LabelID Global ID of an existing label.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list EpicList Epic list in the epic board.

Mutation.epicBoardListDestroy

Destroys an epic board list.

Input type: EpicBoardListDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
listId BoardsEpicListID! Global ID of the epic board list to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list EpicList Epic board list. null if the board was destroyed successfully.

Mutation.epicBoardUpdate

Input type: EpicBoardUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
displayColors Boolean Whether or not display epic colors. Ignored unless epic_color_highlight flag is enabled.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether 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 String Board name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicBoard EpicBoard Updated epic board.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicMoveList

Input type: EpicMoveListInput

Arguments

Name Type Description
boardId BoardsEpicBoardID! Global ID of the board that the epic is in.
clientMutationId String A unique identifier for the client performing the mutation.
epicId EpicID! ID of the epic to mutate.
fromListId BoardsEpicListID ID of the board list that the epic will be moved from. Required if moving between lists.
moveAfterId EpicID ID of epic that should be placed after the current epic.
moveBeforeId EpicID ID of epic that should be placed before the current epic.
positionInList Int Position of epics within the board list. Positions start at 0. Use -1 to move to the end of the list.
toListId BoardsEpicListID! ID of the list the epic will be in after mutation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicSetSubscription

Input type: EpicSetSubscriptionInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID! Group the epic to mutate belongs to.
iid ID! IID of the epic to mutate.
subscribedState Boolean! Desired state of the subscription.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicTreeReorder

Input type: EpicTreeReorderInput

Arguments

Name Type Description
baseEpicId EpicID! ID of the base epic of the tree.
clientMutationId String A unique identifier for the client performing the mutation.
moved EpicTreeNodeFieldsInputType! Parameters for updating the tree positions.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.escalationPolicyCreate

Input type: EscalationPolicyCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

Mutation.escalationPolicyDestroy

Input type: EscalationPolicyDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IncidentManagementEscalationPolicyID! Escalation policy internal ID to remove.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

Mutation.escalationPolicyUpdate

Input type: EscalationPolicyUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the escalation policy.
id IncidentManagementEscalationPolicyID! ID of the on-call schedule to create the on-call rotation in.
name String Name of the escalation policy.
rules [EscalationRuleInput!] Steps of the escalation policy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

Mutation.exportRequirements

Input type: ExportRequirementsInput

Arguments

Name Type Description
authorUsername [String!] Filter requirements by author username.
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full project path the requirements are associated with.
search String Search query for requirement title.
selectedFields [String!] List of selected requirements fields to be exported.
sort Sort List requirements by sort order.
state RequirementState Filter requirements by state.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.externalAuditEventDestinationCreate

Input type: ExternalAuditEventDestinationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationUrl String! Destination URL.
groupPath ID! Group path.
name String Destination name.
verificationToken String Verification token.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalAuditEventDestination ExternalAuditEventDestination Destination created.

Mutation.externalAuditEventDestinationDestroy

Input type: ExternalAuditEventDestinationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsExternalAuditEventDestinationID! ID of external audit event destination to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.externalAuditEventDestinationUpdate

Input type: ExternalAuditEventDestinationUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationUrl String Destination URL to change.
id AuditEventsExternalAuditEventDestinationID! ID of external audit event destination to update.
name String Destination name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalAuditEventDestination ExternalAuditEventDestination Updated destination.

Mutation.geoRegistriesBulkUpdate

Mutates multiple Geo registries for a given registry class.

NOTE: Introduced in 16.4. Status: Experiment.

Input type: GeoRegistriesBulkUpdateInput

Arguments

Name Type Description
action GeoRegistriesBulkAction! Action to be executed on Geo registries.
clientMutationId String A unique identifier for the client performing the mutation.
registryClass GeoRegistryClass! Class of the Geo registries to be updated.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
registryClass GeoRegistryClass Updated Geo registry class.

Mutation.geoRegistriesUpdate

Mutates a Geo registry.

NOTE: Introduced in 16.1. Status: Experiment.

Input type: GeoRegistriesUpdateInput

Arguments

Name Type Description
action GeoRegistryAction! Action to be executed on a Geo registry.
clientMutationId String A unique identifier for the client performing the mutation.
registryClass GeoRegistryClass Class of the Geo registry to be updated.
registryId GeoBaseRegistryID! ID of the Geo registry entry to be updated.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
registry Registrable Updated Geo registry entry.

Mutation.gitlabSubscriptionActivate

Input type: GitlabSubscriptionActivateInput

Arguments

Name Type Description
activationCode String! Activation code received after purchasing a GitLab subscription.
clientMutationId String A unique identifier for the client performing the mutation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
futureSubscriptions [SubscriptionFutureEntry!] Array of future subscriptions.
license CurrentLicense Current license.

Mutation.googleCloudLoggingConfigurationCreate

Input type: GoogleCloudLoggingConfigurationCreateInput

Arguments

Name Type Description
clientEmail String! Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationId String A unique identifier for the client performing the mutation.
googleProjectIdName String! Unique identifier of the Google Cloud project to which the logging configuration belongs.
groupPath ID! Group path.
logIdName String Unique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events).
name String Destination name.
privateKey String! Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
googleCloudLoggingConfiguration GoogleCloudLoggingConfigurationType configuration created.

Mutation.googleCloudLoggingConfigurationDestroy

Input type: GoogleCloudLoggingConfigurationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsGoogleCloudLoggingConfigurationID! ID of the Google Cloud logging configuration to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.googleCloudLoggingConfigurationUpdate

Input type: GoogleCloudLoggingConfigurationUpdateInput

Arguments

Name Type Description
clientEmail String Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationId String A unique identifier for the client performing the mutation.
googleProjectIdName String Unique identifier of the Google Cloud project to which the logging configuration belongs.
id AuditEventsGoogleCloudLoggingConfigurationID! ID of the google Cloud configuration to update.
logIdName String Unique identifier used to distinguish and manage different logs within the same Google Cloud project.
name String Destination name.
privateKey String Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
googleCloudLoggingConfiguration GoogleCloudLoggingConfigurationType configuration updated.

Mutation.groupMemberBulkUpdate

Input type: GroupMemberBulkUpdateInput

Arguments

Name Type Description
accessLevel MemberAccessLevel! Access level to update the members to.
clientMutationId String A unique identifier for the client performing the mutation.
expiresAt Time Date and time the membership expires.
groupId GroupID! Global ID of the group.
userIds [UserID!]! Global IDs of the members.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
groupMembers [GroupMember!] Group members after mutation.

Mutation.groupUpdate

Input type: GroupUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Full path of the group that will be updated.
lockMathRenderingLimitsEnabled Boolean Indicates if math rendering limits are locked for all descendant groups.
mathRenderingLimitsEnabled Boolean Indicates if math rendering limits are used for this group.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
group Group Group after update.

Mutation.httpIntegrationCreate

Input type: HttpIntegrationCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegration HTTP integration.

Mutation.httpIntegrationDestroy

Input type: HttpIntegrationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID! ID of the integration to remove.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegration HTTP integration.

Mutation.httpIntegrationResetToken

Input type: HttpIntegrationResetTokenInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID! ID of the integration to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegration HTTP integration.

Mutation.httpIntegrationUpdate

Input type: HttpIntegrationUpdateInput

Arguments

Name Type Description
active Boolean Whether the integration is receiving alerts.
clientMutationId String A unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID! ID of the integration to mutate.
name String Name of the integration.
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!] Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonString Example of an alert payload.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegration HTTP integration.

Mutation.instanceExternalAuditEventDestinationCreate

Input type: InstanceExternalAuditEventDestinationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationUrl String! Destination URL.
name String Destination name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceExternalAuditEventDestination InstanceExternalAuditEventDestination Destination created.

Mutation.instanceExternalAuditEventDestinationDestroy

Input type: InstanceExternalAuditEventDestinationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceExternalAuditEventDestinationID! ID of the external instance audit event destination to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.instanceExternalAuditEventDestinationUpdate

Input type: InstanceExternalAuditEventDestinationUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationUrl String Destination URL to change.
id AuditEventsInstanceExternalAuditEventDestinationID! ID of the external instance audit event destination to update.
name String Destination name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceExternalAuditEventDestination InstanceExternalAuditEventDestination Updated destination.

Mutation.instanceGoogleCloudLoggingConfigurationCreate

Input type: InstanceGoogleCloudLoggingConfigurationCreateInput

Arguments

Name Type Description
clientEmail String! Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationId String A unique identifier for the client performing the mutation.
googleProjectIdName String! Unique identifier of the Google Cloud project to which the logging configuration belongs.
logIdName String Unique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events).
name String Destination name.
privateKey String! Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceGoogleCloudLoggingConfiguration InstanceGoogleCloudLoggingConfigurationType configuration created.

Mutation.instanceGoogleCloudLoggingConfigurationDestroy

Input type: InstanceGoogleCloudLoggingConfigurationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceGoogleCloudLoggingConfigurationID! ID of the Google Cloud logging configuration to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.instanceGoogleCloudLoggingConfigurationUpdate

Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput

Arguments

Name Type Description
clientEmail String Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationId String A unique identifier for the client performing the mutation.
googleProjectIdName String Unique identifier of the Google Cloud project to which the logging configuration belongs.
id AuditEventsInstanceGoogleCloudLoggingConfigurationID! ID of the instance google Cloud configuration to update.
logIdName String Unique identifier used to distinguish and manage different logs within the same Google Cloud project.
name String Destination name.
privateKey String Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceGoogleCloudLoggingConfiguration InstanceGoogleCloudLoggingConfigurationType configuration updated.

Mutation.issuableResourceLinkCreate

Input type: IssuableResourceLinkCreateInput

Arguments

Name Type Description
clientMutationId String A 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 String Link text of the resource.
linkType IssuableResourceLinkType Link type of the resource.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issuableResourceLink IssuableResourceLink Issuable resource link.

Mutation.issuableResourceLinkDestroy

Input type: IssuableResourceLinkDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IncidentManagementIssuableResourceLinkID! Issuable resource link ID to remove.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issuableResourceLink IssuableResourceLink Issuable resource link.

Mutation.issueLinkAlerts

Input type: IssueLinkAlertsInput

Arguments

Name Type Description
alertReferences [String!]! Alerts references to be linked to the incident.
clientMutationId String A 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.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueMove

Input type: IssueMoveInput

Arguments

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueMoveList

Input type: IssueMoveListInput

Arguments

Name Type Description
boardId BoardID! Global ID of the board that the issue is in.
clientMutationId String A unique identifier for the client performing the mutation.
epicId EpicID ID of the parent epic. NULL when removing the association.
fromListId ID ID of the board list that the issue will be moved from.
iid String! IID of the issue to mutate.
moveAfterId ID ID of issue that should be placed after the current issue.
moveBeforeId ID ID of issue that should be placed before the current issue.
positionInList Int Position 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 ID ID of the board list that the issue will be moved to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetAssignees

Input type: IssueSetAssigneesInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetConfidential

Input type: IssueSetConfidentialInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetCrmContacts

Input type: IssueSetCrmContactsInput

Arguments

Name Type Description
clientMutationId String A 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 MutationOperationMode Changes the operation mode. Defaults to REPLACE.
projectPath ID! Project the issue to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetDueDate

Input type: IssueSetDueDateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dueDate Time Desired 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetEpic

Input type: IssueSetEpicInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicId EpicID Global ID of the epic to be assigned to the issue, epic will be removed if absent or set to null.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetEscalationPolicy

Input type: IssueSetEscalationPolicyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
escalationPolicyId IncidentManagementEscalationPolicyID Global 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetEscalationStatus

Input type: IssueSetEscalationStatusInput

Arguments

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetIteration

Input type: IssueSetIterationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the issue to mutate.
iterationId IterationID Iteration to assign to the issue.
projectPath ID! Project the issue to mutate is in.

Fields

Name Type Description
clientMutationId String A