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. Developers can also generate a machine-readable GraphQL schema in IDL and JSON formats.

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.

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

Introduced in GitLab 16.3. Status: Experiment.

Find an abuse report.

Returns AbuseReport.

Arguments

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

Query.abuseReportLabels

Introduced in GitLab 16.3. Status: Experiment.

Abuse report labels.

Returns AbuseReportLabelConnection.

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

Retrieve all active add-on purchases. This query can be used in GitLab.com and self-managed environments.

Returns [AddOnPurchase!].

Arguments

Name	Type	Description
namespaceId	NamespaceID	ID of namespace that the add-ons were purchased for.

Query.adminGroups

Introduced in GitLab 18.4. Status: Experiment.

Find groups visible to the current admin.

Returns GroupInterfaceConnection.

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	Boolean	When nil (default value), returns all groups. When true, returns only groups that are not pending deletion. When false, only returns groups that are pending deletion.
allAvailable	Boolean	When true, returns all accessible groups. When false, returns only groups where the user is a member. Unauthenticated requests always return all public groups. The owned_only argument takes precedence.
ids	[ID!]	Filter groups by IDs.
markedForDeletionOn	Date	Date when the group was marked for deletion.
ownedOnly	Boolean	Only include groups where the current user has an owner role.
parentPath	ID	Full path of the parent group.
search	String	Search query for group name or group full path.
sort	String	Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topLevelOnly	Boolean	Only include top-level groups.

Query.adminMemberRole

Introduced in GitLab 17.10. Status: Experiment.

Finds a single admin custom role for the instance. Available only for GitLab Self-Managed.

Returns AdminMemberRole.

Arguments

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

Query.adminMemberRolePermissions

Introduced in GitLab 17.9. Status: Experiment.

List of all admin customizable permissions.

Returns CustomizableAdminPermissionConnection.

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

Query.adminMemberRoles

Introduced in GitLab 17.10. Status: Experiment.

Admin custom roles available for the instance. Available only for GitLab Self-Managed.

Returns AdminMemberRoleConnection.

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.
ids	[MemberRoleID!]	Global IDs of the member role to look up.
orderBy	MemberRolesOrderBy	Ordering column. Default is NAME.
sort	SortDirectionEnum	Ordering column. Default is ASC.

Query.adminProjects

Introduced in GitLab 18.4. Status: Experiment.

Find projects visible to the current admin.

Returns ProjectInterfaceConnection.

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	Boolean	Filters by projects that are not archived and not marked for deletion.
aimedForDeletion	Boolean	Return only projects marked for deletion.
archived	ProjectArchived	Filter projects by archived status.
fullPaths	[String!]	Filter projects by full paths. You cannot provide more than 50 full paths.
ids	[ID!]	Filter projects by IDs.
includeHidden	Boolean	Include hidden projects.
lastRepositoryCheckFailed	Boolean	Return only projects where the last repository check failed. Only available for administrators.
markedForDeletionOn	Date	Date when the project was marked for deletion.
membership	Boolean	Return only projects that the current user is a member of.
minAccessLevel	AccessLevelEnum	Return only projects where current user has at least the specified access level.
namespacePath	ID	Filter projects by their namespace's full path (group or user).
notAimedForDeletion	Boolean	Exclude projects that are marked for deletion.
personal	Boolean	Return only personal projects.
programmingLanguageName	String	Filter projects by programming language name (case insensitive). For example: "css" or "ruby".
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. Defaults to id_desc, or similarity if search used.
topics	[String!]	Filter projects by topics.
trending	Boolean	Return only projects that are trending.
visibilityLevel	VisibilityLevelsEnum	Filter projects by visibility level.
withCodeEmbeddingsIndexed {warning-solid}	Boolean	Introduced in GitLab 18.2. Status: Experiment. Include projects with indexed code embeddings. Requires ids to be sent. Applies only if the feature flag allow_with_code_embeddings_indexed_projects_filter is enabled.
withIssuesEnabled	Boolean	Return only projects with issues enabled.
withMergeRequestsEnabled	Boolean	Return only projects with merge requests enabled.

Query.aiCatalogAgentFlowConfig

Introduced in GitLab 18.4. Status: Experiment.

Get flow configuration for an AI Catalog agent.

Returns String.

Arguments

Name	Type	Description
agentVersionId	AiCatalogItemVersionID!	Global ID of the agent version to use.
flowConfigType	AiCatalogFlowConfigType!	Type of flow configuration to generate.

Query.aiCatalogBuiltInTools

Introduced in GitLab 18.3. Status: Experiment.

List of AI Catalog built-in tools.

Returns AiCatalogBuiltInToolConnection!.

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

Query.aiCatalogConfiguredItems

Introduced in GitLab 18.2. Status: Experiment.

AI Catalog items configured for use.

Returns AiCatalogItemConsumerConnection!.

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
groupId	GroupID	Group ID to retrieve configured AI Catalog items for.
includeInherited	Boolean	Include configured AI Catalog items inherited from parent groups.
itemId	AiCatalogItemID	Item ID to retrieve configured AI Catalog items for.
itemType	AiCatalogItemType	Type of items to retrieve.
projectId	ProjectID	Project ID to retrieve configured AI Catalog items for.

Query.aiCatalogItem

Introduced in GitLab 18.2. Status: Experiment.

Find an AI Catalog item.

Returns AiCatalogItem.

Arguments

Name	Type	Description
id	AiCatalogItemID!	Global ID of the catalog item to find.

Query.aiCatalogItems

Introduced in GitLab 18.2. Status: Experiment.

List of AI Catalog items.

Returns AiCatalogItemConnection!.

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
itemType	AiCatalogItemType	Type of items to retrieve.
search	String	Search items by name and description.

Query.aiChatAvailableModels

Introduced in GitLab 18.4. Status: Experiment.

Get available models for Duo Agentic Chat.

Returns AvailableModels.

Arguments

Name	Type	Description
rootNamespaceId	GroupID!	Global ID of the namespace the user is acting on.

Query.aiChatContextPresets

Get available GitLab Duo Chat context presets for the current user for a specific URL.

Returns ContextPreset.

Arguments

Name	Type	Description
projectId	ProjectID	Global ID of the project the user is acting on.
questionCount	Int	Number of questions for the default screen.
resourceId	AiModelID	Global ID of the resource from the current page.
url	String	URL of the page the user is currently on.

Query.aiConversationThreads

Introduced in GitLab 17.9. Status: Experiment.

List conversation threads of AI features.

Returns AiConversationsThreadConnection!.

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
conversationType	AiConversationsThreadsConversationType	Conversation type of the thread.
id	AiConversationThreadID	Id of the thread.

Query.aiFeatureSettings

Introduced in GitLab 17.4. Status: Experiment.

List of configurable AI features.

Returns AiFeatureSettingConnection.

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
selfHostedModelId	AiSelfHostedModelID	Global ID of the self-hosted model.

Query.aiMessages

Introduced in GitLab 16.1. Status: Experiment.

Find GitLab Duo Chat messages.

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
agentVersionId	AiAgentVersionID	Global ID of the agent to answer the chat.
conversationType	AiConversationsThreadsConversationType	Conversation type of the thread.
requestIds	[ID!]	Array of request IDs to fetch.
roles	[AiMessageRole!]	Array of roles to fetch.
threadId	AiConversationThreadID	Global Id of the existing thread.If it is not specified, the last thread for the specified conversation_type will be retrieved.

Query.aiModelSelectionNamespaceSettings

Introduced in GitLab 18.1. Status: Experiment.

List of configurable AI features for namespace Model Selection.

Returns AiModelSelectionNamespaceFeatureSettingConnection.

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
groupId	GroupID!	Group for the model selection.

Query.aiSelfHostedModels

Introduced in GitLab 17.1. Status: Experiment.

Returns the self-hosted model if an ID is provided, otherwise returns all models.

Returns AiSelfHostedModelConnection.

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	AiSelfHostedModelID	Global ID of a self-hosted model.

Query.aiSlashCommands

Get available GitLab Duo Chat slash commands for the current user for a specific URL.

Returns [SlashCommand!].

Arguments

Name	Type	Description
url	String!	URL of the page the user is currently on.

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

Introduced in GitLab 16.11. Status: Experiment.

Instance-level external audit event streaming destinations.

Returns InstanceAuditEventStreamingDestinationConnection.

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

Query.blobSearch

Introduced in GitLab 17.2. Status: Experiment.

Find code visible to the current user.

Returns BlobSearch.

Arguments

Name	Type	Description
chunkCount {warning-solid}	Int	Introduced in GitLab 17.2. Status: Experiment. Maximum chunks per file.
excludeForks {warning-solid}	Boolean	Introduced in GitLab 17.11. Status: Experiment. Excludes forked projects in the search. Always false for project search. Default is true.
groupId {warning-solid}	GroupID	Introduced in GitLab 17.2. Status: Experiment. Group to search in.
includeArchived {warning-solid}	Boolean	Introduced in GitLab 17.7. Status: Experiment. Includes archived projects in the search. Always true for project search. Default is false.
page {warning-solid}	Int	Introduced in GitLab 17.2. Status: Experiment. Page number to fetch the results.
perPage {warning-solid}	Int	Introduced in GitLab 17.2. Status: Experiment. Number of results per page.
projectId {warning-solid}	ProjectID	Introduced in GitLab 17.2. Status: Experiment. Project to search in.
regex {warning-solid}	Boolean	Introduced in GitLab 17.3. Status: Experiment. Uses the regular expression search mode. Default is false.
repositoryRef {warning-solid}	String	Introduced in GitLab 17.2. Status: Experiment. Repository reference to search in.
search	String!	Searched term.

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

Introduced in GitLab 16.1. Status: Experiment.

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

Returns CiCatalogResource.

Arguments

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

Query.ciCatalogResources

Introduced in GitLab 15.11. Status: Experiment.

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

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.
topics	[String!]	Filter catalog resources by project topic names.
verificationLevel	CiCatalogResourceVerificationLevel	Filter catalog resources by verification level.

Query.ciConfig

Deprecated in GitLab 18.1. Use CiLint mutation: https://docs.gitlab.com/api/graphql/reference/#mutationcilint.

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 GitLab 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.ciDedicatedHostedRunnerFilters

Returns available filters for GitLab Dedicated runner usage data.

Returns CiDedicatedHostedRunnerFilters.

Query.ciDedicatedHostedRunnerUsage

Compute usage data for runners across namespaces on GitLab Dedicated. Defaults to the current year if no year or billing month is specified. Ultimate only.

Returns CiDedicatedHostedRunnerUsageConnection.

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
billingMonth	Date	First day of the month to retrieve data for.
grouping	GroupingEnum	Groups usage data by instance aggregate or root namespace.
runnerId	CiRunnerID	Runner ID to retrieve data for.
year	Int	Year to retrieve data for.

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 taken for CI jobs to be picked up by runner by percentile. Enable the ClickHouse database backend to use this query.

Returns QueueingDelayHistory.

Arguments

Name	Type	Description
fromTime	Time	Start of the requested time. Defaults to three hours ago.
runnerType	CiRunnerType	Filter jobs by the type of runner that executed them.
toTime	Time	End of the requested time. Defaults to the 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.cloudConnectorStatus

Introduced in GitLab 17.3. Status: Experiment.

Run a series of status checks for Cloud Connector features.

Returns CloudConnectorStatus.

Query.complianceRequirementControls

Get the list of all the compliance requirement controls.

Returns ComplianceRequirementControl.

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

Introduced in GitLab 17.10. Status: Experiment.

Find a custom field by its ID.

Returns CustomField.

Arguments

Name	Type	Description
id	IssuablesCustomFieldID!	Global ID of the custom field.

Query.dependency

Find a dependency.

Returns Dependency.

Arguments

Name	Type	Description
id	SbomOccurrenceID!	Global ID of the Dependency.

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

Introduced in GitLab 17.9. Status: Experiment.

Get GitLab Duo settings.

Returns DuoSettings.

Query.duoWorkflowEvents

Introduced in GitLab 17.2. Status: Experiment.

List the events for a Duo Agent Platform.

Returns DuoWorkflowEventConnection!.

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
workflowId	AiDuoWorkflowsWorkflowID!	Array of request IDs to fetch.

Query.duoWorkflowWorkflows

Introduced in GitLab 17.2. Status: Experiment.

List the workflows owned by the current user.

Returns DuoWorkflowConnection!.

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
environment	WorkflowEnvironment	Environment, for example, IDE or web.
projectPath	ID	Full path of the project that contains the flows.
sort	Sort	Sort flows by the criteria.
type	String	Type of flow to filter by (for example, software_development).
workflowId	AiDuoWorkflowsWorkflowID	Flow ID to filter by.

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

Deprecated in GitLab 17.4. Replaced with metadata.featureFlags.

Check if a feature flag is enabled.

Returns Boolean!.

Arguments

Name	Type	Description
name	String!	Name of the feature flag.

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

Introduced in GitLab 16.10. Status: Experiment.

Details about an artifact in the Google Artifact Registry.

Returns GoogleCloudArtifactRegistryArtifactDetails.

Arguments

Name	Type	Description
googleCloudProjectId	String!	ID of the Google Cloud project.
image	String!	Name of the image in the Google Artifact Registry.
location	String!	Location of the Artifact Registry repository.
projectPath	ID!	Full project path.
repository	String!	Repository on the Google Artifact Registry.

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
active	Boolean	When nil (default value), returns all groups. When true, returns only groups that are not pending deletion. When false, only returns groups that are pending deletion.
allAvailable	Boolean	When true, returns all accessible groups. When false, returns only groups where the user is a member. Unauthenticated requests always return all public groups. The owned_only argument takes precedence.
ids	[ID!]	Filter groups by IDs.
markedForDeletionOn	Date	Date when the group was marked for deletion.
ownedOnly	Boolean	Only include groups where the current user has an owner role.
parentPath	ID	Full path of the parent group.
search	String	Search query for group name or group full path.
sort	String	Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topLevelOnly	Boolean	Only include top-level groups.

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

Introduced in GitLab 17.0. Status: Experiment.

Returns IntegrationExclusionConnection.

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
integrationName	IntegrationType!	Type of integration.

Query.issue

Find an issue.

Returns Issue.

Arguments

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

Query.issues

Introduced in GitLab 15.6. Status: Experiment.

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

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 GitLab 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 the date.
closedBefore	Time	Issues closed before the date.
confidential	Boolean	Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter	Time	Issues created after the date.
createdBefore	Time	Issues created before the date.
crmContactId	String	ID of a contact assigned to the issues.
crmOrganizationId	String	ID of an organization assigned to the issues.
customField {warning-solid}	[WorkItemWidgetCustomFieldFilterInputType!]	Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfter	Time	Return issues due on or after the given time.
dueBefore	Time	Return issues due on or before the given time.
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 the issue.
milestoneTitle	[String]	Milestone applied to the 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 the criteria.
state	IssuableState	Current state of the issue.
status {warning-solid}	WorkItemWidgetStatusFilterInput	Introduced in GitLab 18.0. Status: Experiment. Filter by status.
subscribed	SubscriptionStatus	Issues the current user is subscribed to.
types	[IssueType!]	Filter issues by the given issue types.
updatedAfter	Time	Issues updated after the date.
updatedBefore	Time	Issues updated before the 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 CiJobInterfaceConnection.

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
compatibleRunnerId {warning-solid}	CiRunnerID	Introduced in GitLab 18.1. Status: Experiment. ID of a runner that matches the requirements of the jobs returned (normally used when filtering pending jobs).
failureReason {warning-solid}	CiJobFailureReason	Introduced in GitLab 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 GitLab 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.ldapAdminRoleLinks

Introduced in GitLab 17.11. Status: Experiment.

LDAP admin links. Available only for GitLab Self-Managed.

Returns LdapAdminRoleLinkConnection.

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

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

Introduced in GitLab 18.4. Status: Experiment.

Find a Maven upstream registry. Returns null if the maven_virtual_registry feature flag is disabled.

Returns MavenUpstream.

Arguments

Name	Type	Description
id	VirtualRegistriesPackagesMavenUpstreamID!	Global ID of the Maven upstream registry.

Query.mavenVirtualRegistry

Introduced in GitLab 18.3. Status: Experiment.

Find a Maven virtual registry. Returns null if the maven_virtual_registry feature flag is disabled.

Returns MavenVirtualRegistry.

Arguments

Name	Type	Description
id	VirtualRegistriesPackagesMavenRegistryID!	Global ID of the Maven virtual registry.

Query.memberRole

Introduced in GitLab 16.6. Status: Experiment.

Finds a single custom role for the instance. Available only for GitLab Self-Managed.

Returns MemberRole.

Arguments

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

Query.memberRolePermissions

Introduced in GitLab 16.4. Status: Experiment.

List of all standard customizable permissions.

Returns CustomizableStandardPermissionConnection.

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

Query.memberRoles

Introduced in GitLab 16.7. Status: Experiment.

Custom roles available for the instance. Available only for GitLab Self-Managed.

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.
ids	[MemberRoleID!]	Global IDs 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.mlExperiment

Find a machine learning experiment.

Returns MlExperiment.

Arguments

Name	Type	Description
id	MlExperimentID!	ID of the experiment.

Query.mlModel

Introduced in GitLab 16.7. Status: Experiment.

Find machine learning models.

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

Security-filtered projects for a namespace.

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
namespaceId	NamespaceID!	Global ID of the namespace.
search	String	Search projects by name.
securityAnalyzerFilters	[AnalyzerFilterInput!]	Filter projects by analyzer type and status.
vulnerabilityCountFilters	[VulnerabilityCountFilterInput!]	Filter projects by vulnerability counts using comparison operators.

Query.note

Introduced in GitLab 15.9. Status: Experiment.

Find a note.

Returns Note.

Arguments

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

Query.organization

Introduced in GitLab 16.4. Status: Experiment.

Find an organization.

Returns Organization.

Arguments

Name	Type	Description
id	OrganizationsOrganizationID!	ID of the organization.

Query.organizations

Introduced in GitLab 16.8. Status: Experiment.

List organizations.

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

Find a project compliance violation.

Returns ProjectComplianceViolation.

Arguments

Name	Type	Description
id	ComplianceManagementProjectsComplianceViolationID!	Global ID of the project compliance violation.

Query.projectSecret

Introduced in GitLab 17.9. Status: Experiment.

View a specific project secret.

Returns ProjectSecret.

Arguments

Name	Type	Description
name	String!	Name of the project secret to view.
projectPath	ID!	Project the secrets belong to.

Query.projectSecrets

Introduced in GitLab 17.8. Status: Experiment.

List project secrets.

Returns ProjectSecretConnection.

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
projectPath	ID!	Project the secrets belong to.

Query.projectSecretsManager

Introduced in GitLab 17.4. Status: Experiment.

Find a project secrets manager.

Returns ProjectSecretsManager.

Arguments

Name	Type	Description
projectPath	ID!	Project of the secrets manager.

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
active	Boolean	Filters by projects that are not archived and not marked for deletion.
aimedForDeletion	Boolean	Return only projects marked for deletion.
archived	ProjectArchived	Filter projects by archived status.
fullPaths	[String!]	Filter projects by full paths. You cannot provide more than 50 full paths.
ids	[ID!]	Filter projects by IDs.
includeHidden	Boolean	Include hidden projects.
lastRepositoryCheckFailed	Boolean	Return only projects where the last repository check failed. Only available for administrators.
markedForDeletionOn	Date	Date when the project was marked for deletion.
membership	Boolean	Return only projects that the current user is a member of.
minAccessLevel	AccessLevelEnum	Return only projects where current user has at least the specified access level.
namespacePath	ID	Filter projects by their namespace's full path (group or user).
notAimedForDeletion	Boolean	Exclude projects that are marked for deletion.
personal	Boolean	Return only personal projects.
programmingLanguageName	String	Filter projects by programming language name (case insensitive). For example: "css" or "ruby".
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. Defaults to id_desc, or similarity if search used.
topics	[String!]	Filter projects by topics.
trending	Boolean	Return only projects that are trending.
visibilityLevel	VisibilityLevelsEnum	Filter projects by visibility level.
withCodeEmbeddingsIndexed {warning-solid}	Boolean	Introduced in GitLab 18.2. Status: Experiment. Include projects with indexed code embeddings. Requires ids to be sent. Applies only if the feature flag allow_with_code_embeddings_indexed_projects_filter is enabled.
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

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

Supported runner 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

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

Runner setup instructions.

Returns RunnerSetup.

Arguments

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

Query.runnerUsage

Runner usage by runner. Enable the ClickHouse database backend to use this query.

Returns [CiRunnerUsage!].

Arguments

Name	Type	Description
fromDate	Date	Start of the requested date frame. Defaults to the start of the previous calendar month.
fullPath	ID	Filter jobs by the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
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. Enable the ClickHouse database backend to use this query.

Returns [CiRunnerUsageByProject!].

Arguments

Name	Type	Description
fromDate	Date	Start of the requested date frame. Defaults to the start of the previous calendar month.
fullPath	ID	Filter jobs based on the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
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 GitLab 14.8. This was renamed. Use: paused.
creatorId	UserID	Filter runners by creator ID.
creatorUsername	String	Filter runners by creator username.
ownerFullPath {warning-solid}	String	Introduced in GitLab 17.8. Status: Experiment. Filter runners by owning project or group.
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	String	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.secretPermissions

Introduced in GitLab 17.10. Status: Experiment.

List secret permissions.

Returns SecretPermissionConnection.

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
projectPath	ID!	Project the secret permission belong to.

Query.selfManagedAddOnEligibleUsers

Introduced in GitLab 16.7. Status: Experiment.

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

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
addOnPurchaseIds	[GitlabSubscriptionsAddOnPurchaseID!]!	Global IDs of the add on purchases to find assignments for.
addOnType	GitlabSubscriptionsAddOnType!	Type of add on to filter the eligible users by.
filterByAssignedSeat	String	Filter users list by assigned seat.
search	String	Search the user list.
sort	GitlabSubscriptionsUserSort	Sort the user list.

Query.selfManagedUsersQueuedForRolePromotion

Fields related to users within a self-managed instance that are pending role promotion approval.

Returns UsersQueuedForRolePromotionConnection.

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

Query.semanticCodeSearch

Introduced in GitLab 18.4. Status: Experiment.

Semantically search for code in provided repositories.

Returns [SemanticSearchCode!].

Arguments

Name	Type	Description
knn	Int	KNN count.
limit	Int	Max number of search results to return.
project	ProjectInfoInput!	Project to search, with optional path prefix.
searchTerm	String!	Search term to search for.

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

Introduced in GitLab 17.6. Status: Experiment.

Finds a single default role for the instance. Available only for GitLab Self-Managed.

Returns StandardRole.

Arguments

Name	Type	Description
accessLevel	[MemberAccessLevel!]	Access level or levels to filter by.

Query.standardRoles

Introduced in GitLab 17.3. Status: Experiment.

Default roles available for the instance. Available only for GitLab Self-Managed.

Returns StandardRoleConnection.

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
accessLevel	[MemberAccessLevel!]	Access level or levels to filter by.

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

Introduced in GitLab 15.9. Status: Experiment.

Find a synthetic note.

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
organizationId {warning-solid}	OrganizationsOrganizationID	Introduced in GitLab 17.7. Status: Experiment. Global ID of the organization.
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 the date.
recordedBefore	Time	Measurement recorded before the 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
active	Boolean	Filter by active users. When true, returns active users. When false, returns non-active users.
admins	Boolean	Return only admin users.
groupId	GroupID	Return users member of a given group.
humans	Boolean	Filter by regular users. When true, returns only users that are not bot or internal users. When false, returns only users that are bot or internal users.
ids	[ID!]	List of user Global IDs.
search	String	Query to search users by name, username, or primary email.
sort	Sort	Sort users by the criteria.
userTypes {warning-solid}	[UserType!]	Introduced in GitLab 18.3. Status: Experiment. Filter by user type.
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.
hasAiResolution	Boolean	Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName	String	Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 {warning-solid}	[VulnerabilityOwasp2021Top10!]	Introduced in GitLab 18.1. Status: Experiment. Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have Elasticsearch configured and the advanced_vulnerability_management feature flag enabled. Not supported on Instance Security Dashboard queries.
projectId	[ID!]	Filter vulnerabilities by project.
reachability {warning-solid}	ReachabilityType	Introduced in GitLab 18.2. Status: Experiment. Filter vulnerabilities by reachability.
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.wikiPage

Introduced in GitLab 17.6. Status: Experiment.

Find a wiki page.

Returns WikiPage.

Arguments

Name	Type	Description
namespaceId	NamespaceID	Wiki page namespace ID.
projectId	ProjectID	Wiki page project ID.
slug	String	Wiki page slug.

Query.workItem

Introduced in GitLab 15.1. Status: Experiment.

Find a work item.

Returns WorkItem.

Arguments

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

Query.workItemAllowedStatuses

Introduced in GitLab 18.4. Status: Experiment.

Allowed work item statuses from the root groups the current user belongs to.

Returns WorkItemStatusConnection.

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
name	String	Filter statuses by name.

Query.workItemDescriptionTemplateContent

Introduced in GitLab 17.9. Status: Experiment.

Find a work item description template.

Returns WorkItemDescriptionTemplate.

Arguments

Name	Type	Description
templateContentInput	WorkItemDescriptionTemplateContentInput!	Input for fetching a specific description template.

Query.workItemsByReference

Introduced in GitLab 16.7. Status: Experiment.

Find work items by their reference.

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 GitLab 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

Introduced in GitLab 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 the mutation.
label	AbuseReportLabel	Label after mutation.

Mutation.achievementsAward

Introduced in GitLab 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 the mutation.
userAchievement	UserAchievement	Achievement award.

Mutation.achievementsCreate

Introduced in GitLab 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 the mutation.

Mutation.achievementsDelete

Introduced in GitLab 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 the mutation.

Mutation.achievementsRevoke

Introduced in GitLab 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 the mutation.
userAchievement	UserAchievement	Achievement award.

Mutation.achievementsUpdate

Introduced in GitLab 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 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 the mutation.
project	Project	Project that was added to the Instance Security Dashboard.

Mutation.adminRolesLdapSync

Introduced in GitLab 18.0. Status: Experiment.

Input type: AdminRolesLdapSyncInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]	Errors encountered during operation.
success	Boolean	Whether the sync was successfully enqueued.

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.
kubernetesAgentId	String	Delete jobs matching kubernetes_agent_id in the context metadata.
mergeActionStatus	String	Delete jobs matching merge_action_status in the context metadata.
organizationId	String	Delete jobs matching organization_id in the context metadata.
pipelineId	String	Delete jobs matching pipeline_id in the context metadata.
policySyncConfigId	String	Delete jobs matching policy_sync_config_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.
scopedUser	String	Delete jobs matching scoped_user in the context metadata.
scopedUserId	String	Delete jobs matching scoped_user_id in the context metadata.
sidekiqDestinationShardRedis	String	Delete jobs matching sidekiq_destination_shard_redis 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 the mutation.
result	DeleteJobsResponse	Information about the status of the deletion request.

Mutation.aiAction

Introduced in GitLab 15.11. Status: Experiment.

Input type: AiActionInput

Arguments

Name	Type	Description
agenticChat	AiAgenticChatInput	Input for agentic_chat 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.
conversationType	AiConversationsThreadsConversationType	Conversation type of the thread.
descriptionComposer	AiDescriptionComposerInput	Input for description_composer AI action.
explainVulnerability	AiExplainVulnerabilityInput	Input for explain_vulnerability AI action.
generateCommitMessage	AiGenerateCommitMessageInput	Input for generate_commit_message AI action.
generateDescription	AiGenerateDescriptionInput	Input for generate_description AI action.
measureCommentTemperature	AiMeasureCommentTemperatureInput	Input for measure_comment_temperature AI action.
platformOrigin	String	Specifies the origin platform of the request.
projectId	ProjectID	Global ID of the project the user is acting on.
resolveVulnerability	AiResolveVulnerabilityInput	Input for resolve_vulnerability AI action.
rootNamespaceId	NamespaceID	Global ID of the top-level namespace the user is acting on.
summarizeNewMergeRequest	AiSummarizeNewMergeRequestInput	Input for summarize_new_merge_request AI action.
summarizeReview	AiSummarizeReviewInput	Input for summarize_review AI action.
threadId	AiConversationThreadID	Global Id of the existing thread to continue the conversation. If it is not specified, a new thread will be created for the specified conversation_type.

Fields

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

Mutation.aiAgentCreate

Introduced in GitLab 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 the mutation.

Mutation.aiAgentDestroy

Introduced in GitLab 16.11. Status: Experiment.

Input type: AiAgentDestroyInput

Arguments

Name	Type	Description
agentId	AiAgentID!	Global ID of the AI Agent to be deleted.
clientMutationId	String	A unique identifier for the client performing the mutation.
projectPath	ID!	Project to which the agent belongs.

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 the mutation.
message	String	AI Agent deletion result message.

Mutation.aiAgentUpdate

Introduced in GitLab 16.10. Status: Experiment.

Input type: AiAgentUpdateInput

Arguments

Name	Type	Description
agentId	AiAgentID!	ID of the agent.
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 the mutation.

Mutation.aiCatalogAgentCreate

Introduced in GitLab 18.2. Status: Experiment.

Input type: AiCatalogAgentCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String!	Description for the agent.
name	String!	Name for the agent.
projectId	ProjectID!	Project for the agent.
public	Boolean!	Whether the agent is publicly visible in the catalog.
release	Boolean	Whether to release the latest version of the agent.
systemPrompt	String!	System prompt for the agent.
tools	[AiCatalogBuiltInToolID!]	List of GitLab tools enabled for the agent.
userPrompt	String!	User prompt for the agent.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
item	AiCatalogAgent	Item created.

Mutation.aiCatalogAgentDelete

Introduced in GitLab 18.2. Status: Experiment.

Input type: AiCatalogAgentDeleteInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
success	Boolean!	Returns true if catalog Agent was successfully deleted.

Mutation.aiCatalogAgentExecute

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiCatalogAgentExecuteInput

Arguments

Name	Type	Description
agentId	AiCatalogItemID!	Global ID of the AI catalog agent to execute.
agentVersionId	AiCatalogItemVersionID	Global ID of the specific agent version to use. If not provided, the latest version will be used.
clientMutationId	String	A unique identifier for the client performing the mutation.
userPrompt	String	Optional user prompt. If provided, it will be used for agent execution; otherwise, the database-stored user_prompt will be used.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
flowConfig	String	YAML configuration file that can be used in Duo workflow service for flow execution.
workflow	DuoWorkflow	Created workflow.

Mutation.aiCatalogAgentUpdate

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiCatalogAgentUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description for the agent.
id	AiCatalogItemID!	Global ID of the catalog Agent to update.
name	String	Name for the agent.
public	Boolean	Whether the agent is publicly visible in the catalog.
release	Boolean	Whether to release the latest version of the agent.
systemPrompt	String	System prompt for the agent.
tools	[AiCatalogBuiltInToolID!]	List of GitLab tools enabled for the agent.
userPrompt	String	User prompt for the agent.
versionBump	AiCatalogVersionBump	Bump version, calculated from the last released version name.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
item	AiCatalogAgent	Agent that was updated.

Mutation.aiCatalogFlowCreate

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiCatalogFlowCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String!	Description for the flow.
name	String!	Name for the flow.
projectId	ProjectID!	Project for the flow.
public	Boolean!	Whether the flow is publicly visible in the catalog.
release	Boolean	Whether to release the latest version of the flow.
steps	[AiCatalogFlowStepsInput!]!	Steps for the flow.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
item	AiCatalogFlow	Item created.

Mutation.aiCatalogFlowDelete

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiCatalogFlowDeleteInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
success	Boolean!	Returns true if catalog flow was successfully deleted.

Mutation.aiCatalogFlowUpdate

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiCatalogFlowUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description for the flow.
id	AiCatalogItemID!	Global ID of the catalog flow to update.
name	String	Name for the flow.
public	Boolean	Whether the flow is publicly visible in the catalog.
release	Boolean	Whether to release the latest version of the flow.
steps	[AiCatalogFlowStepsInput!]	Steps for the flow.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
item	AiCatalogFlow	Flow that was updated.

Mutation.aiCatalogItemConsumerCreate

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiCatalogItemConsumerCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
itemId	AiCatalogItemID!	Item to configure.
pinnedVersionPrefix	String	Major version, minor version, or patch to pin the item to.
target	ItemConsumerTargetInput!	Target in which the catalog item is configured.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
itemConsumer	AiCatalogItemConsumer	Item configuration created.

Mutation.aiCatalogItemConsumerDelete

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiCatalogItemConsumerDeleteInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
success	Boolean!	Returns true if catalog item consumer was successfully deleted.

Mutation.aiCatalogItemConsumerUpdate

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiCatalogItemConsumerUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	AiCatalogItemConsumerID!	Global ID of the catalog item consumer to update.
pinnedVersionPrefix	String	Major version, minor version, or patch to pin the item to.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
itemConsumer	AiCatalogItemConsumer	Item consumer that was updated.

Mutation.aiDuoWorkflowCreate

Introduced in GitLab 18.1. Status: Experiment.

Input type: AiDuoWorkflowCreateInput

Arguments

Name	Type	Description
agentPrivileges	[Int!]	Actions the agent is allowed to perform.
aiCatalogItemVersionId	AiCatalogItemVersionID	ID of the catalog item the workflow is triggered from.
allowAgentToRequestUser	Boolean	When enabled, Duo Agent Platform may stop to ask the user questions before proceeding.
clientMutationId	String	A unique identifier for the client performing the mutation.
environment	WorkflowEnvironment	Environment for the workflow.
goal	String	Goal of the workflow.
namespaceId	NamespaceID	Global ID of the namespace the user is acting on.
preApprovedAgentPrivileges	[Int!]	Actions the agent can perform without asking for approval.
projectId	ProjectID	Global ID of the project the user is acting on.
workflowDefinition	String	Workflow type based on its capability.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the creation process.
workflow	DuoWorkflow	Created workflow.

Mutation.aiFeatureSettingUpdate

Introduced in GitLab 17.4. Status: Experiment.

Updates or creates settings for AI features.

Input type: AiFeatureSettingUpdateInput

Arguments

Name	Type	Description
aiSelfHostedModelId	AiSelfHostedModelID	Global ID of the self-hosted model providing the AI setting.
clientMutationId	String	A unique identifier for the client performing the mutation.
features	[AiFeatures!]!	Array of AI features being configured (for single or batch update).
offeredModelRef	String	Identifier of the selected model for the feature.
provider	AiFeatureProviders!	Provider for AI setting.

Fields

Name	Type	Description
aiFeatureSettings	[AiFeatureSetting!]!	List of AI feature settings after mutation.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.aiFlowTriggerCreate

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiFlowTriggerCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
configPath	String	Path to the configuration file for the AI flow trigger.
description	String!	Description of the AI flow trigger.
eventTypes	[Int!]	Event types that triggers the AI flow.
projectPath	ID!	Full path of the project the AI flow trigger is associated with.
userId	UserID!	Owner of the AI flow trigger.

Fields

Name	Type	Description
aiFlowTrigger	AiFlowTriggerType	Created AI flow trigger.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.aiFlowTriggerDelete

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiFlowTriggerDeleteInput

Arguments

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

Fields

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

Mutation.aiFlowTriggerUpdate

Introduced in GitLab 18.3. Status: Experiment.

Input type: AiFlowTriggerUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
configPath	String	Path to the configuration file for the AI flow trigger.
description	String	Description of the AI flow trigger.
eventTypes	[Int!]	Event types that triggers the AI flow.
id	AiFlowTriggerID!	ID of the flow trigger to update.
userId	UserID	Owner of the AI flow trigger.

Fields

Name	Type	Description
aiFlowTrigger	AiFlowTriggerType	Updated AI flow trigger.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.aiModelSelectionNamespaceUpdate

Introduced in GitLab 18.1. Status: Experiment.

Updates or creates settings for AI features for a namespace.

Input type: AiModelSelectionNamespaceUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
features	[AiModelSelectionFeatures!]!	Array of AI features being configured (for single or batch update).
groupId	GroupID!	Group for the model selection.
offeredModelRef	String!	Identifier of the selected model for the feature.

Fields

Name	Type	Description
aiFeatureSettings {warning-solid}	[AiModelSelectionNamespaceFeatureSetting!]!	Deprecated: Status: Experiment. Introduced in GitLab 18.1.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.aiSelfHostedModelConnectionCheck

Introduced in GitLab 17.7. Status: Experiment.

Checks if the AI Gateway can establish a connection with the given model configuration.

Input type: AiSelfHostedModelConnectionCheckInput

Arguments

Name	Type	Description
apiToken	String	API token to access the self-hosted model, if any.
clientMutationId	String	A unique identifier for the client performing the mutation.
endpoint	String!	Endpoint of the self-hosted model.
identifier	String	Identifier for 3rd party model provider.
model	AiAcceptedSelfHostedModels!	AI model deployed.
name	String!	Deployment name of the self-hosted model.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
result	CloudConnectorProbeResult	Self-hosted hosted connection check result.

Mutation.aiSelfHostedModelCreate

Introduced in GitLab 17.1. Status: Experiment.

Input type: AiSelfHostedModelCreateInput

Arguments

Name	Type	Description
apiToken	String	API token to access the self-hosted model, if any.
clientMutationId	String	A unique identifier for the client performing the mutation.
endpoint	String!	Endpoint of the self-hosted model.
identifier	String	Identifier for 3rd party model provider.
model	AiAcceptedSelfHostedModels!	AI model deployed.
name	String!	Deployment name of the self-hosted model.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
selfHostedModel	AiSelfHostedModel	Self-hosted model after mutation.

Mutation.aiSelfHostedModelDelete

Introduced in GitLab 17.2. Status: Experiment.

Deletes a self-hosted model.

Input type: AiSelfHostedModelDeleteInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	AiSelfHostedModelID!	Global ID of the self-hosted model to delete.

Fields

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

Mutation.aiSelfHostedModelUpdate

Introduced in GitLab 17.2. Status: Experiment.

Updates a self-hosted model.

Input type: AiSelfHostedModelUpdateInput

Arguments

Name	Type	Description
apiToken	String	API token to access the self-hosted model, if any.
clientMutationId	String	A unique identifier for the client performing the mutation.
endpoint	String!	Endpoint of the self-hosted model.
id	AiSelfHostedModelID!	Global ID of the self-hosted model to update.
identifier	String	Identifier for 3rd party model provider.
model	AiAcceptedSelfHostedModels!	AI model deployed.
name	String!	Deployment name of the self-hosted model.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
selfHostedModel	AiSelfHostedModel	Self-hosted model after 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 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 the mutation.
issue	Issue	Issue created after mutation.
todo	Todo	To-do item after mutation.

Mutation.approvalProjectRuleDelete

Introduced in GitLab 16.10. Status: Experiment.

Input type: approvalProjectRuleDeleteInput

Arguments

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

Fields

Name	Type	Description
approvalRule	ApprovalProjectRule	Deleted approval rule.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.approvalProjectRuleUpdate

Introduced in GitLab 16.10. Status: Experiment.

Input type: approvalProjectRuleUpdateInput

Arguments

Name	Type	Description
approvalsRequired	Int!	How many approvals are required to satify rule.
clientMutationId	String	A unique identifier for the client performing the mutation.
groupIds	[ID!]	List of IDs of Groups that can approval rule.
id	ApprovalProjectRuleID!	Global ID of the approval rule to destroy.
name	String!	Name of the approval rule.
userIds	[ID!]	List of IDs of Users that can approval rule.

Fields

Name	Type	Description
approvalRule	ApprovalProjectRule	Approval rule after mutation.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the 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 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 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 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 the mutation.

Mutation.auditEventsAmazonS3ConfigurationUpdate

Input type: AuditEventsAmazonS3ConfigurationUpdateInput

Arguments

Name	Type	Description
accessKeyXid	String	Access key ID of the Amazon S3 account.
active	Boolean	Active status of the destination.
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 the mutation.

Mutation.auditEventsGroupDestinationEventsAdd

Introduced in GitLab 17.0. Status: Experiment.

Input type: AuditEventsGroupDestinationEventsAddInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
destinationId	AuditEventsGroupExternalStreamingDestinationID!	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 the mutation.
eventTypeFilters	[String!]	List of event type filters for the audit event external destination.

Mutation.auditEventsGroupDestinationEventsDelete

Introduced in GitLab 17.0. Status: Experiment.

Input type: AuditEventsGroupDestinationEventsDeleteInput

Arguments

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

Mutation.auditEventsGroupDestinationNamespaceFilterCreate

Introduced in GitLab 17.0. Status: Experiment.

Input type: AuditEventsGroupDestinationNamespaceFilterCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
destinationId	AuditEventsGroupExternalStreamingDestinationID!	Destination ID.
namespacePath	String	Full path of the namespace(only project or group).

Fields

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

Mutation.auditEventsGroupDestinationNamespaceFilterDelete

Introduced in GitLab 17.0. Status: Experiment.

Input type: AuditEventsGroupDestinationNamespaceFilterDeleteInput

Arguments

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

Fields

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

Mutation.auditEventsInstanceAmazonS3ConfigurationUpdate

Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput

Arguments

Name	Type	Description
accessKeyXid	String	Access key ID of the Amazon S3 account.
active	Boolean	Active status of the destination.
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 the mutation.
instanceAmazonS3Configuration	InstanceAmazonS3ConfigurationType	Updated instance-level Amazon S3 configuration.

Mutation.auditEventsInstanceDestinationEventsAdd

Introduced in GitLab 17.0. Status: Experiment.

Input type: AuditEventsInstanceDestinationEventsAddInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
destinationId	AuditEventsInstanceExternalStreamingDestinationID!	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 the mutation.
eventTypeFilters	[String!]	List of event type filters for the audit event external destination.

Mutation.auditEventsInstanceDestinationEventsDelete

Introduced in GitLab 17.0. Status: Experiment.

Input type: AuditEventsInstanceDestinationEventsDeleteInput

Arguments

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

Mutation.auditEventsInstanceDestinationNamespaceFilterCreate

Introduced in GitLab 17.2. Status: Experiment.

Input type: AuditEventsInstanceDestinationNamespaceFilterCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
destinationId	AuditEventsInstanceExternalStreamingDestinationID!	Destination ID.
namespacePath	String	Full path of the namespace. Project or group namespaces only.

Fields

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

Mutation.auditEventsInstanceDestinationNamespaceFilterDelete

Introduced in GitLab 17.2. Status: Experiment.

Input type: AuditEventsInstanceDestinationNamespaceFilterDeleteInput

Arguments

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

Fields

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

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

Deprecated in GitLab 17.5. Replaced by WorkItem type.

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 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.
position	Int	Position of the list.
statusId {warning-solid}	WorkItemsStatusesStatusID	Deprecated: Status: Experiment. Introduced in GitLab 18.0.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during 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 the mutation.
list	BoardList	Updated list.

Mutation.branchDelete

Input type: BranchDeleteInput

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.

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 the mutation.

Mutation.branchRuleApprovalProjectRuleCreate

Introduced in GitLab 16.10. Status: Experiment.

Input type: branchRuleApprovalProjectRuleCreateInput

Arguments

Name	Type	Description
approvalsRequired	Int!	How many approvals are required to satify rule.
branchRuleId	ProjectsBranchRuleID!	Global ID of the branch rule to destroy.
clientMutationId	String	A unique identifier for the client performing the mutation.
groupIds	[ID!]	List of IDs of Groups that can approval rule.
name	String!	Name of the approval rule.
userIds	[ID!]	List of IDs of Users that can approval rule.

Fields

Name	Type	Description
approvalRule	ApprovalProjectRule	Approval rule after mutation.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.branchRuleCreate

Introduced in GitLab 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 the mutation.

Mutation.branchRuleDelete

Introduced in GitLab 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 the mutation.

Mutation.branchRuleExternalStatusCheckCreate

Introduced in GitLab 16.11. Status: Experiment.

Create a new external status check from a branch rule.

Input type: BranchRuleExternalStatusCheckCreateInput

Arguments

Name	Type	Description
branchRuleId	ProjectsBranchRuleID!	Global ID of the branch rule to update.
clientMutationId	String	A unique identifier for the client performing the mutation.
externalUrl	String!	URL of external status check resource.
name	String!	Name of the external status check.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
externalStatusCheck	ExternalStatusCheck	New status check after mutation.

Mutation.branchRuleExternalStatusCheckDestroy

Introduced in GitLab 17.0. Status: Experiment.

Destroy an external status check from a branch rule.

Input type: BranchRuleExternalStatusCheckDestroyInput

Arguments

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

Fields

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

Mutation.branchRuleExternalStatusCheckUpdate

Introduced in GitLab 17.0. Status: Experiment.

Update an external status check from a branch rule.

Input type: BranchRuleExternalStatusCheckUpdateInput

Arguments

Name	Type	Description
branchRuleId	ProjectsBranchRuleID!	Global ID of the branch rule.
clientMutationId	String	A unique identifier for the client performing the mutation.
externalUrl	String!	External URL of the external status check.
id	MergeRequestsExternalStatusCheckID!	Global ID of the external status check to update.
name	String!	Name of the external status check.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
externalStatusCheck	ExternalStatusCheck	Updated external status check after mutation.

Mutation.branchRuleSquashOptionDelete

Introduced in GitLab 17.9. Status: Experiment.

Delete a squash option for a branch rule.

Input type: BranchRuleSquashOptionDeleteInput

Arguments

Name	Type	Description
branchRuleId	ProjectsBranchRuleID!	Global ID of the branch rule.
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 the mutation.

Mutation.branchRuleSquashOptionUpdate

Introduced in GitLab 17.9. Status: Experiment.

Update a squash option for a branch rule.

Input type: BranchRuleSquashOptionUpdateInput

Arguments

Name	Type	Description
branchRuleId	ProjectsBranchRuleID!	Global ID of the branch rule.
clientMutationId	String	A unique identifier for the client performing the mutation.
squashOption	SquashOptionSetting!	Squash option after mutation.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
squashOption	SquashOption	Updated squash option after mutation.

Mutation.branchRuleUpdate

Introduced in GitLab 16.7. Status: Experiment.

Input type: BranchRuleUpdateInput

Arguments

Name	Type	Description
branchProtection	BranchProtectionInput	Branch protections configured for the branch rule.
clientMutationId	String	A unique identifier for the client performing the mutation.
id	ProjectsBranchRuleID!	Global ID of the branch rule to update.
name	String!	Branch name, with wildcards, for the branch rules.

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 the mutation.

Mutation.bulkDestroyJobArtifacts

Introduced in GitLab 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 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 the mutation.

Mutation.bulkRunnerDelete

Introduced in GitLab 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 the mutation.

Mutation.catalogResourcesCreate

Introduced in GitLab 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 the mutation.

Mutation.catalogResourcesDestroy

Introduced in GitLab 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 the mutation.

Mutation.ciJobTokenScopeAddGroupOrProject

Input type: CiJobTokenScopeAddGroupOrProjectInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
defaultPermissions {warning-solid}	Boolean	Deprecated: Status: Experiment. Introduced in GitLab 17.8.
jobTokenPolicies {warning-solid}	[CiJobTokenScopePolicies!]	Deprecated: Status: Experiment. Introduced in GitLab 17.5.
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.
ciJobTokenScopeAllowlistEntry {warning-solid}	CiJobTokenScopeAllowlistEntry	Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during 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 GitLab 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.
ciJobTokenScopeAllowlistEntry {warning-solid}	CiJobTokenScopeAllowlistEntry	Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.ciJobTokenScopeAutopopulateAllowlist

Introduced in GitLab 17.9. Status: Experiment.

Input type: CiJobTokenScopeAutopopulateAllowlistInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
projectPath	ID!	Project in which to autopopulate the allowlist.

Fields

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

Mutation.ciJobTokenScopeClearAllowlistAutopopulations

Introduced in GitLab 17.9. Status: Experiment.

Input type: CiJobTokenScopeClearAllowlistAutopopulationsInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
projectPath	ID!	Project in which to autopopulate the allowlist.

Fields

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

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.
ciJobTokenScopeAllowlistEntry {warning-solid}	CiJobTokenScopeAllowlistEntry	Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.ciJobTokenScopeRemoveProject

Input type: CiJobTokenScopeRemoveProjectInput

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 GitLab 16.9.
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 access scope.
ciJobTokenScopeAllowlistEntry {warning-solid}	CiJobTokenScopeAllowlistEntry	Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.ciJobTokenScopeUpdatePolicies

Introduced in GitLab 17.6. Status: Experiment.

Input type: CiJobTokenScopeUpdatePoliciesInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
defaultPermissions	Boolean!	Indicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
jobTokenPolicies	[CiJobTokenScopePolicies!]!	List of policies added to the CI job token scope.
projectPath	ID!	Project that the CI job token scope belongs to.
targetPath	ID!	Group or project that the CI job token targets.

Fields

Name	Type	Description
ciJobTokenScopeAllowlistEntry {warning-solid}	CiJobTokenScopeAllowlistEntry	Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.ciLint

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

Input type: CiLintInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
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.
ref	String	Ref to use when linting. Default is the project default branch.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
config	CiConfigV2	Linted CI config and metadata.
errors	[String!]!	Errors encountered during 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 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 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 the mutation.

Mutation.clusterAgentUrlConfigurationCreate

Input type: ClusterAgentUrlConfigurationCreateInput

Arguments

Name	Type	Description
caCert	String	Base64-encoded CA certificate in PEM format to verify the agent endpoint.
clientCert	String	Base64-encoded client certificate in PEM format if mTLS authentication should be used. Must be provided with client_key.
clientKey	String	Base64-encoded client key in PEM format if mTLS authentication should be used. Must be provided with client_cert.
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 URL configuration.
tlsHost	String	TLS host name to verify the server name in agent endpoint certificate.
url	String!	URL for the new URL configuration.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
urlConfiguration	ClusterAgentUrlConfiguration	URL configuration created after mutation.

Mutation.clusterAgentUrlConfigurationDelete

Input type: ClusterAgentUrlConfigurationDeleteInput

Arguments

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

Fields

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

Mutation.createAbuseReportNote

Creates an abuse report Note.

Input type: CreateAbuseReportNoteInput

Arguments

Name	Type	Description
abuseReportId	AbuseReportID!	ID of the abuse report.
body	String!	Content of the note.
clientMutationId	String	A unique identifier for the client performing the mutation.
discussionId	DiscussionID	Global ID of the abuse report discussion the note is in reply to.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
note	AbuseReportNote	Abuse report note after 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 the mutation.
issue	Issue	Issue created after mutation.
todo	Todo	To-do item after mutation.

Mutation.createAnnotation

Deprecated in GitLab 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 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 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 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 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 the mutation.
framework	ComplianceFramework	Created compliance framework.

Mutation.createComplianceRequirement

Introduced in GitLab 17.6. Status: Experiment.

Input type: CreateComplianceRequirementInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
complianceFrameworkId	ComplianceManagementFrameworkID!	Global ID of the compliance framework of the new requirement.
controls	[ComplianceRequirementsControlInput!]	Controls to add to the compliance requirement.
params	ComplianceRequirementInput!	Parameters to update the compliance requirement with.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
requirement	ComplianceRequirement	Created compliance requirement.

Mutation.createComplianceRequirementsControl

Introduced in GitLab 17.9. Status: Experiment.

Input type: CreateComplianceRequirementsControlInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
complianceRequirementId	ComplianceManagementComplianceFrameworkComplianceRequirementID!	Global ID of the compliance requirement of the new control.
params	ComplianceRequirementsControlInput!	Parameters to create the compliance requirement control.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
requirementsControl	ComplianceRequirementsControl	Created compliance requirements control.

Mutation.createContainerProtectionRepositoryRule

Creates a repository protection rule to restrict access to a project's container registry.

Input type: CreateContainerProtectionRepositoryRuleInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
minimumAccessLevelForDelete	ContainerProtectionRepositoryRuleAccessLevel	Minimum GitLab access level required to delete container images from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
minimumAccessLevelForPush	ContainerProtectionRepositoryRuleAccessLevel	Minimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
projectPath	ID!	Full path of the project where a protection rule is located.
repositoryPathPattern	String!	Container repository path pattern protected by the protection rule. Must start with the project’s full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project’s full path.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
containerProtectionRepositoryRule	ContainerProtectionRepositoryRule	Container repository protection rule after mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.createContainerProtectionTagRule

Introduced in GitLab 17.8. Status: Experiment.

Creates a protection rule to control which user roles can modify container image tags matching a specified pattern.

Input type: createContainerProtectionTagRuleInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
minimumAccessLevelForDelete	ContainerProtectionTagRuleAccessLevel	Minimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. Introduced in GitLab 17.8: Status: Experiment. If the value is nil, no access level can delete tags.
minimumAccessLevelForPush	ContainerProtectionTagRuleAccessLevel	Minimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. Introduced in GitLab 17.8: Status: Experiment. If the value is nil, no access level can push tags.
projectPath	ID!	Full path of the project containing the container image tags.
tagNamePattern	String!	The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed. Introduced in GitLab 17.8: Status: Experiment.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
containerProtectionTagRule {warning-solid}	ContainerProtectionTagRule	Deprecated: Status: Experiment. Introduced in GitLab 17.8.
errors	[String!]!	Errors encountered during 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 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.
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 the note on a diff.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
note	Note	Note after mutation.
quickActionsStatus	QuickActionsStatus	Status of quick actions 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.
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 the mutation.
note	Note	Note after mutation.
quickActionsStatus	QuickActionsStatus	Status of quick actions after mutation.

Mutation.createEpic

Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide.

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.
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 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.
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 the note on a diff.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
note	Note	Note after mutation.
quickActionsStatus	QuickActionsStatus	Status of quick actions 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 {warning-solid}	EpicID	Deprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
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.
statusId	WorkItemsStatusesStatusID	Global ID of the status.
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 the mutation.
issue	Issue	Issue after mutation.

Mutation.createIteration

Deprecated in GitLab 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 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.
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 the mutation.
note	Note	Note after mutation.
quickActionsStatus	QuickActionsStatus	Status of quick actions after mutation.

Mutation.createPackagesProtectionRule

Creates a protection rule to restrict access to project packages.

Input type: CreatePackagesProtectionRuleInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
minimumAccessLevelForDelete {warning-solid}	PackagesProtectionRuleAccessLevelForDelete	Deprecated: Status: Experiment. Introduced in GitLab 17.10.
minimumAccessLevelForPush	PackagesProtectionRuleAccessLevel	Minimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
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, PYPI.
projectPath	ID!	Full path of the project where a protection rule is located.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during 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 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 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 the mutation.
testCase	Issue	Test case created.

Mutation.customFieldArchive

Introduced in GitLab 17.9. Status: Experiment.

Input type: CustomFieldArchiveInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	IssuablesCustomFieldID!	Global ID of the custom field.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
customField	CustomField	Archived custom field.
errors	[String!]!	Errors encountered during the mutation.

Mutation.customFieldCreate

Introduced in GitLab 17.6. Status: Experiment.

Input type: CustomFieldCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
fieldType	CustomFieldType!	Type of custom field.
groupPath	ID!	Group path where the custom field is created.
name	String!	Name of the custom field.
selectOptions	[CustomFieldSelectOptionInput!]	Available options for a select field.
workItemTypeIds	[WorkItemsTypeID!]	Work item type global IDs associated to the custom field.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
customField	CustomField	Created custom field.
errors	[String!]!	Errors encountered during the mutation.

Mutation.customFieldUnarchive

Introduced in GitLab 17.9. Status: Experiment.

Input type: CustomFieldUnarchiveInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	IssuablesCustomFieldID!	Global ID of the custom field.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
customField	CustomField	Unarchived custom field.
errors	[String!]!	Errors encountered during the mutation.

Mutation.customFieldUpdate

Introduced in GitLab 17.6. Status: Experiment.

Input type: CustomFieldUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	IssuablesCustomFieldID!	Global ID of the custom field.
name	String	Name of the custom field.
selectOptions	[CustomFieldSelectOptionInput!]	Available options for a select field.
workItemTypeIds	[WorkItemsTypeID!]	Work item type global IDs associated to the custom field.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
customField	CustomField	Updated custom field.
errors	[String!]!	Errors encountered during the mutation.

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 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 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 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 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 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 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 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 GitLab 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 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 GitLab 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 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 GitLab 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 the mutation.
id {warning-solid}	DastScannerProfileID	Deprecated: use dastScannerProfile field. Deprecated in GitLab 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 GitLab 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 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 GitLab 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 GitLab 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 the mutation.
id {warning-solid}	DastScannerProfileID	Deprecated: use dastScannerProfile field. Deprecated in GitLab 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.
optionalVariables	[JSON!]	Optional variables that can be configured for DAST scans.
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 the mutation.
id {warning-solid}	DastSiteProfileID	Deprecated: use dastSiteProfile.id field. Deprecated in GitLab 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 GitLab 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 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 GitLab 14.5.
id	DastSiteProfileID!	ID of the site profile to be updated.
optionalVariables	[JSON!]	Optional variables that can be configured for DAST scans.
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 the mutation.
id {warning-solid}	DastSiteProfileID	Deprecated: use dastSiteProfile.id field. Deprecated in GitLab 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 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 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 the mutation.

Mutation.deleteAnnotation

Deprecated in GitLab 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 the mutation.

Mutation.deleteContainerProtectionRepositoryRule

Deletes a container repository protection rule.

Input type: DeleteContainerProtectionRepositoryRuleInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
containerProtectionRepositoryRule	ContainerProtectionRepositoryRule	Container repository protection rule that was deleted successfully.
errors	[String!]!	Errors encountered during the mutation.

Mutation.deleteContainerProtectionTagRule

Introduced in GitLab 17.8. Status: Experiment.

Deletes a protection rule that controls which user roles can modify container image tags matching a specified pattern.

Input type: DeleteContainerProtectionTagRuleInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
containerProtectionTagRule {warning-solid}	ContainerProtectionTagRule	Deprecated: Status: Experiment. Introduced in GitLab 17.8.
errors	[String!]!	Errors encountered during the mutation.

Mutation.deleteConversationThread

Introduced in GitLab 17.9. Status: Experiment.

Input type: DeleteConversationThreadInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	List of errors that occurred whilst trying to delete the thread.
success	Boolean!	Returns true if thread was successfully deleted.

Mutation.deleteDuoWorkflowsWorkflow

Introduced in GitLab 18.1. Status: Experiment.

Input type: DeleteDuoWorkflowsWorkflowInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	List of errors that occurred whilst trying to delete the workflow.
success	Boolean!	Returns true if workflow was successfully deleted.

Mutation.deletePackagesProtectionRule

Deletes a protection rule for packages.

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 the mutation.
packageProtectionRule	PackagesProtectionRule	Packages protection rule that was deleted successfully.

Mutation.deletePagesDeployment

Introduced in GitLab 17.1. Status: Experiment.

Deletes a Pages deployment.

Input type: DeletePagesDeploymentInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	PagesDeploymentID!	ID of the Pages Deployment.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
pagesDeployment	PagesDeployment!	Deleted Pages Deployment.

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 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 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 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 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 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 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 the mutation.

Mutation.destroyComplianceRequirement

Introduced in GitLab 17.7. Status: Experiment.

Input type: DestroyComplianceRequirementInput

Arguments

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

Fields

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

Mutation.destroyComplianceRequirementsControl

Introduced in GitLab 17.9. Status: Experiment.

Input type: DestroyComplianceRequirementsControlInput

Arguments

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

Fields

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

Mutation.destroyEpicBoard

Deprecated in GitLab 17.5. Replaced by WorkItem type.

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 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 the mutation.
note	Note	Note after mutation.
quickActionsStatus	QuickActionsStatus	Status of quick actions 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 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 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 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 100.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during 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 the mutation.
snippet	Snippet	Snippet after mutation.

Mutation.devfileValidate

Introduced in GitLab 18.4. Status: Experiment.

Input type: DevfileValidateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
devfileYaml	String!	Input devfile.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
valid	Boolean	Status whether devfile is valid or not.

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 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 the mutation.

Mutation.dismissPolicyViolations

Introduced in GitLab 18.4. Status: Experiment.

Dismisses policy violations linked to a merge request.

Input type: DismissPolicyViolationsInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
iid	String!	IID of the merge request to mutate.
projectPath	ID!	Project the merge request to mutate is in.
securityPolicyIds	[ID!]!	IDs of warn mode policies with violations to dismiss.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.duoSettingsUpdate

Introduced in GitLab 17.9. Status: Experiment.

Updates GitLab Duo settings.

Input type: DuoSettingsUpdateInput

Arguments

Name	Type	Description
aiGatewayUrl	String	URL for local AI gateway server.
clientMutationId	String	A unique identifier for the client performing the mutation.
duoAgentPlatformServiceUrl	String	URL for the local Duo Agent Platform service.
duoCoreFeaturesEnabled	Boolean	Indicates whether GitLab Duo Core features are enabled.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
duoSettings	DuoSettings!	GitLab Duo settings after mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.duoUserFeedback

Introduced in GitLab 16.10. Status: Experiment.

Input type: DuoUserFeedbackInput

Arguments

Name	Type	Description
agentVersionId	AiAgentVersionID	Global ID of the agent to answer the chat.
aiMessageId	String!	ID of the AI Message.
clientMutationId	String	A unique identifier for the client performing the mutation.
trackingEvent	TrackingEventInput	Tracking event data.

Fields

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

Mutation.environmentCreate

Create an environment.

Input type: EnvironmentCreateInput

Arguments

Name	Type	Description
autoStopSetting	AutoStopSetting	Auto stop setting of the environment.
clientMutationId	String	A unique identifier for the client performing the mutation.
clusterAgentId	ClustersAgentID	Cluster agent of the environment.
description	String	Description 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 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 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 the mutation.

Mutation.environmentUpdate

Update an environment.

Input type: EnvironmentUpdateInput

Arguments

Name	Type	Description
autoStopSetting	AutoStopSetting	Auto stop setting of the environment.
clientMutationId	String	A unique identifier for the client performing the mutation.
clusterAgentId	ClustersAgentID	Cluster agent of the environment.
description	String	Description 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 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 the mutation.

Mutation.epicAddIssue

Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide.

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 the mutation.

Mutation.epicBoardCreate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

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.
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 the mutation.

Mutation.epicBoardListCreate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

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 the mutation.
list	EpicList	Epic list in the epic board.

Mutation.epicBoardListDestroy

Deprecated in GitLab 17.5. Replaced by WorkItem type.

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 the mutation.
list	EpicList	Epic board list. null if the board was destroyed successfully.

Mutation.epicBoardUpdate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

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.
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 the mutation.

Mutation.epicMoveList

Deprecated in GitLab 17.5. Replaced by WorkItem type.

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 the mutation.

Mutation.epicSetSubscription

Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide.

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 the mutation.

Mutation.epicTreeReorder

Deprecated in GitLab 17.5. Replaced by WorkItem type.

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 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 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 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 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 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 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 the mutation.

Mutation.externalAuditEventDestinationUpdate

Input type: ExternalAuditEventDestinationUpdateInput

Arguments

Name	Type	Description
active	Boolean	Active status of the destination.
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 the mutation.
externalAuditEventDestination	ExternalAuditEventDestination	Updated destination.

Mutation.geoRegistriesBulkUpdate

Introduced in GitLab 16.4. Status: Experiment.

Mutates multiple Geo registries for a given registry class.

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.
ids	[GeoBaseRegistryID!]	Execute the action on registries selected by their ID.
registryClass	GeoRegistryClass!	Class of the Geo registries to be updated.
replicationState	ReplicationStateEnum	Execute the action on registries selected by their replication state.
verificationState	VerificationStateEnum	Execute the action on registries selected by their verification state.

Fields

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

Mutation.geoRegistriesUpdate

Introduced in GitLab 16.1. Status: Experiment.

Mutates a Geo registry.

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.
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 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 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 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 the mutation.

Mutation.googleCloudLoggingConfigurationUpdate

Input type: GoogleCloudLoggingConfigurationUpdateInput

Arguments

Name	Type	Description
active	Boolean	Active status of the destination.
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 the mutation.
googleCloudLoggingConfiguration	GoogleCloudLoggingConfigurationType	configuration updated.

Mutation.groupAuditEventStreamingDestinationsCreate

Introduced in GitLab 16.11. Status: Experiment.

Input type: GroupAuditEventStreamingDestinationsCreateInput

Arguments

Name	Type	Description
category	String!	Destination category.
clientMutationId	String	A unique identifier for the client performing the mutation.
config	JSON!	Destination config.
groupPath	ID!	Group path.
name	String	Destination name.
secretToken	String	Secret token.

Fields

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

Mutation.groupAuditEventStreamingDestinationsDelete

Introduced in GitLab 16.11. Status: Experiment.

Input type: GroupAuditEventStreamingDestinationsDeleteInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	AuditEventsGroupExternalStreamingDestinationID!	ID of the audit events external streaming destination to delete.

Fields

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

Mutation.groupAuditEventStreamingDestinationsUpdate

Introduced in GitLab 16.11. Status: Experiment.

Input type: GroupAuditEventStreamingDestinationsUpdateInput

Arguments

Name	Type	Description
active	Boolean	Active status of the destination.
category	String	Destination category.
clientMutationId	String	A unique identifier for the client performing the mutation.
config	JSON	Destination config.
id	AuditEventsGroupExternalStreamingDestinationID!	ID of external audit event destination to update.
name	String	Destination name.
secretToken	String	Secret token.

Fields

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

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 the mutation.
groupMembers	[GroupMember!]	Group members after mutation.

Mutation.groupMembersExport

Introduced in GitLab 17.4. Status: Experiment.

Input type: GroupMembersExportInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
groupId	GroupID!	Global ID of the group.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
message	String	Export request result message.

Mutation.groupSavedReplyCreate

Introduced in GitLab 16.10. Status: Experiment.

Input type: GroupSavedReplyCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
content	String!	Content of the saved reply.
groupId	GroupID!	Group for the save reply.
name	String!	Name of the saved reply.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
savedReply	GroupSavedReply	Saved reply after mutation.

Mutation.groupSavedReplyDestroy

Introduced in GitLab 16.10. Status: Experiment.

Input type: GroupSavedReplyDestroyInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	GroupsSavedReplyID!	Global ID of the group-level saved reply.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
savedReply	GroupSavedReply	Saved reply after mutation.

Mutation.groupSavedReplyUpdate

Introduced in GitLab 16.10. Status: Experiment.

Input type: GroupSavedReplyUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
content	String!	Content of the saved reply.
id	GroupsSavedReplyID!	Global ID of the group-level saved reply.
name	String!	Name of the saved reply.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
savedReply	GroupSavedReply	Saved reply after mutation.

Mutation.groupUpdate

Input type: GroupUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
duoFeaturesEnabled	Boolean	Indicates whether GitLab Duo features are enabled for the group. Introduced in GitLab 16.10: Status: Experiment.
fullPath	ID!	Full path of the group that will be updated.
lockDuoFeaturesEnabled	Boolean	Indicates if the GitLab Duo features enabled setting is enforced for all subgroups. Introduced in GitLab 16.10: Status: Experiment.
lockMathRenderingLimitsEnabled	Boolean	Indicates if math rendering limits are locked for all descendant groups.
mathRenderingLimitsEnabled	Boolean	Indicates if math rendering limits are used for the group.
name	String	Name of the group.
path	String	Path of the namespace.
sharedRunnersSetting	SharedRunnersSetting	Shared runners availability for the namespace and its descendants.
visibility	VisibilityLevelsEnum	Visibility of the namespace.
webBasedCommitSigningEnabled {warning-solid}	Boolean	Deprecated: Status: Experiment. Introduced in GitLab 18.2.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during 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.
type	AlertManagementIntegrationType	Type of integration to create. Cannot be changed after creation.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
integration	AlertManagementHttpIntegration	Alerting 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 the mutation.
integration	AlertManagementHttpIntegration	Alerting 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 the mutation.
integration	AlertManagementHttpIntegration	Alerting 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 the mutation.
integration	AlertManagementHttpIntegration	Alerting integration.

Mutation.importSourceUserCancelReassignment

Introduced in GitLab 17.2. Status: Experiment.

Input type: ImportSourceUserCancelReassignmentInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	ImportSourceUserID!	Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
importSourceUser	ImportSourceUser	Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserKeepAllAsPlaceholder

Introduced in GitLab 17.6. Status: Experiment.

Input type: ImportSourceUserKeepAllAsPlaceholderInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
namespaceId	NamespaceID!	Global ID of the namespace.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
updatedImportSourceUserCount	Int	Number of successfully updated mappings of users on source instance to their destination users.

Mutation.importSourceUserKeepAsPlaceholder

Introduced in GitLab 17.2. Status: Experiment.

Input type: ImportSourceUserKeepAsPlaceholderInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	ImportSourceUserID!	Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
importSourceUser	ImportSourceUser	Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserReassign

Introduced in GitLab 17.2. Status: Experiment.

Input type: ImportSourceUserReassignInput

Arguments

Name	Type	Description
assigneeUserId	UserID!	Global ID of the assignee user.
clientMutationId	String	A unique identifier for the client performing the mutation.
id	ImportSourceUserID!	Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
importSourceUser	ImportSourceUser	Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserResendNotification

Introduced in GitLab 17.2. Status: Experiment.

Input type: ImportSourceUserResendNotificationInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	ImportSourceUserID!	Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
importSourceUser	ImportSourceUser	Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserUndoKeepAsPlaceholder

Introduced in GitLab 18.4. Status: Experiment.

Input type: ImportSourceUserUndoKeepAsPlaceholderInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	ImportSourceUserID!	Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
importSourceUser	ImportSourceUser	Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.instanceAuditEventStreamingDestinationsCreate

Introduced in GitLab 16.11. Status: Experiment.

Input type: InstanceAuditEventStreamingDestinationsCreateInput

Arguments

Name	Type	Description
category	String!	Destination category.
clientMutationId	String	A unique identifier for the client performing the mutation.
config	JSON!	Destination config.
name	String	Destination name.
secretToken	String	Secret token.

Fields

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

Mutation.instanceAuditEventStreamingDestinationsDelete

Introduced in GitLab 16.11. Status: Experiment.

Input type: InstanceAuditEventStreamingDestinationsDeleteInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	AuditEventsInstanceExternalStreamingDestinationID!	ID of the audit events external streaming destination to delete.

Fields

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

Mutation.instanceAuditEventStreamingDestinationsUpdate

Introduced in GitLab 16.11. Status: Experiment.

Input type: InstanceAuditEventStreamingDestinationsUpdateInput

Arguments

Name	Type	Description
active	Boolean	Active status of the destination.
category	String	Destination category.
clientMutationId	String	A unique identifier for the client performing the mutation.
config	JSON	Destination config.
id	AuditEventsInstanceExternalStreamingDestinationID!	ID of external audit event destination to update.
name	String	Destination name.
secretToken	String	Secret token.

Fields

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

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 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 the mutation.

Mutation.instanceExternalAuditEventDestinationUpdate

Input type: InstanceExternalAuditEventDestinationUpdateInput

Arguments

Name	Type	Description
active	Boolean	Active status of the destination.
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 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 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 the mutation.

Mutation.instanceGoogleCloudLoggingConfigurationUpdate

Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput

Arguments

Name	Type	Description
active	Boolean	Active status of the destination.
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 the mutation.
instanceGoogleCloudLoggingConfiguration	InstanceGoogleCloudLoggingConfigurationType	configuration updated.

Mutation.integrationExclusionCreate

Introduced in GitLab 17.0. Status: Experiment.

Input type: IntegrationExclusionCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
groupIds	[GroupID!]	IDs of groups to exclude up to a maximum of 100.
integrationName	IntegrationType!	Type of integration to exclude.
projectIds	[ProjectID!]	IDs of projects to exclude up to a maximum of 100.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
exclusions	[IntegrationExclusion!]	Integration exclusions created by the mutation.

Mutation.integrationExclusionDelete

Introduced in GitLab 17.0. Status: Experiment.

Input type: IntegrationExclusionDeleteInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
groupIds	[GroupID!]	IDs of excluded groups.
integrationName	IntegrationType!	Type of integration.
projectIds	[ProjectID!]	IDs of excluded projects.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
exclusions	[IntegrationExclusion!]	Project no longer excluded due to the mutation.

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 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 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 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 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 {warning-solid}	EpicID	Deprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
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 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 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 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 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 the mutation.
issue	Issue	Issue after mutation.

Mutation.issueSetEpic

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: IssueSetEpicInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
epicId {warning-solid}	EpicID	Deprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
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 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 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 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 unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
issue	Issue	Issue after mutation.

Mutation.issueSetLocked

Input type: IssueSetLockedInput

Arguments

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

Fields

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

Mutation.issueSetSeverity

Input type: IssueSetSeverityInput

Arguments

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

Fields

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

Mutation.issueSetSubscription

Input type: IssueSetSubscriptionInput

Arguments

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

Fields

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

Mutation.issueSetWeight

Input type: IssueSetWeightInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
iid	String!	IID of the issue to mutate.
projectPath	ID!	Project the issue to mutate is in.
weight	Int	The desired weight for the issue. If set to null, weight is removed.

Fields

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

Mutation.issueUnlinkAlert

Input type: IssueUnlinkAlertInput

Arguments

Name	Type	Description
alertId	AlertManagementAlertID!	Global ID of the alert to unlink from 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 the mutation.
issue	Issue	Issue after mutation.

Mutation.iterationCadenceCreate

Input type: IterationCadenceCreateInput

Arguments

Name	Type	Description
active	Boolean!	Whether the iteration cadence is active.
automatic	Boolean!	Whether the iteration cadence should automatically generate upcoming iterations.
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks	Int	Duration in weeks of the iterations within the cadence.
groupPath	ID!	Group where the iteration cadence is created.
iterationsInAdvance	Int	Upcoming iterations to be created when iteration cadence is set to automatic.
rollOver	Boolean	Whether the iteration cadence should roll over issues to the next iteration or not.
startDate	Time	Timestamp of the automation start date.
title	String	Title of the iteration cadence.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
iterationCadence	IterationCadence	Created iteration cadence.

Mutation.iterationCadenceDestroy

Input type: IterationCadenceDestroyInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	IterationsCadenceID!	Global ID of the iteration cadence.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
group	Group!	Group the iteration cadence belongs to.

Mutation.iterationCadenceUpdate

Input type: IterationCadenceUpdateInput

Arguments

Name	Type	Description
active	Boolean	Whether the iteration cadence is active.
automatic	Boolean	Whether the iteration cadence should automatically generate upcoming iterations.
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks	Int	Duration in weeks of the iterations within the cadence.
id	IterationsCadenceID!	Global ID of the iteration cadence.
iterationsInAdvance	Int	Upcoming iterations to be created when iteration cadence is set to automatic.
rollOver	Boolean	Whether the iteration cadence should roll over issues to the next iteration or not.
startDate	Time	Timestamp of the automation start date.
title	String	Title of the iteration cadence.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
iterationCadence	IterationCadence	Updated iteration cadence.

Mutation.iterationCreate

Input type: iterationCreateInput

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 the mutation.
iteration	Iteration	Created iteration.

Mutation.iterationDelete

Input type: IterationDeleteInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
group	Group!	Group the iteration belongs to.

Mutation.jiraImportStart

Input type: JiraImportStartInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
jiraProjectKey	String!	Project key of the importer Jira project.
jiraProjectName {warning-solid}	String	Deprecated: Argument is not used. Deprecated in GitLab 17.4.
projectPath	ID!	Project to import the Jira project into.
usersMapping	[JiraUsersMappingInputType!]	Mapping of Jira to GitLab users.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
jiraImport	JiraImport	Jira import data after mutation.

Mutation.jiraImportUsers

Input type: JiraImportUsersInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
projectPath	ID!	Project to import the Jira users into.
startAt	Int	Index of the record the import should started at, default 0 (50 records returned).

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
jiraUsers	[JiraUser!]	Users returned from Jira, matched by email and name if possible.

Mutation.jobArtifactsDestroy

Input type: JobArtifactsDestroyInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
destroyedArtifactsCount	Int!	Number of artifacts deleted.
errors	[String!]!	Errors encountered during the mutation.
job	CiJob	Job with artifacts to be deleted.

Mutation.jobCancel

Input type: JobCancelInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
job	CiJob	Job after the mutation.

Mutation.jobPlay

Input type: JobPlayInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	CiProcessableID!	ID of the job to mutate.
variables	[CiVariableInput!]	Variables to use when playing a manual job.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
job	CiJob	Job after the mutation.

Mutation.jobRetry

Input type: JobRetryInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	CiProcessableID!	ID of the job to mutate.
variables	[CiVariableInput!]	Variables to use when retrying a manual job.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
job	CiJob	Job after the mutation.

Mutation.jobUnschedule

Input type: JobUnscheduleInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
job	CiJob	Job after the mutation.

Mutation.labelCreate

Input type: LabelCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
color	String	The color of the label given in 6-digit hex notation with leading '#' sign (for example, #FFAABB) or one of the CSS color names.
description	String	Description of the label.
groupPath	ID	Full path of the group with which the resource is associated.
projectPath	ID	Full path of the project with which the resource is associated.
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 the mutation.
label	Label	Label after mutation.

Mutation.labelUpdate

Input type: LabelUpdateInput

Arguments

Name	Type	Description
archived {warning-solid}	Boolean	Deprecated: Status: Experiment. Introduced in GitLab 18.4.
clientMutationId	String	A unique identifier for the client performing the mutation.
id	LabelID!	Global ID of the label to update.

Fields

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

Mutation.ldapAdminRoleLinkCreate

Introduced in GitLab 17.11. Status: Experiment.

Creates an instance-level custom admin role LDAP link.

Input type: LdapAdminRoleLinkCreateInput

Arguments

Name	Type	Description
adminMemberRoleId	MemberRoleID!	Global ID of the custom admin role to be assigned to a user.
clientMutationId	String	A unique identifier for the client performing the mutation.
cn	String	Common Name (CN) of the LDAP group.
filter	String	Search filter for the LDAP group.
provider	String!	LDAP provider for the LDAP link.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
ldapAdminRoleLink	LdapAdminRoleLink	Created instance-level LDAP link.

Mutation.ldapAdminRoleLinkDestroy

Introduced in GitLab 18.0. Status: Experiment.

Destroys an instance-level custom admin role LDAP link.

Input type: LdapAdminRoleLinkDestroyInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	AuthzLdapAdminRoleLinkID!	Global ID of the instance-level LDAP link to delete.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
ldapAdminRoleLink	LdapAdminRoleLink	Deleted instance-level LDAP link.

Mutation.lifecycleAttachWorkItemType

Introduced in GitLab 18.4. Status: Experiment.

Input type: LifecycleAttachWorkItemTypeInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
lifecycleId	WorkItemsStatusesLifecycleID!	Global ID of the lifecycle to attach the work item type to.
namespacePath	ID!	Namespace path where the lifecycle exists.
statusMappings	[StatusMappingInput!]	Status mappings from the old lifecycle to the new lifecycle.
workItemTypeId	WorkItemsTypeID!	Global ID of the work item type to attach to the lifecycle.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
lifecycle	WorkItemLifecycle	Lifecycle after attaching the work item type.

Mutation.lifecycleCreate

Introduced in GitLab 18.4. Status: Experiment.

Input type: LifecycleCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
defaultClosedStatusIndex	Int!	Index of the default closed status in the statuses array.
defaultDuplicateStatusIndex	Int!	Index of the default duplicated status in the statuses array.
defaultOpenStatusIndex	Int!	Index of the default open status in the statuses array.
name	String!	Name of the lifecycle.
namespacePath	ID!	Namespace path where the lifecycle will be created.
statuses	[WorkItemStatusInput!]!	Statuses of the lifecycle. Can be existing (with id) or new (without id).

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
lifecycle	WorkItemLifecycle	Lifecycle created.

Mutation.lifecycleDelete

Introduced in GitLab 18.4. Status: Experiment.

Input type: LifecycleDeleteInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	WorkItemsStatusesLifecycleID!	Global ID of the lifecycle to delete.
namespacePath	ID!	Namespace path where the lifecycle exists.

Fields

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

Mutation.lifecycleUpdate

Introduced in GitLab 18.1. Status: Experiment.

Input type: LifecycleUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
defaultClosedStatusIndex	Int	Index of the default closed status in the statuses array.
defaultDuplicateStatusIndex	Int	Index of the default duplicated status in the statuses array.
defaultOpenStatusIndex	Int	Index of the default open status in the statuses array.
id	WorkItemsStatusesLifecycleID!	Global ID of the lifecycle to be updated.
name	String	Name of the lifecycle.
namespacePath	ID!	Namespace path where the lifecycle exists.
statusMappings	[StatusMappingInput!]	Mappings for statuses being removed from the lifecycle. Maps old status to replacement status.
statuses	[WorkItemStatusInput!]	Statuses of the lifecycle. Can be existing (with id) or new (without id).

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
lifecycle	WorkItemLifecycle	Lifecycle updated.

Mutation.linkProjectComplianceViolationIssue

Introduced in GitLab 18.3. Status: Experiment.

Input type: LinkProjectComplianceViolationIssueInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
issueIid	String!	IID of the issue to be linked.
projectPath	ID!	Full path of the project the issue belongs to.
violationId	ComplianceManagementProjectsComplianceViolationID!	Global ID of the project compliance violation.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
violation	ProjectComplianceViolation	Updated project compliance violation.

Mutation.markAsSpamSnippet

Input type: MarkAsSpamSnippetInput

Arguments

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

Fields

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

Mutation.mavenUpstreamCreate

Introduced in GitLab 18.2. Status: Experiment.

Input type: MavenUpstreamCreateInput

Arguments

Name	Type	Description
cacheValidityHours	Int	Cache validity period. Defaults to 24 hours.
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the upstream registry.
id	VirtualRegistriesPackagesMavenRegistryID!	ID of the upstream registry.
metadataCacheValidityHours {warning-solid}	Int	Deprecated: Status: Experiment. Introduced in GitLab 18.4.
name	String!	Name of upstream registry.
password	String	Password of the upstream registry.
url	String!	URL of the upstream registry.
username	String	Username of the upstream registry.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
upstream	MavenUpstream	Maven upstream after the mutation.

Mutation.memberRoleAdminCreate

Introduced in GitLab 17.7. Status: Experiment.

Input type: MemberRoleAdminCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the member role.
name	String	Name of the member role.
permissions	[MemberRoleAdminPermission!]	List of all customizable admin permissions.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
memberRole	AdminMemberRole	Member role.

Mutation.memberRoleAdminDelete

Introduced in GitLab 17.10. Status: Experiment.

Input type: MemberRoleAdminDeleteInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	MemberRoleID!	ID of the admin member role to delete.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
memberRole	MemberRole	Deleted admin member role.

Mutation.memberRoleAdminUpdate

Introduced in GitLab 17.10. Status: Experiment.

Input type: MemberRoleAdminUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the member role.
id	MemberRoleID!	ID of the member role to mutate.
name	String	Name of the member role.
permissions	[MemberRoleAdminPermission!]	List of all customizable admin permissions.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
memberRole	AdminMemberRole	Member role.

Mutation.memberRoleCreate

Introduced in GitLab 16.5. Status: Experiment.

Input type: MemberRoleCreateInput

Arguments

Name	Type	Description
baseAccessLevel	MemberRolesAccessLevel!	Base access level for the custom role.
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the member role.
groupPath	ID	Group the member role to mutate is in. Required for SaaS.
name	String	Name of the member role.
permissions	[MemberRolePermission!]	List of all customizable permissions.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
memberRole	MemberRole	Member role.

Mutation.memberRoleDelete

Introduced in GitLab 16.7. Status: Experiment.

Input type: MemberRoleDeleteInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
memberRole	MemberRole	Deleted member role.

Mutation.memberRoleToUserAssign

Introduced in GitLab 17.7. Status: Experiment.

Input type: MemberRoleToUserAssignInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
memberRoleId	MemberRoleID	Global ID of the custom role to be assigned to a user. Admin roles will be unassigned from the user if omitted or set as NULL.
userId	UserID!	Global ID of the user to be assigned to a custom role.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
userMemberRole	UserMemberRole	Created user member role or nil if the relation was deleted.

Mutation.memberRoleUpdate

Input type: MemberRoleUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the member role.
id	MemberRoleID!	ID of the member role to mutate.
name	String	Name of the member role.
permissions	[MemberRolePermission!]	List of all customizable permissions.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
memberRole	MemberRole	Member role.

Mutation.mergeRequestAccept

Accepts a merge request. When accepted, the source branch will be scheduled to merge into the target branch, either immediately if possible, or using one of the automatic merge strategies.

In GitLab 16.5, the merging happens asynchronously. This results in mergeRequest and state not updating after a mutation request, because the merging may not have happened yet.

Input type: MergeRequestAcceptInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
commitMessage	String	Custom merge commit message.
iid	String!	IID of the merge request to mutate.
projectPath	ID!	Project the merge request to mutate is in.
sha	String!	HEAD SHA at the time when the merge was requested.
shouldRemoveSourceBranch	Boolean	Should the source branch be removed.
squash	Boolean	Squash commits on the source branch before merge.
squashCommitMessage	String	Custom squash commit message (if squash is true).
strategy	MergeStrategyEnum	How to merge the merge request.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestCreate

Input type: MergeRequestCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the merge request (Markdown rendered as HTML for caching).
labels	[String!]	Labels of the merge request.
mergeAfter	Time	Date after which the merge request can be merged.
projectPath	ID!	Project full path the merge request is associated with.
removeSourceBranch	Boolean	Indicates if the source branch of the merge request will be deleted after merge.
sourceBranch	String!	Source branch of the merge request.
targetBranch	String!	Target branch of the merge request.
title	String!	Title of the merge request.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestDestroyRequestedChanges

Input type: MergeRequestDestroyRequestedChangesInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestReviewerRereview

Input type: MergeRequestReviewerRereviewInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
iid	String!	IID of the merge request to mutate.
projectPath	ID!	Project the merge request to mutate is in.
userId	UserID!	User ID for the user that has been requested for a new review.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestSetAssignees

Input type: MergeRequestSetAssigneesInput

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 merge request to mutate.
operationMode	MutationOperationMode	Operation to perform. Defaults to REPLACE.
projectPath	ID!	Project the merge request to mutate is in.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestSetDraft

Input type: MergeRequestSetDraftInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestSetLabels

Input type: MergeRequestSetLabelsInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
iid	String!	IID of the merge request to mutate.
labelIds	[LabelID!]!	Label IDs to set. Replaces existing labels by default.
operationMode	MutationOperationMode	Changes the operation mode. Defaults to REPLACE.
projectPath	ID!	Project the merge request to mutate is in.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestSetLocked

Input type: MergeRequestSetLockedInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
iid	String!	IID of the merge request to mutate.
locked	Boolean!	Whether or not to lock the merge request.
projectPath	ID!	Project the merge request to mutate is in.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestSetMilestone

Input type: MergeRequestSetMilestoneInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
iid	String!	IID of the merge request to mutate.
milestoneId	MilestoneID	Milestone to assign to the merge request.
projectPath	ID!	Project the merge request to mutate is in.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestSetReviewers

Input type: MergeRequestSetReviewersInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestSetSubscription

Input type: MergeRequestSetSubscriptionInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
iid	String!	IID of the merge request to mutate.
projectPath	ID!	Project the merge request to mutate is in.
subscribedState	Boolean!	Desired state of the subscription.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestUpdate

Update attributes of a merge request.

Input type: MergeRequestUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the merge request (Markdown rendered as HTML for caching).
iid	String!	IID of the merge request to mutate.
mergeAfter	Time	Date after which the merge request can be merged.
overrideRequestedChanges	Boolean	Override all requested changes. Can only be set by users who have permissionto merge this merge request.
projectPath	ID!	Project the merge request to mutate is in.
removeSourceBranch	Boolean	Indicates if the source branch of the merge request will be deleted after merge.
state	MergeRequestNewState	Action to perform to change the state.
targetBranch	String	Target branch of the merge request.
timeEstimate	String	Estimated time to complete the merge request. Use null or 0 to remove the current estimate.
title	String	Title of the merge request.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeRequestUpdateApprovalRule

Input type: MergeRequestUpdateApprovalRuleInput

Arguments

Name	Type	Description
approvalRuleId	Int!	ID of an approval rule.
approvalsRequired	Int!	Number of required approvals for a given rule.
clientMutationId	String	A unique identifier for the client performing the mutation.
groupIds	[String!]	IDs of groups as approvers.
iid	String!	IID of the merge request to mutate.
name	String!	Name of the approval rule.
projectPath	ID!	Project the merge request to mutate is in.
removeHiddenGroups	Boolean	Whether hidden groups should be removed.
userIds	[String!]	IDs of users as approvers.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
mergeRequest	MergeRequest	Merge request after mutation.

Mutation.mergeTrainsDeleteCar

Introduced in GitLab 17.2. Status: Experiment.

Input type: MergeTrainsDeleteCarInput

Arguments

Name	Type	Description
carId	MergeTrainsCarID!	Global ID of the car.
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 the mutation.

Mutation.mlModelCreate

Introduced in GitLab 16.8. Status: Experiment.

Input type: MlModelCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the model.
name	String!	Name of the model.
projectPath	ID!	Project the model to mutate is in.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
model	MlModel	Model after mutation.

Mutation.mlModelDelete

Introduced in GitLab 17.0. Status: Experiment.

Input type: MlModelDeleteInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	MlModelID!	Global ID of the model to be deleted.
projectPath	ID!	Project the model to mutate is in.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
model	MlModel	Model after mutation.

Mutation.mlModelDestroy

Introduced in GitLab 16.10. Status: Experiment.

Input type: MlModelDestroyInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	MlModelID!	Global ID of the model to be deleted.
projectPath	ID!	Project the model to mutate is in.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
message	String	Model deletion result message.
model	MlModel	Model after mutation.

Mutation.mlModelEdit

Introduced in GitLab 17.3. Status: Experiment.

Input type: MlModelEditInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the model.
modelId	Int	Id of the model.
name	String!	Name of the model.
projectPath	ID!	Project the model to mutate is in.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
model	MlModel	Model after mutation.

Mutation.mlModelVersionCreate

Introduced in GitLab 17.1. Status: Experiment.

Input type: MlModelVersionCreateInput

Arguments

Name	Type	Description
candidateId	MlCandidateID	Global ID of a candidate to promote optionally.
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the model version.
modelId	MlModelID!	Global ID of the model the version belongs to.
projectPath	ID!	Project the model to mutate is in.
version	String	Model version.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
modelVersion	MlModelVersion	Model after mutation.

Mutation.mlModelVersionDelete

Introduced in GitLab 17.0. Status: Experiment.

Input type: MlModelVersionDeleteInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	MlModelVersionID!	Global ID of the model version to be deleted.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
modelVersion	MlModelVersion	Deleted model version.

Mutation.mlModelVersionEdit

Introduced in GitLab 17.4. Status: Experiment.

Input type: MlModelVersionEditInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String!	Description of the model version.
modelId	MlModelID!	Global ID of the model the version belongs to.
projectPath	ID!	Project the model to mutate is in.
version	String!	Model version.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
modelVersion	MlModelVersion	Model after mutation.

Mutation.namespaceBanDestroy

Input type: NamespaceBanDestroyInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	NamespacesNamespaceBanID!	Global ID of the namespace ban to remove.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
namespaceBan	NamespaceBan	Namespace Ban.

Mutation.namespaceCiCdSettingsUpdate

Input type: NamespaceCiCdSettingsUpdateInput

Arguments

Name	Type	Description
allowStaleRunnerPruning	Boolean	Indicates if stale runners directly belonging to the namespace should be periodically pruned.
clientMutationId	String	A unique identifier for the client performing the mutation.
fullPath	ID!	Full path of the namespace the settings belong to.

Fields

Name	Type	Description
ciCdSettings	NamespaceCiCdSetting!	CI/CD settings after mutation.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.namespaceCreateRemoteDevelopmentClusterAgentMapping

Input type: NamespaceCreateRemoteDevelopmentClusterAgentMappingInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
clusterAgentId	ClustersAgentID!	GlobalID of the cluster agent to be associated with the namespace.
namespaceId	NamespaceID!	GlobalID of the namespace to be associated with the cluster agent.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
namespaceClusterAgentMapping {warning-solid}	NamespaceClusterAgentMapping	Deprecated: Status: Experiment. Introduced in GitLab 17.10.

Mutation.namespaceDeleteRemoteDevelopmentClusterAgentMapping

Input type: NamespaceDeleteRemoteDevelopmentClusterAgentMappingInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
clusterAgentId	ClustersAgentID!	GlobalID of the cluster agent to be un-associated from the namespace.
namespaceId	NamespaceID!	GlobalID of the namespace to be un-associated from the cluster agent.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
namespaceClusterAgentMapping {warning-solid}	NamespaceClusterAgentMapping	Deprecated: Status: Experiment. Introduced in GitLab 17.11.

Mutation.namespaceSettingsUpdate

Introduced in GitLab 17.9. Status: Experiment.

Input type: NamespaceSettingsUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
fullPath	ID!	Full path of the namespace the settings belong to.
pipelineVariablesDefaultRole	PipelineVariablesDefaultRoleType	Indicates the default minimum role required to override pipeline variables in the namespace.

Fields

Name	Type	Description
ciCdSettings	CiCdSettings!	Namespace CI/CD settings after mutation.
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.

Mutation.namespacesRegenerateNewWorkItemEmailAddress

Introduced in GitLab 18.2. Status: Experiment.

Input type: NamespacesRegenerateNewWorkItemEmailAddressInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
fullPath	ID!	Full path of the namespace to regenerate the new work item email address for.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
namespace	Namespace	Namespace after regenerating the new work item email address.

Mutation.noteConvertToThread

Convert a standard comment to a resolvable thread.

Input type: NoteConvertToThreadInput

Arguments

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

Fields

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

Mutation.oncallRotationCreate

Input type: OncallRotationCreateInput

Arguments

Name	Type	Description
activePeriod	OncallRotationActivePeriodInputType	Active period of time that the on-call rotation should take place.
clientMutationId	String	A unique identifier for the client performing the mutation.
endsAt	OncallRotationDateInputType	End date and time of the on-call rotation, in the timezone of the on-call schedule.
name	String!	Name of the on-call rotation.
participants	[OncallUserInputType!]!	Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
projectPath	ID!	Project to create the on-call schedule in.
rotationLength	OncallRotationLengthInputType!	Rotation length of the on-call rotation.
scheduleIid	String!	IID of the on-call schedule to create the on-call rotation in.
startsAt	OncallRotationDateInputType!	Start date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
oncallRotation	IncidentManagementOncallRotation	On-call rotation.

Mutation.oncallRotationDestroy

Input type: OncallRotationDestroyInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	IncidentManagementOncallRotationID!	ID of the on-call rotation to remove.
projectPath	ID!	Project to remove the on-call schedule from.
scheduleIid	String!	IID of the on-call schedule to the on-call rotation belongs to.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
oncallRotation	IncidentManagementOncallRotation	On-call rotation.

Mutation.oncallRotationUpdate

Input type: OncallRotationUpdateInput

Arguments

Name	Type	Description
activePeriod	OncallRotationActivePeriodInputType	Active period of time that the on-call rotation should take place.
clientMutationId	String	A unique identifier for the client performing the mutation.
endsAt	OncallRotationDateInputType	End date and time of the on-call rotation, in the timezone of the on-call schedule.
id	IncidentManagementOncallRotationID!	ID of the on-call schedule to create the on-call rotation in.
name	String	Name of the on-call rotation.
participants	[OncallUserInputType!]	Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
rotationLength	OncallRotationLengthInputType	Rotation length of the on-call rotation.
startsAt	OncallRotationDateInputType	Start date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
oncallRotation	IncidentManagementOncallRotation	On-call rotation.

Mutation.oncallScheduleCreate

Input type: OncallScheduleCreateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the on-call schedule.
name	String!	Name of the on-call schedule.
projectPath	ID!	Project to create the on-call schedule in.
timezone	String!	Timezone of the on-call schedule.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
oncallSchedule	IncidentManagementOncallSchedule	On-call schedule.

Mutation.oncallScheduleDestroy

Input type: OncallScheduleDestroyInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
iid	String!	On-call schedule internal ID to remove.
projectPath	ID!	Project to remove the on-call schedule from.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
oncallSchedule	IncidentManagementOncallSchedule	On-call schedule.

Mutation.oncallScheduleUpdate

Input type: OncallScheduleUpdateInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the on-call schedule.
iid	String!	On-call schedule internal ID to update.
name	String	Name of the on-call schedule.
projectPath	ID!	Project to update the on-call schedule in.
timezone	String	Timezone of the on-call schedule.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
oncallSchedule	IncidentManagementOncallSchedule	On-call schedule.

Mutation.organizationCreate

Introduced in GitLab 16.6. Status: Experiment.

Input type: OrganizationCreateInput

Arguments

Name	Type	Description
avatar	Upload	Avatar for the organization.
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the organization.
name	String!	Name for the organization.
path	String!	Path for the organization.

Fields

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

Mutation.organizationCreateClusterAgentMapping

Introduced in GitLab 17.11. Status: Experiment.

Input type: OrganizationCreateClusterAgentMappingInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
clusterAgentId	ClustersAgentID!	GlobalID of the cluster agent to be associated with the organization.
organizationId	OrganizationsOrganizationID!	GlobalID of the organization to be associated with the cluster agent.

Fields

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

Mutation.organizationDeleteClusterAgentMapping

Introduced in GitLab 17.11. Status: Experiment.

Input type: OrganizationDeleteClusterAgentMappingInput

Arguments

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
clusterAgentId	ClustersAgentID!	GlobalID of the cluster agent to be dissociated with the organization.
organizationId	OrganizationsOrganizationID!	GlobalID of the organization to be dissociated with the cluster agent.

Fields

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

Mutation.organizationUpdate

Introduced in GitLab 16.7. Status: Experiment.

Input type: OrganizationUpdateInput

Arguments

Name	Type	Description
avatar	Upload	Avatar for the organization.
clientMutationId	String	A unique identifier for the client performing the mutation.
description	String	Description of the organization.
id	OrganizationsOrganizationID!	ID of the organization to mutate.
name	String	Name for the organization.
path	String	Path for the organization.

Fields

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

Mutation.organizationUserUpdate

Introduced in GitLab 17.5. Status: Experiment.

Input type: OrganizationUserUpdateInput

Arguments

Name	Type	Description
accessLevel	OrganizationUserAccessLevel!	Access level to update the organization user to.
clientMutationId	String	A unique identifier for the client performing the mutation.
id	OrganizationsOrganizationUserID!	ID of the organization user to mutate.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
organizationUser {warning-solid}	OrganizationUser	Deprecated: Status: Experiment. Introduced in GitLab 17.5.

Mutation.pagesMarkOnboardingComplete

Input type: PagesMarkOnboardingCompleteInput

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
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
onboardingComplete	Boolean!	Indicates the new onboarding_complete state of the project's Pages metadata.

Mutation.pipelineCancel

Input type: PipelineCancelInput

Arguments

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

Fields

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

Mutation.pipelineCreate

Input type: PipelineCreateInput

Arguments

Name	Type	Description
async {warning-solid}	Boolean	Deprecated: Status: Experiment. Introduced in GitLab 17.8.
clientMutationId	String	A unique identifier for the client performing the mutation.
inputs {warning-solid}	[CiInputsInput!]	Deprecated: Status: Experiment. Introduced in GitLab 17.10.
projectPath	ID!	Full path of the project that is triggering the pipeline.
ref	String!	Ref on which to run the pipeline.
variables	[CiVariableInput!]	Variables for the pipeline.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
pipeline	Pipeline	Pipeline created after mutation. Null if async: true.
requestId {warning-solid}	String	Deprecated: Status: Experiment. Introduced in GitLab 17.8.

Mutation.pipelineDestroy

Input type: PipelineDestroyInput

Arguments

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

Fields

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

Mutation.pipelineRetry

Input type: PipelineRetryInput

Arguments

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

Fields

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

Mutation.pipelineScheduleCreate

Input type: PipelineScheduleCreateInput

Arguments

Name	Type	Description
active	Boolean	Indicates if the pipeline schedule should be active or not.
clientMutationId	String	A unique identifier for the client performing the mutation.
cron	String!	Cron expression of the pipeline schedule.
cronTimezone	String	Cron time zone supported by ActiveSupport::TimeZone. For example: "Pacific Time (US & Canada)" (default: "UTC").
description	String!	Description of the pipeline schedule.
inputs {warning-solid}	[CiInputsInput!]	Deprecated: Status: Experiment. Introduced in GitLab 17.10.
projectPath	ID!	Full path of the project the pipeline schedule is associated with.
ref	String!	Ref of the pipeline schedule.
variables	[PipelineScheduleVariableInput!]	Variables for the pipeline schedule.

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
pipelineSchedule	PipelineSchedule	Created pipeline schedule.

Mutation.pipelineScheduleDelete

Input type: PipelineScheduleDeleteInput

Arguments

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

Fields

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

Mutation.pipelineSchedulePlay

Input type: PipelineSchedulePlayInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
pipelineSchedule	PipelineSchedule	Pipeline schedule after mutation.

Mutation.pipelineScheduleTakeOwnership

Input type: PipelineScheduleTakeOwnershipInput

Arguments

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

Fields

Name	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
errors	[String!]!	Errors encountered during the mutation.
pipelineSchedule	PipelineSchedule	Updated pipeline schedule ownership.

Mutation.pipelineScheduleUpdate

Input type: PipelineScheduleUpdateInput

Arguments

Name	Type	Description
active	Boolean	Indicates if the pipeline schedule should be active or not.
clientMutationId	String	A unique identifier for the client performing the mutation.
cron	String	Cron expression of the pipeline schedule.
cronTimezone	String	Cron time zone supported by ActiveSupport::TimeZone. For example: "Pacific Time (US & Canada)" (default: "UTC").
description	String	Description of the pipeline schedule.
id	CiPipelineScheduleID!	ID of the pipeline schedule to mutate.
inputs {warning-solid}	[CiInputsInput!]	Deprecated: Status: Experiment. Introduced in GitLab 17.11.
ref