Mutations are the top-level entry points for creating, updating, and deleting data in the
GitLab GraphQL API . For an introduction, see
Mutations .
Deprecated items are planned to be removed in a
future release. For more information, see the GitLab
deprecation process .
Calling a mutation You call a mutation with one argument, input. You put the mutation’s arguments inside input,
and then request the fields you want returned:
graphql
mutation ( $id : NoteableID !, $body : String !) {
# Arguments go inside `input`.
createNote ( input : { noteableId : $id , body : $body }) {
# Request the fields you want returned.
note {
id
body
}
errors
}
} Each mutation lists:
Input type : The type of input. You need it when you pass all of the arguments as one
variable, for example mutation($input: CreateNoteInput!) { createNote(input: $input) { errors } }.Arguments : What you can put inside input. An argument whose type ends in ! is required,
unless it has a default value.Fields : What you can request in the result. Every mutation returns errors, a list of
error messages. Always request errors so you can see why a mutation failed.clientMutationIdEvery mutation also accepts an optional clientMutationId argument of type String, and returns
the same value in its result. Use it to match each response to its request. It works the same way
for every mutation, so it is not listed with each mutation’s arguments and fields.
achievementsAwardInput type: AchievementsAwardInput
Arguments Name Type Description achievementIdAchievementsAchievementID!Global ID of the achievement being awarded. awardMessageStringMessage to associate with the awarded achievement. userIdUserID!Global ID of the user being awarded the achievement.
Fields achievementsCreateInput type: AchievementsCreateInput
Arguments Name Type Description avatarUploadAvatar for the achievement. descriptionStringDescription of or notes for the achievement. nameString!Name for the achievement. namespaceIdNamespaceID!Namespace for the achievement.
Fields Name Type Description achievementAchievementAchievement created. errors[String!]!Errors encountered during the mutation.
achievementsDeleteInput type: AchievementsDeleteInput
Arguments Fields Name Type Description achievementAchievementAchievement. errors[String!]!Errors encountered during the mutation.
achievementsRevokeInput type: AchievementsRevokeInput
Arguments Fields achievementsUpdateInput type: AchievementsUpdateInput
Arguments Name Type Description achievementIdAchievementsAchievementID!Global ID of the achievement being updated. avatarUploadAvatar for the achievement. descriptionStringDescription of or notes for the achievement. nameStringName for the achievement.
Fields Name Type Description achievementAchievementAchievement. errors[String!]!Errors encountered during the mutation.
addProjectToSecurityDashboardInput type: AddProjectToSecurityDashboardInput
Arguments Name Type Description idProjectID!ID of the project to be added to Instance Security Dashboard.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectProject that was added to the Instance Security Dashboard.
adminClearDuoAvailabilityClears an admin-locked GitLab Duo availability override from a group.
Input type: AdminClearDuoAvailabilityInput
Arguments Name Type Description groupIdGroupID!Group to clear the GitLab Duo availability override from.
Fields Name Type Description adminLockedBooleanWhether the group has an admin-locked GitLab Duo availability override. availabilityDuoAvailabilityResolved GitLab Duo availability for the group after the override is cleared. errors[String!]!Errors encountered during the mutation.
adminRolesLdapSyncInput type: AdminRolesLdapSyncInput
Fields Name Type Description errors[String!]Errors encountered during operation. successBooleanWhether the sync was successfully enqueued.
adminSetDuoAvailabilitySets an admin-locked GitLab Duo availability override on a group.
Input type: AdminSetDuoAvailabilityInput
Arguments Name Type Description Default availabilityDuoAvailability!GitLab Duo availability state to lock on the group. clearDescendantsBooleanClear conflicting admin-locked overrides on descendant groups instead of rejecting. falsegroupIdGroupID!Group to set the GitLab Duo availability override on.
Fields Name Type Description adminLockedBooleanWhether the group has an admin-locked GitLab Duo availability override. affectedAdminLockedDescendantsAdminDuoAvailabilityLockedAncestorConnectionDescendant groups with admin-locked overrides that must be cleared before this override can be applied. Present only when clearDescendants was false; the override was not applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last. availabilityDuoAvailabilityResolved GitLab Duo availability for the group after 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.
adminSidekiqQueuesDeleteJobsInput type: AdminSidekiqQueuesDeleteJobsInput
Arguments Name Type Description 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. clientNameStringDelete jobs matching client_name in the context metadata. clientTypeStringDelete jobs matching client_type in the context metadata. clientVersionStringDelete jobs matching client_version in the context metadata. featureCategoryStringDelete jobs matching feature_category in the context metadata. glRootNamespaceIdStringDelete jobs matching gl_root_namespace_id 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 Name Type Description errors[String!]!Errors encountered during the mutation. resultDeleteJobsResponseInformation about the status of the deletion request.
aiActionInput type: AiActionInput
Arguments Fields aiCatalogAgentCreateInput type: AiCatalogAgentCreateInput
Arguments Fields aiCatalogAgentDeleteInput type: AiCatalogAgentDeleteInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. successBoolean!Returns true if catalog Agent was successfully deleted.
aiCatalogAgentUpdateInput type: AiCatalogAgentUpdateInput
Arguments Fields aiCatalogFlowCreateInput type: AiCatalogFlowCreateInput
Arguments Name Type Description definitionStringYAML definition for the flow. descriptionString!Description for the flow. nameString!Name for the flow. projectIdProjectID!Project for the flow. publicBooleanDeprecated in GitLab 19.2. Use visibility. releaseBooleanWhether to release the latest version of the flow. visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.
Fields aiCatalogFlowDeleteInput type: AiCatalogFlowDeleteInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. successBoolean!Returns true if catalog flow was successfully deleted.
aiCatalogFlowUpdateInput type: AiCatalogFlowUpdateInput
Arguments Name Type Description definitionStringYAML definition for the Flow. descriptionStringDescription for the flow. idAiCatalogItemID!Global ID of the catalog flow to update. nameStringName for the flow. publicBooleanDeprecated in GitLab 19.2. Use visibility. releaseBooleanWhether to release the latest version of the flow. versionBumpAiCatalogVersionBumpBump version, calculated from the last released version name. visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.
Fields aiCatalogItemConsumerBulkCreateInput type: AiCatalogItemConsumerBulkCreateInput
Arguments Name Type Description 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). triggerConditionsAiCatalogTriggerConditionsInputIntroduced as an experiment in GitLab 19.3. triggerFilterJSONDeprecated in GitLab 19.3. Use triggerConditions. triggerGoalsJSONIntroduced as an experiment in GitLab 19.5. triggerTypes[String!]List of event types to create AI Catalog triggers for.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
aiCatalogItemConsumerCreateInput type: AiCatalogItemConsumerCreateInput
Arguments Name Type Description Default consumerKindAiCatalogItemConsumerKindType of item configuration. INHERITANCE is only valid for a top-level group target. DIRECTitemIdAiCatalogItemID!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. replaceExistingDirectConfigurationsBooleanConfirm replacement of a group configuration, and any project configurations, for this item when inheritance is turned on. Required when the item is already configured for the group. targetItemConsumerTargetInput!Target project or top-level group in which the catalog item is configured. triggerConditionsAiCatalogTriggerConditionsInputIntroduced as an experiment in GitLab 19.3. triggerFilterJSONDeprecated in GitLab 19.3. Use triggerConditions. triggerGoalsJSONIntroduced as an experiment in GitLab 19.5. triggerTypes[String!]List of event types to create AI Catalog triggers for (values can be mention, assign or assign_reviewer).
Fields Name Type Description errors[String!]!Errors encountered during the mutation. itemConsumerAiCatalogItemConsumerItem configuration created. warnings[String!]!Non-fatal problems encountered while configuring the item. The configuration was still created.
aiCatalogItemConsumerDeleteInput type: AiCatalogItemConsumerDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. successBoolean!Returns true if catalog item consumer was successfully deleted.
aiCatalogItemConsumerUpdateInput type: AiCatalogItemConsumerUpdateInput
Arguments Name Type Description idAiCatalogItemConsumerID!Global ID of the catalog item consumer to update. pinnedVersionAiCatalogPinnedVersionVersion the item is pinned to, in the format n.n.n. pinnedVersionPrefixAiCatalogPinnedVersionDeprecated 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 aiCatalogItemReportInput type: AiCatalogItemReportInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
aiCatalogItemStarInput type: AiCatalogItemStarInput
Arguments Name Type Description idAiCatalogItemID!Global ID of the catalog item to star or unstar. starredBoolean!Indicates whether to star or unstar the catalog item.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. starCountInt!Number of stars for the catalog item.
aiCatalogItemVersionRestoreInput type: AiCatalogItemVersionRestoreInput
Arguments Name Type Description Default deprecateCurrentBooleanWhether to mark the current latest version as deprecated. falseidAiCatalogItemVersionID!Global ID of the item version to restore from.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. itemVersionAiCatalogItemVersionNewly created item version restored from the source version.
aiCatalogMcpServerCreateInput type: AiCatalogMcpServerCreateInput
Arguments Fields aiCatalogMcpServerSetBlockBlocks or allows an external MCP server for a group or project (kill-switch).
Input type: AiCatalogMcpServerSetBlockInput
Arguments Name Type Description blockedBoolean!Set to true to block the MCP server, false to allow it. 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 Name Type Description errors[String!]!Errors encountered during the mutation. mcpServerAiCatalogMcpServerMCP server with its updated block status.
aiCatalogMcpServerUpdateInput type: AiCatalogMcpServerUpdateInput
Arguments Fields aiCatalogThirdPartyFlowCreateInput type: AiCatalogThirdPartyFlowCreateInput
Arguments Name Type Description definitionString!YAML definition for the Flow. descriptionString!Description for the Flow. nameString!Name for the Flow. projectIdProjectID!Project for the Flow. publicBooleanDeprecated in GitLab 19.2. Use visibility. releaseBooleanWhether to release the latest version of the Flow. visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.
Fields aiCatalogThirdPartyFlowDeleteInput type: AiCatalogThirdPartyFlowDeleteInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. successBoolean!Returns true if catalog Third Party Flow was successfully deleted.
aiCatalogThirdPartyFlowUpdateInput type: AiCatalogThirdPartyFlowUpdateInput
Arguments Name Type Description definitionStringYAML definition for the Flow. descriptionStringDescription for the Flow. idAiCatalogItemID!Global ID of the catalog Flow to update. nameStringName for the Flow. publicBooleanDeprecated in GitLab 19.2. Use visibility. releaseBooleanWhether to release the latest version of the Flow. versionBumpAiCatalogVersionBumpBump version, calculated from the last released version name. visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.
Fields aiDomainSettingsInstanceUpdateAdds or removes domains from the allowed or denied list for flows running in a sandboxed environment.
Input type: AiDomainSettingsInstanceUpdateInput
Arguments Fields Name Type Description addedDomains[String!]Domains that were added in the operation. errors[String!]!Errors encountered during the mutation. removedDomains[String!]Domains that were removed in the operation.
aiDomainSettingsNamespaceUpdateAdds or removes domains from the allowed or denied list for flows running in a sandboxed environment.
Input type: AiDomainSettingsNamespaceUpdateInput
Arguments Fields Name Type Description addedDomains[String!]Domains that were added in the operation. errors[String!]!Errors encountered during the mutation. removedDomains[String!]Domains that were removed in the operation.
aiDuoWorkflowCreateInput type: AiDuoWorkflowCreateInput
Arguments Name Type Description 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. 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 Name Type Description errors[String!]!Errors encountered during the creation process. workflowDuoWorkflowCreated workflow.
aiFeatureSettingModelAllowlistUpdateUpdates the instance-level model selection allowlist for an AI feature.
Input type: AiFeatureSettingModelAllowlistUpdateInput
Arguments Name Type Description 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. featureAiFeatures!AI feature whose model allowlist is being configured.
Fields aiFeatureSettingUpdateUpdates or creates settings for AI features.
Input type: AiFeatureSettingUpdateInput
Arguments Name Type Description aiSelfHostedModelIdAiSelfHostedModelIDGlobal ID of the self-hosted model providing the AI setting. 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 Name Type Description aiFeatureSettings[AiFeatureSetting!]!List of AI feature settings after mutation. errors[String!]!Errors encountered during the mutation.
aiFlowScheduleCreateInput type: AiFlowScheduleCreateInput
Arguments Name Type Description Default activeBooleanIndicates whether the schedule should be active. truecronString!Cron expression defining the schedule frequency. cronTimezoneString!IANA timezone for the cron expression. descriptionString!Description of the schedule. flowTriggerIdAiFlowTriggerID!Global ID of the flow trigger to schedule.
Fields aiFlowScheduleDeleteInput type: AiFlowScheduleDeleteInput
Arguments Fields aiFlowScheduleUpdateInput type: AiFlowScheduleUpdateInput
Arguments Name Type Description activeBooleanIndicates whether the schedule should be active. cronStringCron expression defining the schedule frequency. cronTimezoneStringIANA timezone for the cron expression. descriptionStringDescription of the schedule. idAiFlowScheduleID!Global ID of the flow schedule to update.
Fields aiFlowTriggerCreateInput type: AiFlowTriggerCreateInput
Arguments Name Type Description activeBooleanIntroduced as an experiment in GitLab 19.4. aiCatalogItemConsumerIdAiCatalogItemConsumerIDAI catalog item consumer to use instead of config_path. 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. filterJSONIntroduced as an experiment in GitLab 19.0. goalsJSONIntroduced as an experiment in GitLab 19.5. projectPathID!Full path of the project the AI flow trigger is associated with. userIdUserIDService account for the AI flow trigger.
Fields aiFlowTriggerDeleteInput type: AiFlowTriggerDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
aiFlowTriggerUpdateInput type: AiFlowTriggerUpdateInput
Arguments Name Type Description activeBooleanIntroduced as an experiment in GitLab 19.4. aiCatalogItemConsumerIdAiCatalogItemConsumerIDAI catalog item consumer to use instead of config_path. 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. filterJSONIntroduced as an experiment in GitLab 18.11. goalsJSONIntroduced as an experiment in GitLab 19.5. idAiFlowTriggerID!ID of the flow trigger to update. userIdUserIDService account for the AI flow trigger.
Fields aiModelSelectionNamespaceModelAllowlistUpdateUpdates the namespace-level model selection allowlist for an AI feature.
Input type: AiModelSelectionNamespaceModelAllowlistUpdateInput
Arguments Name Type Description 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. featureAiFeatures!AI feature whose model allowlist is being configured. groupIdGroupID!Group whose model allowlist is being configured.
Fields aiModelSelectionNamespaceUpdateUpdates or creates settings for AI features for a namespace.
Input type: AiModelSelectionNamespaceUpdateInput
Arguments Name Type Description 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 aiSelfHostedModelConnectionCheckChecks if the AI Gateway can establish a connection with the given model configuration.
Input type: AiSelfHostedModelConnectionCheckInput
Arguments Name Type Description apiTokenStringAPI token to access the self-hosted model, if any. endpointStringEndpoint of the self-hosted model. iamRoleStringIAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider. 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 aiSelfHostedModelCreateInput type: AiSelfHostedModelCreateInput
Arguments Name Type Description apiTokenStringAPI token to access the self-hosted model, if any. endpointStringEndpoint of the self-hosted model. iamRoleStringIAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider. 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 Name Type Description errors[String!]!Errors encountered during the mutation. selfHostedModelAiSelfHostedModelSelf-hosted model after mutation.
aiSelfHostedModelDeleteDeletes a self-hosted model.
Input type: AiSelfHostedModelDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
aiSelfHostedModelUpdateUpdates a self-hosted model.
Input type: AiSelfHostedModelUpdateInput
Arguments Name Type Description apiTokenStringAPI token to access the self-hosted model, if any. endpointStringEndpoint of the self-hosted model. iamRoleStringIAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider. 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 Name Type Description errors[String!]!Errors encountered during the mutation. selfHostedModelAiSelfHostedModelSelf-hosted model after mutation.
alertSetAssigneesInput type: AlertSetAssigneesInput
Arguments Name Type Description assigneeUsernames[String!]!Usernames to assign to the alert. Replaces existing assignees by default. iidString!IID of the alert to mutate. operationModeMutationOperationModeOperation to perform. Defaults to REPLACE. projectPathID!Project the alert to mutate is in.
Fields alertTodoCreateInput type: AlertTodoCreateInput
Arguments Name Type Description iidString!IID of the alert to mutate. projectPathID!Project the alert to mutate is in.
Fields approvalProjectRuleDeleteInput type: approvalProjectRuleDeleteInput
Arguments Fields approvalProjectRuleUpdateInput type: approvalProjectRuleUpdateInput
Arguments Name Type Description approvalsRequiredInt!How many approvals are required to satisfy rule. 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 approveDeploymentInput type: ApproveDeploymentInput
Arguments Name Type Description 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 Name Type Description deploymentApprovalDeploymentApprovalDeploymentApproval after mutation. errors[String!]!Errors encountered during the mutation.
artifactDestroyInput type: ArtifactDestroyInput
Arguments Fields artifactRegistryActivateActivates an Artifact Registry for an organization by claiming a slug.
Input type: ArtifactRegistryActivateInput
Arguments Name Type Description slugString!Slug to claim, Artifact Registry’s immutable identifier for the namespace.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryArtifactRegistryIntroduced as an experiment in GitLab 19.4.
artifactRegistryArtifactDeleteDeletes one artifact of an Artifact Registry repository. Permanently deletes a published artifact on a hosted repository and evicts a cached artifact on a remote repository, following the kind of the repository addressed. Artifact Registry accepts the request rather than completing it, so the mutation reports acceptance rather than completion. Re-read the artifact list to see the result.
Input type: ArtifactRegistryArtifactDeleteInput
Arguments Name Type Description idID!ID of the artifact in Artifact Registry, as returned by the id field on a package or image. Not a GitLab global ID. nameString!Name of the repository holding the artifact, unique within the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. repositoryArtifactRegistryRepositoryRepository holding the deleted artifact. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.
artifactRegistryContainerTagDeleteDeletes a container tag, identified by its name. Applies only to container repositories in Docker or OCI format. This mutation never reads the repository kind. Artifact Registry decides the outcome from its own records. On a hosted repository, deletion permanently removes the tag. On a remote repository, it evicts the cached tag reference. On a virtual repository, the request is passed through for Artifact Registry to decide. Deleting a tag never removes the manifest it pointed at. Artifact Registry accepts the request rather than completing it, so this mutation reports acceptance, not completion.
Input type: ArtifactRegistryContainerTagDeleteInput
Arguments Name Type Description imageIdID!ID of the image holding the tag in Artifact Registry, as returned by the id field on an image. Not a GitLab global ID. nameString!Name of the repository holding the tag, unique within the organization. tagNameString!Name of the tag to delete. Limited to 1024 characters.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. repositoryArtifactRegistryRepositoryRepository holding the deleted tag. A tag delete moves no repository counter. Null when the deletion was not accepted.
artifactRegistryDisableDisables Artifact Registry for the organization resolved from the request context (the X-GitLab-Organization-ID header, or the user default organization).
Input type: ArtifactRegistryDisableInput
Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryArtifactRegistryRegistry after the transition. Null when the transition was rejected, for example an unknown namespace.
artifactRegistryEnableEnables Artifact Registry for the organization resolved from the request context (the X-GitLab-Organization-ID header, or the user default organization).
Input type: ArtifactRegistryEnableInput
Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryArtifactRegistryRegistry after the transition. Null when the transition was rejected, for example an unknown namespace.
artifactRegistryManifestDeleteDeletes a manifest, identified by its digest. Applies only to Docker or OCI container repositories, whose kind this mutation never reads. Artifact Registry decides the outcome from its records, permanently removing the manifest on a hosted repository, evicting the cached copy on a remote one, or passing the request through on a virtual one. Deleting a manifest removes tags pointing at it and index entries where it is the parent, though a manifest it indexed survives untagged. Artifact Registry accepts rather than completes the request, so this reports acceptance. Re-read the image’s manifests afterward for the result. Deletion is refused if another manifest indexes the target as a child, and the error lists at most 10 blocking digests plus the total count.
Input type: ArtifactRegistryManifestDeleteInput
Arguments Name Type Description digestString!Content-addressable digest of the manifest, as returned by the digest field on a manifest. Limited to 512 characters. imageIdID!ID of the image holding the manifest in Artifact Registry, as returned by the id field on an image. Not a GitLab global ID. nameString!Name of the repository holding the manifest, unique within the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. repositoryArtifactRegistryRepositoryRepository holding the deleted manifest. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not accepted.
artifactRegistryNpmDistTagDeleteDeletes one dist-tag of an npm package in an Artifact Registry repository, addressed by its Artifact Registry ID. Applies to npm repositories only. A non-npm repository is refused before any request reaches Artifact Registry, and the refusal appears in the payload errors. A remote repository is refused the same way, because Artifact Registry holds the dist-tags of a remote repository as a rewritten document rather than as individually addressable rows, so there is no dist-tag row to delete. Removes the dist-tag alone, never the version it named. The mutation reports acceptance rather than completion.
Input type: ArtifactRegistryNpmDistTagDeleteInput
Arguments Name Type Description idID!ID of the dist-tag in Artifact Registry. Not a GitLab global ID. nameString!Name of the repository holding the dist-tag, unique within the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. repositoryArtifactRegistryRepositoryRepository holding the deleted dist-tag. A dist-tag delete moves no repository counter. Null when the deletion was not accepted.
artifactRegistryRepositoryArtifactsDeleteDeletes every artifact of an Artifact Registry repository. Permanently deletes published artifacts on a hosted repository and evicts cached artifacts on a remote repository, following the kind of the repository addressed. Artifact Registry accepts the request rather than completing it, so the mutation reports acceptance rather than completion. Re-read the artifact list to see the result.
Input type: ArtifactRegistryRepositoryArtifactsDeleteInput
Arguments Name Type Description nameString!Name of the repository whose artifacts are deleted, unique within the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. repositoryArtifactRegistryRepositoryRepository the deletion targeted. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.
artifactRegistryRepositoryCreateCreates a repository in Artifact Registry.
Input type: ArtifactRegistryRepositoryCreateInput
Arguments Name Type Description 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. settingsArtifactRegistryRemoteSettingsInputIntroduced as an experiment in GitLab 19.4. upstreamRepositoryIds[ID!]Introduced as an experiment in GitLab 19.5. visibilityArtifactRegistryRepositoryVisibilityWho can read the repository.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. refusedUpstreamRepositoryIdIDIntroduced as an experiment in GitLab 19.5. repositoryArtifactRegistryRepositoryRepository created. Null when the creation was not applied.
artifactRegistryRepositoryDeleteDeletes a repository in Artifact Registry and removes every artifact it holds. Deleting an already-absent repository still succeeds.
Input type: ArtifactRegistryRepositoryDeleteInput
Arguments Name Type Description nameString!Name of the repository to delete, unique within the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
artifactRegistryRepositoryTestConnectionTests the upstream connection of a remote repository in Artifact Registry.
Input type: ArtifactRegistryRepositoryTestConnectionInput
Arguments Name Type Description nameString!Name of the repository to test, unique within the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. httpStatusIntStatus the upstream answered the probe with. Null when the probe failed in transport and no response arrived, and when no probe ran. lastHealthCheckedAtTimeTimestamp of the most recent health probe of the upstream, as it reads after this probe. Null when no verdict is recorded, including when this probe’s own write did not land. lastHealthStatusArtifactRegistryHealthStatusStored health verdict as it reads after the probe. Can differ from passed, because Artifact Registry moves it to UNHEALTHY only once consecutive failures reach its threshold. UNKNOWN when no verdict is recorded, including when this probe’s own write did not land, and for a status this schema does not recognize. Null when no probe ran. passedBooleanIndicates the upstream answered the probe with a status below 500. Reports reachability rather than credential validity, so an upstream 401 or 404 passes. Null when no probe ran.
artifactRegistryRepositoryUpdateUpdates a repository in Artifact Registry. Artifact Registry writes the metadata fields and the settings in separate transactions, metadata first, so a failed update can leave a visibility or description change applied while the settings did not change. Re-sending the same mutation converges.
Input type: ArtifactRegistryRepositoryUpdateInput
Arguments Name Type Description descriptionStringHuman-readable description of the repository. nameString!Name of the repository to update, unique within the organization. Cannot be changed. settingsArtifactRegistryRemoteSettingsInputIntroduced as an experiment in GitLab 19.4. upstreamRepositoryIds[ID!]Introduced as an experiment in GitLab 19.5. visibilityArtifactRegistryRepositoryVisibilityWho can read the repository.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. refusedUpstreamRepositoryIdIDIntroduced as an experiment in GitLab 19.5. repositoryArtifactRegistryRepositoryRepository updated. Null when the update was not applied.
artifactRegistryRoleBulkGrantGrants Artifact Registry roles to users on resources in a single all-or-nothing operation. Replaces any role a user already holds on that resource.
Input type: ArtifactRegistryRoleBulkGrantInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. grantedRoleCountIntNumber of role assignments granted. Present only on success.
artifactRegistryRoleBulkRevokeRevokes Artifact Registry roles from users on resources in a single all-or-nothing operation. Users can revoke their own role.
Input type: ArtifactRegistryRoleBulkRevokeInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. revokedRoleCountIntNumber of role assignments revoked. Present only on success.
artifactRegistryRoleGrantGrants an Artifact Registry role to a user on a resource. Replaces any role the user already holds on that resource.
Input type: ArtifactRegistryRoleGrantInput
Arguments Name Type Description assigneeIdUserID!Global ID of the user to grant the role to. resourceIdString!UUID of the Artifact Registry resource (repository or namespace) the role applies to. roleArtifactRegistryRole!Artifact Registry role to grant.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
artifactRegistryRoleRevokeRevokes a user’s Artifact Registry role on a resource. Names no role: a user holds one role per resource, and revoking removes it. Users can revoke their own role.
Input type: ArtifactRegistryRoleRevokeInput
Arguments Name Type Description assigneeIdUserID!Global ID of the user to revoke the role from. resourceIdString!UUID of the Artifact Registry resource (repository or namespace) the role is assigned on.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
artifactRegistryUpstreamRepositoryDissociateRemoves an upstream repository association from a virtual repository in Artifact Registry. The upstream repository and its artifacts remain unchanged, and Artifact Registry compacts the remaining upstream positions. Succeeds even when the association is already gone, or the repository is missing, inaccessible, not virtual, or not of the given format.
Input type: ArtifactRegistryUpstreamRepositoryDissociateInput
Arguments Name Type Description associationIdID!ID of the upstream repository association to remove, as returned by the id field on an upstream repository association. Not a GitLab global ID. formatArtifactRegistryRepositoryFormat!Package format of the virtual repository. nameString!Name of the virtual repository holding the upstream repository, unique within the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
artifactRegistryUpstreamTestConnectionTests a supplied upstream connection for the remote repository create form in Artifact Registry, before any repository exists to hold it.
Input type: ArtifactRegistryUpstreamTestConnectionInput
Arguments Name Type Description credentialsArtifactRegistryRemoteCredentialsInputUpstream credentials to probe with. Omit or pass null to probe unauthenticated. Accepted for every format, but ignored when probing a container upstream (docker or oci), whose probe is always unauthenticated. formatArtifactRegistryRepositoryFormat!Package format of the upstream to probe. Decides the credential shape and the probe auth. urlString!Base URL of the upstream to probe.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. httpStatusIntStatus the upstream answered the probe with. Null when the probe failed in transport and no response arrived, and when no probe ran. passedBooleanIndicates the upstream answered the probe with a status below 500. Reports reachability rather than credential validity, so an upstream 401 or 404 passes. Null when no probe ran.
artifactRegistryVersionDeleteDeletes one version of a package in an Artifact Registry repository. Permanently deletes a published version on a hosted repository and evicts a cached version on a remote repository, following the kind of the repository addressed. Artifact Registry accepts the request rather than completing it, so the mutation reports acceptance rather than completion. Re-read the version list to see the result. Applies to Maven and npm repositories only.
Input type: ArtifactRegistryVersionDeleteInput
Arguments Name Type Description idID!ID of the version in Artifact Registry, as returned by the id field on a version. Not a GitLab global ID. nameString!Name of the repository holding the version, unique within the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. repositoryArtifactRegistryRepositoryRepository holding the deleted version. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.
ascpComponentCreateInput type: AscpComponentCreateInput
Arguments Name Type Description 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 ascpScanCreateInput type: AscpScanCreateInput
Arguments Name Type Description Default baseCommitShaStringBase commit SHA for incremental scans. baseScanIdSecurityAscpScanIDID of the base scan for incremental scans. commitShaString!Git commit SHA that was scanned. projectPathID!Full path of the project. scanTypeAscpScanTypeType of scan (default: full). FULL
Fields Name Type Description errors[String!]!Errors encountered during the mutation. scanAscpScanIntroduced as an experiment in GitLab 18.10.
ascpSecurityContextCreateInput type: AscpSecurityContextCreateInput
Arguments Fields auditEventsAmazonS3ConfigurationCreateDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsCreate with amazonS3 category instead.
Input type: AuditEventsAmazonS3ConfigurationCreateInput
Arguments Name Type Description 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. groupPathID!Group path. nameStringDestination name. secretAccessKeyString!Secret access key of the Amazon S3 account.
Fields auditEventsAmazonS3ConfigurationDeleteDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.
Input type: AuditEventsAmazonS3ConfigurationDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
auditEventsAmazonS3ConfigurationUpdateDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.
Input type: AuditEventsAmazonS3ConfigurationUpdateInput
Arguments Name Type Description 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. idAuditEventsAmazonS3ConfigurationID!ID of the Amazon S3 configuration to update. nameStringDestination name. secretAccessKeyStringSecret access key of the Amazon S3 account.
Fields auditEventsGroupDestinationDenylistEventsAddInput type: AuditEventsGroupDestinationDenylistEventsAddInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. eventTypeFilters[String!]List of denylisted event type filters for the audit event external destination.
auditEventsGroupDestinationDenylistEventsDeleteInput type: AuditEventsGroupDestinationDenylistEventsDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
auditEventsGroupDestinationEventsAddInput type: AuditEventsGroupDestinationEventsAddInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. eventTypeFilters[String!]List of event type filters for the audit event external destination.
auditEventsGroupDestinationEventsDeleteInput type: AuditEventsGroupDestinationEventsDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
auditEventsGroupDestinationNamespaceFilterCreateInput type: AuditEventsGroupDestinationNamespaceFilterCreateInput
Arguments Fields auditEventsGroupDestinationNamespaceFilterDeleteInput type: AuditEventsGroupDestinationNamespaceFilterDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
auditEventsInstanceAmazonS3ConfigurationCreateDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsCreate with amazonS3 category instead.
Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput
Arguments Name Type Description 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. nameStringDestination name. secretAccessKeyString!Secret access key of the Amazon S3 account.
Fields auditEventsInstanceAmazonS3ConfigurationDeleteDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.
Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
auditEventsInstanceAmazonS3ConfigurationUpdateDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.
Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput
Arguments Name Type Description 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. idAuditEventsInstanceAmazonS3ConfigurationID!ID of the instance-level Amazon S3 configuration to update. nameStringDestination name. secretAccessKeyStringSecret access key of the Amazon S3 account.
Fields auditEventsInstanceDestinationEventsAddInput type: AuditEventsInstanceDestinationEventsAddInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. eventTypeFilters[String!]List of event type filters for the audit event external destination.
auditEventsInstanceDestinationEventsDeleteInput type: AuditEventsInstanceDestinationEventsDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
auditEventsInstanceDestinationNamespaceFilterCreateInput type: AuditEventsInstanceDestinationNamespaceFilterCreateInput
Arguments Fields auditEventsInstanceDestinationNamespaceFilterDeleteInput type: AuditEventsInstanceDestinationNamespaceFilterDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
auditEventsStreamingDestinationEventsAddDeprecated in GitLab 18.10. Use auditEventsGroupDestinationEventsAdd instead.
Input type: AuditEventsStreamingDestinationEventsAddInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. eventTypeFilters[String!]List of event type filters for the audit event external destination.
auditEventsStreamingDestinationEventsRemoveDeprecated in GitLab 18.10. Use auditEventsGroupDestinationEventsRemove instead.
Input type: AuditEventsStreamingDestinationEventsRemoveInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
auditEventsStreamingDestinationInstanceEventsAddDeprecated in GitLab 18.10. Use auditEventsInstanceDestinationEventsAdd instead.
Input type: AuditEventsStreamingDestinationInstanceEventsAddInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. eventTypeFilters[String!]List of event type filters for the audit event external destination.
auditEventsStreamingDestinationInstanceEventsRemoveDeprecated in GitLab 18.10. Use auditEventsInstanceDestinationEventsRemove instead.
Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
Deprecated in GitLab 18.10. Configure headers by using the streaming destination configuration. Use groupAuditEventStreamingDestinationsUpdate.
Input type: AuditEventsStreamingHeadersCreateInput
Arguments Fields Deprecated in GitLab 18.10. Configure headers by using the streaming destination configuration. Use groupAuditEventStreamingDestinationsUpdate.
Input type: AuditEventsStreamingHeadersDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
Deprecated in GitLab 18.10. Configure headers by using the streaming destination configuration. Use groupAuditEventStreamingDestinationsUpdate.
Input type: AuditEventsStreamingHeadersUpdateInput
Arguments Fields auditEventsStreamingHttpNamespaceFiltersAddDeprecated in GitLab 18.10. Use auditEventsGroupDestinationNamespaceFilterCreate instead.
Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput
Arguments Fields auditEventsStreamingHttpNamespaceFiltersDeleteDeprecated in GitLab 18.10. Use auditEventsGroupDestinationNamespaceFilterDelete instead.
Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
Deprecated in GitLab 18.10. Configure headers by using the streaming destination configuration. Use instanceAuditEventStreamingDestinationsUpdate.
Input type: AuditEventsStreamingInstanceHeadersCreateInput
Arguments Fields Deprecated in GitLab 18.10. Configure headers by using the streaming destination configuration. Use instanceAuditEventStreamingDestinationsUpdate.
Input type: AuditEventsStreamingInstanceHeadersDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
Deprecated in GitLab 18.10. Configure headers by using the streaming destination configuration. Use instanceAuditEventStreamingDestinationsUpdate.
Input type: AuditEventsStreamingInstanceHeadersUpdateInput
Arguments Fields awardEmojiAddInput type: AwardEmojiAddInput
Arguments Name Type Description awardableIdAwardableID!Global ID of the awardable resource. nameString!Emoji name.
Fields Name Type Description awardEmojiAwardEmojiEmoji reactions after mutation. errors[String!]!Errors encountered during the mutation.
awardEmojiRemoveInput type: AwardEmojiRemoveInput
Arguments Name Type Description awardableIdAwardableID!Global ID of the awardable resource. nameString!Emoji name.
Fields Name Type Description awardEmojiAwardEmojiEmoji reactions after mutation. errors[String!]!Errors encountered during the mutation.
awardEmojiToggleInput type: AwardEmojiToggleInput
Arguments Name Type Description awardableIdAwardableID!Global ID of the awardable resource. nameString!Emoji name.
Fields Name Type Description awardEmojiAwardEmojiEmoji reactions after 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.
boardEpicCreateDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: BoardEpicCreateInput
Arguments Name Type Description boardIdBoardsEpicBoardID!Global ID of the board that the epic is in. 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 Name Type Description epicEpicEpic after creation. errors[String!]!Errors encountered during the mutation.
boardListCreateInput type: BoardListCreateInput
Arguments Name Type Description assigneeIdUserIDGlobal ID of an existing user. backlogBooleanCreate the backlog list. boardIdBoardID!Global ID of the issue board to mutate. iterationIdIterationIDGlobal ID of an existing iteration. labelIdLabelIDGlobal ID of an existing label. milestoneIdMilestoneIDGlobal ID of an existing milestone. positionIntPosition of the list. statusIdWorkItemsStatusesStatusIDIntroduced as an experiment in GitLab 18.0.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. listBoardListIssue list in the issue board.
boardListUpdateLimitMetricsInput type: BoardListUpdateLimitMetricsInput
Arguments Name Type Description limitMetricListLimitMetricNew limit metric type for the list. listIdListID!Global ID of the list. maxIssueCountIntNew maximum issue count limit. maxIssueWeightIntNew maximum issue weight limit.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. listBoardListUpdated list.
branchDeleteInput type: BranchDeleteInput
Arguments Name Type Description nameString!Name of the branch. projectPathID!Project full path the branch is associated with.
Fields Name Type Description branchBranchBranch after mutation. errors[String!]!Errors encountered during the mutation.
branchRuleApprovalProjectRuleCreateInput type: branchRuleApprovalProjectRuleCreateInput
Arguments Name Type Description approvalsRequiredInt!How many approvals are required to satisfy rule. branchRuleIdProjectsBranchRuleID!Global ID of the branch rule to destroy. 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 branchRuleCreateInput type: BranchRuleCreateInput
Arguments Name Type Description nameString!Branch name, with wildcards, for the branch rules. projectPathID!Full path to the project that the branch is associated with.
Fields Name Type Description branchRuleBranchRuleBranch rule after mutation. errors[String!]!Errors encountered during the mutation.
branchRuleDeleteInput type: BranchRuleDeleteInput
Arguments Fields Name Type Description branchRuleBranchRuleBranch rule after mutation. errors[String!]!Errors encountered during the mutation.
branchRuleExternalStatusCheckCreateCreate a new external status check from a branch rule.
Input type: BranchRuleExternalStatusCheckCreateInput
Arguments Name Type Description branchRuleIdProjectsBranchRuleID!Global ID of the branch rule to update. externalUrlString!URL of external status check resource. nameString!Name of the external status check. sharedSecretStringHMAC shared secret for authenticating external status check requests.
Fields branchRuleExternalStatusCheckDestroyDestroy an external status check from a branch rule.
Input type: BranchRuleExternalStatusCheckDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
branchRuleExternalStatusCheckUpdateUpdate an external status check from a branch rule.
Input type: BranchRuleExternalStatusCheckUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. externalStatusCheckExternalStatusCheckUpdated external status check after mutation.
branchRuleSquashOptionCreateCreate a squash option for a branch rule.
Input type: BranchRuleSquashOptionCreateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. squashOptionSquashOptionCreated squash option after mutation.
branchRuleSquashOptionDeleteDelete a squash option for a branch rule.
Input type: BranchRuleSquashOptionDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
branchRuleSquashOptionUpdateUpdate a squash option for a branch rule.
Input type: BranchRuleSquashOptionUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. squashOptionSquashOptionUpdated squash option after mutation.
branchRuleUpdateInput type: BranchRuleUpdateInput
Arguments Fields Name Type Description branchRuleBranchRuleBranch rule after mutation. errors[String!]!Errors encountered during the mutation.
bulkDestroyJobArtifactsInput type: BulkDestroyJobArtifactsInput
Arguments Name Type Description ids[CiJobArtifactID!]!Global IDs of the job artifacts to destroy. projectIdProjectID!Global Project ID of the job artifacts to destroy. Incompatible with projectPath.
Fields Name Type Description destroyedCountIntNumber of job artifacts deleted. destroyedIds[CiJobArtifactID!]IDs of job artifacts that were deleted. errors[String!]!Errors encountered during the mutation.
bulkEnableDevopsAdoptionNamespacesStatus : Beta.
Input type: BulkEnableDevopsAdoptionNamespacesInput
Arguments Fields bulkRunnerDeleteInput type: BulkRunnerDeleteInput
Arguments Fields Name Type Description 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.
bulkSetVulnerabilityFindingsDueDatesBulk 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 Name Type Description 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 Name Type Description 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.
Bulk updates permission settings for multiple AI tool rules.
Input type: BulkUpdateAiToolRulesInput
Arguments Name Type Description 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). Each entry replaces the whole rule, so a partial entry clears the access types it omits.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. results[BulkToolRuleResult!]!Results for each tool rule update, including any per-item errors.
bulkUpdateSecurityAttributesInput type: BulkUpdateSecurityAttributesInput
Arguments Fields Name Type Description errors[String!]!Errors encountered while initiating the bulk update operation.
cancelVulnerabilityWorkflowCancels a vulnerability workflow execution.
Input type: CancelVulnerabilityWorkflowInput
Arguments Fields catalogResourcesCreateInput type: CatalogResourcesCreateInput
Arguments Name Type Description projectPathID!Project path belonging to the catalog resource.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
catalogResourcesDestroyInput type: CatalogResourcesDestroyInput
Arguments Name Type Description projectPathID!Project path belonging to the catalog resource.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
cdApplicationCreateCreates a continuous deployment application in an organization.
Input type: CdApplicationCreateInput
Arguments Fields Name Type Description applicationCdApplicationApplication created by the mutation. errors[String!]!Errors encountered during the mutation.
cdApplicationFlowDefinitionCreateCreates a new pipeline version of a continuous deployment application flow definition.
Input type: CdApplicationFlowDefinitionCreateInput
Arguments Name Type Description applicationIdCdApplicationID!Global ID of the application to create the flow definition for. definitionString!Body of the flow definition.
Fields cdApplicationLinkCreateCreates a link on a continuous deployment application.
Input type: CdApplicationLinkCreateInput
Arguments Fields Name Type Description applicationLinkCdApplicationLinkLink created by the mutation. errors[String!]!Errors encountered during the mutation.
cdApplicationLinkDeleteDeletes a link on a continuous deployment application.
Input type: CdApplicationLinkDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
cdApplicationLinkUpdateUpdates a link on a continuous deployment application.
Input type: CdApplicationLinkUpdateInput
Arguments Fields Name Type Description applicationLinkCdApplicationLinkLink updated by the mutation. errors[String!]!Errors encountered during the mutation.
cdApplicationUpdateUpdates a continuous deployment application.
Input type: CdApplicationUpdateInput
Arguments Name Type Description descriptionStringDescription of the application. idCdApplicationID!Global ID of the application to update. nameStringName of the application.
Fields Name Type Description applicationCdApplicationApplication updated by the mutation. errors[String!]!Errors encountered during the mutation.
cdArtifactSourceCreateCreates a continuous deployment artifact source for a service.
Input type: CdArtifactSourceCreateInput
Arguments Name Type Description nameString!Name of the artifact source. serviceIdCdServiceID!Global ID of the service to create the artifact source for. sourceConfigJSONConfiguration of the artifact source, defined by the consuming driver. sourceRefString!Reference of the artifact source.
Fields Name Type Description artifactSourceCdArtifactSourceArtifact source created by the mutation. errors[String!]!Errors encountered during the mutation.
cdEnvironmentCreateCreates a continuous deployment environment in an organization.
Input type: CdEnvironmentCreateInput
Arguments Fields Name Type Description environmentCdEnvironmentEnvironment created by the mutation. errors[String!]!Errors encountered during the mutation.
cdEnvironmentDriverBindingCreateCreates a new versioned driver binding for a continuous deployment environment.
Input type: CdEnvironmentDriverBindingCreateInput
Arguments Fields cdEnvironmentUpdateUpdates a continuous deployment environment.
Input type: CdEnvironmentUpdateInput
Arguments Fields Name Type Description environmentCdEnvironmentEnvironment updated by the mutation. errors[String!]!Errors encountered during the mutation.
cdRolloutCreateCreates a continuous deployment rollout in an organization.
Input type: CdRolloutCreateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. rolloutCdRolloutRollout created by the mutation.
cdRolloutGateResolveResolves an open approval gate on a continuous deployment rollout by recording the decision in the rollout transition journal.
Input type: CdRolloutGateResolveInput
Arguments Name Type Description idCdRolloutID!Global ID of the rollout whose approval gate is being resolved. resolutionReasonStringReason for the decision. statusCdRolloutGateStatus!Decision to record for the approval gate.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. rolloutTransitionCdRolloutTransitionRollout transition journal entry created by the mutation.
cdServiceCreateCreates a continuous deployment service in an application.
Input type: CdServiceCreateInput
Arguments Name Type Description applicationIdCdApplicationID!Global ID of the application to create the service in. descriptionStringDescription of the service. nameString!Name of the service.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. serviceCdServiceService created by the mutation.
cdServiceUpdateUpdates a continuous deployment service.
Input type: CdServiceUpdateInput
Arguments Name Type Description descriptionStringDescription of the service. idCdServiceID!Global ID of the service to update. nameStringName of the service.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. serviceCdServiceService updated by the mutation.
cdVersionCreateCreates a continuous deployment version from a free-text name, for artifacts GitLab did not observe being pushed.
Input type: CdVersionCreateInput
Arguments Name Type Description artifactSourceIdCdArtifactSourceID!Global ID of the artifact source to create the version for. nameString!Name of the version.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. versionCdVersionVersion created by the mutation.
cdVersionSetCreateCreates a continuous deployment version set in an application.
Input type: CdVersionSetCreateInput
Arguments Name Type Description applicationIdCdApplicationID!Global ID of the application to create the version set in. 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 Name Type Description errors[String!]!Errors encountered during the mutation. versionSetCdVersionSetVersion set created by the mutation.
ciJobTokenScopeAddGroupOrProjectInput type: CiJobTokenScopeAddGroupOrProjectInput
Arguments Name Type Description Default defaultPermissionsBooleanIntroduced as an experiment in GitLab 17.8. truejobTokenPolicies[CiJobTokenScopePolicies!]Introduced as an experiment in GitLab 17.5. []projectPathID!Project that the CI job token scope belongs to. targetPathID!Group or project to be added to the CI job token scope.
Fields ciJobTokenScopeAddProjectInput type: CiJobTokenScopeAddProjectInput
Arguments Name Type Description directionCiJobTokenScopeDirectionDeprecated 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 ciJobTokenScopeRemoveGroupInput type: CiJobTokenScopeRemoveGroupInput
Arguments Name Type Description projectPathID!Project that the CI job token scope belongs to. targetGroupPathID!Group to be removed from the CI job token scope.
Fields ciJobTokenScopeRemoveProjectInput type: CiJobTokenScopeRemoveProjectInput
Arguments Name Type Description directionCiJobTokenScopeDirectionDeprecated 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 ciJobTokenScopeUpdatePoliciesInput type: CiJobTokenScopeUpdatePoliciesInput
Arguments Name Type Description 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 ciLintLinted and processed contents of a CI config.
Should not be requested more than once per request.
Input type: CiLintInput
Arguments Name Type Description 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 Name Type Description configCiConfigV2Linted CI config and metadata. errors[String!]!Errors encountered during the mutation.
clusterAgentDeleteInput type: ClusterAgentDeleteInput
Arguments Name Type Description idClustersAgentID!Global ID of the cluster agent that will be deleted.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
clusterAgentTokenCreateInput type: ClusterAgentTokenCreateInput
Arguments Name Type Description 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 Name Type Description 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.
clusterAgentTokenRevokeInput type: ClusterAgentTokenRevokeInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
clusterAgentUrlConfigurationCreateInput type: ClusterAgentUrlConfigurationCreateInput
Arguments Name Type Description 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. 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 clusterAgentUrlConfigurationDeleteInput type: ClusterAgentUrlConfigurationDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
commitCreateInput type: CommitCreateInput
Arguments Name Type Description Default actions[CommitAction!]Array of action hashes to commit as a batch. []allowEmptyBooleanIndicates whether an empty commit can be created. Defaults to false. falsebranchString!Name of the branch to commit into, it can be a new branch. messageString!Raw commit message. projectPathID!Project full path the branch is associated with. startBranchStringIf on a new branch, name of the original branch. startProjectPathIDFull path of the project to start the commit from. Must be the project itself or a project it was forked from. startShaStringSHA of the commit to start the new branch from. Mutually exclusive with startBranch.
Fields Name Type Description commitCommitCommit after mutation. commitPipelinePathStringETag path for the commit’s pipeline. content[String!]Contents of the commit. errors[String!]!Errors encountered during the mutation.
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 Name Type Description projectPathID!Full path of the project.
Fields Name Type Description branchStringBranch that has the new/modified .gitlab-ci.yml file. errors[String!]!Errors encountered during the mutation. successPathStringRedirect path to use when the response is successful.
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 Name Type Description projectPathID!Full path of the project.
Fields Name Type Description branchStringBranch that has the new/modified .gitlab-ci.yml file. errors[String!]!Errors encountered during the mutation. successPathStringRedirect path to use when the response is successful.
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 Fields Name Type Description branchStringBranch that has the new/modified .gitlab-ci.yml file. errors[String!]!Errors encountered during the mutation. successPathStringRedirect path to use when the response is successful.
Enable SAST IaC for a project in a new or
modified .gitlab-ci.yml file in a new branch. The new
branch and a URL to create a merge request are a part of the
response.
Input type: ConfigureSastIacInput
Arguments Name Type Description projectPathID!Full path of the project.
Fields Name Type Description branchStringBranch that has the new/modified .gitlab-ci.yml file. errors[String!]!Errors encountered during the mutation. successPathStringRedirect path to use when the response is successful.
Configure secret detection for a project by enabling secret detection
in a new or modified .gitlab-ci.yml file in a new branch. The new
branch and a URL to create a merge request are a part of the
response.
Input type: ConfigureSecretDetectionInput
Arguments Name Type Description projectPathID!Full path of the project.
Fields Name Type Description branchStringBranch that has the new/modified .gitlab-ci.yml file. errors[String!]!Errors encountered during the mutation. successPathStringRedirect path to use when the response is successful.
containerCacheEntryDeleteInput type: ContainerCacheEntryDeleteInput
Arguments Name Type Description idString!ID of the cache entry.
Fields containerUpstreamCacheDeleteInput type: ContainerUpstreamCacheDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. upstreamContainerUpstreamContainer virtual registry upstream.
containerUpstreamCreateInput type: ContainerUpstreamCreateInput
Arguments Name Type Description Default cacheValidityHoursIntCache validity period. Defaults to 24 hours. 24descriptionStringDescription 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 containerUpstreamDeleteInput type: ContainerUpstreamDeleteInput
Arguments Fields containerUpstreamTestInput type: ContainerUpstreamTestInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. successBoolean!Whether the upstream connectivity test was successful.
containerUpstreamUpdateInput type: ContainerUpstreamUpdateInput
Arguments Name Type Description cacheValidityHoursIntCache validity period. 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 containerVirtualRegistryCacheDeleteInput type: ContainerVirtualRegistryCacheDeleteInput
Arguments Fields containerVirtualRegistryCreateInput type: ContainerVirtualRegistryCreateInput
Arguments Name Type Description descriptionStringDescription of the virtual registry. groupPathIDFull path of the group with which the resource is associated. nameString!Name of virtual registry.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryContainerRegistryContainer virtual registry after the mutation.
containerVirtualRegistryDeleteInput type: ContainerVirtualRegistryDeleteInput
Arguments Fields containerVirtualRegistryUpdateInput type: ContainerVirtualRegistryUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryContainerRegistryContainer virtual registry after the mutation.
containerVirtualRegistryUpstreamCreateInput type: ContainerVirtualRegistryUpstreamCreateInput
Arguments Fields containerVirtualRegistryUpstreamDeleteInput type: ContainerVirtualRegistryUpstreamDeleteInput
Arguments Fields containerVirtualRegistryUpstreamUpdateInput type: ContainerVirtualRegistryUpstreamUpdateInput
Arguments Fields corpusCreateInput type: CorpusCreateInput
Arguments Name Type Description fullPathID!Project the corpus belongs to. packageIdPackagesPackageID!ID of the corpus package.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
createAlertIssueInput type: CreateAlertIssueInput
Arguments Name Type Description iidString!IID of the alert to mutate. projectPathID!Project the alert to mutate is in.
Fields createAnnotationDeprecated in GitLab 16.0. Underlying feature was removed in 16.0.
Input type: CreateAnnotationInput
Arguments Name Type Description 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 createBoardInput type: CreateBoardInput
Arguments Name Type Description assigneeIdUserIDID of user to be assigned to the board. 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 Name Type Description boardBoardBoard after mutation. errors[String!]!Errors encountered during the mutation.
createBranchInput type: CreateBranchInput
Arguments Name Type Description 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 Name Type Description branchBranchBranch after mutation. errors[String!]!Errors encountered during the mutation.
createClusterAgentInput type: CreateClusterAgentInput
Arguments Name Type Description nameString!Name of the cluster agent. projectPathID!Full path of the associated project for the cluster agent.
Fields Name Type Description clusterAgentClusterAgentCluster agent created after mutation. errors[String!]!Errors encountered during the mutation.
createComplianceFrameworkInput type: CreateComplianceFrameworkInput
Arguments Name Type Description namespacePathID!Full path of the namespace to add the compliance framework to. paramsComplianceFrameworkInput!Parameters to update the compliance framework with.
Fields createComplianceFrameworkFromTemplateInput type: CreateComplianceFrameworkFromTemplateInput
Arguments Name Type Description 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 createComplianceRequirementInput type: CreateComplianceRequirementInput
Arguments Fields createComplianceRequirementsControlInput type: CreateComplianceRequirementsControlInput
Arguments Fields createContainerProtectionRepositoryRuleCreates a repository protection rule to restrict access to a project’s container registry.
Input type: CreateContainerProtectionRepositoryRuleInput
Arguments Name Type Description minimumAccessLevelForDeleteContainerProtectionRepositoryRuleAccessLevelIntroduced as an experiment in GitLab 17.11.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 createContainerProtectionTagRuleCreates a protection rule to control which user roles can modify container image tags matching a specified pattern.
Input type: createContainerProtectionTagRuleInput
Arguments Name Type Description 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 Name Type Description containerProtectionTagRuleContainerProtectionTagRuleProtection rule for container image tags after creation. errors[String!]!Errors encountered during the mutation.
createCustomDashboardCreates a custom dashboard in an organization.
Input type: CreateCustomDashboardInput
Arguments Fields createCustomEmojiInput type: CreateCustomEmojiInput
Arguments Name Type Description groupPathID!Namespace full path the emoji is associated with. nameString!Name of the emoji. urlString!Location of the emoji file.
Fields Name Type Description customEmojiCustomEmojiNew custom emoji. errors[String!]!Errors encountered during the mutation.
createDiffNoteInput type: CreateDiffNoteInput
Arguments Name Type Description bodyString!Content of the note. 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 Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
createDiscussionInput type: CreateDiscussionInput
Arguments Name Type Description bodyString!Content of the note. internalBooleanInternal flag for a note. Default is false. noteableIdNoteableID!Global ID of the resource to add a note to.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
createEpicDeprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide .
Input type: CreateEpicInput
Arguments Name Type Description addLabelIds[ID!]IDs of labels to be added to the epic. addLabels[String!]Array of labels to be added to the epic. 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 Name Type Description epicEpicCreated epic. errors[String!]!Errors encountered during the mutation.
createFunctionalVerificationWorkflowInput type: CreateFunctionalVerificationWorkflowInput
Arguments Name Type Description checkTypeFunctionalVerificationCheckType!Type of functional verification check to run. fullPathID!Full path of the namespace to run the verification check against.
Fields createImageDiffNoteInput type: CreateImageDiffNoteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
createIssueInput type: CreateIssueInput
Arguments Name Type Description assigneeIds[UserID!]Array of user IDs to assign to the issue. 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. epicIdEpicIDDeprecated 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
createIterationDeprecated in GitLab 14.0. Use iterationCreate.
Input type: CreateIterationInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. iterationIterationCreated iteration.
createLatestDiffNoteCreates 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 Name Type Description bodyString!Content of the note. 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 Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
createNoteCreates a Note.
If the body of the Note contains only quick actions,
the Note will be destroyed during an update, and no Note will be
returned.
Input type: CreateNoteInput
Arguments Name Type Description bodyString!Content of the note. 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 Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
createPackagesProtectionRuleCreates a protection rule to restrict access to project packages.
Input type: CreatePackagesProtectionRuleInput
Arguments Name Type Description minimumAccessLevelForDeletePackagesProtectionRuleAccessLevelForDeleteIntroduced as an experiment in GitLab 17.10.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 createRequirementInput type: CreateRequirementInput
Arguments Name Type Description descriptionStringDescription of the requirement. projectPathID!Full project path the requirement is associated with. titleStringTitle of the requirement.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. requirementRequirementRequirement after mutation.
createSnippetInput type: CreateSnippetInput
Arguments Name Type Description blobActions[SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs. 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 Name Type Description errors[String!]!Errors encountered during the mutation. snippetSnippetSnippet after mutation.
Creates a protection rule for a Terraform state backend.
Input type: CreateTerraformStateProtectionRuleInput
Arguments Name Type Description Default allowedFromTerraformStateProtectionRuleAllowedFromIntroduced as an experiment in GitLab 19.1.ANYWHERE allows all sources, CI_ONLY requires a CI job token, CI_ON_PROTECTED_BRANCH_ONLY requires a CI job on a protected branch. ANYWHEREminimumAccessLevelForWriteTerraformStateProtectionRuleAccessLevel!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 createTestCaseInput type: CreateTestCaseInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. testCaseIssueTest case created.
customFieldArchiveInput type: CustomFieldArchiveInput
Arguments Fields Name Type Description customFieldCustomFieldArchived custom field. errors[String!]!Errors encountered during the mutation.
customFieldCreateInput type: CustomFieldCreateInput
Arguments Fields Name Type Description customFieldCustomFieldCreated custom field. errors[String!]!Errors encountered during the mutation.
customFieldUnarchiveInput type: CustomFieldUnarchiveInput
Arguments Fields Name Type Description customFieldCustomFieldUnarchived custom field. errors[String!]!Errors encountered during the mutation.
customFieldUpdateInput type: CustomFieldUpdateInput
Arguments Fields Name Type Description customFieldCustomFieldUpdated custom field. errors[String!]!Errors encountered during the mutation.
Input type: CustomerRelationsContactCreateInput
Arguments Fields Input type: CustomerRelationsContactUpdateInput
Arguments Fields customerRelationsOrganizationCreateInput type: CustomerRelationsOrganizationCreateInput
Arguments Name Type Description defaultRateFloatStandard billing rate for the organization. descriptionStringDescription of or notes for the organization. groupIdGroupID!Group for the organization. nameString!Name of the organization.
Fields customerRelationsOrganizationUpdateInput type: CustomerRelationsOrganizationUpdateInput
Arguments Fields dastOnDemandScanCreateInput type: DastOnDemandScanCreateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. pipelineUrlStringURL of the pipeline that was created.
dastProfileCreateInput type: DastProfileCreateInput
Arguments Name Type Description Default branchNameStringAssociated branch. 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. falsetagList[String!]Indicates the runner tags associated with the profile.
Fields Name Type Description dastProfileDastProfileCreated profile. errors[String!]!Errors encountered during the mutation. pipelineUrlStringURL of the pipeline that was created. Requires runAfterCreate to be set to true.
dastProfileDeleteInput type: DastProfileDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
dastProfileRunInput type: DastProfileRunInput
Arguments Name Type Description fullPathIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID. idDastProfileID!ID of the profile to be used for the scan.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. pipelineUrlStringURL of the pipeline that was created.
dastProfileUpdateInput type: DastProfileUpdateInput
Arguments Name Type Description Default branchNameStringAssociated branch. 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. ""fullPathIDDeprecated 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. falsetagList[String!]Indicates the runner tags associated with the profile.
Fields Name Type Description 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.
dastScannerProfileCreateInput type: DastScannerProfileCreateInput
Arguments Name Type Description Default 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. PASSIVEshowDebugMessagesBooleanIndicates if debug messages should be included in DAST console output. True to include the debug messages. falsespiderTimeoutIntMaximum number of minutes allowed for the spider to traverse the site. tagList[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. false
Fields dastScannerProfileDeleteInput type: DastScannerProfileDeleteInput
Arguments Name Type Description fullPathIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID. idDastScannerProfileID!ID of the scanner profile to be deleted.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
dastScannerProfileUpdateInput type: DastScannerProfileUpdateInput
Arguments Name Type Description fullPathIDDeprecated 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[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 dastSiteProfileCreateInput type: DastSiteProfileCreateInput
Arguments Name Type Description Default authDastSiteProfileAuthInputParameters for authentication. 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 dastSiteProfileDeleteInput type: DastSiteProfileDeleteInput
Arguments Name Type Description fullPathIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID. idDastSiteProfileID!ID of the site profile to be deleted.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
dastSiteProfileUpdateInput type: DastSiteProfileUpdateInput
Arguments Name Type Description authDastSiteProfileAuthInputParameters for authentication. excludedUrls[String!]URLs to skip during an authenticated scan. fullPathIDDeprecated 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 dastSiteTokenCreateInput type: DastSiteTokenCreateInput
Arguments Name Type Description fullPathID!Project the site token belongs to. targetUrlStringURL of the target to be validated.
Fields dastSiteValidationCreateInput type: DastSiteValidationCreateInput
Arguments Fields dastSiteValidationRevokeInput type: DastSiteValidationRevokeInput
Arguments Name Type Description fullPathID!Project the site validation belongs to. normalizedTargetUrlString!Normalized URL of the target to be revoked.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
deleteAnnotationDeprecated in GitLab 16.0. Underlying feature was removed in 16.0.
Input type: DeleteAnnotationInput
Arguments Name Type Description idString!Global ID of the annotation to delete.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
deleteContainerProtectionRepositoryRuleDeletes a container repository protection rule.
Input type: DeleteContainerProtectionRepositoryRuleInput
Arguments Fields deleteContainerProtectionTagRuleDeletes a protection rule that controls which user roles can modify container image tags matching a specified pattern.
Input type: DeleteContainerProtectionTagRuleInput
Arguments Fields deleteConversationThreadInput type: DeleteConversationThreadInput
Arguments Fields Name Type Description errors[String!]!List of errors that occurred whilst trying to delete the thread. successBoolean!Returns true if thread was successfully deleted.
deleteCustomDashboardDeletes a custom dashboard.
Input type: DeleteCustomDashboardInput
Arguments Fields deleteDuoWorkflowsWorkflowInput type: DeleteDuoWorkflowsWorkflowInput
Arguments Fields Name Type Description errors[String!]!List of errors that occurred whilst trying to delete the workflow. successBoolean!Returns true if workflow was successfully deleted.
deleteGroupCustomAttributeDeletes a custom attribute from a group. Only available to admins.
Input type: DeleteGroupCustomAttributeInput
Arguments Name Type Description groupPathID!Full path of the group. keyString!Key of the custom attribute to delete.
Fields Name Type Description customAttributeCustomAttributeDeleted custom attribute. errors[String!]!Errors encountered during the mutation.
deletePackagesProtectionRuleDeletes a protection rule for packages.
Input type: DeletePackagesProtectionRuleInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. packageProtectionRulePackagesProtectionRulePackages protection rule that was deleted successfully.
deletePagesDeploymentDeletes a Pages deployment.
Input type: DeletePagesDeploymentInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. pagesDeploymentPagesDeployment!Deleted Pages Deployment.
deleteProjectCustomAttributeDeletes a custom attribute from a project. Only available to admins.
Input type: DeleteProjectCustomAttributeInput
Arguments Name Type Description keyString!Key of the custom attribute to delete. projectPathID!Full path of the project.
Fields Name Type Description customAttributeCustomAttributeDeleted custom attribute. errors[String!]!Errors encountered during the mutation.
Deletes a protection rule for a Terraform state backend.
Input type: DeleteTerraformStateProtectionRuleInput
Arguments Fields deleteUserCustomAttributeDeletes a custom attribute from a user. Only available to admins.
Input type: DeleteUserCustomAttributeInput
Arguments Name Type Description keyString!Key of the custom attribute to delete. userIdUserID!Global ID of the user.
Fields Name Type Description customAttributeCustomAttributeDeleted custom attribute. errors[String!]!Errors encountered during the mutation.
designManagementDeleteInput type: DesignManagementDeleteInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. versionDesignVersionNew version in which the designs are deleted.
designManagementMoveInput type: DesignManagementMoveInput
Arguments Fields Name Type Description designCollectionDesignCollectionCurrent state of the collection. errors[String!]!Errors encountered during the mutation.
designManagementUpdateInput type: DesignManagementUpdateInput
Arguments Fields Name Type Description designDesign!Updated design. errors[String!]!Errors encountered during the mutation.
designManagementUploadInput type: DesignManagementUploadInput
Arguments Name Type Description 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 Name Type Description 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.
destroyBoardInput type: DestroyBoardInput
Arguments Name Type Description idBoardID!Global ID of the board to destroy.
Fields Name Type Description boardBoardBoard after mutation. errors[String!]!Errors encountered during the mutation.
destroyBoardListInput type: DestroyBoardListInput
Arguments Name Type Description listIdListID!Global ID of the list to destroy. Only label lists are accepted.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. listBoardListList after mutation.
destroyComplianceFrameworkInput type: DestroyComplianceFrameworkInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
destroyComplianceRequirementInput type: DestroyComplianceRequirementInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
destroyComplianceRequirementsControlInput type: DestroyComplianceRequirementsControlInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
destroyContainerRepositoryInput type: DestroyContainerRepositoryInput
Arguments Fields Name Type Description containerRepositoryContainerRepository!Container repository policy after scheduling the deletion. errors[String!]!Errors encountered during the mutation.
Input type: DestroyContainerRepositoryTagsInput
Arguments Name Type Description idContainerRepositoryID!ID of the container repository. tagNames[String!]!Container repository tag(s) to delete. Total number can’t be greater than 20.
Fields Name Type Description deletedTagNames[String!]!Deleted container repository tags. errors[String!]!Errors encountered during the mutation.
destroyCustomEmojiInput type: DestroyCustomEmojiInput
Arguments Name Type Description idCustomEmojiID!Global ID of the custom emoji to destroy.
Fields Name Type Description customEmojiCustomEmojiDeleted custom emoji. errors[String!]!Errors encountered during the mutation.
destroyEpicBoardDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: DestroyEpicBoardInput
Arguments Fields Name Type Description epicBoardEpicBoardEpic board after mutation. errors[String!]!Errors encountered during the mutation.
destroyNoteInput type: DestroyNoteInput
Arguments Name Type Description idNoteID!Global ID of the note to destroy.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
destroyPackageInput type: DestroyPackageInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
destroyPackageFileInput type: DestroyPackageFileInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
destroyPackageFilesInput type: DestroyPackageFilesInput
Arguments Name Type Description ids[PackagesPackageFileID!]!IDs of the Package file. projectPathID!Project path where the packages cleanup policy is located.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
destroyPackagesInput type: DestroyPackagesInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
destroySnippetInput type: DestroySnippetInput
Arguments Name Type Description idSnippetID!Global ID of the snippet to destroy.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. snippetSnippetSnippet after mutation.
devfileValidateInput type: DevfileValidateInput
Arguments Name Type Description devfileYamlString!Input devfile.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. validBooleanStatus whether devfile is valid or not.
disableDevopsAdoptionNamespaceStatus : Beta.
Input type: DisableDevopsAdoptionNamespaceInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
discussionToggleResolveToggles the resolved state of a discussion.
Input type: DiscussionToggleResolveInput
Arguments Name Type Description idDiscussionID!Global ID of the discussion. resolveBoolean!Will resolve the discussion when true, and unresolve the discussion when false.
Fields Name Type Description discussionDiscussionDiscussion after mutation. errors[String!]!Errors encountered during the mutation.
dismissPolicyViolationsDismisses policy violations linked to a merge request.
Input type: DismissPolicyViolationsInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
duoSettingsUpdateUpdates GitLab Duo settings.
Input type: DuoSettingsUpdateInput
Arguments Name Type Description aiGatewayTimeoutSecondsIntTimeout for the AI Gateway request. aiGatewayUrlStringURL for the local AI Gateway server. allowAllUnixSocketsBooleanIntroduced as an experiment in GitLab 19.0. allowProjectExtensionBooleanIntroduced as an experiment in GitLab 19.0. duoAgentPlatformServiceUrlStringURL for the local Duo Agent Platform service. duoCliEnabledBooleanIntroduced as an experiment in GitLab 19.0. duoCoreFeaturesEnabledBooleanIndicates whether GitLab Duo Core features are enabled. includeRecommendedAllowedBooleanIntroduced as an experiment in GitLab 19.0. minimumAccessLevelEnableOnProjectsAccessLevelEnumIntroduced as an experiment in GitLab 18.7. minimumAccessLevelExecuteAccessLevelEnumIntroduced as an experiment in GitLab 18.7. minimumAccessLevelExecuteAsyncAccessLevelEnumIntroduced as an experiment in GitLab 18.7. minimumAccessLevelManageAccessLevelEnumIntroduced as an experiment in GitLab 18.7. selfHostedDuoAgentPlatformServiceSecureBooleanWhether to use secure transport (TLS) for the local Duo Agent Platform service.
Fields Name Type Description duoSettingsDuoSettings!GitLab Duo settings after mutation. errors[String!]!Errors encountered during the mutation.
duoUserFeedbackInput type: DuoUserFeedbackInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
echoCreateA mutation that does not perform any changes.
This is expected to be used for testing of endpoints, to verify
that a user has mutation access.
Input type: EchoCreateInput
Arguments Name Type Description errors[String!]Errors to return to the user. messages[String!]Messages to return to the user.
Fields Name Type Description echoes[String!]Messages returned to the user. errors[String!]!Errors encountered during the mutation.
enableDevopsAdoptionNamespaceStatus : Beta.
Input type: EnableDevopsAdoptionNamespaceInput
Arguments Fields environmentCreateCreate an environment.
Input type: EnvironmentCreateInput
Arguments Name Type Description autoStopSettingAutoStopSettingAuto stop setting of the environment. 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 Name Type Description environmentEnvironmentCreated environment. errors[String!]!Errors encountered during the mutation.
environmentDeleteDelete an environment.
Input type: EnvironmentDeleteInput
Arguments Name Type Description idEnvironmentID!Global ID of the environment to Delete.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
environmentStopStop an environment.
Input type: EnvironmentStopInput
Arguments Name Type Description forceBooleanForce environment to stop without executing on_stop actions. idEnvironmentID!Global ID of the environment to stop.
Fields Name Type Description environmentEnvironmentEnvironment after attempt to stop. errors[String!]!Errors encountered during the mutation.
environmentUpdateUpdate an environment.
Input type: EnvironmentUpdateInput
Arguments Name Type Description autoStopSettingAutoStopSettingAuto stop setting of the environment. 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 Name Type Description environmentEnvironmentEnvironment after attempt to update. errors[String!]!Errors encountered during the mutation.
environmentsCanaryIngressUpdateDeprecated This endpoint is planned to be removed along with certificate-based clusters. See this epic for more information.
Input type: EnvironmentsCanaryIngressUpdateInput
Arguments Name Type Description idEnvironmentID!Global ID of the environment to update. weightInt!Weight of the Canary Ingress.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
epicAddIssueDeprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide .
Input type: EpicAddIssueInput
Arguments Name Type Description 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 Name Type Description epicEpicEpic after mutation. epicIssueEpicIssueEpic-issue relationship. errors[String!]!Errors encountered during the mutation.
epicBoardCreateDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: EpicBoardCreateInput
Arguments Name Type Description 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 Name Type Description epicBoardEpicBoardCreated epic board. errors[String!]!Errors encountered during the mutation.
epicBoardListCreateDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: EpicBoardListCreateInput
Arguments Name Type Description backlogBooleanCreate the backlog list. boardIdBoardsEpicBoardID!Global ID of the issue board to mutate. labelIdLabelIDGlobal ID of an existing label.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. listEpicListEpic list in the epic board.
epicBoardListDestroyDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: EpicBoardListDestroyInput
Arguments Name Type Description listIdBoardsEpicListID!Global ID of the epic board list to destroy.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. listEpicListEpic board list. null if the board was destroyed successfully.
epicBoardUpdateDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: EpicBoardUpdateInput
Arguments Name Type Description 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 Name Type Description epicBoardEpicBoardUpdated epic board. errors[String!]!Errors encountered during the mutation.
epicMoveListDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: EpicMoveListInput
Arguments Name Type Description boardIdBoardsEpicBoardID!Global ID of the board that the epic is in. 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 Name Type Description epicEpicEpic after mutation. errors[String!]!Errors encountered during the mutation.
epicSetSubscriptionDeprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide .
Input type: EpicSetSubscriptionInput
Arguments Name Type Description groupPathID!Group the epic to mutate belongs to. iidID!IID of the epic to mutate. subscribedStateBoolean!Desired state of the subscription.
Fields Name Type Description epicEpicEpic after mutation. errors[String!]!Errors encountered during the mutation.
epicTreeReorderDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: EpicTreeReorderInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
escalationPolicyCreateInput type: EscalationPolicyCreateInput
Arguments Name Type Description 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 escalationPolicyDestroyInput type: EscalationPolicyDestroyInput
Arguments Fields escalationPolicyUpdateInput type: EscalationPolicyUpdateInput
Arguments Fields exportRequirementsInput type: ExportRequirementsInput
Arguments Name Type Description authorUsername[String!]Filter requirements by author username. 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 Name Type Description errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationCreateDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsCreate instead.
Input type: ExternalAuditEventDestinationCreateInput
Arguments Name Type Description destinationUrlString!Destination URL. groupPathID!Group path. nameStringDestination name. verificationTokenStringVerification token.
Fields externalAuditEventDestinationDestroyDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.
Input type: ExternalAuditEventDestinationDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationUpdateDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.
Input type: ExternalAuditEventDestinationUpdateInput
Arguments Fields geoRegistriesBulkUpdateMutates multiple Geo registries for a given registry class.
Input type: GeoRegistriesBulkUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryClassGeoRegistryClassUpdated Geo registry class.
geoRegistriesUpdateMutates a Geo registry.
Input type: GeoRegistriesUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryRegistrableUpdated Geo registry entry.
gitlabSubscriptionActivateInput type: GitlabSubscriptionActivateInput
Arguments Name Type Description activationCodeString!Activation code received after purchasing a GitLab subscription.
Fields googleCloudLoggingConfigurationCreateDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsCreate with gcpLogging category instead.
Input type: GoogleCloudLoggingConfigurationCreateInput
Arguments Name Type Description Default 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. 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). "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 googleCloudLoggingConfigurationDestroyDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.
Input type: GoogleCloudLoggingConfigurationDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
googleCloudLoggingConfigurationUpdateDeprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.
Input type: GoogleCloudLoggingConfigurationUpdateInput
Arguments Name Type Description 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. 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 governPolicyCreateCreates a policy in the policy store for an organization or group.
Input type: GovernPolicyCreateInput
Arguments Name Type Description actions[JSON!]Actions the policy takes. No more than 1000 actions. descriptionStringDescription of the policy. groupPathIDFull path of the top-level group whose policy store to use. Exactly one of organizationId or groupPath is required. lifecycleStateStringLifecycle state of the policy. modeStringEnforcement mode of the policy. nameString!Name of the policy. organizationIdOrganizationsOrganizationIDGlobal ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required. policyScopeJSONAuthored scope of the policy. Mutually exclusive with scopeRego. rules[JSON!]!Rules of the policy, at least one. No more than 1000 rules. scopeRegoStringRego expression scoping the policy. Mutually exclusive with policyScope. triggerTypeString!Trigger the policy responds to.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. policyGovernPolicyPolicy created in the policy store.
governPolicyDeleteDeletes a policy from the policy store for an organization or group.
Input type: GovernPolicyDeleteInput
Arguments Name Type Description groupPathIDFull path of the top-level group whose policy store to use. Exactly one of organizationId or groupPath is required. idInt!ID of the policy to delete. organizationIdOrganizationsOrganizationIDGlobal ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
governPolicyUpdateUpdates a policy in the policy store for an organization or group. Only the supplied fields are changed; omitted fields keep their current values, while an explicit null clears a nullable field.
Input type: GovernPolicyUpdateInput
Arguments Name Type Description actions[JSON!]Actions the policy takes. No more than 1000 actions. descriptionStringDescription of the policy. groupPathIDFull path of the top-level group whose policy store to use. Exactly one of organizationId or groupPath is required. lifecycleStateStringLifecycle state of the policy. modeStringEnforcement mode of the policy. nameStringName of the policy. organizationIdOrganizationsOrganizationIDGlobal ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required. policyIdInt!ID of the policy. policyScopeJSONAuthored scope of the policy. Mutually exclusive with scopeRego. rules[JSON!]Rules of the policy, at least one when supplied. No more than 1000 rules. scopeRegoStringRego expression scoping the policy. Mutually exclusive with policyScope. triggerTypeStringTrigger the policy responds to.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. policyGovernPolicyPolicy updated in the policy store.
groupAuditEventStreamingDestinationsCreateInput type: GroupAuditEventStreamingDestinationsCreateInput
Arguments Name Type Description categoryString!Destination category. configJSON!Destination config. groupPathID!Group path. nameStringDestination name. secretTokenStringSecret token.
Fields groupAuditEventStreamingDestinationsDeleteInput type: GroupAuditEventStreamingDestinationsDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
groupAuditEventStreamingDestinationsUpdateInput type: GroupAuditEventStreamingDestinationsUpdateInput
Arguments Fields groupMemberBulkUpdateInput type: GroupMemberBulkUpdateInput
Arguments Name Type Description accessLevelMemberAccessLevel!Access level to update the members to. expiresAtTimeDate and time the membership expires. groupIdGroupID!Global ID of the group. userIds[UserID!]!Global IDs of the members.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupMembers[GroupMember!]Group members after mutation. queuedMemberApprovalsMemberApprovalConnectionList of queued pending members approvals. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupMembersExportInput type: GroupMembersExportInput
Arguments Name Type Description groupIdGroupID!Global ID of the group.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. messageStringExport request result message.
groupSavedReplyCreateInput type: GroupSavedReplyCreateInput
Arguments Name Type Description contentString!Content of the saved reply. groupIdGroupID!Group for the save reply. nameString!Name of the saved reply.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. savedReplyGroupSavedReplySaved reply after mutation.
groupSavedReplyDestroyInput type: GroupSavedReplyDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. savedReplyGroupSavedReplySaved reply after mutation.
groupSavedReplyUpdateInput type: GroupSavedReplyUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. savedReplyGroupSavedReplySaved reply after mutation.
groupSecretCreateInput type: GroupSecretCreateInput
Arguments Name Type Description 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 groupSecretDeleteInput type: GroupSecretDeleteInput
Arguments Name Type Description groupPathID!Group of the secret. nameString!Name of the group secret to delete.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupSecretGroupSecretDeleted group secret.
groupSecretUpdateInput type: GroupSecretUpdateInput
Arguments Name Type Description 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 groupSecretsManagerDeprovisionInput type: GroupSecretsManagerDeprovisionInput
Arguments Name Type Description groupPathID!Group of the secrets manager.
Fields groupSecretsManagerInitializeInput type: GroupSecretsManagerInitializeInput
Arguments Name Type Description groupPathID!Group of the secrets manager.
Fields groupSecretsPermissionDeleteInput type: GroupSecretsPermissionDeleteInput
Arguments Name Type Description groupPathID!Group permissions for the secret. principalPrincipalInput!Whose permission to be deleted.
Fields groupSecretsPermissionUpdateInput type: GroupSecretsPermissionUpdateInput
Arguments Name Type Description actions[SecretsManagementAction!]!Actions that can be performed on secrets. expiredAtISO8601DateExpiration date for Secret Permission (optional). groupPathID!Group to which the permissions are added. principalPrincipalInput!User/MemberRole/Role that is provided access.
Fields groupTransferInput type: GroupTransferInput
Arguments Name Type Description idGroupID!Global ID of the group to transfer. targetIdGroupIDGlobal ID of the target parent group. Omit to make group top-level.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupGroupGroup after mutation.
groupUpdateInput type: GroupUpdateInput
Arguments Name Type Description aiAuditEventsStorageEnabledBooleanIntroduced as an experiment in GitLab 19.2. builtInProjectTemplatesEnabledBooleanIntroduced as an experiment in GitLab 19.0. duoAutoModeEnabledBooleanIntroduced as an experiment in GitLab 19.5. duoFeaturesEnabledBooleanIntroduced as an experiment in GitLab 16.10. fullPathID!Full path of the group that will be updated. lockAiAuditEventsStorageEnabledBooleanIntroduced as an experiment in GitLab 19.2. lockBuiltInProjectTemplatesEnabledBooleanIntroduced as an experiment in GitLab 19.0. lockDuoAutoModeEnabledBooleanIntroduced as an experiment in GitLab 19.5. lockDuoFeaturesEnabledBooleanIntroduced as an experiment in GitLab 16.10. lockMathRenderingLimitsEnabledBooleanIndicates if math rendering limits are locked for all descendant groups. lockToolApprovalForSessionEnabledBooleanIntroduced as an experiment in GitLab 18.11. 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. toolApprovalForSessionEnabledBooleanIntroduced as an experiment in GitLab 18.11. visibilityVisibilityLevelsEnumVisibility of the namespace. webBasedCommitSigningEnabledBooleanIntroduced as an experiment in GitLab 18.2.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupGroupGroup after update.
httpIntegrationCreateInput type: HttpIntegrationCreateInput
Arguments Fields httpIntegrationDestroyInput type: HttpIntegrationDestroyInput
Arguments Fields httpIntegrationResetTokenInput type: HttpIntegrationResetTokenInput
Arguments Fields httpIntegrationUpdateInput type: HttpIntegrationUpdateInput
Arguments Fields importSourceUserCancelReassignmentInput type: ImportSourceUserCancelReassignmentInput
Arguments Name Type Description idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.
importSourceUserKeepAllAsPlaceholderInput type: ImportSourceUserKeepAllAsPlaceholderInput
Arguments Name Type Description namespaceIdNamespaceID!Global ID of the namespace.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. updatedImportSourceUserCountIntNumber of successfully updated mappings of users on source instance to their destination users.
importSourceUserKeepAsPlaceholderInput type: ImportSourceUserKeepAsPlaceholderInput
Arguments Name Type Description idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.
importSourceUserReassignInput type: ImportSourceUserReassignInput
Arguments Name Type Description assigneeUserIdUserID!Global ID of the assignee user. idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.
importSourceUserResendNotificationInput type: ImportSourceUserResendNotificationInput
Arguments Name Type Description idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.
importSourceUserRetryFailedReassignmentInput type: ImportSourceUserRetryFailedReassignmentInput
Arguments Name Type Description idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.
importSourceUserRevokeInput type: ImportSourceUserRevokeInput
Arguments Name Type Description idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.
importSourceUserUndoKeepAsPlaceholderInput type: ImportSourceUserUndoKeepAsPlaceholderInput
Arguments Name Type Description idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.
instanceAuditEventStreamingDestinationsCreateInput type: InstanceAuditEventStreamingDestinationsCreateInput
Arguments Name Type Description categoryString!Destination category. configJSON!Destination config. nameStringDestination name. secretTokenStringSecret token.
Fields instanceAuditEventStreamingDestinationsDeleteInput type: InstanceAuditEventStreamingDestinationsDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
instanceAuditEventStreamingDestinationsUpdateInput type: InstanceAuditEventStreamingDestinationsUpdateInput
Arguments Fields instanceExternalAuditEventDestinationCreateDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsCreate instead.
Input type: InstanceExternalAuditEventDestinationCreateInput
Arguments Name Type Description destinationUrlString!Destination URL. nameStringDestination name.
Fields instanceExternalAuditEventDestinationDestroyDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.
Input type: InstanceExternalAuditEventDestinationDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
instanceExternalAuditEventDestinationUpdateDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.
Input type: InstanceExternalAuditEventDestinationUpdateInput
Arguments Fields instanceGoogleCloudLoggingConfigurationCreateDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsCreate with gcpLogging category instead.
Input type: InstanceGoogleCloudLoggingConfigurationCreateInput
Arguments Name Type Description Default 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. 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). "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 instanceGoogleCloudLoggingConfigurationDestroyDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.
Input type: InstanceGoogleCloudLoggingConfigurationDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
instanceGoogleCloudLoggingConfigurationUpdateDeprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.
Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput
Arguments Name Type Description 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. 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 instanceSecretsManagerEnrollInput type: InstanceSecretsManagerEnrollInput
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
instanceSecretsManagerUnenrollInput type: InstanceSecretsManagerUnenrollInput
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
integrationExclusionCreateInput type: IntegrationExclusionCreateInput
Arguments Name Type Description 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 integrationExclusionDeleteInput type: IntegrationExclusionDeleteInput
Arguments Fields issuableResourceLinkCreateInput type: IssuableResourceLinkCreateInput
Arguments Fields issuableResourceLinkDestroyInput type: IssuableResourceLinkDestroyInput
Arguments Fields issueLinkAlertsInput type: IssueLinkAlertsInput
Arguments Name Type Description alertReferences[String!]!Alerts references to be linked to the incident. iidString!IID of the issue to mutate. projectPathID!Project the issue to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueMoveInput type: IssueMoveInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueMoveListInput type: IssueMoveListInput
Arguments Name Type Description boardIdBoardID!Global ID of the board that the issue is in. epicIdEpicIDDeprecated 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetAssigneesInput type: IssueSetAssigneesInput
Arguments Name Type Description Default assigneeUsernames[String!]!Usernames to assign to the resource. Replaces existing assignees by default. iidString!IID of the issue to mutate. operationModeMutationOperationModeOperation to perform. Defaults to REPLACE. REPLACEprojectPathID!Project the issue to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetConfidentialInput type: IssueSetConfidentialInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
Input type: IssueSetCrmContactsInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetDueDateInput type: IssueSetDueDateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetEpicDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: IssueSetEpicInput
Arguments Name Type Description epicIdEpicIDDeprecated 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetEscalationPolicyInput type: IssueSetEscalationPolicyInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetEscalationStatusInput type: IssueSetEscalationStatusInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetIterationInput type: IssueSetIterationInput
Arguments Name Type Description iidString!IID of the issue to mutate. iterationIdIterationIDIteration to assign to the issue. projectPathID!Project the issue to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetLockedInput type: IssueSetLockedInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetSeverityInput type: IssueSetSeverityInput
Arguments Name Type Description iidString!IID of the issue to mutate. projectPathID!Project the issue to mutate is in. severityIssuableSeverity!Set the incident severity level.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetSubscriptionInput type: IssueSetSubscriptionInput
Arguments Name Type Description iidString!IID of the issue to mutate. projectPathID!Project the issue to mutate is in. subscribedStateBoolean!Desired state of the subscription.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueSetWeightInput type: IssueSetWeightInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
issueUnlinkAlertInput type: IssueUnlinkAlertInput
Arguments Name Type Description alertIdAlertManagementAlertID!Global ID of the alert to unlink from the incident. iidString!IID of the issue to mutate. projectPathID!Project the issue to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
iterationCadenceCreateInput type: IterationCadenceCreateInput
Arguments Name Type Description activeBoolean!Whether the iteration cadence is active. automaticBoolean!Whether the iteration cadence should automatically generate upcoming iterations. 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 Name Type Description errors[String!]!Errors encountered during the mutation. iterationCadenceIterationCadenceCreated iteration cadence.
iterationCadenceDestroyInput type: IterationCadenceDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupGroup!Group the iteration cadence belongs to.
iterationCadenceUpdateInput type: IterationCadenceUpdateInput
Arguments Name Type Description activeBooleanWhether the iteration cadence is active. automaticBooleanWhether the iteration cadence should automatically generate upcoming iterations. 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 Name Type Description errors[String!]!Errors encountered during the mutation. iterationCadenceIterationCadenceUpdated iteration cadence.
iterationCreateInput type: iterationCreateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. iterationIterationCreated iteration.
iterationDeleteInput type: IterationDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupGroup!Group the iteration belongs to.
jiraImportStartInput type: JiraImportStartInput
Arguments Name Type Description jiraProjectKeyString!Project key of the importer Jira project. jiraProjectNameStringDeprecated 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 Name Type Description errors[String!]!Errors encountered during the mutation. jiraImportJiraImportJira import data after mutation.
jiraImportUsersInput type: JiraImportUsersInput
Arguments Name Type Description projectPathID!Project to import the Jira users into. startAtIntIndex of the record the import should started at, default 0 (50 records returned).
Fields Name Type Description errors[String!]!Errors encountered during the mutation. jiraUsers[JiraUser!]Users returned from Jira, matched by email and name if possible.
jobArtifactsDestroyInput type: JobArtifactsDestroyInput
Arguments Name Type Description idCiBuildID!ID of the job to mutate.
Fields Name Type Description destroyedArtifactsCountInt!Number of artifacts deleted. errors[String!]!Errors encountered during the mutation. jobCiJobJob with artifacts to be deleted.
jobCancelInput type: JobCancelInput
Arguments Name Type Description idCiBuildID!ID of the job to mutate.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. jobCiJobJob after the mutation.
jobPlayInput type: JobPlayInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. jobCiJobJob after the mutation.
jobRetryInput type: JobRetryInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. jobCiJobJob after the mutation.
jobUnscheduleInput type: JobUnscheduleInput
Arguments Name Type Description idCiBuildID!ID of the job to mutate.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. jobCiJobJob after the mutation.
knowledgeGraphExcludedNamespaceCreateInput type: KnowledgeGraphExcludedNamespaceCreateInput
Arguments Name Type Description groupPathID!Full path of the top-level group to exclude.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupGroupExcluded group.
knowledgeGraphExcludedNamespaceDestroyInput type: KnowledgeGraphExcludedNamespaceDestroyInput
Arguments Name Type Description groupPathID!Full path of the top-level group to remove from exclusions.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupGroupGroup removed from exclusions.
labelCreateInput type: LabelCreateInput
Arguments Name Type Description Default colorStringThe color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names. See List of color keywords at mozilla.org . "#6699cc"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 Name Type Description errors[String!]!Errors encountered during the mutation. labelLabelLabel after mutation.
labelUpdateInput type: LabelUpdateInput
Arguments Name Type Description archivedBooleanWhether to archive the label. Introduced in GitLab 18.10. idLabelID!Global ID of the label to update.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. labelLabelLabel after mutation.
ldapAdminRoleLinkCreateCreates an instance-level custom admin role LDAP link.
Input type: LdapAdminRoleLinkCreateInput
Arguments Name Type Description adminMemberRoleIdMemberRoleID!Global ID of the custom admin role to be assigned to a user. cnStringCommon Name (CN) of the LDAP group. filterStringSearch filter for the LDAP group. providerString!LDAP provider for the LDAP link.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. ldapAdminRoleLinkLdapAdminRoleLinkCreated instance-level LDAP link.
ldapAdminRoleLinkDestroyDestroys an instance-level custom admin role LDAP link.
Input type: LdapAdminRoleLinkDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. ldapAdminRoleLinkLdapAdminRoleLinkDeleted instance-level LDAP link.
lifecycleAttachWorkItemTypeInput type: LifecycleAttachWorkItemTypeInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. lifecycleWorkItemLifecycleLifecycle after attaching the work item type.
lifecycleCreateInput type: LifecycleCreateInput
Arguments Name Type Description 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 lifecycleDeleteInput type: LifecycleDeleteInput
Arguments Fields lifecycleUpdateInput type: LifecycleUpdateInput
Arguments Name Type Description 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 linkProjectComplianceViolationIssueInput type: LinkProjectComplianceViolationIssueInput
Arguments Fields markAsSpamSnippetInput type: MarkAsSpamSnippetInput
Arguments Name Type Description idSnippetID!Global ID of the snippet to update.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. snippetSnippetSnippet after mutation.
mavenCacheEntryDeleteInput type: MavenCacheEntryDeleteInput
Arguments Name Type Description idString!ID of the cache entry.
Fields mavenUpstreamCacheDeleteInput type: MavenUpstreamCacheDeleteInput
Arguments Fields mavenUpstreamCreateInput type: MavenUpstreamCreateInput
Arguments Name Type Description Default cacheValidityHoursIntCache validity period. Defaults to 24 hours. 24descriptionStringDescription of the upstream registry. idVirtualRegistriesPackagesMavenRegistryID!ID of the upstream registry. metadataCacheValidityHoursIntMetadata cache validity period. Defaults to 24 hours. 24nameString!Name of upstream registry. passwordStringPassword of the upstream registry. urlString!URL of the upstream registry. usernameStringUsername of the upstream registry.
Fields mavenUpstreamDeleteInput type: MavenUpstreamDeleteInput
Arguments Fields mavenUpstreamUpdateInput type: MavenUpstreamUpdateInput
Arguments Name Type Description cacheValidityHoursIntCache validity period. 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 mavenVirtualRegistryCacheDeleteInput type: MavenVirtualRegistryCacheDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryMavenRegistryMaven virtual registry.
mavenVirtualRegistryCreateInput type: MavenVirtualRegistryCreateInput
Arguments Name Type Description descriptionStringDescription of the virtual registry. groupPathIDFull path of the group with which the resource is associated. nameString!Name of virtual registry.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryMavenRegistryMaven virtual registry after the mutation.
mavenVirtualRegistryDeleteInput type: MavenVirtualRegistryDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryMavenRegistryDeleted Maven virtual registry.
mavenVirtualRegistryUpdateInput type: MavenVirtualRegistryUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. registryMavenRegistryMaven virtual registry after the mutation.
mavenVirtualRegistryUpstreamDeleteInput type: MavenVirtualRegistryUpstreamDeleteInput
Arguments Fields mavenVirtualRegistryUpstreamUpdateInput type: MavenVirtualRegistryUpstreamUpdateInput
Arguments Fields memberRoleAdminCreateInput type: MemberRoleAdminCreateInput
Arguments Fields memberRoleAdminDeleteInput type: MemberRoleAdminDeleteInput
Arguments Name Type Description idMemberRoleID!ID of the admin member role to delete.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. memberRoleMemberRoleDeleted admin member role.
memberRoleAdminUpdateInput type: MemberRoleAdminUpdateInput
Arguments Fields memberRoleCreateInput type: MemberRoleCreateInput
Arguments Name Type Description baseAccessLevelMemberRolesAccessLevel!Base access level for the custom role. 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 Name Type Description errors[String!]!Errors encountered during the mutation. memberRoleMemberRoleMember role.
memberRoleDeleteInput type: MemberRoleDeleteInput
Arguments Name Type Description idMemberRoleID!ID of the member role to delete.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. memberRoleMemberRoleDeleted member role.
memberRoleToUserAssignInput type: MemberRoleToUserAssignInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. userMemberRoleUserMemberRoleCreated user member role or nil if the relation was deleted.
memberRoleUpdateInput type: MemberRoleUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. memberRoleMemberRoleMember role.
mergeRequestAcceptAccepts a merge request.
When accepted, the source branch will be scheduled to merge into the target branch, either
immediately if possible, or using one of the automatic merge strategies.
In GitLab 16.5 , the merging happens asynchronously.
This results in mergeRequest and state not updating after a mutation request,
because the merging may not have happened yet.
Input type: MergeRequestAcceptInput
Arguments Name Type Description Default 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. falsesquashCommitMessageStringCustom squash commit message (if squash is true). strategyMergeStrategyEnumHow to merge the merge request.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestBypassSecurityPolicyBypasses security policies for a merge request.
Input type: MergeRequestBypassSecurityPolicyInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestCreateInput type: MergeRequestCreateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestCreateWorkItemRelationsLinks work items to a merge request.
Input type: MergeRequestCreateWorkItemRelationsInput
Arguments Name Type Description Default 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. RELATEDprojectPathID!Project the merge request to mutate is in. workItemIds[WorkItemID!]!Global IDs of the work items to link.
Fields mergeRequestDestroyRequestedChangesInput type: MergeRequestDestroyRequestedChangesInput
Arguments Name Type Description iidString!IID of the merge request to mutate. projectPathID!Project the merge request to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestDestroyWorkItemRelationsRemoves relations between a merge request and work items.
Input type: MergeRequestDestroyWorkItemRelationsInput
Arguments Name Type Description ids[MergeRequestIssueID!]!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 mergeRequestRequestChangesInput type: MergeRequestRequestChangesInput
Arguments Name Type Description iidString!IID of the merge request to mutate. projectPathID!Project the merge request to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestResyncSecurityPoliciesTriggers a re-evaluation of the security approval policies applicable to the merge request.
Input type: MergeRequestResyncSecurityPoliciesInput
Arguments Name Type Description iidString!IID of the merge request to re-evaluate. projectPathID!Project the merge request belongs to.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after the re-evaluation was scheduled.
mergeRequestReviewerRereviewInput type: MergeRequestReviewerRereviewInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestSavedViewCreateCreates a saved view on the merge request dashboard. Available only when the mr_dashboard_saved_views feature flag is enabled.
Input type: MergeRequestSavedViewCreateInput
Arguments Fields mergeRequestSavedViewDeleteDeletes a saved view from the merge request dashboard. Available only when the mr_dashboard_saved_views feature flag is enabled.
Input type: MergeRequestSavedViewDeleteInput
Arguments Fields mergeRequestSavedViewUpdateUpdates a saved view on the merge request dashboard. Available only when the mr_dashboard_saved_views feature flag is enabled.
Input type: MergeRequestSavedViewUpdateInput
Arguments Fields mergeRequestSetAssigneesInput type: MergeRequestSetAssigneesInput
Arguments Name Type Description Default assigneeUsernames[String!]!Usernames to assign to the resource. Replaces existing assignees by default. iidString!IID of the merge request to mutate. operationModeMutationOperationModeOperation to perform. Defaults to REPLACE. REPLACEprojectPathID!Project the merge request to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestSetBlockingMergeRequestsInput type: MergeRequestSetBlockingMergeRequestsInput
Arguments Name Type Description blockingMergeRequestReferences[String!]!Array of blocking merge request references (e.g., “!123”, “project!456”). iidString!IID of the merge request to mutate. projectPathID!Project the merge request to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestSetDraftInput type: MergeRequestSetDraftInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestSetLabelsInput type: MergeRequestSetLabelsInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestSetLockedInput type: MergeRequestSetLockedInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestSetMilestoneInput type: MergeRequestSetMilestoneInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestSetReviewersInput type: MergeRequestSetReviewersInput
Arguments Name Type Description Default iidString!IID of the merge request to mutate. operationModeMutationOperationModeOperation to perform. Defaults to REPLACE. REPLACEprojectPathID!Project the merge request to mutate is in. reviewerUsernames[String!]!Usernames of reviewers to assign. Replaces existing reviewers by default. Usernames that do not match a visible user are reported in errors and not assigned.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestSetSubscriptionInput type: MergeRequestSetSubscriptionInput
Arguments Name Type Description iidString!IID of the merge request to mutate. projectPathID!Project the merge request to mutate is in. subscribedStateBoolean!Desired state of the subscription.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestUpdateUpdate attributes of a merge request.
Input type: MergeRequestUpdateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeRequestUpdateApprovalRuleInput type: MergeRequestUpdateApprovalRuleInput
Arguments Name Type Description Default approvalRuleIdInt!ID of an approval rule. approvalsRequiredInt!Number of required approvals for a given rule. 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. falseuserIds[String!]IDs of users as approvers. []
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge request after mutation.
mergeTrainsDeleteCarInput type: MergeTrainsDeleteCarInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
mlModelCreateInput type: MlModelCreateInput
Arguments Name Type Description descriptionStringDescription of the model. nameString!Name of the model. projectPathID!Project the model to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. modelMlModelModel after mutation.
mlModelDeleteInput type: MlModelDeleteInput
Arguments Name Type Description idMlModelID!Global ID of the model to be deleted. projectPathID!Project the model to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. modelMlModelModel after mutation.
mlModelDestroyInput type: MlModelDestroyInput
Arguments Name Type Description idMlModelID!Global ID of the model to be deleted. projectPathID!Project the model to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. messageStringModel deletion result message. modelMlModelModel after mutation.
mlModelEditInput type: MlModelEditInput
Arguments Name Type Description descriptionStringDescription of the model. modelIdIntId of the model. nameString!Name of the model. projectPathID!Project the model to mutate is in.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. modelMlModelModel after mutation.
mlModelVersionCreateInput type: MlModelVersionCreateInput
Arguments Name Type Description candidateIdMlCandidateIDGlobal ID of a candidate to promote optionally. 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 Name Type Description errors[String!]!Errors encountered during the mutation. modelVersionMlModelVersionModel after mutation.
mlModelVersionDeleteInput type: MlModelVersionDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. modelVersionMlModelVersionDeleted model version.
mlModelVersionEditInput type: MlModelVersionEditInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. modelVersionMlModelVersionModel after mutation.
namespaceBanDestroyInput type: NamespaceBanDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. namespaceBanNamespaceBanNamespace Ban.
namespaceCiCdSettingsUpdateInput type: NamespaceCiCdSettingsUpdateInput
Arguments Name Type Description allowStaleRunnerPruningBooleanIndicates if stale runners directly belonging to the namespace should be periodically pruned. fullPathID!Full path of the namespace the settings belong to.
Fields namespaceCreateRemoteDevelopmentClusterAgentMappingInput type: NamespaceCreateRemoteDevelopmentClusterAgentMappingInput
Arguments Name Type Description 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 namespaceDeleteRemoteDevelopmentClusterAgentMappingInput type: NamespaceDeleteRemoteDevelopmentClusterAgentMappingInput
Arguments Name Type Description 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 namespaceSecretsManagerEnrollInput type: NamespaceSecretsManagerEnrollInput
Arguments Name Type Description namespacePathID!Full path of the namespace to enroll.
Fields namespaceSecretsManagerUnenrollInput type: NamespaceSecretsManagerUnenrollInput
Arguments Name Type Description namespacePathID!Full path of the namespace to unenroll.
Fields namespaceSettingsUpdateInput type: NamespaceSettingsUpdateInput
Arguments Name Type Description fullPathID!Full path of the namespace the settings belong to. pipelineVariablesDefaultRolePipelineVariablesDefaultRoleTypeIndicates the default minimum role required to override pipeline variables in the namespace.
Fields Name Type Description ciCdSettingsCiCdSettings!Namespace CI/CD settings after mutation. errors[String!]!Errors encountered during the mutation.
namespacesRegenerateNewWorkItemEmailAddressInput type: NamespacesRegenerateNewWorkItemEmailAddressInput
Arguments Name Type Description fullPathID!Full path of the namespace to regenerate the new work item email address for.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. namespaceNamespaceNamespace after regenerating the new work item email address.
noteConvertToThreadConvert a standard comment to a resolvable thread.
Input type: NoteConvertToThreadInput
Arguments Name Type Description idNoteID!Global ID of the Note to convert.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
oncallRotationCreateInput type: OncallRotationCreateInput
Arguments Fields oncallRotationDestroyInput type: OncallRotationDestroyInput
Arguments Name Type Description 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 oncallRotationUpdateInput type: OncallRotationUpdateInput
Arguments Fields oncallScheduleCreateInput type: OncallScheduleCreateInput
Arguments Name Type Description 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 oncallScheduleDestroyInput type: OncallScheduleDestroyInput
Arguments Name Type Description iidString!On-call schedule internal ID to remove. projectPathID!Project to remove the on-call schedule from.
Fields oncallScheduleUpdateInput type: OncallScheduleUpdateInput
Arguments Name Type Description 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 orbitStartTrialInput type: OrbitStartTrialInput
Arguments Name Type Description groupPathID!Full path of the top-level group.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupGroupGroup the trial was requested for, also returned on error. Read knowledgeGraphEnabled and orbitTrial from it.
orbitUpdateInput type: OrbitUpdateInput
Arguments Name Type Description enabledBoolean!Whether to enable or disable the Knowledge Graph for the group. groupPathID!Full path of the group to update.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. groupGroupGroup after mutation.
organizationConfirmInput type: OrganizationConfirmInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. organizationOrganizationOrganization after mutation.
organizationCreateInput type: OrganizationCreateInput
Arguments Name Type Description avatarUploadAvatar for the organization. descriptionStringDescription of the organization. nameString!Name for the organization. pathString!Path for the organization. visibilityOrganizationVisibilityVisibility for the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. organizationOrganizationOrganization after mutation.
organizationCreateClusterAgentMappingInput type: OrganizationCreateClusterAgentMappingInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation.
organizationDeleteInput type: OrganizationDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. organizationOrganizationSoft-deleted organization.
organizationDeleteClusterAgentMappingInput type: OrganizationDeleteClusterAgentMappingInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation.
organizationRestoreInput type: OrganizationRestoreInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. organizationOrganizationRestored organization.
organizationUpdateInput type: OrganizationUpdateInput
Arguments Name Type Description avatarUploadAvatar for the organization. descriptionStringDescription of the organization. idOrganizationsOrganizationID!ID of the organization to mutate. nameStringName for the organization. pathStringPath for the organization. policyStoreExperimentEnabledBooleanIntroduced as an experiment in GitLab 19.4. visibilityOrganizationVisibilityVisibility for the organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. organizationOrganizationOrganization after mutation.
organizationUserCreateInput type: OrganizationUserCreateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. organizationUserOrganizationUserIntroduced as an experiment in GitLab 19.3.
organizationUserDeleteInput type: OrganizationUserDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. organizationUserOrganizationUserIntroduced as an experiment in GitLab 19.3.
organizationUserUpdateInput type: OrganizationUserUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. organizationUserOrganizationUserIntroduced as an experiment in GitLab 17.5.
pagesMarkOnboardingCompleteInput type: PagesMarkOnboardingCompleteInput
Arguments Name Type Description projectPathID!Full path of the project.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. onboardingCompleteBoolean!Indicates the new onboarding_complete state of the project’s Pages metadata.
personalAccessTokenCreateCreates a personal access token for the current user.
Input type: PersonalAccessTokenCreateInput
Arguments Name Type Description Default 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. false
Fields Name Type Description errors[String!]!Errors encountered during the mutation. tokenStringCreated personal access token.
personalAccessTokenRevokeRevokes a specified personal access token.
Input type: PersonalAccessTokenRevokeInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
personalAccessTokenRotateRotate a specified personal access token.
Input type: PersonalAccessTokenRotateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. tokenStringCreated personal access token.
pipelineCancelInput type: PipelineCancelInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. pipelinePipelinePipeline after mutation.
pipelineCreateInput type: PipelineCreateInput
Arguments Name Type Description asyncBooleanIntroduced as an experiment in GitLab 17.8.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. inputs[CiInputsInput!]Introduced as an experiment in GitLab 17.10. 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 Name Type Description errors[String!]!Errors encountered during the mutation. pipelinePipelinePipeline created after mutation. Null if async: true. requestIdStringIntroduced as an experiment in GitLab 17.8.async: false.
pipelineDestroyInput type: PipelineDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
pipelineExecutionSchedulePolicyTestRunTriggers a test-run for a Scheduled Pipeline Execution Policy on a specific project.
Input type: PipelineExecutionSchedulePolicyTestRunInput
Arguments Name Type Description policyIdSecurityPolicyID!Global ID of the pipeline execution schedule policy to test. projectPathID!Full path of the project to run the test on.
Fields pipelineRetryInput type: PipelineRetryInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. pipelinePipelinePipeline after mutation.
pipelineScheduleCreateInput type: PipelineScheduleCreateInput
Arguments Name Type Description activeBooleanIndicates if the pipeline schedule should be active or not. 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[CiInputsInput!]Introduced as an experiment in GitLab 17.10. 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 Name Type Description errors[String!]!Errors encountered during the mutation. pipelineSchedulePipelineScheduleCreated pipeline schedule.
pipelineScheduleDeleteInput type: PipelineScheduleDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
pipelineSchedulePlayInput type: PipelineSchedulePlayInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. pipelineSchedulePipelineSchedulePipeline schedule after mutation.
pipelineScheduleTakeOwnershipInput type: PipelineScheduleTakeOwnershipInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. pipelineSchedulePipelineScheduleUpdated pipeline schedule ownership.
pipelineScheduleUpdateInput type: PipelineScheduleUpdateInput
Arguments Name Type Description activeBooleanIndicates if the pipeline schedule should be active or not. 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[CiInputsInput!]Introduced as an experiment in GitLab 17.11. refStringRef of the pipeline schedule. variables[PipelineScheduleVariableInput!]Variables for the pipeline schedule.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. pipelineSchedulePipelineScheduleUpdated pipeline schedule.
pipelineTriggerCreateInput type: PipelineTriggerCreateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. pipelineTriggerPipelineTriggerMutated pipeline trigger token.
pipelineTriggerDeleteInput type: PipelineTriggerDeleteInput
Arguments Name Type Description idCiTriggerID!ID of the pipeline trigger token to delete.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
pipelineTriggerUpdateInput type: PipelineTriggerUpdateInput
Arguments Name Type Description descriptionString!Description of the pipeline trigger token. idCiTriggerID!ID of the pipeline trigger token to update.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. pipelineTriggerPipelineTriggerMutated pipeline trigger token.
Input type: ProcessUserBillablePromotionRequestInput
Arguments Name Type Description statusMemberApprovalStatusType!Status for the member approval request (approved, denied, pending). userIdUserID!Global ID of user to be promoted.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. resultUserPromotionStatusTypeStatus of the user promotion process (success, partial_success, failed).
projectBlobsRemoveInput type: projectBlobsRemoveInput
Arguments Name Type Description blobOids[String!]!List of blob oids. projectPathID!Full path of the project to replace.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
projectCiCdSettingsUpdateInput type: ProjectCiCdSettingsUpdateInput
Arguments Name Type Description 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. jobTokenScopeEnabledBooleanDeprecated 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 projectCustomAttributeSetSets (creates or updates) a custom attribute on a project. Only available to admins.
Input type: ProjectCustomAttributeSetInput
Arguments Name Type Description keyString!Key of the custom attribute. projectPathID!Full path of the project. valueString!Value of the custom attribute.
Fields Name Type Description customAttributeCustomAttributeCustom attribute after mutation. errors[String!]!Errors encountered during the mutation.
projectMemberBulkUpdateUpdates multiple members of a project. To use this mutation, you must have at least the Maintainer role.
Input type: ProjectMemberBulkUpdateInput
Arguments Name Type Description accessLevelMemberAccessLevel!Access level to update the members to. expiresAtTimeDate and time the membership expires. projectIdProjectID!Global ID of the project. userIds[UserID!]!Global IDs of the members.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectMembers[ProjectMember!]Project members after mutation. queuedMemberApprovalsMemberApprovalConnectionList of queued pending members approvals. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projectSavedReplyCreateInput type: ProjectSavedReplyCreateInput
Arguments Name Type Description contentString!Content of the saved reply. nameString!Name of the saved reply. projectIdProjectID!Project for the saved reply.
Fields projectSavedReplyDestroyInput type: ProjectSavedReplyDestroyInput
Arguments Fields projectSavedReplyUpdateInput type: ProjectSavedReplyUpdateInput
Arguments Fields projectSecretCreateInput type: ProjectSecretCreateInput
Arguments Name Type Description branchString!Branches that can access the secret. 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 projectSecretDeleteInput type: ProjectSecretDeleteInput
Arguments Name Type Description nameString!Name of the project secret. projectPathID!Project of the secret.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectSecretProjectSecretDeleted project secret.
projectSecretUpdateInput type: ProjectSecretUpdateInput
Arguments Name Type Description branchStringNew branches that can access the secret. 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 projectSecretsManagerDeprovisionInput type: ProjectSecretsManagerDeprovisionInput
Arguments Name Type Description projectPathID!Project of the secrets manager.
Fields projectSecretsManagerInitializeInput type: ProjectSecretsManagerInitializeInput
Arguments Name Type Description projectPathID!Project of the secrets manager.
Fields projectSecretsPermissionDeleteInput type: ProjectSecretsPermissionDeleteInput
Arguments Name Type Description principalPrincipalInput!User/MemberRole/Role whose access is being removed. projectPathID!Project from which the permissions are removed.
Fields projectSecretsPermissionUpdateInput type: ProjectSecretsPermissionUpdateInput
Arguments Name Type Description actions[SecretsManagementAction!]!Actions that can be performed on secrets. expiredAtISO8601DateExpiration date for Secret Permission (optional). principalPrincipalInput!User/MemberRole/Role that is provided access. projectPathID!Project to which the permissions are added.
Fields projectSecurityExclusionCreateInput type: ProjectSecurityExclusionCreateInput
Arguments Name Type Description activeBoolean!Whether the exclusion is active. 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 projectSecurityExclusionDeleteInput type: ProjectSecurityExclusionDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
projectSecurityExclusionUpdateInput type: ProjectSecurityExclusionUpdateInput
Arguments Fields projectSetComplianceFrameworkDeprecated in GitLab 17.11. Use mutation ProjectUpdateComplianceFrameworks instead of this.
Input type: ProjectSetComplianceFrameworkInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectProject after mutation.
projectSetContinuousVulnerabilityScanningDeprecated in GitLab 17.3. CVS has been enabled permanently. See this epic for more information.
Input type: ProjectSetContinuousVulnerabilityScanningInput
Arguments Name Type Description enableBoolean!Desired status for continuous vulnerability scanning feature. projectPathID!Full path of the project.
Fields Name Type Description continuousVulnerabilityScanningEnabledBoolean!Whether feature is enabled. errors[String!]!Errors encountered during the mutation.
projectSetLockedInput type: ProjectSetLockedInput
Arguments Name Type Description filePathString!Full path to the file. lockBoolean!Whether or not to lock the file path. projectPathID!Full path of the project to mutate.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectProject after mutation.
projectSettingsUpdateInput type: ProjectSettingsUpdateInput
Arguments Name Type Description aiAuditEventsStorageEnabledBooleanIntroduced as an experiment in GitLab 19.2. duoAutoModeEnabledBooleanIndicates whether Duo Agent Platform auto mode is enabled for the project. 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. webBasedCommitSigningEnabledBooleanIntroduced as an experiment in GitLab 18.2.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectSettingsProjectSetting!Project settings after mutation.
projectSubscriptionCreateInput type: ProjectSubscriptionCreateInput
Arguments Name Type Description projectPathString!Full path of the downstream project of the Project Subscription. upstreamPathString!Full path of the upstream project of the Project Subscription.
Fields projectSubscriptionDeleteInput type: ProjectSubscriptionDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectProject after mutation.
projectSyncForkInput type: ProjectSyncForkInput
Arguments Name Type Description projectPathID!Full path of the project to initialize. targetBranchString!Ref of the fork to fetch into.
Fields Name Type Description detailsForkDetailsUpdated fork details. errors[String!]!Errors encountered during the mutation.
projectTargetBranchRuleCreateInput type: ProjectTargetBranchRuleCreateInput
Arguments Name Type Description nameString!Name for the target branch rule. projectIdProjectID!Project ID for the target branch rule. targetBranchString!Target branch for the target branch rule.
Fields projectTargetBranchRuleDestroyInput type: ProjectTargetBranchRuleDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
projectTextReplaceInput type: projectTextReplaceInput
Arguments Name Type Description projectPathID!Full path of the project to replace. replacements[String!]!List of text patterns to replace project-wide.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
projectTransferInput type: ProjectTransferInput
Arguments Name Type Description idProjectID!Global ID of the project to transfer. namespaceIdNamespaceID!Global ID of the target namespace.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectProject after mutation.
projectUpdateComplianceFrameworksUpdate compliance frameworks for a project.
Input type: ProjectUpdateComplianceFrameworksInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectProject after mutation.
prometheusIntegrationCreateDeprecated in GitLab 18.2. Use HttpIntegrationCreate.
Input type: PrometheusIntegrationCreateInput
Arguments Name Type Description Default activeBoolean!Whether the integration is receiving alerts. apiUrlStringDeprecated in GitLab 18.2. Feature removed in 16.0. nameStringName of the integration. "Prometheus"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. HTTP
Fields prometheusIntegrationResetTokenDeprecated in GitLab 18.2. Use HttpIntegrationResetToken.
Input type: PrometheusIntegrationResetTokenInput
Arguments Fields prometheusIntegrationUpdateDeprecated in GitLab 18.2. Use HttpIntegrationUpdate.
Input type: PrometheusIntegrationUpdateInput
Arguments Fields Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide .
Input type: PromoteToEpicInput
Arguments Name Type Description groupPathIDGroup the promoted epic will belong to. iidString!IID of the issue to mutate. projectPathID!Project the issue to mutate is in.
Fields Name Type Description epicEpicEpic after issue promotion. errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
refreshFindingTokenStatusInput type: RefreshFindingTokenStatusInput
Arguments Name Type Description vulnerabilityIdVulnerabilityID!Global ID of the Vulnerability whose token status should be refreshed.
Fields refreshSecurityFindingTokenStatusInput type: RefreshSecurityFindingTokenStatusInput
Arguments Name Type Description securityFindingUuidString!UUID of the Security::Finding whose token status should be refreshed (MR context).
Fields refreshStandardsAdherenceChecksInput type: RefreshStandardsAdherenceChecksInput
Arguments Name Type Description groupPathID!Group path.
Fields refreshVulnerabilityFindingTokenStatusInput type: RefreshVulnerabilityFindingTokenStatusInput
Arguments Name Type Description vulnerabilityIdVulnerabilityID!Global ID of the Vulnerability whose token status should be refreshed.
Fields releaseAssetLinkCreateInput type: ReleaseAssetLinkCreateInput
Arguments Name Type Description Default directAssetPathStringRelative path for a direct asset link. linkTypeReleaseAssetLinkTypeType of the asset link. OTHERnameString!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 releaseAssetLinkDeleteInput type: ReleaseAssetLinkDeleteInput
Arguments Name Type Description idReleasesLinkID!ID of the release asset link to delete.
Fields releaseAssetLinkUpdateInput type: ReleaseAssetLinkUpdateInput
Arguments Fields releaseCreateInput type: ReleaseCreateInput
Arguments Name Type Description assetsReleaseAssetsInputAssets associated to the release. 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 Name Type Description errors[String!]!Errors encountered during the mutation. releaseReleaseRelease after mutation.
releaseDeleteInput type: ReleaseDeleteInput
Arguments Name Type Description projectPathID!Full path of the project the release is associated with. tagNameString!Name of the tag associated with the release to delete.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. releaseReleaseDeleted release.
releaseUpdateInput type: ReleaseUpdateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. releaseReleaseRelease after mutation.
removeProjectFromSecurityDashboardInput type: RemoveProjectFromSecurityDashboardInput
Arguments Name Type Description idProjectID!ID of the project to remove from the Instance Security Dashboard.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
repositionImageDiffNoteRepositions a DiffNote on an image (a Note where the position.positionType is "image").
Input type: RepositionImageDiffNoteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
restorePagesDeploymentRestores a Pages deployment that has been scheduled for deletion.
Input type: RestorePagesDeploymentInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. pagesDeploymentPagesDeployment!Restored Pages Deployment.
resyncSecurityPoliciesTriggers a resynchronization of security policies linked to the given project or group (full_path).
Input type: ResyncSecurityPoliciesInput
Arguments Name Type Description Default fullPathString!Full path of the project or group. relationshipRelationshipTypeRelationship of the policies to resync. DIRECT
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
runnerAssignToProjectInput type: RunnerAssignToProjectInput
Arguments Name Type Description projectPathID!Full path of the project to which the runner will be assigned. runnerIdCiRunnerID!ID of the runner to assign to the project .
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
runnerBulkPauseInput type: RunnerBulkPauseInput
Arguments Name Type Description ids[CiRunnerID!]!IDs of the runners to pause or unpause. pausedBoolean!Indicates the runner is not allowed to receive jobs.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. updatedCountIntNumber of records effectively updated. Only present if operation was performed synchronously. updatedRunners[CiRunner!]Runners after mutation.
runnerCacheClearInput type: RunnerCacheClearInput
Arguments Name Type Description projectIdProjectID!Global ID of the project that will have its runner cache cleared.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
runnerCreateInput type: RunnerCreateInput
Arguments Name Type Description accessLevelCiRunnerAccessLevelAccess level of the runner. 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. privateProjectsMinutesCostFactorFloatIntroduced as an experiment in GitLab 17.7. projectIdProjectIDGlobal ID of the project that the runner is created in (valid only for project runner). publicProjectsMinutesCostFactorFloatIntroduced as an experiment in GitLab 17.7. 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 21 days in the future, and cannot exceed instance/group/project limits. tokenRotationDeadlineTimeIntroduced as an experiment in GitLab 18.10.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. runnerCiRunnerRunner after mutation.
runnerDeleteInput type: RunnerDeleteInput
Arguments Name Type Description idCiRunnerID!ID of the runner to delete.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
runnerUnassignFromProjectInput type: RunnerUnassignFromProjectInput
Arguments Name Type Description projectPathID!Full path of the project from which the runner will be unassigned. runnerIdCiRunnerID!ID of the runner to unassign from the project.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
runnerUpdateInput type: RunnerUpdateInput
Arguments Name Type Description accessLevelCiRunnerAccessLevelAccess level of the runner. activeBooleanDeprecated in GitLab 14.8. Renamed. Use paused instead. associatedProjects[ProjectID!]Projects associated with the runner. Available only for project runners. 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. privateProjectsMinutesCostFactorFloatIntroduced as an experiment in GitLab 17.7. publicProjectsMinutesCostFactorFloatIntroduced as an experiment in GitLab 17.7. runUntaggedBooleanIndicates the runner is able to run untagged jobs. tagList[String!]Tags associated with the runner.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. runnerCiRunnerRunner after mutation.
runnersExportUsageInput type: RunnersExportUsageInput
Arguments Name Type Description Default 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. 1000runnerTypeCiRunnerTypeScope 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 Name Type Description errors[String!]!Errors encountered during the mutation.
runnersRegistrationTokenResetDeprecated in GitLab 17.7. Underlying feature was deprecated in 15.6 and will be removed in 18.0.
Input type: RunnersRegistrationTokenResetInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. tokenStringRunner token after mutation.
safeDisablePipelineVariablesInput type: SafeDisablePipelineVariablesInput
Arguments Name Type Description fullPathID!Full path of the group to disable pipeline variables for.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. successBoolean!Indicates whether the migration was successfully enqueued.
savedReplyCreateInput type: SavedReplyCreateInput
Arguments Name Type Description contentString!Content of the saved reply. nameString!Name of the saved reply.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. savedReplySavedReplySaved reply after mutation.
savedReplyDestroyInput type: SavedReplyDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. savedReplySavedReplySaved reply after mutation.
savedReplyUpdateInput type: SavedReplyUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. savedReplySavedReplySaved reply after mutation.
scanExecutionPolicyCommitCommits the policy_yaml content to the assigned security policy project for the given project (full_path).
Input type: ScanExecutionPolicyCommitInput
Arguments Name Type Description 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. projectPathIDDeprecated in GitLab 14.10. Use fullPath.
Fields Name Type Description branchStringName of the branch to which the policy changes are committed. errors[String!]!Errors encountered during the mutation. validationErrors[SecurityPolicyValidationError!]Validation errors encountered during execution of the mutation.
secretsManagerEnableAddOnInput type: SecretsManagerEnableAddOnInput
Arguments Name Type Description groupPathID!Full path of the top-level group to enable the Secrets Manager add-on for.
Fields Name Type Description entitlementSecretsManagerEntitlementSecrets Manager entitlement state after enabling the add-on. Null when enabling failed; see errors for the reason. errors[String!]!Errors encountered during the mutation.
secretsManagerInstanceEnableAddOnInput type: SecretsManagerInstanceEnableAddOnInput
Fields Name Type Description entitlementSecretsManagerEntitlementInstance-level Secrets Manager entitlement state after enabling the add-on. Null when enabling failed; see errors for the reason. errors[String!]!Errors encountered during the mutation.
secretsManagerInstanceRefreshEntitlementInput type: SecretsManagerInstanceRefreshEntitlementInput
Fields Name Type Description entitlementSecretsManagerEntitlementInstance-wide Secrets Manager entitlement state as the subscription service reports it now. Null when refreshing failed; see errors for the reason. errors[String!]!Errors encountered during the mutation.
secretsManagerInstanceStartTrialInput type: SecretsManagerInstanceStartTrialInput
Fields Name Type Description entitlementSecretsManagerEntitlementInstance-wide Secrets Manager entitlement state after starting the trial. Null when the post-trial state cannot be resolved; query secretsManagerInstanceEntitlement instead. errors[String!]!Errors encountered during the mutation.
secretsManagerRefreshEntitlementInput type: SecretsManagerRefreshEntitlementInput
Arguments Name Type Description groupPathID!Full path of the top-level group to refresh the Secrets Manager entitlement for.
Fields Name Type Description entitlementSecretsManagerEntitlementSecrets Manager entitlement state as the subscription service reports it now. Null when the subscription service could not be reached; see errors. errors[String!]!Errors encountered during the mutation.
secretsManagerStartTrialInput type: SecretsManagerStartTrialInput
Arguments Name Type Description groupPathID!Full path of the top-level group to start a Secrets Manager trial for.
Fields Name Type Description 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.
securityAttributeCreateInput type: SecurityAttributeCreateInput
Arguments Fields securityAttributeDestroyInput type: SecurityAttributeDestroyInput
Arguments Fields Name Type Description deletedAttributeGidSecurityAttributeIDGlobal ID of the destroyed security attribute. errors[String!]!Errors encountered during the mutation.
securityAttributeProjectUpdateInput type: SecurityAttributeProjectUpdateInput
Arguments Fields Name Type Description addedCountIntNumber of attributes added. errors[String!]!Errors encountered during the mutation. projectProjectUpdated project. removedCountIntNumber of attributes removed.
securityAttributeUpdateInput type: SecurityAttributeUpdateInput
Arguments Name Type Description colorColorColor of the security attribute. descriptionStringDescription of the security attribute. idSecurityAttributeID!Global ID of the security attribute. nameStringName of the security attribute.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. securityAttributeSecurityAttributeUpdated security attribute.
securityCategoryCreateInput type: SecurityCategoryCreateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. securityCategorySecurityCategoryCreated security category.
securityCategoryDestroyInput type: SecurityCategoryDestroyInput
Arguments Fields securityCategoryUpdateInput type: SecurityCategoryUpdateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. securityCategorySecurityCategoryUpdated security category.
securityFindingCreateIssueInput type: SecurityFindingCreateIssueInput
Arguments Name Type Description projectProjectID!ID of the project to attach the issue to. uuidString!UUID of the security finding to be used to create an issue.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue created after mutation.
securityFindingCreateMergeRequestInput type: SecurityFindingCreateMergeRequestInput
Arguments Name Type Description uuidString!UUID of the security finding to be used to create a merge request.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. mergeRequestMergeRequestMerge Request created after mutation.
securityFindingCreateVulnerabilityInput type: SecurityFindingCreateVulnerabilityInput
Arguments Name Type Description uuidString!UUID of the security finding to be used to create a vulnerability.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityVulnerability created after mutation.
securityFindingDismissInput type: SecurityFindingDismissInput
Arguments Fields securityFindingExternalIssueLinkCreateInput type: SecurityFindingExternalIssueLinkCreateInput
Arguments Fields Input type: SecurityFindingJiraIssueFormUrlCreateInput
Arguments Name Type Description projectProjectID!ID of the project to attach the issue to. uuidString!UUID of the security finding to be used to create an issue.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. jiraIssueFormUrlStringURL to Jira issue creation form with pre-filled vulnerability data.
securityFindingRevertToDetectedInput type: SecurityFindingRevertToDetectedInput
Arguments Name Type Description commentStringComment that explains why finding was reverted to detected status. uuidString!UUID of the finding to be dismissed.
Fields securityFindingSeverityOverrideInput type: SecurityFindingSeverityOverrideInput
Arguments Fields securityPolicyProjectAssignAssigns 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 Name Type Description fullPathStringFull path of the project or group. projectPathIDDeprecated in GitLab 14.10. Use fullPath. securityPolicyProjectIdProjectID!ID of the security policy project.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
securityPolicyProjectCreateCreates and assigns a security policy project for the given project or group (full_path).
Input type: SecurityPolicyProjectCreateInput
Arguments Name Type Description fullPathStringFull path of the project or group. projectPathIDDeprecated in GitLab 14.10. Use fullPath.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectSecurity Policy Project that was created.
securityPolicyProjectCreateAsyncCreates and assigns a security policy project for the given project or group (full_path) async.
Input type: SecurityPolicyProjectCreateAsyncInput
Arguments Name Type Description fullPathString!Full path of the project or group.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
securityPolicyProjectUnassignUnassigns the security policy project for the given project (full_path).
Input type: SecurityPolicyProjectUnassignInput
Arguments Name Type Description fullPathStringFull path of the project or group. projectPathIDDeprecated in GitLab 14.10. Use fullPath.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
securityRefsTrackInput type: SecurityRefsTrackInput
Arguments Fields securityRefsUntrackInput type: SecurityRefsUntrackInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. untrackedRefIds[ID!]Global IDs of refs that were successfully untracked.
securityScanProfileAttachInput type: SecurityScanProfileAttachInput
Arguments Name Type Description Default 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 Name Type Description errors[String!]!Errors encountered during the mutation.
securityScanProfileCreateInput type: SecurityScanProfileCreateInput
Arguments Name Type Description Default 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. truetriggers[SecurityScanProfileTriggerInput!]!Triggers with optional configuration for the scan profile. At least one is required.
Fields securityScanProfileDeleteInput type: SecurityScanProfileDeleteInput
Arguments Fields securityScanProfileDetachInput type: SecurityScanProfileDetachInput
Arguments Name Type Description Default 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 Name Type Description errors[String!]!Errors encountered during the mutation.
securityScanProfileUpdateInput type: SecurityScanProfileUpdateInput
Arguments Name Type Description Default 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. truetriggers[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 securityTrainingUpdateInput type: SecurityTrainingUpdateInput
Arguments Name Type Description 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 setContainerScanningForRegistryEnable/disable container scanning for registry for the given project.
Input type: SetContainerScanningForRegistryInput
Arguments Name Type Description enableBoolean!Desired status for container scanning for registry feature. namespacePathID!Full path of the namespace (project).
Fields Name Type Description containerScanningForRegistryEnabledBooleanWhether the feature is enabled. errors[String!]!Errors encountered during the mutation.
setCvsForContainerScanningEnable or disable continuous vulnerability scanning for container scanning for the given project.
Input type: SetCvsForContainerScanningInput
Arguments Name Type Description enableBoolean!Desired status for CVS for container scanning. projectPathID!Full path of the project.
Fields Name Type Description cvsForContainerScanningEnabledBooleanWhether CVS for container scanning is enabled. errors[String!]!Errors encountered during the mutation.
setCvsForDependencyScanningEnable or disable continuous vulnerability scanning for dependency scanning for the given project.
Input type: SetCvsForDependencyScanningInput
Arguments Name Type Description enableBoolean!Desired status for CVS for dependency scanning. projectPathID!Full path of the project.
Fields Name Type Description cvsForDependencyScanningEnabledBooleanWhether CVS for dependency scanning is enabled. errors[String!]!Errors encountered during the mutation.
setGroupCustomAttributeCreates or updates a custom attribute on a group. Only available to admins.
Input type: SetGroupCustomAttributeInput
Arguments Name Type Description groupPathID!Full path of the group. keyString!Key of the custom attribute. valueString!Value of the custom attribute.
Fields Name Type Description customAttributeCustomAttributeCustom attribute after mutation. errors[String!]!Errors encountered during the mutation.
setGroupSecretPushProtectionEnable or disable secret push protection for a group.
Input type: SetGroupSecretPushProtectionInput
Arguments Name Type Description namespacePathID!Full path of the group. projectsToExclude[Int!]IDs of projects to exclude from the feature. secretPushProtectionEnabledBoolean!Whether to enable the feature.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
setGroupValidityChecksEnable or disable Validity Checks for a group.
Input type: SetGroupValidityChecksInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. validityChecksEnabledBoolean!Indicates whether validity checks have been enabled for the group.
setLicenseConfigurationSourceSet the license information source for a given project.
Input type: SetLicenseConfigurationSourceInput
Arguments Fields setLicenseScanningForCyclonedxEnable/disable license scanning for CycloneDX SBOM files for the given project.
Input type: SetLicenseScanningForCyclonedxInput
Arguments Name Type Description enableBoolean!Desired status for license scanning for CycloneDX files. projectPathID!Full path of the project.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. licenseScanningForCyclonedxEnabledBooleanWhether license scanning for CycloneDX files is enabled.
setPagesForceHttpsInput type: SetPagesForceHttpsInput
Arguments Name Type Description projectPathID!Path of the project to set the pages force HTTPS. valueBoolean!Indicates user wants to enforce HTTPS on their pages.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectProject that was updated.
setPagesUseUniqueDomainInput type: SetPagesUseUniqueDomainInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. projectProjectProject that was updated.
setPreReceiveSecretDetectionEnable/disable secret push protection for the given project.
Input type: SetPreReceiveSecretDetectionInput
Arguments Name Type Description enableBoolean!Desired status for secret push protection feature. namespacePathID!Full path of the namespace (project).
Fields Name Type Description errors[String!]!Errors encountered during the mutation. preReceiveSecretDetectionEnabledBooleanWhether the feature is enabled. secretPushProtectionEnabledBooleanWhether the feature is enabled.
setSecretPushProtectionEnable/disable secret push protection for the given project.
Input type: SetSecretPushProtectionInput
Arguments Name Type Description enableBoolean!Desired status for secret push protection feature. namespacePathID!Full path of the namespace (project).
Fields Name Type Description errors[String!]!Errors encountered during the mutation. preReceiveSecretDetectionEnabledBooleanWhether the feature is enabled. secretPushProtectionEnabledBooleanWhether the feature is enabled.
setValidityChecksEnable/disable secret detection validity checks for the given project.
Input type: SetValidityChecksInput
Arguments Name Type Description enableBoolean!Desired status for validity checks feature. namespacePathID!Full path of the namespace (project).
Fields Name Type Description errors[String!]!Errors encountered during the mutation. validityChecksEnabledBooleanWhether the feature is enabled.
starProjectInput type: StarProjectInput
Arguments Name Type Description projectIdProjectID!Full path of the project to star or unstar. starredBoolean!Indicates whether to star or unstar the project.
Fields Name Type Description countString!Number of stars for the project. errors[String!]!Errors encountered during the mutation.
startVulnerabilityWorkflowCreates and starts a vulnerability workflow execution.
Input type: StartVulnerabilityWorkflowInput
Arguments Fields tagCreateCreates a tag in a project repository.
Rate limited per project by the tags_create_limit application setting.
Input type: TagCreateInput
Arguments Name Type Description Default 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 Name Type Description errors[String!]!Errors encountered during the mutation. tagTagTag after mutation.
tagDeleteInput type: TagDeleteInput
Arguments Name Type Description nameString!Name of the tag. projectPathID!Project full path the branch is associated with.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. tagTagTag after mutation.
Input type: TerraformStateDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
Input type: TerraformStateLockInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
Input type: TerraformStateUnlockInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
timelineEventCreateInput type: TimelineEventCreateInput
Arguments Name Type Description 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 timelineEventDestroyInput type: TimelineEventDestroyInput
Arguments Fields Input type: TimelineEventPromoteFromNoteInput
Arguments Name Type Description noteIdNoteID!Note ID from which the timeline event promoted.
Fields timelineEventTagCreateInput type: TimelineEventTagCreateInput
Arguments Name Type Description nameString!Name of the tag. projectPathID!Project to create the timeline event tag in.
Fields timelineEventUpdateInput type: TimelineEventUpdateInput
Arguments Fields timelogCreateInput type: TimelogCreateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. timelogTimelogTimelog.
timelogDeleteInput type: TimelogDeleteInput
Arguments Name Type Description idTimelogID!Global ID of the timelog.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. timelogTimelogTimelog.
todoCreateInput type: TodoCreateInput
Arguments Name Type Description targetIdTodoableID!Global ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. todoTodoTo-do item created.
todoDeleteAllDoneInput type: TodoDeleteAllDoneInput
Arguments Name Type Description updatedBeforeTimeTo-do items marked as done before the timestamp will be deleted.
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
todoDeleteManyInput type: TodoDeleteManyInput
Arguments Name Type Description ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).
Fields Name Type Description errors[String!]!Errors encountered during the mutation.
todoMarkDoneInput type: TodoMarkDoneInput
Arguments Name Type Description idTodoID!Global ID of the to-do item to mark as done.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. todoTodo!Requested to-do item.
todoResolveManyInput type: TodoResolveManyInput
Arguments Name Type Description ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).
Fields Name Type Description errors[String!]!Errors encountered during the mutation. todos[Todo!]!Resolved to-do items.
todoRestoreInput type: TodoRestoreInput
Arguments Name Type Description idTodoID!Global ID of the to-do item to restore.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. todoTodo!Requested to-do item.
todoRestoreManyInput type: TodoRestoreManyInput
Arguments Name Type Description ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).
Fields Name Type Description errors[String!]!Errors encountered during the mutation. todos[Todo!]!Restored to-do items.
todoSnoozeInput type: TodoSnoozeInput
Arguments Name Type Description idTodoID!Global ID of the to-do item to be snoozed. snoozeUntilTime!Time until which the todo should be snoozed.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. todoTodo!Requested to-do item.
todoSnoozeManyInput type: TodoSnoozeManyInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. todos[Todo!]!Snoozed to-do items.
todoUnSnoozeInput type: TodoUnSnoozeInput
Arguments Name Type Description idTodoID!Global ID of the to-do item to be snoozed.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. todoTodo!Requested to-do item.
todoUnsnoozeManyInput type: TodoUnsnoozeManyInput
Arguments Name Type Description ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).
Fields Name Type Description errors[String!]!Errors encountered during the mutation. todos[Todo!]!Unsnoozed to-do items.
todosMarkAllDoneInput type: TodosMarkAllDoneInput
Arguments Name Type Description action[TodoActionEnum!]Action to be filtered. authorId[ID!]ID of an author. 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 Name Type Description errors[String!]!Errors encountered during the mutation. todos[Todo!]!Updated to-do items.
unlinkProjectComplianceViolationIssueInput type: UnlinkProjectComplianceViolationIssueInput
Arguments Fields Updates the permission settings for an AI tool rule.
Input type: UpdateAiToolRuleInput
Arguments Name Type Description backgroundAccessAiBackgroundToolPermissionIntroduced as an experiment in GitLab 19.3. 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”. unsetAccessTypes[AiToolAccessType!]Introduced as an experiment in GitLab 19.5. webAccessAiToolPermissionPermission mode for web surface.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. toolRuleAiToolRuleUpdated tool rule after mutation.
updateAlertStatusInput type: UpdateAlertStatusInput
Arguments Fields updateBoardInput type: UpdateBoardInput
Arguments Name Type Description assigneeIdUserIDID of user to be assigned to the board. 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 Name Type Description boardBoardBoard after mutation. errors[String!]!Errors encountered during the mutation.
updateBoardEpicUserPreferencesDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: UpdateBoardEpicUserPreferencesInput
Arguments Name Type Description boardIdBoardID!Board global ID. collapsedBoolean!Whether the epic should be collapsed in the board. epicIdEpicID!ID of an epic to set preferences for.
Fields Name Type Description epicUserPreferencesBoardEpicUserPreferencesUser preferences for the epic in the board after mutation. errors[String!]!Errors encountered during the mutation.
updateBoardListInput type: UpdateBoardListInput
Arguments Name Type Description collapsedBooleanIndicates if the list is collapsed for the user. listIdListID!Global ID of the list. positionIntPosition of list within the board.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. listBoardListMutated list.
updateComplianceFrameworkInput type: UpdateComplianceFrameworkInput
Arguments Fields Name Type Description complianceFrameworkComplianceFrameworkCompliance framework after mutation. errors[String!]!Errors encountered during the mutation.
updateComplianceRequirementInput type: UpdateComplianceRequirementInput
Arguments Fields updateComplianceRequirementsControlInput type: UpdateComplianceRequirementsControlInput
Arguments Fields updateContainerExpirationPolicyInput type: UpdateContainerExpirationPolicyInput
Arguments Fields updateContainerProtectionRepositoryRuleUpdates a container repository protection rule that controls who can modify container images based on user roles.
Input type: UpdateContainerProtectionRepositoryRuleInput
Arguments Name Type Description idContainerRegistryProtectionRuleID!Global ID of the container repository protection rule to be updated. minimumAccessLevelForDeleteContainerProtectionRepositoryRuleAccessLevelIntroduced as an experiment in GitLab 17.11.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 updateContainerProtectionTagRuleUpdates a protection rule that controls which user roles can modify container image tags matching a specified pattern.
Input type: UpdateContainerProtectionTagRuleInput
Arguments Name Type Description 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 Name Type Description containerProtectionTagRuleContainerProtectionTagRuleProtection rule for container image tags after creation. errors[String!]!Errors encountered during the mutation.
updateCustomDashboardUpdates a custom dashboard.
Input type: UpdateCustomDashboardInput
Arguments Fields updateDependencyProxyImageTtlGroupPolicyThese settings can be adjusted only by the group Owner.
Input type: UpdateDependencyProxyImageTtlGroupPolicyInput
Arguments Name Type Description 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 updateDependencyProxyPackagesSettingsUpdates 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 Name Type Description 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 updateDependencyProxySettingsThese settings can be adjusted only by the group Owner.
Input type: UpdateDependencyProxySettingsInput
Arguments Name Type Description 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 Name Type Description dependencyProxySettingDependencyProxySettingGroup dependency proxy settings after mutation. errors[String!]!Errors encountered during the mutation.
updateDuoWorkflowAgentPrivilegesInput type: UpdateDuoWorkflowAgentPrivilegesInput
Arguments Name Type Description agentPrivileges[Int!]Replaces the set of actions the agent is allowed to perform. preApprovedAgentPrivileges[Int!]Replaces the set of actions the agent can perform without asking for approval. workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to update.
Fields Input type: UpdateDuoWorkflowToolCallApprovalsInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during update. workflowDuoWorkflowUpdated workflow with new tool approvals.
updateDuoWorkflowWebSearchInput type: UpdateDuoWorkflowWebSearchInput
Arguments Name Type Description webSearchEnabledBoolean!Whether web search should be enabled for the session. workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to update.
Fields updateEpicDeprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide .
Input type: UpdateEpicInput
Arguments Name Type Description addLabelIds[ID!]IDs of labels to be added to the epic. addLabels[String!]Array of labels to be added to the epic. 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 Name Type Description epicEpicEpic after mutation. errors[String!]!Errors encountered during the mutation.
updateEpicBoardListDeprecated in GitLab 17.5. Replaced by WorkItem type.
Input type: UpdateEpicBoardListInput
Arguments Name Type Description collapsedBooleanIndicates if the list is collapsed for the user. listIdBoardsEpicListID!Global ID of the epic list. positionIntPosition of list within the board.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. listEpicListMutated epic list.
updateImageDiffNoteUpdates 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 Fields Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
updateIssueInput type: UpdateIssueInput
Arguments Name Type Description addLabelIds[ID!]IDs of labels to be added to the issue. confidentialBooleanIndicates the issue is confidential. descriptionStringDescription of the issue. dueDateISO8601DateDue date of the issue. epicIdEpicIDDeprecated 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue after mutation.
updateIterationInput type: UpdateIterationInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. iterationIterationUpdated iteration.
updateNamespacePackageSettingsThese settings can be adjusted only by the group Owner.
Input type: UpdateNamespacePackageSettingsInput
Arguments Name Type Description auditEventsEnabledBooleanIndicates whether audit events are created when publishing or deleting a package in the namespace (Premium and Ultimate only). genericDuplicateExceptionRegexUntrustedRegexpWhen generic_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When generic_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected. 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 or versions that match this regex. When maven_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected. 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 or versions that match this regex. When nuget_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected. 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. When terraform_module_duplicates_allowed is true, duplicate packages with names that match this regex are rejected. terraformModuleDuplicatesAllowedBooleanIndicates whether duplicate Terraform packages are allowed for the namespace.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. packageSettingsPackageSettingsNamespace package setting after mutation.
updateNoteUpdates 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 Name Type Description bodyStringContent of the note. idNoteID!Global ID of the note to update.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. noteNoteNote after mutation. quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.
updatePackagesCleanupPolicyInput type: UpdatePackagesCleanupPolicyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. packagesCleanupPolicyPackagesCleanupPolicyPackages cleanup policy after mutation.
updatePackagesProtectionRuleUpdates a package protection rule to restrict access to project packages. You can prevent users without certain permissions from altering packages.
Input type: UpdatePackagesProtectionRuleInput
Arguments Name Type Description idPackagesProtectionRuleID!Global ID of the package protection rule to be updated. minimumAccessLevelForDeletePackagesProtectionRuleAccessLevelForDeleteIntroduced as an experiment in GitLab 17.10.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 updateProjectComplianceViolationInput type: UpdateProjectComplianceViolationInput
Arguments Fields updateRequirementInput type: UpdateRequirementInput
Arguments Name Type Description descriptionStringDescription of the requirement. iidStringDeprecated 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 Name Type Description errors[String!]!Errors encountered during the mutation. requirementRequirementRequirement after mutation.
updateSnippetInput type: UpdateSnippetInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. snippetSnippetSnippet after mutation.
Updates a protection rule for a Terraform state backend.
Input type: UpdateTerraformStateProtectionRuleInput
Arguments Name Type Description allowedFromTerraformStateProtectionRuleAllowedFromIntroduced as an experiment in GitLab 18.11.ANYWHERE allows all sources, CI_ONLY requires a CI job token, CI_ON_PROTECTED_BRANCH_ONLY requires a CI job on a protected branch. idTerraformStateProtectionRuleID!Global ID of the Terraform state protection rule to update. minimumAccessLevelForWriteTerraformStateProtectionRuleAccessLevelIntroduced as an experiment in GitLab 18.11.DEVELOPER, MAINTAINER, OWNER, or ADMIN. stateNameStringIntroduced as an experiment in GitLab 18.11.
Fields updateVirtualRegistriesSettingUpdates or creates virtual registries settings for a root group.
Input type: UpdateVirtualRegistriesSettingInput
Arguments Name Type Description enabledBooleanEnable or disable the virtual registries. fullPathID!Group path for the group virtual registries.
Fields uploadCreateCreates an upload (uploads a file to a project or group for use in Markdown).
Input type: UploadCreateInput
Arguments Name Type Description 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 Name Type Description altStringAlt text for the uploaded file. Usually the name of the file. 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.
uploadDeleteDeletes an upload.
Input type: UploadDeleteInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. uploadFileUploadDeleted upload.
upsertFlatUserCapUpdate the flat per-user budget cap for a subscription.
Input type: UpsertFlatUserCapInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. flatUserCapFloatUpdated flat per-user budget cap. flatUserCapEnabledBooleanWhether the flat per-user budget cap is enabled.
upsertUserBudgetCapOverridesBulk upsert per-user budget cap overrides.
Input type: UpsertUserBudgetCapOverridesInput
Arguments Name Type Description 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 userAchievementPrioritiesUpdateInput type: UserAchievementPrioritiesUpdateInput
Arguments Name Type Description userAchievementIds[AchievementsUserAchievementID!]!Global IDs of the user achievements being prioritized, ordered from highest to lowest priority.
Fields userAchievementsDeleteInput type: UserAchievementsDeleteInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. userAchievementUserAchievementDeleted user achievement.
userAchievementsUpdateInput type: UserAchievementsUpdateInput
Arguments Name Type Description awardMessageStringMessage to associate with the awarded achievement. showOnProfileBooleanIndicates whether or not the user achievement is visible on the profile. userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being updated.
Fields userAddOnAssignmentBulkCreateInput type: UserAddOnAssignmentBulkCreateInput
Arguments Fields Name Type Description addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation. errors[String!]!Errors encountered during the mutation. usersAddOnUserConnectionUsers who the add-on purchase was assigned to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
userAddOnAssignmentBulkRemoveInput type: UserAddOnAssignmentBulkRemoveInput
Arguments Fields Name Type Description addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation. errors[String!]!Errors encountered during the mutation. usersAddOnUserConnectionUsers who was unassigned from the add-on purchase. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
userAddOnAssignmentCreateInput type: UserAddOnAssignmentCreateInput
Arguments Fields Name Type Description addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation. errors[String!]!Errors encountered during the mutation. userAddOnUserUser who the add-on purchase was assigned to.
userAddOnAssignmentRemoveInput type: UserAddOnAssignmentRemoveInput
Arguments Fields Name Type Description addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation. errors[String!]!Errors encountered during the mutation. userAddOnUserUser that the add-on was removed from.
userCalloutCreateInput type: UserCalloutCreateInput
Arguments Name Type Description featureNameString!Feature name you want to dismiss the callout for.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. userCalloutUserCallout!User callout dismissed.
userCustomAttributeSetCreates or updates a custom attribute on a user. Only available to admins.
Input type: UserCustomAttributeSetInput
Arguments Name Type Description keyString!Key of the custom attribute. userIdUserID!Global ID of the user. valueString!Value of the custom attribute.
Fields Name Type Description customAttributeCustomAttributeCustom attribute after mutation. errors[String!]!Errors encountered during the mutation.
userGroupCalloutCreateInput type: UserGroupCalloutCreateInput
Arguments Name Type Description featureNameString!Feature name you want to dismiss the callout for. groupIdGroupID!Group for the callout.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. userGroupCalloutUserGroupCallout!User group callout dismissed.
userPreferencesUpdateInput type: UserPreferencesUpdateInput
Arguments Name Type Description 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. orbitSettingsJSONIntroduced as an experiment in GitLab 19.0. organizationGroupsProjectsDisplayOrganizationGroupProjectDisplayIntroduced as an experiment in GitLab 17.2. organizationGroupsProjectsSortOrganizationGroupProjectSortIntroduced as an experiment in GitLab 17.2. projectsSortProjectSortSort order for projects. useWorkItemsViewBooleanDeprecated in GitLab 19.5. Work item view is always used. visibilityPipelineIdTypeVisibilityPipelineIdTypeDetermines whether the pipeline list shows ID or IID. wikiUseAutoCommitMessageBooleanIntroduced as an experiment in GitLab 18.10. workItemsDisplaySettingsJSONIntroduced as an experiment in GitLab 18.1.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. userPreferencesUserPreferencesUser preferences after mutation.
userSetNamespaceCommitEmailInput type: UserSetNamespaceCommitEmailInput
Arguments Name Type Description emailIdEmailIDID of the email to set. namespaceIdNamespaceID!ID of the namespace to set the namespace commit email for.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. namespaceCommitEmailNamespaceCommitEmailUser namespace commit email after mutation.
valueStreamCreateCreates a value stream.
Input type: ValueStreamCreateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. valueStreamValueStreamCreated value stream.
valueStreamDestroyDestroy a value stream.
Input type: ValueStreamDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. valueStreamValueStreamValue stream deleted after mutation.
valueStreamUpdateUpdates a value stream.
Input type: ValueStreamUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. valueStreamValueStreamUpdated value stream.
verifiedNamespaceCreateCreate a verified namespace and mark all child catalog resources with the passed verification level info.
Input type: VerifiedNamespaceCreateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
virtualRegistriesCleanupPolicyUpsertCreate or update virtual registries cleanup policy for a root group.
Input type: VirtualRegistriesCleanupPolicyUpsertInput
Arguments Name Type Description cadenceIntJob cadence for the cleanup process. Allowed values are 1, 7, 14, 30, 90. Default is 7. 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 vulnerabilitiesArchiveInput type: VulnerabilitiesArchiveInput
Arguments Name Type Description dateDate!Last update date of vulnerabilities being archived. projectIdProjectID!ID of the project to attach the vulnerability to.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. statusString!Status of the action.
vulnerabilitiesCreateIssueInput type: VulnerabilitiesCreateIssueInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. issueIssueIssue created after mutation.
vulnerabilitiesDismissInput type: VulnerabilitiesDismissInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilities[Vulnerability!]!Vulnerabilities after state change.
vulnerabilitiesRemoveAllFromProjectRemove all Vulnerabilities and related information from a given project. Introduced in GitLab 16.7.
Input type: VulnerabilitiesRemoveAllFromProjectInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. projects[Project!]!Projects for which the deletion was scheduled.
vulnerabilitiesSeverityOverrideInput type: vulnerabilitiesSeverityOverrideInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilities[Vulnerability!]!Vulnerabilities after severity change.
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 Name Type Description vulnerabilityIdVulnerabilityID!ID of the vulnerability to remediate.
Fields vulnerabilityConfirmInput type: VulnerabilityConfirmInput
Arguments Name Type Description commentStringComment why vulnerability was confirmed (maximum 50,000 characters). idVulnerabilityID!ID of the vulnerability to be confirmed.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityVulnerability after state change.
vulnerabilityCreateInput type: VulnerabilityCreateInput
Arguments Name Type Description Default 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). UNKNOWNsolutionStringInstructions for how to fix the vulnerability. stateVulnerabilityStateState of the vulnerability (defaults to detected). DETECTED
Fields Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityVulnerability created.
vulnerabilityDismissInput type: VulnerabilityDismissInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityVulnerability after state change.
vulnerabilityDismissFalsePositiveFlagDismiss a vulnerability false positive flag.
Input type: VulnerabilityDismissFalsePositiveFlagInput
Arguments Name Type Description idVulnerabilityID!ID of the vulnerability to dismiss false positive flag for.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityVulnerability after dismissing false positive flag.
vulnerabilityExternalIssueLinkCreateInput type: VulnerabilityExternalIssueLinkCreateInput
Arguments Fields vulnerabilityExternalIssueLinkDestroyInput type: VulnerabilityExternalIssueLinkDestroyInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation.
vulnerabilityIssueLinkCreateInput type: VulnerabilityIssueLinkCreateInput
Arguments Name Type Description 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 vulnerabilityLinkMergeRequestLink a merge request to a vulnerability.
Input type: VulnerabilityLinkMergeRequestInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityUpdated vulnerability.
vulnerabilityResolveInput type: VulnerabilityResolveInput
Arguments Name Type Description commentStringComment why vulnerability was resolved (maximum 50,000 characters). idVulnerabilityID!ID of the vulnerability to be resolved.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityVulnerability after state change.
vulnerabilityRevertToDetectedInput type: VulnerabilityRevertToDetectedInput
Arguments Name Type Description commentStringComment why vulnerability was reverted to detected (maximum 50,000 characters). idVulnerabilityID!ID of the vulnerability to be reverted to detected.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityVulnerability after state change.
vulnerabilityUnlinkMergeRequestUnlink a merge request from a vulnerability.
Input type: VulnerabilityUnlinkMergeRequestInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. vulnerabilityVulnerabilityUpdated vulnerability.
wikiPageSubscribeInput type: WikiPageSubscribeInput
Arguments Name Type Description idWikiPageMetaID!Global ID of the wiki page meta record. subscribedBoolean!Desired state of the subscription.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. wikiPageWikiPageWiki page after mutation.
workItemAddClosingMergeRequestAdds a closing merge request to a work item.
Input type: WorkItemAddClosingMergeRequestInput
Arguments Name Type Description 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 workItemAddLinkedItemsAdd linked items to the work item.
Input type: WorkItemAddLinkedItemsInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. messageStringLinked items update result message. workItemWorkItemUpdated work item.
workItemAvailabilityToggleEnables or disables a work item type for a namespace.
Input type: WorkItemAvailabilityToggleInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. workItemTypeWorkItemTypeWork item type after the availability change.
workItemBulkMoveMoves work items between projects or groups.
Input type: WorkItemBulkMoveInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. movedWorkItemCountIntNumber of work items that were successfully moved.
workItemBulkUpdateAllows updating several properties for a set of work items.
Input type: WorkItemBulkUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. updatedWorkItemCountIntNumber of work items that were successfully updated.
workItemConvertConverts the work item to a new type.
Input type: WorkItemConvertInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. workItemWorkItemUpdated work item.
workItemCreateCreates a work item.
Input type: WorkItemCreateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. workItemWorkItemCreated work item.
workItemCreateFromTaskCreates a work item from a task in another work item’s description.
Input type: WorkItemCreateFromTaskInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. newWorkItemWorkItemNew work item created from task. workItemWorkItemUpdated work item.
workItemDecisionArchiveArchives a resolved decision in the decision log of a work item. The decision is kept but marked as archived. Open decisions cannot be archived, and archiving cannot be undone.
Input type: WorkItemDecisionArchiveInput
Arguments Fields workItemDecisionCreateRecords a decision in the decision log of a work item.
Input type: WorkItemDecisionCreateInput
Arguments Name Type Description descriptionStringContext of the decision. discussionIdDiscussionIDGlobal ID of the originating discussion thread. options[WorkItemDecisionOptionInput!]Candidate options of the decision. Maximum of 5 options. Incompatible with resolution. resolutionWorkItemDecisionResolutionInputWhen present, records the decision as resolved at creation. Incompatible with options. sourceLinkStringURL of the comment, discussion, or external resource that prompted the decision. titleStringQuestion being decided. Required unless resolution is provided. workItemIdWorkItemID!Global ID of the work item.
Fields workItemDecisionDeleteDeletes an open decision from the decision log of a work item. Resolved or archived decisions cannot be deleted; archive resolved decisions instead.
Input type: WorkItemDecisionDeleteInput
Arguments Fields workItemDecisionResolveResolves a decision in the decision log of a work item.
Input type: WorkItemDecisionResolveInput
Arguments Name Type Description idWorkItemsDecisionID!Global ID of the decision. resolutionRationaleStringReasoning for the resolution. resolvingNoteIdNoteIDGlobal ID of the comment that resolved the decision. selectedOptionContentStringContent of a custom option, added as the only selected option of the decision while every existing option is deselected. Incompatible with selectedOptionIds. selectedOptionIds[WorkItemsDecisionOptionID!]Global IDs of the selected options. Maximum of 5 options.
Fields workItemDecisionUpdateUpdates a decision in the decision log of a work item.
Input type: WorkItemDecisionUpdateInput
Arguments Name Type Description descriptionStringContext of the decision. discussionIdDiscussionIDGlobal ID of the originating discussion thread. idWorkItemsDecisionID!Global ID of the decision. options[WorkItemDecisionOptionUpdateInput!]Existing options of the decision to update. Maximum of 6 options. resolutionRationaleStringReasoning for the resolution. Can only be updated on resolved decisions. resolvedByIdUserIDGlobal ID of the user who resolved the decision. Can only be updated on resolved decisions. resolvingNoteIdNoteIDGlobal ID of the comment that resolved the decision. Can only be updated on resolved decisions. selectedOptionContentStringContent of the selected option. Unless exactly one option is selected, a new selected option with this content is added and any selected options are deselected. Can only be updated on resolved decisions. sourceLinkStringURL of the comment, discussion, or external resource that prompted the decision. titleStringQuestion being decided.
Fields workItemDeleteDeletes a work item.
Input type: WorkItemDeleteInput
Arguments Name Type Description idWorkItemID!Global ID of the work item.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. namespaceNamespaceNamespace the deleted work item belonged to. projectProjectDeprecated in GitLab 16.9. Use namespace.
workItemEnableAiPlanningEnables AI planning for a work item. Once enabled, AI planning cannot be disabled.
Input type: WorkItemEnableAiPlanningInput
Arguments Name Type Description idWorkItemID!Global ID of the work item.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. workItemWorkItemWork item after mutation.
workItemExportDeprecated in GitLab 18.0. Use WorkItemsCsvExport.
Input type: WorkItemExportInput
Arguments Name Type Description 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. 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. healthStatusFilterHealthStatusFilterIntroduced as an experiment in GitLab 18.2. hierarchyFiltersHierarchyFilterInputIntroduced as an experiment in GitLab 18.3. 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.’. includeDescendantWorkItemsBooleanIntroduced as an experiment in GitLab 18.3. iterationCadenceId[IterationsCadenceID!]Introduced as an experiment in GitLab 18.2. iterationId[ID]Introduced as an experiment in GitLab 18.2. iterationWildcardIdIterationWildcardIdIntroduced as an experiment in GitLab 18.2. 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). parentWildcardIdWorkItemParentWildcardIdIntroduced as an experiment in GitLab 18.5. 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. statusWorkItemWidgetStatusFilterInputIntroduced as an experiment in GitLab 18.7. 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. weightStringIntroduced as an experiment in GitLab 18.2. weightWildcardIdWeightWildcardIdIntroduced as an experiment in GitLab 18.2. workItemTypeIds[WorkItemsTypeID!]Filter work items by work item type global IDs.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. messageStringExport request result message.
workItemGenerateReadinessScoreScores the readiness of a work item asynchronously through a Duo Agent Platform flow, instead of Duo Chat. Available only when the workplan_score feature flag is enabled; returns an error otherwise.
Input type: WorkItemGenerateReadinessScoreInput
Arguments Name Type Description idWorkItemID!Global ID of the work item to score readiness for.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. workflowDuoWorkflowDuo Agent Platform workflow started to score the readiness.
workItemGenerateWorkplanGenerates a workplan for a work item asynchronously through a Duo Agent Platform flow, instead of Duo Chat. Available only when the duo_workplan_async_flow feature flag is enabled; returns an error otherwise.
Input type: WorkItemGenerateWorkplanInput
Arguments Name Type Description idWorkItemID!Global ID of the work item to generate a workplan for.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. workflowDuoWorkflowDuo Agent Platform workflow started to generate the workplan.
workItemHierarchyAddChildrenItemsAdds children to a given work item’s hierarchy by Global ID.
Input type: WorkItemHierarchyAddChildrenItemsInput
Arguments Fields Name Type Description addedChildren[WorkItem!]!Work items that were added as children. errors[String!]!Errors encountered during the mutation.
workItemRemoveLinkedItemsRemove items linked to the work item.
Input type: WorkItemRemoveLinkedItemsInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. messageStringLinked items update result message. workItemWorkItemUpdated work item.
workItemResumeWorkplanResumes a paused workplan generation flow that is awaiting input, sending the replies left on the questions the flow asked. Available only when the duo_workplan_async_flow feature flag is enabled; returns an error otherwise.
Input type: WorkItemResumeWorkplanInput
Arguments Name Type Description idWorkItemID!Global ID of the work item whose workplan generation to resume.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. workflowDuoWorkflowDuo Agent Platform workflow that was resumed.
workItemSavedViewCreateCreates a saved view.
Input type: WorkItemSavedViewCreateInput
Arguments Name Type Description 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. privateBooleanDeprecated in GitLab 18.10. Replaced by isPrivate argument. sortWorkItemSort!Sort option associated with the saved view.
Fields workItemSavedViewDeleteDeletes a saved view.
Input type: WorkItemSavedViewDeleteInput
Arguments Fields workItemSavedViewReorderReorders a saved view for the current user.
Input type: WorkItemSavedViewReorderInput
Arguments Fields workItemSavedViewSubscribeSubscribes the current user to a saved view.
Input type: WorkItemSavedViewSubscribeInput
Arguments Fields workItemSavedViewUnsubscribeUnsubscribes the current user from a saved view.
Input type: WorkItemSavedViewUnsubscribeInput
Arguments Fields workItemSavedViewUpdateUpdates a saved view.
Input type: WorkItemSavedViewUpdateInput
Arguments Fields workItemSettingsUpdateUpdates work item settings for a root group or organization. Omit fullPath to update settings for the current organization.
Input type: WorkItemSettingsUpdateInput
Arguments Name Type Description customizableTypeVisibilityBooleanWhether namespace admins can configure per-type work item visibility. fullPathIDFull path of the root group. Omit to use the current organization.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. workItemSettingsWorkItemSettingsWork item settings after mutation.
workItemSubscribeInput type: WorkItemSubscribeInput
Arguments Name Type Description idWorkItemID!Global ID of the work item. subscribedBoolean!Desired state of the subscription.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. workItemWorkItemWork item after mutation.
workItemTypeCreateInput type: WorkItemTypeCreateInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. workItemTypeWorkItemTypeWork item type that was created.
workItemTypeUpdateInput type: WorkItemTypeUpdateInput
Arguments Name Type Description archiveBooleanWhether to archive the work item type. 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 Name Type Description errors[String!]!Errors encountered during the mutation. workItemTypeWorkItemTypeWork item type that was updated.
workItemUpdateUpdates a work item by Global ID.
Input type: WorkItemUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. workItemWorkItemUpdated work item.
workItemUserPreferenceUpdateCreate or Update user preferences for a work item type and namespace.
Input type: WorkItemUserPreferenceUpdateInput
Arguments Name Type Description Default 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. CREATED_ASCworkItemTypeIdWorkItemsTypeIDGlobal ID of a work item type.
Fields workItemsCsvExportInput type: WorkItemsCsvExportInput
Arguments Name Type Description 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. 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. healthStatusFilterHealthStatusFilterIntroduced as an experiment in GitLab 18.2. hierarchyFiltersHierarchyFilterInputIntroduced as an experiment in GitLab 18.3. 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.'. includeDescendantWorkItemsBooleanIntroduced as an experiment in GitLab 18.3. iterationCadenceId[IterationsCadenceID!]Introduced as an experiment in GitLab 18.2. iterationId[ID]Introduced as an experiment in GitLab 18.2. iterationWildcardIdIterationWildcardIdIntroduced as an experiment in GitLab 18.2. 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). parentWildcardIdWorkItemParentWildcardIdIntroduced as an experiment in GitLab 18.5. 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. statusWorkItemWidgetStatusFilterInputIntroduced as an experiment in GitLab 18.7. 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. weightStringIntroduced as an experiment in GitLab 18.2. weightWildcardIdWeightWildcardIdIntroduced as an experiment in GitLab 18.2. workItemTypeIds[WorkItemsTypeID!]Filter work items by work item type global IDs.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. messageStringExport request result message.
workItemsCsvImportInput type: WorkItemsCsvImportInput
Arguments Name Type Description fileUpload!CSV file to import work items from. projectPathID!Full project path.
Fields Name Type Description errors[String!]!Errors encountered during the mutation. messageStringImport request result message.
workItemsHierarchyReorderReorder a work item in the hierarchy tree.
Input type: workItemsHierarchyReorderInput
Arguments Name Type Description adjacentWorkItemIdWorkItemIDID of the work item to move next to. For example, the item above or below. 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 Name Type Description adjacentWorkItemWorkItemAdjacent work item after mutation. errors[String!]!Errors encountered during the mutation. parentWorkItemWorkItemWork item’s parent after mutation. workItemWorkItemWork item after mutation.
workItemsReorderReorders a work item.
Input type: workItemsReorderInput
Arguments Name Type Description 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 Name Type Description errors[String!]!Errors encountered during the mutation. workItemWorkItemWork item after mutation.
workspaceCreateInput type: WorkspaceCreateInput
Arguments Name Type Description Default 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. nulldevfileRefStringDeprecated in GitLab 17.8. Argument is renamed to project_ref. editorStringDeprecated in GitLab 17.5. Argument is not used. maxHoursBeforeTerminationIntDeprecated 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[WorkspaceVariableInput!]Deprecated in GitLab 18.0. Argument is renamed to workspace_variables. []workspaceVariables[WorkspaceVariableInput!]Introduced as an experiment in GitLab 18.0. []
Fields Name Type Description errors[String!]!Errors encountered during the mutation. workspaceWorkspaceCreated workspace.
workspaceUpdateInput type: WorkspaceUpdateInput
Arguments Fields Name Type Description errors[String!]!Errors encountered during the mutation. workspaceWorkspaceCreated workspace.