Help us learn about your current experience with the documentation. Take the survey.

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:

NameTypeDescription
idAbuseReportID!ID of the abuse report.

Query.accessTokenPermissions

  • Introduced in GitLab 18.6.
  • Status: Experiment.

List of permissions for fine-grained access tokens.

Returns [AccessTokenPermission!]!.

Query.addOnPurchases

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

Returns [AddOnPurchase!].

Arguments:

NameTypeDescription
namespaceIdNamespaceIDID of namespace that the add-ons were purchased for.

Query.adminDuoAvailabilityNamespaces

  • Introduced in GitLab 19.2.
  • Status: Experiment.

List groups with their resolved GitLab Duo availability for admin overrides.

Returns AdminDuoAvailabilityNamespaceConnection.

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

Arguments:

NameTypeDescription
adminLockedBooleanFilter to groups that are (or are not) the introducer of an admin lock.
duoAvailability[DuoAvailability!]Filter to groups whose effective availability is one of these values.
includeDescendantsBooleanInclude all descendants, not just direct children, of the parent group.
parentIdGroupIDRestrict the list to descendants of the given group.
searchStringFilter groups by name or full path.

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:

NameTypeDescription
activeBooleanWhen 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.
aimedForDeletionBooleanFilter groups that are marked for deletion.
allAvailableBooleanWhen 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.
includeSubgroupsBooleanInclude descendant groups of the group given in parentPath. Ignored unless parentPath is also provided.
markedForDeletionOnDateDate when the group was marked for deletion.
notBaseGroupsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
ownedOnlyBooleanOnly include groups where the current user has an owner role.
parentPathIDFull path of the parent group.
searchStringSearch query for group name or group full path.
sortStringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topLevelOnlyBooleanOnly include top-level groups.
visibilityLevelVisibilityLevelsEnumFilter groups by visibility level.

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:

NameTypeDescription
assignableBooleanFilter for member roles the current user can assign.
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering 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:

NameTypeDescription
assignableBooleanFilter for member roles the current user can assign.
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering 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:

NameTypeDescription
activeBooleanFilters by projects that are not archived and not marked for deletion.
aimedForDeletionBooleanReturn only projects marked for deletion.
archivedProjectArchivedFilter projects by archived status.
duoLicensedFeature warning-solidDuoLicensedFeatureIntroduced in GitLab 18.11. Status: Experiment. Include only projects eligible for the specified GitLab Duo licensed feature. Results are automatically filtered to projects where the user has the Maintainer or Owner role.
fullPaths[String!]Filter projects by full paths. You cannot provide more than 50 full paths.
ids[ID!]Filter projects by IDs.
includeHiddenBooleanInclude hidden projects.
lastRepositoryCheckFailedBooleanReturn only projects where the last repository check failed. Only available for administrators.
markedForDeletionOnDateDate when the project was marked for deletion.
membershipBooleanReturn only projects that the current user is a member of.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
namespacePathIDFilter projects by their namespace’s full path (group or user).
notAimedForDeletionBooleanExclude projects that are marked for deletion.
personalBooleanReturn only personal projects.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: css or ruby.
searchStringSearch query, which can be for the project name, a path, or a description.
searchNamespacesBooleanInclude namespace in project search.
sortStringSort 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 warning-solidBooleanDeprecated in GitLab 18.8. No longer functional. Underlying feature was removed in 19.0.
visibilityLevelVisibilityLevelsEnumFilter projects by visibility level.
withIssuesEnabledBooleanReturn only projects with issues enabled.
withMergeRequestsEnabledBooleanReturn 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:

NameTypeDescription
agentVersionIdAiCatalogItemVersionID!Global ID of the agent version to use.
flowConfigTypeAiCatalogFlowConfigType!Type of flow configuration to generate.

Query.aiCatalogAvailableFlowsForProject

  • Introduced in GitLab 18.9.
  • Status: Experiment.

AI Catalog flows available to enable for a project.

Returns AiCatalogItemConsumerConnection!.

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

Arguments:

NameTypeDescription
projectIdProjectID!Project ID to retrieve available AI Catalog flows for.

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:

NameTypeDescription
configurableForProjectIdProjectIDProject ID to filter AI Catalog item consumers. When provided with group_id, returns only consumers whose associated items are configurable within the project (i.e., group-enabled items that are public or owned by the project). Excludes consumers for items that are private to other projects.
foundationalFlowReferenceStringFilter by foundational flow reference.
groupIdGroupIDGroup ID to retrieve configured AI Catalog items for.
includeFoundationalConsumers warning-solidBooleanIntroduced in GitLab 18.10. Status: Experiment. Include configured foundational AI Catalog items.
includeInheritedBooleanInclude configured AI Catalog items inherited from parent groups.
itemIdAiCatalogItemIDItem ID to retrieve configured AI Catalog items for.
itemTypeAiCatalogItemTypeType of items to retrieve.
itemTypes[AiCatalogItemType!]Types of items to retrieve.
projectIdProjectIDProject ID to retrieve configured AI Catalog items for.

Query.aiCatalogCustomAndFoundationalItems

  • Introduced in GitLab 19.0.
  • Status: Experiment.

List of AI Catalog items, including foundational items.

Returns AiCatalogCustomAndFoundationalItemConnection!.

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

Arguments:

NameTypeDescription
itemTypes[AiCatalogItemType!]Types of items to retrieve.
searchStringSearch items by name and description.
sortAiCatalogItemsSortSort order of items.

Query.aiCatalogItem

  • Introduced in GitLab 18.2.
  • Status: Experiment.

Find an AI Catalog item.

Returns AiCatalogItem.

Arguments:

NameTypeDescription
idAiCatalogItemID!Global ID of the catalog item to find.
showSoftDeletedBooleanWhether to show the item if it has been soft-deleted. Defaults to false.

Query.aiCatalogItemConsumer

  • Introduced in GitLab 18.5.
  • Status: Experiment.

Find a single AI Catalog item consumer by ID.

Returns AiCatalogItemConsumer.

Arguments:

NameTypeDescription
idAiCatalogItemConsumerID!Global ID of the AI Catalog item consumer.

Query.aiCatalogItemVersions

  • Introduced in GitLab 18.8.
  • Status: Experiment.

Public AI Catalog item versions.

Returns AiCatalogItemVersionConnection!.

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

Arguments:

NameTypeDescription
createdAfterTimeItem versions created after the timestamp.
excludeDeprecatedBooleanWhether to exclude deprecated versions from the results. Defaults to true.

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:

NameTypeDescription
itemTypeAiCatalogItemTypeType of items to retrieve.
itemTypes[AiCatalogItemType!]Types of items to retrieve.
searchStringSearch items by name and description.
sortAiCatalogItemsSortSort order of items.

Query.aiCatalogMcpServer

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Find an AI Catalog MCP server by ID.

Returns AiCatalogMcpServer.

Arguments:

NameTypeDescription
idAiCatalogMcpServerID!Global ID of the MCP server.

Query.aiCatalogMcpServers

  • Introduced in GitLab 18.10.
  • Status: Experiment.

List of AI Catalog MCP servers.

Returns AiCatalogMcpServerConnection!.

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

Query.aiCatalogMcpTools

  • Introduced in GitLab 18.11.
  • Status: Experiment.

List of MCP tools dynamically discovered from the GitLab MCP server.

Returns AiCatalogMcpToolConnection!.

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

Query.aiChatAvailableModels

  • Introduced in GitLab 18.4.
  • Status: Experiment.

Get available models for Duo Agentic Chat.

Returns AvailableModels.

Arguments:

NameTypeDescription
namespaceIdGroupIDGlobal ID of the namespace the user is acting on.
projectIdProjectIDGlobal ID of the project the user is acting on.
rootNamespaceIdGroupIDGlobal ID of the top-level 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:

NameTypeDescription
projectIdProjectIDGlobal ID of the project the user is acting on.
questionCountIntNumber of questions for the default screen.
resourceIdAiModelIDGlobal ID of the resource from the current page.
urlStringURL of the page the user is currently on.

Query.aiChatIncludedProjects

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Get projects that can be included by the current user in a GitLab Duo Chat context.

Returns ProjectConnection.

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

Arguments:

NameTypeDescription
searchStringSearch query, which can be for the project name or path. Minimum 3 characters.

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:

NameTypeDescription
conversationTypeAiConversationsThreadsConversationTypeConversation type of the thread.
idAiConversationThreadIDId of the thread.

Query.aiDomainSettings

  • Introduced in GitLab 19.0.
  • Status: Experiment.

List of allowed or denied domains for AI features.

Returns StringConnection.

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

Arguments:

NameTypeDescription
domainSettingTypeAiDomainSettingType!Type of domain setting to retrieve.
searchStringFilter domains by substring match.

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:

NameTypeDescription
selfHostedModelIdAiSelfHostedModelIDGlobal ID of the self-hosted model.

Query.aiFlowsMetadata

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Metadata describing Duo Agent Platform flow capabilities available to the caller.

Returns AiFlowsMetadata.

Arguments:

NameTypeDescription
namespaceIdNamespaceIDGlobal ID of the group or personal namespace to compute flow capabilities for. When omitted, only namespace-independent capabilities are returned.
projectIdProjectIDGlobal ID of the project to compute flow capabilities for. Takes precedence over namespaceId when both are given.

Query.aiFoundationalChatAgent

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Core agent in GitLab.

Returns AiFoundationalChatAgent.

Arguments:

NameTypeDescription
referenceString!Reference to the foundational chat agent.

Query.aiFoundationalChatAgents

  • Introduced in GitLab 18.6.
  • Status: Experiment.

Core agents in GitLab.

Returns AiFoundationalChatAgentConnection!.

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

Arguments:

NameTypeDescription
namespaceIdNamespaceIDGlobal ID of the namespace where the chat is present.
projectIdProjectIDGlobal ID of the project where the chat is present.

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:

NameTypeDescription
conversationTypeAiConversationsThreadsConversationTypeConversation type of the thread.
requestIds[ID!]Array of request IDs to fetch.
roles[AiMessageRole!]Array of roles to fetch.
threadIdAiConversationThreadIDGlobal 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:

NameTypeDescription
groupIdGroupID!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:

NameTypeDescription
idAiSelfHostedModelIDGlobal 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:

NameTypeDescription
urlString!URL of the page the user is currently on.

Query.aiToolRules

  • Introduced in GitLab 19.1.
  • Status: Experiment.

AI tool governance rules for a namespace.

Returns AiToolRuleConnection.

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

Arguments:

NameTypeDescription
actionTypeAiToolActionTypeFilter tools by action type.
fullPathID!Full path of the root namespace to fetch tool rules for.
projectPathIDFull path of the project to fetch effective tool rules for. When provided, returns the merged effective rules for the project, applying most-restrictive-wins across namespace and project rules.
searchStringCase-insensitive text search on tool name or display name.

Query.aiUsageData

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Instance level AI-related data. Admins only.

Returns AiInstanceUsageData.

Query.artifactRegistryRoleAssignments

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Direct Artifact Registry role assignments on the given resources. Returns only roles assigned on a resource itself, not members who inherit access from a membership on an ancestor namespace, so it is not a complete list of everyone who can access the resource.

Returns ArtifactRegistryRoleAssignmentConnection.

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

Arguments:

NameTypeDescription
resourceIds[String!]UUIDs of the Artifact Registry resources to read role assignments for. Empty reads the whole organization, which only the organization owner may do.
roles[ArtifactRegistryRole!]Only return assignments for these roles.

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

  • Deprecated in GitLab 18.10.
  • Use auditEventsInstanceStreamingDestinations with amazonS3 category instead.

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:

NameTypeDescription
chunkCount warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Maximum chunks per file.
excludeForks warning-solidBooleanIntroduced in GitLab 17.11. Status: Experiment. Excludes forked projects in the search. Always false for project search. Default is true.
groupId warning-solidGroupIDIntroduced in GitLab 17.2. Status: Experiment. Group to search in.
includeArchived warning-solidBooleanIntroduced in GitLab 17.7. Status: Experiment. Includes archived projects in the search. Always true for project search. Default is false.
language warning-solid[String!]Introduced in GitLab 19.3. Status: Experiment. Filter results to the given detected languages (for example, ["Ruby", "Go"]). Requires the zoekt_language_aggregations feature flag.
page warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Page number to fetch the results.
perPage warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Number of results per page.
projectId warning-solidProjectIDIntroduced in GitLab 17.2. Status: Experiment. Project to search in.
regex warning-solidBooleanIntroduced in GitLab 17.3. Status: Experiment. Uses the regular expression search mode. Default is false.
repositoryRef warning-solidStringIntroduced in GitLab 17.2. Status: Experiment. Repository reference to search in.
searchString!Searched term.

Query.boardList

Find an issue board list.

Returns BoardList.

Arguments:

NameTypeDescription
idListID!Global ID of the list.
issueFiltersBoardIssueInputFilters applied when getting issue metadata in the board list.

Query.ciApplicationSettings

CI related settings that apply to the entire instance.

Returns CiApplicationSettings.

Query.ciCatalogBundledResources

  • Introduced in GitLab 19.3.
  • Status: Experiment.

GitLab-maintained bundled CI/CD Catalog resources available on the current cell.

Returns CiCatalogBundledResourceConnection.

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

Query.ciCatalogResource

  • Introduced in GitLab 16.1.
  • Status: Experiment.

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

Returns CiCatalogResource.

Arguments:

NameTypeDescription
fullPathIDCI/CD Catalog resource full path.
idCiCatalogResourceIDCI/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:

NameTypeDescription
groupIds[GroupID!]Filter catalog resources to those whose project namespace matches one of the given groups.
minAccessLevelAccessLevelEnumMinimum access level required for the user on the catalog resource project.
scopeCiCatalogResourceScopeScope of the returned catalog resources.
searchStringSearch term to filter the catalog resources by name or description.
sortCiCatalogResourceSortSort catalog resources by given criteria.
topics[String!]Filter catalog resources by project topic names.
verificationLevelCiCatalogResourceVerificationLevelFilter catalog resources by verification level.

Query.ciConfig

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

Returns CiConfig.

Arguments:

NameTypeDescription
contentString!Contents of .gitlab-ci.yml.
dryRunBooleanRun pipeline creation simulation, or only do static check.
projectPathID!Project of the CI config.
shaStringSha for the pipeline.
skipVerifyProjectSha warning-solidBooleanIntroduced 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:

NameTypeDescription
billingMonthDateFirst day of the month to retrieve data for.
groupingGroupingEnumGroups usage data by instance aggregate or root namespace.
runnerIdCiRunnerIDRunner ID to retrieve data for.
yearIntYear to retrieve data for.

Query.ciMinutesProjectMonthlyUsage

Compute usage data for projects in a namespace for a given month. Returns project usage independent of whether a namespace-level usage record exists.

Returns CiMinutesProjectMonthlyUsageConnection.

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

Arguments:

NameTypeDescription
dateDateDate for which to retrieve the usage data, should be the first day of a month. Defaults to the current month.
namespaceIdNamespaceIDGlobal ID of the Namespace for the project compute usage.

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:

NameTypeDescription
dateDateDate for which to retrieve the usage data, should be the first day of a month.
namespaceIdNamespaceIDGlobal ID of the Namespace for the monthly compute usage.

Query.ciPipelineStage

Stage belonging to a CI pipeline.

Returns CiStage.

Arguments:

NameTypeDescription
idCiStageID!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:

NameTypeDescription
fromTimeTimeStart of the requested time. Defaults to three hours ago.
runnerTypeCiRunnerTypeFilter jobs by the type of runner that executed them.
toTimeTimeEnd 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:

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

List of available compliance framework templates.

Returns [ComplianceFrameworkTemplate!].

Arguments:

NameTypeDescription
idComplianceManagementFrameworksTemplateRegistryTemplateIDFilter by template ID.

Query.complianceRequirementControls

Get the list of all the compliance requirement controls.

Returns ComplianceRequirementControl.

Query.containerRepository

Find a container repository.

Returns ContainerRepositoryDetails.

Arguments:

NameTypeDescription
idContainerRepositoryID!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.customDashboard

Find a custom dashboard by ID.

Returns CustomDashboard.

Arguments:

NameTypeDescription
idAnalyticsCustomDashboardsDashboardID!Dashboard ID.

Query.customDashboards

Find custom dashboards for an organization.

Returns CustomDashboardInterfaceConnection.

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

Arguments:

NameTypeDescription
createdByIdUserIDFilter by dashboard creator.
namespaceIdNamespaceIDFilter by namespace.
organizationIdOrganizationsOrganizationIDOrganization ID to filter dashboards. Defaults to the current organization if not provided.
scopeCustomDashboardScopeFilter dashboards by scope.
searchStringFilter dashboards by name.

Query.customField

  • Introduced in GitLab 17.10.
  • Status: Experiment.

Find a custom field by its ID.

Returns CustomField.

Arguments:

NameTypeDescription
idIssuablesCustomFieldID!Global ID of the custom field.

Query.customSystemDashboard

Find a GitLab-provided system dashboard by slug.

Returns CustomSystemDashboard.

Arguments:

NameTypeDescription
slugString!Slug of the system dashboard (e.g. “duo_and_sdlc_trends”).

Query.dependency

Find a dependency.

Returns Dependency.

Arguments:

NameTypeDescription
idSbomOccurrenceID!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:

NameTypeDescription
displayNamespaceIdNamespaceIDFilter by display namespace.

Query.duoDefaultNamespaceCandidates

  • Introduced in GitLab 18.7.
  • Status: Experiment.

List namespaces suitable to be set as default namespace.

Returns NamespaceConnection.

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

Query.duoSettings

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Get GitLab Duo settings.

Returns DuoSettings.

Query.duoWorkflowBranches

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Other attempts at a turn in a Duo Agent Platform session, created when the user retried it. Always empty until branch reconstruction is released.

Returns [DuoWorkflowBranch!].

Arguments:

NameTypeDescription
threadTsString!Identifier of the checkpoint that introduced a user message, from DuoMessage.threadTs. Returns the other attempts at the same turn, so the branch that message belongs to is excluded.
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the session.

Query.duoWorkflowEvents

  • Introduced in GitLab 17.2.
  • Status: Experiment.

List the events for a Duo Agent Platform. Returns only the latest checkpoint by default. Use first and after to page through history.

Returns DuoWorkflowEventConnection!.

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

Arguments:

NameTypeDescription
workflowIdAiDuoWorkflowsWorkflowID!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:

NameTypeDescription
environmentWorkflowEnvironmentEnvironment, for example, IDE or web.
excludeTypes[String!]Types of flows to exclude (for example, [“software_development”, “chat”]).
ids[AiDuoWorkflowsWorkflowID!]Filter flows by a list of IDs.
projectPathIDFull path of the project that contains the flows.
searchStringFlow title or goal to search for.
sortDuoWorkflowsWorkflowSortSort flows by the criteria.
statusGroupDuoWorkflowStatusGroupStatus group to filter flow sessions by.
typeStringType of flow to filter by (for example, software_development or foundational_chat_agents).
updatedAfterISO8601DateTimeFilters flows updated after a given date.
workflowIdAiDuoWorkflowsWorkflowIDFlow ID to filter by.

Query.echo

Testing endpoint to validate the API with.

Returns String!.

Arguments:

NameTypeDescription
textString!Text to echo back.

Query.epicBoardList

Returns EpicList.

Arguments:

NameTypeDescription
epicFiltersEpicFiltersFilters applied when getting epic metadata in the epic board list.
idBoardsEpicListID!Global ID of the list.

Query.featureFlagEnabled

  • Deprecated in GitLab 17.4.
  • Replaced with metadata.featureFlags.

Check if a feature flag is enabled. External API consumers should read the feature flag guidance for external API consumers before using this field.

Returns Boolean!.

Arguments:

NameTypeDescription
nameString!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:

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

Query.gitlabCreditsAvailable

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Whether GitLab credits are available for the current user.

Returns Boolean!.

Arguments:

NameTypeDescription
namespaceIdNamespaceIDGlobal ID of the namespace to check credits for.

Query.gitlabCreditsUnavailableReason

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Reason GitLab credits are unavailable. Returns “usage_billing_forbidden” when usage billing is not available for the account. Returns null when credits are available or the unavailability reason is not recognized.

Returns AiCreditsDenialReason.

Arguments:

NameTypeDescription
namespaceIdNamespaceIDGlobal ID of the namespace to check credits for.

Query.gitpodEnabled

Whether Ona 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:

NameTypeDescription
googleCloudProjectIdString!ID of the Google Cloud project.
imageString!Name of the image in the Google Artifact Registry.
locationString!Location of the Artifact Registry repository.
projectPathID!Full project path.
repositoryString!Repository on the Google Artifact Registry.

Query.group

Find a group.

Returns Group.

Arguments:

NameTypeDescription
fullPathID!Full path of the group. For example, gitlab-org/gitlab-foss.

Query.groupSecret

  • Introduced in GitLab 18.9.
  • Status: Experiment.

View a specific group secret.

Returns GroupSecret.

Arguments:

NameTypeDescription
groupPathID!Group the secret belongs to.
nameString!Name of the group secret to view.

Query.groupSecrets

  • Introduced in GitLab 18.9.
  • Status: Experiment.

List group secrets.

Returns GroupSecretConnection.

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

Arguments:

NameTypeDescription
groupPathID!Group the secrets belong to.

Query.groupSecretsCount

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Total number of secrets in a group.

Returns Int.

Arguments:

NameTypeDescription
groupPathID!Full path of the group.

Query.groupSecretsManager

  • Introduced in GitLab 18.6.
  • Status: Experiment.

Find a group secrets manager.

Returns GroupSecretsManager.

Arguments:

NameTypeDescription
groupPathID!Group of the secrets manager.

Query.groupSecretsNeedingRotation

  • Introduced in GitLab 18.10.
  • Status: Experiment.

List group secrets that need to be rotated.

Returns GroupSecretConnection.

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

Arguments:

NameTypeDescription
groupPathID!Group the secrets belong to.

Query.groupSecretsPermissions

  • Introduced in GitLab 18.7.
  • Status: Experiment.

List group secrets permissions.

Returns GroupSecretsPermissionConnection.

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

Arguments:

NameTypeDescription
groupPathID!Group the secrets permission belong to.

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:

NameTypeDescription
activeBooleanWhen 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.
aimedForDeletionBooleanFilter groups that are marked for deletion.
allAvailableBooleanWhen 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.
includeSubgroupsBooleanInclude descendant groups of the group given in parentPath. Ignored unless parentPath is also provided.
markedForDeletionOnDateDate when the group was marked for deletion.
notBaseGroupsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
ownedOnlyBooleanOnly include groups where the current user has an owner role.
parentPathIDFull path of the parent group.
searchStringSearch query for group name or group full path.
sortStringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topLevelOnlyBooleanOnly include top-level groups.
visibilityLevelVisibilityLevelsEnumFilter groups by visibility level.
withKnowledgeGraphEnabled warning-solidBooleanIntroduced in GitLab 18.10. Status: Experiment. Return only groups with Knowledge Graph enabled.

Query.instanceExternalAuditEventDestinations

  • Deprecated in GitLab 18.10.
  • Use auditEventsInstanceStreamingDestinations instead.

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

  • Deprecated in GitLab 18.10.
  • Use auditEventsInstanceStreamingDestinations with gcpLogging category instead.

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

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Check if Secrets Manager is enrolled at the instance level.

Returns SecretsManagerInstanceEnrollment.

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:

NameTypeDescription
integrationNameIntegrationType!Type of integration.

Query.issue

Find an issue.

Returns Issue.

Arguments:

NameTypeDescription
idIssueID!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:

NameTypeDescription
assigneeIdStringID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername warning-solidStringDeprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames[String!]Usernames of users assigned to the issue.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsernameStringUsername of the author of the issue.
closedAfterTimeIssues closed after the date.
closedBeforeTimeIssues closed before the date.
confidentialBooleanFilter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfterTimeIssues created after the date.
createdBeforeTimeIssues created before the date.
crmContactIdStringID of a contact assigned to the issues.
crmOrganizationIdStringID of an organization assigned to the issues.
customField warning-solid[WorkItemWidgetCustomFieldFilterInputType!]Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfterTimeReturn issues due on or after the given time.
dueBeforeTimeReturn issues due on or before the given time.
epicIdStringID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardIdEpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatusFilterHealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iidStringIID 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.'.
includeArchivedBooleanWhether to include issues from archived projects. Defaults to false.
includeSubepicsBooleanWhether 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.
iterationTitleStringFilter by iteration title.
iterationWildcardIdIterationWildcardIdFilter by iteration ID wildcard.
labelName[String]Labels applied to the issue.
milestoneTitle[String]Milestone applied to the issue.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
notNegatedIssueFilterInputNegated arguments.
orUnionedIssueFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortIssueSortSort issues by the criteria.
stateIssuableStateCurrent state of the issue.
status warning-solidWorkItemWidgetStatusFilterInputIntroduced in GitLab 18.0. Status: Experiment. Filter by status.
subscribedSubscriptionStatusIssues the current user is subscribed to.
types[IssueType!]Filter issues by the given issue types.
updatedAfterTimeIssues updated after the date.
updatedBeforeTimeIssues updated before the date.
weightStringWeight applied to the issue, “none” and “any” values are supported.
weightWildcardIdWeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.
workItemTypeIds[WorkItemsTypeID!]Filter issues by work item type global IDs.

Query.iteration

Find an iteration.

Returns Iteration.

Arguments:

NameTypeDescription
idIterationID!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:

NameTypeDescription
compatibleRunnerId warning-solidCiRunnerIDIntroduced 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-solidCiJobFailureReasonIntroduced 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.
  • 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.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:

NameTypeDescription
assignableBooleanFilter for member roles the current user can assign.
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering 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:

NameTypeDescription
assignableBooleanFilter for member roles the current user can assign.
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering column. Default is ASC.

Query.mergeRequest

Find a merge request.

Returns MergeRequest.

Arguments:

NameTypeDescription
idMergeRequestID!Global ID of the merge request.

Query.mergeRequests

  • Introduced in GitLab 19.3.
  • Status: Experiment.

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

Returns MergeRequestConnection.

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

Arguments:

NameTypeDescription
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeUsernames[String!]Usernames of users assigned to the merge request.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfterTimeMerge requests closed after the date.
closedBeforeTimeMerge requests closed before the date.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
ignoredReviewerUsername warning-solidStringIntroduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
includeArchivedBooleanWhether to include merge requests from archived projects. Defaults to false.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
orUnionedMergeRequestFilterInputList of arguments with inclusive OR.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
sortMergeRequestSortSort merge requests by the criteria.
sourceBranches[String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge requests the current user is subscribed to.
targetBranches[String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.

Query.metadata

Metadata about GitLab.

Returns Metadata.

Query.milestone

Find a milestone.

Returns Milestone.

Arguments:

NameTypeDescription
idMilestoneID!Find a milestone by its ID.

Query.mlExperiment

Find a machine learning experiment.

Returns MlExperiment.

Arguments:

NameTypeDescription
idMlExperimentID!ID of the experiment.

Query.mlModel

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Find machine learning models.

Returns MlModel.

Arguments:

NameTypeDescription
idMlModelID!ID of the model.

Query.namespace

Find a namespace.

Returns Namespace.

Arguments:

NameTypeDescription
fullPathID!Full path of the namespace. For example, gitlab-org/gitlab-foss.

Query.namespaceSecretsManagerEnrollment

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Check Secrets Manager enrollment for a namespace.

Returns SecretsManagerEnrollment.

Arguments:

NameTypeDescription
namespacePathID!Full path of the namespace.

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:

NameTypeDescription
attributeFilters[AttributeFilterInput!]Filter projects by security attributes. Up to 20 items.
hasFailedOrWarning warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Filter projects by whether they have any failed security scans. Warnings have no effect on this filter.
hasScanners warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Filter projects by whether they have any configured security scans.
hasStale warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Filter projects by whether they have any failed security scans.
includeSubgroupsBooleanInclude also subgroup projects.
namespaceIdNamespaceID!Global ID of the namespace.
searchStringSearch projects by name.
securityAnalyzerFilters[AnalyzerFilterInput!]Filter projects by analyzer type and status.
sortBy warning-solidSortableAnalyzerTypeIntroduced in GitLab 19.2. Status: Experiment. Sort projects by analyzer 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:

NameTypeDescription
idNoteID!Global ID of the note.

Query.openbaoHealth

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Check if OpenBao instance is healthy and reachable.

Returns Boolean!.

Query.organization

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Find an organization.

Returns Organization.

Arguments:

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

Arguments:

NameTypeDescription
excludeDefault warning-solidBooleanIntroduced in GitLab 19.1. Status: Experiment. Excludes the Default organization from results.
searchStringSearch query, which can be for the organization name or a path.
state warning-solidOrganizationStateIntroduced in GitLab 19.1. Status: Experiment. Filter organizations by state.

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:

NameTypeDescription
idPackagesPackageID!Global ID of the package.

Query.packageMetadataAdvisories

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Get multiple package metadata advisories.

Returns PackageMetadataAdvisoryConnection.

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

Arguments:

NameTypeDescription
createdAfterISO8601DateTimeFilter advisories created after the datetime.
identifiers[String!]!Array of advisory identifiers.
updatedAfterISO8601DateTimeFilter advisories updated after the datetime.

Query.packageMetadataAdvisory

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Get a package metadata advisory.

Returns PackageMetadataAdvisory.

Arguments:

NameTypeDescription
idPackageMetadataAdvisoryIDGlobal ID of the advisory.
identifierStringIdentifier of the advisory.

Query.pipelineExecutionSchedulePolicyTestRun

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Find a pipeline execution schedule policy test run by ID.

Returns PolicyScheduleTestRun.

Arguments:

NameTypeDescription
idSecurityScheduledPipelineExecutionPolicyTestRunID!Global ID of the policy schedule test run.

Query.project

Find a project.

Returns Project.

Arguments:

NameTypeDescription
fullPathID!Full path of the project. For example, gitlab-org/gitlab-foss.

Query.projectComplianceViolation

Find a project compliance violation.

Returns ProjectComplianceViolation.

Arguments:

NameTypeDescription
idComplianceManagementProjectsComplianceViolationID!Global ID of the project compliance violation.

Query.projectSecret

  • Introduced in GitLab 17.9.
  • Status: Experiment.

View a specific project secret.

Returns ProjectSecret.

Arguments:

NameTypeDescription
nameString!Name of the project secret to view.
projectPathID!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:

NameTypeDescription
projectPathID!Project the secrets belong to.

Query.projectSecretsCount

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Total number of secrets in a project.

Returns Int.

Arguments:

NameTypeDescription
projectPathID!Full path of the project.

Query.projectSecretsManager

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Find a project secrets manager.

Returns ProjectSecretsManager.

Arguments:

NameTypeDescription
projectPathID!Project of the secrets manager.

Query.projectSecretsNeedingRotation

  • Introduced in GitLab 18.5.
  • Status: Experiment.

List project secrets that need to be rotated.

Returns ProjectSecretConnection.

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

Arguments:

NameTypeDescription
projectPathID!Project the secrets belong to.

Query.projectSecretsPermissions

  • Introduced in GitLab 18.7.
  • Status: Experiment.

List project secrets permissions.

Returns ProjectSecretsPermissionConnection.

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

Arguments:

NameTypeDescription
projectPathID!Project the secrets permissions belong to.

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:

NameTypeDescription
activeBooleanFilters by projects that are not archived and not marked for deletion.
aimedForDeletionBooleanReturn only projects marked for deletion.
archivedProjectArchivedFilter projects by archived status.
duoLicensedFeature warning-solidDuoLicensedFeatureIntroduced in GitLab 18.11. Status: Experiment. Include only projects eligible for the specified GitLab Duo licensed feature. Results are automatically filtered to projects where the user has the Maintainer or Owner role.
fullPaths[String!]Filter projects by full paths. You cannot provide more than 50 full paths.
ids[ID!]Filter projects by IDs.
includeHiddenBooleanInclude hidden projects.
lastRepositoryCheckFailedBooleanReturn only projects where the last repository check failed. Only available for administrators.
markedForDeletionOnDateDate when the project was marked for deletion.
membershipBooleanReturn only projects that the current user is a member of.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
namespacePathIDFilter projects by their namespace’s full path (group or user).
notAimedForDeletionBooleanExclude projects that are marked for deletion.
personalBooleanReturn only personal projects.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: css or ruby.
searchStringSearch query, which can be for the project name, a path, or a description.
searchNamespacesBooleanInclude namespace in project search.
sortStringSort 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 warning-solidBooleanDeprecated in GitLab 18.8. No longer functional. Underlying feature was removed in 19.0.
visibilityLevelVisibilityLevelsEnumFilter projects by visibility level.
withIssuesEnabledBooleanReturn only projects with issues enabled.
withMergeRequestsEnabledBooleanReturn only projects with merge requests enabled.

Query.queryComplexity

Information about the complexity of the GraphQL query.

Returns QueryComplexity.

Query.restrictedVisibilityLevels

Visibility levels that are restricted on the instance. Non-administrators cannot use restricted visibility levels for groups, projects, or snippets.

Returns [VisibilityLevelsEnum!].

Query.runner

Find a runner.

Returns CiRunner.

Arguments:

NameTypeDescription
idCiRunnerID!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:

NameTypeDescription
architectureString!Architecture to generate the instructions for.
groupId warning-solidGroupIDDeprecated in GitLab 13.11. No longer used.
platformString!Platform to generate the instructions for.
projectId warning-solidProjectIDDeprecated 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:

NameTypeDescription
fromDateDateStart of the requested date frame. Defaults to the start of the previous calendar month.
fullPathIDFilter 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.
runnerTypeCiRunnerTypeFilter runners by the type.
runnersLimitIntMaximum number of runners to return. Other runners will be aggregated to a runner: null entry. Defaults to 5 if unspecified. Maximum of 500.
toDateDateEnd 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:

NameTypeDescription
fromDateDateStart of the requested date frame. Defaults to the start of the previous calendar month.
fullPathIDFilter 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.
projectsLimitIntMaximum number of projects to return. Other projects will be aggregated to a project: null entry. Defaults to 5 if unspecified. Maximum of 500.
runnerTypeCiRunnerTypeFilter jobs by the type of runner that executed them.
toDateDateEnd 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:

NameTypeDescription
active warning-solidBooleanDeprecated in GitLab 14.8. Renamed. Use paused instead.
creatorIdUserIDFilter runners by creator ID.
creatorUsernameStringFilter runners by creator username.
ownerFullPath warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Filter runners by owning project or group.
pausedBooleanFilter runners by paused (true) or active (false) status.
searchStringFilter by full token or partial text in description field.
sortCiRunnerSortSort order of results.
statusCiRunnerStatusFilter runners by status.
tagList[String!]Filter by tags associated with the runner (comma-separated or array).
typeCiRunnerTypeFilter runners by type.
upgradeStatusCiRunnerUpgradeStatusFilter by upgrade status.
versionPrefixStringFilter 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:

NameTypeDescription
projectPathID!Project the secret permission belong to.

Query.securityConfiguration

Security configuration for the project.

Returns SecurityConfiguration.

Arguments:

NameTypeDescription
projectIdProjectID!Project to get the security configuration for.

Query.securityScanProfile

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Get security scan profile by ID.

Returns ScanProfileType!.

Arguments:

NameTypeDescription
idSecurityScanProfileID!Global ID of the security scan profile.

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:

NameTypeDescription
addOnPurchaseIds[GitlabSubscriptionsAddOnPurchaseID!]!Global IDs of the add on purchases to find assignments for.
addOnTypeGitlabSubscriptionsAddOnType!Type of add on to filter the eligible users by.
filterByAssignedSeatStringFilter users list by assigned seat.
searchStringSearch the user list.
sortGitlabSubscriptionsUserSortSort 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.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:

NameTypeDescription
authorIdUserIDID of an author.
exploreBooleanExplore personal snippets.
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
projectIdProjectIDID of a project.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.

Query.spdxLicenses

  • Introduced in GitLab 19.1.
  • Status: Experiment.

List of SPDX licenses from the SPDX licence catalogue.

Returns [SpdxLicense!].

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:

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

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

  • Introduced in GitLab 18.5.
  • Status: Experiment.

Usage data of consumables under the subscription.

Returns GitlabSubscriptionUsage.

Arguments:

NameTypeDescription
endDateISO8601DateEnd date of the usage period to query. Defaults to the end of the current month.
flowTypes[String!]Filter usage data by flow type identifiers (e.g. [“chat”, “code_review”]). Only applies to event-backed fields (creditsUsed, dailyUsage, dailyAverage, totalActiveUsers, totalCreditsUsed). Wallet-backed fields (monthlyWaiver, monthlyCommitment, overage) are not affected by this filter.
namespacePathIDPath of the top-level namespace. Leave it blank if querying the instance subscription.
startDateISO8601DateStart date of the usage period to query. Defaults to the beginning of the current month.

Query.syntheticNote

  • Introduced in GitLab 15.9.
  • Status: Experiment.

Find a synthetic note.

Returns Note.

Arguments:

NameTypeDescription
noteableIdNoteableID!Global ID of the resource to search synthetic note on.
shaString!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:

NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.

Query.todo

Retrieve a single to-do item.

Returns Todo.

Arguments:

NameTypeDescription
idTodoID!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:

NameTypeDescription
organizationId warning-solidOrganizationsOrganizationIDIntroduced in GitLab 17.7. Status: Experiment. Global ID of the organization.
searchStringSearch query for topic name.

Query.trialUsage

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Usage data for trial subscriptions.

Returns GitlabTrialUsage.

Arguments:

NameTypeDescription
namespacePathIDPath of the top-level namespace. Leave it blank if querying the instance subscription.

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:

NameTypeDescription
identifierMeasurementIdentifier!Type of measurement or statistics to retrieve.
recordedAfterTimeMeasurement recorded after the date.
recordedBeforeTimeMeasurement recorded before the date.

Query.user

Find a user.

Returns UserCore.

Arguments:

NameTypeDescription
idUserIDID of the User.
usernameStringUsername 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:

NameTypeDescription
activeBooleanFilter by active users. When true, returns active users. When false, returns non-active users.
adminsBooleanReturn only admin users.
groupIdGroupIDReturn users member of a given group.
humansBooleanFilter 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.
searchStringQuery to search users by name, username, or primary email.
sortSortSort 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.virtualRegistriesContainerRegistry

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Find a container virtual registry. Returns null if the container_virtual_registries feature flag is disabled.

Returns ContainerRegistryDetails.

Arguments:

NameTypeDescription
idVirtualRegistriesContainerRegistryID!Global ID of the container virtual registry.

Query.virtualRegistriesContainerUpstream

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Finds a container upstream registry with details. Returns null if the container_virtual_registries feature flag is disabled.

Returns ContainerUpstreamDetails.

Arguments:

NameTypeDescription
idVirtualRegistriesContainerUpstreamID!Global ID of the container upstream.

Query.virtualRegistriesPackagesMavenRegistry

  • Introduced in GitLab 18.6.
  • Status: Experiment.

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

Returns MavenRegistryDetails.

Arguments:

NameTypeDescription
idVirtualRegistriesPackagesMavenRegistryID!Global ID of the Maven virtual registry.

Query.virtualRegistriesPackagesMavenUpstream

  • Introduced in GitLab 18.6.
  • Status: Experiment.

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

Returns MavenUpstreamDetails.

Arguments:

NameTypeDescription
idVirtualRegistriesPackagesMavenUpstreamID!Global ID of the Maven upstream registry.

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:

NameTypeDescription
clusterAgentId[ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId[ClustersClusterID!]Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason[VulnerabilityDismissalReason!]Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
falsePositive warning-solidBooleanIntroduced in GitLab 18.8. Status: Experiment. Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolutionBooleanReturns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution.
hasIssuesBooleanReturns only the vulnerabilities which have linked issues.
hasMergeRequestBooleanReturns only the vulnerabilities which have linked merge requests.
hasRemediationsBooleanReturns only the vulnerabilities which have remediations.
hasResolutionBooleanReturns only the vulnerabilities which have been resolved on default branch.
identifierNameStringFilter 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.
malware warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
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 advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 warning-solid[VulnerabilityOwasp2025Top10!]Introduced in GitLab 19.0. Status: Experiment. Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed warning-solidBooleanIntroduced in GitLab 18.8. Status: Experiment. Returns only the vulnerabilities which have been auto dismissed by security policies. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations warning-solid[PolicyViolations!]Introduced in GitLab 18.6. Status: Experiment. Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId[ID!]Filter vulnerabilities by project.
reachability warning-solidReachabilityTypeIntroduced 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.
sortVulnerabilitySortList vulnerabilities by sort order.
state[VulnerabilityState!]Filter vulnerabilities by state.
trackedRefIds warning-solid[SecurityProjectTrackedContextID!]Introduced in GitLab 18.10. Status: Experiment. Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured and advanced vulnerability management set up.
trackedRefsScope warning-solidSecurityTrackedRefScopeIntroduced in GitLab 18.9. Status: Experiment. Filter by tracked ref scope. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerabilities_across_contexts feature flag enabled.
validityCheck warning-solid[VulnerabilityFindingTokenStatusState!]Introduced in GitLab 18.5. Status: Experiment. Filter vulnerabilities by validity check.

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:

NameTypeDescription
endDateISO8601Date!Last day for which to fetch vulnerability history.
startDateISO8601Date!First day for which to fetch vulnerability history.

Query.vulnerability

Find a vulnerability.

Returns Vulnerability.

Arguments:

NameTypeDescription
idVulnerabilityID!Global ID of the Vulnerability.

Query.wikiPage

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Find a wiki page.

Returns WikiPage.

Arguments:

NameTypeDescription
namespaceIdNamespaceIDWiki page namespace ID.
projectIdProjectIDWiki page project ID.
slugStringWiki page slug.

Query.workItem

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Find a work item.

Returns WorkItem.

Arguments:

NameTypeDescription
idWorkItemID!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:

NameTypeDescription
nameStringFilter statuses by name.

Query.workItemDescriptionTemplateContent

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Find a work item description template.

Returns WorkItemDescriptionTemplate.

Arguments:

NameTypeDescription
templateContentInputWorkItemDescriptionTemplateContentInput!Input for fetching a specific description template.

Query.workItemTypeIconDefinitions

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Available icon definitions for work item types.

Returns [WorkItemTypeIconDefinition!]!.

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:

NameTypeDescription
contextNamespacePathIDFull 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:

NameTypeDescription
idRemoteDevelopmentWorkspaceID!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:

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

Input type: AchievementsAwardInput

Arguments:

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being awarded.
awardMessageStringMessage to associate with the awarded achievement.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIdUserID!Global ID of the user being awarded the achievement.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userAchievementUserAchievementAchievement award.

Mutation.achievementsCreate

Input type: AchievementsCreateInput

Arguments:

NameTypeDescription
avatarUploadAvatar for the achievement.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of or notes for the achievement.
nameString!Name for the achievement.
namespaceIdNamespaceID!Namespace for the achievement.

Fields:

NameTypeDescription
achievementAchievementAchievement created.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.achievementsDelete

Input type: AchievementsDeleteInput

Arguments:

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being deleted.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields:

NameTypeDescription
achievementAchievementAchievement.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.achievementsRevoke

Input type: AchievementsRevokeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being revoked.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userAchievementUserAchievementAchievement award.

Mutation.achievementsUpdate

Input type: AchievementsUpdateInput

Arguments:

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being updated.
avatarUploadAvatar for the achievement.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of or notes for the achievement.
nameStringName for the achievement.

Fields:

NameTypeDescription
achievementAchievementAchievement.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectID!ID of the project to be added to Instance Security Dashboard.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectProject that was added to the Instance Security Dashboard.

Mutation.adminClearDuoAvailability

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Clears an admin-locked GitLab Duo availability override from a group.

Input type: AdminClearDuoAvailabilityInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIdGroupID!Group to clear the GitLab Duo availability override from.

Fields:

NameTypeDescription
adminLockedBooleanWhether the group has an admin-locked GitLab Duo availability override.
availabilityDuoAvailabilityResolved GitLab Duo availability for the group after the override is cleared.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.adminRolesLdapSync

  • Introduced in GitLab 18.0.
  • Status: Experiment.

Input type: AdminRolesLdapSyncInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]Errors encountered during operation.
successBooleanWhether the sync was successfully enqueued.

Mutation.adminSetDuoAvailability

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Sets an admin-locked GitLab Duo availability override on a group.

Input type: AdminSetDuoAvailabilityInput

Arguments:

NameTypeDescription
availabilityDuoAvailability!GitLab Duo availability state to lock on the group.
clearDescendantsBooleanClear conflicting admin-locked overrides on descendant groups instead of rejecting.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIdGroupID!Group to set the GitLab Duo availability override on.

Fields:

NameTypeDescription
adminLockedBooleanWhether the group has an admin-locked GitLab Duo availability override.
availabilityDuoAvailabilityResolved GitLab Duo availability for the group after the mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
conflictingAncestorAdminDuoAvailabilityLockedAncestorAncestor group whose admin lock blocked the mutation, if any. When present, the override was not applied.
errors[String!]!Errors encountered during the mutation.

Mutation.adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

Arguments:

NameTypeDescription
aiResourceStringDelete jobs matching ai_resource in the context metadata.
artifactSizeStringDelete jobs matching artifact_size in the context metadata.
artifactUsedCdnStringDelete jobs matching artifact_used_cdn in the context metadata.
artifactsDependenciesCountStringDelete jobs matching artifacts_dependencies_count in the context metadata.
artifactsDependenciesSizeStringDelete jobs matching artifacts_dependencies_size in the context metadata.
bulkImportEntityIdStringDelete jobs matching bulk_import_entity_id in the context metadata.
callerIdStringDelete jobs matching caller_id in the context metadata.
clientIdStringDelete jobs matching client_id in the context metadata.
clientMutationIdStringA unique identifier for the client performing the mutation.
featureCategoryStringDelete jobs matching feature_category in the context metadata.
glUserIdStringDelete jobs matching gl_user_id in the context metadata.
jobIdStringDelete jobs matching job_id in the context metadata.
kubernetesAgentIdStringDelete jobs matching kubernetes_agent_id in the context metadata.
mergeActionStatusStringDelete jobs matching merge_action_status in the context metadata.
mvccManifestStringDelete jobs matching mvcc_manifest in the context metadata.
organizationIdStringDelete jobs matching organization_id in the context metadata.
pipelineIdStringDelete jobs matching pipeline_id in the context metadata.
projectStringDelete jobs matching project in the context metadata.
queueNameString!Name of the queue to delete jobs from.
relatedClassStringDelete jobs matching related_class in the context metadata.
remoteIpStringDelete jobs matching remote_ip in the context metadata.
rootCallerIdStringDelete jobs matching root_caller_id in the context metadata.
rootNamespaceStringDelete jobs matching root_namespace in the context metadata.
scopedUserStringDelete jobs matching scoped_user in the context metadata.
scopedUserIdStringDelete jobs matching scoped_user_id in the context metadata.
sidekiqDestinationShardRedisStringDelete jobs matching sidekiq_destination_shard_redis in the context metadata.
subscriptionPlanStringDelete jobs matching subscription_plan in the context metadata.
userStringDelete jobs matching user in the context metadata.
userIdStringDelete jobs matching user_id in the context metadata.
workerClassStringDelete jobs with the given worker class.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
resultDeleteJobsResponseInformation about the status of the deletion request.

Mutation.aiAction

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Input type: AiActionInput

Arguments:

NameTypeDescription
agenticChatAiAgenticChatInputInput for agentic_chat AI action.
chatAiChatInputInput for chat AI action.
clientMutationIdStringA unique identifier for the client performing the mutation.
clientSubscriptionIdStringClient generated ID that can be subscribed to, to receive a response for the mutation.
conversationTypeAiConversationsThreadsConversationTypeConversation type of the thread.
explainVulnerabilityAiExplainVulnerabilityInputInput for explain_vulnerability AI action.
generateCommitMessageAiGenerateCommitMessageInputInput for generate_commit_message AI action.
generateDescriptionAiGenerateDescriptionInputInput for generate_description AI action.
measureCommentTemperatureAiMeasureCommentTemperatureInputInput for measure_comment_temperature AI action.
platformOriginStringSpecifies the origin platform of the request.
projectIdProjectIDGlobal ID of the project the user is acting on.
resolveVulnerabilityAiResolveVulnerabilityInputInput for resolve_vulnerability AI action.
rootNamespaceIdNamespaceIDGlobal ID of the top-level namespace the user is acting on.
summarizeNewMergeRequestAiSummarizeNewMergeRequestInputInput for summarize_new_merge_request AI action.
summarizeReviewAiSummarizeReviewInputInput for summarize_review AI action.
threadIdAiConversationThreadIDGlobal 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
requestIdStringID of the request.
threadIdAiConversationThreadIDGlobal Id of the thread.

Mutation.aiCatalogAgentCreate

  • Introduced in GitLab 18.2.
  • Status: Experiment.

Input type: AiCatalogAgentCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionString!Description for the agent.
mcpServers warning-solid[AiCatalogMcpServerID!]Introduced in GitLab 18.10. Status: Experiment. MCP servers to associate with the agent.
mcpTools warning-solid[String!]Introduced in GitLab 18.11. Status: Experiment. List of MCP tools enabled for the agent.
nameString!Name for the agent.
projectIdProjectID!Project for the agent.
public warning-solidBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the agent.
systemPromptString!System prompt for the agent.
tools[AiCatalogBuiltInToolID!]List of GitLab built-in tools enabled for the agent.
userPromptStringUser prompt for the agent.
visibility warning-solidAiCatalogItemVisibilityIntroduced in GitLab 19.2. Status: Experiment. Visibility of the agent in the catalog.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemAiCatalogAgentItem created.

Mutation.aiCatalogAgentDelete

  • Introduced in GitLab 18.2.
  • Status: Experiment.

Input type: AiCatalogAgentDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
forceHardDeleteBooleanWhen true, the flow will always be hard deleted and never soft deleted. Can only be used by instance admins.
idAiCatalogItemID!Global ID of the catalog Agent to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successBoolean!Returns true if catalog Agent was successfully deleted.

Mutation.aiCatalogAgentUpdate

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: AiCatalogAgentUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription for the agent.
idAiCatalogItemID!Global ID of the catalog Agent to update.
mcpServers warning-solid[AiCatalogMcpServerID!]Introduced in GitLab 18.10. Status: Experiment. MCP servers to associate with the agent.
mcpTools warning-solid[String!]Introduced in GitLab 18.11. Status: Experiment. List of MCP tools enabled for the agent.
nameStringName for the agent.
public warning-solidBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the agent.
systemPromptStringSystem prompt for the agent.
tools[AiCatalogBuiltInToolID!]List of GitLab built-in tools enabled for the agent.
userPromptStringUser prompt for the agent.
versionBumpAiCatalogVersionBumpBump version, calculated from the last released version name.
visibility warning-solidAiCatalogItemVisibilityIntroduced in GitLab 19.2. Status: Experiment. Visibility of the agent in the catalog.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemAiCatalogAgentAgent that was updated.

Mutation.aiCatalogFlowCreate

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: AiCatalogFlowCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
definitionStringYAML definition for the flow.
descriptionString!Description for the flow.
nameString!Name for the flow.
projectIdProjectID!Project for the flow.
public warning-solidBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the flow.
visibility warning-solidAiCatalogItemVisibilityIntroduced in GitLab 19.2. Status: Experiment. Visibility of the flow in the catalog.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemAiCatalogFlowItem created.

Mutation.aiCatalogFlowDelete

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: AiCatalogFlowDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
forceHardDeleteBooleanWhen true, the flow will always be hard deleted and never soft deleted. Can only be used by instance admins.
idAiCatalogItemID!Global ID of the catalog flow to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successBoolean!Returns true if catalog flow was successfully deleted.

Mutation.aiCatalogFlowUpdate

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: AiCatalogFlowUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
definitionStringYAML definition for the Flow.
descriptionStringDescription for the flow.
idAiCatalogItemID!Global ID of the catalog flow to update.
nameStringName for the flow.
public warning-solidBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the flow.
versionBumpAiCatalogVersionBumpBump version, calculated from the last released version name.
visibility warning-solidAiCatalogItemVisibilityIntroduced in GitLab 19.2. Status: Experiment. Visibility of the flow in the catalog.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemAiCatalogFlowFlow that was updated.

Mutation.aiCatalogItemConsumerBulkCreate

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Input type: AiCatalogItemConsumerBulkCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
itemIdAiCatalogItemID!Global ID of the catalog item to enable.
pinnedVersionAiCatalogPinnedVersionVersion to pin the item to, in the format n.n.n. Must be a released version. Defaults to the latest released version. Ignored when enabling within the item’s managing project, which always tracks the latest released version.
projectIds[ProjectID!]!Global IDs of the projects to enable the catalog item in (maximum 100).
triggerConditions warning-solidAiCatalogTriggerConditionsInputIntroduced in GitLab 19.3. Status: Experiment. Filter conditions for the auto-created AI Catalog triggers, keyed by event type.
triggerFilter warning-solidJSONDeprecated in GitLab 19.3. Use triggerConditions.
triggerTypes[String!]List of event types to create AI Catalog triggers for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.aiCatalogItemConsumerCreate

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: AiCatalogItemConsumerCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
itemIdAiCatalogItemID!Item to configure.
parentItemConsumerIdAiCatalogItemConsumerIDParent item consumer belonging to the top-level group.
pinnedVersionAiCatalogPinnedVersionVersion to pin the item to, in the format n.n.n. Must be a released version. Defaults to the latest released version. Ignored when enabling within the item’s managing project, which always tracks the latest released version.
targetItemConsumerTargetInput!Target project or top-level group in which the catalog item is configured.
triggerConditions warning-solidAiCatalogTriggerConditionsInputIntroduced in GitLab 19.3. Status: Experiment. Filter conditions for the auto-created AI Catalog triggers, keyed by event type.
triggerFilter warning-solidJSONDeprecated in GitLab 19.3. Use triggerConditions.
triggerTypes[String!]List of event types to create AI Catalog triggers for (values can be mention, assign or assign_reviewer).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemConsumerAiCatalogItemConsumerItem configuration created.

Mutation.aiCatalogItemConsumerDelete

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: AiCatalogItemConsumerDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAiCatalogItemConsumerID!Global ID of the catalog item consumer to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successBoolean!Returns true if catalog item consumer was successfully deleted.

Mutation.aiCatalogItemConsumerUpdate

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: AiCatalogItemConsumerUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAiCatalogItemConsumerID!Global ID of the catalog item consumer to update.
pinnedVersionAiCatalogPinnedVersionVersion the item is pinned to, in the format n.n.n.
pinnedVersionPrefix warning-solidAiCatalogPinnedVersionDeprecated in GitLab 19.0. Use pinnedVersion instead.
serviceAccountIdUserIDService account to associate with the item consumer.
triggerTypes[String!]List of event types to create flow triggers for (values can be mention, assign or assign_reviewer).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemConsumerAiCatalogItemConsumerItem consumer that was updated.

Mutation.aiCatalogItemReport

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Input type: AiCatalogItemReportInput

Arguments:

NameTypeDescription
bodyStringAdditional details about the report. Limited to 1000 characters.
clientMutationIdStringA unique identifier for the client performing the mutation.
idAiCatalogItemID!Global ID of the catalog item to report.
reasonAiCatalogItemReportReason!Reason for reporting the catalog item.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.aiCatalogItemStar

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Input type: AiCatalogItemStarInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAiCatalogItemID!Global ID of the catalog item to star or unstar.
starredBoolean!Indicates whether to star or unstar the catalog item.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
starCountInt!Number of stars for the catalog item.

Mutation.aiCatalogItemVersionRestore

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Input type: AiCatalogItemVersionRestoreInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
deprecateCurrentBooleanWhether to mark the current latest version as deprecated.
idAiCatalogItemVersionID!Global ID of the item version to restore from.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemVersionAiCatalogItemVersionNewly created item version restored from the source version.

Mutation.aiCatalogMcpServerCreate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: AiCatalogMcpServerCreateInput

Arguments:

NameTypeDescription
authTypeAiCatalogMcpServerAuthType!Authentication type for the MCP server.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription for the MCP server.
homepageUrlStringHomepage URL for the MCP server.
nameString!Name for the MCP server.
oauthClientIdStringOAuth client ID for the MCP server.
oauthClientSecretStringOAuth client secret for the MCP server.
transportAiCatalogMcpServerTransport!Transport type for the MCP server.
urlString!URL for the MCP server.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mcpServerAiCatalogMcpServerMCP server created.

Mutation.aiCatalogMcpServerSetBlock

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Blocks or allows an external MCP server for a group or project (kill-switch).

Input type: AiCatalogMcpServerSetBlockInput

Arguments:

NameTypeDescription
blockedBoolean!Set to true to block the MCP server, false to allow it.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupFullPathIDFull path of the group to block or allow the MCP server for. Provide exactly one of groupFullPath or projectFullPath.
idAiCatalogMcpServerID!Global ID of the MCP server.
projectFullPathIDFull path of the project to block or allow the MCP server for. Provide exactly one of groupFullPath or projectFullPath.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mcpServerAiCatalogMcpServerMCP server with its updated block status.

Mutation.aiCatalogMcpServerUpdate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: AiCatalogMcpServerUpdateInput

Arguments:

NameTypeDescription
authTypeAiCatalogMcpServerAuthTypeAuthentication type for the MCP server.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription for the MCP server.
homepageUrlStringHomepage URL for the MCP server.
idAiCatalogMcpServerID!Global ID of the MCP server to update.
nameStringName for the MCP server.
oauthClientIdStringOAuth client ID for the MCP server.
oauthClientSecretStringOAuth client secret for the MCP server.
transportAiCatalogMcpServerTransportTransport type for the MCP server.
urlStringURL for the MCP server.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mcpServerAiCatalogMcpServerMCP server that was updated.

Mutation.aiCatalogThirdPartyFlowCreate

  • Introduced in GitLab 18.5.
  • Status: Experiment.

Input type: AiCatalogThirdPartyFlowCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
definitionString!YAML definition for the Flow.
descriptionString!Description for the Flow.
nameString!Name for the Flow.
projectIdProjectID!Project for the Flow.
public warning-solidBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the Flow.
visibility warning-solidAiCatalogItemVisibilityIntroduced in GitLab 19.2. Status: Experiment. Visibility of the Flow in the catalog.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemAiCatalogThirdPartyFlowItem created.

Mutation.aiCatalogThirdPartyFlowDelete

  • Introduced in GitLab 18.5.
  • Status: Experiment.

Input type: AiCatalogThirdPartyFlowDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
forceHardDeleteBooleanWhen true, the Third Party Flow will always be hard deleted and never soft deleted. Can only be used by instance admins.
idAiCatalogItemID!Global ID of the catalog Third Party Flow to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successBoolean!Returns true if catalog Third Party Flow was successfully deleted.

Mutation.aiCatalogThirdPartyFlowUpdate

  • Introduced in GitLab 18.5.
  • Status: Experiment.

Input type: AiCatalogThirdPartyFlowUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
definitionStringYAML definition for the Flow.
descriptionStringDescription for the Flow.
idAiCatalogItemID!Global ID of the catalog Flow to update.
nameStringName for the Flow.
public warning-solidBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the Flow.
versionBumpAiCatalogVersionBumpBump version, calculated from the last released version name.
visibility warning-solidAiCatalogItemVisibilityIntroduced in GitLab 19.2. Status: Experiment. Visibility of the Flow in the catalog.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
itemAiCatalogThirdPartyFlowFlow that was updated.

Mutation.aiDomainSettingsInstanceUpdate

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Adds or removes domains from the allowed or denied list for flows running in a sandboxed environment.

Input type: AiDomainSettingsInstanceUpdateInput

Arguments:

NameTypeDescription
actionAiDomainSettingAction!Action to perform on the domain list.
clientMutationIdStringA unique identifier for the client performing the mutation.
domainSettingTypeAiDomainSettingType!Type of domain setting to update.
domains[String!]!List of domains to add or remove.

Fields:

NameTypeDescription
addedDomains[String!]Domains that were added in the operation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
removedDomains[String!]Domains that were removed in the operation.

Mutation.aiDomainSettingsNamespaceUpdate

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Adds or removes domains from the allowed or denied list for flows running in a sandboxed environment.

Input type: AiDomainSettingsNamespaceUpdateInput

Arguments:

NameTypeDescription
actionAiDomainSettingAction!Action to perform on the domain list.
clientMutationIdStringA unique identifier for the client performing the mutation.
domainSettingTypeAiDomainSettingType!Type of domain setting to update.
domains[String!]!List of domains to add or remove.
namespaceIdNamespaceID!Global ID of the root namespace to update.

Fields:

NameTypeDescription
addedDomains[String!]Domains that were added in the operation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
removedDomains[String!]Domains that were removed in the operation.

Mutation.aiDuoWorkflowCreate

  • Introduced in GitLab 18.1.
  • Status: Experiment.

Input type: AiDuoWorkflowCreateInput

Arguments:

NameTypeDescription
agentPrivileges[Int!]Actions the agent is allowed to perform.
aiCatalogItemVersionIdAiCatalogItemVersionIDID of the catalog item the workflow is triggered from.
allowAgentToRequestUserBooleanWhen enabled, Duo Agent Platform may stop to ask the user questions before proceeding.
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentWorkflowEnvironmentEnvironment for the workflow.
goalStringGoal of the workflow.
issueIdBigIntIID of the noteable (Issue) that the workflow is associated with.
mergeRequestIdBigIntIID of the noteable (MergeRequest) that the workflow is associated with.
namespaceIdNamespaceIDGlobal ID of the namespace the user is acting on.
preApprovedAgentPrivileges[Int!]Actions the agent can perform without asking for approval.
projectIdProjectIDGlobal ID of the project the user is acting on.
webSearchEnabledBooleanEnable web search for the session.
workflowDefinitionStringWorkflow type based on its capability.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the creation process.
workflowDuoWorkflowCreated workflow.

Mutation.aiFeatureSettingModelAllowlistUpdate

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Updates the instance-level model selection allowlist for an AI feature.

Input type: AiFeatureSettingModelAllowlistUpdateInput

Arguments:

NameTypeDescription
allowlistEnabledBoolean!Whether the model selection allowlist is enabled for the feature.
allowlistModelRefs[String!]!Identifiers of the GitLab-managed models allowed for the feature. Ignored when allowlistEnabled is false.
clientMutationIdStringA unique identifier for the client performing the mutation.
featureAiFeatures!AI feature whose model allowlist is being configured.

Fields:

NameTypeDescription
allowListAiModelSelectionAllowListModel selection allowlist for the feature after the update.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.aiFeatureSettingUpdate

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Updates or creates settings for AI features.

Input type: AiFeatureSettingUpdateInput

Arguments:

NameTypeDescription
aiSelfHostedModelIdAiSelfHostedModelIDGlobal ID of the self-hosted model providing the AI setting.
clientMutationIdStringA unique identifier for the client performing the mutation.
features[AiFeatures!]!Array of AI features being configured (for single or batch update).
offeredModelRefStringIdentifier of the selected model for the feature.
providerAiFeatureProviders!Provider for AI setting.

Fields:

NameTypeDescription
aiFeatureSettings[AiFeatureSetting!]!List of AI feature settings after mutation.
clientMutationIdStringA 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:

NameTypeDescription
aiCatalogItemConsumerIdAiCatalogItemConsumerIDAI catalog item consumer to use instead of config_path.
clientMutationIdStringA unique identifier for the client performing the mutation.
configPathStringPath to the configuration file for the AI flow trigger.
descriptionString!Description of the AI flow trigger.
eventTypes[Int!]Event types that triggers the AI flow.
filter warning-solidJSONIntroduced in GitLab 19.0. Status: Experiment. Filter conditions for the AI flow trigger.
projectPathID!Full path of the project the AI flow trigger is associated with.
userIdUserIDService account for the AI flow trigger.

Fields:

NameTypeDescription
aiFlowTriggerAiFlowTriggerTypeCreated AI flow trigger.
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAiFlowTriggerID!ID of the flow trigger to delete.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
aiCatalogItemConsumerIdAiCatalogItemConsumerIDAI catalog item consumer to use instead of config_path.
clientMutationIdStringA unique identifier for the client performing the mutation.
configPathStringPath to the configuration file for the AI flow trigger.
descriptionStringDescription of the AI flow trigger.
eventTypes[Int!]Event types that triggers the AI flow.
filter warning-solidJSONIntroduced in GitLab 18.11. Status: Experiment. Filter conditions for the AI flow trigger.
idAiFlowTriggerID!ID of the flow trigger to update.
userIdUserIDService account for the AI flow trigger.

Fields:

NameTypeDescription
aiFlowTriggerAiFlowTriggerTypeUpdated AI flow trigger.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.aiModelSelectionNamespaceModelAllowlistUpdate

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Updates the namespace-level model selection allowlist for an AI feature.

Input type: AiModelSelectionNamespaceModelAllowlistUpdateInput

Arguments:

NameTypeDescription
allowlistEnabledBoolean!Whether the model selection allowlist is enabled for the feature.
allowlistModelRefs[String!]!Identifiers of the GitLab-managed models allowed for the feature. Ignored when allowlistEnabled is false.
clientMutationIdStringA unique identifier for the client performing the mutation.
featureAiFeatures!AI feature whose model allowlist is being configured.
groupIdGroupID!Group whose model allowlist is being configured.

Fields:

NameTypeDescription
allowListAiModelSelectionAllowListModel selection allowlist for the feature after the update.
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
features[AiModelSelectionFeatures!]!Array of AI features being configured (for single or batch update).
groupIdGroupID!Group for the model selection.
offeredModelRefString!Identifier of the selected model for the feature.

Fields:

NameTypeDescription
aiFeatureSettings warning-solid[AiModelSelectionNamespaceFeatureSetting!]!Introduced in GitLab 18.1. Status: Experiment. List of AI feature settings after mutation.
clientMutationIdStringA 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:

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
clientMutationIdStringA unique identifier for the client performing the mutation.
endpointStringEndpoint of the self-hosted model.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.
providerAiSelfHostedModelProvider!Provider for the self-hosted model.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
resultCloudConnectorProbeResultSelf-hosted hosted connection check result.

Mutation.aiSelfHostedModelCreate

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: AiSelfHostedModelCreateInput

Arguments:

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
clientMutationIdStringA unique identifier for the client performing the mutation.
endpointStringEndpoint of the self-hosted model.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.
providerAiSelfHostedModelProvider!Provider for the self-hosted model.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
selfHostedModelAiSelfHostedModelSelf-hosted model after mutation.

Mutation.aiSelfHostedModelDelete

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Deletes a self-hosted model.

Input type: AiSelfHostedModelDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAiSelfHostedModelID!Global ID of the self-hosted model to delete.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
clientMutationIdStringA unique identifier for the client performing the mutation.
endpointStringEndpoint of the self-hosted model.
idAiSelfHostedModelID!Global ID of the self-hosted model to update.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.
providerAiSelfHostedModelProvider!Provider for the self-hosted model.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
selfHostedModelAiSelfHostedModelSelf-hosted model after mutation.

Mutation.alertSetAssignees

Input type: AlertSetAssigneesInput

Arguments:

NameTypeDescription
assigneeUsernames[String!]!Usernames to assign to the alert. Replaces existing assignees by default.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the alert to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.
projectPathID!Project the alert to mutate is in.

Fields:

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

Mutation.alertTodoCreate

Input type: AlertTodoCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.

Fields:

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

Mutation.approvalProjectRuleDelete

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: approvalProjectRuleDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idApprovalProjectRuleID!Global ID of the approval project rule to delete.

Fields:

NameTypeDescription
approvalRuleApprovalProjectRuleDeleted approval rule.
clientMutationIdStringA 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:

NameTypeDescription
approvalsRequiredInt!How many approvals are required to satisfy rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
coverageMinimumThresholdFloatMinimum code coverage threshold (0-100). Approval is required if coverage falls below the specified threshold.
groupIds[ID!]List of IDs of Groups that can approval rule.
idApprovalProjectRuleID!Global ID of the approval rule to destroy.
nameString!Name of the approval rule.
userIds[ID!]List of IDs of Users that can approval rule.

Fields:

NameTypeDescription
approvalRuleApprovalProjectRuleApproval rule after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.approveDeployment

Input type: ApproveDeploymentInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment to go with the approval.
idDeploymentID!ID of the deployment.
representedAsStringName of the User/Group/Role to use for the approval, when the user belongs to multiple approval rules.
statusDeploymentsApprovalStatus!Status of the approval (either APPROVED or REJECTED).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
deploymentApprovalDeploymentApprovalDeploymentApproval after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.artifactDestroy

Input type: ArtifactDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiJobArtifactID!ID of the artifact to delete.

Fields:

NameTypeDescription
artifactCiJobArtifactDeleted artifact.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.artifactRegistryRepositoryCreate

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Creates a repository in Artifact Registry.

Input type: ArtifactRegistryRepositoryCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringHuman-readable description of the repository.
formatArtifactRegistryRepositoryFormat!Package format the repository holds. Cannot be changed after creation.
kindArtifactRegistryRepositoryKindHow the repository sources its artifacts. Defaults to hosted in Artifact Registry.
nameString!Name of the repository, unique within the organization.
visibilityArtifactRegistryRepositoryVisibilityWho can read the repository.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
repositoryArtifactRegistryRepositoryRepository created. Null when the creation was not applied.

Mutation.artifactRegistryRepositoryDelete

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Deletes a repository in Artifact Registry.

Input type: ArtifactRegistryRepositoryDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the repository to delete, unique within the organization.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.artifactRegistryRepositoryUpdate

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Updates a repository in Artifact Registry.

Input type: ArtifactRegistryRepositoryUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringHuman-readable description of the repository.
nameString!Name of the repository to update, unique within the organization. Cannot be changed.
visibilityArtifactRegistryRepositoryVisibilityWho can read the repository.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
repositoryArtifactRegistryRepositoryRepository updated. Null when the update was not applied.

Mutation.artifactRegistryRoleBulkGrant

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Grants Artifact Registry roles to users on resources in a single all-or-nothing operation.

Input type: ArtifactRegistryRoleBulkGrantInput

Arguments:

NameTypeDescription
assignments[ArtifactRegistryRoleAssignmentInput!]!Role assignments to grant. All succeed or none are written. A maximum of 1000 assignments is allowed per request.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
grantedRoleCountIntNumber of role assignments granted. Present only on success.

Mutation.artifactRegistryRoleGrant

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Grants an Artifact Registry role to a user on a resource.

Input type: ArtifactRegistryRoleGrantInput

Arguments:

NameTypeDescription
assigneeIdUserID!Global ID of the user to grant the role to.
clientMutationIdStringA unique identifier for the client performing the mutation.
resourceIdString!UUID of the Artifact Registry resource (repository or namespace) the role applies to.
roleArtifactRegistryRole!Artifact Registry role to grant.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.ascpComponentCreate

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Input type: AscpComponentCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringComponent description.
expectedUserBehaviorStringExpected user behavior for the component.
projectPathID!Full path of the project.
scanIdSecurityAscpScanID!ID of the scan when the component was discovered.
subDirectoryString!Sub-directory path containing the component.
titleString!Component title.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
component warning-solidAscpComponentIntroduced in GitLab 18.11. Status: Experiment. Created component.
errors[String!]!Errors encountered during the mutation.

Mutation.ascpScanCreate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: AscpScanCreateInput

Arguments:

NameTypeDescription
baseCommitShaStringBase commit SHA for incremental scans.
baseScanIdSecurityAscpScanIDID of the base scan for incremental scans.
clientMutationIdStringA unique identifier for the client performing the mutation.
commitShaString!Git commit SHA that was scanned.
projectPathID!Full path of the project.
scanTypeAscpScanTypeType of scan (default: full).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
scan warning-solidAscpScanIntroduced in GitLab 18.10. Status: Experiment. Created scan.

Mutation.ascpSecurityContextCreate

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Input type: AscpSecurityContextCreateInput

Arguments:

NameTypeDescription
authenticationModelStringHow users authenticate to the component.
authorizationModelStringHow access is controlled.
clientMutationIdStringA unique identifier for the client performing the mutation.
componentIdSecurityAscpComponentID!ID of the component.
dataSensitivityStringTypes of sensitive data handled.
guidelines[AscpSecurityGuidelineInput!]!List of security guidelines.
projectPathID!Full path of the project.
scanIdSecurityAscpScanID!ID of the scan when the security context was created.
summaryStringHigh-level threat model summary.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityContext warning-solidAscpSecurityContextIntroduced in GitLab 18.11. Status: Experiment. Created security context.

Mutation.auditEventsAmazonS3ConfigurationCreate

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsCreate with amazonS3 category instead.

Input type: AuditEventsAmazonS3ConfigurationCreateInput

Arguments:

NameTypeDescription
accessKeyXidString!Access key ID of the Amazon S3 account.
awsRegionString!AWS region where the bucket is created.
bucketNameString!Name of the bucket where the audit events would be logged.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group path.
nameStringDestination name.
secretAccessKeyString!Secret access key of the Amazon S3 account.

Fields:

NameTypeDescription
amazonS3ConfigurationAmazonS3ConfigurationTypeconfiguration created.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsAmazonS3ConfigurationDelete

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsDelete instead.

Input type: AuditEventsAmazonS3ConfigurationDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsAmazonS3ConfigurationID!ID of the Amazon S3 configuration to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsAmazonS3ConfigurationUpdate

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: AuditEventsAmazonS3ConfigurationUpdateInput

Arguments:

NameTypeDescription
accessKeyXidStringAccess key ID of the Amazon S3 account.
activeBooleanActive status of the destination.
awsRegionStringAWS region where the bucket is created.
bucketNameStringName of the bucket where the audit events would be logged.
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsAmazonS3ConfigurationID!ID of the Amazon S3 configuration to update.
nameStringDestination name.
secretAccessKeyStringSecret access key of the Amazon S3 account.

Fields:

NameTypeDescription
amazonS3ConfigurationAmazonS3ConfigurationTypeUpdated Amazon S3 configuration.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsGroupDestinationDenylistEventsAdd

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Input type: AuditEventsGroupDestinationDenylistEventsAddInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add to the denylist.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
eventTypeFilters[String!]List of denylisted event type filters for the audit event external destination.

Mutation.auditEventsGroupDestinationDenylistEventsDelete

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Input type: AuditEventsGroupDestinationDenylistEventsDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from the denylist.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add for streaming.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from streaming.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination ID.
namespacePathStringFull path of the namespace(only project or group).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceFilterGroupAuditEventNamespaceFilterNamespace filter created.

Mutation.auditEventsGroupDestinationNamespaceFilterDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: AuditEventsGroupDestinationNamespaceFilterDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceFilterIdAuditEventsGroupNamespaceFilterID!Namespace filter ID.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsInstanceAmazonS3ConfigurationCreate

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsCreate with amazonS3 category instead.

Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput

Arguments:

NameTypeDescription
accessKeyXidString!Access key ID of the Amazon S3 account.
awsRegionString!AWS region where the bucket is created.
bucketNameString!Name of the bucket where the audit events would be logged.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameStringDestination name.
secretAccessKeyString!Secret access key of the Amazon S3 account.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
instanceAmazonS3ConfigurationInstanceAmazonS3ConfigurationTypeCreated instance Amazon S3 configuration.

Mutation.auditEventsInstanceAmazonS3ConfigurationDelete

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceAmazonS3ConfigurationID!ID of the instance-level Amazon S3 configuration to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsInstanceAmazonS3ConfigurationUpdate

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput

Arguments:

NameTypeDescription
accessKeyXidStringAccess key ID of the Amazon S3 account.
activeBooleanActive status of the destination.
awsRegionStringAWS region where the bucket is created.
bucketNameStringName of the bucket where the audit events would be logged.
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceAmazonS3ConfigurationID!ID of the instance-level Amazon S3 configuration to update.
nameStringDestination name.
secretAccessKeyStringSecret access key of the Amazon S3 account.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
instanceAmazonS3ConfigurationInstanceAmazonS3ConfigurationTypeUpdated instance-level Amazon S3 configuration.

Mutation.auditEventsInstanceDestinationEventsAdd

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: AuditEventsInstanceDestinationEventsAddInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsInstanceExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add for streaming.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsInstanceExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from streaming.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsInstanceExternalStreamingDestinationID!Destination ID.
namespacePathStringFull path of the namespace. Project or group namespaces only.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceFilterInstanceAuditEventNamespaceFilterNamespace filter to be created.

Mutation.auditEventsInstanceDestinationNamespaceFilterDelete

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: AuditEventsInstanceDestinationNamespaceFilterDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceFilterIdAuditEventsInstanceNamespaceFilterID!Namespace filter ID.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsStreamingDestinationEventsAdd

  • Deprecated in GitLab 18.10.
  • Use auditEventsGroupDestinationEventsAdd instead.

Input type: AuditEventsStreamingDestinationEventsAddInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsExternalAuditEventDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add for streaming.

Fields:

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

  • Deprecated in GitLab 18.10.
  • Use auditEventsGroupDestinationEventsRemove instead.

Input type: AuditEventsStreamingDestinationEventsRemoveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsExternalAuditEventDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from streaming.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsStreamingDestinationInstanceEventsAdd

  • Deprecated in GitLab 18.10.
  • Use auditEventsInstanceDestinationEventsAdd instead.

Input type: AuditEventsStreamingDestinationInstanceEventsAddInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsInstanceExternalAuditEventDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add for streaming.

Fields:

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

  • Deprecated in GitLab 18.10.
  • Use auditEventsInstanceDestinationEventsRemove instead.

Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsInstanceExternalAuditEventDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from streaming.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsStreamingHeadersCreate

  • Deprecated in GitLab 18.10.
  • Configure headers by using the streaming destination configuration. Use groupAuditEventStreamingDestinationsUpdate.

Input type: AuditEventsStreamingHeadersCreateInput

Arguments:

NameTypeDescription
activeBooleanBoolean option determining whether header is active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsExternalAuditEventDestinationID!Destination to associate header with.
keyString!Header key.
valueString!Header value.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
headerAuditEventStreamingHeaderCreated header.

Mutation.auditEventsStreamingHeadersDestroy

  • Deprecated in GitLab 18.10.
  • Configure headers by using the streaming destination configuration. Use groupAuditEventStreamingDestinationsUpdate.

Input type: AuditEventsStreamingHeadersDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
headerIdAuditEventsStreamingHeaderID!Header to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsStreamingHeadersUpdate

  • Deprecated in GitLab 18.10.
  • Configure headers by using the streaming destination configuration. Use groupAuditEventStreamingDestinationsUpdate.

Input type: AuditEventsStreamingHeadersUpdateInput

Arguments:

NameTypeDescription
activeBooleanBoolean option determining whether header is active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
headerIdAuditEventsStreamingHeaderID!Header to update.
keyStringHeader key.
valueStringHeader value.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
headerAuditEventStreamingHeaderUpdates header.

Mutation.auditEventsStreamingHttpNamespaceFiltersAdd

  • Deprecated in GitLab 18.10.
  • Use auditEventsGroupDestinationNamespaceFilterCreate instead.

Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsExternalAuditEventDestinationID!Destination ID.
groupPathIDFull path of the group.
projectPathIDFull path of the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceFilterAuditEventStreamingHTTPNamespaceFilterNamespace filter created.

Mutation.auditEventsStreamingHttpNamespaceFiltersDelete

  • Deprecated in GitLab 18.10.
  • Use auditEventsGroupDestinationNamespaceFilterDelete instead.

Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceFilterIdAuditEventsStreamingHTTPNamespaceFilterID!Namespace filter ID.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsStreamingInstanceHeadersCreate

  • Deprecated in GitLab 18.10.
  • Configure headers by using the streaming destination configuration. Use instanceAuditEventStreamingDestinationsUpdate.

Input type: AuditEventsStreamingInstanceHeadersCreateInput

Arguments:

NameTypeDescription
activeBooleanBoolean option determining whether header is active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsInstanceExternalAuditEventDestinationID!Instance level external destination to associate header with.
keyString!Header key.
valueString!Header value.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
headerAuditEventsStreamingInstanceHeaderCreated header.

Mutation.auditEventsStreamingInstanceHeadersDestroy

  • Deprecated in GitLab 18.10.
  • Configure headers by using the streaming destination configuration. Use instanceAuditEventStreamingDestinationsUpdate.

Input type: AuditEventsStreamingInstanceHeadersDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
headerIdAuditEventsStreamingInstanceHeaderID!Header to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.auditEventsStreamingInstanceHeadersUpdate

  • Deprecated in GitLab 18.10.
  • Configure headers by using the streaming destination configuration. Use instanceAuditEventStreamingDestinationsUpdate.

Input type: AuditEventsStreamingInstanceHeadersUpdateInput

Arguments:

NameTypeDescription
activeBooleanBoolean option determining whether header is active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
headerIdAuditEventsStreamingInstanceHeaderID!Header to update.
keyStringHeader key.
valueStringHeader value.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
headerAuditEventsStreamingInstanceHeaderUpdates header.

Mutation.awardEmojiAdd

Input type: AwardEmojiAddInput

Arguments:

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Emoji name.

Fields:

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.awardEmojiRemove

Input type: AwardEmojiRemoveInput

Arguments:

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Emoji name.

Fields:

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.awardEmojiToggle

Input type: AwardEmojiToggleInput

Arguments:

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Emoji name.

Fields:

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
toggledOnBoolean!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:

NameTypeDescription
boardIdBoardsEpicBoardID!Global ID of the board that the epic is in.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group the epic to create is in.
listIdBoardsEpicListID!Global ID of the epic board list in which epic will be created.
titleString!Title of the epic.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after creation.
errors[String!]!Errors encountered during the mutation.

Mutation.boardListCreate

Input type: BoardListCreateInput

Arguments:

NameTypeDescription
assigneeIdUserIDGlobal ID of an existing user.
backlogBooleanCreate the backlog list.
boardIdBoardID!Global ID of the issue board to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.
iterationIdIterationIDGlobal ID of an existing iteration.
labelIdLabelIDGlobal ID of an existing label.
milestoneIdMilestoneIDGlobal ID of an existing milestone.
positionIntPosition of the list.
statusId warning-solidWorkItemsStatusesStatusIDIntroduced in GitLab 18.0. Status: Experiment. Global ID of an existing status.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
listBoardListIssue list in the issue board.

Mutation.boardListUpdateLimitMetrics

Input type: BoardListUpdateLimitMetricsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
limitMetricListLimitMetricNew limit metric type for the list.
listIdListID!Global ID of the list.
maxIssueCountIntNew maximum issue count limit.
maxIssueWeightIntNew maximum issue weight limit.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
listBoardListUpdated list.

Mutation.branchDelete

Input type: BranchDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the branch.
projectPathID!Project full path the branch is associated with.

Fields:

NameTypeDescription
branchBranchBranch after mutation.
clientMutationIdStringA 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:

NameTypeDescription
approvalsRequiredInt!How many approvals are required to satisfy rule.
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule to destroy.
clientMutationIdStringA unique identifier for the client performing the mutation.
coverageMinimumThresholdFloatMinimum code coverage threshold (0-100). Approval is required if coverage falls below the specified threshold.
groupIds[ID!]List of IDs of Groups that can approval rule.
nameString!Name of the approval rule.
userIds[ID!]List of IDs of Users that can approval rule.

Fields:

NameTypeDescription
approvalRuleApprovalProjectRuleApproval rule after mutation.
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Branch name, with wildcards, for the branch rules.
projectPathID!Full path to the project that the branch is associated with.

Fields:

NameTypeDescription
branchRuleBranchRuleBranch rule after mutation.
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectsBranchRuleID!Global ID of the branch rule to destroy.

Fields:

NameTypeDescription
branchRuleBranchRuleBranch rule after mutation.
clientMutationIdStringA 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:

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule to update.
clientMutationIdStringA unique identifier for the client performing the mutation.
externalUrlString!URL of external status check resource.
nameString!Name of the external status check.
sharedSecretStringHMAC shared secret for authenticating external status check requests.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalStatusCheckExternalStatusCheckNew 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:

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
idMergeRequestsExternalStatusCheckID!Global ID of the external status check to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
externalUrlString!External URL of the external status check.
idMergeRequestsExternalStatusCheckID!Global ID of the external status check to update.
nameString!Name of the external status check.
sharedSecretStringHMAC shared secret for authenticating external status check requests.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalStatusCheckExternalStatusCheckUpdated external status check after mutation.

Mutation.branchRuleSquashOptionCreate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Create a squash option for a branch rule.

Input type: BranchRuleSquashOptionCreateInput

Arguments:

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
squashOptionSquashOptionSetting!Squash option to set for the branch rule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
squashOptionSquashOptionCreated squash option after mutation.

Mutation.branchRuleSquashOptionDelete

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Delete a squash option for a branch rule.

Input type: BranchRuleSquashOptionDeleteInput

Arguments:

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
squashOptionSquashOptionSetting!Squash option after mutation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
squashOptionSquashOptionUpdated squash option after mutation.

Mutation.branchRuleUpdate

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: BranchRuleUpdateInput

Arguments:

NameTypeDescription
branchProtectionBranchProtectionInputBranch protections configured for the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectsBranchRuleID!Global ID of the branch rule to update.
nameString!Branch name, with wildcards, for the branch rules.

Fields:

NameTypeDescription
branchRuleBranchRuleBranch rule after mutation.
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[CiJobArtifactID!]!Global IDs of the job artifacts to destroy.
projectIdProjectID!Global Project ID of the job artifacts to destroy. Incompatible with projectPath.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destroyedCountIntNumber 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displayNamespaceIdNamespaceIDDisplay namespace ID.
namespaceIds[NamespaceID!]!List of Namespace IDs.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

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

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
deletedCountIntNumber 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.bulkSetVulnerabilityFindingsDueDates

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Bulk set due dates for vulnerability findings using individual UUID entries. This operation is best-effort: valid updates are applied even if some fail.

Input type: BulkSetVulnerabilityFindingsDueDatesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectFullPathString!Full path of the project.
updates[FindingDueDatesSetInput!]!List of finding UUIDs with due dates. A maximum of 1000 updates is allowed per request.

Fields:

NameTypeDescription
assignedIntNumber of findings for which a due date was successfully assigned.
errors[FindingDueDatesSetError!]!Errors encountered during the mutation. A maximum of 1000 errors are returned per request.
removedIntNumber of findings for which a due date was successfully removed.
skippedIntNumber of findings that were skipped due to errors or not found.

Mutation.bulkUpdateAiToolRules

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Bulk updates permission settings for multiple AI tool rules.

Input type: BulkUpdateAiToolRulesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the root namespace to update tool rules for.
projectPathIDFull path of the project to update tool rules for. When provided, rules can only be stricter than the namespace rule.
toolRules[BulkToolRuleInput!]!Tool rules to update (maximum 100 entries).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
results[BulkToolRuleResult!]!Results for each tool rule update, including any per-item errors.

Mutation.bulkUpdateSecurityAttributes

Input type: BulkUpdateSecurityAttributesInput

Arguments:

NameTypeDescription
attributes[SecurityAttributeID!]!Global IDs of security attributes to apply.
clientMutationIdStringA unique identifier for the client performing the mutation.
items[ID!]!Global IDs of groups and projects to update.
modeSecurityAttributeBulkUpdateMode!Update mode: add, remove, or replace attributes.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered while initiating the bulk update operation.

Mutation.cancelVulnerabilityWorkflow

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Cancels a vulnerability workflow execution.

Input type: CancelVulnerabilityWorkflowInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectIdProjectID!Global ID of the project.
workflowVulnerabilityDuoWorkflow!Workflow to cancel.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorReasonVulnerabilityWorkflowErrorReasonMachine-readable reason for the mutation error.
errors[String!]!Errors encountered during the mutation.
executionVulnerabilityWorkflowExecutionWorkflow execution.

Mutation.catalogResourcesCreate

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Input type: CatalogResourcesCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project path belonging to the catalog resource.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project path belonging to the catalog resource.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdApplicationCreate

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Creates a continuous deployment application in an organization.

Input type: CdApplicationCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the application.
nameString!Name of the application.
organizationIdOrganizationsOrganizationID!Global ID of the organization to create the application in.
services[CdServiceInput!]Services to create in the application, up to 1000.

Fields:

NameTypeDescription
applicationCdApplicationApplication created by the mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdApplicationFlowDefinitionCreate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Creates a new pipeline version of a continuous deployment application flow definition.

Input type: CdApplicationFlowDefinitionCreateInput

Arguments:

NameTypeDescription
applicationIdCdApplicationID!Global ID of the application to create the flow definition for.
clientMutationIdStringA unique identifier for the client performing the mutation.
definitionString!Body of the flow definition.

Fields:

NameTypeDescription
applicationFlowDefinitionCdApplicationFlowDefinitionApplication flow definition created by the mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdApplicationLinkCreate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Creates a link on a continuous deployment application.

Input type: CdApplicationLinkCreateInput

Arguments:

NameTypeDescription
applicationIdCdApplicationID!Global ID of the application to create the link in.
clientMutationIdStringA unique identifier for the client performing the mutation.
linkTypeCdApplicationLinkType!Type of the link.
nameString!Name of the link.
urlString!URL of the link.

Fields:

NameTypeDescription
applicationLinkCdApplicationLinkLink created by the mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdApplicationLinkDelete

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Deletes a link on a continuous deployment application.

Input type: CdApplicationLinkDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCdApplicationLinkID!Global ID of the link to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdApplicationLinkUpdate

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Updates a link on a continuous deployment application.

Input type: CdApplicationLinkUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCdApplicationLinkID!Global ID of the link to update.
linkTypeCdApplicationLinkTypeType of the link.
nameStringName of the link.
urlStringURL of the link.

Fields:

NameTypeDescription
applicationLinkCdApplicationLinkLink updated by the mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdApplicationUpdate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Updates a continuous deployment application.

Input type: CdApplicationUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the application.
idCdApplicationID!Global ID of the application to update.
nameStringName of the application.

Fields:

NameTypeDescription
applicationCdApplicationApplication updated by the mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdArtifactSourceCreate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Creates a continuous deployment artifact source for a service.

Input type: CdArtifactSourceCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the artifact source.
serviceIdCdServiceID!Global ID of the service to create the artifact source for.
sourceRefString!Reference of the artifact source.

Fields:

NameTypeDescription
artifactSourceCdArtifactSourceArtifact source created by the mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdEnvironmentCreate

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Creates a continuous deployment environment in an organization.

Input type: CdEnvironmentCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the environment.
environmentDriverBindingCdEnvironmentDriverBindingInput!Driver binding to create for the environment.
nameString!Name of the environment.
organizationIdOrganizationsOrganizationID!Global ID of the organization to create the environment in.
tierCdEnvironmentTier!Tier of the environment.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentCdEnvironmentEnvironment created by the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdEnvironmentDriverBindingCreate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Creates a new versioned driver binding for a continuous deployment environment.

Input type: CdEnvironmentDriverBindingCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentDriverBindingCdEnvironmentDriverBindingInput!Driver binding to create for the environment.
environmentIdCdEnvironmentID!Global ID of the environment to bind the driver to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentDriverBindingCdEnvironmentDriverBindingEnvironment driver binding created by the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdEnvironmentUpdate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Updates a continuous deployment environment.

Input type: CdEnvironmentUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the environment.
idCdEnvironmentID!Global ID of the environment to update.
nameStringName of the environment.
tierCdEnvironmentTierTier of the environment.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentCdEnvironmentEnvironment updated by the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.cdRolloutCreate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Creates a continuous deployment rollout in an organization.

Input type: CdRolloutCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
organizationIdOrganizationsOrganizationID!Global ID of the organization to create the rollout in.
versionSetIdCdVersionSetID!Global ID of the version set the rollout deploys.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
rolloutCdRolloutRollout created by the mutation.

Mutation.cdRolloutGateResolve

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Resolves an open approval gate on a continuous deployment rollout by recording the decision in the rollout transition journal.

Input type: CdRolloutGateResolveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCdRolloutID!Global ID of the rollout whose approval gate is being resolved.
reasonStringReason for the decision.
statusCdRolloutGateStatus!Decision to record for the approval gate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
rolloutTransitionCdRolloutTransitionRollout transition journal entry created by the mutation.

Mutation.cdServiceCreate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Creates a continuous deployment service in an application.

Input type: CdServiceCreateInput

Arguments:

NameTypeDescription
applicationIdCdApplicationID!Global ID of the application to create the service in.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the service.
nameString!Name of the service.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
serviceCdServiceService created by the mutation.

Mutation.cdServiceUpdate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Updates a continuous deployment service.

Input type: CdServiceUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the service.
idCdServiceID!Global ID of the service to update.
nameStringName of the service.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
serviceCdServiceService updated by the mutation.

Mutation.cdVersionSetCreate

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Creates a continuous deployment version set in an application.

Input type: CdVersionSetCreateInput

Arguments:

NameTypeDescription
applicationIdCdApplicationID!Global ID of the application to create the version set in.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the version set.
nameString!Name of the version set.
versionIds[CdVersionID!]!Global IDs of the versions that make up the version set, one per service. A version set must contain at least one version.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
versionSetCdVersionSetVersion set created by the mutation.

Mutation.ciJobTokenScopeAddGroupOrProject

Input type: CiJobTokenScopeAddGroupOrProjectInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultPermissions warning-solidBooleanIntroduced in GitLab 17.8. Status: Experiment. Indicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
jobTokenPolicies warning-solid[CiJobTokenScopePolicies!]Introduced in GitLab 17.5. Status: Experiment. List of policies added to the CI job token scope. Is ignored if job token policies are disabled.
projectPathID!Project that the CI job token scope belongs to.
targetPathID!Group or project to be added to the CI job token scope.

Fields:

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryIntroduced in GitLab 17.6. Status: Experiment. Allowlist entry for the CI job token’s access scope.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.ciJobTokenScopeAddProject

Input type: CiJobTokenScopeAddProjectInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
direction warning-solidCiJobTokenScopeDirectionDeprecated in GitLab 16.0. Outbound job token scope is being removed. This field can now only be set to INBOUND.
projectPathID!Project that the CI job token scope belongs to.
targetProjectPathID!Project to be added to the CI job token scope.

Fields:

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryIntroduced in GitLab 17.6. Status: Experiment. Allowlist entry for the CI job token’s access scope.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.ciJobTokenScopeRemoveGroup

Input type: CiJobTokenScopeRemoveGroupInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project that the CI job token scope belongs to.
targetGroupPathID!Group to be removed from the CI job token scope.

Fields:

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryIntroduced in GitLab 17.6. Status: Experiment. Allowlist entry for the CI job token’s access scope.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.ciJobTokenScopeRemoveProject

Input type: CiJobTokenScopeRemoveProjectInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
direction warning-solidCiJobTokenScopeDirectionDeprecated in GitLab 16.9. Outbound job token scope is being removed. This field can now only be set to INBOUND.
projectPathID!Project that the CI job token scope belongs to.
targetProjectPathID!Project to be removed from the CI job token scope.

Fields:

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryIntroduced in GitLab 17.6. Status: Experiment. Allowlist entry for the CI job token’s access scope.
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultPermissionsBoolean!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.
projectPathID!Project that the CI job token scope belongs to.
targetPathID!Group or project that the CI job token targets.

Fields:

NameTypeDescription
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryIntroduced in GitLab 17.6. Status: Experiment. Allowlist entry for the CI job token’s access scope.
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Contents of .gitlab-ci.yml.
dryRunBooleanRun pipeline creation simulation, or only do static check.
projectPathID!Project of the CI config.
refStringRef to use when linting. Default is the project default branch.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
configCiConfigV2Linted CI config and metadata.
errors[String!]!Errors encountered during the mutation.

Mutation.clusterAgentDelete

Input type: ClusterAgentDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idClustersAgentID!Global ID of the cluster agent that will be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.clusterAgentTokenCreate

Input type: ClusterAgentTokenCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!Global ID of the cluster agent that will be associated with the new token.
descriptionStringDescription of the token.
nameString!Name of the token.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
secretStringToken secret value. Make sure you save it - you won’t be able to access it again.
tokenClusterAgentTokenToken created after mutation.

Mutation.clusterAgentTokenRevoke

Input type: ClusterAgentTokenRevokeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idClustersAgentTokenID!Global ID of the agent token that will be revoked.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.clusterAgentUrlConfigurationCreate

Input type: ClusterAgentUrlConfigurationCreateInput

Arguments:

NameTypeDescription
caCertStringBase64-encoded CA certificate in PEM format to verify the agent endpoint.
clientCertStringBase64-encoded client certificate in PEM format if mTLS authentication should be used. Must be provided with client_key.
clientKeyStringBase64-encoded client key in PEM format if mTLS authentication should be used. Must be provided with client_cert.
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!Global ID of the cluster agent that will be associated with the new URL configuration.
tlsHostStringTLS host name to verify the server name in agent endpoint certificate.
urlString!URL for the new URL configuration.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
urlConfigurationClusterAgentUrlConfigurationURL configuration created after mutation.

Mutation.clusterAgentUrlConfigurationDelete

Input type: ClusterAgentUrlConfigurationDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idClustersAgentsUrlConfigurationID!Global ID of the agent URL configuration that will be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.commitCreate

Input type: CommitCreateInput

Arguments:

NameTypeDescription
actions[CommitAction!]Array of action hashes to commit as a batch.
allowEmptyBooleanIndicates whether an empty commit can be created. Defaults to false.
branchString!Name of the branch to commit into, it can be a new branch.
clientMutationIdStringA unique identifier for the client performing the mutation.
messageString!Raw commit message.
projectPathID!Project full path the branch is associated with.
startBranchStringIf on a new branch, name of the original branch.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commitCommitCommit after mutation.
commitPipelinePathStringETag 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 adding it to a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a merge request are part of the response.

Input type: ConfigureContainerScanningInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
branchStringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successPathStringRedirect path to use when the response is successful.

Mutation.configureDependencyScanning

Enable dependency scanning .gitlab-ci.yml file in a new branch. The new branch and a URL to create a merge request are a part of the response.

Input type: ConfigureDependencyScanningInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
branchStringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successPathStringRedirect path to use when the response is successful.

Mutation.configureSast

Configure SAST for a project by enabling SAST in a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a Merge Request are a part of the response.

Input type: ConfigureSastInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
configurationSastCiConfigurationInput!SAST CI configuration for the project.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
branchStringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successPathStringRedirect path to use when the response is successful.

Mutation.configureSastIac

Enable SAST IaC for a project in a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a merge request are a part of the response.

Input type: ConfigureSastIacInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
branchStringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successPathStringRedirect path to use when the response is successful.

Mutation.configureSecretDetection

Configure secret detection for a project by enabling secret detection in a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a merge request are a part of the response.

Input type: ConfigureSecretDetectionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
branchStringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successPathStringRedirect path to use when the response is successful.

Mutation.containerCacheEntryDelete

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: ContainerCacheEntryDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idString!ID of the cache entry.

Fields:

NameTypeDescription
cacheEntryContainerUpstreamCacheEntryDeleted container cache entry.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.containerUpstreamCacheDelete

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: ContainerUpstreamCacheDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesContainerUpstreamID!ID of the container virtual registry upstream.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
upstreamContainerUpstreamContainer virtual registry upstream.

Mutation.containerUpstreamCreate

  • Introduced in GitLab 18.8.
  • Status: Experiment.

Input type: ContainerUpstreamCreateInput

Arguments:

NameTypeDescription
cacheValidityHoursIntCache validity period. Defaults to 24 hours.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the upstream registry.
idVirtualRegistriesContainerRegistryID!ID of the upstream registry.
nameString!Name of upstream registry.
passwordStringPassword of the upstream registry.
urlString!URL of the upstream registry.
usernameStringUsername of the upstream registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
upstreamContainerUpstreamDetailsContainer upstream after the mutation.

Mutation.containerUpstreamDelete

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: ContainerUpstreamDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesContainerUpstreamID!ID of the upstream to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
upstreamContainerUpstreamDetailsDestroyed upstream.

Mutation.containerUpstreamTest

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: ContainerUpstreamTestInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathIDFull path of the group to test the upstream registry against. Required when id is not provided.
idVirtualRegistriesContainerUpstreamIDID of the upstream registry to test. When provided, groupPath, url, username, and password are ignored.
passwordStringPassword for authenticating with the upstream registry. Used when id is not provided.
urlStringURL of the upstream registry to test. Required when GraphqlExplorerControllerid is not provided.
usernameStringUsername for authenticating with the upstream registry. Used when id is not provided.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successBoolean!Whether the upstream connectivity test was successful.

Mutation.containerUpstreamUpdate

  • Introduced in GitLab 18.8.
  • Status: Experiment.

Input type: ContainerUpstreamUpdateInput

Arguments:

NameTypeDescription
cacheValidityHoursIntCache validity period.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the upstream registry.
idVirtualRegistriesContainerUpstreamID!ID of the container virtual registry upstream.
nameStringName of upstream registry.
passwordStringPassword of the upstream registry.
urlStringURL of the upstream registry.
usernameStringUsername of the upstream registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
upstreamContainerUpstreamDetailsContainer upstream after the mutation.

Mutation.containerVirtualRegistryCacheDelete

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: ContainerVirtualRegistryCacheDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesContainerRegistryID!ID of the container virtual registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryContainerRegistryContainer virtual registry.

Mutation.containerVirtualRegistryCreate

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: ContainerVirtualRegistryCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the virtual registry.
groupPathIDFull path of the group with which the resource is associated.
nameString!Name of virtual registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryContainerRegistryContainer virtual registry after the mutation.

Mutation.containerVirtualRegistryDelete

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: ContainerVirtualRegistryDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesContainerRegistryID!ID of the container virtual registry to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryContainerRegistryDeleted container virtual registry.

Mutation.containerVirtualRegistryUpdate

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: ContainerVirtualRegistryUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the virtual registry.
idVirtualRegistriesContainerRegistryID!ID of the container virtual registry to be updated.
nameStringName of virtual registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryContainerRegistryContainer virtual registry after the mutation.

Mutation.containerVirtualRegistryUpstreamCreate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: ContainerVirtualRegistryUpstreamCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
registryIdVirtualRegistriesContainerRegistryID!ID of the container virtual registry.
upstreamIdVirtualRegistriesContainerUpstreamID!ID of the upstream.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryUpstreamContainerRegistryUpstreamWithRegistryContainer registry upstream after association.

Mutation.containerVirtualRegistryUpstreamDelete

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: ContainerVirtualRegistryUpstreamDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
upstreamIdVirtualRegistriesContainerRegistryUpstreamID!ID of the container virtual registry upstream.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryUpstreamContainerRegistryUpstreamWithRegistryDeleted container registry upstream.

Mutation.containerVirtualRegistryUpstreamUpdate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: ContainerVirtualRegistryUpstreamUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesContainerRegistryUpstreamID!ID of the container virtual registry upstream.
positionInt!Priority order of an upstream within a virtual registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryUpstreamContainerRegistryUpstreamWithRegistryContainer registry upstream after update.

Mutation.corpusCreate

Input type: CorpusCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Project the corpus belongs to.
packageIdPackagesPackageID!ID of the corpus package.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.createAlertIssue

Input type: CreateAlertIssueInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.

Fields:

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

Mutation.createAnnotation

  • Deprecated in GitLab 16.0.
  • Underlying feature was removed in 16.0.

Input type: CreateAnnotationInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterIdClustersClusterIDGlobal ID of the cluster to add an annotation to.
dashboardPathString!Path to a file defining the dashboard on which the annotation should be added.
descriptionString!Description of the annotation.
endingAtTimeTimestamp indicating ending moment to which the annotation relates.
environmentIdEnvironmentIDGlobal ID of the environment to add an annotation to.
startingAtTime!Timestamp indicating starting moment to which the annotation relates.

Fields:

NameTypeDescription
annotationMetricsDashboardAnnotationCreated annotation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.createBoard

Input type: CreateBoardInput

Arguments:

NameTypeDescription
assigneeIdUserIDID of user to be assigned to the board.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathIDFull path of the group with which the resource is associated.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
iterationCadenceIdIterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationIdIterationIDID 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.
milestoneIdMilestoneIDID of milestone to be assigned to the board.
nameStringBoard name.
projectPathIDFull path of the project with which the resource is associated.
weightIntWeight value to be assigned to the board.

Fields:

NameTypeDescription
boardBoardBoard after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.createBranch

Input type: CreateBranchInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the branch.
projectPathID!Project full path the branch is associated with.
refString!Branch name or commit SHA to create branch from.

Fields:

NameTypeDescription
branchBranchBranch after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.createClusterAgent

Input type: CreateClusterAgentInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the cluster agent.
projectPathID!Full path of the associated project for the cluster agent.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentClusterAgentCluster agent created after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.createComplianceFramework

Input type: CreateComplianceFrameworkInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Full path of the namespace to add the compliance framework to.
paramsComplianceFrameworkInput!Parameters to update the compliance framework with.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
frameworkComplianceFrameworkCreated compliance framework.

Mutation.createComplianceFrameworkFromTemplate

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Input type: CreateComplianceFrameworkFromTemplateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
colorStringOverride the color of the compliance framework in hex format. e.g. #FCA121.
defaultBooleanSet the compliance framework as the default framework for the group.
descriptionStringOverride the description of the compliance framework.
nameStringOverride the name of the compliance framework.
namespacePathID!Full path of the namespace to add the compliance framework to.
templateIdComplianceManagementFrameworksTemplateRegistryTemplateID!Unique identifier of the template to create the framework from.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
frameworkComplianceFrameworkCreated compliance framework.

Mutation.createComplianceRequirement

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Input type: CreateComplianceRequirementInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceFrameworkIdComplianceManagementFrameworkID!Global ID of the compliance framework of the new requirement.
controls[ComplianceRequirementsControlInput!]Controls to add to the compliance requirement.
paramsComplianceRequirementInput!Parameters to update the compliance requirement with.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
requirementComplianceRequirementCreated compliance requirement.

Mutation.createComplianceRequirementsControl

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: CreateComplianceRequirementsControlInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceRequirementIdComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement of the new control.
paramsComplianceRequirementsControlInput!Parameters to create the compliance requirement control.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
requirementsControlComplianceRequirementsControlCreated compliance requirements control.

Mutation.createContainerProtectionRepositoryRule

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

Input type: CreateContainerProtectionRepositoryRuleInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
minimumAccessLevelForDelete warning-solidContainerProtectionRepositoryRuleAccessLevelIntroduced in GitLab 17.11. Status: Experiment. 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. Valid only when feature flag container_registry_protected_containers_delete is enabled.
minimumAccessLevelForPushContainerProtectionRepositoryRuleAccessLevelMinimum 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.
projectPathID!Full path of the project where a protection rule is located.
repositoryPathPatternString!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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionRepositoryRuleContainerProtectionRepositoryRuleContainer 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
minimumAccessLevelForDeleteContainerProtectionTagRuleAccessLevelMinimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags.
minimumAccessLevelForPushContainerProtectionTagRuleAccessLevelMinimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags.
projectPathID!Full path of the project containing the container image tags.
tagNamePatternString!The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionTagRuleContainerProtectionTagRuleProtection rule for container image tags after creation.
errors[String!]!Errors encountered during the mutation.

Mutation.createCustomDashboard

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Creates a custom dashboard in an organization.

Input type: CreateCustomDashboardInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
configCustomDashboardConfigInput!Dashboard layout/config.
descriptionStringDashboard description.
nameString!Dashboard name.
namespaceIdNamespaceIDNamespace to scope the dashboard to.
organizationIdOrganizationsOrganizationIDOrganization the dashboard belongs to. Defaults to the current organization if not provided.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dashboardCustomDashboardNewly created dashboard.
errors[String!]!Errors encountered during creation.

Mutation.createCustomEmoji

Input type: CreateCustomEmojiInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Namespace full path the emoji is associated with.
nameString!Name of the emoji.
urlString!Location of the emoji file.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customEmojiCustomEmojiNew custom emoji.
errors[String!]!Errors encountered during the mutation.

Mutation.createDiffNote

Input type: CreateDiffNoteInput

Arguments:

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
internalBooleanInternal flag for a note. Default is false.
noteableIdNoteableID!Global ID of the resource to add a note to.
positionDiffPositionInput!Position of the note on a diff.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createDiscussion

Input type: CreateDiscussionInput

Arguments:

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
internalBooleanInternal flag for a note. Default is false.
noteableIdNoteableID!Global ID of the resource to add a note to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createEpic

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type. For more information, see [migration guide](https: //docs.gitlab.com/api/graphql/epic_work_items_api_migration_guide/).

Input type: CreateEpicInput

Arguments:

NameTypeDescription
addLabelIds[ID!]IDs of labels to be added to the epic.
addLabels[String!]Array of labels to be added to the epic.
clientMutationIdStringA unique identifier for the client performing the mutation.
colorColorColor of the epic.
confidentialBooleanIndicates if the epic is confidential.
descriptionStringDescription of the epic.
dueDateFixedStringEnd date of the epic.
dueDateIsFixedBooleanIndicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPathID!Group the epic to mutate is in.
removeLabelIds[ID!]IDs of labels to be removed from the epic.
startDateFixedStringStart date of the epic.
startDateIsFixedBooleanIndicates start date should be sourced from start_date_fixed field not the issue milestones.
titleStringTitle of the epic.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicCreated epic.
errors[String!]!Errors encountered during the mutation.

Mutation.createImageDiffNote

Input type: CreateImageDiffNoteInput

Arguments:

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
internalBooleanInternal flag for a note. Default is false.
noteableIdNoteableID!Global ID of the resource to add a note to.
positionDiffImagePositionInput!Position of the note on a diff.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createIssue

Input type: CreateIssueInput

Arguments:

NameTypeDescription
assigneeIds[UserID!]Array of user IDs to assign to the issue.
clientMutationIdStringA unique identifier for the client performing the mutation.
confidentialBooleanIndicates the issue is confidential.
createdAtTimeTimestamp when the issue was created. Available only for admins and project owners.
descriptionStringDescription of the issue.
discussionToResolveStringID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of.
dueDateISO8601DateDue date of the issue.
epicId warning-solidEpicIDDeprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
healthStatusHealthStatusDesired health status.
iidIntIID (internal ID) of a project issue. Only admins and project owners can modify.
iterationCadenceIdIterationsCadenceIDGlobal iteration cadence ID. Required when iterationWildcardId is provided.
iterationIdIterationIDGlobal iteration ID. Mutually exclusive argument with iterationWildcardId.
iterationWildcardIdIssueCreationIterationWildcardIdIteration 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.
lockedBooleanIndicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOfMergeRequestIDIID of a merge request for which to resolve discussions.
milestoneIdMilestoneIDID of the milestone to assign to the issue. On update milestone will be removed if set to null.
moveAfterIdIssueIDGlobal ID of issue that should be placed after the current issue.
moveBeforeIdIssueIDGlobal ID of issue that should be placed before the current issue.
projectPathID!Project full path the issue is associated with.
statusIdWorkItemsStatusesStatusIDGlobal ID of the status.
titleString!Title of the issue.
typeIssueTypeType of the issue.
weightIntWeight of the issue.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.createIteration

  • Deprecated in GitLab 14.0.
  • Use iterationCreate.

Input type: CreateIterationInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathIDFull path of the group with which the resource is associated.
iterationsCadenceIdIterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPathIDFull path of the project with which the resource is associated.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
iterationIterationCreated iteration.

Mutation.createLatestDiffNote

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Creates a diff note on a merge request using minimal parameters. SHAs, file paths, and position type are resolved automatically from the latest merge request diff.

Input type: CreateLatestDiffNoteInput

Arguments:

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
endNewLineIntEnd line number on the new version of the file for a multiline note. When provided, newLine is required and marks the start of the comment range.
endOldLineIntEnd line number on the old version of the file for a multiline note. When provided, oldLine is required and marks the start of the comment range.
filePathString!Path of the file to comment on. For renamed files, either the old or new path can be used.
headShaString!HEAD SHA of the merge request diff. The request fails if it does not match the current diff, guarding against commenting on a stale diff.
internalBooleanInternal flag for a note. Default is false.
newLineIntLine number on the new version of the file. Use alone for added lines, with oldLine for unchanged context lines. At least one of newLine or oldLine is required.
noteableIdMergeRequestID!Global ID of the merge request to add a diff note to.
oldLineIntLine number on the old version of the file. Use alone for removed lines, with newLine for unchanged context lines. At least one of newLine or oldLine is required.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createNote

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

Input type: CreateNoteInput

Arguments:

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
discussionIdDiscussionIDGlobal ID of the discussion the note is in reply to.
internalBooleanInternal flag for a note. Default is false.
mergeRequestDiffHeadShaStringSHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent.
noteableIdNoteableID!Global ID of the resource to add a note to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createPackagesProtectionRule

Creates a protection rule to restrict access to project packages.

Input type: CreatePackagesProtectionRuleInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
minimumAccessLevelForDelete warning-solidPackagesProtectionRuleAccessLevelForDeleteIntroduced in GitLab 17.10. Status: Experiment. Minimum GitLab access required to delete packages from the package registry. Valid values include OWNER or ADMIN. If the value is nil, the default minimum access level is MAINTAINER. Available only when feature flag packages_protected_packages_delete is enabled.
minimumAccessLevelForPushPackagesProtectionRuleAccessLevelMinimum 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.
packageNamePatternString!Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageTypePackagesProtectionRulePackageType!Package type protected by the protection rule. For example, NPM, PYPI.
projectPathID!Full path of the project where a protection rule is located.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule after mutation.

Mutation.createRequirement

Input type: CreateRequirementInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the requirement.
projectPathID!Full project path the requirement is associated with.
titleStringTitle of the requirement.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
requirementRequirementRequirement after mutation.

Mutation.createSnippet

Input type: CreateSnippetInput

Arguments:

NameTypeDescription
blobActions[SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the snippet.
projectPathIDFull path of the project the snippet is associated with.
titleString!Title of the snippet.
uploadedFiles[String!]Paths to files uploaded in the snippet description.
visibilityLevelVisibilityLevelsEnum!Visibility level of the snippet.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
snippetSnippetSnippet after mutation.

Mutation.createTerraformStateProtectionRule

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Creates a protection rule for a Terraform state backend.

Input type: CreateTerraformStateProtectionRuleInput

Arguments:

NameTypeDescription
allowedFrom warning-solidTerraformStateProtectionRuleAllowedFromIntroduced in GitLab 19.1. Status: Experiment. Restriction on the source of write requests. ANYWHERE allows all sources, CI_ONLY requires a CI job token, CI_ON_PROTECTED_BRANCH_ONLY requires a CI job on a protected branch.
clientMutationIdStringA unique identifier for the client performing the mutation.
minimumAccessLevelForWriteTerraformStateProtectionRuleAccessLevel!Minimum GitLab access level required to perform write operations on the Terraform state. Valid values include DEVELOPER, MAINTAINER, OWNER, or ADMIN.
projectPathID!Full path of the project where the protection rule is located.
stateNameString!Terraform state name protected by the rule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
terraformStateProtectionRule warning-solidTerraformStateProtectionRuleIntroduced in GitLab 19.1. Status: Experiment. Terraform state protection rule after mutation.

Mutation.createTestCase

Input type: CreateTestCaseInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
confidentialBooleanSets the test case confidentiality.
descriptionStringTest case description.
labelIds[ID!]IDs of labels to be added to the test case.
projectPathID!Project full path to create the test case in.
titleString!Test case title.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
testCaseIssueTest case created.

Mutation.customFieldArchive

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: CustomFieldArchiveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIssuablesCustomFieldID!Global ID of the custom field.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customFieldCustomFieldArchived custom field.
errors[String!]!Errors encountered during the mutation.

Mutation.customFieldCreate

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Input type: CustomFieldCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fieldTypeCustomFieldType!Type of custom field.
groupPathID!Group path where the custom field is created.
nameString!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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customFieldCustomFieldCreated custom field.
errors[String!]!Errors encountered during the mutation.

Mutation.customFieldUnarchive

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: CustomFieldUnarchiveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIssuablesCustomFieldID!Global ID of the custom field.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customFieldCustomFieldUnarchived custom field.
errors[String!]!Errors encountered during the mutation.

Mutation.customFieldUpdate

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Input type: CustomFieldUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIssuablesCustomFieldID!Global ID of the custom field.
nameStringName 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customFieldCustomFieldUpdated custom field.
errors[String!]!Errors encountered during the mutation.

Mutation.customerRelationsContactCreate

Input type: CustomerRelationsContactCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of or notes for the contact.
emailStringEmail address of the contact.
firstNameString!First name of the contact.
groupIdGroupID!Group for the contact.
lastNameString!Last name of the contact.
organizationIdCustomerRelationsOrganizationIDOrganization for the contact.
phoneStringPhone number of the contact.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contactCustomerRelationsContactContact after the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.customerRelationsContactUpdate

Input type: CustomerRelationsContactUpdateInput

Arguments:

NameTypeDescription
activeBooleanState of the contact.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of or notes for the contact.
emailStringEmail address of the contact.
firstNameStringFirst name of the contact.
idCustomerRelationsContactID!Global ID of the contact.
lastNameStringLast name of the contact.
organizationIdCustomerRelationsOrganizationIDOrganization of the contact.
phoneStringPhone number of the contact.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contactCustomerRelationsContactContact after the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.customerRelationsOrganizationCreate

Input type: CustomerRelationsOrganizationCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultRateFloatStandard billing rate for the organization.
descriptionStringDescription of or notes for the organization.
groupIdGroupID!Group for the organization.
nameString!Name of the organization.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
organizationCustomerRelationsOrganizationOrganization after the mutation.

Mutation.customerRelationsOrganizationUpdate

Input type: CustomerRelationsOrganizationUpdateInput

Arguments:

NameTypeDescription
activeBooleanState of the organization.
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultRateFloatStandard billing rate for the organization.
descriptionStringDescription of or notes for the organization.
idCustomerRelationsOrganizationID!Global ID of the organization.
nameStringName of the organization.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
organizationCustomerRelationsOrganization!Organization after the mutation.

Mutation.dastOnDemandScanCreate

Input type: DastOnDemandScanCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastScannerProfileIdDastScannerProfileIDID of the scanner profile to be used for the scan.
dastSiteProfileIdDastSiteProfileID!ID of the site profile to be used for the scan.
fullPathID!Project the site profile belongs to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelineUrlStringURL of the pipeline that was created.

Mutation.dastProfileCreate

Input type: DastProfileCreateInput

Arguments:

NameTypeDescription
branchNameStringAssociated branch.
clientMutationIdStringA unique identifier for the client performing the mutation.
dastProfileScheduleDastProfileScheduleInputRepresents a DAST Profile Schedule.
dastScannerProfileIdDastScannerProfileID!ID of the scanner profile to be associated.
dastSiteProfileIdDastSiteProfileID!ID of the site profile to be associated.
descriptionStringDescription of the profile. Defaults to an empty string.
fullPathID!Project the profile belongs to.
nameString!Name of the profile.
runAfterCreateBooleanRun scan using profile after creation. Defaults to false.
tagList[String!]Indicates the runner tags associated with the profile.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastProfileDastProfileCreated profile.
errors[String!]!Errors encountered during the mutation.
pipelineUrlStringURL of the pipeline that was created. Requires runAfterCreate to be set to true.

Mutation.dastProfileDelete

Input type: DastProfileDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idDastProfileID!ID of the profile to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.dastProfileRun

Input type: DastProfileRunInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPath warning-solidIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastProfileID!ID of the profile to be used for the scan.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelineUrlStringURL of the pipeline that was created.

Mutation.dastProfileUpdate

Input type: DastProfileUpdateInput

Arguments:

NameTypeDescription
branchNameStringAssociated branch.
clientMutationIdStringA unique identifier for the client performing the mutation.
dastProfileScheduleDastProfileScheduleInputRepresents a DAST profile schedule.
dastScannerProfileIdDastScannerProfileIDID of the scanner profile to be associated.
dastSiteProfileIdDastSiteProfileIDID of the site profile to be associated.
descriptionStringDescription of the profile. Defaults to an empty string.
fullPath warning-solidIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastProfileID!ID of the profile to be deleted.
nameStringName of the profile.
runAfterUpdateBooleanRun scan using profile after update. Defaults to false.
tagList[String!]Indicates the runner tags associated with the profile.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastProfileDastProfileUpdated profile.
errors[String!]!Errors encountered during the mutation.
pipelineUrlStringThe URL of the pipeline that was created. Requires the input argument runAfterUpdate to be set to true when calling the mutation, otherwise no pipeline will be created.

Mutation.dastScannerProfileCreate

Input type: DastScannerProfileCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Project the scanner profile belongs to.
profileNameString!Name of the scanner profile.
scanTypeDastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessagesBooleanIndicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeoutIntMaximum number of minutes allowed for the spider to traverse the site.
tagList warning-solid[String!]Deprecated in GitLab 15.8. Moved to DastProfile.
targetTimeoutIntMaximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpiderBooleanIndicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastScannerProfileDastScannerProfileCreated scanner profile.
errors[String!]!Errors encountered during the mutation.
id warning-solidDastScannerProfileIDDeprecated in GitLab 14.10. use dastScannerProfile field.

Mutation.dastScannerProfileDelete

Input type: DastScannerProfileDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPath warning-solidIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastScannerProfileID!ID of the scanner profile to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.dastScannerProfileUpdate

Input type: DastScannerProfileUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPath warning-solidIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastScannerProfileID!ID of the scanner profile to be updated.
profileNameString!Name of the scanner profile.
scanTypeDastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessagesBooleanIndicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeoutInt!Maximum number of minutes allowed for the spider to traverse the site.
tagList warning-solid[String!]Deprecated in GitLab 15.8. Moved to DastProfile.
targetTimeoutInt!Maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpiderBooleanIndicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastScannerProfileDastScannerProfileUpdated scanner profile.
errors[String!]!Errors encountered during the mutation.
id warning-solidDastScannerProfileIDDeprecated in GitLab 14.10. use dastScannerProfile field.

Mutation.dastSiteProfileCreate

Input type: DastSiteProfileCreateInput

Arguments:

NameTypeDescription
authDastSiteProfileAuthInputParameters for authentication.
clientMutationIdStringA unique identifier for the client performing the mutation.
excludedUrls[String!]URLs to skip during an authenticated scan. Defaults to [].
fullPathID!Project the site profile belongs to.
optionalVariables[JSON!]Optional variables that can be configured for DAST scans.
profileNameString!Name of the site profile.
requestHeadersStringComma-separated list of request header names and values to be added to every request made by DAST.
scanFilePathStringFile Path or URL used as input for the scan method.
scanMethodDastScanMethodTypeScan method by the scanner.
targetTypeDastTargetTypeEnumType of target to be scanned.
targetUrlStringURL of the target to be scanned.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastSiteProfileDastSiteProfileSite Profile object.
errors[String!]!Errors encountered during the mutation.
id warning-solidDastSiteProfileIDDeprecated in GitLab 14.10. use dastSiteProfile.id field.

Mutation.dastSiteProfileDelete

Input type: DastSiteProfileDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPath warning-solidIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastSiteProfileID!ID of the site profile to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.dastSiteProfileUpdate

Input type: DastSiteProfileUpdateInput

Arguments:

NameTypeDescription
authDastSiteProfileAuthInputParameters for authentication.
clientMutationIdStringA unique identifier for the client performing the mutation.
excludedUrls[String!]URLs to skip during an authenticated scan.
fullPath warning-solidIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastSiteProfileID!ID of the site profile to be updated.
optionalVariables[JSON!]Optional variables that can be configured for DAST scans.
profileNameString!Name of the site profile.
requestHeadersStringComma-separated list of request header names and values to be added to every request made by DAST.
scanFilePathStringFile Path or URL used as input for the scan method.
scanMethodDastScanMethodTypeScan method by the scanner.
targetTypeDastTargetTypeEnumType of target to be scanned.
targetUrlStringURL of the target to be scanned.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastSiteProfileDastSiteProfileSite profile object.
errors[String!]!Errors encountered during the mutation.
id warning-solidDastSiteProfileIDDeprecated in GitLab 14.10. use dastSiteProfile.id field.

Mutation.dastSiteTokenCreate

Input type: DastSiteTokenCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Project the site token belongs to.
targetUrlStringURL of the target to be validated.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
idDastSiteTokenIDID of the site token.
statusDastSiteProfileValidationStatusEnumCurrent validation status of the target.
tokenStringToken string.

Mutation.dastSiteValidationCreate

Input type: DastSiteValidationCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastSiteTokenIdDastSiteTokenID!ID of the site token.
fullPathID!Project the site profile belongs to.
strategyDastSiteValidationStrategyEnumValidation strategy to be used.
validationPathString!Path to be requested during validation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
idDastSiteValidationIDID of the site validation.
statusDastSiteProfileValidationStatusEnumCurrent validation status.

Mutation.dastSiteValidationRevoke

Input type: DastSiteValidationRevokeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Project the site validation belongs to.
normalizedTargetUrlString!Normalized URL of the target to be revoked.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idString!Global ID of the annotation to delete.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRegistryProtectionRuleID!Global ID of the container repository protection rule to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionRepositoryRuleContainerProtectionRepositoryRuleContainer 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRegistryProtectionTagRuleID!Global ID of the tag protection rule to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionTagRuleContainerProtectionTagRuleDeleted protection rule for container image tags.
errors[String!]!Errors encountered during the mutation.

Mutation.deleteConversationThread

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: DeleteConversationThreadInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
threadIdAiConversationThreadID!Global ID of the thread to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!List of errors that occurred whilst trying to delete the thread.
successBoolean!Returns true if thread was successfully deleted.

Mutation.deleteCustomDashboard

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Deletes a custom dashboard.

Input type: DeleteCustomDashboardInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAnalyticsCustomDashboardsDashboardID!Global ID of the dashboard to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dashboardCustomDashboardDeleted dashboard.
errors[String!]!Errors encountered during deletion.

Mutation.deleteDuoWorkflowsWorkflow

  • Introduced in GitLab 18.1.
  • Status: Experiment.

Input type: DeleteDuoWorkflowsWorkflowInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!List of errors that occurred whilst trying to delete the workflow.
successBoolean!Returns true if workflow was successfully deleted.

Mutation.deleteGroupCustomAttribute

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Deletes a custom attribute from a group. Only available to admins.

Input type: DeleteGroupCustomAttributeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Full path of the group.
keyString!Key of the custom attribute to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customAttributeCustomAttributeDeleted custom attribute.
errors[String!]!Errors encountered during the mutation.

Mutation.deletePackagesProtectionRule

Deletes a protection rule for packages.

Input type: DeletePackagesProtectionRuleInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPackagesProtectionRuleID!Global ID of the package protection rule to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule that was deleted successfully.

Mutation.deletePagesDeployment

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Deletes a Pages deployment.

Input type: DeletePagesDeploymentInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPagesDeploymentID!ID of the Pages Deployment.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pagesDeploymentPagesDeployment!Deleted Pages Deployment.

Mutation.deleteProjectCustomAttribute

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Deletes a custom attribute from a project. Only available to admins.

Input type: DeleteProjectCustomAttributeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
keyString!Key of the custom attribute to delete.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customAttributeCustomAttributeDeleted custom attribute.
errors[String!]!Errors encountered during the mutation.

Mutation.deleteTerraformStateProtectionRule

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Deletes a protection rule for a Terraform state backend.

Input type: DeleteTerraformStateProtectionRuleInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTerraformStateProtectionRuleID!Global ID of the Terraform state protection rule to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
terraformStateProtectionRule warning-solidTerraformStateProtectionRuleIntroduced in GitLab 19.1. Status: Experiment. Terraform state protection rule that was deleted.

Mutation.deleteUserCustomAttribute

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Deletes a custom attribute from a user. Only available to admins.

Input type: DeleteUserCustomAttributeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
keyString!Key of the custom attribute to delete.
userIdUserID!Global ID of the user.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customAttributeCustomAttributeDeleted custom attribute.
errors[String!]!Errors encountered during the mutation.

Mutation.designManagementDelete

Input type: DesignManagementDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
filenames[String!]!Filenames of the designs to delete.
iidID!IID of the issue to modify designs for.
projectPathID!Project where the issue is to upload designs for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
versionDesignVersionNew version in which the designs are deleted.

Mutation.designManagementMove

Input type: DesignManagementMoveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idDesignManagementDesignID!ID of the design to move.
nextDesignManagementDesignIDID of the immediately following design.
previousDesignManagementDesignIDID of the immediately preceding design.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
designCollectionDesignCollectionCurrent state of the collection.
errors[String!]!Errors encountered during the mutation.

Mutation.designManagementUpdate

Input type: DesignManagementUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the design.
idDesignManagementDesignID!ID of the design to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
designDesign!Updated design.
errors[String!]!Errors encountered during the mutation.

Mutation.designManagementUpload

Input type: DesignManagementUploadInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
files[Upload!]!Files to upload.
iidID!IID of the issue to modify designs for.
projectPathID!Project where the issue is to upload designs for.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idBoardID!Global ID of the board to destroy.

Fields:

NameTypeDescription
boardBoardBoard after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.destroyBoardList

Input type: DestroyBoardListInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
listIdListID!Global ID of the list to destroy. Only label lists are accepted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
listBoardListList after mutation.

Mutation.destroyComplianceFramework

Input type: DestroyComplianceFrameworkInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementFrameworkID!Global ID of the compliance framework to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementComplianceFrameworkComplianceRequirementsControlID!Global ID of the compliance requirement control to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.destroyContainerRepository

Input type: DestroyContainerRepositoryInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRepositoryID!ID of the container repository.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerRepositoryContainerRepository!Container repository policy after scheduling the deletion.
errors[String!]!Errors encountered during the mutation.

Mutation.destroyContainerRepositoryTags

Input type: DestroyContainerRepositoryTagsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRepositoryID!ID of the container repository.
tagNames[String!]!Container repository tag(s) to delete. Total number can’t be greater than 20.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCustomEmojiID!Global ID of the custom emoji to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customEmojiCustomEmojiDeleted custom emoji.
errors[String!]!Errors encountered during the mutation.

Mutation.destroyEpicBoard

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: DestroyEpicBoardInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idBoardsEpicBoardID!Global ID of the board to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicBoardEpicBoardEpic board after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.destroyNote

Input type: DestroyNoteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idNoteID!Global ID of the note to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.destroyPackage

Input type: DestroyPackageInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPackagesPackageID!ID of the Package.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.destroyPackageFile

Input type: DestroyPackageFileInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPackagesPackageFileID!ID of the Package file.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.destroyPackageFiles

Input type: DestroyPackageFilesInput

Arguments:

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

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.destroyPackages

Input type: DestroyPackagesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[PackagesPackageID!]!Global IDs of the Packages. Max 100.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.destroySnippet

Input type: DestroySnippetInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSnippetID!Global ID of the snippet to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
snippetSnippetSnippet after mutation.

Mutation.devfileValidate

  • Introduced in GitLab 18.4.
  • Status: Experiment.

Input type: DevfileValidateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
devfileYamlString!Input devfile.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
validBooleanStatus whether devfile is valid or not.

Mutation.disableDevopsAdoptionNamespace

Status: Beta.

Input type: DisableDevopsAdoptionNamespaceInput

Arguments:

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

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idDiscussionID!Global ID of the discussion.
resolveBoolean!Will resolve the discussion when true, and unresolve the discussion when false.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
discussionDiscussionDiscussion 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentString!Comment explaining the dismissal of the policy violations.
dismissalTypes[DismissalType!]!Type of dismissal for the policy violations.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
securityPolicyIds[ID!]!IDs of warn mode policies with violations to dismiss.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.duoSettingsUpdate

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Updates GitLab Duo settings.

Input type: DuoSettingsUpdateInput

Arguments:

NameTypeDescription
aiGatewayTimeoutSecondsIntTimeout for the AI Gateway request.
aiGatewayUrlStringURL for the local AI Gateway server.
allowAllUnixSockets warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Whether to allow all Unix sockets for network access.
allowProjectExtension warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Whether to allow projects to extend the network access domain allowlist.
clientMutationIdStringA unique identifier for the client performing the mutation.
duoAgentPlatformServiceUrlStringURL for the local Duo Agent Platform service.
duoCliEnabled warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Indicates whether GitLab Duo CLI access is enabled.
duoCoreFeaturesEnabledBooleanIndicates whether GitLab Duo Core features are enabled.
includeRecommendedAllowed warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Whether to include recommended domains in the network access allowlist.
minimumAccessLevelEnableOnProjects warning-solidAccessLevelEnumIntroduced in GitLab 18.7. Status: Experiment. Minimum access level for enable on Duo Agent Platform. Ignored if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelExecute warning-solidAccessLevelEnumIntroduced in GitLab 18.7. Status: Experiment. Minimum access level for execute on Duo Agent Platform. Ignored if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelExecuteAsync warning-solidAccessLevelEnumIntroduced in GitLab 18.7. Status: Experiment. Minimum access level to execute Duo Agent Platform features in CI/CD. Ignored if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelManage warning-solidAccessLevelEnumIntroduced in GitLab 18.7. Status: Experiment. Minimum access level for manage on Duo Agent Platform. Ignored if dap_instance_customizable_permissions feature flag is disabled.
selfHostedDuoAgentPlatformServiceSecureBooleanWhether to use secure transport (TLS) for the local Duo Agent Platform service.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
duoSettingsDuoSettings!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:

NameTypeDescription
aiMessageIdString!ID of the AI Message.
clientMutationIdStringA unique identifier for the client performing the mutation.
trackingEventTrackingEventInputTracking event data.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]Errors to return to the user.
messages[String!]Messages to return to the user.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displayNamespaceIdNamespaceIDDisplay namespace ID.
namespaceIdNamespaceID!Namespace ID.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledNamespaceDevopsAdoptionEnabledNamespaceEnabled namespace after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.environmentCreate

Create an environment.

Input type: EnvironmentCreateInput

Arguments:

NameTypeDescription
autoStopSettingAutoStopSettingAuto stop setting of the environment.
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentIDCluster agent of the environment.
descriptionStringDescription of the environment.
externalUrlStringExternal URL of the environment.
fluxResourcePathStringFlux resource path of the environment.
kubernetesNamespaceStringKubernetes namespace of the environment.
nameString!Name of the environment.
projectPathID!Full path of the project.
tierDeploymentTierTier of the environment.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentEnvironmentCreated environment.
errors[String!]!Errors encountered during the mutation.

Mutation.environmentDelete

Delete an environment.

Input type: EnvironmentDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idEnvironmentID!Global ID of the environment to Delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.environmentStop

Stop an environment.

Input type: EnvironmentStopInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
forceBooleanForce environment to stop without executing on_stop actions.
idEnvironmentID!Global ID of the environment to stop.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentEnvironmentEnvironment after attempt to stop.
errors[String!]!Errors encountered during the mutation.

Mutation.environmentUpdate

Update an environment.

Input type: EnvironmentUpdateInput

Arguments:

NameTypeDescription
autoStopSettingAutoStopSettingAuto stop setting of the environment.
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentIDCluster agent of the environment.
descriptionStringDescription of the environment.
externalUrlStringExternal URL of the environment.
fluxResourcePathStringFlux resource path of the environment.
idEnvironmentID!Global ID of the environment to update.
kubernetesNamespaceStringKubernetes namespace of the environment.
tierDeploymentTierTier of the environment.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentEnvironmentEnvironment 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idEnvironmentID!Global ID of the environment to update.
weightInt!Weight of the Canary Ingress.

Fields:

NameTypeDescription
clientMutationIdStringA 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](https: //docs.gitlab.com/api/graphql/epic_work_items_api_migration_guide/).

Input type: EpicAddIssueInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group the epic to mutate belongs to.
iidID!IID of the epic to mutate.
issueIidString!IID of the issue to be added.
projectPathID!Full path of the project the issue belongs to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after mutation.
epicIssueEpicIssueEpic-issue relationship.
errors[String!]!Errors encountered during the mutation.

Mutation.epicBoardCreate

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicBoardCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displayColorsBooleanWhether or not display epic colors.
groupPathIDFull path of the group with which the resource is associated.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
labelIds[LabelID!]IDs of labels to be added to the board.
labels[String!]Labels of the issue.
nameStringBoard name.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicBoardEpicBoardCreated epic board.
errors[String!]!Errors encountered during the mutation.

Mutation.epicBoardListCreate

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicBoardListCreateInput

Arguments:

NameTypeDescription
backlogBooleanCreate the backlog list.
boardIdBoardsEpicBoardID!Global ID of the issue board to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.
labelIdLabelIDGlobal ID of an existing label.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
listEpicListEpic 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
listIdBoardsEpicListID!Global ID of the epic board list to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
listEpicListEpic board list. null if the board was destroyed successfully.

Mutation.epicBoardUpdate

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicBoardUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displayColorsBooleanWhether or not display epic colors.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
idBoardsEpicBoardID!Epic board global ID.
labelIds[LabelID!]IDs of labels to be added to the board.
labels[String!]Labels of the issue.
nameStringBoard name.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicBoardEpicBoardUpdated epic board.
errors[String!]!Errors encountered during the mutation.

Mutation.epicMoveList

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicMoveListInput

Arguments:

NameTypeDescription
boardIdBoardsEpicBoardID!Global ID of the board that the epic is in.
clientMutationIdStringA unique identifier for the client performing the mutation.
epicIdEpicID!ID of the epic to mutate.
fromListIdBoardsEpicListIDID of the board list that the epic will be moved from. Required if moving between lists.
moveAfterIdEpicIDID of epic that should be placed after the current epic.
moveBeforeIdEpicIDID of epic that should be placed before the current epic.
positionInListIntPosition of epics within the board list. Positions start at 0. Use -1 to move to the end of the list.
toListIdBoardsEpicListID!ID of the list the epic will be in after mutation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic 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](https: //docs.gitlab.com/api/graphql/epic_work_items_api_migration_guide/).

Input type: EpicSetSubscriptionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group the epic to mutate belongs to.
iidID!IID of the epic to mutate.
subscribedStateBoolean!Desired state of the subscription.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.epicTreeReorder

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicTreeReorderInput

Arguments:

NameTypeDescription
baseEpicIdEpicID!ID of the base epic of the tree.
clientMutationIdStringA unique identifier for the client performing the mutation.
movedEpicTreeNodeFieldsInputType!Parameters for updating the tree positions.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.escalationPolicyCreate

Input type: EscalationPolicyCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the escalation policy.
nameString!Name of the escalation policy.
projectPathID!Project to create the escalation policy for.
rules[EscalationRuleInput!]!Steps of the escalation policy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

Mutation.escalationPolicyDestroy

Input type: EscalationPolicyDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementEscalationPolicyID!Escalation policy internal ID to remove.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

Mutation.escalationPolicyUpdate

Input type: EscalationPolicyUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the escalation policy.
idIncidentManagementEscalationPolicyID!ID of the on-call schedule to create the on-call rotation in.
nameStringName of the escalation policy.
rules[EscalationRuleInput!]Steps of the escalation policy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

Mutation.exportRequirements

Input type: ExportRequirementsInput

Arguments:

NameTypeDescription
authorUsername[String!]Filter requirements by author username.
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full project path the requirements are associated with.
searchStringSearch query for requirement title.
selectedFields[String!]List of selected requirements fields to be exported.
sortSortList requirements by sort order.
stateRequirementStateFilter requirements by state.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.externalAuditEventDestinationCreate

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsCreate instead.

Input type: ExternalAuditEventDestinationCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationUrlString!Destination URL.
groupPathID!Group path.
nameStringDestination name.
verificationTokenStringVerification token.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationExternalAuditEventDestinationDestination created.

Mutation.externalAuditEventDestinationDestroy

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsDelete instead.

Input type: ExternalAuditEventDestinationDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsExternalAuditEventDestinationID!ID of external audit event destination to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.externalAuditEventDestinationUpdate

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: ExternalAuditEventDestinationUpdateInput

Arguments:

NameTypeDescription
activeBooleanActive status of the destination.
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationUrlStringDestination URL to change.
idAuditEventsExternalAuditEventDestinationID!ID of external audit event destination to update.
nameStringDestination name.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationExternalAuditEventDestinationUpdated destination.

Mutation.geoRegistriesBulkUpdate

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Mutates multiple Geo registries for a given registry class.

Input type: GeoRegistriesBulkUpdateInput

Arguments:

NameTypeDescription
actionGeoRegistriesBulkAction!Action to be executed on Geo registries.
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[GeoBaseRegistryID!]Execute the action on registries selected by their ID.
registryClassGeoRegistryClass!Class of the Geo registries to be updated.
replicationStateReplicationStateEnumExecute the action on registries selected by their replication state.
verificationStateVerificationStateEnumExecute the action on registries selected by their verification state.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryClassGeoRegistryClassUpdated Geo registry class.

Mutation.geoRegistriesUpdate

  • Introduced in GitLab 16.1.
  • Status: Experiment.

Mutates a Geo registry.

Input type: GeoRegistriesUpdateInput

Arguments:

NameTypeDescription
actionGeoRegistryAction!Action to be executed on a Geo registry.
clientMutationIdStringA unique identifier for the client performing the mutation.
registryIdGeoBaseRegistryID!ID of the Geo registry entry to be updated.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryRegistrableUpdated Geo registry entry.

Mutation.gitlabSubscriptionActivate

Input type: GitlabSubscriptionActivateInput

Arguments:

NameTypeDescription
activationCodeString!Activation code received after purchasing a GitLab subscription.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
futureSubscriptions[SubscriptionFutureEntry!]Array of future subscriptions.
licenseCurrentLicenseCurrent license.

Mutation.googleCloudLoggingConfigurationCreate

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsCreate with gcpLogging category instead.

Input type: GoogleCloudLoggingConfigurationCreateInput

Arguments:

NameTypeDescription
clientEmailString!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.
clientMutationIdStringA unique identifier for the client performing the mutation.
googleProjectIdNameString!Unique identifier of the Google Cloud project to which the logging configuration belongs.
groupPathID!Group path.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events).
nameStringDestination name.
privateKeyString!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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
googleCloudLoggingConfigurationGoogleCloudLoggingConfigurationTypeconfiguration created.

Mutation.googleCloudLoggingConfigurationDestroy

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsDelete instead.

Input type: GoogleCloudLoggingConfigurationDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsGoogleCloudLoggingConfigurationID!ID of the Google Cloud logging configuration to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.googleCloudLoggingConfigurationUpdate

  • Deprecated in GitLab 18.10.
  • Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: GoogleCloudLoggingConfigurationUpdateInput

Arguments:

NameTypeDescription
activeBooleanActive status of the destination.
clientEmailStringEmail 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.
clientMutationIdStringA unique identifier for the client performing the mutation.
googleProjectIdNameStringUnique identifier of the Google Cloud project to which the logging configuration belongs.
idAuditEventsGoogleCloudLoggingConfigurationID!ID of the google Cloud configuration to update.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.
nameStringDestination name.
privateKeyStringPrivate 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
googleCloudLoggingConfigurationGoogleCloudLoggingConfigurationTypeconfiguration updated.

Mutation.groupAuditEventStreamingDestinationsCreate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: GroupAuditEventStreamingDestinationsCreateInput

Arguments:

NameTypeDescription
categoryString!Destination category.
clientMutationIdStringA unique identifier for the client performing the mutation.
configJSON!Destination config.
groupPathID!Group path.
nameStringDestination name.
secretTokenStringSecret token.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationGroupAuditEventStreamingDestinationDestination created.

Mutation.groupAuditEventStreamingDestinationsDelete

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: GroupAuditEventStreamingDestinationsDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsGroupExternalStreamingDestinationID!ID of the audit events external streaming destination to delete.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
activeBooleanActive status of the destination.
categoryStringDestination category.
clientMutationIdStringA unique identifier for the client performing the mutation.
configJSONDestination config.
idAuditEventsGroupExternalStreamingDestinationID!ID of external audit event destination to update.
nameStringDestination name.
secretTokenStringSecret token.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationGroupAuditEventStreamingDestinationUpdated destination.

Mutation.groupMemberBulkUpdate

Input type: GroupMemberBulkUpdateInput

Arguments:

NameTypeDescription
accessLevelMemberAccessLevel!Access level to update the members to.
clientMutationIdStringA unique identifier for the client performing the mutation.
expiresAtTimeDate and time the membership expires.
groupIdGroupID!Global ID of the group.
userIds[UserID!]!Global IDs of the members.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIdGroupID!Global ID of the group.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
messageStringExport request result message.

Mutation.groupSavedReplyCreate

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: GroupSavedReplyCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
groupIdGroupID!Group for the save reply.
nameString!Name of the saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

Mutation.groupSavedReplyDestroy

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: GroupSavedReplyDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idGroupsSavedReplyID!Global ID of the group-level saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

Mutation.groupSavedReplyUpdate

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: GroupSavedReplyUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
idGroupsSavedReplyID!Global ID of the group-level saved reply.
nameString!Name of the saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

Mutation.groupSecretCreate

Input type: GroupSecretCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the group secret.
environmentString!Environment that can access the secret.
groupPathID!Group of the secret.
nameString!Name of the group secret.
protectedBoolean!Whether the secret is only accessible from protected branches.
rotationIntervalDaysIntNumber of days between rotation reminders for the secret.
secretString!Value of the group secret.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupSecretGroupSecretGroup secret.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.groupSecretDelete

Input type: GroupSecretDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group of the secret.
nameString!Name of the group secret to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupSecretGroupSecretDeleted group secret.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.groupSecretUpdate

Input type: GroupSecretUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringNew description of the group secret.
environmentStringNew environment that can access the secret.
groupPathID!Group of the secret.
metadataCasInt!This should match the current metadata version of the group secret being updated.
nameString!Name of the group secret to update.
protectedBooleanWhether the secret is only accessible from protected branches.
rotationIntervalDaysIntNumber of days between rotation reminders for the secret.
secretStringNew value of the group secret.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupSecretGroupSecretUpdated group secret.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.groupSecretsManagerDeprovision

Input type: GroupSecretsManagerDeprovisionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group of the secrets manager.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupSecretsManagerGroupSecretsManagerGroup secrets manager.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.groupSecretsManagerInitialize

Input type: GroupSecretsManagerInitializeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group of the secrets manager.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupSecretsManagerGroupSecretsManagerGroup secrets manager.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.groupSecretsPermissionDelete

Input type: GroupSecretsPermissionDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group permissions for the secret.
principalPrincipalInput!Whose permission to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.
secretsPermissionGroupSecretsPermissionDeleted Secrets Permission.

Mutation.groupSecretsPermissionUpdate

Input type: GroupSecretsPermissionUpdateInput

Arguments:

NameTypeDescription
actions[SecretsManagementAction!]!Actions that can be performed on secrets.
clientMutationIdStringA unique identifier for the client performing the mutation.
expiredAtISO8601DateExpiration date for Secret Permission (optional).
groupPathID!Group to which the permissions are added.
principalPrincipalInput!User/MemberRole/Role/Group that is provided access.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.
secretsPermissionGroupSecretsPermissionSecrets Permission that was created.

Mutation.groupTransfer

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Input type: GroupTransferInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idGroupID!Global ID of the group to transfer.
targetIdGroupIDGlobal ID of the target parent group. Omit to make group top-level.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupGroupGroup after mutation.

Mutation.groupUpdate

Input type: GroupUpdateInput

Arguments:

NameTypeDescription
aiAuditEventsStorageEnabled warning-solidBooleanIntroduced in GitLab 19.2. Status: Experiment. Indicates whether AI audit events are stored for the group.
builtInProjectTemplatesEnabled warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Indicates whether built-in project templates are available for new projects in the group.
clientMutationIdStringA unique identifier for the client performing the mutation.
duoFeaturesEnabled warning-solidBooleanIntroduced in GitLab 16.10. Status: Experiment. Indicates whether GitLab Duo features are enabled for the group.
fullPathID!Full path of the group that will be updated.
lockAiAuditEventsStorageEnabled warning-solidBooleanIntroduced in GitLab 19.2. Status: Experiment. Indicates whether AI audit events storage is enforced for all subgroups and projects.
lockBuiltInProjectTemplatesEnabled warning-solidBooleanIntroduced in GitLab 19.0. Status: Experiment. Indicates if the built-in project templates enabled setting is enforced for all subgroups.
lockDuoFeaturesEnabled warning-solidBooleanIntroduced in GitLab 16.10. Status: Experiment. Indicates if the GitLab Duo features enabled setting is enforced for all subgroups.
lockMathRenderingLimitsEnabledBooleanIndicates if math rendering limits are locked for all descendant groups.
lockToolApprovalForSessionEnabled warning-solidBooleanIntroduced in GitLab 18.11. Status: Experiment. Indicates if the tool approval for session setting is enforced for all subgroups.
mathRenderingLimitsEnabledBooleanIndicates if math rendering limits are used for the group.
nameStringName of the group.
pathStringPath of the namespace.
sharedRunnersSettingSharedRunnersSettingShared runners availability for the namespace and its descendants.
stepUpAuthRequiredOauthProviderStringOAuth provider required for step-up authentication.
toolApprovalForSessionEnabled warning-solidBooleanIntroduced in GitLab 18.11. Status: Experiment. Indicates whether tool approval for session is enabled for the group.
visibilityVisibilityLevelsEnumVisibility of the namespace.
webBasedCommitSigningEnabled warning-solidBooleanIntroduced in GitLab 18.2. Status: Experiment. Indicates whether web-based commit signing is enabled for the group.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupGroupGroup after update.

Mutation.httpIntegrationCreate

Input type: HttpIntegrationCreateInput

Arguments:

NameTypeDescription
activeBoolean!Whether the integration is receiving alerts.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the integration.
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.
projectPathID!Project to create the integration in.
typeAlertManagementIntegrationTypeType of integration to create. Cannot be changed after creation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementHttpIntegrationAlerting integration.

Mutation.httpIntegrationDestroy

Input type: HttpIntegrationDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAlertManagementHttpIntegrationID!ID of the integration to remove.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementHttpIntegrationAlerting integration.

Mutation.httpIntegrationResetToken

Input type: HttpIntegrationResetTokenInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAlertManagementHttpIntegrationID!ID of the integration to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementHttpIntegrationAlerting integration.

Mutation.httpIntegrationUpdate

Input type: HttpIntegrationUpdateInput

Arguments:

NameTypeDescription
activeBooleanWhether the integration is receiving alerts.
clientMutationIdStringA unique identifier for the client performing the mutation.
idAlertManagementHttpIntegrationID!ID of the integration to mutate.
nameStringName of the integration.
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementHttpIntegrationAlerting integration.

Mutation.importSourceUserCancelReassignment

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: ImportSourceUserCancelReassignmentInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceIdNamespaceID!Global ID of the namespace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
updatedImportSourceUserCountIntNumber 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping 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:

NameTypeDescription
assigneeUserIdUserID!Global ID of the assignee user.
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserRetryFailedReassignment

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Input type: ImportSourceUserRetryFailedReassignmentInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping 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:

NameTypeDescription
categoryString!Destination category.
clientMutationIdStringA unique identifier for the client performing the mutation.
configJSON!Destination config.
nameStringDestination name.
secretTokenStringSecret token.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationInstanceAuditEventStreamingDestinationDestination created.

Mutation.instanceAuditEventStreamingDestinationsDelete

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: InstanceAuditEventStreamingDestinationsDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceExternalStreamingDestinationID!ID of the audit events external streaming destination to delete.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
activeBooleanActive status of the destination.
categoryStringDestination category.
clientMutationIdStringA unique identifier for the client performing the mutation.
configJSONDestination config.
idAuditEventsInstanceExternalStreamingDestinationID!ID of external audit event destination to update.
nameStringDestination name.
secretTokenStringSecret token.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationInstanceAuditEventStreamingDestinationUpdated destination.

Mutation.instanceExternalAuditEventDestinationCreate

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsCreate instead.

Input type: InstanceExternalAuditEventDestinationCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationUrlString!Destination URL.
nameStringDestination name.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
instanceExternalAuditEventDestinationInstanceExternalAuditEventDestinationDestination created.

Mutation.instanceExternalAuditEventDestinationDestroy

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: InstanceExternalAuditEventDestinationDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceExternalAuditEventDestinationID!ID of the external instance audit event destination to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.instanceExternalAuditEventDestinationUpdate

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: InstanceExternalAuditEventDestinationUpdateInput

Arguments:

NameTypeDescription
activeBooleanActive status of the destination.
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationUrlStringDestination URL to change.
idAuditEventsInstanceExternalAuditEventDestinationID!ID of the external instance audit event destination to update.
nameStringDestination name.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
instanceExternalAuditEventDestinationInstanceExternalAuditEventDestinationUpdated destination.

Mutation.instanceGoogleCloudLoggingConfigurationCreate

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsCreate with gcpLogging category instead.

Input type: InstanceGoogleCloudLoggingConfigurationCreateInput

Arguments:

NameTypeDescription
clientEmailString!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.
clientMutationIdStringA unique identifier for the client performing the mutation.
googleProjectIdNameString!Unique identifier of the Google Cloud project to which the logging configuration belongs.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events).
nameStringDestination name.
privateKeyString!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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
instanceGoogleCloudLoggingConfigurationInstanceGoogleCloudLoggingConfigurationTypeconfiguration created.

Mutation.instanceGoogleCloudLoggingConfigurationDestroy

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: InstanceGoogleCloudLoggingConfigurationDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceGoogleCloudLoggingConfigurationID!ID of the Google Cloud logging configuration to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.instanceGoogleCloudLoggingConfigurationUpdate

  • Deprecated in GitLab 18.10.
  • Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput

Arguments:

NameTypeDescription
activeBooleanActive status of the destination.
clientEmailStringEmail 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.
clientMutationIdStringA unique identifier for the client performing the mutation.
googleProjectIdNameStringUnique identifier of the Google Cloud project to which the logging configuration belongs.
idAuditEventsInstanceGoogleCloudLoggingConfigurationID!ID of the instance google Cloud configuration to update.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.
nameStringDestination name.
privateKeyStringPrivate 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
instanceGoogleCloudLoggingConfigurationInstanceGoogleCloudLoggingConfigurationTypeconfiguration updated.

Mutation.instanceSecretsManagerEnroll

Input type: InstanceSecretsManagerEnrollInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.instanceSecretsManagerUnenroll

Input type: InstanceSecretsManagerUnenrollInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.integrationExclusionCreate

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: IntegrationExclusionCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[GroupID!]IDs of groups to exclude up to a maximum of 100.
integrationNameIntegrationType!Type of integration to exclude.
projectIds[ProjectID!]IDs of projects to exclude up to a maximum of 100.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[GroupID!]IDs of excluded groups.
integrationNameIntegrationType!Type of integration.
projectIds[ProjectID!]IDs of excluded projects.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIssueID!Incident id to associate the resource link with.
linkString!Link of the resource.
linkTextStringLink text of the resource.
linkTypeIssuableResourceLinkTypeLink type of the resource.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issuableResourceLinkIssuableResourceLinkIssuable resource link.

Mutation.issuableResourceLinkDestroy

Input type: IssuableResourceLinkDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementIssuableResourceLinkID!Issuable resource link ID to remove.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issuableResourceLinkIssuableResourceLinkIssuable resource link.

Mutation.issueLinkAlerts

Input type: IssueLinkAlertsInput

Arguments:

NameTypeDescription
alertReferences[String!]!Alerts references to be linked to the incident.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueMove

Input type: IssueMoveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
targetProjectPathID!Project to move the issue to.
targetWorkItemTypeIdWorkItemsTypeIDWork item type to use in the target project. When omitted, the source work item type is preserved.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueMoveList

Input type: IssueMoveListInput

Arguments:

NameTypeDescription
boardIdBoardID!Global ID of the board that the issue is in.
clientMutationIdStringA unique identifier for the client performing the mutation.
epicId warning-solidEpicIDDeprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
fromListIdIDID of the board list that the issue will be moved from.
iidString!IID of the issue to mutate.
moveAfterIdIDID of issue that should be placed after the current issue.
moveBeforeIdIDID of issue that should be placed before the current issue.
positionInListIntPosition of issue within the board list. Positions start at 0. Use -1 to move to the end of the list.
projectPathID!Project the issue to mutate is in.
toListIdIDID of the board list that the issue will be moved to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetAssignees

Input type: IssueSetAssigneesInput

Arguments:

NameTypeDescription
assigneeUsernames[String!]!Usernames to assign to the resource. Replaces existing assignees by default.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetConfidential

Input type: IssueSetConfidentialInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
confidentialBoolean!Whether or not to set the issue as a confidential.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetCrmContacts

Input type: IssueSetCrmContactsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contactIds[CustomerRelationsContactID!]!Customer relations contact IDs to set. Replaces existing contacts by default.
iidString!IID of the issue to mutate.
operationModeMutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetDueDate

Input type: IssueSetDueDateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dueDateTimeDesired due date for the issue. Due date is removed if null.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetEpic

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: IssueSetEpicInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicId warning-solidEpicIDDeprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetEscalationPolicy

Input type: IssueSetEscalationPolicyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
escalationPolicyIdIncidentManagementEscalationPolicyIDGlobal ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetEscalationStatus

Input type: IssueSetEscalationStatusInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
statusIssueEscalationStatus!Set the escalation status.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetIteration

Input type: IssueSetIterationInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
iterationIdIterationIDIteration to assign to the issue.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetLocked

Input type: IssueSetLockedInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
lockedBoolean!Whether or not to lock discussion on the issue.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetSeverity

Input type: IssueSetSeverityInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
severityIssuableSeverity!Set the incident severity level.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetSubscription

Input type: IssueSetSubscriptionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
subscribedStateBoolean!Desired state of the subscription.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueSetWeight

Input type: IssueSetWeightInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
weightIntThe desired weight for the issue. If set to null, weight is removed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.issueUnlinkAlert

Input type: IssueUnlinkAlertInput

Arguments:

NameTypeDescription
alertIdAlertManagementAlertID!Global ID of the alert to unlink from the incident.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.iterationCadenceCreate

Input type: IterationCadenceCreateInput

Arguments:

NameTypeDescription
activeBoolean!Whether the iteration cadence is active.
automaticBoolean!Whether the iteration cadence should automatically generate upcoming iterations.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeksIntDuration in weeks of the iterations within the cadence.
groupPathID!Group where the iteration cadence is created.
iterationsInAdvanceIntNumber of future iterations to schedule in addition to the current one.
rollOverBooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDateTimeTimestamp of the automation start date.
titleStringTitle of the iteration cadence.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
iterationCadenceIterationCadenceCreated iteration cadence.

Mutation.iterationCadenceDestroy

Input type: IterationCadenceDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIterationsCadenceID!Global ID of the iteration cadence.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupGroup!Group the iteration cadence belongs to.

Mutation.iterationCadenceUpdate

Input type: IterationCadenceUpdateInput

Arguments:

NameTypeDescription
activeBooleanWhether the iteration cadence is active.
automaticBooleanWhether the iteration cadence should automatically generate upcoming iterations.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeksIntDuration in weeks of the iterations within the cadence.
idIterationsCadenceID!Global ID of the iteration cadence.
iterationsInAdvanceIntNumber of future iterations to schedule in addition to the current one.
rollOverBooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDateTimeTimestamp of the automation start date.
titleStringTitle of the iteration cadence.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
iterationCadenceIterationCadenceUpdated iteration cadence.

Mutation.iterationCreate

Input type: iterationCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathIDFull path of the group with which the resource is associated.
iterationsCadenceIdIterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPathIDFull path of the project with which the resource is associated.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
iterationIterationCreated iteration.

Mutation.iterationDelete

Input type: IterationDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIterationID!ID of the iteration.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupGroup!Group the iteration belongs to.

Mutation.jiraImportStart

Input type: JiraImportStartInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
jiraProjectKeyString!Project key of the importer Jira project.
jiraProjectName warning-solidStringDeprecated in GitLab 17.4. Argument is not used.
projectPathID!Project to import the Jira project into.
usersMapping[JiraUsersMappingInputType!]Mapping of Jira to GitLab users.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
jiraImportJiraImportJira import data after mutation.

Mutation.jiraImportUsers

Input type: JiraImportUsersInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project to import the Jira users into.
startAtIntIndex of the record the import should started at, default 0 (50 records returned).

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiBuildID!ID of the job to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destroyedArtifactsCountInt!Number of artifacts deleted.
errors[String!]!Errors encountered during the mutation.
jobCiJobJob with artifacts to be deleted.

Mutation.jobCancel

Input type: JobCancelInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiBuildID!ID of the job to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
jobCiJobJob after the mutation.

Mutation.jobPlay

Input type: JobPlayInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiProcessableID!ID of the job to mutate.
inputs[CiInputsInput!]Inputs to use when playing the job.
variables[CiVariableInput!]Variables to use when playing a manual job.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
jobCiJobJob after the mutation.

Mutation.jobRetry

Input type: JobRetryInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiProcessableID!ID of the job to mutate.
inputs[CiInputsInput!]Inputs to use when retrying the job.
variables[CiVariableInput!]Variables to use when retrying a manual job.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
jobCiJobJob after the mutation.

Mutation.jobUnschedule

Input type: JobUnscheduleInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiBuildID!ID of the job to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
jobCiJobJob after the mutation.

Mutation.labelCreate

Input type: LabelCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
colorStringThe color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names.
descriptionStringDescription of the label.
groupPathIDFull path of the group with which the resource is associated.
projectPathIDFull path of the project with which the resource is associated.
titleString!Title of the label.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
labelLabelLabel after mutation.

Mutation.labelUpdate

Input type: LabelUpdateInput

Arguments:

NameTypeDescription
archivedBooleanWhether to archive the label. Introduced in GitLab 18.10.
clientMutationIdStringA unique identifier for the client performing the mutation.
idLabelID!Global ID of the label to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
labelLabelLabel after mutation.

Mutation.ldapAdminRoleLinkCreate

  • Introduced in GitLab 17.11.
  • Status: Experiment.

Creates an instance-level custom admin role LDAP link.

Input type: LdapAdminRoleLinkCreateInput

Arguments:

NameTypeDescription
adminMemberRoleIdMemberRoleID!Global ID of the custom admin role to be assigned to a user.
clientMutationIdStringA unique identifier for the client performing the mutation.
cnStringCommon Name (CN) of the LDAP group.
filterStringSearch filter for the LDAP group.
providerString!LDAP provider for the LDAP link.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
ldapAdminRoleLinkLdapAdminRoleLinkCreated 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuthzLdapAdminRoleLinkID!Global ID of the instance-level LDAP link to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
ldapAdminRoleLinkLdapAdminRoleLinkDeleted instance-level LDAP link.

Mutation.lifecycleAttachWorkItemType

  • Introduced in GitLab 18.4.
  • Status: Experiment.

Input type: LifecycleAttachWorkItemTypeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
lifecycleIdWorkItemsStatusesLifecycleID!Global ID of the lifecycle to attach the work item type to.
namespacePathID!Namespace path where the lifecycle exists.
statusMappings[StatusMappingInput!]Status mappings from the old lifecycle to the new lifecycle.
workItemTypeIdWorkItemsTypeID!Global ID of the work item type to attach to the lifecycle.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
lifecycleWorkItemLifecycleLifecycle after attaching the work item type.

Mutation.lifecycleCreate

  • Introduced in GitLab 18.4.
  • Status: Experiment.

Input type: LifecycleCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultClosedStatusIndexInt!Index of the default closed status in the statuses array.
defaultDuplicateStatusIndexInt!Index of the default duplicated status in the statuses array.
defaultOpenStatusIndexInt!Index of the default open status in the statuses array.
nameString!Name of the lifecycle.
namespacePathID!Namespace path where the lifecycle will be created.
statuses[WorkItemStatusInput!]!Statuses of the lifecycle. Can be existing (with id) or new (without id).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
lifecycleWorkItemLifecycleLifecycle created.

Mutation.lifecycleDelete

  • Introduced in GitLab 18.4.
  • Status: Experiment.

Input type: LifecycleDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemsStatusesLifecycleID!Global ID of the lifecycle to delete.
namespacePathID!Namespace path where the lifecycle exists.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
lifecycleWorkItemLifecycleDeleted lifecycle.

Mutation.lifecycleUpdate

  • Introduced in GitLab 18.1.
  • Status: Experiment.

Input type: LifecycleUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultClosedStatusIndexIntIndex of the default closed status in the statuses array.
defaultDuplicateStatusIndexIntIndex of the default duplicated status in the statuses array.
defaultOpenStatusIndexIntIndex of the default open status in the statuses array.
idWorkItemsStatusesLifecycleID!Global ID of the lifecycle to be updated.
nameStringName of the lifecycle.
namespacePathID!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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
lifecycleWorkItemLifecycleLifecycle updated.

Mutation.linkProjectComplianceViolationIssue

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: LinkProjectComplianceViolationIssueInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
issueIidString!IID of the issue to be linked.
projectPathID!Full path of the project the issue belongs to.
violationIdComplianceManagementProjectsComplianceViolationID!Global ID of the project compliance violation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
violationProjectComplianceViolationUpdated project compliance violation.

Mutation.markAsSpamSnippet

Input type: MarkAsSpamSnippetInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSnippetID!Global ID of the snippet to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
snippetSnippetSnippet after mutation.

Mutation.mavenCacheEntryDelete

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: MavenCacheEntryDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idString!ID of the cache entry.

Fields:

NameTypeDescription
cacheEntryMavenUpstreamCacheEntryMaven cache entry.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.mavenUpstreamCacheDelete

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: MavenUpstreamCacheDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesPackagesMavenUpstreamID!ID of the Maven virtual registry upstream.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
upstreamMavenUpstreamDetailsMaven virtual registry upstream.

Mutation.mavenUpstreamCreate

  • Introduced in GitLab 18.2.
  • Status: Experiment.

Input type: MavenUpstreamCreateInput

Arguments:

NameTypeDescription
cacheValidityHoursIntCache validity period. Defaults to 24 hours.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the upstream registry.
idVirtualRegistriesPackagesMavenRegistryID!ID of the upstream registry.
metadataCacheValidityHoursIntMetadata cache validity period. Defaults to 24 hours.
nameString!Name of upstream registry.
passwordStringPassword of the upstream registry.
urlString!URL of the upstream registry.
usernameStringUsername of the upstream registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
upstreamMavenUpstreamDetailsMaven upstream after the mutation.

Mutation.mavenUpstreamDelete

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: MavenUpstreamDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesPackagesMavenUpstreamID!ID of the upstream to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
upstreamMavenUpstreamDetailsDestroyed upstream.

Mutation.mavenUpstreamUpdate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: MavenUpstreamUpdateInput

Arguments:

NameTypeDescription
cacheValidityHoursIntCache validity period.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the upstream registry.
idVirtualRegistriesPackagesMavenUpstreamID!ID of the upstream registry.
metadataCacheValidityHoursIntMetadata cache validity period.
nameStringName of upstream registry.
passwordStringPassword of the upstream registry.
urlStringURL of the upstream registry.
usernameStringUsername of the upstream registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
upstreamMavenUpstreamDetailsMaven upstream after the mutation.

Mutation.mavenVirtualRegistryCacheDelete

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: MavenVirtualRegistryCacheDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesPackagesMavenRegistryID!ID of the Maven virtual registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryMavenRegistryMaven virtual registry.

Mutation.mavenVirtualRegistryCreate

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: MavenVirtualRegistryCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the virtual registry.
groupPathIDFull path of the group with which the resource is associated.
nameString!Name of virtual registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryMavenRegistryMaven virtual registry after the mutation.

Mutation.mavenVirtualRegistryDelete

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: MavenVirtualRegistryDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesPackagesMavenRegistryID!ID of the Maven virtual registry to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryMavenRegistryDeleted Maven virtual registry.

Mutation.mavenVirtualRegistryUpdate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: MavenVirtualRegistryUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the virtual registry.
idVirtualRegistriesPackagesMavenRegistryID!ID of the Maven virtual registry to be updated.
nameStringName of virtual registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryMavenRegistryMaven virtual registry after the mutation.

Mutation.mavenVirtualRegistryUpstreamDelete

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Input type: MavenVirtualRegistryUpstreamDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
upstreamIdVirtualRegistriesPackagesMavenRegistryUpstreamID!ID of the Maven virtual registry upstream.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryUpstreamMavenRegistryUpstreamWithRegistryDeleted maven registry upstream.

Mutation.mavenVirtualRegistryUpstreamUpdate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: MavenVirtualRegistryUpstreamUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVirtualRegistriesPackagesMavenRegistryUpstreamID!ID of the Maven virtual registry upstream.
positionInt!Priority order of an upstream within a virtual registry.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
registryUpstreamMavenRegistryUpstreamWithRegistryMaven registry upstream after update.

Mutation.memberRoleAdminCreate

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Input type: MemberRoleAdminCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the member role.
nameStringName of the member role.
permissions[MemberRoleAdminPermission!]List of all customizable admin permissions.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
memberRoleAdminMemberRoleMember role.

Mutation.memberRoleAdminDelete

  • Introduced in GitLab 17.10.
  • Status: Experiment.

Input type: MemberRoleAdminDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMemberRoleID!ID of the admin member role to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
memberRoleMemberRoleDeleted admin member role.

Mutation.memberRoleAdminUpdate

  • Introduced in GitLab 17.10.
  • Status: Experiment.

Input type: MemberRoleAdminUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the member role.
idMemberRoleID!ID of the member role to mutate.
nameStringName of the member role.
permissions[MemberRoleAdminPermission!]List of all customizable admin permissions.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
memberRoleAdminMemberRoleMember role.

Mutation.memberRoleCreate

  • Introduced in GitLab 16.5.
  • Status: Experiment.

Input type: MemberRoleCreateInput

Arguments:

NameTypeDescription
baseAccessLevelMemberRolesAccessLevel!Base access level for the custom role.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the member role.
groupPathIDGroup the member role to mutate is in. Required for SaaS.
nameStringName of the member role.
permissions[MemberRolePermission!]List of all customizable permissions.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
memberRoleMemberRoleMember role.

Mutation.memberRoleDelete

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: MemberRoleDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMemberRoleID!ID of the member role to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
memberRoleMemberRoleDeleted member role.

Mutation.memberRoleToUserAssign

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Input type: MemberRoleToUserAssignInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
memberRoleIdMemberRoleIDGlobal 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.
userIdUserID!Global ID of the user to be assigned to a custom role.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userMemberRoleUserMemberRoleCreated user member role or nil if the relation was deleted.

Mutation.memberRoleUpdate

Input type: MemberRoleUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the member role.
idMemberRoleID!ID of the member role to mutate.
nameStringName of the member role.
permissions[MemberRolePermission!]List of all customizable permissions.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
memberRoleMemberRoleMember 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commitMessageStringCustom merge commit message.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
shaString!HEAD SHA at the time when the merge was requested.
shouldRemoveSourceBranchBooleanShould the source branch be removed.
squashBooleanSquash commits on the source branch before merge.
squashCommitMessageStringCustom squash commit message (if squash is true).
strategyMergeStrategyEnumHow to merge the merge request.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestBypassSecurityPolicy

  • Introduced in GitLab 18.5.
  • Status: Experiment.

Bypasses security policies for a merge request.

Input type: MergeRequestBypassSecurityPolicyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
reasonString!Reason for bypassing the security policy.
securityPolicyIds[ID!]!ID of the security policy to bypass.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestCreate

Input type: MergeRequestCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the merge request (Markdown rendered as HTML for caching).
labels[String!]Labels of the merge request.
mergeAfterTimeDate after which the merge request can be merged.
projectPathID!Project full path the merge request is associated with.
removeSourceBranchBooleanIndicates if the source branch of the merge request will be deleted after merge.
sourceBranchString!Source branch of the merge request.
targetBranchString!Target branch of the merge request.
titleString!Title of the merge request.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestCreateWorkItemRelations

Links work items to a merge request.

Input type: MergeRequestCreateWorkItemRelationsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
linkTypeMergeRequestWorkItemLinkTypeType of relationship to create. Defaults to RELATED. MENTIONED relations are managed automatically and cannot be created.
projectPathID!Project the merge request to mutate is in.
workItemIds[WorkItemID!]!Global IDs of the work items to link.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.
workItemRelations[MergeRequestWorkItemRelation!]Created merge request to work item relations.

Mutation.mergeRequestDestroyRequestedChanges

Input type: MergeRequestDestroyRequestedChangesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestDestroyWorkItemRelations

Removes relations between a merge request and work items.

Input type: MergeRequestDestroyWorkItemRelationsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[MergeRequestsClosingIssuesID!]!Global IDs of the relations to remove.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.
removedRelationIds[MergeRequestsClosingIssuesID!]Global IDs of the removed relations.

Mutation.mergeRequestRequestChanges

Input type: MergeRequestRequestChangesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestResyncSecurityPolicies

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Triggers a re-evaluation of the security approval policies applicable to the merge request.

Input type: MergeRequestResyncSecurityPoliciesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to re-evaluate.
projectPathID!Project the merge request belongs to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after the re-evaluation was scheduled.

Mutation.mergeRequestReviewerRereview

Input type: MergeRequestReviewerRereviewInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
userIdUserID!User ID for the user that has been requested for a new review.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetAssignees

Input type: MergeRequestSetAssigneesInput

Arguments:

NameTypeDescription
assigneeUsernames[String!]!Usernames to assign to the resource. Replaces existing assignees by default.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetBlockingMergeRequests

Input type: MergeRequestSetBlockingMergeRequestsInput

Arguments:

NameTypeDescription
blockingMergeRequestReferences[String!]!Array of blocking merge request references (e.g., “!123”, “project!456”).
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetDraft

Input type: MergeRequestSetDraftInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
draftBoolean!Whether or not to set the merge request as a draft.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetLabels

Input type: MergeRequestSetLabelsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
labelIds[LabelID!]!Label IDs to set. Replaces existing labels by default.
operationModeMutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetLocked

Input type: MergeRequestSetLockedInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
lockedBoolean!Whether or not to lock the merge request.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetMilestone

Input type: MergeRequestSetMilestoneInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
milestoneIdMilestoneIDMilestone to assign to the merge request.
projectPathID!Project the merge request to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetReviewers

Input type: MergeRequestSetReviewersInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.
projectPathID!Project the merge request to mutate is in.
reviewerUsernames[String!]!Usernames of reviewers to assign. Replaces existing reviewers by default.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetSubscription

Input type: MergeRequestSetSubscriptionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
subscribedStateBoolean!Desired state of the subscription.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestUpdate

Update attributes of a merge request.

Input type: MergeRequestUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the merge request (Markdown rendered as HTML for caching).
iidString!IID of the merge request to mutate.
mergeAfterTimeDate after which the merge request can be merged.
overrideRequestedChangesBooleanOverride all requested changes. Can only be set by users who have permissionto merge this merge request.
projectPathID!Project the merge request to mutate is in.
removeSourceBranchBooleanIndicates if the source branch of the merge request will be deleted after merge.
stateMergeRequestNewStateAction to perform to change the state.
targetBranchStringTarget branch of the merge request.
timeEstimateStringEstimated time to complete the merge request. Use null or 0 to remove the current estimate.
titleStringTitle of the merge request.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestUpdateApprovalRule

Input type: MergeRequestUpdateApprovalRuleInput

Arguments:

NameTypeDescription
approvalRuleIdInt!ID of an approval rule.
approvalsRequiredInt!Number of required approvals for a given rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[String!]IDs of groups as approvers.
iidString!IID of the merge request to mutate.
nameString!Name of the approval rule.
projectPathID!Project the merge request to mutate is in.
removeHiddenGroupsBooleanWhether hidden groups should be removed.
userIds[String!]IDs of users as approvers.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeTrainsDeleteCar

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: MergeTrainsDeleteCarInput

Arguments:

NameTypeDescription
carIdMergeTrainsCarID!Global ID of the car.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields:

NameTypeDescription
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the model.
nameString!Name of the model.
projectPathID!Project the model to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
modelMlModelModel after mutation.

Mutation.mlModelDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: MlModelDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMlModelID!Global ID of the model to be deleted.
projectPathID!Project the model to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
modelMlModelModel after mutation.

Mutation.mlModelDestroy

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: MlModelDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMlModelID!Global ID of the model to be deleted.
projectPathID!Project the model to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
messageStringModel deletion result message.
modelMlModelModel after mutation.

Mutation.mlModelEdit

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Input type: MlModelEditInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the model.
modelIdIntId of the model.
nameString!Name of the model.
projectPathID!Project the model to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
modelMlModelModel after mutation.

Mutation.mlModelVersionCreate

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: MlModelVersionCreateInput

Arguments:

NameTypeDescription
candidateIdMlCandidateIDGlobal ID of a candidate to promote optionally.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the model version.
modelIdMlModelID!Global ID of the model the version belongs to.
projectPathID!Project the model to mutate is in.
versionStringModel version.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
modelVersionMlModelVersionModel after mutation.

Mutation.mlModelVersionDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: MlModelVersionDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMlModelVersionID!Global ID of the model version to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
modelVersionMlModelVersionDeleted model version.

Mutation.mlModelVersionEdit

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: MlModelVersionEditInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionString!Description of the model version.
modelIdMlModelID!Global ID of the model the version belongs to.
projectPathID!Project the model to mutate is in.
versionString!Model version.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
modelVersionMlModelVersionModel after mutation.

Mutation.namespaceBanDestroy

Input type: NamespaceBanDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idNamespacesNamespaceBanID!Global ID of the namespace ban to remove.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceBanNamespaceBanNamespace Ban.

Mutation.namespaceCiCdSettingsUpdate

Input type: NamespaceCiCdSettingsUpdateInput

Arguments:

NameTypeDescription
allowStaleRunnerPruningBooleanIndicates if stale runners directly belonging to the namespace should be periodically pruned.
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the namespace the settings belong to.

Fields:

NameTypeDescription
ciCdSettingsNamespaceCiCdSetting!CI/CD settings after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.namespaceCreateRemoteDevelopmentClusterAgentMapping

Input type: NamespaceCreateRemoteDevelopmentClusterAgentMappingInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be associated with the namespace.
namespaceIdGroupID!GlobalID of the group to be associated with the cluster agent.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceClusterAgentMapping warning-solidNamespaceClusterAgentMappingIntroduced in GitLab 17.10. Status: Experiment. Created namespace cluster agent mapping.

Mutation.namespaceDeleteRemoteDevelopmentClusterAgentMapping

Input type: NamespaceDeleteRemoteDevelopmentClusterAgentMappingInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be un-associated from the namespace.
namespaceIdGroupID!GlobalID of the group to be un-associated from the cluster agent.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceClusterAgentMapping warning-solidNamespaceClusterAgentMappingIntroduced in GitLab 17.11. Status: Experiment. Created namespace cluster agent mapping.

Mutation.namespaceSecretsManagerEnroll

Input type: NamespaceSecretsManagerEnrollInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Full path of the namespace to enroll.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enrollmentSecretsManagerEnrollmentEnrollment record.
errors[String!]!Errors encountered during the mutation.

Mutation.namespaceSecretsManagerUnenroll

Input type: NamespaceSecretsManagerUnenrollInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Full path of the namespace to unenroll.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enrollmentSecretsManagerEnrollmentEnrollment record.
errors[String!]!Errors encountered during the mutation.

Mutation.namespaceSettingsUpdate

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: NamespaceSettingsUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the namespace the settings belong to.
pipelineVariablesDefaultRolePipelineVariablesDefaultRoleTypeIndicates the default minimum role required to override pipeline variables in the namespace.

Fields:

NameTypeDescription
ciCdSettingsCiCdSettings!Namespace CI/CD settings after mutation.
clientMutationIdStringA 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the namespace to regenerate the new work item email address for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceNamespaceNamespace after regenerating the new work item email address.

Mutation.noteConvertToThread

Convert a standard comment to a resolvable thread.

Input type: NoteConvertToThreadInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idNoteID!Global ID of the Note to convert.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.oncallRotationCreate

Input type: OncallRotationCreateInput

Arguments:

NameTypeDescription
activePeriodOncallRotationActivePeriodInputTypeActive period of time that the on-call rotation should take place.
clientMutationIdStringA unique identifier for the client performing the mutation.
endsAtOncallRotationDateInputTypeEnd date and time of the on-call rotation, in the timezone of the on-call schedule.
nameString!Name of the on-call rotation.
participants[OncallUserInputType!]!Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
projectPathID!Project to create the on-call schedule in.
rotationLengthOncallRotationLengthInputType!Rotation length of the on-call rotation.
scheduleIidString!IID of the on-call schedule to create the on-call rotation in.
startsAtOncallRotationDateInputType!Start date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

Mutation.oncallRotationDestroy

Input type: OncallRotationDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementOncallRotationID!ID of the on-call rotation to remove.
projectPathID!Project to remove the on-call schedule from.
scheduleIidString!IID of the on-call schedule to the on-call rotation belongs to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

Mutation.oncallRotationUpdate

Input type: OncallRotationUpdateInput

Arguments:

NameTypeDescription
activePeriodOncallRotationActivePeriodInputTypeActive period of time that the on-call rotation should take place.
clientMutationIdStringA unique identifier for the client performing the mutation.
endsAtOncallRotationDateInputTypeEnd date and time of the on-call rotation, in the timezone of the on-call schedule.
idIncidentManagementOncallRotationID!ID of the on-call schedule to create the on-call rotation in.
nameStringName of the on-call rotation.
participants[OncallUserInputType!]Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
rotationLengthOncallRotationLengthInputTypeRotation length of the on-call rotation.
startsAtOncallRotationDateInputTypeStart date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

Mutation.oncallScheduleCreate

Input type: OncallScheduleCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the on-call schedule.
nameString!Name of the on-call schedule.
projectPathID!Project to create the on-call schedule in.
timezoneString!Timezone of the on-call schedule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

Mutation.oncallScheduleDestroy

Input type: OncallScheduleDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!On-call schedule internal ID to remove.
projectPathID!Project to remove the on-call schedule from.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

Mutation.oncallScheduleUpdate

Input type: OncallScheduleUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the on-call schedule.
iidString!On-call schedule internal ID to update.
nameStringName of the on-call schedule.
projectPathID!Project to update the on-call schedule in.
timezoneStringTimezone of the on-call schedule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

Mutation.orbitUpdate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: OrbitUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBoolean!Whether to enable or disable the Knowledge Graph for the group.
groupPathID!Full path of the group to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
groupGroupGroup after mutation.

Mutation.organizationConfirm

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Input type: OrganizationConfirmInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groups[GroupID!]Global IDs of top-level groups to transfer to the organization.
idOrganizationsOrganizationID!Global ID of the organization to confirm.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
organizationOrganizationOrganization after mutation.

Mutation.organizationCreate

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Input type: OrganizationCreateInput

Arguments:

NameTypeDescription
avatarUploadAvatar for the organization.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the organization.
nameString!Name for the organization.
pathString!Path for the organization.
visibilityOrganizationVisibilityVisibility for the organization.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
organizationOrganizationOrganization after mutation.

Mutation.organizationCreateClusterAgentMapping

  • Introduced in GitLab 17.11.
  • Status: Experiment.

Input type: OrganizationCreateClusterAgentMappingInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be associated with the organization.
organizationIdOrganizationsOrganizationID!GlobalID of the organization to be associated with the cluster agent.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.organizationDelete

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Input type: OrganizationDeleteInput

Arguments:

NameTypeDescription
avatarUploadAvatar for the organization.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the organization.
idOrganizationsOrganizationID!ID of the organization to soft-delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
organizationOrganizationSoft-deleted organization.

Mutation.organizationDeleteClusterAgentMapping

  • Introduced in GitLab 17.11.
  • Status: Experiment.

Input type: OrganizationDeleteClusterAgentMappingInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be dissociated with the organization.
organizationIdOrganizationsOrganizationID!GlobalID of the organization to be dissociated with the cluster agent.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.organizationRestore

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Input type: OrganizationRestoreInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idOrganizationsOrganizationID!ID of the organization to restore.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
organizationOrganizationRestored organization.

Mutation.organizationUpdate

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: OrganizationUpdateInput

Arguments:

NameTypeDescription
avatarUploadAvatar for the organization.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the organization.
idOrganizationsOrganizationID!ID of the organization to mutate.
nameStringName for the organization.
pathStringPath for the organization.
visibilityOrganizationVisibilityVisibility for the organization.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
organizationOrganizationOrganization after mutation.

Mutation.organizationUserUpdate

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Input type: OrganizationUserUpdateInput

Arguments:

NameTypeDescription
accessLevelOrganizationUserAccessLevel!Access level to update the organization user to.
clientMutationIdStringA unique identifier for the client performing the mutation.
idOrganizationsOrganizationUserID!ID of the organization user to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
organizationUser warning-solidOrganizationUserIntroduced in GitLab 17.5. Status: Experiment. Organization user after mutation.

Mutation.pagesMarkOnboardingComplete

Input type: PagesMarkOnboardingCompleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
onboardingCompleteBoolean!Indicates the new onboarding_complete state of the project’s Pages metadata.

Mutation.personalAccessTokenCreate

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Creates a personal access token for the current user.

Input type: PersonalAccessTokenCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the token.
expiresAtISO8601DateExpiration date of the token.
granularScopes[GranularScopeInput!]!List of granular scopes to assign to the token.
nameString!Name of the token.
sudoBooleanWhether the token can impersonate other users with sudo. Requires the token owner to be an administrator.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
tokenStringCreated personal access token.

Mutation.personalAccessTokenRevoke

  • Introduced in GitLab 18.8.
  • Status: Experiment.

Revokes a specified personal access token.

Input type: PersonalAccessTokenRevokeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPersonalAccessTokenID!Global ID of the personal access token that will be revoked.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.personalAccessTokenRotate

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Rotate a specified personal access token.

Input type: PersonalAccessTokenRotateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
expiresAtISO8601DateExpiration date of the token.
idPersonalAccessTokenID!Global ID of the personal access token that will be rotated.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
tokenStringCreated personal access token.

Mutation.pipelineCancel

Input type: PipelineCancelInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineID!ID of the pipeline to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelinePipelinePipeline after mutation.

Mutation.pipelineCreate

Input type: PipelineCreateInput

Arguments:

NameTypeDescription
async warning-solidBooleanIntroduced in GitLab 17.8. Status: Experiment. When true, the request does not wait for the pipeline to be created, and returns a unique identifier that can be used to check the creation status.
clientMutationIdStringA unique identifier for the client performing the mutation.
inputs warning-solid[CiInputsInput!]Introduced in GitLab 17.10. Status: Experiment. Inputs for the pipeline.
mergeRequestIidStringIID of the merge request to create pipeline for.
projectPathID!Full path of the project that is triggering the pipeline.
refString!Ref on which to run the pipeline. Ignored when mergeRequestIid is provided; the merge request ref path is used instead.
variables[CiVariableInput!]Variables for the pipeline.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelinePipelinePipeline created after mutation. Null if async: true.
requestId warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. ID for checking the pipeline creation status. Null if async: false.

Mutation.pipelineDestroy

Input type: PipelineDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineID!ID of the pipeline to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.pipelineExecutionSchedulePolicyTestRun

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Triggers a test-run for a Scheduled Pipeline Execution Policy on a specific project.

Input type: PipelineExecutionSchedulePolicyTestRunInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
policyIdSecurityPolicyID!Global ID of the pipeline execution schedule policy to test.
projectPathID!Full path of the project to run the test on.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
testRunPolicyScheduleTestRunTest-run record created.

Mutation.pipelineRetry

Input type: PipelineRetryInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineID!ID of the pipeline to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelinePipelinePipeline after mutation.

Mutation.pipelineScheduleCreate

Input type: PipelineScheduleCreateInput

Arguments:

NameTypeDescription
activeBooleanIndicates if the pipeline schedule should be active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
cronString!Cron expression of the pipeline schedule.
cronTimezoneStringCron time zone supported by ActiveSupport::TimeZone. For example: Pacific Time (US & Canada) (default: UTC).
descriptionString!Description of the pipeline schedule.
inputs warning-solid[CiInputsInput!]Introduced in GitLab 17.10. Status: Experiment. Inputs for the pipeline schedule.
projectPathID!Full path of the project the pipeline schedule is associated with.
refString!Ref of the pipeline schedule.
variables[PipelineScheduleVariableInput!]Variables for the pipeline schedule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelineSchedulePipelineScheduleCreated pipeline schedule.

Mutation.pipelineScheduleDelete

Input type: PipelineScheduleDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.pipelineSchedulePlay

Input type: PipelineSchedulePlayInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelineSchedulePipelineSchedulePipeline schedule after mutation.

Mutation.pipelineScheduleTakeOwnership

Input type: PipelineScheduleTakeOwnershipInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelineSchedulePipelineScheduleUpdated pipeline schedule ownership.

Mutation.pipelineScheduleUpdate

Input type: PipelineScheduleUpdateInput

Arguments:

NameTypeDescription
activeBooleanIndicates if the pipeline schedule should be active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
cronStringCron expression of the pipeline schedule.
cronTimezoneStringCron time zone supported by ActiveSupport::TimeZone. For example: Pacific Time (US & Canada) (default: UTC).
descriptionStringDescription of the pipeline schedule.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.
inputs warning-solid[CiInputsInput!]Introduced in GitLab 17.11. Status: Experiment. Inputs for the pipeline schedule.
refStringRef of the pipeline schedule.
variables[PipelineScheduleVariableInput!]Variables for the pipeline schedule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelineSchedulePipelineScheduleUpdated pipeline schedule.

Mutation.pipelineTriggerCreate

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: PipelineTriggerCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionString!Description of the pipeline trigger token.
expiresAtTimeTimestamp of when the pipeline trigger token expires.
projectPathID!Full path of the project that the pipeline trigger token to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelineTriggerPipelineTriggerMutated pipeline trigger token.

Mutation.pipelineTriggerDelete

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: PipelineTriggerDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiTriggerID!ID of the pipeline trigger token to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.pipelineTriggerUpdate

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: PipelineTriggerUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionString!Description of the pipeline trigger token.
idCiTriggerID!ID of the pipeline trigger token to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pipelineTriggerPipelineTriggerMutated pipeline trigger token.

Mutation.processUserBillablePromotionRequest

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: ProcessUserBillablePromotionRequestInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
statusMemberApprovalStatusType!Status for the member approval request (approved, denied, pending).
userIdUserID!Global ID of user to be promoted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
resultUserPromotionStatusTypeStatus of the user promotion process (success, partial_success, failed).

Mutation.projectBlobsRemove

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: projectBlobsRemoveInput

Arguments:

NameTypeDescription
blobOids[String!]!List of blob oids.
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project to replace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.projectCiCdSettingsUpdate

Input type: ProjectCiCdSettingsUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
crossProjectPushForJobTokenAllowedBooleanIndicates the ability to push to this repository using a job token from an allowlisted project.
displayPipelineVariablesBooleanIndicates whether pipeline variables can be displayed in the UI.
fullPathID!Full Path of the project the settings belong to.
groupRunnersEnabledBooleanIndicates whether group runners are enabled for the project.
inboundJobTokenScopeEnabledBooleanIndicates whether CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabled warning-solidBooleanDeprecated in GitLab 16.0. Outbound job token scope is being removed. This field can now only be set to false.
keepLatestArtifactBooleanIndicates whether the latest artifact should be kept for the project.
maxPipelinesPerMergeTrainIntMaximum number of parallel pipelines per merge train.
mergePipelinesEnabledBooleanIndicates if merged results pipelines are enabled for the project.
mergeTrainEnforcementMergeTrainEnforcementMerge train enforcement level for the project.
mergeTrainsEnabledBooleanIndicates if merge trains are enabled for the project.
mergeTrainsSkipTrainAllowedBooleanIndicates whether an option is allowed to merge without refreshing the merge train. Ignored unless the merge_trains_skip_train feature flag is also enabled.
pipelineVariablesMinimumOverrideRoleStringMinimum role required to set variables when creating a pipeline or running a job.
pushRepositoryForJobTokenAllowedBooleanIndicates the ability to push to the original project repository using a job token.
resourceGroupDefaultProcessModeResourceGroupsProcessModeDefault process mode for resource groups in the project.
skipBranchPipelinesForMrsBooleanIndicates whether branch pipelines are skipped if a merge request is open.

Fields:

NameTypeDescription
ciCdSettingsProjectCiCdSetting!CI/CD settings after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.projectCustomAttributeSet

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Sets (creates or updates) a custom attribute on a project. Only available to admins.

Input type: ProjectCustomAttributeSetInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
keyString!Key of the custom attribute.
projectPathID!Full path of the project.
valueString!Value of the custom attribute.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customAttributeCustomAttributeCustom attribute after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.projectMemberBulkUpdate

Updates multiple members of a project. To use this mutation, you must have at least the Maintainer role.

Input type: ProjectMemberBulkUpdateInput

Arguments:

NameTypeDescription
accessLevelMemberAccessLevel!Access level to update the members to.
clientMutationIdStringA unique identifier for the client performing the mutation.
expiresAtTimeDate and time the membership expires.
projectIdProjectID!Global ID of the project.
userIds[UserID!]!Global IDs of the members.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectMembers[ProjectMember!]Project members after mutation.

Mutation.projectSavedReplyCreate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: ProjectSavedReplyCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
nameString!Name of the saved reply.
projectIdProjectID!Project for the saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

Mutation.projectSavedReplyDestroy

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: ProjectSavedReplyDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectsSavedReplyID!Global ID of the project-level saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

Mutation.projectSavedReplyUpdate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: ProjectSavedReplyUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
idProjectsSavedReplyID!Global ID of the project-level saved reply.
nameString!Name of the saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

Mutation.projectSecretCreate

Input type: ProjectSecretCreateInput

Arguments:

NameTypeDescription
branchString!Branches that can access the secret.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the project secret.
environmentString!Environments that can access the secret.
nameString!Name of the project secret.
projectPathID!Project of the secret.
rotationIntervalDaysIntNumber of days between rotation reminders for the secret.
secretString!Value of the project secret.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectSecretProjectSecretProject secret.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.projectSecretDelete

Input type: ProjectSecretDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the project secret.
projectPathID!Project of the secret.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectSecretProjectSecretDeleted project secret.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.projectSecretUpdate

Input type: ProjectSecretUpdateInput

Arguments:

NameTypeDescription
branchStringNew branches that can access the secret.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringNew description of the project secret.
environmentStringNew environments that can access the secret.
metadataCasInt!This should match the current metadata version of the project secret being updated.
nameString!Name of the project secret to update.
projectPathID!Project of the secret.
rotationIntervalDaysIntNumber of days between rotation reminders for the secret.
secretStringNew value of the project secret.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectSecretProjectSecretUpdated project secret.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.projectSecretsManagerDeprovision

Input type: ProjectSecretsManagerDeprovisionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project of the secrets manager.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectSecretsManagerProjectSecretsManagerProject secrets manager.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.projectSecretsManagerInitialize

Input type: ProjectSecretsManagerInitializeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project of the secrets manager.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectSecretsManagerProjectSecretsManagerProject secrets manager.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.

Mutation.projectSecretsPermissionDelete

Input type: ProjectSecretsPermissionDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
principalPrincipalInput!User/MemberRole/Role/Group whose access is being removed.
projectPathID!Project from which the permissions are removed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.
secretsPermissionProjectSecretsPermissionSecrets Permission that was deleted.

Mutation.projectSecretsPermissionUpdate

Input type: ProjectSecretsPermissionUpdateInput

Arguments:

NameTypeDescription
actions[SecretsManagementAction!]!Actions that can be performed on secrets.
clientMutationIdStringA unique identifier for the client performing the mutation.
expiredAtISO8601DateExpiration date for Secret Permission (optional).
principalPrincipalInput!User/MemberRole/Role/Group that is provided access.
projectPathID!Project to which the permissions are added.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.
secretsPermissionProjectSecretsPermissionSecrets Permission that was created.

Mutation.projectSecurityExclusionCreate

Input type: ProjectSecurityExclusionCreateInput

Arguments:

NameTypeDescription
activeBoolean!Whether the exclusion is active.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringOptional description for the exclusion.
projectPathID!Full path of the project the exclusion will be associated with.
scannerExclusionScannerEnum!Scanner to ignore values for based on the exclusion.
typeExclusionTypeEnum!Type of the exclusion.
valueString!Value of the exclusion.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityExclusionProjectSecurityExclusionProject security exclusion created.

Mutation.projectSecurityExclusionDelete

Input type: ProjectSecurityExclusionDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSecurityProjectSecurityExclusionID!Global ID of the exclusion to be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.projectSecurityExclusionUpdate

Input type: ProjectSecurityExclusionUpdateInput

Arguments:

NameTypeDescription
activeBooleanWhether the exclusion is active.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringOptional description for the exclusion.
idSecurityProjectSecurityExclusionID!Global ID of the exclusion to be updated.
scannerExclusionScannerEnumScanner to ignore values for based on the exclusion.
typeExclusionTypeEnumType of the exclusion.
valueStringValue of the exclusion.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityExclusionProjectSecurityExclusionProject security exclusion updated.

Mutation.projectSetComplianceFramework

  • Deprecated in GitLab 17.11.
  • Use mutation ProjectUpdateComplianceFrameworks instead of this.

Assign (or unset) a compliance framework to a project. This mutation raises an error if the project has more than one compliance framework associated with it.

Input type: ProjectSetComplianceFrameworkInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceFrameworkIdComplianceManagementFrameworkIDID of the compliance framework to assign to the project. Set to null to unset.
projectIdProjectID!ID of the project to change the compliance framework of.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

Mutation.projectSetContinuousVulnerabilityScanning

  • Deprecated in GitLab 17.3.
  • CVS has been enabled permanently. See [this epic](https: //gitlab.com/groups/gitlab-org/-/epics/11474) for more information.

Enable or disable continuous vulnerability scanning for the given project.

Input type: ProjectSetContinuousVulnerabilityScanningInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for continuous vulnerability scanning feature.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
continuousVulnerabilityScanningEnabledBoolean!Whether feature is enabled.
errors[String!]!Errors encountered during the mutation.

Mutation.projectSetLocked

Input type: ProjectSetLockedInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
filePathString!Full path to the file.
lockBoolean!Whether or not to lock the file path.
projectPathID!Full path of the project to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

Mutation.projectSettingsUpdate

  • Introduced in GitLab 16.9.
  • Status: Experiment.

Input type: ProjectSettingsUpdateInput

Arguments:

NameTypeDescription
aiAuditEventsStorageEnabled warning-solidBooleanIntroduced in GitLab 19.2. Status: Experiment. Indicates whether AI audit events are stored for the project.
clientMutationIdStringA unique identifier for the client performing the mutation.
duoContextExclusionSettingsDuoContextExclusionSettingsInputSettings for excluding files from Duo context.
duoFeaturesEnabledBooleanIndicates whether GitLab Duo features are enabled for the project.
duoSastFpDetectionEnabledBooleanIndicates whether SAST False Positive Detection is enabled for the project.
duoSastVrWorkflowEnabledBooleanIndicates whether SAST Vulnerability Resolution workflow is enabled for the project.
duoSecretDetectionFpEnabledBooleanIndicates whether Secret Detection False Positive Detection is enabled for the project.
fullPathID!Full Path of the project the settings belong to.
toolApprovalForSessionEnabledBooleanIndicates whether tool approval for Duo Workflow sessions is enabled for the project.
webBasedCommitSigningEnabled warning-solidBooleanIntroduced in GitLab 18.2. Status: Experiment. Indicates whether web-based commit signing is enabled for the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectSettingsProjectSetting!Project settings after mutation.

Mutation.projectSubscriptionCreate

Input type: ProjectSubscriptionCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathString!Full path of the downstream project of the Project Subscription.
upstreamPathString!Full path of the upstream project of the Project Subscription.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
subscriptionCiSubscriptionsProjectProject Subscription created by the mutation.

Mutation.projectSubscriptionDelete

Input type: ProjectSubscriptionDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
subscriptionIdCiSubscriptionsProjectID!ID of the subscription to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

Mutation.projectSyncFork

  • Introduced in GitLab 15.9.
  • Status: Experiment.

Input type: ProjectSyncForkInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project to initialize.
targetBranchString!Ref of the fork to fetch into.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
detailsForkDetailsUpdated fork details.
errors[String!]!Errors encountered during the mutation.

Mutation.projectTargetBranchRuleCreate

Input type: ProjectTargetBranchRuleCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name for the target branch rule.
projectIdProjectID!Project ID for the target branch rule.
targetBranchString!Target branch for the target branch rule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
targetBranchRuleProjectTargetBranchRuleTarget branch rule after mutation.

Mutation.projectTargetBranchRuleDestroy

Input type: ProjectTargetBranchRuleDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectsTargetBranchRuleID!ID for the target branch rule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.projectTextReplace

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: projectTextReplaceInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project to replace.
replacements[String!]!List of text patterns to replace project-wide.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.projectTransfer

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Input type: ProjectTransferInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectID!Global ID of the project to transfer.
namespaceIdNamespaceID!Global ID of the target namespace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

Mutation.projectUpdateComplianceFrameworks

Update compliance frameworks for a project.

Input type: ProjectUpdateComplianceFrameworksInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceFrameworkIds[ComplianceManagementFrameworkID!]!IDs of the compliance framework to update for the project.
projectIdProjectID!ID of the project to change the compliance framework of.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

Mutation.prometheusIntegrationCreate

  • Deprecated in GitLab 18.2.
  • Use HttpIntegrationCreate.

Input type: PrometheusIntegrationCreateInput

Arguments:

NameTypeDescription
activeBoolean!Whether the integration is receiving alerts.
apiUrl warning-solidStringDeprecated in GitLab 18.2. Feature removed in 16.0.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameStringName of the integration.
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.
projectPathID!Project to create the integration in.
typeAlertManagementIntegrationTypeType of integration to create. Cannot be changed after creation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementPrometheusIntegrationNewly created integration.

Mutation.prometheusIntegrationResetToken

  • Deprecated in GitLab 18.2.
  • Use HttpIntegrationResetToken.

Input type: PrometheusIntegrationResetTokenInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIntegrationsPrometheusID!ID of the integration to mutate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementPrometheusIntegrationUpdated integration.

Mutation.prometheusIntegrationUpdate

  • Deprecated in GitLab 18.2.
  • Use HttpIntegrationUpdate.

Input type: PrometheusIntegrationUpdateInput

Arguments:

NameTypeDescription
activeBooleanWhether the integration is receiving alerts.
apiUrl warning-solidStringDeprecated in GitLab 18.2. Feature removed in 16.0.
clientMutationIdStringA unique identifier for the client performing the mutation.
idIntegrationsPrometheusID!ID of the integration to mutate.
nameStringName of the integration.
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementPrometheusIntegrationUpdated integration.

Mutation.promoteToEpic

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type. For more information, see [migration guide](https: //docs.gitlab.com/api/graphql/epic_work_items_api_migration_guide/).

Input type: PromoteToEpicInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathIDGroup the promoted epic will belong to.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after issue promotion.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.refreshFindingTokenStatus

Input type: RefreshFindingTokenStatusInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
vulnerabilityIdVulnerabilityID!Global ID of the Vulnerability whose token status should be refreshed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
findingTokenStatusVulnerabilityFindingTokenStatusUpdated token status record for the given finding.

Mutation.refreshSecurityFindingTokenStatus

Input type: RefreshSecurityFindingTokenStatusInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
securityFindingUuidString!UUID of the Security::Finding whose token status should be refreshed (MR context).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
findingTokenStatusSecurityFindingTokenStatusUpdated token status record for the given Security::Finding.

Mutation.refreshStandardsAdherenceChecks

Input type: RefreshStandardsAdherenceChecksInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group path.

Fields:

NameTypeDescription
adherenceChecksStatusStandardsAdherenceChecksStatusProgress of standards adherence checks.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.refreshVulnerabilityFindingTokenStatus

Input type: RefreshVulnerabilityFindingTokenStatusInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
vulnerabilityIdVulnerabilityID!Global ID of the Vulnerability whose token status should be refreshed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
findingTokenStatusVulnerabilityFindingTokenStatusUpdated token status record for the given Vulnerabilities::Finding.

Mutation.releaseAssetLinkCreate

Input type: ReleaseAssetLinkCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
directAssetPathStringRelative path for a direct asset link.
linkTypeReleaseAssetLinkTypeType of the asset link.
nameString!Name of the asset link.
projectPathID!Full path of the project the asset link is associated with.
tagNameString!Name of the associated release’s tag.
urlString!URL of the asset link.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
linkReleaseAssetLinkAsset link after mutation.

Mutation.releaseAssetLinkDelete

Input type: ReleaseAssetLinkDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idReleasesLinkID!ID of the release asset link to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
linkReleaseAssetLinkDeleted release asset link.

Mutation.releaseAssetLinkUpdate

Input type: ReleaseAssetLinkUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
directAssetPathStringRelative path for a direct asset link.
idReleasesLinkID!ID of the release asset link to update.
linkTypeReleaseAssetLinkTypeType of the asset link.
nameStringName of the asset link.
urlStringURL of the asset link.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
linkReleaseAssetLinkAsset link after mutation.

Mutation.releaseCreate

Input type: ReleaseCreateInput

Arguments:

NameTypeDescription
assetsReleaseAssetsInputAssets associated to the release.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription (also known as “release notes”) of the release.
milestones[String!]Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
nameStringName of the release.
projectPathID!Full path of the project the release is associated with.
refStringCommit SHA or branch name to use if creating a new tag.
releasedAtTimeDate and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
tagMessageStringMessage to use if creating a new annotated tag.
tagNameString!Name of the tag to associate with the release.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
releaseReleaseRelease after mutation.

Mutation.releaseDelete

Input type: ReleaseDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project the release is associated with.
tagNameString!Name of the tag associated with the release to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
releaseReleaseDeleted release.

Mutation.releaseUpdate

Input type: ReleaseUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription (release notes) of the release.
milestones[String!]Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
nameStringName of the release.
projectPathID!Full path of the project the release is associated with.
releasedAtTimeRelease date.
tagNameString!Name of the tag associated with the release.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
releaseReleaseRelease after mutation.

Mutation.removeProjectFromSecurityDashboard

Input type: RemoveProjectFromSecurityDashboardInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectID!ID of the project to remove from the Instance Security Dashboard.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.repositionImageDiffNote

Repositions a DiffNote on an image (a Note where the position.positionType is "image").

Input type: RepositionImageDiffNoteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idDiffNoteID!Global ID of the DiffNote to update.
positionUpdateDiffImagePositionInput!Position of the note on a diff.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.restorePagesDeployment

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Restores a Pages deployment that has been scheduled for deletion.

Input type: RestorePagesDeploymentInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPagesDeploymentID!ID of the Pages Deployment.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
pagesDeploymentPagesDeployment!Restored Pages Deployment.

Mutation.resyncSecurityPolicies

  • Introduced in GitLab 18.1.
  • Status: Experiment.

Triggers a resynchronization of security policies linked to the given project or group (full_path).

Input type: ResyncSecurityPoliciesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathString!Full path of the project or group.
relationshipRelationshipTypeRelationship of the policies to resync.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.runnerAssignToProject

  • Introduced in GitLab 18.1.
  • Status: Experiment.

Input type: RunnerAssignToProjectInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project to which the runner will be assigned.
runnerIdCiRunnerID!ID of the runner to assign to the project .

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.runnerBulkPause

  • Introduced in GitLab 17.11.
  • Status: Experiment.

Input type: RunnerBulkPauseInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[CiRunnerID!]!IDs of the runners to pause or unpause.
pausedBoolean!Indicates the runner is not allowed to receive jobs.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
updatedCountIntNumber of records effectively updated. Only present if operation was performed synchronously.
updatedRunners[CiRunner!]Runners after mutation.

Mutation.runnerCacheClear

Input type: RunnerCacheClearInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectIdProjectID!Global ID of the project that will have its runner cache cleared.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.runnerCreate

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Input type: RunnerCreateInput

Arguments:

NameTypeDescription
accessLevelCiRunnerAccessLevelAccess level of the runner.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the runner.
groupIdGroupIDGlobal ID of the group that the runner is created in (valid only for group runner).
lockedBooleanIndicates the runner is locked.
maintenanceNoteStringRunner’s maintenance notes.
maximumTimeoutIntMaximum timeout (in seconds) for jobs processed by the runner.
pausedBooleanIndicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor warning-solidFloatIntroduced in GitLab 17.7. Status: Experiment. Private projects’ “compute cost factor” associated with the runner (GitLab.com only).
projectIdProjectIDGlobal ID of the project that the runner is created in (valid only for project runner).
publicProjectsMinutesCostFactor warning-solidFloatIntroduced in GitLab 17.7. Status: Experiment. Public projects’ “compute cost factor” associated with the runner (GitLab.com only).
runUntaggedBooleanIndicates the runner is able to run untagged jobs.
runnerTypeCiRunnerType!Type of the runner to create.
tagList[String!]Tags associated with the runner.
tokenExpiresAtTimeToken expiration time (ISO 8601 format). Must be between 5 minutes and 15 days in the future, and cannot exceed instance/group/project limits.
tokenRotationDeadline warning-solidTimeIntroduced in GitLab 18.10. Status: Experiment. Deadline for token rotation (ISO 8601 format). Requires tokenExpiresAt. Must be <= tokenExpiresAt. Setting both to the same value disables token rotation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
runnerCiRunnerRunner after mutation.

Mutation.runnerDelete

Input type: RunnerDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiRunnerID!ID of the runner to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.runnerUnassignFromProject

  • Introduced in GitLab 18.1.
  • Status: Experiment.

Input type: RunnerUnassignFromProjectInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project from which the runner will be unassigned.
runnerIdCiRunnerID!ID of the runner to unassign from the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.runnerUpdate

Input type: RunnerUpdateInput

Arguments:

NameTypeDescription
accessLevelCiRunnerAccessLevelAccess level of the runner.
active warning-solidBooleanDeprecated in GitLab 14.8. Renamed. Use paused instead.
associatedProjects[ProjectID!]Projects associated with the runner. Available only for project runners.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the runner.
idCiRunnerID!ID of the runner to update.
lockedBooleanIndicates the runner is locked.
maintenanceNoteStringRunner’s maintenance notes.
maximumTimeoutIntMaximum timeout (in seconds) for jobs processed by the runner.
pausedBooleanIndicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor warning-solidFloatIntroduced in GitLab 17.7. Status: Experiment. Private projects’ “compute cost factor” associated with the runner (GitLab.com only).
publicProjectsMinutesCostFactor warning-solidFloatIntroduced in GitLab 17.7. Status: Experiment. Public projects’ “compute cost factor” associated with the runner (GitLab.com only).
runUntaggedBooleanIndicates the runner is able to run untagged jobs.
tagList[String!]Tags associated with the runner.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
runnerCiRunnerRunner after mutation.

Mutation.runnersExportUsage

Input type: RunnersExportUsageInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fromDateISO8601DateUTC start date of the period to report on. Defaults to the start of last full month.
fullPathIDFilter 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.
maxProjectCountIntMaximum number of projects to return. All other runner usage will be attributed to an <Other projects> entry. Defaults to 1000 projects.
runnerTypeCiRunnerTypeScope of the runners to include in the report.
toDateISO8601DateUTC end date of the period to report on. " \ “Defaults to the end of the month specified by fromDate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.runnersRegistrationTokenReset

  • Deprecated in GitLab 17.7.
  • Underlying feature was deprecated in 15.6 and will be removed in 18.0.

Input type: RunnersRegistrationTokenResetInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIDID of the project or group to reset the token for. Omit if resetting instance runner token.
typeCiRunnerType!Scope of the object to reset the token for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
tokenStringRunner token after mutation.

Mutation.safeDisablePipelineVariables

Input type: SafeDisablePipelineVariablesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the group to disable pipeline variables for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
successBoolean!Indicates whether the migration was successfully enqueued.

Mutation.savedReplyCreate

Input type: SavedReplyCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
nameString!Name of the saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplySavedReplySaved reply after mutation.

Mutation.savedReplyDestroy

Input type: SavedReplyDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idUsersSavedReplyID!Global ID of the user saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplySavedReplySaved reply after mutation.

Mutation.savedReplyUpdate

Input type: SavedReplyUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
idUsersSavedReplyID!Global ID of the user saved reply.
nameString!Name of the saved reply.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedReplySavedReplySaved reply after mutation.

Mutation.scanExecutionPolicyCommit

Commits the policy_yaml content to the assigned security policy project for the given project (full_path).

Input type: ScanExecutionPolicyCommitInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathStringFull path of the project.
nameString!Name of the policy. If the name is null, the name field from policy_yaml is used.
operationModeMutationOperationMode!Changes the operation mode.
policyYamlString!YAML snippet of the policy.
projectPath warning-solidIDDeprecated in GitLab 14.10. Use fullPath.

Fields:

NameTypeDescription
branchStringName of the branch to which the policy changes are committed.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
validationErrors[SecurityPolicyValidationError!]Validation errors encountered during execution of the mutation.

Mutation.secretPermissionDelete

Input type: SecretPermissionDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
principalPrincipalInput!Whose permission to be deleted.
projectPathID!Project permissions for the secret.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.
secretPermissionSecretPermissionDeleted Secret Permission.

Mutation.secretPermissionUpdate

Input type: SecretPermissionUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
expiredAtISO8601DateExpiration date for Secret Permission (optional).
permissions[String!]!Permissions to be provided. [‘create’, ‘update’, ‘read’, ‘delete’].
principalPrincipalInput!User/MemberRole/Role/Group that is provided access.
projectPathID!Project to which the permissions are added.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
reason warning-solidSecretsManagerWriteDenialReasonIntroduced in GitLab 19.2. Status: Experiment. Reason the write was denied due to entitlement; null when not denied for that reason.
secretPermissionSecretPermissionSecret Permission that was created.

Mutation.secretsManagerStartTrial

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Input type: SecretsManagerStartTrialInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Full path of the top-level group to start a Secrets Manager trial for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
entitlementSecretsManagerEntitlementSecrets Manager entitlement state after starting the trial. Null when the post-trial state cannot be resolved; query the group entitlement directly instead.
errors[String!]!Errors encountered during the mutation.

Mutation.securityAttributeCreate

Input type: SecurityAttributeCreateInput

Arguments:

NameTypeDescription
attributes[SecurityAttributeInput!]!Attributes to create.
categoryIdSecurityCategoryID!Global ID of the security category.
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceIdNamespaceID!Global ID of the namespace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityAttributes[SecurityAttribute!]Created security attributes.

Mutation.securityAttributeDestroy

Input type: SecurityAttributeDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSecurityAttributeID!Global ID of the security attribute to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
deletedAttributeGidSecurityAttributeIDGlobal ID of the destroyed security attribute.
errors[String!]!Errors encountered during the mutation.

Mutation.securityAttributeProjectUpdate

Input type: SecurityAttributeProjectUpdateInput

Arguments:

NameTypeDescription
addAttributeIds[SecurityAttributeID!]Global IDs of the security attributes to add to the project.
clientMutationIdStringA unique identifier for the client performing the mutation.
projectIdProjectID!Global ID of the project.
removeAttributeIds[SecurityAttributeID!]Global IDs of the security attributes to remove from the project.

Fields:

NameTypeDescription
addedCountIntNumber of attributes added.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectUpdated project.
removedCountIntNumber of attributes removed.

Mutation.securityAttributeUpdate

Input type: SecurityAttributeUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
colorColorColor of the security attribute.
descriptionStringDescription of the security attribute.
idSecurityAttributeID!Global ID of the security attribute.
nameStringName of the security attribute.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityAttributeSecurityAttributeUpdated security attribute.

Mutation.securityCategoryCreate

Input type: SecurityCategoryCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the security category.
multipleSelectionBooleanWhether multiple attributes can be selected.
nameString!Name of the security category.
namespaceIdNamespaceID!Global ID of the category namespace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityCategorySecurityCategoryCreated security category.

Mutation.securityCategoryDestroy

Input type: SecurityCategoryDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSecurityCategoryID!Global ID of the security category to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
deletedAttributesGid[SecurityAttributeID!]Global IDs of the deleted security attributes.
deletedCategoryGidSecurityCategoryIDGlobal ID of the deleted security category.
errors[String!]!Errors encountered during the mutation.

Mutation.securityCategoryUpdate

Input type: SecurityCategoryUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the security category.
idSecurityCategoryID!Global ID of the security category.
nameStringName of the security category.
namespaceIdNamespaceID!Global ID of the category namespace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityCategorySecurityCategoryUpdated security category.

Mutation.securityFindingCreateIssue

Input type: SecurityFindingCreateIssueInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectProjectID!ID of the project to attach the issue to.
uuidString!UUID of the security finding to be used to create an issue.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.

Mutation.securityFindingCreateMergeRequest

Input type: SecurityFindingCreateMergeRequestInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
uuidString!UUID of the security finding to be used to create a merge request.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge Request created after mutation.

Mutation.securityFindingCreateVulnerability

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Input type: SecurityFindingCreateVulnerabilityInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
uuidString!UUID of the security finding to be used to create a vulnerability.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability created after mutation.

Mutation.securityFindingDismiss

Input type: SecurityFindingDismissInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why finding should be dismissed.
dismissalReasonVulnerabilityDismissalReasonReason why finding should be dismissed.
uuidString!UUID of the finding to be dismissed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityFindingPipelineSecurityReportFindingDismissed finding.
uuidStringUUID of dismissed finding.

Mutation.securityFindingExternalIssueLinkCreate

Input type: SecurityFindingExternalIssueLinkCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
externalTrackerVulnerabilityExternalIssueLinkExternalTracker!External tracker type of the external issue link.
linkTypeVulnerabilityExternalIssueLinkType!Type of the external issue link.
projectProjectID!ID of the project to attach the issue to.
uuidString!UUID of the security finding to be used to create an issue.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalIssueLinkVulnerabilityExternalIssueLinkCreated external issue link.

Mutation.securityFindingJiraIssueFormUrlCreate

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Input type: SecurityFindingJiraIssueFormUrlCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectProjectID!ID of the project to attach the issue to.
uuidString!UUID of the security finding to be used to create an issue.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
jiraIssueFormUrlStringURL to Jira issue creation form with pre-filled vulnerability data.

Mutation.securityFindingRevertToDetected

Input type: SecurityFindingRevertToDetectedInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment that explains why finding was reverted to detected status.
uuidString!UUID of the finding to be dismissed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityFindingPipelineSecurityReportFindingFinding reverted to detected.

Mutation.securityFindingSeverityOverride

Input type: SecurityFindingSeverityOverrideInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
severityVulnerabilitySeverity!New severity value for the finding.
uuidString!UUID of the finding to modify.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
securityFindingPipelineSecurityReportFindingFinding of which the severity was modified.

Mutation.securityPolicyProjectAssign

Assigns the specified project(security_policy_project_id) as security policy project for the given project(full_path). If the project already has a security policy project, this reassigns the project’s security policy project with the given security_policy_project_id.

Input type: SecurityPolicyProjectAssignInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathStringFull path of the project or group.
projectPath warning-solidIDDeprecated in GitLab 14.10. Use fullPath.
securityPolicyProjectIdProjectID!ID of the security policy project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.securityPolicyProjectCreate

Creates and assigns a security policy project for the given project or group (full_path).

Input type: SecurityPolicyProjectCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathStringFull path of the project or group.
projectPath warning-solidIDDeprecated in GitLab 14.10. Use fullPath.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectSecurity Policy Project that was created.

Mutation.securityPolicyProjectCreateAsync

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Creates and assigns a security policy project for the given project or group (full_path) async.

Input type: SecurityPolicyProjectCreateAsyncInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathString!Full path of the project or group.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.securityPolicyProjectUnassign

Unassigns the security policy project for the given project (full_path).

Input type: SecurityPolicyProjectUnassignInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathStringFull path of the project or group.
projectPath warning-solidIDDeprecated in GitLab 14.10. Use fullPath.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.securityRefsTrack

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: SecurityRefsTrackInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.
refs[SecurityRefInput!]!Array of refs to be tracked.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the operation.
trackedRefs[SecurityTrackedRef!]Refs that were successfully tracked.

Mutation.securityRefsUntrack

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: SecurityRefsUntrackInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
refIds[SecurityProjectTrackedContextID!]!Global IDs of the tracked refs to stop tracking.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
untrackedRefIds[ID!]Global IDs of refs that were successfully untracked.

Mutation.securityScanProfileAttach

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: SecurityScanProfileAttachInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[GroupID!]Group IDs to attach the profile to.
projectIds[ProjectID!]Project IDs to attach the profile to.
securityScanProfileIdSecurityScanProfileID!Security scan profile ID to attach.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.securityScanProfileCreate

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Input type: SecurityScanProfileCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionString!Description of the scan profile.
nameString!Name of the scan profile.
namespaceIdNamespaceID!Global ID of the top level namespace to create the scan profile for.
scanTypeSecurityScanProfileType!Type of the scan profile.
stripDefaultsBooleanWhen true, trigger configuration values equal to the defaults are removed before storage so only overrides are persisted. When false, the configuration is stored as provided, ignoring defaults.
triggers[SecurityScanProfileTriggerInput!]!Triggers with optional configuration for the scan profile. At least one is required.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
scanProfileScanProfileTypeCreated scan profile.

Mutation.securityScanProfileDelete

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Input type: SecurityScanProfileDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSecurityScanProfileID!Global ID of the scan profile to delete.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
deletedScanProfileIdSecurityScanProfileIDGlobal ID of the deleted scan profile.
errors[String!]!Errors encountered during the mutation.

Mutation.securityScanProfileDetach

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: SecurityScanProfileDetachInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[GroupID!]Group IDs to detach the profile from.
projectIds[ProjectID!]Project IDs to detach the profile from.
securityScanProfileIdSecurityScanProfileID!Security scan profile ID to detach.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.securityScanProfileUpdate

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Input type: SecurityScanProfileUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the scan profile.
idSecurityScanProfileID!Global ID of the scan profile to update.
nameStringName of the scan profile.
stripDefaultsBooleanWhen true, trigger configuration values equal to the defaults are removed before storage so only overrides are persisted. When false, the configuration is stored as provided, ignoring defaults.
triggers[SecurityScanProfileTriggerInput!]Complete set of triggers with optional configuration for the scan profile. When provided, triggers omitted from the list are removed, and a trigger sent without a configuration has its existing configuration removed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
scanProfileScanProfileTypeUpdated scan profile.

Mutation.securityTrainingUpdate

Input type: SecurityTrainingUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
isEnabledBoolean!Sets the training provider as enabled for the project.
isPrimaryBooleanSets the training provider as primary for the project.
projectPathID!Full path of the project.
providerIdSecurityTrainingProviderID!ID of the provider.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
trainingProjectSecurityTrainingRepresents the training entity subject to mutation.

Mutation.setContainerScanningForRegistry

Enable/disable container scanning for registry for the given project.

Input type: SetContainerScanningForRegistryInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for container scanning for registry feature.
namespacePathID!Full path of the namespace (project).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerScanningForRegistryEnabledBooleanWhether the feature is enabled.
errors[String!]!Errors encountered during the mutation.

Mutation.setCvsForContainerScanning

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Enable or disable continuous vulnerability scanning for container scanning for the given project.

Input type: SetCvsForContainerScanningInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for CVS for container scanning.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
cvsForContainerScanningEnabledBooleanWhether CVS for container scanning is enabled.
errors[String!]!Errors encountered during the mutation.

Mutation.setCvsForDependencyScanning

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Enable or disable continuous vulnerability scanning for dependency scanning for the given project.

Input type: SetCvsForDependencyScanningInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for CVS for dependency scanning.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
cvsForDependencyScanningEnabledBooleanWhether CVS for dependency scanning is enabled.
errors[String!]!Errors encountered during the mutation.

Mutation.setGroupCustomAttribute

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Creates or updates a custom attribute on a group. Only available to admins.

Input type: SetGroupCustomAttributeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Full path of the group.
keyString!Key of the custom attribute.
valueString!Value of the custom attribute.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customAttributeCustomAttributeCustom attribute after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.setGroupSecretPushProtection

Enable or disable secret push protection for a group.

Input type: SetGroupSecretPushProtectionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Full path of the group.
projectsToExclude[Int!]IDs of projects to exclude from the feature.
secretPushProtectionEnabledBoolean!Whether to enable the feature.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.setGroupValidityChecks

Enable or disable Validity Checks for a group.

Input type: SetGroupValidityChecksInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Full path of the group.
projectsToExclude[Int!]IDs of projects to exclude from validity checks configuration.
validityChecksEnabledBoolean!Whether to enable validity checks for all projects in the group.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
validityChecksEnabledBoolean!Indicates whether validity checks have been enabled for the group.

Mutation.setLicenseConfigurationSource

Set the license information source for a given project.

Input type: SetLicenseConfigurationSourceInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.
sourceSecurityPreferredLicenseSourceConfiguration!Preferred source of license information for dependencies.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
licenseConfigurationSourceSecurityPreferredLicenseSourceConfigurationPreferred source of license information for dependencies.

Mutation.setLicenseScanningForCyclonedx

Enable/disable license scanning for CycloneDX SBOM files for the given project.

Input type: SetLicenseScanningForCyclonedxInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for license scanning for CycloneDX files.
projectPathID!Full path of the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
licenseScanningForCyclonedxEnabledBooleanWhether license scanning for CycloneDX files is enabled.

Mutation.setPagesForceHttps

Input type: SetPagesForceHttpsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Path of the project to set the pages force HTTPS.
valueBoolean!Indicates user wants to enforce HTTPS on their pages.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectProject that was updated.

Mutation.setPagesUseUniqueDomain

Input type: SetPagesUseUniqueDomainInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Path of the project to set the pages to use unique domains.
valueBoolean!Indicates user wants to use unique subdomains for their pages.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projectProjectProject that was updated.

Mutation.setPreReceiveSecretDetection

Enable/disable secret push protection for the given project.

Input type: SetPreReceiveSecretDetectionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for secret push protection feature.
namespacePathID!Full path of the namespace (project).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
preReceiveSecretDetectionEnabledBooleanWhether the feature is enabled.
secretPushProtectionEnabledBooleanWhether the feature is enabled.

Mutation.setSecretPushProtection

Enable/disable secret push protection for the given project.

Input type: SetSecretPushProtectionInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for secret push protection feature.
namespacePathID!Full path of the namespace (project).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
preReceiveSecretDetectionEnabledBooleanWhether the feature is enabled.
secretPushProtectionEnabledBooleanWhether the feature is enabled.

Mutation.setValidityChecks

Enable/disable secret detection validity checks for the given project.

Input type: SetValidityChecksInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for validity checks feature.
namespacePathID!Full path of the namespace (project).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
validityChecksEnabledBooleanWhether the feature is enabled.

Mutation.starProject

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: StarProjectInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectIdProjectID!Full path of the project to star or unstar.
starredBoolean!Indicates whether to star or unstar the project.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
countString!Number of stars for the project.
errors[String!]!Errors encountered during the mutation.

Mutation.startVulnerabilityWorkflow

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Creates and starts a vulnerability workflow execution.

Input type: StartVulnerabilityWorkflowInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
findingUuids[String!]Finding UUIDs to process, up to 1000. If omitted, all project findings are processed.
projectIdProjectID!Global ID of the project.
severities[VulnerabilitySeverity!]Severities to process. If omitted, all severities are processed.
workflowVulnerabilityDuoWorkflow!Workflow to execute.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorReasonVulnerabilityWorkflowErrorReasonMachine-readable reason for the mutation error.
errors[String!]!Errors encountered during the mutation.
executionVulnerabilityWorkflowExecutionWorkflow execution.

Mutation.tagCreate

Input type: TagCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
messageStringTagging message.
nameString!Name of the tag.
projectPathID!Project full path the branch is associated with.
refString!Tag name or commit SHA to create tag from.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
tagTagTag after mutation.

Mutation.tagDelete

Input type: TagDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the tag.
projectPathID!Project full path the branch is associated with.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
tagTagTag after mutation.

Mutation.terraformStateDelete

Input type: TerraformStateDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTerraformStateID!Global ID of the Terraform state.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.terraformStateLock

Input type: TerraformStateLockInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTerraformStateID!Global ID of the Terraform state.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.terraformStateUnlock

Input type: TerraformStateUnlockInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTerraformStateID!Global ID of the Terraform state.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.timelineEventCreate

  • Introduced in GitLab 15.6.
  • Status: Experiment.

Input type: TimelineEventCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
incidentIdIssueID!Incident ID of the timeline event.
noteString!Text note of the timeline event.
occurredAtTime!Timestamp of when the event occurred.
timelineEventTagNames[String!]Tags for the incident timeline event.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
timelineEventTimelineEventTypeTimeline event.

Mutation.timelineEventDestroy

Input type: TimelineEventDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementTimelineEventID!Timeline event ID to remove.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
timelineEventTimelineEventTypeTimeline event.

Mutation.timelineEventPromoteFromNote

Input type: TimelineEventPromoteFromNoteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
noteIdNoteID!Note ID from which the timeline event promoted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
timelineEventTimelineEventTypeTimeline event.

Mutation.timelineEventTagCreate

Input type: TimelineEventTagCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the tag.
projectPathID!Project to create the timeline event tag in.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
timelineEventTagTimelineEventTagTypeTimeline event tag.

Mutation.timelineEventUpdate

Input type: TimelineEventUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementTimelineEventID!ID of the timeline event to update.
noteStringText note of the timeline event.
occurredAtTimeTimestamp when the event occurred.
timelineEventTagNames[String!]Tags for the incident timeline event.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
timelineEventTimelineEventTypeTimeline event.

Mutation.timelogCreate

Input type: TimelogCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
issuableIdIssuableID!Global ID of the issuable (Issue, WorkItem or MergeRequest).
spentAtTimeTimestamp of when the time was spent. If empty, defaults to current time.
summaryString!Summary of time spent.
timeSpentString!Amount of time spent.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
timelogTimelogTimelog.

Mutation.timelogDelete

Input type: TimelogDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTimelogID!Global ID of the timelog.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
timelogTimelogTimelog.

Mutation.todoCreate

Input type: TodoCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
targetIdTodoableID!Global ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todoTodoTo-do item created.

Mutation.todoDeleteAllDone

  • Introduced in GitLab 17.11.
  • Status: Experiment.

Input type: TodoDeleteAllDoneInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
updatedBeforeTimeTo-do items marked as done before the timestamp will be deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.todoDeleteMany

  • Introduced in GitLab 17.11.
  • Status: Experiment.

Input type: TodoDeleteManyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.todoMarkDone

Input type: TodoMarkDoneInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTodoID!Global ID of the to-do item to mark as done.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todoTodo!Requested to-do item.

Mutation.todoResolveMany

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: TodoResolveManyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Resolved to-do items.

Mutation.todoRestore

Input type: TodoRestoreInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTodoID!Global ID of the to-do item to restore.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todoTodo!Requested to-do item.

Mutation.todoRestoreMany

Input type: TodoRestoreManyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Restored to-do items.

Mutation.todoSnooze

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: TodoSnoozeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTodoID!Global ID of the to-do item to be snoozed.
snoozeUntilTime!Time until which the todo should be snoozed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todoTodo!Requested to-do item.

Mutation.todoSnoozeMany

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: TodoSnoozeManyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).
snoozeUntilTime!Time until which the todos should be snoozed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Snoozed to-do items.

Mutation.todoUnSnooze

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: TodoUnSnoozeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTodoID!Global ID of the to-do item to be snoozed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todoTodo!Requested to-do item.

Mutation.todoUnsnoozeMany

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: TodoUnsnoozeManyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Unsnoozed to-do items.

Mutation.todosMarkAllDone

Input type: TodosMarkAllDoneInput

Arguments:

NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupId[ID!]ID of a group.
projectId[ID!]ID of a project.
targetIdTodoableIDGlobal ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported. If argument is omitted, all pending to-do items of the current user are marked as done.
type[TodoTargetEnum!]Type of the todo.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Updated to-do items.

Mutation.unlinkProjectComplianceViolationIssue

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Input type: UnlinkProjectComplianceViolationIssueInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
issueIidString!IID of the issue to be unlinked.
projectPathID!Full path of the project the issue belongs to.
violationIdComplianceManagementProjectsComplianceViolationID!Global ID of the project compliance violation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
violationProjectComplianceViolationUpdated project compliance violation.

Mutation.updateAiToolRule

  • Introduced in GitLab 19.1.
  • Status: Experiment.

Updates the permission settings for an AI tool rule.

Input type: UpdateAiToolRuleInput

Arguments:

NameTypeDescription
backgroundAccess warning-solidAiBackgroundToolPermissionIntroduced in GitLab 19.3. Status: Experiment. Permission mode for the background-flow surface.
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the root namespace to update the tool rule for.
localAccessAiToolPermissionPermission mode for local or IDE surface.
projectPathIDFull path of the project to update the tool rule for. When provided, creates a project-level rule that can only be stricter than the namespace rule.
toolIdString!Tool name string identifying the tool to update. For example, “create_issue”.
webAccessAiToolPermissionPermission mode for web surface.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
toolRuleAiToolRuleUpdated tool rule after mutation.

Mutation.updateAlertStatus

Input type: UpdateAlertStatusInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.
statusAlertManagementStatus!Status to set the alert.

Fields:

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

Mutation.updateBoard

Input type: UpdateBoardInput

Arguments:

NameTypeDescription
assigneeIdUserIDID of user to be assigned to the board.
clientMutationIdStringA unique identifier for the client performing the mutation.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
idBoardID!Board global ID.
iterationCadenceIdIterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationIdIterationIDID 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.
milestoneIdMilestoneIDID of milestone to be assigned to the board.
nameStringBoard name.
weightIntWeight value to be assigned to the board.

Fields:

NameTypeDescription
boardBoardBoard after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateBoardEpicUserPreferences

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: UpdateBoardEpicUserPreferencesInput

Arguments:

NameTypeDescription
boardIdBoardID!Board global ID.
clientMutationIdStringA unique identifier for the client performing the mutation.
collapsedBoolean!Whether the epic should be collapsed in the board.
epicIdEpicID!ID of an epic to set preferences for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicUserPreferencesBoardEpicUserPreferencesUser preferences for the epic in the board after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateBoardList

Input type: UpdateBoardListInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
collapsedBooleanIndicates if the list is collapsed for the user.
listIdListID!Global ID of the list.
positionIntPosition of list within the board.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
listBoardListMutated list.

Mutation.updateComplianceFramework

Input type: UpdateComplianceFrameworkInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementFrameworkID!Global ID of the compliance framework to update.
paramsComplianceFrameworkInput!Parameters to update the compliance framework with.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceFrameworkComplianceFrameworkCompliance framework after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateComplianceRequirement

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Input type: UpdateComplianceRequirementInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
controls[ComplianceRequirementsControlInput!]Controls to add or update to the compliance requirement.
idComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement to update.
paramsComplianceRequirementInput!Parameters to update the compliance requirement with.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
requirementComplianceRequirementCompliance requirement after updation.

Mutation.updateComplianceRequirementsControl

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: UpdateComplianceRequirementsControlInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementComplianceFrameworkComplianceRequirementsControlID!Global ID of the compliance requirement control to update.
paramsComplianceRequirementsControlInput!Parameters to update the compliance requirement control with.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
requirementsControlComplianceRequirementsControlCompliance requirement control after updation.

Mutation.updateContainerExpirationPolicy

Input type: UpdateContainerExpirationPolicyInput

Arguments:

NameTypeDescription
cadenceContainerExpirationPolicyCadenceEnumSchedule of the container expiration policy.
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanIndicates whether the container expiration policy is enabled.
keepNContainerExpirationPolicyKeepEnumNumber of tags to retain.
nameRegexUntrustedRegexpTags with names matching the regex pattern will expire.
nameRegexKeepUntrustedRegexpTags with names matching the regex pattern will be preserved.
olderThanContainerExpirationPolicyOlderThanEnumTags older than the given age will expire.
projectPathID!Project path where the container expiration policy is located.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerExpirationPolicy warning-solidContainerExpirationPolicyDeprecated in GitLab 17.5. Use container_tags_expiration_policy.
containerTagsExpirationPolicyContainerTagsExpirationPolicyContainer tags expiration policy after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateContainerProtectionRepositoryRule

Updates a container repository protection rule that controls who can modify container images based on user roles.

Input type: UpdateContainerProtectionRepositoryRuleInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRegistryProtectionRuleID!Global ID of the container repository protection rule to be updated.
minimumAccessLevelForDelete warning-solidContainerProtectionRepositoryRuleAccessLevelIntroduced in GitLab 17.11. Status: Experiment. 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. Valid only when feature flag container_registry_protected_containers_delete is enabled.
minimumAccessLevelForPushContainerProtectionRepositoryRuleAccessLevelMinimum 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.
repositoryPathPatternStringContainer 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:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionRepositoryRuleContainerProtectionRepositoryRuleContainer repository protection rule after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateContainerProtectionTagRule

  • Introduced in GitLab 17.8.
  • Status: Experiment.

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

Input type: UpdateContainerProtectionTagRuleInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRegistryProtectionTagRuleID!Global ID of the tag protection rule to update.
minimumAccessLevelForDeleteContainerProtectionTagRuleAccessLevelMinimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags.
minimumAccessLevelForPushContainerProtectionTagRuleAccessLevelMinimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags.
tagNamePatternStringThe pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionTagRuleContainerProtectionTagRuleProtection rule for container image tags after creation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateCustomDashboard

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Updates a custom dashboard.

Input type: UpdateCustomDashboardInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
configCustomDashboardConfigInputDashboard layout/config.
descriptionStringDashboard description.
idAnalyticsCustomDashboardsDashboardID!Global ID of the dashboard to update.
nameStringDashboard name.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dashboardCustomDashboardUpdated dashboard.
errors[String!]!Errors encountered during update.

Mutation.updateDependencyProxyImageTtlGroupPolicy

These settings can be adjusted only by the group Owner.

Input type: UpdateDependencyProxyImageTtlGroupPolicyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanIndicates whether the policy is enabled or disabled.
groupPathID!Group path for the group dependency proxy image TTL policy.
ttlIntNumber of days to retain a cached image file.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dependencyProxyImageTtlPolicyDependencyProxyImageTtlGroupPolicyGroup image TTL policy after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateDependencyProxyPackagesSettings

Updates or creates dependency proxy for packages settings. Requires the packages and dependency proxy to be enabled in the config. Requires the packages feature to be enabled at the project level.

Input type: UpdateDependencyProxyPackagesSettingsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanIndicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryPasswordStringPassword for the external Maven packages registry. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time.
mavenExternalRegistryUrlStringURL for the external Maven packages registry.
mavenExternalRegistryUsernameStringUsername for the external Maven packages registry.
projectPathID!Project path for the dependency proxy for packages settings.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dependencyProxyPackagesSettingDependencyProxyPackagesSettingDependency proxy for packages settings after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateDependencyProxySettings

These settings can be adjusted only by the group Owner.

Input type: UpdateDependencyProxySettingsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanIndicates whether the policy is enabled or disabled.
groupPathID!Group path for the group dependency proxy.
identityStringIdentity credential used to authenticate with Docker Hub when pulling images. Can be a username (for password or personal access token (PAT)) or organization name (for organization access token (OAT)).
secretStringSecret credential used to authenticate with Docker Hub when pulling images. Can be a password, personal access token (PAT), or organization access token (OAT).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dependencyProxySettingDependencyProxySettingGroup dependency proxy settings after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateDuoWorkflowAgentPrivileges

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Input type: UpdateDuoWorkflowAgentPrivilegesInput

Arguments:

NameTypeDescription
agentPrivileges[Int!]Replaces the set of actions the agent is allowed to perform.
clientMutationIdStringA unique identifier for the client performing the mutation.
preApprovedAgentPrivileges[Int!]Replaces the set of actions the agent can perform without asking for approval.
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during update.
workflowDuoWorkflowUpdated workflow.

Mutation.updateDuoWorkflowToolCallApprovals

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Input type: UpdateDuoWorkflowToolCallApprovalsInput

Arguments:

NameTypeDescription
approvalSource warning-solidDuoWorkflowToolCallApprovalSourceIntroduced in GitLab 19.3. Status: Experiment. Source of the approval decision, for audit purposes.
clientMutationIdStringA unique identifier for the client performing the mutation.
patternStringGlob pattern to approve for matching tool call arguments.
toolCallArgsJSONArguments for the tool call.
toolNameString!Name of the tool to approve.
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during update.
workflowDuoWorkflowUpdated workflow with new tool approvals.

Mutation.updateDuoWorkflowWebSearch

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Input type: UpdateDuoWorkflowWebSearchInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
webSearchEnabledBoolean!Whether web search should be enabled for the session.
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during update.
workflowDuoWorkflowUpdated workflow.

Mutation.updateEpic

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type. For more information, see [migration guide](https: //docs.gitlab.com/api/graphql/epic_work_items_api_migration_guide/).

Input type: UpdateEpicInput

Arguments:

NameTypeDescription
addLabelIds[ID!]IDs of labels to be added to the epic.
addLabels[String!]Array of labels to be added to the epic.
clientMutationIdStringA unique identifier for the client performing the mutation.
colorColorColor of the epic.
confidentialBooleanIndicates if the epic is confidential.
descriptionStringDescription of the epic.
dueDateFixedStringEnd date of the epic.
dueDateIsFixedBooleanIndicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPathID!Group the epic to mutate is in.
iidID!IID of the epic to mutate.
removeLabelIds[ID!]IDs of labels to be removed from the epic.
removeLabels[String!]Array of labels to be removed from the epic.
startDateFixedStringStart date of the epic.
startDateIsFixedBooleanIndicates start date should be sourced from start_date_fixed field not the issue milestones.
stateEventEpicStateEventState event for the epic.
titleStringTitle of the epic.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.updateEpicBoardList

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: UpdateEpicBoardListInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
collapsedBooleanIndicates if the list is collapsed for the user.
listIdBoardsEpicListID!Global ID of the epic list.
positionIntPosition of list within the board.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
listEpicListMutated epic list.

Mutation.updateImageDiffNote

Updates a DiffNote on an image (a Note where the position.positionType is "image"). If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.

Input type: UpdateImageDiffNoteInput

Arguments:

NameTypeDescription
bodyStringContent of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
idNoteID!Global ID of the note to update.
positionUpdateDiffImagePositionInputPosition of the note on a diff.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.updateIssue

Input type: UpdateIssueInput

Arguments:

NameTypeDescription
addLabelIds[ID!]IDs of labels to be added to the issue.
clientMutationIdStringA unique identifier for the client performing the mutation.
confidentialBooleanIndicates the issue is confidential.
descriptionStringDescription of the issue.
dueDateISO8601DateDue date of the issue.
epicId warning-solidEpicIDDeprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
healthStatusHealthStatusDesired health status.
iidString!IID of the issue to mutate.
labelIds[ID!]IDs of labels to be set. Replaces existing issue labels.
lockedBooleanIndicates discussion is locked on the issue.
milestoneIdIDID of the milestone to assign to the issue. Accepts either a global ID, for example "gid://gitlab/Milestone/42", or a numeric ID, for example "42". On update milestone will be removed if set to null.
projectPathID!Project the issue to mutate is in.
removeLabelIds[ID!]IDs of labels to be removed from the issue.
stateEventIssueStateEventClose or reopen an issue.
timeEstimateStringEstimated time to complete the issue. Use null or 0 to remove the current estimate.
titleStringTitle of the issue.
typeIssueTypeType of the issue.
weightIntWeight of the issue.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

Mutation.updateIteration

Input type: UpdateIterationInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathID!Group of the iteration.
idID!Global ID of the iteration.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
iterationIterationUpdated iteration.

Mutation.updateNamespacePackageSettings

These settings can be adjusted only by the group Owner.

Input type: UpdateNamespacePackageSettingsInput

Arguments:

NameTypeDescription
auditEventsEnabledBooleanIndicates whether audit events are created when publishing or deleting a package in the namespace (Premium and Ultimate only).
clientMutationIdStringA unique identifier for the client performing the mutation.
genericDuplicateExceptionRegexUntrustedRegexpWhen generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
genericDuplicatesAllowedBooleanIndicates whether duplicate generic packages are allowed for the namespace.
lockMavenPackageRequestsForwardingBooleanIndicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwardingBooleanIndicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwardingBooleanIndicates whether PyPI package forwarding is locked for all descendent namespaces.
lockRubygemsPackageRequestsForwardingBooleanIndicates whether RubyGems package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegexUntrustedRegexpWhen maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
mavenDuplicatesAllowedBooleanIndicates whether duplicate Maven packages are allowed for the namespace.
mavenPackageRequestsForwardingBooleanIndicates whether Maven package forwarding is allowed for the namespace.
namespacePathID!Namespace path where the namespace package setting is located.
npmPackageRequestsForwardingBooleanIndicates whether npm package forwarding is allowed for the namespace.
nugetDuplicateExceptionRegexUntrustedRegexpWhen nuget_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
nugetDuplicatesAllowedBooleanIndicates whether duplicate NuGet packages are allowed for the namespace.
nugetSymbolServerEnabledBooleanIndicates whether the NuGet symbol server is enabled for the namespace.
pypiPackageRequestsForwardingBooleanIndicates whether PyPI package forwarding is allowed for the namespace.
rubygemsPackageRequestsForwardingBooleanIndicates whether RubyGems package forwarding is allowed for the namespace.
terraformModuleDuplicateExceptionRegexUntrustedRegexpWhen terraform_module_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
terraformModuleDuplicatesAllowedBooleanIndicates whether duplicate Terraform packages are allowed for the namespace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
packageSettingsPackageSettingsNamespace package setting after mutation.

Mutation.updateNote

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

Input type: UpdateNoteInput

Arguments:

NameTypeDescription
bodyStringContent of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
idNoteID!Global ID of the note to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.updatePackagesCleanupPolicy

Input type: UpdatePackagesCleanupPolicyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
keepNDuplicatedPackageFilesPackagesCleanupKeepDuplicatedPackageFilesEnumNumber of duplicated package files to retain.
projectPathID!Project path where the packages cleanup policy is located.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
packagesCleanupPolicyPackagesCleanupPolicyPackages cleanup policy after mutation.

Mutation.updatePackagesProtectionRule

Updates a package protection rule to restrict access to project packages. You can prevent users without certain permissions from altering packages.

Input type: UpdatePackagesProtectionRuleInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPackagesProtectionRuleID!Global ID of the package protection rule to be updated.
minimumAccessLevelForDelete warning-solidPackagesProtectionRuleAccessLevelForDeleteIntroduced in GitLab 17.10. Status: Experiment. Minimum GitLab access required to delete packages from the package registry. Valid values include OWNER or ADMIN. If the value is nil, the default minimum access level is MAINTAINER. Available only when feature flag packages_protected_packages_delete is enabled.
minimumAccessLevelForPushPackagesProtectionRuleAccessLevelMinimum 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.
packageNamePatternStringPackage name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageTypePackagesProtectionRulePackageTypePackage type protected by the protection rule. For example, NPM, PYPI.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule after mutation.

Mutation.updateProjectComplianceViolation

  • Introduced in GitLab 18.2.
  • Status: Experiment.

Input type: UpdateProjectComplianceViolationInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementProjectsComplianceViolationID!Global ID of the project compliance violation to update.
statusComplianceViolationStatus!New status for the project compliance violation.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceViolationProjectComplianceViolationCompliance violation after status update.
errors[String!]!Errors encountered during the mutation.

Mutation.updateRequirement

Input type: UpdateRequirementInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the requirement.
iid warning-solidStringDeprecated in GitLab 15.8. Use work_item_iid instead.
lastTestReportStateTestReportStateCreates a test report for the requirement with the given state.
projectPathID!Full project path the requirement is associated with.
stateRequirementStateState of the requirement.
titleStringTitle of the requirement.
workItemIidStringIID of the requirement work item to update.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
requirementRequirementRequirement after mutation.

Mutation.updateSnippet

Input type: UpdateSnippetInput

Arguments:

NameTypeDescription
blobActions[SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the snippet.
idSnippetID!Global ID of the snippet to update.
titleStringTitle of the snippet.
visibilityLevelVisibilityLevelsEnumVisibility level of the snippet.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
snippetSnippetSnippet after mutation.

Mutation.updateTerraformStateProtectionRule

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Updates a protection rule for a Terraform state backend.

Input type: UpdateTerraformStateProtectionRuleInput

Arguments:

NameTypeDescription
allowedFrom warning-solidTerraformStateProtectionRuleAllowedFromIntroduced in GitLab 18.11. Status: Experiment. Restriction on the source of write requests. ANYWHERE allows all sources, CI_ONLY requires a CI job token, CI_ON_PROTECTED_BRANCH_ONLY requires a CI job on a protected branch.
clientMutationIdStringA unique identifier for the client performing the mutation.
idTerraformStateProtectionRuleID!Global ID of the Terraform state protection rule to update.
minimumAccessLevelForWrite warning-solidTerraformStateProtectionRuleAccessLevelIntroduced in GitLab 18.11. Status: Experiment. Minimum GitLab access level required to perform write operations on the Terraform state. Valid values include DEVELOPER, MAINTAINER, OWNER, or ADMIN.
stateName warning-solidStringIntroduced in GitLab 18.11. Status: Experiment. Terraform state name protected by the rule.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
terraformStateProtectionRule warning-solidTerraformStateProtectionRuleIntroduced in GitLab 18.11. Status: Experiment. Terraform state protection rule after mutation.

Mutation.updateVirtualRegistriesSetting

  • Introduced in GitLab 18.5.
  • Status: Experiment.

Updates or creates virtual registries settings for a root group.

Input type: UpdateVirtualRegistriesSettingInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanEnable or disable the virtual registries.
fullPathID!Group path for the group virtual registries.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
virtualRegistriesSettingVirtualRegistriesSettingVirtual registries settings after mutation.

Mutation.uploadCreate

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Creates an upload (uploads a file to a project or group for use in Markdown).

Input type: UploadCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fileUpload!File to upload.
groupPathIDFull path of the group with which the resource is associated.
projectPathIDFull path of the project with which the resource is associated.

Fields:

NameTypeDescription
altStringAlt text for the uploaded file. Usually the name of the file.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
fullPathStringFull path to the file.
markdownStringMarkdown-formatted link to the file.
uploadFileUploadUploaded file.
urlStringURL to access the file.

Mutation.uploadDelete

Deletes an upload.

Input type: UploadDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
filenameString!Upload filename.
groupPathIDFull path of the group with which the resource is associated.
projectPathIDFull path of the project with which the resource is associated.
secretString!Secret part of upload path.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
uploadFileUploadDeleted upload.

Mutation.upsertFlatUserCap

Update the flat per-user budget cap for a subscription.

Input type: UpsertFlatUserCapInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
flatUserCapFloat!Default per-user budget cap applied to all users.
flatUserCapEnabledBoolean!Whether the flat per-user budget cap is enabled.
namespacePathStringPath of the top-level group namespace. Omit for self-managed instance scope.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
flatUserCapFloatUpdated flat per-user budget cap.
flatUserCapEnabledBooleanWhether the flat per-user budget cap is enabled.

Mutation.upsertUserBudgetCapOverrides

Bulk upsert per-user budget cap overrides.

Input type: UpsertUserBudgetCapOverridesInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathStringPath of the top-level group namespace. Omit for self-managed instance scope.
overrides[BudgetCapUserOverrideInput!]!List of per-user budget cap overrides to upsert.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userOverrides[GitlabSubscriptionBudgetCapUserOverride!]Updated user budget cap overrides.

Mutation.userAchievementPrioritiesUpdate

Input type: UserAchievementPrioritiesUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
userAchievementIds[AchievementsUserAchievementID!]!Global IDs of the user achievements being prioritized, ordered from highest to lowest priority.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userAchievements[UserAchievement!]!Updated user achievements.

Mutation.userAchievementsDelete

Input type: UserAchievementsDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being deleted.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userAchievementUserAchievementDeleted user achievement.

Mutation.userAchievementsUpdate

Input type: UserAchievementsUpdateInput

Arguments:

NameTypeDescription
awardMessageStringMessage to associate with the awarded achievement.
clientMutationIdStringA unique identifier for the client performing the mutation.
showOnProfileBooleanIndicates whether or not the user achievement is visible on the profile.
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being updated.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userAchievementUserAchievementAchievement award.

Mutation.userAddOnAssignmentBulkCreate

Input type: UserAddOnAssignmentBulkCreateInput

Arguments:

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be assigned to.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIds[UserID!]!Global IDs of user to be assigned.

Fields:

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.userAddOnAssignmentBulkRemove

Input type: UserAddOnAssignmentBulkRemoveInput

Arguments:

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be unassigned from.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIds[UserID!]!Global IDs of user to be unassigned.

Fields:

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.userAddOnAssignmentCreate

Input type: UserAddOnAssignmentCreateInput

Arguments:

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be assigned to.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIdUserID!Global ID of user to be assigned.

Fields:

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userAddOnUserUser who the add-on purchase was assigned to.

Mutation.userAddOnAssignmentRemove

Input type: UserAddOnAssignmentRemoveInput

Arguments:

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase assignment belongs to.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIdUserID!Global ID of user whose assignment will be removed.

Fields:

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userAddOnUserUser that the add-on was removed from.

Mutation.userCalloutCreate

Input type: UserCalloutCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
featureNameString!Feature name you want to dismiss the callout for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userCalloutUserCallout!User callout dismissed.

Mutation.userCustomAttributeSet

  • Introduced in GitLab 18.9.
  • Status: Experiment.

Creates or updates a custom attribute on a user. Only available to admins.

Input type: UserCustomAttributeSetInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
keyString!Key of the custom attribute.
userIdUserID!Global ID of the user.
valueString!Value of the custom attribute.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customAttributeCustomAttributeCustom attribute after mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.userGroupCalloutCreate

Input type: UserGroupCalloutCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
featureNameString!Feature name you want to dismiss the callout for.
groupIdGroupID!Group for the callout.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userGroupCalloutUserGroupCallout!User group callout dismissed.

Mutation.userPreferencesUpdate

Input type: UserPreferencesUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
duoDefaultNamespaceIdIntDefault namespace context for Duo features when namespace can not be inferred.
extensionsMarketplaceOptInStatusExtensionsMarketplaceOptInStatusStatus of the Web IDE Extension Marketplace opt-in for the user.
issuesSortIssueSortSort order for issue lists.
knowledgeGraphGoverningNamespaceIdIntGoverning and billing namespace for Orbit.
mergeRequestDashboardListTypeMergeRequestsDashboardListTypeMerge request dashboard list rendering type.
mergeRequestDashboardShowDraftsBooleanShow draft merge requests on the merge request dashboard.
mergeRequestsSortMergeRequestSortSort order for issue lists.
orbitSettings warning-solidJSONIntroduced in GitLab 19.0. Status: Experiment. Orbit agent settings, e.g.: “{ enabled: false }”.
organizationGroupsProjectsDisplay warning-solidOrganizationGroupProjectDisplayIntroduced in GitLab 17.2. Status: Experiment. Default list view for organization groups and projects.
organizationGroupsProjectsSort warning-solidOrganizationGroupProjectSortIntroduced in GitLab 17.2. Status: Experiment. Sort order for organization groups and projects.
projectsSortProjectSortSort order for projects.
useWorkItemsViewBooleanUse work item view instead of legacy issue view.
visibilityPipelineIdTypeVisibilityPipelineIdTypeDetermines whether the pipeline list shows ID or IID.
wikiUseAutoCommitMessage warning-solidBooleanIntroduced in GitLab 18.10. Status: Experiment. Whether to skip the commit message modal and use the auto-generated commit message when saving changes to a wiki document.
workItemsDisplaySettings warning-solidJSONIntroduced in GitLab 18.1. Status: Experiment. Display settings for the work item lists, e.g.: “{ shouldOpenItemsInSidePanel: false }”.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userPreferencesUserPreferencesUser preferences after mutation.

Mutation.userSetNamespaceCommitEmail

Input type: UserSetNamespaceCommitEmailInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
emailIdEmailIDID of the email to set.
namespaceIdNamespaceID!ID of the namespace to set the namespace commit email for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceCommitEmailNamespaceCommitEmailUser namespace commit email after mutation.

Mutation.valueStreamCreate

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Creates a value stream.

Input type: ValueStreamCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Value stream name.
namespacePathID!Full path of the namespace(project or group) the value stream is created in.
settingValueStreamSettingInputValue stream configuration.
stages[CreateValueStreamStageInput!]Value stream stages.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
valueStreamValueStreamCreated value stream.

Mutation.valueStreamDestroy

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Destroy a value stream.

Input type: ValueStreamDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAnalyticsCycleAnalyticsValueStreamID!Global ID of the value stream to destroy.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
valueStreamValueStreamValue stream deleted after mutation.

Mutation.valueStreamUpdate

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Updates a value stream.

Input type: ValueStreamUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAnalyticsCycleAnalyticsValueStreamID!Global ID of the value stream to update.
nameStringValue stream name.
settingValueStreamSettingInputValue stream configuration.
stages[UpdateValueStreamStageInput!]Value stream stages.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
valueStreamValueStreamUpdated value stream.

Mutation.verifiedNamespaceCreate

Create a verified namespace and mark all child catalog resources with the passed verification level info.

Input type: VerifiedNamespaceCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Root namespace path.
verificationLevelCiCatalogResourceVerificationLevel!Verification level for a root namespace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.virtualRegistriesCleanupPolicyUpsert

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Create or update virtual registries cleanup policy for a root group.

Input type: VirtualRegistriesCleanupPolicyUpsertInput

Arguments:

NameTypeDescription
cadenceIntJob cadence for the cleanup process. Allowed values are 1, 7, 14, 30, 90. Default is 7.
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanEnable or disable the virtual registries cleanup policy. Default is false.
fullPathID!Group path for the group virtual registries.
keepNDaysAfterDownloadIntKeep packages for the period after download. Range is 1-365. Default is 30.
notifyOnFailureBooleanWhether to notify group owners when cleanup runs fail. Default is false.
notifyOnSuccessBooleanWhether to notify group owners when cleanup runs succeed. Default is false.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
virtualRegistriesCleanupPolicyVirtualRegistryCleanupPolicyVirtual registries cleanup policy after mutation.

Mutation.vulnerabilitiesArchive

  • Introduced in GitLab 17.10.
  • Status: Experiment.

Input type: VulnerabilitiesArchiveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dateDate!Last update date of vulnerabilities being archived.
projectIdProjectID!ID of the project to attach the vulnerability to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
statusString!Status of the action.

Mutation.vulnerabilitiesCreateIssue

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: VulnerabilitiesCreateIssueInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectProjectID!ID of the project to attach the issue to.
vulnerabilityIds[VulnerabilityID!]!IDs of vulnerabilities to link to the given issue. Up to 100 can be provided.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.

Mutation.vulnerabilitiesDismiss

Input type: VulnerabilitiesDismissInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReasonVulnerabilityDismissalReasonReason why vulnerability should be dismissed.
vulnerabilityIds[VulnerabilityID!]!IDs of the vulnerabilities to be dismissed (maximum 100 entries).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilities[Vulnerability!]!Vulnerabilities after state change.

Mutation.vulnerabilitiesRemoveAllFromProject

Remove all Vulnerabilities and related information from a given project. Introduced in GitLab 16.7.

Input type: VulnerabilitiesRemoveAllFromProjectInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectIds[ProjectID!]!IDs of project for which all Vulnerabilities should be removed. The deletion will happen in the background so the changes will not be visible immediately.
resolvedOnDefaultBranchBooleanWhen set as true, deletes only the vulnerabilities no longer detected. When set as false, deletes only the vulnerabilities still detected.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
projects[Project!]!Projects for which the deletion was scheduled.

Mutation.vulnerabilitiesSeverityOverride

Input type: vulnerabilitiesSeverityOverrideInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentString!Comment why vulnerability severity was changed (maximum 50,000 characters).
severityVulnerabilitySeverity!New severity value for the severities.
vulnerabilityIds[VulnerabilityID!]!IDs of the vulnerabilities for which severity needs to be changed (maximum 100 entries).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilities[Vulnerability!]!Vulnerabilities after severity change.

Mutation.vulnerabilityAutoRemediation

  • Introduced in GitLab 19.2.
  • Status: Experiment.

Triggers automated remediation for a single vulnerability. Currently supports dependency (SCA) vulnerabilities, where a remediation merge request is created asynchronously when a fix is available; other report types return UNSUPPORTED.

Input type: VulnerabilityAutoRemediationInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
vulnerabilityIdVulnerabilityID!ID of the vulnerability to remediate.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
statusVulnerabilityAutoRemediationStatusOutcome of triggering auto-remediation.

Mutation.vulnerabilityConfirm

Input type: VulnerabilityConfirmInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was confirmed (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be confirmed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

Mutation.vulnerabilityCreate

Input type: VulnerabilityCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
confirmedAtTimeTimestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is confirmed).
descriptionString!Long text section that describes the vulnerability in more detail.
detectedAtTimeTimestamp of when the vulnerability was first detected (defaults to creation time).
dismissedAtTimeTimestamp of when the vulnerability state changed to dismissed (defaults to creation time if status is dismissed).
identifiers[VulnerabilityIdentifierInput!]!Array of CVE or CWE identifiers for the vulnerability.
nameString!Name of the vulnerability.
projectProjectID!ID of the project to attach the vulnerability to.
projectTrackedContextProjectTrackedContextInputTracked context to associate with the vulnerability.
resolvedAtTimeTimestamp of when the vulnerability state changed to resolved (defaults to creation time if status is resolved).
scannerVulnerabilityScannerInput!Information about the scanner used to discover the vulnerability.
severityVulnerabilitySeveritySeverity of the vulnerability (defaults to unknown).
solutionStringInstructions for how to fix the vulnerability.
stateVulnerabilityStateState of the vulnerability (defaults to detected).

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability created.

Mutation.vulnerabilityDismiss

Input type: VulnerabilityDismissInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReasonVulnerabilityDismissalReasonReason why vulnerability should be dismissed.
idVulnerabilityID!ID of the vulnerability to be dismissed.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

Mutation.vulnerabilityDismissFalsePositiveFlag

  • Introduced in GitLab 18.6.
  • Status: Experiment.

Dismiss a vulnerability false positive flag.

Input type: VulnerabilityDismissFalsePositiveFlagInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVulnerabilityID!ID of the vulnerability to dismiss false positive flag for.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after dismissing false positive flag.

Mutation.vulnerabilityExternalIssueLinkCreate

Input type: VulnerabilityExternalIssueLinkCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
externalTrackerVulnerabilityExternalIssueLinkExternalTracker!External tracker type of the external issue link.
idVulnerabilityID!ID of the vulnerability.
linkTypeVulnerabilityExternalIssueLinkType!Type of the external issue link.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
externalIssueLinkVulnerabilityExternalIssueLinkCreated external issue link.

Mutation.vulnerabilityExternalIssueLinkDestroy

Input type: VulnerabilityExternalIssueLinkDestroyInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVulnerabilitiesExternalIssueLinkID!Global ID of the vulnerability external issue link.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.vulnerabilityIssueLinkCreate

Input type: VulnerabilityIssueLinkCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
issueIdIssueID!ID of the issue to link to.
vulnerabilityIds[VulnerabilityID!]!IDs of vulnerabilities to link to the given issue. Up to 100 can be provided.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
issueLinks[VulnerabilityIssueLink!]Created issue links.

Mutation.vulnerabilityLinkMergeRequest

  • Introduced in GitLab 18.4.
  • Status: Experiment.

Link a merge request to a vulnerability.

Input type: VulnerabilityLinkMergeRequestInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
mergeRequestIdMergeRequestID!ID of the merge request.
readinessScoreFloatConfidence rating representing the estimated accuracy of the fix in the AI generated merge request. Decimal value between 0 and 1, with 1 being the highest.
vulnerabilityIdVulnerabilityID!ID of the vulnerability.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityUpdated vulnerability.

Mutation.vulnerabilityResolve

Input type: VulnerabilityResolveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was resolved (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be resolved.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

Mutation.vulnerabilityRevertToDetected

Input type: VulnerabilityRevertToDetectedInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was reverted to detected (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be reverted to detected.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

Mutation.vulnerabilityUnlinkMergeRequest

  • Introduced in GitLab 18.5.
  • Status: Experiment.

Unlink a merge request from a vulnerability.

Input type: VulnerabilityUnlinkMergeRequestInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
mergeRequestIdMergeRequestID!ID of the merge request.
vulnerabilityIdVulnerabilityID!ID of the vulnerability.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityUpdated vulnerability.

Mutation.wikiPageSubscribe

  • Introduced in GitLab 18.1.
  • Status: Experiment.

Input type: WikiPageSubscribeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWikiPageMetaID!Global ID of the wiki page meta record.
subscribedBoolean!Desired state of the subscription.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
wikiPageWikiPageWiki page after mutation.

Mutation.workItemAddClosingMergeRequest

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Adds a closing merge request to a work item.

Input type: WorkItemAddClosingMergeRequestInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contextNamespacePathIDFull path of the context namespace (project or group). Only project full paths are used to find a merge request using a short reference syntax like !1. Ignored for full references and URLs. Defaults to the namespace of the work item if not provided.
idWorkItemID!Global ID of the work item.
mergeRequestReferenceString!Merge request reference (short, full or URL). Example: !1, project_full_path!1 or https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
closingMergeRequestWorkItemClosingMergeRequestClosing merge request added to the work item.
errors[String!]!Errors encountered during the mutation.
workItemWorkItemWork item with new closing merge requests.

Mutation.workItemAddLinkedItems

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Add linked items to the work item.

Input type: WorkItemAddLinkedItemsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
linkTypeWorkItemRelatedLinkTypeType of link. Defaults to RELATED.
workItemsIds[WorkItemID!]!Global IDs of the items to link. Maximum number of IDs you can provide: 10.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
messageStringLinked items update result message.
workItemWorkItemUpdated work item.

Mutation.workItemAvailabilityToggle

  • Introduced in GitLab 18.11.
  • Status: Experiment.

Enables or disables a work item type for a namespace.

Input type: WorkItemAvailabilityToggleInput

Arguments:

NameTypeDescription
actionWorkItemAvailabilityAction!Whether to enable or disable the work item type.
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the group or project.
scopeWorkItemAvailabilityScope!Whether to apply to the namespace or propagate to all existing children.
workItemTypeIdWorkItemsTypeID!Global ID of the work item type.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemTypeWorkItemTypeWork item type after the availability change.

Mutation.workItemBulkMove

  • Introduced in GitLab 18.2.
  • Status: Experiment.

Moves work items between projects or groups.

Input type: WorkItemBulkMoveInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[WorkItemID!]!Global ID array of the work items that will be moved. IDs that the user can’t move will be ignored. A max of 100 can be provided.
sourceFullPathString!Full path of the source namespace. For example, gitlab-org/gitlab-foss.
targetFullPathString!Full path of the target namespace. For example, gitlab-org/gitlab-foss. User paths are not supported.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
movedWorkItemCountIntNumber of work items that were successfully moved.

Mutation.workItemBulkUpdate

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Allows updating several properties for a set of work items.

Input type: WorkItemBulkUpdateInput

Arguments:

NameTypeDescription
assigneesWidget warning-solidWorkItemWidgetAssigneesInputIntroduced in GitLab 18.2. Status: Experiment. Input for assignees widget.
clientMutationIdStringA unique identifier for the client performing the mutation.
confidential warning-solidBooleanIntroduced in GitLab 18.2. Status: Experiment. Sets the work item confidentiality.
fullPathID!Full path of the project or group (Premium and Ultimate only) containing the work items that will be updated. User paths are not supported.
healthStatusWidget warning-solidWorkItemWidgetHealthStatusInputIntroduced in GitLab 18.2. Status: Experiment. Input for health status widget.
hierarchyWidget warning-solidWorkItemWidgetHierarchyCreateInputIntroduced in GitLab 18.2. Status: Experiment. Input for hierarchy widget.
ids[WorkItemID!]!Global ID array of the work items that will be updated. IDs that the user can’t update will be ignored. A max of 100 can be provided.
iterationWidget warning-solidWorkItemWidgetIterationInputIntroduced in GitLab 18.2. Status: Experiment. Input for iteration widget.
labelsWidgetWorkItemWidgetLabelsUpdateInputInput for labels widget.
milestoneWidget warning-solidWorkItemWidgetMilestoneInputIntroduced in GitLab 18.2. Status: Experiment. Input for milestone widget.
stateEvent warning-solidWorkItemStateEventIntroduced in GitLab 18.2. Status: Experiment. Close or reopen multiple work items at once.
statusWidget warning-solidWorkItemWidgetStatusInputIntroduced in GitLab 18.3. Status: Experiment. Input for status widget.
subscriptionEvent warning-solidWorkItemSubscriptionEventIntroduced in GitLab 18.2. Status: Experiment. Subscribe or unsubscribe from the work items.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
updatedWorkItemCountIntNumber of work items that were successfully updated.

Mutation.workItemConvert

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Converts the work item to a new type.

Input type: WorkItemConvertInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
workItemTypeIdWorkItemsTypeID!Global ID of the new work item type.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemWorkItemUpdated work item.

Mutation.workItemCreate

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Creates a work item.

Input type: WorkItemCreateInput

Arguments:

NameTypeDescription
agentPlanWidget warning-solidWorkItemWidgetAgentPlanInputIntroduced in GitLab 19.0. Status: Experiment. Input for agent plan widget.
assigneesWidgetWorkItemWidgetAssigneesInputInput for assignees widget.
clientMutationIdStringA unique identifier for the client performing the mutation.
colorWidgetWorkItemWidgetColorInputInput for color widget.
confidentialBooleanSets the work item confidentiality.
createSourceStringSource which triggered the creation of the work item. Used only for tracking purposes.
createdAtTimeTimestamp when the work item was created. Available only for admins and project owners.
crmContactsWidgetWorkItemWidgetCrmContactsCreateInputInput for CRM contacts widget.
customFieldsWidget warning-solid[WorkItemWidgetCustomFieldValueInputType!]Introduced in GitLab 17.10. Status: Experiment. Input for custom fields widget.
description warning-solidStringDeprecated in GitLab 16.9. use description widget instead.
descriptionWidgetWorkItemWidgetDescriptionInputInput for description widget.
developmentWidgetWorkItemWidgetDevelopmentCreateInputInput for development widget.
discussionsToResolveWorkItemResolveDiscussionsInputInformation required to resolve discussions in a noteable, when the work item is created.
healthStatusWidgetWorkItemWidgetHealthStatusInputInput for health status widget.
hierarchyWidgetWorkItemWidgetHierarchyCreateInputInput for hierarchy widget.
iterationWidgetWorkItemWidgetIterationInputIteration widget of the work item.
labelsWidgetWorkItemWidgetLabelsCreateInputInput for labels widget.
linkedItemsWidgetWorkItemWidgetLinkedItemsCreateInputInput for linked items widget.
milestoneWidgetWorkItemWidgetMilestoneInputInput for milestone widget.
namespacePathIDFull path of the namespace(project or group) the work item is created in.
projectPath warning-solidIDDeprecated in GitLab 15.10. Please use namespacePath instead. That will cover for both projects and groups.
startAndDueDateWidgetWorkItemWidgetStartAndDueDateUpdateInputInput for start and due date widget.
statusWidget warning-solidWorkItemWidgetStatusInputIntroduced in GitLab 17.11. Status: Experiment. Input for status widget.
titleString!Title of the work item.
vulnerabilityId warning-solidVulnerabilityIDIntroduced in GitLab 17.9. Status: Experiment. Input for linking an existing vulnerability to created work item.
weightWidgetWorkItemWidgetWeightInputInput for weight widget.
workItemTypeIdWorkItemsTypeID!Global ID of a work item type.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemWorkItemCreated work item.

Mutation.workItemCreateFromTask

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Creates a work item from a task in another work item’s description.

Input type: WorkItemCreateFromTaskInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
workItemDataWorkItemConvertTaskInput!Arguments necessary to convert a task into a work item.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
newWorkItemWorkItemNew work item created from task.
workItemWorkItemUpdated work item.

Mutation.workItemDelete

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Deletes a work item.

Input type: WorkItemDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
namespaceNamespaceNamespace the deleted work item belonged to.
project warning-solidProjectDeprecated in GitLab 16.9. Use namespace.

Mutation.workItemEnableAiPlanning

  • Introduced in GitLab 19.3.
  • Status: Experiment.

Enables AI planning for a work item. Once enabled, AI planning cannot be disabled.

Input type: WorkItemEnableAiPlanningInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemWorkItemWork item after mutation.

Mutation.workItemExport

  • Deprecated in GitLab 18.0.
  • Use WorkItemsCsvExport.

Input type: WorkItemExportInput

Arguments:

NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
clientMutationIdStringA unique identifier for the client performing the mutation.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
crmContactIdStringFilter by ID of CRM contact.
crmOrganizationIdStringFilter by ID of CRM contact organization.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
healthStatusFilter warning-solidHealthStatusFilterIntroduced in GitLab 18.2. Status: Experiment. Health status of the work items, “none” and “any” values are supported.
hierarchyFilters warning-solidHierarchyFilterInputIntroduced in GitLab 18.3. Status: Experiment. Filtering options related to the work item hierarchy.
ids[WorkItemID!]Filter by global IDs of work items (maximum is 100 IDs).
iids[String!]List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeDescendantWorkItems warning-solidBooleanIntroduced in GitLab 18.3. Status: Experiment. Whether to include work items of descendant parents when filtering by parent_ids.
iterationCadenceId warning-solid[IterationsCadenceID!]Introduced in GitLab 18.2. Status: Experiment. Filter by a list of iteration cadence IDs.
iterationId warning-solid[ID]Introduced in GitLab 18.2. Status: Experiment. List of iteration Global IDs applied to the work items.
iterationWildcardId warning-solidIterationWildcardIdIntroduced in GitLab 18.2. Status: Experiment. Filter by iteration ID wildcard.
labelName[String!]Labels applied to the work item (maximum is 100 labels).
milestoneTitle[String!]Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
parentIds[WorkItemID!]Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId warning-solidWorkItemParentWildcardIdIntroduced in GitLab 18.5. Status: Experiment. Filter by parent ID wildcard. Incompatible with parentIds.
projectPathID!Full project path.
releaseTag[String!]Release tag associated with the work item’s milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardIdReleaseTagWildcardIdFilter by release tag wildcard.
searchStringSearch query for title or description.
selectedFields[AvailableExportFields!]List of selected fields to be exported. Omit to export all available fields.
stateIssuableStateCurrent state of the work item.
status warning-solidWorkItemWidgetStatusFilterInputIntroduced in GitLab 18.7. Status: Experiment. Filter by status.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.
weight warning-solidStringIntroduced in GitLab 18.2. Status: Experiment. Weight applied to the work item, “none” and “any” values are supported.
weightWildcardId warning-solidWeightWildcardIdIntroduced in GitLab 18.2. Status: Experiment. Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds[WorkItemsTypeID!]Filter work items by work item type global IDs.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
messageStringExport request result message.

Mutation.workItemHierarchyAddChildrenItems

  • Introduced in GitLab 18.2.
  • Status: Experiment.

Adds children to a given work item’s hierarchy by Global ID.

Input type: WorkItemHierarchyAddChildrenItemsInput

Arguments:

NameTypeDescription
childrenIds[WorkItemID!]!Global IDs of children work items.
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.

Fields:

NameTypeDescription
addedChildren[WorkItem!]!Work items that were added as children.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.

Mutation.workItemRemoveLinkedItems

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Remove items linked to the work item.

Input type: WorkItemRemoveLinkedItemsInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
workItemsIds[WorkItemID!]!Global IDs of the items to unlink. Maximum number of IDs you can provide: 10.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
messageStringLinked items update result message.
workItemWorkItemUpdated work item.

Mutation.workItemSavedViewCreate

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Creates a saved view.

Input type: WorkItemSavedViewCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the saved view.
displaySettingsJSON!Display settings associated with the saved view.
filtersWorkItemSavedViewFilterInput!Filters associated with the saved view.
isPrivateBooleanWhether the saved view is private. Default is true.
nameString!Name of the saved view.
namespacePathID!Full path of the namespace to create the saved view in.
private warning-solidBooleanDeprecated in GitLab 18.10. Replaced by isPrivate argument.
sortWorkItemSort!Sort option associated with the saved view.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeCreated saved view.

Mutation.workItemSavedViewDelete

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Deletes a saved view.

Input type: WorkItemSavedViewDeleteInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeDeleted saved view.

Mutation.workItemSavedViewReorder

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Reorders a saved view for the current user.

Input type: WorkItemSavedViewReorderInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view to be reordered.
moveAfterIdWorkItemsSavedViewsSavedViewIDGlobal ID of a saved view that the reordered view should be placed after.
moveBeforeIdWorkItemsSavedViewsSavedViewIDGlobal ID of a saved view that the reordered view should be placed before.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeReordered saved view.

Mutation.workItemSavedViewSubscribe

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Subscribes the current user to a saved view.

Input type: WorkItemSavedViewSubscribeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view to subscribe to.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeSubscribed saved view.

Mutation.workItemSavedViewUnsubscribe

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Unsubscribes the current user from a saved view.

Input type: WorkItemSavedViewUnsubscribeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view to unsubscribe from.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeUnsubscribed saved view.

Mutation.workItemSavedViewUpdate

  • Introduced in GitLab 18.7.
  • Status: Experiment.

Updates a saved view.

Input type: WorkItemSavedViewUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the saved view.
displaySettingsJSONDisplay settings associated with the saved view.
filtersWorkItemSavedViewFilterInputFilters associated with the saved view.
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view.
isPrivateBooleanWhether the saved view is private.
nameStringName of the saved view.
private warning-solidBooleanDeprecated in GitLab 18.10. Replaced by isPrivate argument.
sortWorkItemSortSorting option associated with the saved view.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeUpdated saved view.

Mutation.workItemSettingsUpdate

  • Introduced in GitLab 19.0.
  • Status: Experiment.

Updates work item settings for a root group or organization. Omit fullPath to update settings for the current organization.

Input type: WorkItemSettingsUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customizableTypeVisibilityBooleanWhether namespace admins can configure per-type work item visibility.
fullPathIDFull path of the root group. Omit to use the current organization.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemSettingsWorkItemSettingsWork item settings after mutation.

Mutation.workItemSubscribe

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: WorkItemSubscribeInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
subscribedBoolean!Desired state of the subscription.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemWorkItemWork item after mutation.

Mutation.workItemTypeCreate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: WorkItemTypeCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledByDefaultForNewNamespacesBooleanIndicates the type is enabled by default for new child namespaces.
fullPathStringFull path of the root group.
iconNameString!Icon name for the work item type. Use the workItemTypeIconDefinitions query to retrieve the list of available icon names.
nameString!Name for the work item type.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemTypeWorkItemTypeWork item type that was created.

Mutation.workItemTypeUpdate

  • Introduced in GitLab 18.10.
  • Status: Experiment.

Input type: WorkItemTypeUpdateInput

Arguments:

NameTypeDescription
archiveBooleanWhether to archive the work item type.
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledByDefaultForNewNamespacesBooleanIndicates the type is enabled by default for new child namespaces.
fullPathStringFull path of the root group.
iconNameStringIcon name for the work item type. Use the workItemTypeIconDefinitions query to retrieve the list of available icon names.
idWorkItemsTypeID!Global ID of the work item type to update.
nameStringNew name for the work item type.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemTypeWorkItemTypeWork item type that was updated.

Mutation.workItemUpdate

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Updates a work item by Global ID.

Input type: WorkItemUpdateInput

Arguments:

NameTypeDescription
agentPlanWidget warning-solidWorkItemWidgetAgentPlanInputIntroduced in GitLab 19.0. Status: Experiment. Input for agent plan widget.
assigneesWidgetWorkItemWidgetAssigneesInputInput for assignees widget.
awardEmojiWidgetWorkItemWidgetAwardEmojiUpdateInputInput for emoji reactions widget.
clientMutationIdStringA unique identifier for the client performing the mutation.
colorWidgetWorkItemWidgetColorInputInput for color widget.
confidentialBooleanSets the work item confidentiality.
crmContactsWidgetWorkItemWidgetCrmContactsUpdateInputInput for CRM contacts widget.
currentUserTodosWidgetWorkItemWidgetCurrentUserTodosInputInput for to-dos widget.
customFieldsWidget warning-solid[WorkItemWidgetCustomFieldValueInputType!]Introduced in GitLab 17.10. Status: Experiment. Input for custom fields widget.
descriptionWidgetWorkItemWidgetDescriptionInputInput for description widget.
healthStatusWidgetWorkItemWidgetHealthStatusInputInput for health status widget.
hierarchyWidgetWorkItemWidgetHierarchyUpdateInputInput for hierarchy widget.
idWorkItemID!Global ID of the work item.
iterationWidgetWorkItemWidgetIterationInputInput for iteration widget.
labelsWidgetWorkItemWidgetLabelsUpdateInputInput for labels widget.
milestoneWidgetWorkItemWidgetMilestoneInputInput for milestone widget.
moveAfterId warning-solidWorkItemIDIntroduced in GitLab 19.2. Status: Experiment. Global ID of a work item that should be placed after the work item.
moveBeforeId warning-solidWorkItemIDIntroduced in GitLab 19.2. Status: Experiment. Global ID of a work item that should be placed before the work item.
notesWidgetWorkItemWidgetNotesInputInput for notes widget.
notificationsWidgetWorkItemWidgetNotificationsUpdateInputInput for notifications widget.
progressWidgetWorkItemWidgetProgressInputInput for progress widget.
startAndDueDateWidgetWorkItemWidgetStartAndDueDateUpdateInputInput for start and due date widget.
stateEventWorkItemStateEventClose or reopen a work item.
statusWidget warning-solidWorkItemWidgetStatusInputIntroduced in GitLab 17.11. Status: Experiment. Input for status widget.
timeTrackingWidgetWorkItemWidgetTimeTrackingInputInput for time tracking widget.
titleStringTitle of the work item.
verificationStatusWidgetVerificationStatusInputInput for verification status widget.
weightWidgetWorkItemWidgetWeightInputInput for weight widget.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemWorkItemUpdated work item.

Mutation.workItemUserPreferenceUpdate

  • Introduced in GitLab 17.10.
  • Status: Experiment.

Create or Update user preferences for a work item type and namespace.

Input type: WorkItemUserPreferenceUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displaySettingsJSONDisplay settings for the work item lists.
namespacePathID!Full path of the namespace on which the preference is set.
sortWorkItemSortSort order for work item lists.
workItemTypeIdWorkItemsTypeIDGlobal ID of a work item type.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
userPreferencesWorkItemTypesUserPreferenceUser preferences.

Mutation.workItemsCsvExport

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Input type: WorkItemsCsvExportInput

Arguments:

NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
clientMutationIdStringA unique identifier for the client performing the mutation.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
crmContactIdStringFilter by ID of CRM contact.
crmOrganizationIdStringFilter by ID of CRM contact organization.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
healthStatusFilter warning-solidHealthStatusFilterIntroduced in GitLab 18.2. Status: Experiment. Health status of the work items, “none” and “any” values are supported.
hierarchyFilters warning-solidHierarchyFilterInputIntroduced in GitLab 18.3. Status: Experiment. Filtering options related to the work item hierarchy.
ids[WorkItemID!]Filter by global IDs of work items (maximum is 100 IDs).
iids[String!]List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeDescendantWorkItems warning-solidBooleanIntroduced in GitLab 18.3. Status: Experiment. Whether to include work items of descendant parents when filtering by parent_ids.
iterationCadenceId warning-solid[IterationsCadenceID!]Introduced in GitLab 18.2. Status: Experiment. Filter by a list of iteration cadence IDs.
iterationId warning-solid[ID]Introduced in GitLab 18.2. Status: Experiment. List of iteration Global IDs applied to the work items.
iterationWildcardId warning-solidIterationWildcardIdIntroduced in GitLab 18.2. Status: Experiment. Filter by iteration ID wildcard.
labelName[String!]Labels applied to the work item (maximum is 100 labels).
milestoneTitle[String!]Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
parentIds[WorkItemID!]Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId warning-solidWorkItemParentWildcardIdIntroduced in GitLab 18.5. Status: Experiment. Filter by parent ID wildcard. Incompatible with parentIds.
projectPathID!Full project path.
releaseTag[String!]Release tag associated with the work item’s milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardIdReleaseTagWildcardIdFilter by release tag wildcard.
searchStringSearch query for title or description.
selectedFields[AvailableExportFields!]List of selected fields to be exported. Omit to export all available fields.
stateIssuableStateCurrent state of the work item.
status warning-solidWorkItemWidgetStatusFilterInputIntroduced in GitLab 18.7. Status: Experiment. Filter by status.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.
weight warning-solidStringIntroduced in GitLab 18.2. Status: Experiment. Weight applied to the work item, “none” and “any” values are supported.
weightWildcardId warning-solidWeightWildcardIdIntroduced in GitLab 18.2. Status: Experiment. Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds[WorkItemsTypeID!]Filter work items by work item type global IDs.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
messageStringExport request result message.

Mutation.workItemsCsvImport

  • Introduced in GitLab 18.2.
  • Status: Experiment.

Input type: WorkItemsCsvImportInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fileUpload!CSV file to import work items from.
projectPathID!Full project path.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
messageStringImport request result message.

Mutation.workItemsHierarchyReorder

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Reorder a work item in the hierarchy tree.

Input type: workItemsHierarchyReorderInput

Arguments:

NameTypeDescription
adjacentWorkItemIdWorkItemIDID of the work item to move next to. For example, the item above or below.
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item to be reordered.
parentIdWorkItemIDGlobal ID of the new parent work item.
relativePositionRelativePositionTypePosition relative to the adjacent work item. Valid values are BEFORE or AFTER.

Fields:

NameTypeDescription
adjacentWorkItemWorkItemAdjacent work item after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
parentWorkItemWorkItemWork item’s parent after mutation.
workItemWorkItemWork item after mutation.

Mutation.workItemsReorder

  • Introduced in GitLab 18.3.
  • Status: Experiment.

Reorders a work item.

Input type: workItemsReorderInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item to be reordered.
moveAfterIdWorkItemIDGlobal ID of a work item that should be placed after the work item.
moveBeforeIdWorkItemIDGlobal ID of a work item that should be placed before the work item.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workItemWorkItemWork item after mutation.

Mutation.workspaceCreate

Input type: WorkspaceCreateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!GlobalID of the cluster agent the created workspace will be associated with.
desiredStateString!Desired state of the created workspace.
devfilePathStringProject path containing the devfile used to configure the workspace. If not provided, the GitLab default devfile is used.
devfileRef warning-solidStringDeprecated in GitLab 17.8. Argument is renamed to project_ref.
editor warning-solidStringDeprecated in GitLab 17.5. Argument is not used.
maxHoursBeforeTermination warning-solidIntDeprecated in GitLab 17.9. Field is not used.
projectIdProjectID!ID of the project that will provide the Devfile for the created workspace.
projectRefStringProject repo git ref.
variables warning-solid[WorkspaceVariableInput!]Deprecated in GitLab 18.0. Argument is renamed to workspace_variables.
workspaceVariables warning-solid[WorkspaceVariableInput!]Introduced in GitLab 18.0. Status: Experiment. Variables to inject into the workspace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workspaceWorkspaceCreated workspace.

Mutation.workspaceUpdate

Input type: WorkspaceUpdateInput

Arguments:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
desiredStateString!Desired state of the created workspace.
idRemoteDevelopmentWorkspaceID!Global ID of the workspace.

Fields:

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during the mutation.
workspaceWorkspaceCreated workspace.

Connections

Some types in our schema are Connection types - they represent a paginated collection of edges between two nodes in the graph. These follow the Relay cursor connections specification.

Pagination arguments

All connection fields support the following pagination arguments:

NameTypeDescription
afterStringReturns the elements in the list that come after the specified cursor.
beforeStringReturns the elements in the list that come before the specified cursor.
firstIntReturns the first n elements from the list.
lastIntReturns the last n elements from the list.

Since these arguments are common to all connection fields, they are not repeated for each connection.

Connection fields

All connections have at least the following fields:

NameTypeDescription
pageInfoPageInfo!Pagination information.
edges[edge!]The edges.
nodes[item!]The items in the current page.

The precise type of Edge and Item depends on the kind of connection. A ProjectConnection will have nodes that have the type [Project!], and edges that have the type ProjectEdge.

Connection types

Some of the types in the schema exist solely to model connections. Each connection has a distinct, named type, with a distinct named edge type. These are listed separately below.

AbuseReportUploadRegistryConnection

The connection type for AbuseReportUploadRegistry.

Fields:

NameTypeDescription
edges[AbuseReportUploadRegistryEdge]A list of edges.
nodes[AbuseReportUploadRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AbuseReportUploadRegistryConnection.count

Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

AbuseReportUploadRegistryEdge

The edge type for AbuseReportUploadRegistry.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAbuseReportUploadRegistryThe item at the end of the edge.

AccessLevelDeployKeyConnection

The connection type for AccessLevelDeployKey.

Fields:

NameTypeDescription
edges[AccessLevelDeployKeyEdge]A list of edges.
nodes[AccessLevelDeployKey]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AccessLevelDeployKeyEdge

The edge type for AccessLevelDeployKey.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAccessLevelDeployKeyThe item at the end of the edge.

AchievementConnection

The connection type for Achievement.

Fields:

NameTypeDescription
edges[AchievementEdge]A list of edges.
nodes[Achievement]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AchievementConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AchievementEdge

The edge type for Achievement.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAchievementThe item at the end of the edge.

AchievementUploadRegistryConnection

The connection type for AchievementUploadRegistry.

Fields:

NameTypeDescription
edges[AchievementUploadRegistryEdge]A list of edges.
nodes[AchievementUploadRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AchievementUploadRegistryConnection.count

Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

AchievementUploadRegistryEdge

The edge type for AchievementUploadRegistry.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAchievementUploadRegistryThe item at the end of the edge.

AddOnUserConnection

The connection type for AddOnUser.

Fields:

NameTypeDescription
edges[AddOnUserEdge]A list of edges.
nodes[AddOnUser]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AddOnUserConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AddOnUserEdge

The edge type for AddOnUser.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAddOnUserThe item at the end of the edge.

AdminDuoAvailabilityLockedAncestorConnection

The connection type for AdminDuoAvailabilityLockedAncestor.

Fields:

NameTypeDescription
edges[AdminDuoAvailabilityLockedAncestorEdge]A list of edges.
nodes[AdminDuoAvailabilityLockedAncestor]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AdminDuoAvailabilityLockedAncestorEdge

The edge type for AdminDuoAvailabilityLockedAncestor.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAdminDuoAvailabilityLockedAncestorThe item at the end of the edge.

AdminDuoAvailabilityNamespaceConnection

The connection type for AdminDuoAvailabilityNamespace.

Fields:

NameTypeDescription
edges[AdminDuoAvailabilityNamespaceEdge]A list of edges.
nodes[AdminDuoAvailabilityNamespace]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AdminDuoAvailabilityNamespaceEdge

The edge type for AdminDuoAvailabilityNamespace.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAdminDuoAvailabilityNamespaceThe item at the end of the edge.

AdminMemberRoleConnection

The connection type for AdminMemberRole.

Fields:

NameTypeDescription
edges[AdminMemberRoleEdge]A list of edges.
nodes[AdminMemberRole]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AdminMemberRoleEdge

The edge type for AdminMemberRole.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAdminMemberRoleThe item at the end of the edge.

AgentConfigurationConnection

The connection type for AgentConfiguration.

Fields:

NameTypeDescription
edges[AgentConfigurationEdge]A list of edges.
nodes[AgentConfiguration]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AgentConfigurationEdge

The edge type for AgentConfiguration.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAgentConfigurationThe item at the end of the edge.

AgentPlatformSessionsAggregationResponseConnection

The connection type for AgentPlatformSessionsAggregationResponse.

Fields:

NameTypeDescription
countInt!Total number of aggregated rows.
edges[AgentPlatformSessionsAggregationResponseEdge]A list of edges.
nodes[AgentPlatformSessionsAggregationResponse]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AgentPlatformSessionsAggregationResponseEdge

The edge type for AgentPlatformSessionsAggregationResponse.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAgentPlatformSessionsAggregationResponseThe item at the end of the edge.

AgentPlatformUserFlowCountConnection

The connection type for AgentPlatformUserFlowCount.

Fields:

NameTypeDescription
edges[AgentPlatformUserFlowCountEdge]A list of edges.
nodes[AgentPlatformUserFlowCount]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AgentPlatformUserFlowCountEdge

The edge type for AgentPlatformUserFlowCount.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAgentPlatformUserFlowCountThe item at the end of the edge.

AiAuditEventConnection

The connection type for AiAuditEvent.

Fields:

NameTypeDescription
edges[AiAuditEventEdge]A list of edges.
nodes[AiAuditEvent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiAuditEventEdge

The edge type for AiAuditEvent.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiAuditEventThe item at the end of the edge.

AiCatalogBuiltInToolConnection

The connection type for AiCatalogBuiltInTool.

Fields:

NameTypeDescription
edges[AiCatalogBuiltInToolEdge]A list of edges.
nodes[AiCatalogBuiltInTool]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiCatalogBuiltInToolEdge

The edge type for AiCatalogBuiltInTool.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiCatalogBuiltInToolThe item at the end of the edge.

AiCatalogCustomAndFoundationalItemConnection

The connection type for AiCatalogCustomAndFoundationalItem.

Fields:

NameTypeDescription
edges[AiCatalogCustomAndFoundationalItemEdge]A list of edges.
nodes[AiCatalogCustomAndFoundationalItem]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiCatalogCustomAndFoundationalItemEdge

The edge type for AiCatalogCustomAndFoundationalItem.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiCatalogCustomAndFoundationalItemThe item at the end of the edge.

AiCatalogItemConnection

The connection type for AiCatalogItem.

Fields:

NameTypeDescription
edges[AiCatalogItemEdge]A list of edges.
nodes[AiCatalogItem]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AiCatalogItemConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogItemConsumerConnection

The connection type for AiCatalogItemConsumer.

Fields:

NameTypeDescription
edges[AiCatalogItemConsumerEdge]A list of edges.
nodes[AiCatalogItemConsumer]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AiCatalogItemConsumerConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogItemConsumerEdge

The edge type for AiCatalogItemConsumer.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiCatalogItemConsumerThe item at the end of the edge.

AiCatalogItemEdge

The edge type for AiCatalogItem.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiCatalogItemThe item at the end of the edge.

AiCatalogItemVersionConnection

The connection type for AiCatalogItemVersion.

Fields:

NameTypeDescription
edges[AiCatalogItemVersionEdge]A list of edges.
nodes[AiCatalogItemVersion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AiCatalogItemVersionConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogItemVersionEdge

The edge type for AiCatalogItemVersion.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiCatalogItemVersionThe item at the end of the edge.

AiCatalogMcpServerConnection

The connection type for AiCatalogMcpServer.

Fields:

NameTypeDescription
edges[AiCatalogMcpServerEdge]A list of edges.
nodes[AiCatalogMcpServer]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiCatalogMcpServerEdge

The edge type for AiCatalogMcpServer.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiCatalogMcpServerThe item at the end of the edge.

AiCatalogMcpToolConnection

The connection type for AiCatalogMcpTool.

Fields:

NameTypeDescription
edges[AiCatalogMcpToolEdge]A list of edges.
nodes[AiCatalogMcpTool]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiCatalogMcpToolEdge

The edge type for AiCatalogMcpTool.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiCatalogMcpToolThe item at the end of the edge.

AiConversationsThreadConnection

The connection type for AiConversationsThread.

Fields:

NameTypeDescription
edges[AiConversationsThreadEdge]A list of edges.
nodes[AiConversationsThread]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiConversationsThreadEdge

The edge type for AiConversationsThread.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiConversationsThreadThe item at the end of the edge.

AiFeatureSettingConnection

The connection type for AiFeatureSetting.

Fields:

NameTypeDescription
edges[AiFeatureSettingEdge]A list of edges.
nodes[AiFeatureSetting]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiFeatureSettingEdge

The edge type for AiFeatureSetting.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiFeatureSettingThe item at the end of the edge.

AiFlowTriggerTypeConnection

The connection type for AiFlowTriggerType.

Fields:

NameTypeDescription
edges[AiFlowTriggerTypeEdge]A list of edges.
nodes[AiFlowTriggerType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AiFlowTriggerTypeConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiFlowTriggerTypeEdge

The edge type for AiFlowTriggerType.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiFlowTriggerTypeThe item at the end of the edge.

AiFoundationalChatAgentConnection

The connection type for AiFoundationalChatAgent.

Fields:

NameTypeDescription
edges[AiFoundationalChatAgentEdge]A list of edges.
nodes[AiFoundationalChatAgent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiFoundationalChatAgentEdge

The edge type for AiFoundationalChatAgent.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiFoundationalChatAgentThe item at the end of the edge.

AiInstanceUsageEventConnection

The connection type for AiInstanceUsageEvent.

Fields:

NameTypeDescription
edges[AiInstanceUsageEventEdge]A list of edges.
nodes[AiInstanceUsageEvent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiInstanceUsageEventEdge

The edge type for AiInstanceUsageEvent.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiInstanceUsageEventThe item at the end of the edge.

AiMessageConnection

The connection type for AiMessage.

Fields:

NameTypeDescription
edges[AiMessageEdge]A list of edges.
nodes[AiMessage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiMessageEdge

The edge type for AiMessage.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiMessageThe item at the end of the edge.

AiModelSelectionAllowListModelConnection

The connection type for AiModelSelectionAllowListModel.

Fields:

NameTypeDescription
edges[AiModelSelectionAllowListModelEdge]A list of edges.
nodes[AiModelSelectionAllowListModel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiModelSelectionAllowListModelEdge

The edge type for AiModelSelectionAllowListModel.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiModelSelectionAllowListModelThe item at the end of the edge.

AiModelSelectionNamespaceFeatureSettingConnection

The connection type for AiModelSelectionNamespaceFeatureSetting.

Fields:

NameTypeDescription
edges[AiModelSelectionNamespaceFeatureSettingEdge]A list of edges.
nodes[AiModelSelectionNamespaceFeatureSetting]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiModelSelectionNamespaceFeatureSettingEdge

The edge type for AiModelSelectionNamespaceFeatureSetting.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiModelSelectionNamespaceFeatureSettingThe item at the end of the edge.

AiModelSelectionOfferedModelConnection

The connection type for AiModelSelectionOfferedModel.

Fields:

NameTypeDescription
edges[AiModelSelectionOfferedModelEdge]A list of edges.
nodes[AiModelSelectionOfferedModel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiModelSelectionOfferedModelEdge

The edge type for AiModelSelectionOfferedModel.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiModelSelectionOfferedModelThe item at the end of the edge.

AiSelfHostedModelConnection

The connection type for AiSelfHostedModel.

Fields:

NameTypeDescription
edges[AiSelfHostedModelEdge]A list of edges.
nodes[AiSelfHostedModel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiSelfHostedModelEdge

The edge type for AiSelfHostedModel.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiSelfHostedModelThe item at the end of the edge.

AiToolRuleConnection

The connection type for AiToolRule.

Fields:

NameTypeDescription
edges[AiToolRuleEdge]A list of edges.
nodes[AiToolRule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiToolRuleEdge

The edge type for AiToolRule.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiToolRuleThe item at the end of the edge.

AiUsageEventConnection

The connection type for AiUsageEvent.

Fields:

NameTypeDescription
edges[AiUsageEventEdge]A list of edges.
nodes[AiUsageEvent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiUsageEventEdge

The edge type for AiUsageEvent.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiUsageEventThe item at the end of the edge.

AiUserMetricsConnection

The connection type for AiUserMetrics.

Fields:

NameTypeDescription
edges[AiUserMetricsEdge]A list of edges.
nodes[AiUserMetrics]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiUserMetricsEdge

The edge type for AiUserMetrics.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiUserMetricsThe item at the end of the edge.

AiVectorizableFileUploadRegistryConnection

The connection type for AiVectorizableFileUploadRegistry.

Fields:

NameTypeDescription
edges[AiVectorizableFileUploadRegistryEdge]A list of edges.
nodes[AiVectorizableFileUploadRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AiVectorizableFileUploadRegistryConnection.count

Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

AiVectorizableFileUploadRegistryEdge

The edge type for AiVectorizableFileUploadRegistry.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiVectorizableFileUploadRegistryThe item at the end of the edge.

AiXrayReportConnection

The connection type for AiXrayReport.

Fields:

NameTypeDescription
edges[AiXrayReportEdge]A list of edges.
nodes[AiXrayReport]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiXrayReportEdge

The edge type for AiXrayReport.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiXrayReportThe item at the end of the edge.

AlertManagementAlertConnection

The connection type for AlertManagementAlert.

Fields:

NameTypeDescription
edges[AlertManagementAlertEdge]A list of edges.
nodes[AlertManagementAlert]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AlertManagementAlertEdge

The edge type for AlertManagementAlert.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAlertManagementAlertThe item at the end of the edge.

AlertManagementHttpIntegrationConnection

The connection type for AlertManagementHttpIntegration.

Fields:

NameTypeDescription
edges[AlertManagementHttpIntegrationEdge]A list of edges.
nodes[AlertManagementHttpIntegration]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AlertManagementHttpIntegrationEdge

The edge type for AlertManagementHttpIntegration.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAlertManagementHttpIntegrationThe item at the end of the edge.

AlertManagementIntegrationConnection

The connection type for AlertManagementIntegration.

Fields:

NameTypeDescription
edges[AlertManagementIntegrationEdge]A list of edges.
nodes[AlertManagementIntegration]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AlertManagementIntegrationEdge

The edge type for AlertManagementIntegration.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAlertManagementIntegrationThe item at the end of the edge.

AlertManagementMetricImageUploadRegistryConnection

The connection type for AlertManagementMetricImageUploadRegistry.

Fields:

NameTypeDescription
edges[AlertManagementMetricImageUploadRegistryEdge]A list of edges.
nodes[AlertManagementMetricImageUploadRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AlertManagementMetricImageUploadRegistryConnection.count

Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

AlertManagementMetricImageUploadRegistryEdge

The edge type for AlertManagementMetricImageUploadRegistry.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAlertManagementMetricImageUploadRegistryThe item at the end of the edge.

AmazonS3ConfigurationTypeConnection

The connection type for AmazonS3ConfigurationType.

Fields:

NameTypeDescription
edges[AmazonS3ConfigurationTypeEdge]A list of edges.
nodes[AmazonS3ConfigurationType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AmazonS3ConfigurationTypeEdge

The edge type for AmazonS3ConfigurationType.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAmazonS3ConfigurationTypeThe item at the end of the edge.

AppearanceUploadRegistryConnection

The connection type for AppearanceUploadRegistry.

Fields:

NameTypeDescription
edges[AppearanceUploadRegistryEdge]A list of edges.
nodes[AppearanceUploadRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
AppearanceUploadRegistryConnection.count

Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

AppearanceUploadRegistryEdge

The edge type for AppearanceUploadRegistry.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAppearanceUploadRegistryThe item at the end of the edge.

ApprovalPolicyConnection

The connection type for ApprovalPolicy.

Fields:

NameTypeDescription
edges[ApprovalPolicyEdge]A list of edges.
nodes[ApprovalPolicy]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ApprovalPolicyEdge

The edge type for ApprovalPolicy.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeApprovalPolicyThe item at the end of the edge.

ApprovalProjectRuleConnection

The connection type for ApprovalProjectRule.

Fields:

NameTypeDescription
edges[ApprovalProjectRuleEdge]A list of edges.
nodes[ApprovalProjectRule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ApprovalProjectRuleEdge

The edge type for ApprovalProjectRule.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeApprovalProjectRuleThe item at the end of the edge.

ArtifactRegistryRepositoryConnection

The connection type for ArtifactRegistryRepository.

Fields:

NameTypeDescription
edges[ArtifactRegistryRepositoryEdge]A list of edges.
nodes[ArtifactRegistryRepository]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ArtifactRegistryRepositoryEdge

The edge type for ArtifactRegistryRepository.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeArtifactRegistryRepositoryThe item at the end of the edge.

ArtifactRegistryRoleAssignmentConnection

The connection type for ArtifactRegistryRoleAssignment.

Fields:

NameTypeDescription
edges[ArtifactRegistryRoleAssignmentEdge]A list of edges.
nodes[ArtifactRegistryRoleAssignment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ArtifactRegistryRoleAssignmentEdge

The edge type for ArtifactRegistryRoleAssignment.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeArtifactRegistryRoleAssignmentThe item at the end of the edge.

AscpComponentConnection

The connection type for AscpComponent.

Fields:

NameTypeDescription
edges[AscpComponentEdge]A list of edges.
nodes[AscpComponent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AscpComponentEdge

The edge type for AscpComponent.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAscpComponentThe item at the end of the edge.

AscpScanConnection

The connection type for AscpScan.

Fields:

NameTypeDescription
edges[AscpScanEdge]A list of edges.
nodes[AscpScan]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AscpScanEdge

The edge type for AscpScan.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAscpScanThe item at the end of the edge.

AscpSecurityGuidelineConnection

The connection type for AscpSecurityGuideline.

Fields:

NameTypeDescription
edges[AscpSecurityGuidelineEdge]A list of edges.
nodes[AscpSecurityGuideline]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AscpSecurityGuidelineEdge

The edge type for AscpSecurityGuideline.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAscpSecurityGuidelineThe item at the end of the edge.

AuditEventDefinitionConnection

The connection type for AuditEventDefinition.

Fields:

NameTypeDescription
edges[AuditEventDefinitionEdge]A list of edges.
nodes[AuditEventDefinition]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AuditEventDefinitionEdge

The edge type for AuditEventDefinition.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAuditEventDefinitionThe item at the end of the edge.

AuditEventStreamingHeaderConnection

The connection type for AuditEventStreamingHeader.

Fields:

NameTypeDescription
edges[AuditEventStreamingHeaderEdge]A list of edges.
nodes[AuditEventStreamingHeader]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AuditEventStreamingHeaderEdge

The edge type for AuditEventStreamingHeader.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAuditEventStreamingHeaderThe item at the end of the edge.

AuditEventsStreamingInstanceHeaderConnection

The connection type for AuditEventsStreamingInstanceHeader.

Fields:

NameTypeDescription
edges[AuditEventsStreamingInstanceHeaderEdge]A list of edges.
nodes[AuditEventsStreamingInstanceHeader]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AuditEventsStreamingInstanceHeaderEdge

The edge type for AuditEventsStreamingInstanceHeader.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAuditEventsStreamingInstanceHeaderThe item at the end of the edge.

AwardEmojiConnection

The connection type for AwardEmoji.

Fields:

NameTypeDescription
edges[AwardEmojiEdge]A list of edges.
nodes[AwardEmoji]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AwardEmojiEdge

The edge type for AwardEmoji.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAwardEmojiThe item at the end of the edge.

BlobConnection

The connection type for Blob.

Fields:

NameTypeDescription
edges[BlobEdge]A list of edges.
nodes[Blob]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

BlobEdge

The edge type for Blob.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBlobThe item at the end of the edge.

BoardConnection

The connection type for Board.

Fields:

NameTypeDescription
edges[BoardEdge]A list of edges.
nodes[Board]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

BoardEdge

The edge type for Board.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBoardThe item at the end of the edge.

BoardEpicConnection

The connection type for BoardEpic.

Fields:

NameTypeDescription
edges[BoardEpicEdge]A list of edges.
nodes[BoardEpic]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
BoardEpicConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

BoardEpicEdge

The edge type for BoardEpic.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBoardEpicThe item at the end of the edge.

BoardListConnection

The connection type for BoardList.

Fields:

NameTypeDescription
edges[BoardListEdge]A list of edges.
nodes[BoardList]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

BoardListEdge

The edge type for BoardList.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBoardListThe item at the end of the edge.

BranchRuleConnection

The connection type for BranchRule.

Fields:

NameTypeDescription
edges[BranchRuleEdge]A list of edges.
nodes[BranchRule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

BranchRuleEdge

The edge type for BranchRule.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBranchRuleThe item at the end of the edge.

BulkImportExportUploadUploadRegistryConnection

The connection type for BulkImportExportUploadUploadRegistry.

Fields:

NameTypeDescription
edges[BulkImportExportUploadUploadRegistryEdge]A list of edges.
nodes[BulkImportExportUploadUploadRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
BulkImportExportUploadUploadRegistryConnection.count

Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

BulkImportExportUploadUploadRegistryEdge

The edge type for BulkImportExportUploadUploadRegistry.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBulkImportExportUploadUploadRegistryThe item at the end of the edge.

CdApplicationConnection

The connection type for CdApplication.

Fields:

NameTypeDescription
edges[CdApplicationEdge]A list of edges.
nodes[CdApplication]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdApplicationConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdApplicationEdge

The edge type for CdApplication.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdApplicationThe item at the end of the edge.

CdApplicationFlowDefinitionConnection

The connection type for CdApplicationFlowDefinition.

Fields:

NameTypeDescription
edges[CdApplicationFlowDefinitionEdge]A list of edges.
nodes[CdApplicationFlowDefinition]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdApplicationFlowDefinitionConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdApplicationFlowDefinitionEdge

The edge type for CdApplicationFlowDefinition.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdApplicationFlowDefinitionThe item at the end of the edge.

CdApplicationLinkConnection

The connection type for CdApplicationLink.

Fields:

NameTypeDescription
edges[CdApplicationLinkEdge]A list of edges.
nodes[CdApplicationLink]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdApplicationLinkConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdApplicationLinkEdge

The edge type for CdApplicationLink.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdApplicationLinkThe item at the end of the edge.

CdArtifactSourceConnection

The connection type for CdArtifactSource.

Fields:

NameTypeDescription
edges[CdArtifactSourceEdge]A list of edges.
nodes[CdArtifactSource]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdArtifactSourceConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdArtifactSourceEdge

The edge type for CdArtifactSource.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdArtifactSourceThe item at the end of the edge.

CdDeploymentConnection

The connection type for CdDeployment.

Fields:

NameTypeDescription
edges[CdDeploymentEdge]A list of edges.
nodes[CdDeployment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdDeploymentConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdDeploymentEdge

The edge type for CdDeployment.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdDeploymentThe item at the end of the edge.

CdDeploymentTransitionConnection

The connection type for CdDeploymentTransition.

Fields:

NameTypeDescription
edges[CdDeploymentTransitionEdge]A list of edges.
nodes[CdDeploymentTransition]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdDeploymentTransitionConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdDeploymentTransitionEdge

The edge type for CdDeploymentTransition.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdDeploymentTransitionThe item at the end of the edge.

CdEnvironmentApplicationConnection

The connection type for CdEnvironmentApplication.

Fields:

NameTypeDescription
edges[CdEnvironmentApplicationEdge]A list of edges.
nodes[CdEnvironmentApplication]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdEnvironmentApplicationConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironmentApplicationEdge

The edge type for CdEnvironmentApplication.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdEnvironmentApplicationThe item at the end of the edge.

CdEnvironmentConnection

The connection type for CdEnvironment.

Fields:

NameTypeDescription
edges[CdEnvironmentEdge]A list of edges.
nodes[CdEnvironment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdEnvironmentConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironmentDriverBindingConnection

The connection type for CdEnvironmentDriverBinding.

Fields:

NameTypeDescription
edges[CdEnvironmentDriverBindingEdge]A list of edges.
nodes[CdEnvironmentDriverBinding]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdEnvironmentDriverBindingConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironmentDriverBindingEdge

The edge type for CdEnvironmentDriverBinding.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdEnvironmentDriverBindingThe item at the end of the edge.

CdEnvironmentEdge

The edge type for CdEnvironment.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdEnvironmentThe item at the end of the edge.

CdRolloutConnection

The connection type for CdRollout.

Fields:

NameTypeDescription
edges[CdRolloutEdge]A list of edges.
nodes[CdRollout]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdRolloutConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutEdge

The edge type for CdRollout.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdRolloutThe item at the end of the edge.

CdRolloutEnvironmentConnection

The connection type for CdRolloutEnvironment.

Fields:

NameTypeDescription
edges[CdRolloutEnvironmentEdge]A list of edges.
nodes[CdRolloutEnvironment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdRolloutEnvironmentConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutEnvironmentEdge

The edge type for CdRolloutEnvironment.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdRolloutEnvironmentThe item at the end of the edge.

CdRolloutTransitionConnection

The connection type for CdRolloutTransition.

Fields:

NameTypeDescription
edges[CdRolloutTransitionEdge]A list of edges.
nodes[CdRolloutTransition]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdRolloutTransitionConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutTransitionEdge

The edge type for CdRolloutTransition.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdRolloutTransitionThe item at the end of the edge.

CdServiceConnection

The connection type for CdService.

Fields:

NameTypeDescription
edges[CdServiceEdge]A list of edges.
nodes[CdService]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdServiceConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdServiceEdge

The edge type for CdService.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdServiceThe item at the end of the edge.

CdServiceEnvironmentHealthConnection

The connection type for CdServiceEnvironmentHealth.

Fields:

NameTypeDescription
edges[CdServiceEnvironmentHealthEdge]A list of edges.
nodes[CdServiceEnvironmentHealth]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdServiceEnvironmentHealthConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdServiceEnvironmentHealthEdge

The edge type for CdServiceEnvironmentHealth.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdServiceEnvironmentHealthThe item at the end of the edge.

CdVersionConnection

The connection type for CdVersion.

Fields:

NameTypeDescription
edges[CdVersionEdge]A list of edges.
nodes[CdVersion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdVersionConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersionEdge

The edge type for CdVersion.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdVersionThe item at the end of the edge.

CdVersionSetConnection

The connection type for CdVersionSet.

Fields:

NameTypeDescription
edges[CdVersionSetEdge]A list of edges.
nodes[CdVersionSet]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdVersionSetConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersionSetEdge

The edge type for CdVersionSet.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdVersionSetThe item at the end of the edge.

CdVersionSetEntryConnection

The connection type for CdVersionSetEntry.

Fields:

NameTypeDescription
edges[CdVersionSetEntryEdge]A list of edges.
nodes[CdVersionSetEntry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CdVersionSetEntryConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersionSetEntryEdge

The edge type for CdVersionSetEntry.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCdVersionSetEntryThe item at the end of the edge.

CiBuildNeedConnection

The connection type for CiBuildNeed.

Fields:

NameTypeDescription
edges[CiBuildNeedEdge]A list of edges.
nodes[CiBuildNeed]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiBuildNeedEdge

The edge type for CiBuildNeed.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiBuildNeedThe item at the end of the edge.

CiCatalogBundledResourceConnection

The connection type for CiCatalogBundledResource.

Fields:

NameTypeDescription
edges[CiCatalogBundledResourceEdge]A list of edges.
nodes[CiCatalogBundledResource]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CiCatalogBundledResourceConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCatalogBundledResourceEdge

The edge type for CiCatalogBundledResource.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogBundledResourceThe item at the end of the edge.

CiCatalogResourceComponentConnection

The connection type for CiCatalogResourceComponent.

Fields:

NameTypeDescription
edges[CiCatalogResourceComponentEdge]A list of edges.
nodes[CiCatalogResourceComponent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiCatalogResourceComponentEdge

The edge type for CiCatalogResourceComponent.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceComponentThe item at the end of the edge.

CiCatalogResourceComponentUsageConnection

The connection type for CiCatalogResourceComponentUsage.

Fields:

NameTypeDescription
edges[CiCatalogResourceComponentUsageEdge]A list of edges.
nodes[CiCatalogResourceComponentUsage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiCatalogResourceComponentUsageEdge

The edge type for CiCatalogResourceComponentUsage.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceComponentUsageThe item at the end of the edge.

CiCatalogResourceConnection

The connection type for CiCatalogResource.

Fields:

NameTypeDescription
edges[CiCatalogResourceEdge]A list of edges.
nodes[CiCatalogResource]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CiCatalogResourceConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCatalogResourceEdge

The edge type for CiCatalogResource.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceThe item at the end of the edge.

CiCatalogResourceProjectUsageConnection

The connection type for CiCatalogResourceProjectUsage.

Fields:

NameTypeDescription
edges[CiCatalogResourceProjectUsageEdge]A list of edges.
nodes[CiCatalogResourceProjectUsage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiCatalogResourceProjectUsageEdge

The edge type for CiCatalogResourceProjectUsage.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceProjectUsageThe item at the end of the edge.

CiCatalogResourceVersionConnection

The connection type for CiCatalogResourceVersion.

Fields:

NameTypeDescription
edges[CiCatalogResourceVersionEdge]A list of edges.
nodes[CiCatalogResourceVersion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CiCatalogResourceVersionConnection.count

Total count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCatalogResourceVersionEdge

The edge type for CiCatalogResourceVersion.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceVersionThe item at the end of the edge.

CiConfigGroupConnection

The connection type for CiConfigGroup.

Fields:

NameTypeDescription
edges[CiConfigGroupEdge]A list of edges.
nodes[CiConfigGroup]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiConfigGroupEdge

The edge type for CiConfigGroup.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiConfigGroupThe item at the end of the edge.

CiConfigJobConnection

The connection type for CiConfigJob.

Fields:

NameTypeDescription
edges[CiConfigJobEdge]A list of edges.
nodes[CiConfigJob]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiConfigJobEdge

The edge type for CiConfigJob.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiConfigJobThe item at the end of the edge.

CiConfigNeedConnection

The connection type for CiConfigNeed.

Fields:

NameTypeDescription
edges[CiConfigNeedEdge]A list of edges.
nodes[CiConfigNeed]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiConfigNeedEdge

The edge type for CiConfigNeed.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiConfigNeedThe item at the end of the edge.

CiConfigStageConnection

The connection type for CiConfigStage.

Fields:

NameTypeDescription
edges[CiConfigStageEdge]A list of edges.
nodes[CiConfigStage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiConfigStageEdge

The edge type for CiConfigStage.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiConfigStageThe item at the end of the edge.

CiDedicatedHostedRunnerUsageConnection

The connection type for CiDedicatedHostedRunnerUsage.

Fields:

NameTypeDescription
edges[CiDedicatedHostedRunnerUsageEdge]A list of edges.
nodes[CiDedicatedHostedRunnerUsage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiDedicatedHostedRunnerUsageEdge

The edge type for CiDedicatedHostedRunnerUsage.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiDedicatedHostedRunnerUsageThe item at the end of the edge.

CiDeletedRunnerConnection

The connection type for CiDeletedRunner.

Fields:

NameTypeDescription
edges[CiDeletedRunnerEdge]A list of edges.
nodes[CiDeletedRunner]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiDeletedRunnerEdge

The edge type for CiDeletedRunner.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiDeletedRunnerThe item at the end of the edge.

CiGroupConnection

The connection type for CiGroup.

Fields:

NameTypeDescription
edges[CiGroupEdge]A list of edges.
nodes[CiGroup]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiGroupEdge

The edge type for CiGroup.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiGroupThe item at the end of the edge.

CiGroupEnvironmentScopeConnection

The connection type for CiGroupEnvironmentScope.

Fields:

NameTypeDescription
edges[CiGroupEnvironmentScopeEdge]A list of edges.
nodes[CiGroupEnvironmentScope]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiGroupEnvironmentScopeEdge

The edge type for CiGroupEnvironmentScope.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiGroupEnvironmentScopeThe item at the end of the edge.

CiGroupVariableConnection

The connection type for CiGroupVariable.

Fields:

NameTypeDescription
edges[CiGroupVariableEdge]A list of edges.
limitInt!Maximum amount of group CI/CD variables.
nodes[CiGroupVariable]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiGroupVariableEdge

The edge type for CiGroupVariable.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiGroupVariableThe item at the end of the edge.

CiInputsFieldConnection

The connection type for CiInputsField.

Fields:

NameTypeDescription
edges[CiInputsFieldEdge]A list of edges.
nodes[CiInputsField]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiInputsFieldEdge

The edge type for CiInputsField.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiInputsFieldThe item at the end of the edge.

CiInstanceVariableConnection

The connection type for CiInstanceVariable.

Fields:

NameTypeDescription
edges[CiInstanceVariableEdge]A list of edges.
nodes[CiInstanceVariable]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiInstanceVariableEdge

The edge type for CiInstanceVariable.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiInstanceVariableThe item at the end of the edge.

CiJobAnalyticsConnection

The connection type for CiJobAnalytics.

Fields:

NameTypeDescription
edges[CiJobAnalyticsEdge]A list of edges.
nodes[CiJobAnalytics]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiJobAnalyticsEdge

The edge type for CiJobAnalytics.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobAnalyticsThe item at the end of the edge.

CiJobArtifactConnection

The connection type for CiJobArtifact.

Fields:

NameTypeDescription
edges[CiJobArtifactEdge]A list of edges.
nodes[CiJobArtifact]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiJobArtifactEdge

The edge type for CiJobArtifact.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobArtifactThe item at the end of the edge.

CiJobConnection

The connection type for CiJob.

Fields:

NameTypeDescription
edges[CiJobEdge]A list of edges.
nodes[CiJob]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CiJobConnection.count

Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

CiJobEdge

The edge type for CiJob.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobThe item at the end of the edge.

CiJobInterfaceConnection

The connection type for CiJobInterface.

Fields:

NameTypeDescription
edges[CiJobInterfaceEdge]A list of edges.
nodes[CiJobInterface]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
CiJobInterfaceConnection.count

Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Returns Int!.

Arguments:

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

CiJobInterfaceEdge

The edge type for CiJobInterface.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobInterfaceThe item at the end of the edge.

CiJobTokenAccessibleGroupConnection

The connection type for CiJobTokenAccessibleGroup.

Fields:

NameTypeDescription
edges[CiJobTokenAccessibleGroupEdge]A list of edges.
nodes[CiJobTokenAccessibleGroup]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiJobTokenAccessibleGroupEdge

The edge type for CiJobTokenAccessibleGroup.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobTokenAccessibleGroupThe item at the end of the edge.

CiJobTokenAccessibleProjectConnection

The connection type for CiJobTokenAccessibleProject.

Fields:

NameTypeDescription
edges[CiJobTokenAccessibleProjectEdge]A list of edges.
nodes[CiJobTokenAccessibleProject]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiJobTokenAccessibleProjectEdge

The edge type for CiJobTokenAccessibleProject.

Fields:

NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobTokenAccessibleProjectThe item at the end of the edge.

CiJobTokenAuthLogConnection

The connection type for CiJobTokenAuthLog.

Fields:

NameTypeDescription
edges