GraphQL API Mutations

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.

clientMutationId

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

achievementsAward

Input type: AchievementsAwardInput

achievementsAward arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being awarded.
awardMessage String Message to associate with the awarded achievement.
userId UserID! Global ID of the user being awarded the achievement.

achievementsAward fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userAchievement UserAchievement Achievement award.

achievementsCreate

Input type: AchievementsCreateInput

achievementsCreate arguments

Name Type Description
avatar Upload Avatar for the achievement.
description String Description of or notes for the achievement.
name String! Name for the achievement.
namespaceId NamespaceID! Namespace for the achievement.

achievementsCreate fields

Name Type Description
achievement Achievement Achievement created.
errors [String!]! Errors encountered during the mutation.

achievementsDelete

Input type: AchievementsDeleteInput

achievementsDelete arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being deleted.

achievementsDelete fields

Name Type Description
achievement Achievement Achievement.
errors [String!]! Errors encountered during the mutation.

achievementsRevoke

Input type: AchievementsRevokeInput

achievementsRevoke arguments

Name Type Description
userAchievementId AchievementsUserAchievementID! Global ID of the user achievement being revoked.

achievementsRevoke fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userAchievement UserAchievement Achievement award.

achievementsUpdate

Input type: AchievementsUpdateInput

achievementsUpdate arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being updated.
avatar Upload Avatar for the achievement.
description String Description of or notes for the achievement.
name String Name for the achievement.

achievementsUpdate fields

Name Type Description
achievement Achievement Achievement.
errors [String!]! Errors encountered during the mutation.

addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

addProjectToSecurityDashboard arguments

Name Type Description
id ProjectID! ID of the project to be added to Instance Security Dashboard.

addProjectToSecurityDashboard fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Project that was added to the Instance Security Dashboard.

adminClearDuoAvailability

  • Status: Experiment

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

Input type: AdminClearDuoAvailabilityInput

adminClearDuoAvailability arguments

Name Type Description
groupId GroupID! Group to clear the GitLab Duo availability override from.

adminClearDuoAvailability fields

Name Type Description
adminLocked Boolean Whether the group has an admin-locked GitLab Duo availability override.
availability DuoAvailability Resolved GitLab Duo availability for the group after the override is cleared.
errors [String!]! Errors encountered during the mutation.

adminRolesLdapSync

  • Status: Experiment

Input type: AdminRolesLdapSyncInput

adminRolesLdapSync fields

Name Type Description
errors [String!] Errors encountered during operation.
success Boolean Whether the sync was successfully enqueued.

adminSetDuoAvailability

  • Status: Experiment

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

Input type: AdminSetDuoAvailabilityInput

adminSetDuoAvailability arguments

Name Type Description Default
availability DuoAvailability! GitLab Duo availability state to lock on the group.
clearDescendants Boolean Clear conflicting admin-locked overrides on descendant groups instead of rejecting. false
groupId GroupID! Group to set the GitLab Duo availability override on.

adminSetDuoAvailability fields

Name Type Description
adminLocked Boolean Whether the group has an admin-locked GitLab Duo availability override.
affectedAdminLockedDescendants AdminDuoAvailabilityLockedAncestorConnection Descendant 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.
availability DuoAvailability Resolved GitLab Duo availability for the group after the mutation.
conflictingAncestor AdminDuoAvailabilityLockedAncestor Ancestor group whose admin lock blocked the mutation, if any. When present, the override was not applied.
errors [String!]! Errors encountered during the mutation.

adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

adminSidekiqQueuesDeleteJobs arguments

Name Type Description
aiResource String Delete jobs matching ai_resource in the context metadata.
artifactSize String Delete jobs matching artifact_size in the context metadata.
artifactUsedCdn String Delete jobs matching artifact_used_cdn in the context metadata.
artifactsDependenciesCount String Delete jobs matching artifacts_dependencies_count in the context metadata.
artifactsDependenciesSize String Delete jobs matching artifacts_dependencies_size in the context metadata.
bulkImportEntityId String Delete jobs matching bulk_import_entity_id in the context metadata.
callerId String Delete jobs matching caller_id in the context metadata.
clientId String Delete jobs matching client_id in the context metadata.
clientName String Delete jobs matching client_name in the context metadata.
clientType String Delete jobs matching client_type in the context metadata.
clientVersion String Delete jobs matching client_version in the context metadata.
featureCategory String Delete jobs matching feature_category in the context metadata.
glRootNamespaceId String Delete jobs matching gl_root_namespace_id in the context metadata.
glUserId String Delete jobs matching gl_user_id in the context metadata.
jobId String Delete jobs matching job_id in the context metadata.
kubernetesAgentId String Delete jobs matching kubernetes_agent_id in the context metadata.
mergeActionStatus String Delete jobs matching merge_action_status in the context metadata.
mvccManifest String Delete jobs matching mvcc_manifest in the context metadata.
organizationId String Delete jobs matching organization_id in the context metadata.
pipelineId String Delete jobs matching pipeline_id in the context metadata.
project String Delete jobs matching project in the context metadata.
queueName String! Name of the queue to delete jobs from.
relatedClass String Delete jobs matching related_class in the context metadata.
remoteIp String Delete jobs matching remote_ip in the context metadata.
rootCallerId String Delete jobs matching root_caller_id in the context metadata.
rootNamespace String Delete jobs matching root_namespace in the context metadata.
scopedUser String Delete jobs matching scoped_user in the context metadata.
scopedUserId String Delete jobs matching scoped_user_id in the context metadata.
sidekiqDestinationShardRedis String Delete jobs matching sidekiq_destination_shard_redis in the context metadata.
subscriptionPlan String Delete jobs matching subscription_plan in the context metadata.
user String Delete jobs matching user in the context metadata.
userId String Delete jobs matching user_id in the context metadata.
workerClass String Delete jobs with the given worker class.

adminSidekiqQueuesDeleteJobs fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
result DeleteJobsResponse Information about the status of the deletion request.

aiAction

  • Status: Experiment

Input type: AiActionInput

aiAction arguments

Name Type Description
agenticChat AiAgenticChatInput Input for agentic_chat AI action.
chat AiChatInput Input for chat AI action.
clientSubscriptionId String Client generated ID that can be subscribed to, to receive a response for the mutation.
conversationType AiConversationsThreadsConversationType Conversation type of the thread.
explainVulnerability AiExplainVulnerabilityInput Input for explain_vulnerability AI action.
generateCommitMessage AiGenerateCommitMessageInput Input for generate_commit_message AI action.
generateDescription AiGenerateDescriptionInput Input for generate_description AI action.
platformOrigin String Specifies the origin platform of the request.
projectId ProjectID Global ID of the project the user is acting on.
resolveVulnerability AiResolveVulnerabilityInput Input for resolve_vulnerability AI action.
rootNamespaceId NamespaceID Global ID of the top-level namespace the user is acting on.
summarizeNewMergeRequest AiSummarizeNewMergeRequestInput Input for summarize_new_merge_request AI action.
summarizeReview AiSummarizeReviewInput Input for summarize_review AI action.
threadId AiConversationThreadID Global Id of the existing thread to continue the conversation. If it is not specified, a new thread will be created for the specified conversation_type.

aiAction fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
requestId String ID of the request.
threadId AiConversationThreadID Global Id of the thread.

aiCatalogAgentCreate

  • Status: Experiment

Input type: AiCatalogAgentCreateInput

aiCatalogAgentCreate arguments

Name Type Description
description String! Description for the agent.
mcpServers [AiCatalogMcpServerID!] Introduced as an experiment in GitLab 18.10.

MCP servers to associate with the agent. At most 20.
mcpTools [String!] Introduced as an experiment in GitLab 18.11.

List of MCP tools enabled for the agent.
name String! Name for the agent.
projectId ProjectID! Project for the agent.
public Boolean Deprecated in GitLab 19.2. Use visibility.
release Boolean Whether to release the latest version of the agent.
systemPrompt String! System prompt for the agent.
tools [AiCatalogBuiltInToolID!] List of GitLab built-in tools enabled for the agent.
userPrompt String User prompt for the agent.
visibility AiCatalogItemVisibility Introduced as an experiment in GitLab 19.2.

Visibility of the agent in the catalog.

aiCatalogAgentCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
item AiCatalogAgent Item created.

aiCatalogAgentDelete

  • Status: Experiment

Input type: AiCatalogAgentDeleteInput

aiCatalogAgentDelete arguments

Name Type Description
forceHardDelete Boolean When true, the flow will always be hard deleted and never soft deleted. Can only be used by instance admins.
id AiCatalogItemID! Global ID of the catalog Agent to delete.

aiCatalogAgentDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
success Boolean! Returns true if catalog Agent was successfully deleted.

aiCatalogAgentUpdate

  • Status: Experiment

Input type: AiCatalogAgentUpdateInput

aiCatalogAgentUpdate arguments

Name Type Description
description String Description for the agent.
id AiCatalogItemID! Global ID of the catalog Agent to update.
mcpServers [AiCatalogMcpServerID!] Introduced as an experiment in GitLab 18.10.

MCP servers to associate with the agent. At most 20.
mcpTools [String!] Introduced as an experiment in GitLab 18.11.

List of MCP tools enabled for the agent.
name String Name for the agent.
public Boolean Deprecated in GitLab 19.2. Use visibility.
release Boolean Whether to release the latest version of the agent.
systemPrompt String System prompt for the agent.
tools [AiCatalogBuiltInToolID!] List of GitLab built-in tools enabled for the agent.
userPrompt String User prompt for the agent.
versionBump AiCatalogVersionBump Bump version, calculated from the last released version name.
visibility AiCatalogItemVisibility Introduced as an experiment in GitLab 19.2.

Visibility of the agent in the catalog.

aiCatalogAgentUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
item AiCatalogAgent Agent that was updated.

aiCatalogFlowCreate

  • Status: Experiment

Input type: AiCatalogFlowCreateInput

aiCatalogFlowCreate arguments

Name Type Description
definition String YAML definition for the flow.
description String! Description for the flow.
name String! Name for the flow.
projectId ProjectID! Project for the flow.
public Boolean Deprecated in GitLab 19.2. Use visibility.
release Boolean Whether to release the latest version of the flow.
visibility AiCatalogItemVisibility Introduced as an experiment in GitLab 19.2.

Visibility of the flow in the catalog.

aiCatalogFlowCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
item AiCatalogFlow Item created.

aiCatalogFlowDelete

  • Status: Experiment

Input type: AiCatalogFlowDeleteInput

aiCatalogFlowDelete arguments

Name Type Description
forceHardDelete Boolean When true, the flow will always be hard deleted and never soft deleted. Can only be used by instance admins.
id AiCatalogItemID! Global ID of the catalog flow to delete.

aiCatalogFlowDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
success Boolean! Returns true if catalog flow was successfully deleted.

aiCatalogFlowUpdate

  • Status: Experiment

Input type: AiCatalogFlowUpdateInput

aiCatalogFlowUpdate arguments

Name Type Description
definition String YAML definition for the Flow.
description String Description for the flow.
id AiCatalogItemID! Global ID of the catalog flow to update.
name String Name for the flow.
public Boolean Deprecated in GitLab 19.2. Use visibility.
release Boolean Whether to release the latest version of the flow.
versionBump AiCatalogVersionBump Bump version, calculated from the last released version name.
visibility AiCatalogItemVisibility Introduced as an experiment in GitLab 19.2.

Visibility of the flow in the catalog.

aiCatalogFlowUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
item AiCatalogFlow Flow that was updated.

aiCatalogItemConsumerBulkCreate

  • Status: Experiment

Enables a catalog item in multiple projects in the background. Rate limited to 10 requests per minute per user.

Input type: AiCatalogItemConsumerBulkCreateInput

aiCatalogItemConsumerBulkCreate arguments

Name Type Description
itemId AiCatalogItemID! Global ID of the catalog item to enable.
pinnedVersion AiCatalogPinnedVersion Version to pin the item to, in the format n.n.n. Must be a released version. Defaults to the latest released version. Ignored when enabling within the item’s managing project, which always tracks the latest released version.
projectIds [ProjectID!]! Global IDs of the projects to enable the catalog item in (maximum 100).
triggerConditions AiCatalogTriggerConditionsInput Introduced as an experiment in GitLab 19.3.

Filter conditions for the auto-created AI Catalog triggers, keyed by event type.
triggerFilter JSON Deprecated in GitLab 19.3. Use triggerConditions.
triggerGoals JSON Introduced as an experiment in GitLab 19.5.

Goals for the auto-created AI Catalog triggers, keyed by event type.
triggerTypes [String!] List of event types to create AI Catalog triggers for.

aiCatalogItemConsumerBulkCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

aiCatalogItemConsumerCreate

  • Status: Experiment

Enables a catalog item in a project or top-level group. Rate limited to 30 requests per minute per user.

Input type: AiCatalogItemConsumerCreateInput

aiCatalogItemConsumerCreate arguments

Name Type Description Default
consumerKind AiCatalogItemConsumerKind Type of item configuration. INHERITANCE is only valid for a top-level group target. DIRECT
itemId AiCatalogItemID! Item to configure.
parentItemConsumerId AiCatalogItemConsumerID Parent item consumer belonging to the top-level group.
pinnedVersion AiCatalogPinnedVersion Version 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.
replaceExistingDirectConfigurations Boolean Confirm 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.
target ItemConsumerTargetInput! Target project or top-level group in which the catalog item is configured.
triggerConditions AiCatalogTriggerConditionsInput Introduced as an experiment in GitLab 19.3.

Filter conditions for the auto-created AI Catalog triggers, keyed by event type.
triggerFilter JSON Deprecated in GitLab 19.3. Use triggerConditions.
triggerGoals JSON Introduced as an experiment in GitLab 19.5.

Goals for the auto-created AI Catalog triggers, keyed by event type.
triggerTypes [String!] List of event types to create AI Catalog triggers for (values can be mention, assign or assign_reviewer).

aiCatalogItemConsumerCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
itemConsumer AiCatalogItemConsumer Item configuration created.
warnings [String!]! Non-fatal problems encountered while configuring the item. The configuration was still created.

aiCatalogItemConsumerDelete

  • Status: Experiment

Disables a catalog item in a project or top-level group. Rate limited to 30 requests per minute per user.

Input type: AiCatalogItemConsumerDeleteInput

aiCatalogItemConsumerDelete arguments

Name Type Description
id AiCatalogItemConsumerID! Global ID of the catalog item consumer to delete.

aiCatalogItemConsumerDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
success Boolean! Returns true if catalog item consumer was successfully deleted.

aiCatalogItemConsumerUpdate

  • Status: Experiment

Input type: AiCatalogItemConsumerUpdateInput

aiCatalogItemConsumerUpdate arguments

Name Type Description
id AiCatalogItemConsumerID! Global ID of the catalog item consumer to update.
pinnedVersion AiCatalogPinnedVersion Version the item is pinned to, in the format n.n.n.
pinnedVersionPrefix AiCatalogPinnedVersion Deprecated in GitLab 19.0. Use pinnedVersion instead.
serviceAccountId UserID Service 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).

aiCatalogItemConsumerUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
itemConsumer AiCatalogItemConsumer Item consumer that was updated.

aiCatalogItemReport

  • Status: Experiment

Input type: AiCatalogItemReportInput

aiCatalogItemReport arguments

Name Type Description
body String Additional details about the report. Limited to 1000 characters.
id AiCatalogItemID! Global ID of the catalog item to report.
reason AiCatalogItemReportReason! Reason for reporting the catalog item.

aiCatalogItemReport fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

aiCatalogItemStar

  • Status: Experiment

Input type: AiCatalogItemStarInput

aiCatalogItemStar arguments

Name Type Description
id AiCatalogItemID! Global ID of the catalog item to star or unstar.
starred Boolean! Indicates whether to star or unstar the catalog item.

aiCatalogItemStar fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
starCount Int! Number of stars for the catalog item.

aiCatalogItemVersionRestore

  • Status: Experiment

Input type: AiCatalogItemVersionRestoreInput

aiCatalogItemVersionRestore arguments

Name Type Description Default
deprecateCurrent Boolean Whether to mark the current latest version as deprecated. false
id AiCatalogItemVersionID! Global ID of the item version to restore from.

aiCatalogItemVersionRestore fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
itemVersion AiCatalogItemVersion Newly created item version restored from the source version.

aiCatalogMcpServerCreate

  • Status: Experiment

Input type: AiCatalogMcpServerCreateInput

aiCatalogMcpServerCreate arguments

Name Type Description
authType AiCatalogMcpServerAuthType! Authentication type for the MCP server.
description String Description for the MCP server.
homepageUrl String Homepage URL for the MCP server.
name String! Name for the MCP server.
oauthClientId String OAuth client ID for the MCP server.
oauthClientSecret String OAuth client secret for the MCP server.
transport AiCatalogMcpServerTransport! Transport type for the MCP server.
url String! URL for the MCP server.

aiCatalogMcpServerCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mcpServer AiCatalogMcpServer MCP server created.

aiCatalogMcpServerSetBlock

  • Status: Experiment

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

Input type: AiCatalogMcpServerSetBlockInput

aiCatalogMcpServerSetBlock arguments

Name Type Description
blocked Boolean! Set to true to block the MCP server, false to allow it.
groupFullPath ID Full path of the group to block or allow the MCP server for. Provide exactly one of groupFullPath or projectFullPath.
id AiCatalogMcpServerID! Global ID of the MCP server.
projectFullPath ID Full path of the project to block or allow the MCP server for. Provide exactly one of groupFullPath or projectFullPath.

aiCatalogMcpServerSetBlock fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mcpServer AiCatalogMcpServer MCP server with its updated block status.

aiCatalogMcpServerUpdate

  • Status: Experiment

Input type: AiCatalogMcpServerUpdateInput

aiCatalogMcpServerUpdate arguments

Name Type Description
authType AiCatalogMcpServerAuthType Authentication type for the MCP server.
description String Description for the MCP server.
homepageUrl String Homepage URL for the MCP server.
id AiCatalogMcpServerID! Global ID of the MCP server to update.
name String Name for the MCP server.
oauthClientId String OAuth client ID for the MCP server.
oauthClientSecret String OAuth client secret for the MCP server.
transport AiCatalogMcpServerTransport Transport type for the MCP server.
url String URL for the MCP server.

aiCatalogMcpServerUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mcpServer AiCatalogMcpServer MCP server that was updated.

aiCatalogThirdPartyFlowCreate

  • Status: Experiment

Input type: AiCatalogThirdPartyFlowCreateInput

aiCatalogThirdPartyFlowCreate arguments

Name Type Description
definition String! YAML definition for the Flow.
description String! Description for the Flow.
name String! Name for the Flow.
projectId ProjectID! Project for the Flow.
public Boolean Deprecated in GitLab 19.2. Use visibility.
release Boolean Whether to release the latest version of the Flow.
visibility AiCatalogItemVisibility Introduced as an experiment in GitLab 19.2.

Visibility of the Flow in the catalog.

aiCatalogThirdPartyFlowCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
item AiCatalogThirdPartyFlow Item created.

aiCatalogThirdPartyFlowDelete

  • Status: Experiment

Input type: AiCatalogThirdPartyFlowDeleteInput

aiCatalogThirdPartyFlowDelete arguments

Name Type Description
forceHardDelete Boolean When true, the Third Party Flow will always be hard deleted and never soft deleted. Can only be used by instance admins.
id AiCatalogItemID! Global ID of the catalog Third Party Flow to delete.

aiCatalogThirdPartyFlowDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
success Boolean! Returns true if catalog Third Party Flow was successfully deleted.

aiCatalogThirdPartyFlowUpdate

  • Status: Experiment

Input type: AiCatalogThirdPartyFlowUpdateInput

aiCatalogThirdPartyFlowUpdate arguments

Name Type Description
definition String YAML definition for the Flow.
description String Description for the Flow.
id AiCatalogItemID! Global ID of the catalog Flow to update.
name String Name for the Flow.
public Boolean Deprecated in GitLab 19.2. Use visibility.
release Boolean Whether to release the latest version of the Flow.
versionBump AiCatalogVersionBump Bump version, calculated from the last released version name.
visibility AiCatalogItemVisibility Introduced as an experiment in GitLab 19.2.

Visibility of the Flow in the catalog.

aiCatalogThirdPartyFlowUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
item AiCatalogThirdPartyFlow Flow that was updated.

aiDomainSettingsInstanceUpdate

  • Status: Experiment

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

Input type: AiDomainSettingsInstanceUpdateInput

aiDomainSettingsInstanceUpdate arguments

Name Type Description
action AiDomainSettingAction! Action to perform on the domain list.
domainSettingType AiDomainSettingType! Type of domain setting to update.
domains [String!]! List of domains to add or remove.

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

aiDomainSettingsNamespaceUpdate

  • Status: Experiment

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

Input type: AiDomainSettingsNamespaceUpdateInput

aiDomainSettingsNamespaceUpdate arguments

Name Type Description
action AiDomainSettingAction! Action to perform on the domain list.
domainSettingType AiDomainSettingType! Type of domain setting to update.
domains [String!]! List of domains to add or remove.
namespaceId NamespaceID! Global ID of the root namespace to update.

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

aiDuoWorkflowCreate

  • Status: Experiment

Input type: AiDuoWorkflowCreateInput

aiDuoWorkflowCreate arguments

Name Type Description
agentPrivileges [Int!] Actions the agent is allowed to perform.
aiCatalogItemVersionId AiCatalogItemVersionID ID of the catalog item the workflow is triggered from.
allowAgentToRequestUser Boolean When enabled, Duo Agent Platform may stop to ask the user questions before proceeding.
environment WorkflowEnvironment Environment for the workflow.
goal String Goal of the workflow.
issueId BigInt IID of the noteable (Issue) that the workflow is associated with.
mergeRequestId BigInt IID of the noteable (MergeRequest) that the workflow is associated with.
namespaceId NamespaceID Global ID of the namespace the user is acting on.
preApprovedAgentPrivileges [Int!] Actions the agent can perform without asking for approval.
projectId ProjectID Global ID of the project the user is acting on.
source DuoWorkflowSourceType Where the session was triggered from. Only client-surface values are accepted.
webSearchEnabled Boolean Enable web search for the session.
workflowDefinition String Workflow type based on its capability.

aiDuoWorkflowCreate fields

Name Type Description
errors [String!]! Errors encountered during the creation process.
workflow DuoWorkflow Created workflow.

aiFeatureSettingModelAllowlistUpdate

  • Status: Experiment

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

Input type: AiFeatureSettingModelAllowlistUpdateInput

aiFeatureSettingModelAllowlistUpdate arguments

Name Type Description
allowlistEnabled Boolean! 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.
feature AiFeatures! AI feature whose model allowlist is being configured.

aiFeatureSettingModelAllowlistUpdate fields

Name Type Description
allowList AiModelSelectionAllowList Model selection allowlist for the feature after the update.
errors [String!]! Errors encountered during the mutation.

aiFeatureSettingUpdate

  • Status: Experiment

Updates or creates settings for AI features.

Input type: AiFeatureSettingUpdateInput

aiFeatureSettingUpdate arguments

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

aiFeatureSettingUpdate fields

Name Type Description
aiFeatureSettings [AiFeatureSetting!]! List of AI feature settings after mutation.
errors [String!]! Errors encountered during the mutation.

aiFlowScheduleCreate

  • Status: Experiment

Input type: AiFlowScheduleCreateInput

aiFlowScheduleCreate arguments

Name Type Description Default
active Boolean Indicates whether the schedule should be active. true
cron String! Cron expression defining the schedule frequency.
cronTimezone String! IANA timezone for the cron expression.
description String! Description of the schedule.
flowTriggerId AiFlowTriggerID! Global ID of the flow trigger to schedule.

aiFlowScheduleCreate fields

Name Type Description
aiFlowSchedule AiFlowScheduleType Created flow schedule.
errors [String!]! Errors encountered during the mutation.

aiFlowScheduleDelete

  • Status: Experiment

Input type: AiFlowScheduleDeleteInput

aiFlowScheduleDelete arguments

Name Type Description
id AiFlowScheduleID! Global ID of the flow schedule to delete.

aiFlowScheduleDelete fields

Name Type Description
aiFlowSchedule AiFlowScheduleType Deleted flow schedule.
errors [String!]! Errors encountered during the mutation.

aiFlowScheduleUpdate

  • Status: Experiment

Input type: AiFlowScheduleUpdateInput

aiFlowScheduleUpdate arguments

Name Type Description
active Boolean Indicates whether the schedule should be active.
cron String Cron expression defining the schedule frequency.
cronTimezone String IANA timezone for the cron expression.
description String Description of the schedule.
id AiFlowScheduleID! Global ID of the flow schedule to update.

aiFlowScheduleUpdate fields

Name Type Description
aiFlowSchedule AiFlowScheduleType Updated flow schedule.
errors [String!]! Errors encountered during the mutation.

aiFlowTriggerCreate

  • Status: Experiment

Input type: AiFlowTriggerCreateInput

aiFlowTriggerCreate arguments

Name Type Description
active Boolean Introduced as an experiment in GitLab 19.4.

Indicates whether the AI flow trigger is active. Defaults to true.
aiCatalogItemConsumerId AiCatalogItemConsumerID AI catalog item consumer to use instead of config_path.
configPath String Path to the configuration file for the AI flow trigger.
description String! Description of the AI flow trigger.
eventTypes [Int!] Event types that triggers the AI flow.
filter JSON Introduced as an experiment in GitLab 19.0.

Filter conditions for the AI flow trigger.
goals JSON Introduced as an experiment in GitLab 19.5.

Goals for the AI flow trigger, keyed by event type.
projectPath ID! Full path of the project the AI flow trigger is associated with.
readyMergeRequestsOnFinish Boolean Introduced as an experiment in GitLab 19.6.

Indicates whether merge requests created by a session that a work item event of the AI flow trigger started are marked as ready when the session finishes. Applies only when the dap_software_factory and ai_flow_trigger_chaining feature flags are enabled, and only to work items in a project. Requires the work_item event type. The work item filter must match all its rules, and have one top-level action rule in ["status_changed"] and one top-level status.name rule in a list of status names.
statusOnFinish String Introduced as an experiment in GitLab 19.6.

Name of the work item status to set when a session that a work item event of the AI flow trigger started finishes. Applies only when the dap_software_factory and ai_flow_trigger_chaining feature flags are enabled, and only to work items in a project. Requires the work_item event type. The work item filter must match all its rules, and have one top-level action rule in ["status_changed"] and one top-level status.name rule in a list of status names.
userId UserID Service account for the AI flow trigger.

aiFlowTriggerCreate fields

Name Type Description
aiFlowTrigger AiFlowTriggerType Created AI flow trigger.
errorReason AiFlowTriggerErrorReason Introduced as an experiment in GitLab 19.6.

Machine-readable reason for the mutation error.
errors [String!]! Errors encountered during the mutation.

aiFlowTriggerDelete

  • Status: Experiment

Input type: AiFlowTriggerDeleteInput

aiFlowTriggerDelete arguments

Name Type Description
id AiFlowTriggerID! ID of the flow trigger to delete.

aiFlowTriggerDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

aiFlowTriggerUpdate

  • Status: Experiment

Input type: AiFlowTriggerUpdateInput

aiFlowTriggerUpdate arguments

Name Type Description
active Boolean Introduced as an experiment in GitLab 19.4.

Indicates whether the AI flow trigger is active. Inactive triggers do not run automatically.
aiCatalogItemConsumerId AiCatalogItemConsumerID AI catalog item consumer to use instead of config_path.
configPath String Path to the configuration file for the AI flow trigger.
description String Description of the AI flow trigger.
eventTypes [Int!] Event types that triggers the AI flow.
filter JSON Introduced as an experiment in GitLab 18.11.

Filter conditions for the AI flow trigger.
goals JSON Introduced as an experiment in GitLab 19.5.

Goals for the AI flow trigger, keyed by event type.
id AiFlowTriggerID! ID of the flow trigger to update.
readyMergeRequestsOnFinish Boolean Introduced as an experiment in GitLab 19.6.

Indicates whether merge requests created by a session that a work item event of the AI flow trigger started are marked as ready when the session finishes. Applies only when the dap_software_factory and ai_flow_trigger_chaining feature flags are enabled, and only to work items in a project. Requires the work_item event type. The work item filter must match all its rules, and have one top-level action rule in ["status_changed"] and one top-level status.name rule in a list of status names.
statusOnFinish String Introduced as an experiment in GitLab 19.6.

Name of the work item status to set when a session that a work item event of the AI flow trigger started finishes. Applies only when the dap_software_factory and ai_flow_trigger_chaining feature flags are enabled, and only to work items in a project. Requires the work_item event type. The work item filter must match all its rules, and have one top-level action rule in ["status_changed"] and one top-level status.name rule in a list of status names.
userId UserID Service account for the AI flow trigger.

aiFlowTriggerUpdate fields

Name Type Description
aiFlowTrigger AiFlowTriggerType Updated AI flow trigger.
errorReason AiFlowTriggerErrorReason Introduced as an experiment in GitLab 19.6.

Machine-readable reason for the mutation error.
errors [String!]! Errors encountered during the mutation.

aiModelSelectionNamespaceModelAllowlistUpdate

  • Status: Experiment

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

Input type: AiModelSelectionNamespaceModelAllowlistUpdateInput

aiModelSelectionNamespaceModelAllowlistUpdate arguments

Name Type Description
allowlistEnabled Boolean! 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.
feature AiFeatures! AI feature whose model allowlist is being configured.
groupId GroupID! Group whose model allowlist is being configured.

aiModelSelectionNamespaceModelAllowlistUpdate fields

Name Type Description
allowList AiModelSelectionAllowList Model selection allowlist for the feature after the update.
errors [String!]! Errors encountered during the mutation.

aiModelSelectionNamespaceUpdate

  • Status: Experiment

Updates or creates settings for AI features for a namespace.

Input type: AiModelSelectionNamespaceUpdateInput

aiModelSelectionNamespaceUpdate arguments

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

aiModelSelectionNamespaceUpdate fields

Name Type Description
aiFeatureSettings [AiModelSelectionNamespaceFeatureSetting!]! Introduced as an experiment in GitLab 18.1.

List of AI feature settings after mutation.
errors [String!]! Errors encountered during the mutation.

aiSelfHostedModelConnectionCheck

  • Status: Experiment

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

Input type: AiSelfHostedModelConnectionCheckInput

aiSelfHostedModelConnectionCheck arguments

Name Type Description
apiToken String API token to access the self-hosted model, if any.
endpoint String Endpoint of the self-hosted model.
iamRole String IAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider.
identifier String Identifier for 3rd party model provider.
model AiAcceptedSelfHostedModels! AI model deployed.
name String! Deployment name of the self-hosted model.
provider AiSelfHostedModelProvider! Provider for the self-hosted model.

aiSelfHostedModelConnectionCheck fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
result CloudConnectorProbeResult Self-hosted hosted connection check result.

aiSelfHostedModelCreate

  • Status: Experiment

Input type: AiSelfHostedModelCreateInput

aiSelfHostedModelCreate arguments

Name Type Description
apiToken String API token to access the self-hosted model, if any.
endpoint String Endpoint of the self-hosted model.
iamRole String IAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider.
identifier String Identifier for 3rd party model provider.
model AiAcceptedSelfHostedModels! AI model deployed.
name String! Deployment name of the self-hosted model.
provider AiSelfHostedModelProvider! Provider for the self-hosted model.

aiSelfHostedModelCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
selfHostedModel AiSelfHostedModel Self-hosted model after mutation.

aiSelfHostedModelDelete

  • Status: Experiment

Deletes a self-hosted model.

Input type: AiSelfHostedModelDeleteInput

aiSelfHostedModelDelete arguments

Name Type Description
id AiSelfHostedModelID! Global ID of the self-hosted model to delete.

aiSelfHostedModelDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

aiSelfHostedModelUpdate

  • Status: Experiment

Updates a self-hosted model.

Input type: AiSelfHostedModelUpdateInput

aiSelfHostedModelUpdate arguments

Name Type Description
apiToken String API token to access the self-hosted model, if any.
endpoint String Endpoint of the self-hosted model.
iamRole String IAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider.
id AiSelfHostedModelID! Global ID of the self-hosted model to update.
identifier String Identifier for 3rd party model provider.
model AiAcceptedSelfHostedModels! AI model deployed.
name String! Deployment name of the self-hosted model.
provider AiSelfHostedModelProvider! Provider for the self-hosted model.

aiSelfHostedModelUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
selfHostedModel AiSelfHostedModel Self-hosted model after mutation.

alertSetAssignees

Input type: AlertSetAssigneesInput

alertSetAssignees arguments

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

alertSetAssignees fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
errors [String!]! Errors encountered during the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

alertTodoCreate

Input type: AlertTodoCreateInput

alertTodoCreate arguments

Name Type Description
iid String! IID of the alert to mutate.
projectPath ID! Project the alert to mutate is in.

alertTodoCreate fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
errors [String!]! Errors encountered during the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

anthropicComplianceIntegrationCreate

  • Status: Experiment

Verifies a Compliance Access Key with Anthropic, then stores it as the Anthropic Compliance integration of a top-level group.

Input type: AnthropicComplianceIntegrationCreateInput

anthropicComplianceIntegrationCreate arguments

Name Type Description
apiKey String! Anthropic Compliance Access Key with the read:compliance_user_data scope. Write-only: GitLab never returns it.
groupPath ID! Full path of the top-level group.

anthropicComplianceIntegrationCreate fields

Name Type Description
anthropicComplianceIntegration AnthropicComplianceIntegration Integration after the mutation.
errorReason AnthropicComplianceIntegrationErrorReason Machine-readable reason for the mutation error.
errors [String!]! Errors encountered during the mutation.

anthropicComplianceIntegrationDelete

  • Status: Experiment

Deletes the Anthropic Compliance integration of a top-level group, including its Compliance Access Key. Claude Code sessions already ingested are kept.

Input type: AnthropicComplianceIntegrationDeleteInput

anthropicComplianceIntegrationDelete arguments

Name Type Description
groupPath ID! Full path of the top-level group.

anthropicComplianceIntegrationDelete fields

Name Type Description
errorReason AnthropicComplianceIntegrationErrorReason Machine-readable reason for the mutation error.
errors [String!]! Errors encountered during the mutation.

anthropicComplianceIntegrationUpdate

  • Status: Experiment

Replaces the Compliance Access Key of the Anthropic Compliance integration of a top-level group, or turns the integration on or off. Anthropic verifies a new key, or the stored key when turning the integration on, before GitLab saves the change.

Input type: AnthropicComplianceIntegrationUpdateInput

anthropicComplianceIntegrationUpdate arguments

Name Type Description
apiKey String New Anthropic Compliance Access Key with the read:compliance_user_data scope. Write-only: GitLab never returns it. Does not turn on an integration an owner turned off. Cannot be used with enabled.
enabled Boolean Turns ingestion on or off. Cannot be used with apiKey.
groupPath ID! Full path of the top-level group.

anthropicComplianceIntegrationUpdate fields

Name Type Description
anthropicComplianceIntegration AnthropicComplianceIntegration Integration after the mutation.
errorReason AnthropicComplianceIntegrationErrorReason Machine-readable reason for the mutation error.
errors [String!]! Errors encountered during the mutation.

approvalProjectRuleDelete

  • Status: Experiment

Input type: approvalProjectRuleDeleteInput

approvalProjectRuleDelete arguments

Name Type Description
id ApprovalProjectRuleID! Global ID of the approval project rule to delete.

approvalProjectRuleDelete fields

Name Type Description
approvalRule ApprovalProjectRule Deleted approval rule.
errors [String!]! Errors encountered during the mutation.

approvalProjectRuleUpdate

  • Status: Experiment

Input type: approvalProjectRuleUpdateInput

approvalProjectRuleUpdate arguments

Name Type Description
approvalsRequired Int! How many approvals are required to satisfy rule.
coverageMinimumThreshold Float Minimum 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.
id ApprovalProjectRuleID! Global ID of the approval rule to destroy.
name String! Name of the approval rule.
userIds [ID!] List of IDs of Users that can approval rule.

approvalProjectRuleUpdate fields

Name Type Description
approvalRule ApprovalProjectRule Approval rule after mutation.
errors [String!]! Errors encountered during the mutation.

approveDeployment

Input type: ApproveDeploymentInput

approveDeployment arguments

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

approveDeployment fields

Name Type Description
deploymentApproval DeploymentApproval DeploymentApproval after mutation.
errors [String!]! Errors encountered during the mutation.

artifactDestroy

Input type: ArtifactDestroyInput

artifactDestroy arguments

Name Type Description
id CiJobArtifactID! ID of the artifact to delete.

artifactDestroy fields

Name Type Description
artifact CiJobArtifact Deleted artifact.
errors [String!]! Errors encountered during the mutation.

artifactRegistryActivate

  • Status: Experiment

Activates an Artifact Registry for an organization by claiming a slug. Does not activate Artifact Registry if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryActivateInput

artifactRegistryActivate arguments

Name Type Description
slug String! Slug to claim, Artifact Registry’s immutable identifier for the namespace.

artifactRegistryActivate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry ArtifactRegistry Introduced as an experiment in GitLab 19.4.

The organization’s registry: the one just provisioned, or the existing one when the organization is already activated. Null on every other refusal.

artifactRegistryArtifactDelete

  • Status: Experiment

Deletes 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. Does not delete the artifact if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryArtifactDeleteInput

artifactRegistryArtifactDelete arguments

Name Type Description
id ID! ID of the artifact in Artifact Registry, as returned by the id field on a package or image. Not a GitLab global ID.
name String! Name of the repository holding the artifact, unique within the organization.

artifactRegistryArtifactDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
repository ArtifactRegistryRepository Repository holding the deleted artifact. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.

artifactRegistryContainerTagDelete

  • Status: Experiment

Deletes 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. Does not delete the tag if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryContainerTagDeleteInput

artifactRegistryContainerTagDelete arguments

Name Type Description
imageId ID! ID of the image holding the tag in Artifact Registry, as returned by the id field on an image. Not a GitLab global ID.
name String! Name of the repository holding the tag, unique within the organization.
tagName String! Name of the tag to delete. Limited to 1024 characters.

artifactRegistryContainerTagDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
repository ArtifactRegistryRepository Repository holding the deleted tag. A tag delete moves no repository counter. Null when the deletion was not accepted.

artifactRegistryDisable

  • Status: Experiment

Disables Artifact Registry for the organization resolved from the request context (the X-GitLab-Organization-ID header, or the user default organization). Does not disable Artifact Registry if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryDisableInput

artifactRegistryDisable fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry ArtifactRegistry Registry after the transition. Null when the transition was rejected, for example an unknown namespace.

artifactRegistryEnable

  • Status: Experiment

Enables Artifact Registry for the organization resolved from the request context (the X-GitLab-Organization-ID header, or the user default organization). Does not enable Artifact Registry if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryEnableInput

artifactRegistryEnable fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry ArtifactRegistry Registry after the transition. Null when the transition was rejected, for example an unknown namespace.

artifactRegistryManifestDelete

  • Status: Experiment

Deletes 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. Does not delete the manifest if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryManifestDeleteInput

artifactRegistryManifestDelete arguments

Name Type Description
digest String! Content-addressable digest of the manifest, as returned by the digest field on a manifest. Limited to 512 characters. Deletion is refused if another manifest indexes this one as a child, and the error lists at most 10 blocking digests plus the total count.
imageId ID! ID of the image holding the manifest in Artifact Registry, as returned by the id field on an image. Not a GitLab global ID.
name String! Name of the repository holding the manifest, unique within the organization.

artifactRegistryManifestDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
repository ArtifactRegistryRepository Repository holding the deleted manifest. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not accepted.

artifactRegistryManifestsBulkDelete

  • Status: Experiment

Deletes up to 1000 manifests of one image, by digest. Applies to Docker and OCI repositories only. Permanently deletes manifests on a hosted repository and evicts cached copies on a remote repository. A virtual repository holds no manifests, so the mutation returns not found in errors. Deleting a manifest removes its tags. Artifact Registry applies the batch in the background, so the mutation reports acceptance, not completion, and a manifest can still be listed until the batch reaches it. Only the named manifests are deleted: deleting an index leaves the manifests it indexes. A manifest that an index outside the batch references is skipped and not reported. Does not delete manifests if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryManifestsBulkDeleteInput

artifactRegistryManifestsBulkDelete arguments

Name Type Description
ids [String!]! Content-addressable digests of the manifests to delete, as returned by the digest field on a manifest: sha256: followed by 64 lowercase hexadecimal characters. Takes 1 to 1000 entries, and a repeated digest counts toward the limit. A digest that names no manifest is ignored. Pass the list as a variable: the query text is limited to 10,000 characters.
imageId ID! ID of the image holding the manifests in Artifact Registry, as returned by the id field on an image. Not a GitLab global ID.
name String! Name of the repository holding the image, unique within the organization.

artifactRegistryManifestsBulkDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
repository ArtifactRegistryRepository Repository holding the deleted manifests. Counters were read before the deletion applied, so they can lag its result. Null when the batch was refused or not accepted.

artifactRegistryNpmDistTagDelete

  • Status: Experiment

Deletes 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. Does not delete the dist-tag if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryNpmDistTagDeleteInput

artifactRegistryNpmDistTagDelete arguments

Name Type Description
id ID! ID of the dist-tag in Artifact Registry. Not a GitLab global ID.
name String! Name of the repository holding the dist-tag, unique within the organization.

artifactRegistryNpmDistTagDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
repository ArtifactRegistryRepository Repository holding the deleted dist-tag. A dist-tag delete moves no repository counter. Null when the deletion was not accepted.

artifactRegistryRepositoryArtifactsDelete

  • Status: Experiment

Deletes 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. Does not delete the artifacts if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryRepositoryArtifactsDeleteInput

artifactRegistryRepositoryArtifactsDelete arguments

Name Type Description
name String! Name of the repository whose artifacts are deleted, unique within the organization.

artifactRegistryRepositoryArtifactsDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
repository ArtifactRegistryRepository Repository the deletion targeted. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.

artifactRegistryRepositoryCreate

  • Status: Experiment

Creates a repository in Artifact Registry. Does not create the repository if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryRepositoryCreateInput

artifactRegistryRepositoryCreate arguments

Name Type Description
description String Human-readable description of the repository.
format ArtifactRegistryRepositoryFormat! Package format the repository holds. Cannot be changed after creation.
kind ArtifactRegistryRepositoryKind How the repository sources its artifacts. Defaults to hosted in Artifact Registry.
name String! Name of the repository, unique within the organization.
settings ArtifactRegistryRemoteSettingsInput Introduced as an experiment in GitLab 19.4.

Upstream configuration. Required on a remote repository create, rejected on any other kind.
upstreamRepositoryIds [ID!] Introduced as an experiment in GitLab 19.5.

Upstream repositories of a virtual repository, as Artifact Registry repository IDs in resolution order. On update, replaces the whole upstream list, and an empty list removes every upstream. Rejected on any other kind. Maximum is 1000 IDs per request. Artifact Registry sets a lower limit on how many upstreams a repository can have.
visibility ArtifactRegistryRepositoryVisibility Who can read the repository.

artifactRegistryRepositoryCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
refusedUpstreamRepositoryId ID Introduced as an experiment in GitLab 19.5.

Artifact Registry ID of the first upstream list entry that Artifact Registry refused. Null unless an entry was refused.
repository ArtifactRegistryRepository Repository created. Null when the creation was not applied.

artifactRegistryRepositoryDelete

  • Status: Experiment

Deletes a repository in Artifact Registry and removes every artifact it holds. Deleting an already-absent repository still succeeds. Does not delete the repository if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryRepositoryDeleteInput

artifactRegistryRepositoryDelete arguments

Name Type Description
name String! Name of the repository to delete, unique within the organization.

artifactRegistryRepositoryDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

artifactRegistryRepositoryTestConnection

  • Status: Experiment

Tests the upstream connection of a remote repository in Artifact Registry. Does not test the connection if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryRepositoryTestConnectionInput

artifactRegistryRepositoryTestConnection arguments

Name Type Description
name String! Name of the repository to test, unique within the organization.

artifactRegistryRepositoryTestConnection fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
httpStatus Int Status the upstream answered the probe with. Null when the probe failed in transport and no response arrived, and when no probe ran.
lastHealthCheckedAt Time Timestamp 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.
lastHealthStatus ArtifactRegistryHealthStatus Stored 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.
passed Boolean Indicates 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.

artifactRegistryRepositoryUpdate

  • Status: Experiment

Updates a repository in Artifact Registry. Artifact Registry writes the metadata fields and the settings in one transaction, so a failed update applies none of the changes. Does not update the repository if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryRepositoryUpdateInput

artifactRegistryRepositoryUpdate arguments

Name Type Description
description String Human-readable description of the repository.
name String! Name of the repository to update, unique within the organization. Cannot be changed.
settings ArtifactRegistryRemoteSettingsInput Introduced as an experiment in GitLab 19.4.

Upstream configuration. Required on a remote repository create, rejected on any other kind.
upstreamRepositoryIds [ID!] Introduced as an experiment in GitLab 19.5.

Upstream repositories of a virtual repository, as Artifact Registry repository IDs in resolution order. On update, replaces the whole upstream list, and an empty list removes every upstream. Rejected on any other kind. Maximum is 1000 IDs per request. Artifact Registry sets a lower limit on how many upstreams a repository can have.
visibility ArtifactRegistryRepositoryVisibility Who can read the repository.

artifactRegistryRepositoryUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
refusedUpstreamRepositoryId ID Introduced as an experiment in GitLab 19.5.

Artifact Registry ID of the first upstream list entry that Artifact Registry refused. Null unless an entry was refused.
repository ArtifactRegistryRepository Repository updated. Null when the update was not applied.

artifactRegistryRoleBulkGrant

  • Status: Experiment

Grants 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

artifactRegistryRoleBulkGrant arguments

Name Type Description
assignments [ArtifactRegistryRoleAssignmentInput!]! Role assignments to grant. All succeed or none are written. A maximum of 1000 assignments is allowed per request.

artifactRegistryRoleBulkGrant fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
grantedRoleCount Int Number of role assignments granted. Present only on success.

artifactRegistryRoleBulkRevoke

  • Status: Experiment

Revokes Artifact Registry roles from users on resources in a single all-or-nothing operation. Users can revoke their own role.

Input type: ArtifactRegistryRoleBulkRevokeInput

artifactRegistryRoleBulkRevoke arguments

Name Type Description
revocations [ArtifactRegistryRoleRevocationInput!]! Role revocations to apply. All succeed or none are applied. A maximum of 1000 revocations is allowed per request.

artifactRegistryRoleBulkRevoke fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
revokedRoleCount Int Number of role assignments revoked. Present only on success.

artifactRegistryRoleGrant

  • Status: Experiment

Grants an Artifact Registry role to a user on a resource. Replaces any role the user already holds on that resource.

Input type: ArtifactRegistryRoleGrantInput

artifactRegistryRoleGrant arguments

Name Type Description
assigneeId UserID! Global ID of the user to grant the role to.
resourceId String! UUID of the Artifact Registry resource (repository or namespace) the role applies to.
role ArtifactRegistryRole! Artifact Registry role to grant.

artifactRegistryRoleGrant fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

artifactRegistryRoleRevoke

  • Status: Experiment

Revokes 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

artifactRegistryRoleRevoke arguments

Name Type Description
assigneeId UserID! Global ID of the user to revoke the role from.
resourceId String! UUID of the Artifact Registry resource (repository or namespace) the role is assigned on.

artifactRegistryRoleRevoke fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

artifactRegistryUpstreamRepositoryDissociate

  • Status: Experiment

Removes 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. Does not remove the association if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryUpstreamRepositoryDissociateInput

artifactRegistryUpstreamRepositoryDissociate arguments

Name Type Description
associationId ID! ID of the upstream repository association to remove, as returned by the id field on an upstream repository association. Not a GitLab global ID.
format ArtifactRegistryRepositoryFormat! Package format of the virtual repository.
name String! Name of the virtual repository holding the upstream repository, unique within the organization.

artifactRegistryUpstreamRepositoryDissociate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

artifactRegistryUpstreamTestConnection

  • Status: Experiment

Tests a supplied upstream connection for the remote repository create form in Artifact Registry, before any repository exists to hold it. Does not test the connection if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryUpstreamTestConnectionInput

artifactRegistryUpstreamTestConnection arguments

Name Type Description
credentials ArtifactRegistryRemoteCredentialsInput Upstream 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.
format ArtifactRegistryRepositoryFormat! Package format of the upstream to probe. Decides the credential shape and the probe auth.
url String! Base URL of the upstream to probe.

artifactRegistryUpstreamTestConnection fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
httpStatus Int Status the upstream answered the probe with. Null when the probe failed in transport and no response arrived, and when no probe ran.
passed Boolean Indicates 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.

artifactRegistryVersionDelete

  • Status: Experiment

Deletes 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. Does not delete the version if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryVersionDeleteInput

artifactRegistryVersionDelete arguments

Name Type Description
id ID! ID of the version in Artifact Registry, as returned by the id field on a version. Not a GitLab global ID.
name String! Name of the repository holding the version, unique within the organization.

artifactRegistryVersionDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
repository ArtifactRegistryRepository Repository holding the deleted version. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.

artifactRegistryVersionsBulkDelete

  • Status: Experiment

Deletes up to 1000 versions of one package in an Artifact Registry repository, each with its files. Permanently deletes published versions on a hosted repository and evicts cached versions on a remote repository. A virtual repository holds no versions, so the mutation returns not found in errors. Artifact Registry applies the batch in the background, so the mutation reports acceptance rather than completion, and a version can still be listed until the batch reaches it. Re-read the version list to see the result. On a hosted npm repository, deleting a version also removes its dist-tags, and deleting a package’s last version removes the package. Applies to Maven and npm repositories only. Does not delete versions if the artifact_registry_ui feature flag is disabled.

Input type: ArtifactRegistryVersionsBulkDeleteInput

artifactRegistryVersionsBulkDelete arguments

Name Type Description
ids [ID!]! IDs of the versions to delete in Artifact Registry, as returned by the id field on a version. Not GitLab global IDs. Takes 1 to 1000 entries, and a repeated ID counts toward the limit. IDs that name no version of the package are ignored. Pass the list as a variable: the query text is limited to 10,000 characters.
name String! Name of the repository holding the package, unique within the organization.
packageId ID! ID of the package holding the versions in Artifact Registry, as returned by the id field on a package. Not a GitLab global ID.

artifactRegistryVersionsBulkDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
repository ArtifactRegistryRepository Repository holding the deleted versions. Counters were read before the deletion applied, so they can lag its result. Null when the batch was refused or not accepted.

ascpComponentCreate

  • Status: Experiment

Input type: AscpComponentCreateInput

ascpComponentCreate arguments

Name Type Description
description String Component description.
expectedUserBehavior String Expected user behavior for the component.
projectPath ID! Full path of the project.
scanId SecurityAscpScanID! ID of the scan when the component was discovered.
subDirectory String! Sub-directory path containing the component.
title String! Component title.

ascpComponentCreate fields

Name Type Description
component AscpComponent Introduced as an experiment in GitLab 18.11.

Created component.
errors [String!]! Errors encountered during the mutation.

ascpScanCreate

  • Status: Experiment

Input type: AscpScanCreateInput

ascpScanCreate arguments

Name Type Description Default
baseCommitSha String Base commit SHA for incremental scans.
baseScanId SecurityAscpScanID ID of the base scan for incremental scans.
commitSha String! Git commit SHA that was scanned.
projectPath ID! Full path of the project.
scanType AscpScanType Type of scan (default: full). FULL

ascpScanCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
scan AscpScan Introduced as an experiment in GitLab 18.10.

Created scan.

ascpSecurityContextCreate

  • Status: Experiment

Input type: AscpSecurityContextCreateInput

ascpSecurityContextCreate arguments

Name Type Description
authenticationModel String How users authenticate to the component.
authorizationModel String How access is controlled.
componentId SecurityAscpComponentID! ID of the component.
dataSensitivity String Types of sensitive data handled.
guidelines [AscpSecurityGuidelineInput!]! List of security guidelines.
projectPath ID! Full path of the project.
scanId SecurityAscpScanID! ID of the scan when the security context was created.
securityBoundary [AscpSecurityBoundary!] Security boundaries the component sits on.
summary String High-level threat model summary.

ascpSecurityContextCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityContext AscpSecurityContext Introduced as an experiment in GitLab 18.11.

Created security context.

auditEventsAmazonS3ConfigurationCreate

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

Input type: AuditEventsAmazonS3ConfigurationCreateInput

auditEventsAmazonS3ConfigurationCreate arguments

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

auditEventsAmazonS3ConfigurationCreate fields

Name Type Description
amazonS3Configuration AmazonS3ConfigurationType configuration created.
errors [String!]! Errors encountered during the mutation.

auditEventsAmazonS3ConfigurationDelete

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.

Input type: AuditEventsAmazonS3ConfigurationDeleteInput

auditEventsAmazonS3ConfigurationDelete arguments

Name Type Description
id AuditEventsAmazonS3ConfigurationID! ID of the Amazon S3 configuration to destroy.

auditEventsAmazonS3ConfigurationDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsAmazonS3ConfigurationUpdate

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: AuditEventsAmazonS3ConfigurationUpdateInput

auditEventsAmazonS3ConfigurationUpdate arguments

Name Type Description
accessKeyXid String Access key ID of the Amazon S3 account.
active Boolean Active status of the destination.
awsRegion String AWS region where the bucket is created.
bucketName String Name of the bucket where the audit events would be logged.
id AuditEventsAmazonS3ConfigurationID! ID of the Amazon S3 configuration to update.
name String Destination name.
secretAccessKey String Secret access key of the Amazon S3 account.

auditEventsAmazonS3ConfigurationUpdate fields

Name Type Description
amazonS3Configuration AmazonS3ConfigurationType Updated Amazon S3 configuration.
errors [String!]! Errors encountered during the mutation.

auditEventsGroupDestinationDenylistEventsAdd

  • Status: Experiment

Input type: AuditEventsGroupDestinationDenylistEventsAddInput

auditEventsGroupDestinationDenylistEventsAdd arguments

Name Type Description
destinationId AuditEventsGroupExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add to the denylist.

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

auditEventsGroupDestinationDenylistEventsDelete

  • Status: Experiment

Input type: AuditEventsGroupDestinationDenylistEventsDeleteInput

auditEventsGroupDestinationDenylistEventsDelete arguments

Name Type Description
destinationId AuditEventsGroupExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from the denylist.

auditEventsGroupDestinationDenylistEventsDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsGroupDestinationEventsAdd

  • Status: Experiment

Input type: AuditEventsGroupDestinationEventsAddInput

auditEventsGroupDestinationEventsAdd arguments

Name Type Description
destinationId AuditEventsGroupExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

auditEventsGroupDestinationEventsAdd fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

auditEventsGroupDestinationEventsDelete

  • Status: Experiment

Input type: AuditEventsGroupDestinationEventsDeleteInput

auditEventsGroupDestinationEventsDelete arguments

Name Type Description
destinationId AuditEventsGroupExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

auditEventsGroupDestinationEventsDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsGroupDestinationNamespaceFilterCreate

  • Status: Experiment

Input type: AuditEventsGroupDestinationNamespaceFilterCreateInput

auditEventsGroupDestinationNamespaceFilterCreate arguments

Name Type Description
destinationId AuditEventsGroupExternalStreamingDestinationID! Destination ID.
namespacePath String Full path of the namespace(only project or group).

auditEventsGroupDestinationNamespaceFilterCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespaceFilter GroupAuditEventNamespaceFilter Namespace filter created.

auditEventsGroupDestinationNamespaceFilterDelete

  • Status: Experiment

Input type: AuditEventsGroupDestinationNamespaceFilterDeleteInput

auditEventsGroupDestinationNamespaceFilterDelete arguments

Name Type Description
namespaceFilterId AuditEventsGroupNamespaceFilterID! Namespace filter ID.

auditEventsGroupDestinationNamespaceFilterDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsInstanceAmazonS3ConfigurationCreate

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

Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput

auditEventsInstanceAmazonS3ConfigurationCreate arguments

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

auditEventsInstanceAmazonS3ConfigurationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
instanceAmazonS3Configuration InstanceAmazonS3ConfigurationType Created instance Amazon S3 configuration.

auditEventsInstanceAmazonS3ConfigurationDelete

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput

auditEventsInstanceAmazonS3ConfigurationDelete arguments

Name Type Description
id AuditEventsInstanceAmazonS3ConfigurationID! ID of the instance-level Amazon S3 configuration to delete.

auditEventsInstanceAmazonS3ConfigurationDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsInstanceAmazonS3ConfigurationUpdate

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput

auditEventsInstanceAmazonS3ConfigurationUpdate arguments

Name Type Description
accessKeyXid String Access key ID of the Amazon S3 account.
active Boolean Active status of the destination.
awsRegion String AWS region where the bucket is created.
bucketName String Name of the bucket where the audit events would be logged.
id AuditEventsInstanceAmazonS3ConfigurationID! ID of the instance-level Amazon S3 configuration to update.
name String Destination name.
secretAccessKey String Secret access key of the Amazon S3 account.

auditEventsInstanceAmazonS3ConfigurationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
instanceAmazonS3Configuration InstanceAmazonS3ConfigurationType Updated instance-level Amazon S3 configuration.

auditEventsInstanceDestinationDenylistEventsAdd

  • Status: Experiment

Input type: AuditEventsInstanceDestinationDenylistEventsAddInput

auditEventsInstanceDestinationDenylistEventsAdd arguments

Name Type Description
destinationId AuditEventsInstanceExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add to the denylist (maximum is 1000).

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

auditEventsInstanceDestinationDenylistEventsDelete

  • Status: Experiment

Input type: AuditEventsInstanceDestinationDenylistEventsDeleteInput

auditEventsInstanceDestinationDenylistEventsDelete arguments

Name Type Description
destinationId AuditEventsInstanceExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from the denylist (maximum is 1000).

auditEventsInstanceDestinationDenylistEventsDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsInstanceDestinationEventsAdd

  • Status: Experiment

Input type: AuditEventsInstanceDestinationEventsAddInput

auditEventsInstanceDestinationEventsAdd arguments

Name Type Description
destinationId AuditEventsInstanceExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

auditEventsInstanceDestinationEventsAdd fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

auditEventsInstanceDestinationEventsDelete

  • Status: Experiment

Input type: AuditEventsInstanceDestinationEventsDeleteInput

auditEventsInstanceDestinationEventsDelete arguments

Name Type Description
destinationId AuditEventsInstanceExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

auditEventsInstanceDestinationEventsDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsInstanceDestinationNamespaceFilterCreate

  • Status: Experiment

Input type: AuditEventsInstanceDestinationNamespaceFilterCreateInput

auditEventsInstanceDestinationNamespaceFilterCreate arguments

Name Type Description
destinationId AuditEventsInstanceExternalStreamingDestinationID! Destination ID.
namespacePath String Full path of the namespace. Project or group namespaces only.

auditEventsInstanceDestinationNamespaceFilterCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespaceFilter InstanceAuditEventNamespaceFilter Namespace filter to be created.

auditEventsInstanceDestinationNamespaceFilterDelete

  • Status: Experiment

Input type: AuditEventsInstanceDestinationNamespaceFilterDeleteInput

auditEventsInstanceDestinationNamespaceFilterDelete arguments

Name Type Description
namespaceFilterId AuditEventsInstanceNamespaceFilterID! Namespace filter ID.

auditEventsInstanceDestinationNamespaceFilterDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsStreamingDestinationEventsAdd

Deprecated in GitLab 18.10. Use auditEventsGroupDestinationEventsAdd instead.

Input type: AuditEventsStreamingDestinationEventsAddInput

auditEventsStreamingDestinationEventsAdd arguments

Name Type Description
destinationId AuditEventsExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

auditEventsStreamingDestinationEventsAdd fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

auditEventsStreamingDestinationEventsRemove

Deprecated in GitLab 18.10. Use auditEventsGroupDestinationEventsRemove instead.

Input type: AuditEventsStreamingDestinationEventsRemoveInput

auditEventsStreamingDestinationEventsRemove arguments

Name Type Description
destinationId AuditEventsExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

auditEventsStreamingDestinationEventsRemove fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsStreamingDestinationInstanceEventsAdd

Deprecated in GitLab 18.10. Use auditEventsInstanceDestinationEventsAdd instead.

Input type: AuditEventsStreamingDestinationInstanceEventsAddInput

auditEventsStreamingDestinationInstanceEventsAdd arguments

Name Type Description
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

auditEventsStreamingDestinationInstanceEventsAdd fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

auditEventsStreamingDestinationInstanceEventsRemove

Deprecated in GitLab 18.10. Use auditEventsInstanceDestinationEventsRemove instead.

Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput

auditEventsStreamingDestinationInstanceEventsRemove arguments

Name Type Description
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

auditEventsStreamingDestinationInstanceEventsRemove fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsStreamingHeadersCreate

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

Input type: AuditEventsStreamingHeadersCreateInput

auditEventsStreamingHeadersCreate arguments

Name Type Description Default
active Boolean Boolean option determining whether header is active or not. true
destinationId AuditEventsExternalAuditEventDestinationID! Destination to associate header with.
key String! Header key.
value String! Header value.

auditEventsStreamingHeadersCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
header AuditEventStreamingHeader Created header.

auditEventsStreamingHeadersDestroy

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

Input type: AuditEventsStreamingHeadersDestroyInput

auditEventsStreamingHeadersDestroy arguments

Name Type Description
headerId AuditEventsStreamingHeaderID! Header to delete.

auditEventsStreamingHeadersDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsStreamingHeadersUpdate

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

Input type: AuditEventsStreamingHeadersUpdateInput

auditEventsStreamingHeadersUpdate arguments

Name Type Description Default
active Boolean Boolean option determining whether header is active or not. null
headerId AuditEventsStreamingHeaderID! Header to update.
key String Header key. null
value String Header value. null

auditEventsStreamingHeadersUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
header AuditEventStreamingHeader Updates header.

auditEventsStreamingHttpNamespaceFiltersAdd

Deprecated in GitLab 18.10. Use auditEventsGroupDestinationNamespaceFilterCreate instead.

Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput

auditEventsStreamingHttpNamespaceFiltersAdd arguments

Name Type Description
destinationId AuditEventsExternalAuditEventDestinationID! Destination ID.
groupPath ID Full path of the group.
projectPath ID Full path of the project.

auditEventsStreamingHttpNamespaceFiltersAdd fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespaceFilter AuditEventStreamingHTTPNamespaceFilter Namespace filter created.

auditEventsStreamingHttpNamespaceFiltersDelete

Deprecated in GitLab 18.10. Use auditEventsGroupDestinationNamespaceFilterDelete instead.

Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput

auditEventsStreamingHttpNamespaceFiltersDelete arguments

Name Type Description
namespaceFilterId AuditEventsStreamingHTTPNamespaceFilterID! Namespace filter ID.

auditEventsStreamingHttpNamespaceFiltersDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsStreamingInstanceHeadersCreate

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

Input type: AuditEventsStreamingInstanceHeadersCreateInput

auditEventsStreamingInstanceHeadersCreate arguments

Name Type Description Default
active Boolean Boolean option determining whether header is active or not. true
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Instance level external destination to associate header with.
key String! Header key.
value String! Header value.

auditEventsStreamingInstanceHeadersCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
header AuditEventsStreamingInstanceHeader Created header.

auditEventsStreamingInstanceHeadersDestroy

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

Input type: AuditEventsStreamingInstanceHeadersDestroyInput

auditEventsStreamingInstanceHeadersDestroy arguments

Name Type Description
headerId AuditEventsStreamingInstanceHeaderID! Header to delete.

auditEventsStreamingInstanceHeadersDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

auditEventsStreamingInstanceHeadersUpdate

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

Input type: AuditEventsStreamingInstanceHeadersUpdateInput

auditEventsStreamingInstanceHeadersUpdate arguments

Name Type Description Default
active Boolean Boolean option determining whether header is active or not. null
headerId AuditEventsStreamingInstanceHeaderID! Header to update.
key String Header key. null
value String Header value. null

auditEventsStreamingInstanceHeadersUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
header AuditEventsStreamingInstanceHeader Updates header.

awardEmojiAdd

Input type: AwardEmojiAddInput

awardEmojiAdd arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
name String! Emoji name.

awardEmojiAdd fields

Name Type Description
awardEmoji AwardEmoji Emoji reactions after mutation.
errors [String!]! Errors encountered during the mutation.

awardEmojiRemove

Input type: AwardEmojiRemoveInput

awardEmojiRemove arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
name String! Emoji name.

awardEmojiRemove fields

Name Type Description
awardEmoji AwardEmoji Emoji reactions after mutation.
errors [String!]! Errors encountered during the mutation.

awardEmojiToggle

Input type: AwardEmojiToggleInput

awardEmojiToggle arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
name String! Emoji name.

awardEmojiToggle fields

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

boardEpicCreate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: BoardEpicCreateInput

boardEpicCreate arguments

Name Type Description
boardId BoardsEpicBoardID! Global ID of the board that the epic is in.
groupPath ID! Group the epic to create is in.
listId BoardsEpicListID! Global ID of the epic board list in which epic will be created.
title String! Title of the epic.

boardEpicCreate fields

Name Type Description
epic Epic Epic after creation.
errors [String!]! Errors encountered during the mutation.

boardListCreate

Input type: BoardListCreateInput

boardListCreate arguments

Name Type Description
assigneeId UserID Global ID of an existing user.
backlog Boolean Create the backlog list.
boardId BoardID! Global ID of the issue board to mutate.
iterationId IterationID Global ID of an existing iteration.
labelId LabelID Global ID of an existing label.
milestoneId MilestoneID Global ID of an existing milestone.
position Int Position of the list.
statusId WorkItemsStatusesStatusID Introduced as an experiment in GitLab 18.0.

Global ID of an existing status.

boardListCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
list BoardList Issue list in the issue board.

boardListUpdateLimitMetrics

Input type: BoardListUpdateLimitMetricsInput

boardListUpdateLimitMetrics arguments

Name Type Description
limitMetric ListLimitMetric New limit metric type for the list.
listId ListID! Global ID of the list.
maxIssueCount Int New maximum issue count limit.
maxIssueWeight Int New maximum issue weight limit.

boardListUpdateLimitMetrics fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
list BoardList Updated list.

branchDelete

Input type: BranchDeleteInput

branchDelete arguments

Name Type Description
name String! Name of the branch.
projectPath ID! Project full path the branch is associated with.

branchDelete fields

Name Type Description
branch Branch Branch after mutation.
errors [String!]! Errors encountered during the mutation.

branchRuleApprovalProjectRuleCreate

  • Status: Experiment

Input type: branchRuleApprovalProjectRuleCreateInput

branchRuleApprovalProjectRuleCreate arguments

Name Type Description
approvalsRequired Int! How many approvals are required to satisfy rule.
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule to destroy.
coverageMinimumThreshold Float Minimum 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.
name String! Name of the approval rule.
userIds [ID!] List of IDs of Users that can approval rule.

branchRuleApprovalProjectRuleCreate fields

Name Type Description
approvalRule ApprovalProjectRule Approval rule after mutation.
errors [String!]! Errors encountered during the mutation.

branchRuleCreate

  • Status: Experiment

Input type: BranchRuleCreateInput

branchRuleCreate arguments

Name Type Description
name String! Branch name, with wildcards, for the branch rules.
projectPath ID! Full path to the project that the branch is associated with.

branchRuleCreate fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
errors [String!]! Errors encountered during the mutation.

branchRuleDelete

  • Status: Experiment

Input type: BranchRuleDeleteInput

branchRuleDelete arguments

Name Type Description
id ProjectsBranchRuleID! Global ID of the branch rule to destroy.

branchRuleDelete fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
errors [String!]! Errors encountered during the mutation.

branchRuleExternalStatusCheckCreate

  • Status: Experiment

Create a new external status check from a branch rule.

Input type: BranchRuleExternalStatusCheckCreateInput

branchRuleExternalStatusCheckCreate arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule to update.
externalUrl String! URL of external status check resource.
name String! Name of the external status check.
sharedSecret String HMAC shared secret for authenticating external status check requests.

branchRuleExternalStatusCheckCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalStatusCheck ExternalStatusCheck New status check after mutation.

branchRuleExternalStatusCheckDestroy

  • Status: Experiment

Destroy an external status check from a branch rule.

Input type: BranchRuleExternalStatusCheckDestroyInput

branchRuleExternalStatusCheckDestroy arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.
id MergeRequestsExternalStatusCheckID! Global ID of the external status check to destroy.

branchRuleExternalStatusCheckDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

branchRuleExternalStatusCheckUpdate

  • Status: Experiment

Update an external status check from a branch rule.

Input type: BranchRuleExternalStatusCheckUpdateInput

branchRuleExternalStatusCheckUpdate arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.
externalUrl String! External URL of the external status check.
id MergeRequestsExternalStatusCheckID! Global ID of the external status check to update.
name String! Name of the external status check.
sharedSecret String HMAC shared secret for authenticating external status check requests.

branchRuleExternalStatusCheckUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalStatusCheck ExternalStatusCheck Updated external status check after mutation.

branchRuleSquashOptionCreate

  • Status: Experiment

Create a squash option for a branch rule.

Input type: BranchRuleSquashOptionCreateInput

branchRuleSquashOptionCreate arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.
squashOption SquashOptionSetting! Squash option to set for the branch rule.

branchRuleSquashOptionCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
squashOption SquashOption Created squash option after mutation.

branchRuleSquashOptionDelete

  • Status: Experiment

Delete a squash option for a branch rule.

Input type: BranchRuleSquashOptionDeleteInput

branchRuleSquashOptionDelete arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.

branchRuleSquashOptionDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

branchRuleSquashOptionUpdate

  • Status: Experiment

Update a squash option for a branch rule.

Input type: BranchRuleSquashOptionUpdateInput

branchRuleSquashOptionUpdate arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.
squashOption SquashOptionSetting! Squash option after mutation.

branchRuleSquashOptionUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
squashOption SquashOption Updated squash option after mutation.

branchRuleUpdate

  • Status: Experiment

Input type: BranchRuleUpdateInput

branchRuleUpdate arguments

Name Type Description
branchProtection BranchProtectionInput Branch protections configured for the branch rule.
id ProjectsBranchRuleID! Global ID of the branch rule to update.
name String! Branch name, with wildcards, for the branch rules.

branchRuleUpdate fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
errors [String!]! Errors encountered during the mutation.

bulkDestroyJobArtifacts

  • Status: Experiment

Input type: BulkDestroyJobArtifactsInput

bulkDestroyJobArtifacts arguments

Name Type Description
ids [CiJobArtifactID!]! Global IDs of the job artifacts to destroy.
projectId ProjectID! Global Project ID of the job artifacts to destroy. Incompatible with projectPath.

bulkDestroyJobArtifacts fields

Name Type Description
destroyedCount Int Number of job artifacts deleted.
destroyedIds [CiJobArtifactID!] IDs of job artifacts that were deleted.
errors [String!]! Errors encountered during the mutation.

bulkEnableDevopsAdoptionNamespaces

Status: Beta.

Input type: BulkEnableDevopsAdoptionNamespacesInput

bulkEnableDevopsAdoptionNamespaces arguments

Name Type Description
displayNamespaceId NamespaceID Display namespace ID.
namespaceIds [NamespaceID!]! List of Namespace IDs.

bulkEnableDevopsAdoptionNamespaces fields

Name Type Description
enabledNamespaces [DevopsAdoptionEnabledNamespace!] Enabled namespaces after mutation.
errors [String!]! Errors encountered during the mutation.

bulkRunnerDelete

  • Status: Experiment

Input type: BulkRunnerDeleteInput

bulkRunnerDelete arguments

Name Type Description
ids [CiRunnerID!] IDs of the runners to delete.

bulkRunnerDelete fields

Name Type Description
deletedCount Int Number of records effectively deleted. Only present if operation was performed synchronously.
deletedIds [CiRunnerID!] IDs of records effectively deleted. Only present if operation was performed synchronously.
errors [String!]! Errors encountered during the mutation.

bulkSetVulnerabilityFindingsDueDates

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

Input type: BulkSetVulnerabilityFindingsDueDatesInput

bulkSetVulnerabilityFindingsDueDates arguments

Name Type Description
projectFullPath String! Full path of the project.
updates [FindingDueDatesSetInput!]! List of finding UUIDs with due dates. A maximum of 1000 updates is allowed per request.

bulkSetVulnerabilityFindingsDueDates fields

Name Type Description
assigned Int Number 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.
removed Int Number of findings for which a due date was successfully removed.
skipped Int Number of findings that were skipped due to errors or not found.

bulkUpdateAiToolRules

  • Status: Experiment

Bulk updates permission settings for multiple AI tool rules.

Input type: BulkUpdateAiToolRulesInput

bulkUpdateAiToolRules arguments

Name Type Description
fullPath ID! Full path of the root namespace to update tool rules for.
projectPath ID Full 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.

bulkUpdateAiToolRules fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
results [BulkToolRuleResult!]! Results for each tool rule update, including any per-item errors.

bulkUpdateSecurityAttributes

Input type: BulkUpdateSecurityAttributesInput

bulkUpdateSecurityAttributes arguments

Name Type Description
attributes [SecurityAttributeID!]! Global IDs of security attributes to apply.
items [ID!]! Global IDs of groups and projects to update.
mode SecurityAttributeBulkUpdateMode! Update mode: add, remove, or replace attributes.

bulkUpdateSecurityAttributes fields

Name Type Description
errors [String!]! Errors encountered while initiating the bulk update operation.

cancelVulnerabilityWorkflow

Cancels a vulnerability workflow execution.

Input type: CancelVulnerabilityWorkflowInput

cancelVulnerabilityWorkflow arguments

Name Type Description
projectId ProjectID! Global ID of the project.
workflow VulnerabilityDuoWorkflow! Workflow to cancel.

cancelVulnerabilityWorkflow fields

Name Type Description
errorReason VulnerabilityWorkflowErrorReason Machine-readable reason for the mutation error.
errors [String!]! Errors encountered during the mutation.
execution VulnerabilityWorkflowExecution Workflow execution.

catalogResourcesCreate

  • Status: Experiment

Input type: CatalogResourcesCreateInput

catalogResourcesCreate arguments

Name Type Description
projectPath ID! Project path belonging to the catalog resource.

catalogResourcesCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

catalogResourcesDestroy

  • Status: Experiment

Input type: CatalogResourcesDestroyInput

catalogResourcesDestroy arguments

Name Type Description
projectPath ID! Project path belonging to the catalog resource.

catalogResourcesDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

cdApplicationCreate

  • Status: Experiment

Creates a continuous deployment application in an organization.

Input type: CdApplicationCreateInput

cdApplicationCreate arguments

Name Type Description
description String Description of the application.
name String! Name of the application.
organizationId OrganizationsOrganizationID! Global ID of the organization to create the application in.
services [CdServiceInput!] Services to create in the application, up to 1000.

cdApplicationCreate fields

Name Type Description
application CdApplication Application created by the mutation.
errors [String!]! Errors encountered during the mutation.

cdApplicationFlowDefinitionCreate

  • Status: Experiment

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

Input type: CdApplicationFlowDefinitionCreateInput

cdApplicationFlowDefinitionCreate arguments

Name Type Description
applicationId CdApplicationID! Global ID of the application to create the flow definition for.
definition String! Body of the flow definition.

cdApplicationFlowDefinitionCreate fields

Name Type Description
applicationFlowDefinition CdApplicationFlowDefinition Application flow definition created by the mutation.
errors [String!]! Errors encountered during the mutation.

cdApplicationLinkCreate

  • Status: Experiment

Creates a link on a continuous deployment application.

Input type: CdApplicationLinkCreateInput

cdApplicationLinkCreate arguments

Name Type Description
applicationId CdApplicationID! Global ID of the application to create the link in.
linkType CdApplicationLinkType! Type of the link.
name String! Name of the link.
url String! URL of the link.

cdApplicationLinkCreate fields

Name Type Description
applicationLink CdApplicationLink Link created by the mutation.
errors [String!]! Errors encountered during the mutation.

cdApplicationLinkDelete

  • Status: Experiment

Deletes a link on a continuous deployment application.

Input type: CdApplicationLinkDeleteInput

cdApplicationLinkDelete arguments

Name Type Description
id CdApplicationLinkID! Global ID of the link to delete.

cdApplicationLinkDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

cdApplicationLinkUpdate

  • Status: Experiment

Updates a link on a continuous deployment application.

Input type: CdApplicationLinkUpdateInput

cdApplicationLinkUpdate arguments

Name Type Description
id CdApplicationLinkID! Global ID of the link to update.
linkType CdApplicationLinkType Type of the link.
name String Name of the link.
url String URL of the link.

cdApplicationLinkUpdate fields

Name Type Description
applicationLink CdApplicationLink Link updated by the mutation.
errors [String!]! Errors encountered during the mutation.

cdApplicationUpdate

  • Status: Experiment

Updates a continuous deployment application.

Input type: CdApplicationUpdateInput

cdApplicationUpdate arguments

Name Type Description
description String Description of the application.
id CdApplicationID! Global ID of the application to update.
name String Name of the application.

cdApplicationUpdate fields

Name Type Description
application CdApplication Application updated by the mutation.
errors [String!]! Errors encountered during the mutation.

cdArtifactSourceCreate

  • Status: Experiment

Creates a continuous deployment artifact source for a service.

Input type: CdArtifactSourceCreateInput

cdArtifactSourceCreate arguments

Name Type Description
name String! Name of the artifact source.
serviceId CdServiceID! Global ID of the service to create the artifact source for.
sourceConfig JSON Configuration of the artifact source, defined by the consuming driver.
sourceRef String! Reference of the artifact source.

cdArtifactSourceCreate fields

Name Type Description
artifactSource CdArtifactSource Artifact source created by the mutation.
errors [String!]! Errors encountered during the mutation.

cdEnvironmentCreate

  • Status: Experiment

Creates a continuous deployment environment in an organization.

Input type: CdEnvironmentCreateInput

cdEnvironmentCreate arguments

Name Type Description
description String Description of the environment.
environmentDriverBinding CdEnvironmentDriverBindingInput! Driver binding to create for the environment.
name String! Name of the environment.
organizationId OrganizationsOrganizationID! Global ID of the organization to create the environment in.
tier CdEnvironmentTier! Tier of the environment.

cdEnvironmentCreate fields

Name Type Description
environment CdEnvironment Environment created by the mutation.
errors [String!]! Errors encountered during the mutation.

cdEnvironmentDriverBindingCreate

  • Status: Experiment

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

Input type: CdEnvironmentDriverBindingCreateInput

cdEnvironmentDriverBindingCreate arguments

Name Type Description
environmentDriverBinding CdEnvironmentDriverBindingInput! Driver binding to create for the environment.
environmentId CdEnvironmentID! Global ID of the environment to bind the driver to.

cdEnvironmentDriverBindingCreate fields

Name Type Description
environmentDriverBinding CdEnvironmentDriverBinding Environment driver binding created by the mutation.
errors [String!]! Errors encountered during the mutation.

cdEnvironmentUpdate

  • Status: Experiment

Updates a continuous deployment environment.

Input type: CdEnvironmentUpdateInput

cdEnvironmentUpdate arguments

Name Type Description
description String Description of the environment.
id CdEnvironmentID! Global ID of the environment to update.
name String Name of the environment.
tier CdEnvironmentTier Tier of the environment.

cdEnvironmentUpdate fields

Name Type Description
environment CdEnvironment Environment updated by the mutation.
errors [String!]! Errors encountered during the mutation.

cdRolloutCreate

  • Status: Experiment

Creates a continuous deployment rollout in an organization.

Input type: CdRolloutCreateInput

cdRolloutCreate arguments

Name Type Description
organizationId OrganizationsOrganizationID! Global ID of the organization to create the rollout in.
versionSetId CdVersionSetID! Global ID of the version set the rollout deploys.

cdRolloutCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
rollout CdRollout Rollout created by the mutation.

cdRolloutGateResolve

  • Status: Experiment

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

Input type: CdRolloutGateResolveInput

cdRolloutGateResolve arguments

Name Type Description
id CdRolloutID! Global ID of the rollout whose approval gate is being resolved.
resolutionReason String Reason for the decision.
status CdRolloutGateStatus! Decision to record for the approval gate.

cdRolloutGateResolve fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
rolloutTransition CdRolloutTransition Rollout transition journal entry created by the mutation.

cdServiceCreate

  • Status: Experiment

Creates a continuous deployment service in an application.

Input type: CdServiceCreateInput

cdServiceCreate arguments

Name Type Description
applicationId CdApplicationID! Global ID of the application to create the service in.
description String Description of the service.
name String! Name of the service.

cdServiceCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
service CdService Service created by the mutation.

cdServiceUpdate

  • Status: Experiment

Updates a continuous deployment service.

Input type: CdServiceUpdateInput

cdServiceUpdate arguments

Name Type Description
description String Description of the service.
id CdServiceID! Global ID of the service to update.
name String Name of the service.

cdServiceUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
service CdService Service updated by the mutation.

cdVersionCreate

  • Status: Experiment

Creates a continuous deployment version from a free-text name, for artifacts GitLab did not observe being pushed.

Input type: CdVersionCreateInput

cdVersionCreate arguments

Name Type Description
artifactSourceId CdArtifactSourceID! Global ID of the artifact source to create the version for.
name String! Name of the version.

cdVersionCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
version CdVersion Version created by the mutation.

cdVersionSetCreate

  • Status: Experiment

Creates a continuous deployment version set in an application.

Input type: CdVersionSetCreateInput

cdVersionSetCreate arguments

Name Type Description
applicationId CdApplicationID! Global ID of the application to create the version set in.
description String Description of the version set.
name String! 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.

cdVersionSetCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
versionSet CdVersionSet Version set created by the mutation.

ciJobTokenScopeAddGroupOrProject

Input type: CiJobTokenScopeAddGroupOrProjectInput

ciJobTokenScopeAddGroupOrProject arguments

Name Type Description Default
defaultPermissions Boolean Introduced as an experiment in GitLab 17.8.

Indicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
true
jobTokenPolicies [CiJobTokenScopePolicies!] Introduced as an experiment in GitLab 17.5.

List of policies added to the CI job token scope. Is ignored if job token policies are disabled.
[]
projectPath ID! Project that the CI job token scope belongs to.
targetPath ID! Group or project to be added to the CI job token scope.

ciJobTokenScopeAddGroupOrProject fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token’s access scope.
ciJobTokenScopeAllowlistEntry CiJobTokenScopeAllowlistEntry Introduced as an experiment in GitLab 17.6.

Allowlist entry for the CI job token’s access scope.
errors [String!]! Errors encountered during the mutation.

ciJobTokenScopeAddProject

Input type: CiJobTokenScopeAddProjectInput

ciJobTokenScopeAddProject arguments

Name Type Description
direction CiJobTokenScopeDirection Deprecated in GitLab 16.0. Outbound job token scope is being removed. This field can now only be set to INBOUND.
projectPath ID! Project that the CI job token scope belongs to.
targetProjectPath ID! Project to be added to the CI job token scope.

ciJobTokenScopeAddProject fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token’s access scope.
ciJobTokenScopeAllowlistEntry CiJobTokenScopeAllowlistEntry Introduced as an experiment in GitLab 17.6.

Allowlist entry for the CI job token’s access scope.
errors [String!]! Errors encountered during the mutation.

ciJobTokenScopeRemoveGroup

Input type: CiJobTokenScopeRemoveGroupInput

ciJobTokenScopeRemoveGroup arguments

Name Type Description
projectPath ID! Project that the CI job token scope belongs to.
targetGroupPath ID! Group to be removed from the CI job token scope.

ciJobTokenScopeRemoveGroup fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token’s access scope.
ciJobTokenScopeAllowlistEntry CiJobTokenScopeAllowlistEntry Introduced as an experiment in GitLab 17.6.

Allowlist entry for the CI job token’s access scope.
errors [String!]! Errors encountered during the mutation.

ciJobTokenScopeRemoveProject

Input type: CiJobTokenScopeRemoveProjectInput

ciJobTokenScopeRemoveProject arguments

Name Type Description
direction CiJobTokenScopeDirection Deprecated in GitLab 16.9. Outbound job token scope is being removed. This field can now only be set to INBOUND.
projectPath ID! Project that the CI job token scope belongs to.
targetProjectPath ID! Project to be removed from the CI job token scope.

ciJobTokenScopeRemoveProject fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token’s access scope.
ciJobTokenScopeAllowlistEntry CiJobTokenScopeAllowlistEntry Introduced as an experiment in GitLab 17.6.

Allowlist entry for the CI job token’s access scope.
errors [String!]! Errors encountered during the mutation.

ciJobTokenScopeUpdatePolicies

  • Status: Experiment

Input type: CiJobTokenScopeUpdatePoliciesInput

ciJobTokenScopeUpdatePolicies arguments

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

ciJobTokenScopeUpdatePolicies fields

Name Type Description
ciJobTokenScopeAllowlistEntry CiJobTokenScopeAllowlistEntry Introduced as an experiment in GitLab 17.6.

Allowlist entry for the CI job token’s access scope. Null when resetting to default permissions removes the current project’s entry.
errors [String!]! Errors encountered during the mutation.

ciLint

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

Input type: CiLintInput

ciLint arguments

Name Type Description
content String! Contents of .gitlab-ci.yml.
dryRun Boolean Run pipeline creation simulation, or only do static check.
projectPath ID! Project of the CI config.
ref String Ref to use when linting. Default is the project default branch.

ciLint fields

Name Type Description
config CiConfigV2 Linted CI config and metadata.
errors [String!]! Errors encountered during the mutation.

clusterAgentDelete

Input type: ClusterAgentDeleteInput

clusterAgentDelete arguments

Name Type Description
id ClustersAgentID! Global ID of the cluster agent that will be deleted.

clusterAgentDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

clusterAgentTokenCreate

Input type: ClusterAgentTokenCreateInput

clusterAgentTokenCreate arguments

Name Type Description
clusterAgentId ClustersAgentID! Global ID of the cluster agent that will be associated with the new token.
description String Description of the token.
name String! Name of the token.

clusterAgentTokenCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
secret String Token secret value. Make sure you save it - you won’t be able to access it again.
token ClusterAgentToken Token created after mutation.

clusterAgentTokenRevoke

Input type: ClusterAgentTokenRevokeInput

clusterAgentTokenRevoke arguments

Name Type Description
id ClustersAgentTokenID! Global ID of the agent token that will be revoked.

clusterAgentTokenRevoke fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

clusterAgentUrlConfigurationCreate

Input type: ClusterAgentUrlConfigurationCreateInput

clusterAgentUrlConfigurationCreate arguments

Name Type Description
caCert String Base64-encoded CA certificate in PEM format to verify the agent endpoint.
clientCert String Base64-encoded client certificate in PEM format if mTLS authentication should be used. Must be provided with client_key.
clientKey String Base64-encoded client key in PEM format if mTLS authentication should be used. Must be provided with client_cert.
clusterAgentId ClustersAgentID! Global ID of the cluster agent that will be associated with the new URL configuration.
tlsHost String TLS host name to verify the server name in agent endpoint certificate.
url String! URL for the new URL configuration.

clusterAgentUrlConfigurationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
urlConfiguration ClusterAgentUrlConfiguration URL configuration created after mutation.

clusterAgentUrlConfigurationDelete

Input type: ClusterAgentUrlConfigurationDeleteInput

clusterAgentUrlConfigurationDelete arguments

Name Type Description
id ClustersAgentsUrlConfigurationID! Global ID of the agent URL configuration that will be deleted.

clusterAgentUrlConfigurationDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

commitCreate

Input type: CommitCreateInput

commitCreate arguments

Name Type Description Default
actions [CommitAction!] Array of action hashes to commit as a batch. []
allowEmpty Boolean Indicates whether an empty commit can be created. Defaults to false. false
branch String! Name of the branch to commit into, it can be a new branch.
message String! Raw commit message.
projectPath ID! Project full path the branch is associated with.
startBranch String If on a new branch, name of the original branch.
startProjectPath ID Full path of the project to start the commit from. Must be the project itself or a project it was forked from.
startSha String SHA of the commit to start the new branch from. Mutually exclusive with startBranch.

commitCreate fields

Name Type Description
commit Commit Commit after mutation.
commitPipelinePath String ETag path for the commit’s pipeline.
content [String!] Contents of the commit.
errors [String!]! Errors encountered during the mutation.

configureContainerScanning

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

Input type: ConfigureContainerScanningInput

configureContainerScanning arguments

Name Type Description
projectPath ID! Full path of the project.

configureContainerScanning fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
errors [String!]! Errors encountered during the mutation.
successPath String Redirect path to use when the response is successful.

configureDependencyScanning

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

Input type: ConfigureDependencyScanningInput

configureDependencyScanning arguments

Name Type Description
projectPath ID! Full path of the project.

configureDependencyScanning fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
errors [String!]! Errors encountered during the mutation.
successPath String Redirect path to use when the response is successful.

configureSast

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

Input type: ConfigureSastInput

configureSast arguments

Name Type Description
configuration SastCiConfigurationInput! SAST CI configuration for the project.
projectPath ID! Full path of the project.

configureSast fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
errors [String!]! Errors encountered during the mutation.
successPath String Redirect path to use when the response is successful.

configureSastIac

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

Input type: ConfigureSastIacInput

configureSastIac arguments

Name Type Description
projectPath ID! Full path of the project.

configureSastIac fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
errors [String!]! Errors encountered during the mutation.
successPath String Redirect path to use when the response is successful.

configureSecretDetection

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

Input type: ConfigureSecretDetectionInput

configureSecretDetection arguments

Name Type Description
projectPath ID! Full path of the project.

configureSecretDetection fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
errors [String!]! Errors encountered during the mutation.
successPath String Redirect path to use when the response is successful.

containerCacheEntryDelete

  • Status: Experiment

Input type: ContainerCacheEntryDeleteInput

containerCacheEntryDelete arguments

Name Type Description
id String! ID of the cache entry.

containerCacheEntryDelete fields

Name Type Description
cacheEntry ContainerUpstreamCacheEntry Deleted container cache entry.
errors [String!]! Errors encountered during the mutation.

containerUpstreamCacheDelete

  • Status: Experiment

Input type: ContainerUpstreamCacheDeleteInput

containerUpstreamCacheDelete arguments

Name Type Description
id VirtualRegistriesContainerUpstreamID! ID of the container virtual registry upstream.

containerUpstreamCacheDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upstream ContainerUpstream Container virtual registry upstream.

containerUpstreamCreate

  • Status: Experiment

Input type: ContainerUpstreamCreateInput

containerUpstreamCreate arguments

Name Type Description Default
cacheValidityHours Int Cache validity period. Defaults to 24 hours. 24
description String Description of the upstream registry.
id VirtualRegistriesContainerRegistryID! ID of the upstream registry.
name String! Name of upstream registry.
password String Password of the upstream registry.
url String! URL of the upstream registry.
username String Username of the upstream registry.

containerUpstreamCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upstream ContainerUpstreamDetails Container upstream after the mutation.

containerUpstreamDelete

  • Status: Experiment

Input type: ContainerUpstreamDeleteInput

containerUpstreamDelete arguments

Name Type Description
id VirtualRegistriesContainerUpstreamID! ID of the upstream to be deleted.

containerUpstreamDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upstream ContainerUpstreamDetails Destroyed upstream.

containerUpstreamTest

  • Status: Experiment

Input type: ContainerUpstreamTestInput

containerUpstreamTest arguments

Name Type Description
groupPath ID Full path of the group to test the upstream registry against. Required when id is not provided.
id VirtualRegistriesContainerUpstreamID ID of the upstream registry to test. When provided, groupPath, url, username, and password are ignored.
password String Password for authenticating with the upstream registry. Used when id is not provided.
url String URL of the upstream registry to test. Required when GraphqlExplorerControllerid is not provided.
username String Username for authenticating with the upstream registry. Used when id is not provided.

containerUpstreamTest fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
success Boolean! Whether the upstream connectivity test was successful.

containerUpstreamUpdate

  • Status: Experiment

Input type: ContainerUpstreamUpdateInput

containerUpstreamUpdate arguments

Name Type Description
cacheValidityHours Int Cache validity period.
description String Description of the upstream registry.
id VirtualRegistriesContainerUpstreamID! ID of the container virtual registry upstream.
name String Name of upstream registry.
password String Password of the upstream registry.
url String URL of the upstream registry.
username String Username of the upstream registry.

containerUpstreamUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upstream ContainerUpstreamDetails Container upstream after the mutation.

containerVirtualRegistryCacheDelete

  • Status: Experiment

Input type: ContainerVirtualRegistryCacheDeleteInput

containerVirtualRegistryCacheDelete arguments

Name Type Description
id VirtualRegistriesContainerRegistryID! ID of the container virtual registry.

containerVirtualRegistryCacheDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry ContainerRegistry Container virtual registry.

containerVirtualRegistryCreate

  • Status: Experiment

Input type: ContainerVirtualRegistryCreateInput

containerVirtualRegistryCreate arguments

Name Type Description
description String Description of the virtual registry.
groupPath ID Full path of the group with which the resource is associated.
name String! Name of virtual registry.

containerVirtualRegistryCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry ContainerRegistry Container virtual registry after the mutation.

containerVirtualRegistryDelete

  • Status: Experiment

Input type: ContainerVirtualRegistryDeleteInput

containerVirtualRegistryDelete arguments

Name Type Description
id VirtualRegistriesContainerRegistryID! ID of the container virtual registry to be deleted.

containerVirtualRegistryDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry ContainerRegistry Deleted container virtual registry.

containerVirtualRegistryUpdate

  • Status: Experiment

Input type: ContainerVirtualRegistryUpdateInput

containerVirtualRegistryUpdate arguments

Name Type Description
description String Description of the virtual registry.
id VirtualRegistriesContainerRegistryID! ID of the container virtual registry to be updated.
name String Name of virtual registry.

containerVirtualRegistryUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry ContainerRegistry Container virtual registry after the mutation.

containerVirtualRegistryUpstreamCreate

  • Status: Experiment

Input type: ContainerVirtualRegistryUpstreamCreateInput

containerVirtualRegistryUpstreamCreate arguments

Name Type Description
registryId VirtualRegistriesContainerRegistryID! ID of the container virtual registry.
upstreamId VirtualRegistriesContainerUpstreamID! ID of the upstream.

containerVirtualRegistryUpstreamCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registryUpstream ContainerRegistryUpstreamWithRegistry Container registry upstream after association.

containerVirtualRegistryUpstreamDelete

  • Status: Experiment

Input type: ContainerVirtualRegistryUpstreamDeleteInput

containerVirtualRegistryUpstreamDelete arguments

Name Type Description
upstreamId VirtualRegistriesContainerRegistryUpstreamID! ID of the container virtual registry upstream.

containerVirtualRegistryUpstreamDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registryUpstream ContainerRegistryUpstreamWithRegistry Deleted container registry upstream.

containerVirtualRegistryUpstreamUpdate

  • Status: Experiment

Input type: ContainerVirtualRegistryUpstreamUpdateInput

containerVirtualRegistryUpstreamUpdate arguments

Name Type Description
id VirtualRegistriesContainerRegistryUpstreamID! ID of the container virtual registry upstream.
position Int! Priority order of an upstream within a virtual registry.

containerVirtualRegistryUpstreamUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registryUpstream ContainerRegistryUpstreamWithRegistry Container registry upstream after update.

corpusCreate

Input type: CorpusCreateInput

corpusCreate arguments

Name Type Description
fullPath ID! Project the corpus belongs to.
packageId PackagesPackageID! ID of the corpus package.

corpusCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

createAlertIssue

Input type: CreateAlertIssueInput

createAlertIssue arguments

Name Type Description
iid String! IID of the alert to mutate.
projectPath ID! Project the alert to mutate is in.

createAlertIssue fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
errors [String!]! Errors encountered during the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

createAnnotation

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

Input type: CreateAnnotationInput

createAnnotation arguments

Name Type Description
clusterId ClustersClusterID Global ID of the cluster to add an annotation to.
dashboardPath String! Path to a file defining the dashboard on which the annotation should be added.
description String! Description of the annotation.
endingAt Time Timestamp indicating ending moment to which the annotation relates.
environmentId EnvironmentID Global ID of the environment to add an annotation to.
startingAt Time! Timestamp indicating starting moment to which the annotation relates.

createAnnotation fields

Name Type Description
annotation MetricsDashboardAnnotation Created annotation.
errors [String!]! Errors encountered during the mutation.

createBoard

Input type: CreateBoardInput

createBoard arguments

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

createBoard fields

Name Type Description
board Board Board after mutation.
errors [String!]! Errors encountered during the mutation.

createBranch

Input type: CreateBranchInput

createBranch arguments

Name Type Description
name String! Name of the branch.
projectPath ID! Project full path the branch is associated with.
ref String! Branch name or commit SHA to create branch from.

createBranch fields

Name Type Description
branch Branch Branch after mutation.
errors [String!]! Errors encountered during the mutation.

createClusterAgent

Input type: CreateClusterAgentInput

createClusterAgent arguments

Name Type Description
name String! Name of the cluster agent.
projectPath ID! Full path of the associated project for the cluster agent.

createClusterAgent fields

Name Type Description
clusterAgent ClusterAgent Cluster agent created after mutation.
errors [String!]! Errors encountered during the mutation.

createComplianceFramework

Input type: CreateComplianceFrameworkInput

createComplianceFramework arguments

Name Type Description
namespacePath ID! Full path of the namespace to add the compliance framework to.
params ComplianceFrameworkInput! Parameters to update the compliance framework with.

createComplianceFramework fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
framework ComplianceFramework Created compliance framework.

createComplianceFrameworkFromTemplate

  • Status: Experiment

Input type: CreateComplianceFrameworkFromTemplateInput

createComplianceFrameworkFromTemplate arguments

Name Type Description
color String Override the color of the compliance framework in hex format. e.g. #FCA121.
default Boolean Set the compliance framework as the default framework for the group.
description String Override the description of the compliance framework.
name String Override the name of the compliance framework.
namespacePath ID! Full path of the namespace to add the compliance framework to.
templateId ComplianceManagementFrameworksTemplateRegistryTemplateID! Unique identifier of the template to create the framework from.

createComplianceFrameworkFromTemplate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
framework ComplianceFramework Created compliance framework.

createComplianceRequirement

  • Status: Experiment

Input type: CreateComplianceRequirementInput

createComplianceRequirement arguments

Name Type Description
complianceFrameworkId ComplianceManagementFrameworkID! Global ID of the compliance framework of the new requirement.
controls [ComplianceRequirementsControlInput!] Controls to add to the compliance requirement.
params ComplianceRequirementInput! Parameters to update the compliance requirement with.

createComplianceRequirement fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
requirement ComplianceRequirement Created compliance requirement.

createComplianceRequirementsControl

  • Status: Experiment

Input type: CreateComplianceRequirementsControlInput

createComplianceRequirementsControl arguments

Name Type Description
complianceRequirementId ComplianceManagementComplianceFrameworkComplianceRequirementID! Global ID of the compliance requirement of the new control.
params ComplianceRequirementsControlInput! Parameters to create the compliance requirement control.

createComplianceRequirementsControl fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
requirementsControl ComplianceRequirementsControl Created compliance requirements control.

createContainerProtectionRepositoryRule

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

Input type: CreateContainerProtectionRepositoryRuleInput

createContainerProtectionRepositoryRule arguments

Name Type Description
minimumAccessLevelForDelete ContainerProtectionRepositoryRuleAccessLevel Introduced as an experiment in GitLab 17.11.

Minimum GitLab access level required to delete container images from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER. Valid only when feature flag container_registry_protected_containers_delete is enabled.
minimumAccessLevelForPush ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
projectPath ID! Full path of the project where a protection rule is located.
repositoryPathPattern String! Container repository path pattern protected by the protection rule. Must start with the project’s full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project’s full path.

createContainerProtectionRepositoryRule fields

Name Type Description
containerProtectionRepositoryRule ContainerProtectionRepositoryRule Container repository protection rule after mutation.
errors [String!]! Errors encountered during the mutation.

createContainerProtectionTagRule

  • Status: Experiment

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

Input type: createContainerProtectionTagRuleInput

createContainerProtectionTagRule arguments

Name Type Description
minimumAccessLevelForDelete ContainerProtectionTagRuleAccessLevel Minimum 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.
minimumAccessLevelForPush ContainerProtectionTagRuleAccessLevel Minimum 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.
projectPath ID! Full path of the project containing the container image tags.
tagNamePattern String! The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.

createContainerProtectionTagRule fields

Name Type Description
containerProtectionTagRule ContainerProtectionTagRule Protection rule for container image tags after creation.
errors [String!]! Errors encountered during the mutation.

createCustomDashboard

  • Status: Experiment

Creates a custom dashboard in an organization.

Input type: CreateCustomDashboardInput

createCustomDashboard arguments

Name Type Description
config JSON! Dashboard config, validated against the analytics dashboard JSON schema.
description String Deprecated in GitLab 19.6. Use config.description.
name String Deprecated in GitLab 19.6. Use config.title.
namespaceId NamespaceID Namespace to scope the dashboard to.
organizationId OrganizationsOrganizationID Organization the dashboard belongs to. Must be the current organization, which is used when not provided.

createCustomDashboard fields

Name Type Description
dashboard CustomDashboard Newly created dashboard.
errors [String!]! Errors encountered during creation.

createCustomEmoji

Input type: CreateCustomEmojiInput

createCustomEmoji arguments

Name Type Description
groupPath ID! Namespace full path the emoji is associated with.
name String! Name of the emoji.
url String! Location of the emoji file.

createCustomEmoji fields

Name Type Description
customEmoji CustomEmoji New custom emoji.
errors [String!]! Errors encountered during the mutation.

createDiffNote

Input type: CreateDiffNoteInput

createDiffNote arguments

Name Type Description
body String! Content of the note.
internal Boolean Internal flag for a note. Default is false.
noteableId NoteableID! Global ID of the resource to add a note to.
position DiffPositionInput! Position of the note on a diff.

createDiffNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

createDiscussion

Input type: CreateDiscussionInput

createDiscussion arguments

Name Type Description
body String! Content of the note.
internal Boolean Internal flag for a note. Default is false.
noteableId NoteableID! Global ID of the resource to add a note to.

createDiscussion fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

createEpic

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

Input type: CreateEpicInput

createEpic 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.
color Color Color of the epic.
confidential Boolean Indicates if the epic is confidential.
description String Description of the epic.
dueDateFixed String End date of the epic.
dueDateIsFixed Boolean Indicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath ID! Group the epic to mutate is in.
removeLabelIds [ID!] IDs of labels to be removed from the epic.
startDateFixed String Start date of the epic.
startDateIsFixed Boolean Indicates start date should be sourced from start_date_fixed field not the issue milestones.
title String Title of the epic.

createEpic fields

Name Type Description
epic Epic Created epic.
errors [String!]! Errors encountered during the mutation.

createFunctionalVerificationWorkflow

  • Status: Experiment

Input type: CreateFunctionalVerificationWorkflowInput

createFunctionalVerificationWorkflow arguments

Name Type Description
checkType FunctionalVerificationCheckType! Type of functional verification check to run.
fullPath ID! Full path of the namespace to run the verification check against.

createFunctionalVerificationWorkflow fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workflowId AiDuoWorkflowsWorkflowID Global ID of the workflow created for the run.

createImageDiffNote

Input type: CreateImageDiffNoteInput

createImageDiffNote arguments

Name Type Description
body String! Content of the note.
internal Boolean Internal flag for a note. Default is false.
noteableId NoteableID! Global ID of the resource to add a note to.
position DiffImagePositionInput! Position of the note on a diff.

createImageDiffNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

createIssue

Input type: CreateIssueInput

createIssue arguments

Name Type Description
assigneeIds [UserID!] Array of user IDs to assign to the issue.
confidential Boolean Indicates the issue is confidential.
createdAt Time Timestamp when the issue was created. Available only for admins and project owners.
description String Description of the issue.
discussionToResolve String ID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of.
dueDate ISO8601Date Due date of the issue.
epicId EpicID Deprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
healthStatus HealthStatus Desired health status.
iid Int IID (internal ID) of a project issue. Only admins and project owners can modify.
iterationCadenceId IterationsCadenceID Global iteration cadence ID. Required when iterationWildcardId is provided.
iterationId IterationID Global iteration ID. Mutually exclusive argument with iterationWildcardId.
iterationWildcardId IssueCreationIterationWildcardId Iteration wildcard ID. Supported values are: CURRENT. Mutually exclusive argument with iterationId. iterationCadenceId also required when this argument is provided.
labelIds [LabelID!] IDs of labels to be added to the issue.
labels [String!] Labels of the issue.
locked Boolean Indicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOf MergeRequestID IID of a merge request for which to resolve discussions.
milestoneId MilestoneID ID of the milestone to assign to the issue. On update milestone will be removed if set to null.
moveAfterId IssueID Global ID of issue that should be placed after the current issue.
moveBeforeId IssueID Global ID of issue that should be placed before the current issue.
projectPath ID! Project full path the issue is associated with.
statusId WorkItemsStatusesStatusID Global ID of the status.
title String! Title of the issue.
type IssueType Type of the issue.
weight Int Weight of the issue.

createIssue fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

createIteration

Deprecated in GitLab 14.0. Use iterationCreate.

Input type: CreateIterationInput

createIteration arguments

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

createIteration fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
iteration Iteration Created iteration.

createLatestDiffNote

  • Status: Experiment

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

Input type: CreateLatestDiffNoteInput

createLatestDiffNote arguments

Name Type Description
body String! Content of the note.
endNewLine Int End 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.
endOldLine Int End 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.
filePath String! Path of the file to comment on. For renamed files, either the old or new path can be used.
headSha String! 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.
internal Boolean Internal flag for a note. Default is false.
newLine Int Line 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.
noteableId MergeRequestID! Global ID of the merge request to add a diff note to.
oldLine Int Line 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.

createLatestDiffNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

createNote

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

Input type: CreateNoteInput

createNote arguments

Name Type Description
body String! Content of the note.
discussionId DiscussionID Global ID of the discussion the note is in reply to.
internal Boolean Internal flag for a note. Default is false.
mergeRequestDiffHeadSha String SHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent.
noteableId NoteableID! Global ID of the resource to add a note to.

createNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

createPackagesProtectionRule

Creates a protection rule to restrict access to project packages.

Input type: CreatePackagesProtectionRuleInput

createPackagesProtectionRule arguments

Name Type Description
minimumAccessLevelForDelete PackagesProtectionRuleAccessLevelForDelete Introduced as an experiment in GitLab 17.10.

Minimum GitLab access required to delete packages from the package registry. Valid values include OWNER or ADMIN. If the value is nil, the default minimum access level is MAINTAINER. Available only when feature flag packages_protected_packages_delete is enabled.
minimumAccessLevelForPush PackagesProtectionRuleAccessLevel Minimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
packageNamePattern String! Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageType PackagesProtectionRulePackageType! Package type protected by the protection rule. For example, NPM, PYPI.
projectPath ID! Full path of the project where a protection rule is located.

createPackagesProtectionRule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
packageProtectionRule PackagesProtectionRule Packages protection rule after mutation.

createRequirement

Input type: CreateRequirementInput

createRequirement arguments

Name Type Description
description String Description of the requirement.
projectPath ID! Full project path the requirement is associated with.
title String Title of the requirement.

createRequirement fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
requirement Requirement Requirement after mutation.

createSnippet

Input type: CreateSnippetInput

createSnippet arguments

Name Type Description
blobActions [SnippetBlobActionInputType!] Actions to perform over the snippet repository and blobs.
description String Description of the snippet.
projectPath ID Full path of the project the snippet is associated with.
title String! Title of the snippet.
uploadedFiles [String!] Paths to files uploaded in the snippet description.
visibilityLevel VisibilityLevelsEnum! Visibility level of the snippet.

createSnippet fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
snippet Snippet Snippet after mutation.

createTerraformStateProtectionRule

  • Status: Experiment

Creates a protection rule for a Terraform state backend.

Input type: CreateTerraformStateProtectionRuleInput

createTerraformStateProtectionRule arguments

Name Type Description Default
allowedFrom TerraformStateProtectionRuleAllowedFrom Introduced as an experiment in GitLab 19.1.

Restriction on the source of write requests. ANYWHERE allows all sources, CI_ONLY requires a CI job token, CI_ON_PROTECTED_BRANCH_ONLY requires a CI job on a protected branch.
ANYWHERE
minimumAccessLevelForWrite TerraformStateProtectionRuleAccessLevel! Minimum GitLab access level required to perform write operations on the Terraform state. Valid values include DEVELOPER, MAINTAINER, OWNER, or ADMIN.
projectPath ID! Full path of the project where the protection rule is located.
stateName String! Terraform state name protected by the rule.

createTerraformStateProtectionRule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
terraformStateProtectionRule TerraformStateProtectionRule Introduced as an experiment in GitLab 19.1.

Terraform state protection rule after mutation.

createTestCase

Input type: CreateTestCaseInput

createTestCase arguments

Name Type Description
confidential Boolean Sets the test case confidentiality.
description String Test case description.
labelIds [ID!] IDs of labels to be added to the test case.
projectPath ID! Project full path to create the test case in.
title String! Test case title.

createTestCase fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
testCase Issue Test case created.

customFieldArchive

  • Status: Experiment

Input type: CustomFieldArchiveInput

customFieldArchive arguments

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

customFieldArchive fields

Name Type Description
customField CustomField Archived custom field.
errors [String!]! Errors encountered during the mutation.

customFieldCreate

  • Status: Experiment

Input type: CustomFieldCreateInput

customFieldCreate arguments

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

customFieldCreate fields

Name Type Description
customField CustomField Created custom field.
errors [String!]! Errors encountered during the mutation.

customFieldUnarchive

  • Status: Experiment

Input type: CustomFieldUnarchiveInput

customFieldUnarchive arguments

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

customFieldUnarchive fields

Name Type Description
customField CustomField Unarchived custom field.
errors [String!]! Errors encountered during the mutation.

customFieldUpdate

  • Status: Experiment

Input type: CustomFieldUpdateInput

customFieldUpdate arguments

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

customFieldUpdate fields

Name Type Description
customField CustomField Updated custom field.
errors [String!]! Errors encountered during the mutation.

customerRelationsContactCreate

Input type: CustomerRelationsContactCreateInput

customerRelationsContactCreate arguments

Name Type Description
description String Description of or notes for the contact.
email String Email address of the contact.
firstName String! First name of the contact.
groupId GroupID! Group for the contact.
lastName String! Last name of the contact.
organizationId CustomerRelationsOrganizationID Organization for the contact.
phone String Phone number of the contact.

customerRelationsContactCreate fields

Name Type Description
contact CustomerRelationsContact Contact after the mutation.
errors [String!]! Errors encountered during the mutation.

customerRelationsContactUpdate

Input type: CustomerRelationsContactUpdateInput

customerRelationsContactUpdate arguments

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

customerRelationsContactUpdate fields

Name Type Description
contact CustomerRelationsContact Contact after the mutation.
errors [String!]! Errors encountered during the mutation.

customerRelationsOrganizationCreate

Input type: CustomerRelationsOrganizationCreateInput

customerRelationsOrganizationCreate arguments

Name Type Description
defaultRate Float Standard billing rate for the organization.
description String Description of or notes for the organization.
groupId GroupID! Group for the organization.
name String! Name of the organization.

customerRelationsOrganizationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organization CustomerRelationsOrganization Organization after the mutation.

customerRelationsOrganizationUpdate

Input type: CustomerRelationsOrganizationUpdateInput

customerRelationsOrganizationUpdate arguments

Name Type Description
active Boolean State of the organization.
defaultRate Float Standard billing rate for the organization.
description String Description of or notes for the organization.
id CustomerRelationsOrganizationID! Global ID of the organization.
name String Name of the organization.

customerRelationsOrganizationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organization CustomerRelationsOrganization! Organization after the mutation.

dastOnDemandScanCreate

Input type: DastOnDemandScanCreateInput

dastOnDemandScanCreate arguments

Name Type Description
dastScannerProfileId DastScannerProfileID ID of the scanner profile to be used for the scan.
dastSiteProfileId DastSiteProfileID! ID of the site profile to be used for the scan.
fullPath ID! Project the site profile belongs to.

dastOnDemandScanCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipelineUrl String URL of the pipeline that was created.

dastProfileCreate

Input type: DastProfileCreateInput

dastProfileCreate arguments

Name Type Description Default
branchName String Associated branch.
dastProfileSchedule DastProfileScheduleInput Represents a DAST Profile Schedule.
dastScannerProfileId DastScannerProfileID! ID of the scanner profile to be associated.
dastSiteProfileId DastSiteProfileID! ID of the site profile to be associated.
description String Description of the profile. Defaults to an empty string. ""
fullPath ID! Project the profile belongs to.
name String! Name of the profile.
runAfterCreate Boolean Run scan using profile after creation. Defaults to false. false
tagList [String!] Indicates the runner tags associated with the profile.

dastProfileCreate fields

Name Type Description
dastProfile DastProfile Created profile.
errors [String!]! Errors encountered during the mutation.
pipelineUrl String URL of the pipeline that was created. Requires runAfterCreate to be set to true.

dastProfileDelete

Input type: DastProfileDeleteInput

dastProfileDelete arguments

Name Type Description
id DastProfileID! ID of the profile to be deleted.

dastProfileDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

dastProfileRun

Input type: DastProfileRunInput

dastProfileRun arguments

Name Type Description
fullPath ID Deprecated in GitLab 14.5. Full path not required to qualify Global ID.
id DastProfileID! ID of the profile to be used for the scan.

dastProfileRun fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipelineUrl String URL of the pipeline that was created.

dastProfileUpdate

Input type: DastProfileUpdateInput

dastProfileUpdate arguments

Name Type Description Default
branchName String Associated branch.
dastProfileSchedule DastProfileScheduleInput Represents a DAST profile schedule.
dastScannerProfileId DastScannerProfileID ID of the scanner profile to be associated.
dastSiteProfileId DastSiteProfileID ID of the site profile to be associated.
description String Description of the profile. Defaults to an empty string. ""
fullPath ID Deprecated in GitLab 14.5. Full path not required to qualify Global ID.
id DastProfileID! ID of the profile to be deleted.
name String Name of the profile.
runAfterUpdate Boolean Run scan using profile after update. Defaults to false. false
tagList [String!] Indicates the runner tags associated with the profile.

dastProfileUpdate fields

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

dastScannerProfileCreate

Input type: DastScannerProfileCreateInput

dastScannerProfileCreate arguments

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

dastScannerProfileCreate fields

Name Type Description
dastScannerProfile DastScannerProfile Created scanner profile.
errors [String!]! Errors encountered during the mutation.
id DastScannerProfileID Deprecated in GitLab 14.10. use dastScannerProfile field.

dastScannerProfileDelete

Input type: DastScannerProfileDeleteInput

dastScannerProfileDelete arguments

Name Type Description
fullPath ID Deprecated in GitLab 14.5. Full path not required to qualify Global ID.
id DastScannerProfileID! ID of the scanner profile to be deleted.

dastScannerProfileDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

dastScannerProfileUpdate

Input type: DastScannerProfileUpdateInput

dastScannerProfileUpdate arguments

Name Type Description
fullPath ID Deprecated in GitLab 14.5. Full path not required to qualify Global ID.
id DastScannerProfileID! ID of the scanner profile to be updated.
profileName String! Name of the scanner profile.
scanType DastScanTypeEnum Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages Boolean Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout Int! Maximum number of minutes allowed for the spider to traverse the site.
tagList [String!] Deprecated in GitLab 15.8. Moved to DastProfile.
targetTimeout Int! Maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider Boolean Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

dastScannerProfileUpdate fields

Name Type Description
dastScannerProfile DastScannerProfile Updated scanner profile.
errors [String!]! Errors encountered during the mutation.
id DastScannerProfileID Deprecated in GitLab 14.10. use dastScannerProfile field.

dastSiteProfileCreate

Input type: DastSiteProfileCreateInput

dastSiteProfileCreate arguments

Name Type Description Default
auth DastSiteProfileAuthInput Parameters for authentication.
excludedUrls [String!] URLs to skip during an authenticated scan. Defaults to []. []
fullPath ID! Project the site profile belongs to.
optionalVariables [JSON!] Optional variables that can be configured for DAST scans. []
profileName String! Name of the site profile.
requestHeaders String Comma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath String File Path or URL used as input for the scan method.
scanMethod DastScanMethodType Scan method by the scanner.
targetType DastTargetTypeEnum Type of target to be scanned.
targetUrl String URL of the target to be scanned.

dastSiteProfileCreate fields

Name Type Description
dastSiteProfile DastSiteProfile Site Profile object.
errors [String!]! Errors encountered during the mutation.
id DastSiteProfileID Deprecated in GitLab 14.10. use dastSiteProfile.id field.

dastSiteProfileDelete

Input type: DastSiteProfileDeleteInput

dastSiteProfileDelete arguments

Name Type Description
fullPath ID Deprecated in GitLab 14.5. Full path not required to qualify Global ID.
id DastSiteProfileID! ID of the site profile to be deleted.

dastSiteProfileDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

dastSiteProfileUpdate

Input type: DastSiteProfileUpdateInput

dastSiteProfileUpdate arguments

Name Type Description
auth DastSiteProfileAuthInput Parameters for authentication.
excludedUrls [String!] URLs to skip during an authenticated scan.
fullPath ID Deprecated in GitLab 14.5. Full path not required to qualify Global ID.
id DastSiteProfileID! ID of the site profile to be updated.
optionalVariables [JSON!] Optional variables that can be configured for DAST scans.
profileName String! Name of the site profile.
requestHeaders String Comma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath String File Path or URL used as input for the scan method.
scanMethod DastScanMethodType Scan method by the scanner.
targetType DastTargetTypeEnum Type of target to be scanned.
targetUrl String URL of the target to be scanned.

dastSiteProfileUpdate fields

Name Type Description
dastSiteProfile DastSiteProfile Site profile object.
errors [String!]! Errors encountered during the mutation.
id DastSiteProfileID Deprecated in GitLab 14.10. use dastSiteProfile.id field.

dastSiteTokenCreate

Input type: DastSiteTokenCreateInput

dastSiteTokenCreate arguments

Name Type Description
fullPath ID! Project the site token belongs to.
targetUrl String URL of the target to be validated.

dastSiteTokenCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
id DastSiteTokenID ID of the site token.
status DastSiteProfileValidationStatusEnum Current validation status of the target.
token String Token string.

dastSiteValidationCreate

Input type: DastSiteValidationCreateInput

dastSiteValidationCreate arguments

Name Type Description
dastSiteTokenId DastSiteTokenID! ID of the site token.
fullPath ID! Project the site profile belongs to.
strategy DastSiteValidationStrategyEnum Validation strategy to be used.
validationPath String! Path to be requested during validation.

dastSiteValidationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
id DastSiteValidationID ID of the site validation.
status DastSiteProfileValidationStatusEnum Current validation status.

dastSiteValidationRevoke

Input type: DastSiteValidationRevokeInput

dastSiteValidationRevoke arguments

Name Type Description
fullPath ID! Project the site validation belongs to.
normalizedTargetUrl String! Normalized URL of the target to be revoked.

dastSiteValidationRevoke fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

deleteAnnotation

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

Input type: DeleteAnnotationInput

deleteAnnotation arguments

Name Type Description
id String! Global ID of the annotation to delete.

deleteAnnotation fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

deleteContainerProtectionRepositoryRule

Deletes a container repository protection rule.

Input type: DeleteContainerProtectionRepositoryRuleInput

deleteContainerProtectionRepositoryRule arguments

Name Type Description
id ContainerRegistryProtectionRuleID! Global ID of the container repository protection rule to delete.

deleteContainerProtectionRepositoryRule fields

Name Type Description
containerProtectionRepositoryRule ContainerProtectionRepositoryRule Container repository protection rule that was deleted successfully.
errors [String!]! Errors encountered during the mutation.

deleteContainerProtectionTagRule

  • Status: Experiment

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

Input type: DeleteContainerProtectionTagRuleInput

deleteContainerProtectionTagRule arguments

Name Type Description
id ContainerRegistryProtectionTagRuleID! Global ID of the tag protection rule to delete.

deleteContainerProtectionTagRule fields

Name Type Description
containerProtectionTagRule ContainerProtectionTagRule Deleted protection rule for container image tags.
errors [String!]! Errors encountered during the mutation.

deleteConversationThread

  • Status: Experiment

Input type: DeleteConversationThreadInput

deleteConversationThread arguments

Name Type Description
threadId AiConversationThreadID! Global ID of the thread to delete.

deleteConversationThread fields

Name Type Description
errors [String!]! List of errors that occurred whilst trying to delete the thread.
success Boolean! Returns true if thread was successfully deleted.

deleteCustomDashboard

  • Status: Experiment

Deletes a custom dashboard.

Input type: DeleteCustomDashboardInput

deleteCustomDashboard arguments

Name Type Description
id AnalyticsCustomDashboardsDashboardID! Global ID of the dashboard to delete.

deleteCustomDashboard fields

Name Type Description
dashboard CustomDashboard Deleted dashboard.
errors [String!]! Errors encountered during deletion.

deleteDuoWorkflowsWorkflow

  • Status: Experiment

Input type: DeleteDuoWorkflowsWorkflowInput

deleteDuoWorkflowsWorkflow arguments

Name Type Description
workflowId AiDuoWorkflowsWorkflowID! Global ID of the workflow to delete.

deleteDuoWorkflowsWorkflow fields

Name Type Description
errors [String!]! List of errors that occurred whilst trying to delete the workflow.
success Boolean! Returns true if workflow was successfully deleted.

deleteGroupCustomAttribute

  • Status: Experiment

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

Input type: DeleteGroupCustomAttributeInput

deleteGroupCustomAttribute arguments

Name Type Description
groupPath ID! Full path of the group.
key String! Key of the custom attribute to delete.

deleteGroupCustomAttribute fields

Name Type Description
customAttribute CustomAttribute Deleted custom attribute.
errors [String!]! Errors encountered during the mutation.

deletePackagesProtectionRule

Deletes a protection rule for packages.

Input type: DeletePackagesProtectionRuleInput

deletePackagesProtectionRule arguments

Name Type Description
id PackagesProtectionRuleID! Global ID of the package protection rule to delete.

deletePackagesProtectionRule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
packageProtectionRule PackagesProtectionRule Packages protection rule that was deleted successfully.

deletePagesDeployment

  • Status: Experiment

Deletes a Pages deployment.

Input type: DeletePagesDeploymentInput

deletePagesDeployment arguments

Name Type Description
id PagesDeploymentID! ID of the Pages Deployment.

deletePagesDeployment fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pagesDeployment PagesDeployment! Deleted Pages Deployment.

deleteProjectCustomAttribute

  • Status: Experiment

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

Input type: DeleteProjectCustomAttributeInput

deleteProjectCustomAttribute arguments

Name Type Description
key String! Key of the custom attribute to delete.
projectPath ID! Full path of the project.

deleteProjectCustomAttribute fields

Name Type Description
customAttribute CustomAttribute Deleted custom attribute.
errors [String!]! Errors encountered during the mutation.

deleteTerraformStateProtectionRule

  • Status: Experiment

Deletes a protection rule for a Terraform state backend.

Input type: DeleteTerraformStateProtectionRuleInput

deleteTerraformStateProtectionRule arguments

Name Type Description
id TerraformStateProtectionRuleID! Global ID of the Terraform state protection rule to delete.

deleteTerraformStateProtectionRule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
terraformStateProtectionRule TerraformStateProtectionRule Introduced as an experiment in GitLab 19.1.

Terraform state protection rule that was deleted.

deleteUserCustomAttribute

  • Status: Experiment

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

Input type: DeleteUserCustomAttributeInput

deleteUserCustomAttribute arguments

Name Type Description
key String! Key of the custom attribute to delete.
userId UserID! Global ID of the user.

deleteUserCustomAttribute fields

Name Type Description
customAttribute CustomAttribute Deleted custom attribute.
errors [String!]! Errors encountered during the mutation.

designManagementDelete

Input type: DesignManagementDeleteInput

designManagementDelete arguments

Name Type Description
filenames [String!]! Filenames of the designs to delete.
iid ID! IID of the issue to modify designs for.
projectPath ID! Project where the issue is to upload designs for.

designManagementDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
version DesignVersion New version in which the designs are deleted.

designManagementMove

Input type: DesignManagementMoveInput

designManagementMove arguments

Name Type Description
id DesignManagementDesignID! ID of the design to move.
next DesignManagementDesignID ID of the immediately following design.
previous DesignManagementDesignID ID of the immediately preceding design.

designManagementMove fields

Name Type Description
designCollection DesignCollection Current state of the collection.
errors [String!]! Errors encountered during the mutation.

designManagementUpdate

Input type: DesignManagementUpdateInput

designManagementUpdate arguments

Name Type Description
description String Description of the design.
id DesignManagementDesignID! ID of the design to update.

designManagementUpdate fields

Name Type Description
design Design! Updated design.
errors [String!]! Errors encountered during the mutation.

designManagementUpload

Input type: DesignManagementUploadInput

designManagementUpload arguments

Name Type Description
files [Upload!]! Files to upload.
iid ID! IID of the issue to modify designs for.
projectPath ID! Project where the issue is to upload designs for.

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

destroyBoard

Input type: DestroyBoardInput

destroyBoard arguments

Name Type Description
id BoardID! Global ID of the board to destroy.

destroyBoard fields

Name Type Description
board Board Board after mutation.
errors [String!]! Errors encountered during the mutation.

destroyBoardList

Input type: DestroyBoardListInput

destroyBoardList arguments

Name Type Description
listId ListID! Global ID of the list to destroy. Only label lists are accepted.

destroyBoardList fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
list BoardList List after mutation.

destroyComplianceFramework

Input type: DestroyComplianceFrameworkInput

destroyComplianceFramework arguments

Name Type Description
id ComplianceManagementFrameworkID! Global ID of the compliance framework to destroy.

destroyComplianceFramework fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

destroyComplianceRequirement

  • Status: Experiment

Input type: DestroyComplianceRequirementInput

destroyComplianceRequirement arguments

Name Type Description
id ComplianceManagementComplianceFrameworkComplianceRequirementID! Global ID of the compliance requirement to destroy.

destroyComplianceRequirement fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

destroyComplianceRequirementsControl

  • Status: Experiment

Input type: DestroyComplianceRequirementsControlInput

destroyComplianceRequirementsControl arguments

Name Type Description
id ComplianceManagementComplianceFrameworkComplianceRequirementsControlID! Global ID of the compliance requirement control to destroy.

destroyComplianceRequirementsControl fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

destroyContainerRepository

Input type: DestroyContainerRepositoryInput

destroyContainerRepository arguments

Name Type Description
id ContainerRepositoryID! ID of the container repository.

destroyContainerRepository fields

Name Type Description
containerRepository ContainerRepository! Container repository policy after scheduling the deletion.
errors [String!]! Errors encountered during the mutation.

destroyContainerRepositoryTags

Input type: DestroyContainerRepositoryTagsInput

destroyContainerRepositoryTags arguments

Name Type Description
id ContainerRepositoryID! ID of the container repository.
tagNames [String!]! Container repository tag(s) to delete. Total number can’t be greater than 20.

destroyContainerRepositoryTags fields

Name Type Description
deletedTagNames [String!]! Deleted container repository tags.
errors [String!]! Errors encountered during the mutation.

destroyCustomEmoji

Input type: DestroyCustomEmojiInput

destroyCustomEmoji arguments

Name Type Description
id CustomEmojiID! Global ID of the custom emoji to destroy.

destroyCustomEmoji fields

Name Type Description
customEmoji CustomEmoji Deleted custom emoji.
errors [String!]! Errors encountered during the mutation.

destroyEpicBoard

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: DestroyEpicBoardInput

destroyEpicBoard arguments

Name Type Description
id BoardsEpicBoardID! Global ID of the board to destroy.

destroyEpicBoard fields

Name Type Description
epicBoard EpicBoard Epic board after mutation.
errors [String!]! Errors encountered during the mutation.

destroyNote

Input type: DestroyNoteInput

destroyNote arguments

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

destroyNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

destroyPackage

Input type: DestroyPackageInput

destroyPackage arguments

Name Type Description
id PackagesPackageID! ID of the Package.

destroyPackage fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

destroyPackageFile

Input type: DestroyPackageFileInput

destroyPackageFile arguments

Name Type Description
id PackagesPackageFileID! ID of the Package file.

destroyPackageFile fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

destroyPackageFiles

Input type: DestroyPackageFilesInput

destroyPackageFiles arguments

Name Type Description
ids [PackagesPackageFileID!]! IDs of the Package file.
projectPath ID! Project path where the packages cleanup policy is located.

destroyPackageFiles fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

destroyPackages

Input type: DestroyPackagesInput

destroyPackages arguments

Name Type Description
ids [PackagesPackageID!]! Global IDs of the Packages. Max 100.

destroyPackages fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

destroySnippet

Input type: DestroySnippetInput

destroySnippet arguments

Name Type Description
id SnippetID! Global ID of the snippet to destroy.

destroySnippet fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
snippet Snippet Snippet after mutation.

devfileValidate

  • Status: Experiment

Input type: DevfileValidateInput

devfileValidate arguments

Name Type Description
devfileYaml String! Input devfile.

devfileValidate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
valid Boolean Status whether devfile is valid or not.

disableDevopsAdoptionNamespace

Status: Beta.

Input type: DisableDevopsAdoptionNamespaceInput

disableDevopsAdoptionNamespace arguments

Name Type Description
id [AnalyticsDevopsAdoptionEnabledNamespaceID!]! One or many IDs of the enabled namespaces to disable.

disableDevopsAdoptionNamespace fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

discussionToggleResolve

Toggles the resolved state of a discussion.

Input type: DiscussionToggleResolveInput

discussionToggleResolve arguments

Name Type Description
id DiscussionID! Global ID of the discussion.
resolve Boolean! Will resolve the discussion when true, and unresolve the discussion when false.

discussionToggleResolve fields

Name Type Description
discussion Discussion Discussion after mutation.
errors [String!]! Errors encountered during the mutation.

dismissPolicyViolations

  • Status: Experiment

Dismisses policy violations linked to a merge request.

Input type: DismissPolicyViolationsInput

dismissPolicyViolations arguments

Name Type Description
comment String! Comment explaining the dismissal of the policy violations.
dismissalTypes [DismissalType!]! Type of dismissal for the policy violations.
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.
securityPolicyIds [ID!]! IDs of warn mode policies with violations to dismiss.

dismissPolicyViolations fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

duoSettingsUpdate

  • Status: Experiment

Updates GitLab Duo settings.

Input type: DuoSettingsUpdateInput

duoSettingsUpdate arguments

Name Type Description
aiGatewayTimeoutSeconds Int Timeout for the AI Gateway request.
aiGatewayUrl String URL for the local AI Gateway server.
allowAllUnixSockets Boolean Introduced as an experiment in GitLab 19.0.

Whether to allow all Unix sockets for network access.
allowProjectExtension Boolean Introduced as an experiment in GitLab 19.0.

Whether to allow projects to extend the network access domain allowlist.
duoAgentPlatformServiceUrl String URL for the local Duo Agent Platform service.
duoCliEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates whether GitLab Duo CLI access is enabled.
duoCoreFeaturesEnabled Boolean Indicates whether GitLab Duo Core features are enabled.
includeRecommendedAllowed Boolean Introduced as an experiment in GitLab 19.0.

Whether to include recommended domains in the network access allowlist.
minimumAccessLevelEnableOnProjects AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level for enable on Duo Agent Platform. Ignored if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelExecute AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level for execute on Duo Agent Platform. Ignored if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelExecuteAsync AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level to execute Duo Agent Platform features in CI/CD. Ignored if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelManage AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level for manage on Duo Agent Platform. Ignored if dap_instance_customizable_permissions feature flag is disabled.
requireSandbox Boolean Indicates whether flows that run on GitLab Runner fail when the execution environment sandbox is unavailable, instead of running without it.
selfHostedDuoAgentPlatformServiceSecure Boolean Whether to use secure transport (TLS) for the local Duo Agent Platform service.
webSearchEnabled Boolean Introduced as an experiment in GitLab 19.6.

Indicates whether web search is allowed in GitLab Duo Chat. Applies to GitLab Self-Managed and GitLab Dedicated only.

duoSettingsUpdate fields

Name Type Description
duoSettings DuoSettings! GitLab Duo settings after mutation.
errors [String!]! Errors encountered during the mutation.

duoUserFeedback

  • Status: Experiment

Input type: DuoUserFeedbackInput

duoUserFeedback arguments

Name Type Description
aiMessageId String! ID of the AI Message.
trackingEvent TrackingEventInput Tracking event data.

duoUserFeedback fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

echoCreate

A mutation that does not perform any changes.

This is expected to be used for testing of endpoints, to verify that a user has mutation access.

Input type: EchoCreateInput

echoCreate arguments

Name Type Description
errors [String!] Errors to return to the user.
messages [String!] Messages to return to the user.

echoCreate fields

Name Type Description
echoes [String!] Messages returned to the user.
errors [String!]! Errors encountered during the mutation.

enableDevopsAdoptionNamespace

Status: Beta.

Input type: EnableDevopsAdoptionNamespaceInput

enableDevopsAdoptionNamespace arguments

Name Type Description
displayNamespaceId NamespaceID Display namespace ID.
namespaceId NamespaceID! Namespace ID.

enableDevopsAdoptionNamespace fields

Name Type Description
enabledNamespace DevopsAdoptionEnabledNamespace Enabled namespace after mutation.
errors [String!]! Errors encountered during the mutation.

environmentCreate

Create an environment.

Input type: EnvironmentCreateInput

environmentCreate arguments

Name Type Description
autoStopSetting AutoStopSetting Auto stop setting of the environment.
clusterAgentId ClustersAgentID Cluster agent of the environment.
description String Description of the environment.
externalUrl String External URL of the environment.
fluxResourcePath String Flux resource path of the environment.
kubernetesNamespace String Kubernetes namespace of the environment.
name String! Name of the environment.
projectPath ID! Full path of the project.
tier DeploymentTier Tier of the environment.

environmentCreate fields

Name Type Description
environment Environment Created environment.
errors [String!]! Errors encountered during the mutation.

environmentDelete

Delete an environment. When the environment_delete_in_batches feature flag is enabled, a large environment is deleted over several requests: each request returns an error in errors until the environment is gone, and the rows deleted count toward a per-user rate limit (environment_delete_rows_limit_per_user application setting). Until the rate_limit_environment_delete_rows feature flag is enabled, requests over this limit are logged but not blocked.

Input type: EnvironmentDeleteInput

environmentDelete arguments

Name Type Description
id EnvironmentID! Global ID of the environment to Delete.

environmentDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

environmentStop

Stop an environment.

Input type: EnvironmentStopInput

environmentStop arguments

Name Type Description
force Boolean Force environment to stop without executing on_stop actions.
id EnvironmentID! Global ID of the environment to stop.

environmentStop fields

Name Type Description
environment Environment Environment after attempt to stop.
errors [String!]! Errors encountered during the mutation.

environmentUpdate

Update an environment.

Input type: EnvironmentUpdateInput

environmentUpdate arguments

Name Type Description
autoStopSetting AutoStopSetting Auto stop setting of the environment.
clusterAgentId ClustersAgentID Cluster agent of the environment.
description String Description of the environment.
externalUrl String External URL of the environment.
fluxResourcePath String Flux resource path of the environment.
id EnvironmentID! Global ID of the environment to update.
kubernetesNamespace String Kubernetes namespace of the environment.
tier DeploymentTier Tier of the environment.

environmentUpdate fields

Name Type Description
environment Environment Environment after attempt to update.
errors [String!]! Errors encountered during the mutation.

environmentsCanaryIngressUpdate

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

Input type: EnvironmentsCanaryIngressUpdateInput

environmentsCanaryIngressUpdate arguments

Name Type Description
id EnvironmentID! Global ID of the environment to update.
weight Int! Weight of the Canary Ingress.

environmentsCanaryIngressUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

epicAddIssue

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

Input type: EpicAddIssueInput

epicAddIssue arguments

Name Type Description
groupPath ID! Group the epic to mutate belongs to.
iid ID! IID of the epic to mutate.
issueIid String! IID of the issue to be added.
projectPath ID! Full path of the project the issue belongs to.

epicAddIssue fields

Name Type Description
epic Epic Epic after mutation.
epicIssue EpicIssue Epic-issue relationship.
errors [String!]! Errors encountered during the mutation.

epicBoardCreate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicBoardCreateInput

epicBoardCreate arguments

Name Type Description
displayColors Boolean Whether or not display epic colors.
groupPath ID Full path of the group with which the resource is associated.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
name String Board name.

epicBoardCreate fields

Name Type Description
epicBoard EpicBoard Created epic board.
errors [String!]! Errors encountered during the mutation.

epicBoardListCreate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicBoardListCreateInput

epicBoardListCreate arguments

Name Type Description
backlog Boolean Create the backlog list.
boardId BoardsEpicBoardID! Global ID of the issue board to mutate.
labelId LabelID Global ID of an existing label.

epicBoardListCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
list EpicList Epic list in the epic board.

epicBoardListDestroy

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicBoardListDestroyInput

epicBoardListDestroy arguments

Name Type Description
listId BoardsEpicListID! Global ID of the epic board list to destroy.

epicBoardListDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
list EpicList Epic board list. null if the board was destroyed successfully.

epicBoardUpdate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicBoardUpdateInput

epicBoardUpdate arguments

Name Type Description
displayColors Boolean Whether or not display epic colors.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
id BoardsEpicBoardID! Epic board global ID.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
name String Board name.

epicBoardUpdate fields

Name Type Description
epicBoard EpicBoard Updated epic board.
errors [String!]! Errors encountered during the mutation.

epicMoveList

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicMoveListInput

epicMoveList arguments

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

epicMoveList fields

Name Type Description
epic Epic Epic after mutation.
errors [String!]! Errors encountered during the mutation.

epicSetSubscription

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

Input type: EpicSetSubscriptionInput

epicSetSubscription arguments

Name Type Description
groupPath ID! Group the epic to mutate belongs to.
iid ID! IID of the epic to mutate.
subscribedState Boolean! Desired state of the subscription.

epicSetSubscription fields

Name Type Description
epic Epic Epic after mutation.
errors [String!]! Errors encountered during the mutation.

epicTreeReorder

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicTreeReorderInput

epicTreeReorder arguments

Name Type Description
baseEpicId EpicID! ID of the base epic of the tree.
moved EpicTreeNodeFieldsInputType! Parameters for updating the tree positions.

epicTreeReorder fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

escalationPolicyCreate

Input type: EscalationPolicyCreateInput

escalationPolicyCreate arguments

Name Type Description
description String Description of the escalation policy.
name String! Name of the escalation policy.
projectPath ID! Project to create the escalation policy for.
rules [EscalationRuleInput!]! Steps of the escalation policy.

escalationPolicyCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

escalationPolicyDestroy

Input type: EscalationPolicyDestroyInput

escalationPolicyDestroy arguments

Name Type Description
id IncidentManagementEscalationPolicyID! Escalation policy internal ID to remove.

escalationPolicyDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

escalationPolicyUpdate

Input type: EscalationPolicyUpdateInput

escalationPolicyUpdate arguments

Name Type Description
description String Description of the escalation policy.
id IncidentManagementEscalationPolicyID! ID of the on-call schedule to create the on-call rotation in.
name String Name of the escalation policy.
rules [EscalationRuleInput!] Steps of the escalation policy.

escalationPolicyUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

exportRequirements

Input type: ExportRequirementsInput

exportRequirements arguments

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

exportRequirements fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

externalAuditEventDestinationCreate

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsCreate instead.

Input type: ExternalAuditEventDestinationCreateInput

externalAuditEventDestinationCreate arguments

Name Type Description
destinationUrl String! Destination URL.
groupPath ID! Group path.
name String Destination name.
verificationToken String Verification token.

externalAuditEventDestinationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalAuditEventDestination ExternalAuditEventDestination Destination created.

externalAuditEventDestinationDestroy

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.

Input type: ExternalAuditEventDestinationDestroyInput

externalAuditEventDestinationDestroy arguments

Name Type Description
id AuditEventsExternalAuditEventDestinationID! ID of external audit event destination to destroy.

externalAuditEventDestinationDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

externalAuditEventDestinationUpdate

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: ExternalAuditEventDestinationUpdateInput

externalAuditEventDestinationUpdate arguments

Name Type Description
active Boolean Active status of the destination.
destinationUrl String Destination URL to change.
id AuditEventsExternalAuditEventDestinationID! ID of external audit event destination to update.
name String Destination name.

externalAuditEventDestinationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalAuditEventDestination ExternalAuditEventDestination Updated destination.

geoRegistriesBulkUpdate

  • Status: Experiment

Mutates multiple Geo registries for a given registry class.

Input type: GeoRegistriesBulkUpdateInput

geoRegistriesBulkUpdate arguments

Name Type Description
action GeoRegistriesBulkAction! Action to be executed on Geo registries.
ids [GeoBaseRegistryID!] Execute the action on registries selected by their ID.
registryClass GeoRegistryClass! Class of the Geo registries to be updated.
replicationState ReplicationStateEnum Execute the action on registries selected by their replication state.
verificationState VerificationStateEnum Execute the action on registries selected by their verification state.

geoRegistriesBulkUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registryClass GeoRegistryClass Updated Geo registry class.

geoRegistriesUpdate

  • Status: Experiment

Mutates a Geo registry.

Input type: GeoRegistriesUpdateInput

geoRegistriesUpdate arguments

Name Type Description
action GeoRegistryAction! Action to be executed on a Geo registry.
registryId GeoBaseRegistryID! ID of the Geo registry entry to be updated.

geoRegistriesUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry Registrable Updated Geo registry entry.

gitlabSubscriptionActivate

Input type: GitlabSubscriptionActivateInput

gitlabSubscriptionActivate arguments

Name Type Description
activationCode String! Activation code received after purchasing a GitLab subscription.

gitlabSubscriptionActivate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
futureSubscriptions [SubscriptionFutureEntry!] Array of future subscriptions.
license CurrentLicense Current license.

googleCloudLoggingConfigurationCreate

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

Input type: GoogleCloudLoggingConfigurationCreateInput

googleCloudLoggingConfigurationCreate arguments

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

googleCloudLoggingConfigurationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
googleCloudLoggingConfiguration GoogleCloudLoggingConfigurationType configuration created.

googleCloudLoggingConfigurationDestroy

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.

Input type: GoogleCloudLoggingConfigurationDestroyInput

googleCloudLoggingConfigurationDestroy arguments

Name Type Description
id AuditEventsGoogleCloudLoggingConfigurationID! ID of the Google Cloud logging configuration to destroy.

googleCloudLoggingConfigurationDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

googleCloudLoggingConfigurationUpdate

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: GoogleCloudLoggingConfigurationUpdateInput

googleCloudLoggingConfigurationUpdate arguments

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

googleCloudLoggingConfigurationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
googleCloudLoggingConfiguration GoogleCloudLoggingConfigurationType configuration updated.

governPolicyCreate

  • Status: Experiment

Creates a policy in the policy store for an organization or group.

Input type: GovernPolicyCreateInput

governPolicyCreate arguments

Name Type Description
actions [JSON!] Actions the policy takes. No more than 1000 actions.
description String Description of the policy.
groupPath ID Full path of the group whose policy store to use. Exactly one of organizationId or groupPath is required.
lifecycleState String Lifecycle state of the policy.
mode String Enforcement mode of the policy.
name String! Name of the policy.
organizationId OrganizationsOrganizationID Global ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required.
policyScope JSON Authored scope of the policy. Mutually exclusive with scopeRego.
rules [JSON!]! Rules of the policy, at least one. No more than 1000 rules.
scopeRego String Rego expression scoping the policy. Mutually exclusive with policyScope.
triggerType String! Trigger the policy responds to.

governPolicyCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
policy GovernPolicy Policy created in the policy store.

governPolicyDelete

  • Status: Experiment

Deletes a policy from the policy store for an organization or group.

Input type: GovernPolicyDeleteInput

governPolicyDelete arguments

Name Type Description
groupPath ID Full path of the group whose policy store to use. Exactly one of organizationId or groupPath is required.
id Int! ID of the policy to delete.
organizationId OrganizationsOrganizationID Global ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required.

governPolicyDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

governPolicyUpdate

  • Status: Experiment

Updates 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

governPolicyUpdate arguments

Name Type Description
actions [JSON!] Actions the policy takes. No more than 1000 actions.
description String Description of the policy.
groupPath ID Full path of the group whose policy store to use. Exactly one of organizationId or groupPath is required.
lifecycleState String Lifecycle state of the policy.
mode String Enforcement mode of the policy.
name String Name of the policy.
organizationId OrganizationsOrganizationID Global ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required.
policyId Int! ID of the policy.
policyScope JSON Authored scope of the policy. Mutually exclusive with scopeRego.
rules [JSON!] Rules of the policy, at least one when supplied. No more than 1000 rules.
scopeRego String Rego expression scoping the policy. Mutually exclusive with policyScope.
triggerType String Trigger the policy responds to.

governPolicyUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
policy GovernPolicy Policy updated in the policy store.

groupAuditEventStreamingDestinationsCreate

  • Status: Experiment

Input type: GroupAuditEventStreamingDestinationsCreateInput

groupAuditEventStreamingDestinationsCreate arguments

Name Type Description
category String! Destination category.
config JSON! Destination config.
groupPath ID! Group path.
name String Destination name.
secretToken String Secret token.

groupAuditEventStreamingDestinationsCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalAuditEventDestination GroupAuditEventStreamingDestination Destination created.

groupAuditEventStreamingDestinationsDelete

  • Status: Experiment

Input type: GroupAuditEventStreamingDestinationsDeleteInput

groupAuditEventStreamingDestinationsDelete arguments

Name Type Description
id AuditEventsGroupExternalStreamingDestinationID! ID of the audit events external streaming destination to delete.

groupAuditEventStreamingDestinationsDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

groupAuditEventStreamingDestinationsUpdate

  • Status: Experiment

Input type: GroupAuditEventStreamingDestinationsUpdateInput

groupAuditEventStreamingDestinationsUpdate arguments

Name Type Description
active Boolean Active status of the destination.
category String Destination category.
config JSON Destination config.
id AuditEventsGroupExternalStreamingDestinationID! ID of external audit event destination to update.
name String Destination name.
secretToken String Secret token.

groupAuditEventStreamingDestinationsUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalAuditEventDestination GroupAuditEventStreamingDestination Updated destination.

groupMemberBulkUpdate

Input type: GroupMemberBulkUpdateInput

groupMemberBulkUpdate arguments

Name Type Description
accessLevel MemberAccessLevel! Access level to update the members to.
expiresAt Time Date and time the membership expires.
groupId GroupID! Global ID of the group.
userIds [UserID!]! Global IDs of the members.

groupMemberBulkUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
groupMembers [GroupMember!] Group members after mutation.
queuedMemberApprovals MemberApprovalConnection List of queued pending members approvals. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

groupMembersExport

  • Status: Experiment

Input type: GroupMembersExportInput

groupMembersExport arguments

Name Type Description
groupId GroupID! Global ID of the group.

groupMembersExport fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
message String Export request result message.

groupSavedReplyCreate

  • Status: Experiment

Input type: GroupSavedReplyCreateInput

groupSavedReplyCreate arguments

Name Type Description
content String! Content of the saved reply.
groupId GroupID! Group for the save reply.
name String! Name of the saved reply.

groupSavedReplyCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply GroupSavedReply Saved reply after mutation.

groupSavedReplyDestroy

  • Status: Experiment

Input type: GroupSavedReplyDestroyInput

groupSavedReplyDestroy arguments

Name Type Description
id GroupsSavedReplyID! Global ID of the group-level saved reply.

groupSavedReplyDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply GroupSavedReply Saved reply after mutation.

groupSavedReplyUpdate

  • Status: Experiment

Input type: GroupSavedReplyUpdateInput

groupSavedReplyUpdate arguments

Name Type Description
content String! Content of the saved reply.
id GroupsSavedReplyID! Global ID of the group-level saved reply.
name String! Name of the saved reply.

groupSavedReplyUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply GroupSavedReply Saved reply after mutation.

groupSecretCreate

Input type: GroupSecretCreateInput

groupSecretCreate arguments

Name Type Description
description String Description of the group secret.
environment String! Environment that can access the secret.
groupPath ID! Group of the secret.
name String! Name of the group secret.
protected Boolean! Whether the secret is only accessible from protected branches.
rotationIntervalDays Int Number of days between rotation reminders for the secret.
secret String! Value of the group secret.

groupSecretCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
groupSecret GroupSecret Group secret.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

groupSecretDelete

Input type: GroupSecretDeleteInput

groupSecretDelete arguments

Name Type Description
groupPath ID! Group of the secret.
name String! Name of the group secret to delete.

groupSecretDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
groupSecret GroupSecret Deleted group secret.

groupSecretUpdate

Input type: GroupSecretUpdateInput

groupSecretUpdate arguments

Name Type Description
description String New description of the group secret.
environment String New environment that can access the secret.
groupPath ID! Group of the secret.
metadataCas Int! This should match the current metadata version of the group secret being updated.
name String! Name of the group secret to update.
protected Boolean Whether the secret is only accessible from protected branches.
rotationIntervalDays Int Number of days between rotation reminders for the secret.
secret String New value of the group secret.

groupSecretUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
groupSecret GroupSecret Updated group secret.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

groupSecretsManagerDeprovision

Input type: GroupSecretsManagerDeprovisionInput

groupSecretsManagerDeprovision arguments

Name Type Description
groupPath ID! Group of the secrets manager.

groupSecretsManagerDeprovision fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
groupSecretsManager GroupSecretsManager Group secrets manager.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

groupSecretsManagerInitialize

Input type: GroupSecretsManagerInitializeInput

groupSecretsManagerInitialize arguments

Name Type Description
groupPath ID! Group of the secrets manager.

groupSecretsManagerInitialize fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
groupSecretsManager GroupSecretsManager Group secrets manager.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

groupSecretsPermissionDelete

Input type: GroupSecretsPermissionDeleteInput

groupSecretsPermissionDelete arguments

Name Type Description
groupPath ID! Group permissions for the secret.
principal PrincipalInput! Whose permission to be deleted.

groupSecretsPermissionDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.
secretsPermission GroupSecretsPermission Deleted Secrets Permission.

groupSecretsPermissionUpdate

Input type: GroupSecretsPermissionUpdateInput

groupSecretsPermissionUpdate arguments

Name Type Description
actions [SecretsManagementAction!]! Actions that can be performed on secrets.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
groupPath ID! Group to which the permissions are added.
principal PrincipalInput! User/MemberRole/Role that is provided access.

groupSecretsPermissionUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.
secretsPermission GroupSecretsPermission Secrets Permission that was created.

groupTransfer

  • Status: Experiment

Input type: GroupTransferInput

groupTransfer arguments

Name Type Description
id GroupID! Global ID of the group to transfer.
targetId GroupID Global ID of the target parent group. Omit to make group top-level.

groupTransfer fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
group Group Group after mutation.

groupUpdate

Input type: GroupUpdateInput

groupUpdate arguments

Name Type Description
aiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events are stored for the group.
builtInProjectTemplatesEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates whether built-in project templates are available for new projects in the group.
duoAutoModeEnabled Boolean Introduced as an experiment in GitLab 19.5.

Indicates whether Duo Agent Platform auto mode is enabled for the group.
duoFeaturesEnabled Boolean Introduced as an experiment in GitLab 16.10.

Indicates whether GitLab Duo features are enabled for the group.
fullPath ID! Full path of the group that will be updated.
lockAiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events storage is enforced for all subgroups and projects.
lockBuiltInProjectTemplatesEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates if the built-in project templates enabled setting is enforced for all subgroups.
lockDuoAutoModeEnabled Boolean Introduced as an experiment in GitLab 19.5.

Indicates if the Duo Agent Platform auto mode setting is enforced for all subgroups.
lockDuoFeaturesEnabled Boolean Introduced as an experiment in GitLab 16.10.

Indicates if the GitLab Duo features enabled setting is enforced for all subgroups.
lockMathRenderingLimitsEnabled Boolean Indicates if math rendering limits are locked for all descendant groups.
lockToolApprovalForSessionEnabled Boolean Introduced as an experiment in GitLab 18.11.

Indicates if the tool approval for session setting is enforced for all subgroups.
mathRenderingLimitsEnabled Boolean Indicates if math rendering limits are used for the group.
name String Name of the group.
path String Path of the namespace.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.
stepUpAuthRequiredOauthProvider String OAuth provider required for step-up authentication.
toolApprovalForSessionEnabled Boolean Introduced as an experiment in GitLab 18.11.

Indicates whether tool approval for session is enabled for the group.
visibility VisibilityLevelsEnum Visibility of the namespace.
webBasedCommitSigningEnabled Boolean Introduced as an experiment in GitLab 18.2.

Indicates whether web-based commit signing is enabled for the group.

groupUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
group Group Group after update.

httpIntegrationCreate

Input type: HttpIntegrationCreateInput

httpIntegrationCreate arguments

Name Type Description Default
active Boolean! Whether the integration is receiving alerts.
name String! Name of the integration.
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!] Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonString Example of an alert payload.
projectPath ID! Project to create the integration in.
type AlertManagementIntegrationType Type of integration to create. Cannot be changed after creation. HTTP

httpIntegrationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
integration AlertManagementHttpIntegration Alerting integration.

httpIntegrationDestroy

Input type: HttpIntegrationDestroyInput

httpIntegrationDestroy arguments

Name Type Description
id AlertManagementHttpIntegrationID! ID of the integration to remove.

httpIntegrationDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
integration AlertManagementHttpIntegration Alerting integration.

httpIntegrationResetToken

Input type: HttpIntegrationResetTokenInput

httpIntegrationResetToken arguments

Name Type Description
id AlertManagementHttpIntegrationID! ID of the integration to mutate.

httpIntegrationResetToken fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
integration AlertManagementHttpIntegration Alerting integration.

httpIntegrationUpdate

Input type: HttpIntegrationUpdateInput

httpIntegrationUpdate arguments

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

httpIntegrationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
integration AlertManagementHttpIntegration Alerting integration.

importSourceUserCancelReassignment

  • Status: Experiment

Input type: ImportSourceUserCancelReassignmentInput

importSourceUserCancelReassignment arguments

Name Type Description
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserCancelReassignment fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

importSourceUserKeepAllAsPlaceholder

  • Status: Experiment

Input type: ImportSourceUserKeepAllAsPlaceholderInput

importSourceUserKeepAllAsPlaceholder arguments

Name Type Description
namespaceId NamespaceID! Global ID of the namespace.

importSourceUserKeepAllAsPlaceholder fields

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

importSourceUserKeepAsPlaceholder

  • Status: Experiment

Input type: ImportSourceUserKeepAsPlaceholderInput

importSourceUserKeepAsPlaceholder arguments

Name Type Description
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserKeepAsPlaceholder fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

importSourceUserReassign

  • Status: Experiment

Input type: ImportSourceUserReassignInput

importSourceUserReassign arguments

Name Type Description
assigneeUserId UserID! Global ID of the assignee user.
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserReassign fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

importSourceUserResendNotification

  • Status: Experiment

Input type: ImportSourceUserResendNotificationInput

importSourceUserResendNotification arguments

Name Type Description
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserResendNotification fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

importSourceUserRetryFailedReassignment

  • Status: Experiment

Input type: ImportSourceUserRetryFailedReassignmentInput

importSourceUserRetryFailedReassignment arguments

Name Type Description
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserRetryFailedReassignment fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

importSourceUserRevoke

  • Status: Experiment

Input type: ImportSourceUserRevokeInput

importSourceUserRevoke arguments

Name Type Description
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserRevoke fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

importSourceUserUndoKeepAsPlaceholder

  • Status: Experiment

Input type: ImportSourceUserUndoKeepAsPlaceholderInput

importSourceUserUndoKeepAsPlaceholder arguments

Name Type Description
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserUndoKeepAsPlaceholder fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

instanceAuditEventStreamingDestinationsCreate

  • Status: Experiment

Input type: InstanceAuditEventStreamingDestinationsCreateInput

instanceAuditEventStreamingDestinationsCreate arguments

Name Type Description
category String! Destination category.
config JSON! Destination config.
name String Destination name.
secretToken String Secret token.

instanceAuditEventStreamingDestinationsCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalAuditEventDestination InstanceAuditEventStreamingDestination Destination created.

instanceAuditEventStreamingDestinationsDelete

  • Status: Experiment

Input type: InstanceAuditEventStreamingDestinationsDeleteInput

instanceAuditEventStreamingDestinationsDelete arguments

Name Type Description
id AuditEventsInstanceExternalStreamingDestinationID! ID of the audit events external streaming destination to delete.

instanceAuditEventStreamingDestinationsDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

instanceAuditEventStreamingDestinationsUpdate

  • Status: Experiment

Input type: InstanceAuditEventStreamingDestinationsUpdateInput

instanceAuditEventStreamingDestinationsUpdate arguments

Name Type Description
active Boolean Active status of the destination.
category String Destination category.
config JSON Destination config.
id AuditEventsInstanceExternalStreamingDestinationID! ID of external audit event destination to update.
name String Destination name.
secretToken String Secret token.

instanceAuditEventStreamingDestinationsUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalAuditEventDestination InstanceAuditEventStreamingDestination Updated destination.

instanceExternalAuditEventDestinationCreate

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsCreate instead.

Input type: InstanceExternalAuditEventDestinationCreateInput

instanceExternalAuditEventDestinationCreate arguments

Name Type Description
destinationUrl String! Destination URL.
name String Destination name.

instanceExternalAuditEventDestinationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
instanceExternalAuditEventDestination InstanceExternalAuditEventDestination Destination created.

instanceExternalAuditEventDestinationDestroy

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: InstanceExternalAuditEventDestinationDestroyInput

instanceExternalAuditEventDestinationDestroy arguments

Name Type Description
id AuditEventsInstanceExternalAuditEventDestinationID! ID of the external instance audit event destination to destroy.

instanceExternalAuditEventDestinationDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

instanceExternalAuditEventDestinationUpdate

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: InstanceExternalAuditEventDestinationUpdateInput

instanceExternalAuditEventDestinationUpdate arguments

Name Type Description
active Boolean Active status of the destination.
destinationUrl String Destination URL to change.
id AuditEventsInstanceExternalAuditEventDestinationID! ID of the external instance audit event destination to update.
name String Destination name.

instanceExternalAuditEventDestinationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
instanceExternalAuditEventDestination InstanceExternalAuditEventDestination Updated destination.

instanceGoogleCloudLoggingConfigurationCreate

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

Input type: InstanceGoogleCloudLoggingConfigurationCreateInput

instanceGoogleCloudLoggingConfigurationCreate arguments

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

instanceGoogleCloudLoggingConfigurationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
instanceGoogleCloudLoggingConfiguration InstanceGoogleCloudLoggingConfigurationType configuration created.

instanceGoogleCloudLoggingConfigurationDestroy

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: InstanceGoogleCloudLoggingConfigurationDestroyInput

instanceGoogleCloudLoggingConfigurationDestroy arguments

Name Type Description
id AuditEventsInstanceGoogleCloudLoggingConfigurationID! ID of the Google Cloud logging configuration to destroy.

instanceGoogleCloudLoggingConfigurationDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

instanceGoogleCloudLoggingConfigurationUpdate

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput

instanceGoogleCloudLoggingConfigurationUpdate arguments

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

instanceGoogleCloudLoggingConfigurationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
instanceGoogleCloudLoggingConfiguration InstanceGoogleCloudLoggingConfigurationType configuration updated.

instanceSecretsManagerEnroll

Input type: InstanceSecretsManagerEnrollInput

instanceSecretsManagerEnroll fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

instanceSecretsManagerUnenroll

Input type: InstanceSecretsManagerUnenrollInput

instanceSecretsManagerUnenroll fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

integrationExclusionCreate

  • Status: Experiment

Input type: IntegrationExclusionCreateInput

integrationExclusionCreate arguments

Name Type Description
groupIds [GroupID!] IDs of groups to exclude up to a maximum of 100.
integrationName IntegrationType! Type of integration to exclude.
projectIds [ProjectID!] IDs of projects to exclude up to a maximum of 100.

integrationExclusionCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
exclusions [IntegrationExclusion!] Integration exclusions created by the mutation.

integrationExclusionDelete

  • Status: Experiment

Input type: IntegrationExclusionDeleteInput

integrationExclusionDelete arguments

Name Type Description
groupIds [GroupID!] IDs of excluded groups.
integrationName IntegrationType! Type of integration.
projectIds [ProjectID!] IDs of excluded projects.

integrationExclusionDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
exclusions [IntegrationExclusion!] Project no longer excluded due to the mutation.

issuableResourceLinkCreate

Input type: IssuableResourceLinkCreateInput

issuableResourceLinkCreate arguments

Name Type Description
id IssueID! Incident id to associate the resource link with.
link String! Link of the resource.
linkText String Link text of the resource.
linkType IssuableResourceLinkType Link type of the resource.

issuableResourceLinkCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issuableResourceLink IssuableResourceLink Issuable resource link.

issuableResourceLinkDestroy

Input type: IssuableResourceLinkDestroyInput

issuableResourceLinkDestroy arguments

Name Type Description
id IncidentManagementIssuableResourceLinkID! Issuable resource link ID to remove.

issuableResourceLinkDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issuableResourceLink IssuableResourceLink Issuable resource link.

issueLinkAlerts

Input type: IssueLinkAlertsInput

issueLinkAlerts arguments

Name Type Description
alertReferences [String!]! Alerts references to be linked to the incident.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

issueLinkAlerts fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueMove

Input type: IssueMoveInput

issueMove arguments

Name Type Description
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.
targetProjectPath ID! Project to move the issue to.
targetWorkItemTypeId WorkItemsTypeID Work item type to use in the target project. When omitted, the source work item type is preserved.

issueMove fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueMoveList

Input type: IssueMoveListInput

issueMoveList arguments

Name Type Description
boardId BoardID! Global ID of the board that the issue is in.
epicId EpicID Deprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
fromListId ID ID of the board list that the issue will be moved from.
iid String! IID of the issue to mutate.
moveAfterId ID ID of issue that should be placed after the current issue.
moveBeforeId ID ID of issue that should be placed before the current issue.
positionInList Int Position of issue within the board list. Positions start at 0. Use -1 to move to the end of the list.
projectPath ID! Project the issue to mutate is in.
toListId ID ID of the board list that the issue will be moved to.

issueMoveList fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetAssignees

Input type: IssueSetAssigneesInput

issueSetAssignees arguments

Name Type Description Default
assigneeUsernames [String!]! Usernames to assign to the resource. Replaces existing assignees by default.
iid String! IID of the issue to mutate.
operationMode MutationOperationMode Operation to perform. Defaults to REPLACE. REPLACE
projectPath ID! Project the issue to mutate is in.

issueSetAssignees fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetConfidential

Input type: IssueSetConfidentialInput

issueSetConfidential arguments

Name Type Description
confidential Boolean! Whether or not to set the issue as a confidential.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

issueSetConfidential fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetCrmContacts

Input type: IssueSetCrmContactsInput

issueSetCrmContacts arguments

Name Type Description
contactIds [CustomerRelationsContactID!]! Customer relations contact IDs to set. Replaces existing contacts by default.
iid String! IID of the issue to mutate.
operationMode MutationOperationMode Changes the operation mode. Defaults to REPLACE.
projectPath ID! Project the issue to mutate is in.

issueSetCrmContacts fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetDueDate

Input type: IssueSetDueDateInput

issueSetDueDate arguments

Name Type Description
dueDate Time Desired due date for the issue. Due date is removed if null.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

issueSetDueDate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetEpic

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: IssueSetEpicInput

issueSetEpic arguments

Name Type Description
epicId EpicID Deprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

issueSetEpic fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetEscalationPolicy

Input type: IssueSetEscalationPolicyInput

issueSetEscalationPolicy arguments

Name Type Description
escalationPolicyId IncidentManagementEscalationPolicyID Global ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

issueSetEscalationPolicy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetEscalationStatus

Input type: IssueSetEscalationStatusInput

issueSetEscalationStatus arguments

Name Type Description
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.
status IssueEscalationStatus! Set the escalation status.

issueSetEscalationStatus fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetIteration

Input type: IssueSetIterationInput

issueSetIteration arguments

Name Type Description
iid String! IID of the issue to mutate.
iterationId IterationID Iteration to assign to the issue.
projectPath ID! Project the issue to mutate is in.

issueSetIteration fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetLocked

Input type: IssueSetLockedInput

issueSetLocked arguments

Name Type Description
iid String! IID of the issue to mutate.
locked Boolean! Whether or not to lock discussion on the issue.
projectPath ID! Project the issue to mutate is in.

issueSetLocked fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetSeverity

Input type: IssueSetSeverityInput

issueSetSeverity arguments

Name Type Description
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.
severity IssuableSeverity! Set the incident severity level.

issueSetSeverity fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetSubscription

Input type: IssueSetSubscriptionInput

issueSetSubscription arguments

Name Type Description
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.
subscribedState Boolean! Desired state of the subscription.

issueSetSubscription fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueSetWeight

Input type: IssueSetWeightInput

issueSetWeight arguments

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

issueSetWeight fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

issueUnlinkAlert

Input type: IssueUnlinkAlertInput

issueUnlinkAlert arguments

Name Type Description
alertId AlertManagementAlertID! Global ID of the alert to unlink from the incident.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

issueUnlinkAlert fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

iterationCadenceCreate

Input type: IterationCadenceCreateInput

iterationCadenceCreate arguments

Name Type Description
active Boolean! Whether the iteration cadence is active.
automatic Boolean! Whether the iteration cadence should automatically generate upcoming iterations.
description String Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks Int Duration in weeks of the iterations within the cadence.
groupPath ID! Group where the iteration cadence is created.
iterationsInAdvance Int Number of future iterations to schedule in addition to the current one.
rollOver Boolean Whether the iteration cadence should roll over issues to the next iteration or not.
startDate Time Automation start date.
title String Title of the iteration cadence.

iterationCadenceCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
iterationCadence IterationCadence Created iteration cadence.

iterationCadenceDestroy

Input type: IterationCadenceDestroyInput

iterationCadenceDestroy arguments

Name Type Description
id IterationsCadenceID! Global ID of the iteration cadence.

iterationCadenceDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
group Group! Group the iteration cadence belongs to.

iterationCadenceUpdate

Input type: IterationCadenceUpdateInput

iterationCadenceUpdate arguments

Name Type Description
active Boolean Whether the iteration cadence is active.
automatic Boolean Whether the iteration cadence should automatically generate upcoming iterations.
description String Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks Int Duration in weeks of the iterations within the cadence.
id IterationsCadenceID! Global ID of the iteration cadence.
iterationsInAdvance Int Number of future iterations to schedule in addition to the current one.
rollOver Boolean Whether the iteration cadence should roll over issues to the next iteration or not.
startDate Time Automation start date.
title String Title of the iteration cadence.

iterationCadenceUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
iterationCadence IterationCadence Updated iteration cadence.

iterationCreate

Input type: iterationCreateInput

iterationCreate arguments

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

iterationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
iteration Iteration Created iteration.

iterationDelete

Input type: IterationDeleteInput

iterationDelete arguments

Name Type Description
id IterationID! ID of the iteration.

iterationDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
group Group! Group the iteration belongs to.

jiraImportStart

Input type: JiraImportStartInput

jiraImportStart arguments

Name Type Description
jiraProjectKey String! Project key of the importer Jira project.
jiraProjectName String Deprecated in GitLab 17.4. Argument is not used.
projectPath ID! Project to import the Jira project into.
usersMapping [JiraUsersMappingInputType!] Mapping of Jira to GitLab users.

jiraImportStart fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
jiraImport JiraImport Jira import data after mutation.

jiraImportUsers

Input type: JiraImportUsersInput

jiraImportUsers arguments

Name Type Description
projectPath ID! Project to import the Jira users into.
startAt Int Index of the record the import should started at, default 0 (50 records returned).

jiraImportUsers fields

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

jobArtifactsDestroy

Input type: JobArtifactsDestroyInput

jobArtifactsDestroy arguments

Name Type Description
id CiBuildID! ID of the job to mutate.

jobArtifactsDestroy fields

Name Type Description
destroyedArtifactsCount Int! Number of artifacts deleted.
errors [String!]! Errors encountered during the mutation.
job CiJob Job with artifacts to be deleted.

jobCancel

Input type: JobCancelInput

jobCancel arguments

Name Type Description
id CiBuildID! ID of the job to mutate.

jobCancel fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
job CiJob Job after the mutation.

jobPlay

Input type: JobPlayInput

jobPlay arguments

Name Type Description Default
id CiProcessableID! ID of the job to mutate.
inputs [CiInputsInput!] Inputs to use when playing the job. []
variables [CiVariableInput!] Variables to use when playing a manual job. []

jobPlay fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
job CiJob Job after the mutation.

jobRetry

Input type: JobRetryInput

jobRetry arguments

Name Type Description Default
id CiProcessableID! ID of the job to mutate.
inputs [CiInputsInput!] Inputs to use when retrying the job. []
variables [CiVariableInput!] Variables to use when retrying a manual job. []

jobRetry fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
job CiJob Job after the mutation.

jobUnschedule

Input type: JobUnscheduleInput

jobUnschedule arguments

Name Type Description
id CiBuildID! ID of the job to mutate.

jobUnschedule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
job CiJob Job after the mutation.

labelCreate

Input type: LabelCreateInput

labelCreate arguments

Name Type Description Default
color String The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names. See List of color keywords at mozilla.org. "#6699cc"
description String Description of the label.
groupPath ID Full path of the group with which the resource is associated.
projectPath ID Full path of the project with which the resource is associated.
title String! Title of the label.

labelCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
label Label Label after mutation.

labelUpdate

Input type: LabelUpdateInput

labelUpdate arguments

Name Type Description
archived Boolean Whether to archive the label. Introduced in GitLab 18.10.
id LabelID! Global ID of the label to update.

labelUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
label Label Label after mutation.

ldapAdminRoleLinkCreate

  • Status: Experiment

Creates an instance-level custom admin role LDAP link.

Input type: LdapAdminRoleLinkCreateInput

ldapAdminRoleLinkCreate arguments

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

ldapAdminRoleLinkCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
ldapAdminRoleLink LdapAdminRoleLink Created instance-level LDAP link.

ldapAdminRoleLinkDestroy

  • Status: Experiment

Destroys an instance-level custom admin role LDAP link.

Input type: LdapAdminRoleLinkDestroyInput

ldapAdminRoleLinkDestroy arguments

Name Type Description
id AuthzLdapAdminRoleLinkID! Global ID of the instance-level LDAP link to delete.

ldapAdminRoleLinkDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
ldapAdminRoleLink LdapAdminRoleLink Deleted instance-level LDAP link.

lifecycleAttachWorkItemType

  • Status: Experiment

Input type: LifecycleAttachWorkItemTypeInput

lifecycleAttachWorkItemType arguments

Name Type Description
lifecycleId WorkItemsStatusesLifecycleID! Global ID of the lifecycle to attach the work item type to.
namespacePath ID! Namespace path where the lifecycle exists.
statusMappings [StatusMappingInput!] Status mappings from the old lifecycle to the new lifecycle.
workItemTypeId WorkItemsTypeID! Global ID of the work item type to attach to the lifecycle.

lifecycleAttachWorkItemType fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
lifecycle WorkItemLifecycle Lifecycle after attaching the work item type.

lifecycleCreate

  • Status: Experiment

Input type: LifecycleCreateInput

lifecycleCreate arguments

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

lifecycleCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
lifecycle WorkItemLifecycle Lifecycle created.

lifecycleDelete

  • Status: Experiment

Input type: LifecycleDeleteInput

lifecycleDelete arguments

Name Type Description
id WorkItemsStatusesLifecycleID! Global ID of the lifecycle to delete.
namespacePath ID! Namespace path where the lifecycle exists.

lifecycleDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
lifecycle WorkItemLifecycle Deleted lifecycle.

lifecycleUpdate

  • Status: Experiment

Input type: LifecycleUpdateInput

lifecycleUpdate arguments

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

lifecycleUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
lifecycle WorkItemLifecycle Lifecycle updated.

linkProjectComplianceViolationIssue

Input type: LinkProjectComplianceViolationIssueInput

linkProjectComplianceViolationIssue arguments

Name Type Description
issueIid String! IID of the issue to be linked.
projectPath ID! Full path of the project the issue belongs to.
violationId ComplianceManagementProjectsComplianceViolationID! Global ID of the project compliance violation.

linkProjectComplianceViolationIssue fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
violation ProjectComplianceViolation Updated project compliance violation.

markAsSpamSnippet

Input type: MarkAsSpamSnippetInput

markAsSpamSnippet arguments

Name Type Description
id SnippetID! Global ID of the snippet to update.

markAsSpamSnippet fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
snippet Snippet Snippet after mutation.

mavenCacheEntryDelete

  • Status: Experiment

Input type: MavenCacheEntryDeleteInput

mavenCacheEntryDelete arguments

Name Type Description
id String! ID of the cache entry.

mavenCacheEntryDelete fields

Name Type Description
cacheEntry MavenUpstreamCacheEntry Maven cache entry.
errors [String!]! Errors encountered during the mutation.

mavenUpstreamCacheDelete

  • Status: Experiment

Input type: MavenUpstreamCacheDeleteInput

mavenUpstreamCacheDelete arguments

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

mavenUpstreamCacheDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upstream MavenUpstreamDetails Maven virtual registry upstream.

mavenUpstreamCreate

  • Status: Experiment

Input type: MavenUpstreamCreateInput

mavenUpstreamCreate arguments

Name Type Description Default
cacheValidityHours Int Cache validity period. Defaults to 24 hours. 24
description String Description of the upstream registry.
id VirtualRegistriesPackagesMavenRegistryID! ID of the upstream registry.
metadataCacheValidityHours Int Metadata cache validity period. Defaults to 24 hours. 24
name String! Name of upstream registry.
password String Password of the upstream registry.
url String! URL of the upstream registry.
username String Username of the upstream registry.

mavenUpstreamCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upstream MavenUpstreamDetails Maven upstream after the mutation.

mavenUpstreamDelete

  • Status: Experiment

Input type: MavenUpstreamDeleteInput

mavenUpstreamDelete arguments

Name Type Description
id VirtualRegistriesPackagesMavenUpstreamID! ID of the upstream to be deleted.

mavenUpstreamDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upstream MavenUpstreamDetails Destroyed upstream.

mavenUpstreamUpdate

  • Status: Experiment

Input type: MavenUpstreamUpdateInput

mavenUpstreamUpdate arguments

Name Type Description
cacheValidityHours Int Cache validity period.
description String Description of the upstream registry.
id VirtualRegistriesPackagesMavenUpstreamID! ID of the upstream registry.
metadataCacheValidityHours Int Metadata cache validity period.
name String Name of upstream registry.
password String Password of the upstream registry.
url String URL of the upstream registry.
username String Username of the upstream registry.

mavenUpstreamUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upstream MavenUpstreamDetails Maven upstream after the mutation.

mavenVirtualRegistryCacheDelete

  • Status: Experiment

Input type: MavenVirtualRegistryCacheDeleteInput

mavenVirtualRegistryCacheDelete arguments

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

mavenVirtualRegistryCacheDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry MavenRegistry Maven virtual registry.

mavenVirtualRegistryCreate

  • Status: Experiment

Input type: MavenVirtualRegistryCreateInput

mavenVirtualRegistryCreate arguments

Name Type Description
description String Description of the virtual registry.
groupPath ID Full path of the group with which the resource is associated.
name String! Name of virtual registry.

mavenVirtualRegistryCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry MavenRegistry Maven virtual registry after the mutation.

mavenVirtualRegistryDelete

  • Status: Experiment

Input type: MavenVirtualRegistryDeleteInput

mavenVirtualRegistryDelete arguments

Name Type Description
id VirtualRegistriesPackagesMavenRegistryID! ID of the Maven virtual registry to be deleted.

mavenVirtualRegistryDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry MavenRegistry Deleted Maven virtual registry.

mavenVirtualRegistryUpdate

  • Status: Experiment

Input type: MavenVirtualRegistryUpdateInput

mavenVirtualRegistryUpdate arguments

Name Type Description
description String Description of the virtual registry.
id VirtualRegistriesPackagesMavenRegistryID! ID of the Maven virtual registry to be updated.
name String Name of virtual registry.

mavenVirtualRegistryUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registry MavenRegistry Maven virtual registry after the mutation.

mavenVirtualRegistryUpstreamDelete

  • Status: Experiment

Input type: MavenVirtualRegistryUpstreamDeleteInput

mavenVirtualRegistryUpstreamDelete arguments

Name Type Description
upstreamId VirtualRegistriesPackagesMavenRegistryUpstreamID! ID of the Maven virtual registry upstream.

mavenVirtualRegistryUpstreamDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registryUpstream MavenRegistryUpstreamWithRegistry Deleted maven registry upstream.

mavenVirtualRegistryUpstreamUpdate

  • Status: Experiment

Input type: MavenVirtualRegistryUpstreamUpdateInput

mavenVirtualRegistryUpstreamUpdate arguments

Name Type Description
id VirtualRegistriesPackagesMavenRegistryUpstreamID! ID of the Maven virtual registry upstream.
position Int! Priority order of an upstream within a virtual registry.

mavenVirtualRegistryUpstreamUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
registryUpstream MavenRegistryUpstreamWithRegistry Maven registry upstream after update.

memberRoleAdminCreate

  • Status: Experiment

Input type: MemberRoleAdminCreateInput

memberRoleAdminCreate arguments

Name Type Description
description String Description of the member role.
name String Name of the member role.
permissions [MemberRoleAdminPermission!] List of all customizable admin permissions.

memberRoleAdminCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
memberRole AdminMemberRole Member role.

memberRoleAdminDelete

  • Status: Experiment

Input type: MemberRoleAdminDeleteInput

memberRoleAdminDelete arguments

Name Type Description
id MemberRoleID! ID of the admin member role to delete.

memberRoleAdminDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
memberRole MemberRole Deleted admin member role.

memberRoleAdminUpdate

  • Status: Experiment

Input type: MemberRoleAdminUpdateInput

memberRoleAdminUpdate arguments

Name Type Description
description String Description of the member role.
id MemberRoleID! ID of the member role to mutate.
name String Name of the member role.
permissions [MemberRoleAdminPermission!] List of all customizable admin permissions.

memberRoleAdminUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
memberRole AdminMemberRole Member role.

memberRoleCreate

  • Status: Experiment

Input type: MemberRoleCreateInput

memberRoleCreate arguments

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

memberRoleCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
memberRole MemberRole Member role.

memberRoleDelete

  • Status: Experiment

Input type: MemberRoleDeleteInput

memberRoleDelete arguments

Name Type Description
id MemberRoleID! ID of the member role to delete.

memberRoleDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
memberRole MemberRole Deleted member role.

memberRoleToUserAssign

  • Status: Experiment

Input type: MemberRoleToUserAssignInput

memberRoleToUserAssign arguments

Name Type Description
memberRoleId MemberRoleID Global ID of the custom role to be assigned to a user. Admin roles will be unassigned from the user if omitted or set as NULL.
userId UserID! Global ID of the user to be assigned to a custom role.

memberRoleToUserAssign fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userMemberRole UserMemberRole Created user member role or nil if the relation was deleted.

memberRoleUpdate

Input type: MemberRoleUpdateInput

memberRoleUpdate arguments

Name Type Description
description String Description of the member role.
id MemberRoleID! ID of the member role to mutate.
name String Name of the member role.
permissions [MemberRolePermission!] List of all customizable permissions.

memberRoleUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
memberRole MemberRole Member role.

mergeRequestAccept

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

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

Input type: MergeRequestAcceptInput

mergeRequestAccept arguments

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

mergeRequestAccept fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestBypassSecurityPolicy

  • Status: Experiment

Bypasses security policies for a merge request.

Input type: MergeRequestBypassSecurityPolicyInput

mergeRequestBypassSecurityPolicy arguments

Name Type Description
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.
reason String! Reason for bypassing the security policy.
securityPolicyIds [ID!]! ID of the security policy to bypass.

mergeRequestBypassSecurityPolicy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestCreate

Input type: MergeRequestCreateInput

mergeRequestCreate arguments

Name Type Description
description String Description of the merge request (Markdown rendered as HTML for caching).
labels [String!] Labels of the merge request.
mergeAfter Time Date and time after which the merge request can be merged.
mergeBefore Time Introduced as an experiment in GitLab 19.6.

Date and time before which the merge request can be merged.
projectPath ID! Project full path the merge request is associated with.
removeSourceBranch Boolean Indicates if the source branch of the merge request will be deleted after merge.
sourceBranch String! Source branch of the merge request.
targetBranch String! Target branch of the merge request.
title String! Title of the merge request.

mergeRequestCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestCreateWorkItemRelations

Links work items to a merge request.

Input type: MergeRequestCreateWorkItemRelationsInput

mergeRequestCreateWorkItemRelations arguments

Name Type Description Default
iid String! IID of the merge request to mutate.
linkType MergeRequestWorkItemLinkType Type of relationship to create. Defaults to RELATED. MENTIONED relations are managed automatically and cannot be created. RELATED
projectPath ID! Project the merge request to mutate is in.
workItemIds [WorkItemID!]! Global IDs of the work items to link.

mergeRequestCreateWorkItemRelations fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.
workItemRelations [MergeRequestWorkItemRelation!] Created merge request to work item relations.

mergeRequestDestroyRequestedChanges

Input type: MergeRequestDestroyRequestedChangesInput

mergeRequestDestroyRequestedChanges arguments

Name Type Description
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.

mergeRequestDestroyRequestedChanges fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestDestroyWorkItemRelations

Removes relations between a merge request and work items.

Input type: MergeRequestDestroyWorkItemRelationsInput

mergeRequestDestroyWorkItemRelations arguments

Name Type Description
ids [MergeRequestIssueID!]! Global IDs of the relations to remove.
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.

mergeRequestDestroyWorkItemRelations fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.
removedRelationIds [MergeRequestIssueID!] Global IDs of the removed relations.

mergeRequestRequestChanges

Input type: MergeRequestRequestChangesInput

mergeRequestRequestChanges arguments

Name Type Description
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.

mergeRequestRequestChanges fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestResolveConflicts

  • Status: Experiment

Resolves the conflicts of a merge request the way the web UI does: commits a merge of the target branch into the source branch.

Input type: MergeRequestResolveConflictsInput

mergeRequestResolveConflicts arguments

Name Type Description
commitMessage String Message of the merge commit. Defaults to the message the web UI uses.
files [MergeRequestConflictFileResolutionInput!]! Resolution of every file in MergeRequest.conflictFiles. Maximum is 1000 files.
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.

mergeRequestResolveConflicts fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestResyncSecurityPolicies

  • Status: Experiment

Triggers a re-evaluation of the security approval policies applicable to the merge request.

Input type: MergeRequestResyncSecurityPoliciesInput

mergeRequestResyncSecurityPolicies arguments

Name Type Description
iid String! IID of the merge request to re-evaluate.
projectPath ID! Project the merge request belongs to.

mergeRequestResyncSecurityPolicies fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after the re-evaluation was scheduled.

mergeRequestReviewerRereview

Input type: MergeRequestReviewerRereviewInput

mergeRequestReviewerRereview arguments

Name Type Description
duoCodeReviewDepth DuoCodeReviewDepth Introduced as an experiment in GitLab 19.6.

Depth of the GitLab Duo Code Review to run when the user is the GitLab Duo Code Review bot. Ignored for other users, and where Standard reviews are not available for the project.
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.
userId UserID! User ID for the user that has been requested for a new review.

mergeRequestReviewerRereview fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestSavedViewCreate

  • Status: Experiment

Creates a saved view on the merge request dashboard. Available only when the mr_dashboard_saved_views feature flag is enabled.

Input type: MergeRequestSavedViewCreateInput

mergeRequestSavedViewCreate arguments

Name Type Description
filters MergeRequestSavedViewFilterInput Merge request filters stored in the saved view.
name String! Name of the saved view.

mergeRequestSavedViewCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView MergeRequestSavedView Saved view after the mutation.

mergeRequestSavedViewDelete

  • Status: Experiment

Deletes a saved view from the merge request dashboard. Available only when the mr_dashboard_saved_views feature flag is enabled.

Input type: MergeRequestSavedViewDeleteInput

mergeRequestSavedViewDelete arguments

Name Type Description
id MergeRequestsSavedViewID! Global ID of the saved view.

mergeRequestSavedViewDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView MergeRequestSavedView Saved view after the mutation.

mergeRequestSavedViewUpdate

  • Status: Experiment

Updates a saved view on the merge request dashboard. Available only when the mr_dashboard_saved_views feature flag is enabled.

Input type: MergeRequestSavedViewUpdateInput

mergeRequestSavedViewUpdate arguments

Name Type Description
filters MergeRequestSavedViewFilterInput Merge request filters stored in the saved view.
id MergeRequestsSavedViewID! Global ID of the saved view.
name String Name of the saved view.

mergeRequestSavedViewUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView MergeRequestSavedView Saved view after the mutation.

mergeRequestSetAssignees

Input type: MergeRequestSetAssigneesInput

mergeRequestSetAssignees arguments

Name Type Description Default
assigneeUsernames [String!]! Usernames to assign to the resource. Replaces existing assignees by default.
iid String! IID of the merge request to mutate.
operationMode MutationOperationMode Operation to perform. Defaults to REPLACE. REPLACE
projectPath ID! Project the merge request to mutate is in.

mergeRequestSetAssignees fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestSetBlockingMergeRequests

Input type: MergeRequestSetBlockingMergeRequestsInput

mergeRequestSetBlockingMergeRequests arguments

Name Type Description
blockingMergeRequestReferences [String!]! Array of blocking merge request references (e.g., “!123”, “project!456”).
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.

mergeRequestSetBlockingMergeRequests fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestSetDraft

Input type: MergeRequestSetDraftInput

mergeRequestSetDraft arguments

Name Type Description
draft Boolean! Whether or not to set the merge request as a draft.
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.

mergeRequestSetDraft fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestSetLabels

Input type: MergeRequestSetLabelsInput

mergeRequestSetLabels arguments

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

mergeRequestSetLabels fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestSetLocked

Input type: MergeRequestSetLockedInput

mergeRequestSetLocked arguments

Name Type Description
iid String! IID of the merge request to mutate.
locked Boolean! Whether or not to lock the merge request.
projectPath ID! Project the merge request to mutate is in.

mergeRequestSetLocked fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestSetMilestone

Input type: MergeRequestSetMilestoneInput

mergeRequestSetMilestone arguments

Name Type Description
iid String! IID of the merge request to mutate.
milestoneId MilestoneID Milestone to assign to the merge request.
projectPath ID! Project the merge request to mutate is in.

mergeRequestSetMilestone fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestSetReviewers

Input type: MergeRequestSetReviewersInput

mergeRequestSetReviewers arguments

Name Type Description Default
iid String! IID of the merge request to mutate.
operationMode MutationOperationMode Operation to perform. Defaults to REPLACE. REPLACE
projectPath ID! 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.

mergeRequestSetReviewers fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestSetSubscription

Input type: MergeRequestSetSubscriptionInput

mergeRequestSetSubscription arguments

Name Type Description
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.
subscribedState Boolean! Desired state of the subscription.

mergeRequestSetSubscription fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestUpdate

Update attributes of a merge request.

Input type: MergeRequestUpdateInput

mergeRequestUpdate arguments

Name Type Description
description String Description of the merge request (Markdown rendered as HTML for caching).
iid String! IID of the merge request to mutate.
mergeAfter Time Date and time after which the merge request can be merged. To remove the merge schedule, set mergeAfter and mergeBefore to null.
mergeBefore Time Introduced as an experiment in GitLab 19.6.

Date and time before which the merge request can be merged. Set to null to remove the end time.
overrideRequestedChanges Boolean Override all requested changes. Can only be set by users who have permissionto merge this merge request.
projectPath ID! Project the merge request to mutate is in.
removeSourceBranch Boolean Indicates if the source branch of the merge request will be deleted after merge.
state MergeRequestNewState Action to perform to change the state.
targetBranch String Target branch of the merge request.
timeEstimate String Estimated time to complete the merge request. Use null or 0 to remove the current estimate.
title String Title of the merge request.

mergeRequestUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestUpdateApprovalRule

Input type: MergeRequestUpdateApprovalRuleInput

mergeRequestUpdateApprovalRule arguments

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

mergeRequestUpdateApprovalRule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge request after mutation.

mergeRequestsCsvExport

  • Status: Experiment

Input type: MergeRequestsCsvExportInput

mergeRequestsCsvExport arguments

Name Type Description
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath String Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter Time Merge requests closed after the date.
closedBefore Time Merge requests closed before the date.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
ignoredReviewerUsername String Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
labelName [String] Labels applied to the merge request.
labels [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectPath ID! Full project path.
releaseTag String Filter by release tag.
reviewState MergeRequestReviewState Reviewer state of the merge request.
reviewStates [MergeRequestReviewState!] Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.

mergeRequestsCsvExport fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
message String Export request result message.

mergeTrainsDeleteCar

  • Status: Experiment

Input type: MergeTrainsDeleteCarInput

mergeTrainsDeleteCar arguments

Name Type Description
carId MergeTrainsCarID! Global ID of the car.

mergeTrainsDeleteCar fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

mlModelCreate

  • Status: Experiment

Input type: MlModelCreateInput

mlModelCreate arguments

Name Type Description
description String Description of the model.
name String! Name of the model.
projectPath ID! Project the model to mutate is in.

mlModelCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
model MlModel Model after mutation.

mlModelDelete

  • Status: Experiment

Input type: MlModelDeleteInput

mlModelDelete arguments

Name Type Description
id MlModelID! Global ID of the model to be deleted.
projectPath ID! Project the model to mutate is in.

mlModelDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
model MlModel Model after mutation.

mlModelDestroy

  • Status: Experiment

Input type: MlModelDestroyInput

mlModelDestroy arguments

Name Type Description
id MlModelID! Global ID of the model to be deleted.
projectPath ID! Project the model to mutate is in.

mlModelDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
message String Model deletion result message.
model MlModel Model after mutation.

mlModelEdit

  • Status: Experiment

Input type: MlModelEditInput

mlModelEdit arguments

Name Type Description
description String Description of the model.
modelId Int Id of the model.
name String! Name of the model.
projectPath ID! Project the model to mutate is in.

mlModelEdit fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
model MlModel Model after mutation.

mlModelVersionCreate

  • Status: Experiment

Input type: MlModelVersionCreateInput

mlModelVersionCreate arguments

Name Type Description
candidateId MlCandidateID Global ID of a candidate to promote optionally.
description String Description of the model version.
modelId MlModelID! Global ID of the model the version belongs to.
projectPath ID! Project the model to mutate is in.
version String Model version.

mlModelVersionCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
modelVersion MlModelVersion Model after mutation.

mlModelVersionDelete

  • Status: Experiment

Input type: MlModelVersionDeleteInput

mlModelVersionDelete arguments

Name Type Description
id MlModelVersionID! Global ID of the model version to be deleted.

mlModelVersionDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
modelVersion MlModelVersion Deleted model version.

mlModelVersionEdit

  • Status: Experiment

Input type: MlModelVersionEditInput

mlModelVersionEdit arguments

Name Type Description
description String! Description of the model version.
modelId MlModelID! Global ID of the model the version belongs to.
projectPath ID! Project the model to mutate is in.
version String! Model version.

mlModelVersionEdit fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
modelVersion MlModelVersion Model after mutation.

namespaceBanDestroy

Input type: NamespaceBanDestroyInput

namespaceBanDestroy arguments

Name Type Description
id NamespacesNamespaceBanID! Global ID of the namespace ban to remove.

namespaceBanDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespaceBan NamespaceBan Namespace Ban.

namespaceCiCdSettingsUpdate

Input type: NamespaceCiCdSettingsUpdateInput

namespaceCiCdSettingsUpdate arguments

Name Type Description
allowStaleRunnerPruning Boolean Indicates if stale runners directly belonging to the namespace should be periodically pruned.
fullPath ID! Full path of the namespace the settings belong to.

namespaceCiCdSettingsUpdate fields

Name Type Description
ciCdSettings NamespaceCiCdSetting! CI/CD settings after mutation.
errors [String!]! Errors encountered during the mutation.

namespaceCreateRemoteDevelopmentClusterAgentMapping

Input type: NamespaceCreateRemoteDevelopmentClusterAgentMappingInput

namespaceCreateRemoteDevelopmentClusterAgentMapping arguments

Name Type Description
clusterAgentId ClustersAgentID! GlobalID of the cluster agent to be associated with the namespace.
namespaceId GroupID! GlobalID of the group to be associated with the cluster agent.

namespaceCreateRemoteDevelopmentClusterAgentMapping fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespaceClusterAgentMapping NamespaceClusterAgentMapping Introduced as an experiment in GitLab 17.10.

Created namespace cluster agent mapping.

namespaceDeleteRemoteDevelopmentClusterAgentMapping

Input type: NamespaceDeleteRemoteDevelopmentClusterAgentMappingInput

namespaceDeleteRemoteDevelopmentClusterAgentMapping arguments

Name Type Description
clusterAgentId ClustersAgentID! GlobalID of the cluster agent to be un-associated from the namespace.
namespaceId GroupID! GlobalID of the group to be un-associated from the cluster agent.

namespaceDeleteRemoteDevelopmentClusterAgentMapping fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespaceClusterAgentMapping NamespaceClusterAgentMapping Introduced as an experiment in GitLab 17.11.

Created namespace cluster agent mapping.

namespaceSecretsManagerEnroll

Input type: NamespaceSecretsManagerEnrollInput

namespaceSecretsManagerEnroll arguments

Name Type Description
namespacePath ID! Full path of the namespace to enroll.

namespaceSecretsManagerEnroll fields

Name Type Description
enrollment SecretsManagerEnrollment Enrollment record.
errors [String!]! Errors encountered during the mutation.

namespaceSecretsManagerUnenroll

Input type: NamespaceSecretsManagerUnenrollInput

namespaceSecretsManagerUnenroll arguments

Name Type Description
namespacePath ID! Full path of the namespace to unenroll.

namespaceSecretsManagerUnenroll fields

Name Type Description
enrollment SecretsManagerEnrollment Enrollment record.
errors [String!]! Errors encountered during the mutation.

namespaceSettingsUpdate

  • Status: Experiment

Input type: NamespaceSettingsUpdateInput

namespaceSettingsUpdate arguments

Name Type Description
fullPath ID! Full path of the namespace the settings belong to.
pipelineVariablesDefaultRole PipelineVariablesDefaultRoleType Indicates the default minimum role required to override pipeline variables in the namespace.

namespaceSettingsUpdate fields

Name Type Description
ciCdSettings CiCdSettings! Namespace CI/CD settings after mutation.
errors [String!]! Errors encountered during the mutation.

namespacesRegenerateNewWorkItemEmailAddress

  • Status: Experiment

Input type: NamespacesRegenerateNewWorkItemEmailAddressInput

namespacesRegenerateNewWorkItemEmailAddress arguments

Name Type Description
fullPath ID! Full path of the namespace to regenerate the new work item email address for.

namespacesRegenerateNewWorkItemEmailAddress fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespace Namespace Namespace after regenerating the new work item email address.

noteConvertToThread

Convert a standard comment to a resolvable thread.

Input type: NoteConvertToThreadInput

noteConvertToThread arguments

Name Type Description
id NoteID! Global ID of the Note to convert.

noteConvertToThread fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

oncallRotationCreate

Input type: OncallRotationCreateInput

oncallRotationCreate arguments

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

oncallRotationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
oncallRotation IncidentManagementOncallRotation On-call rotation.

oncallRotationDestroy

Input type: OncallRotationDestroyInput

oncallRotationDestroy arguments

Name Type Description
id IncidentManagementOncallRotationID! ID of the on-call rotation to remove.
projectPath ID! Project to remove the on-call schedule from.
scheduleIid String! IID of the on-call schedule to the on-call rotation belongs to.

oncallRotationDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
oncallRotation IncidentManagementOncallRotation On-call rotation.

oncallRotationUpdate

Input type: OncallRotationUpdateInput

oncallRotationUpdate arguments

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

oncallRotationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
oncallRotation IncidentManagementOncallRotation On-call rotation.

oncallScheduleCreate

Input type: OncallScheduleCreateInput

oncallScheduleCreate arguments

Name Type Description
description String Description of the on-call schedule.
name String! Name of the on-call schedule.
projectPath ID! Project to create the on-call schedule in.
timezone String! Timezone of the on-call schedule.

oncallScheduleCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
oncallSchedule IncidentManagementOncallSchedule On-call schedule.

oncallScheduleDestroy

Input type: OncallScheduleDestroyInput

oncallScheduleDestroy arguments

Name Type Description
iid String! On-call schedule internal ID to remove.
projectPath ID! Project to remove the on-call schedule from.

oncallScheduleDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
oncallSchedule IncidentManagementOncallSchedule On-call schedule.

oncallScheduleUpdate

Input type: OncallScheduleUpdateInput

oncallScheduleUpdate arguments

Name Type Description
description String Description of the on-call schedule.
iid String! On-call schedule internal ID to update.
name String Name of the on-call schedule.
projectPath ID! Project to update the on-call schedule in.
timezone String Timezone of the on-call schedule.

oncallScheduleUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
oncallSchedule IncidentManagementOncallSchedule On-call schedule.

orbitExcludedGroupCreate

  • Status: Experiment

Input type: OrbitExcludedGroupCreateInput

orbitExcludedGroupCreate arguments

Name Type Description
groupPath ID! Full path of the top-level group to exclude.

orbitExcludedGroupCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
group Group Excluded group.

orbitExcludedGroupDestroy

  • Status: Experiment

Input type: OrbitExcludedGroupDestroyInput

orbitExcludedGroupDestroy arguments

Name Type Description
groupPath ID! Full path of the top-level group to remove from exclusions.

orbitExcludedGroupDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
group Group Group removed from exclusions.

orbitInstanceStartTrial

  • Status: Experiment

Input type: OrbitInstanceStartTrialInput

orbitInstanceStartTrial fields

Name Type Description
access OrbitAccess Instance Orbit access state after starting the trial.
errors [String!]! Errors encountered during the mutation.

orbitStartTrial

  • Status: Experiment

Input type: OrbitStartTrialInput

orbitStartTrial arguments

Name Type Description
groupPath ID! Full path of the top-level group.

orbitStartTrial fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
group Group Group the trial was requested for, also returned on error. Read orbit { enabled access { trial } } from it.

orbitUpdate

  • Status: Experiment

Turns Orbit on or off for a top-level group.

Input type: OrbitUpdateInput

orbitUpdate arguments

Name Type Description
enabled Boolean! Whether to turn Orbit on or off for the top-level group.
groupPath ID! Full path of the top-level group to update.

orbitUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
group Group Group after mutation.

organizationConfirm

  • Status: Experiment

Input type: OrganizationConfirmInput

organizationConfirm arguments

Name Type Description
groups [GroupID!] Global IDs of top-level groups to transfer to the organization.
id OrganizationsOrganizationID! Global ID of the organization to confirm.

organizationConfirm fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organization Organization Organization after mutation.

organizationCreate

  • Status: Experiment

Input type: OrganizationCreateInput

organizationCreate arguments

Name Type Description
avatar Upload Avatar for the organization.
description String Description of the organization.
name String! Name for the organization.
path String! Path for the organization.
visibility OrganizationVisibility Visibility for the organization.

organizationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organization Organization Organization after mutation.

organizationCreateClusterAgentMapping

  • Status: Experiment

Input type: OrganizationCreateClusterAgentMappingInput

organizationCreateClusterAgentMapping arguments

Name Type Description
clusterAgentId ClustersAgentID! GlobalID of the cluster agent to be associated with the organization.
organizationId OrganizationsOrganizationID! GlobalID of the organization to be associated with the cluster agent.

organizationCreateClusterAgentMapping fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

organizationDelete

  • Status: Experiment

Input type: OrganizationDeleteInput

organizationDelete arguments

Name Type Description
avatar Upload Avatar for the organization.
description String Description of the organization.
id OrganizationsOrganizationID! ID of the organization to soft-delete.

organizationDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organization Organization Soft-deleted organization.

organizationDeleteClusterAgentMapping

  • Status: Experiment

Input type: OrganizationDeleteClusterAgentMappingInput

organizationDeleteClusterAgentMapping arguments

Name Type Description
clusterAgentId ClustersAgentID! GlobalID of the cluster agent to be dissociated with the organization.
organizationId OrganizationsOrganizationID! GlobalID of the organization to be dissociated with the cluster agent.

organizationDeleteClusterAgentMapping fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

organizationRestore

  • Status: Experiment

Input type: OrganizationRestoreInput

organizationRestore arguments

Name Type Description
id OrganizationsOrganizationID! ID of the organization to restore.

organizationRestore fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organization Organization Restored organization.

organizationUpdate

  • Status: Experiment

Input type: OrganizationUpdateInput

organizationUpdate arguments

Name Type Description
avatar Upload Avatar for the organization.
description String Description of the organization.
id OrganizationsOrganizationID! ID of the organization to mutate.
name String Name for the organization.
path String Path for the organization.
policyStoreExperimentEnabled Boolean Introduced as an experiment in GitLab 19.4.

Opt the organization in to or out of the Policy Store experiment. Opting in returns an error when the experiment is not available to the organization; opting out is always accepted.
visibility OrganizationVisibility Visibility for the organization.

organizationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organization Organization Organization after mutation.

organizationUserCreate

  • Status: Experiment

Input type: OrganizationUserCreateInput

organizationUserCreate arguments

Name Type Description
organizationId OrganizationsOrganizationID! ID of the organization to add the user to.
userType OrganizationUserType! Type to add the organization user with.
username String! Username of the user to add to the organization.

organizationUserCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organizationUser OrganizationUser Introduced as an experiment in GitLab 19.3.

Organization user added by the mutation.

organizationUserDelete

  • Status: Experiment

Input type: OrganizationUserDeleteInput

organizationUserDelete arguments

Name Type Description
id OrganizationsOrganizationUserID! ID of the organization user to delete.

organizationUserDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organizationUser OrganizationUser Introduced as an experiment in GitLab 19.3.

Organization user that was deleted.

organizationUserUpdate

  • Status: Experiment

Input type: OrganizationUserUpdateInput

organizationUserUpdate arguments

Name Type Description
accessLevel OrganizationUserAccessLevel! Access level to update the organization user to.
id OrganizationsOrganizationUserID! ID of the organization user to mutate.

organizationUserUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
organizationUser OrganizationUser Introduced as an experiment in GitLab 17.5.

Organization user after mutation.

pagesMarkOnboardingComplete

Input type: PagesMarkOnboardingCompleteInput

pagesMarkOnboardingComplete arguments

Name Type Description
projectPath ID! Full path of the project.

pagesMarkOnboardingComplete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
onboardingComplete Boolean! Indicates the new onboarding_complete state of the project’s Pages metadata.

personalAccessTokenCreate

  • Status: Experiment

Creates a personal access token for the current user.

Input type: PersonalAccessTokenCreateInput

personalAccessTokenCreate arguments

Name Type Description Default
description String Description of the token.
expiresAt ISO8601Date Expiration date of the token.
granularScopes [GranularScopeInput!]! List of granular scopes to assign to the token.
name String! Name of the token.
sudo Boolean Whether the token can impersonate other users with sudo. Requires the token owner to be an administrator. false

personalAccessTokenCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
token String Created personal access token.

personalAccessTokenRevoke

  • Status: Experiment

Revokes a specified personal access token.

Input type: PersonalAccessTokenRevokeInput

personalAccessTokenRevoke arguments

Name Type Description
id PersonalAccessTokenID! Global ID of the personal access token that will be revoked.

personalAccessTokenRevoke fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

personalAccessTokenRotate

  • Status: Experiment

Rotate a specified personal access token.

Input type: PersonalAccessTokenRotateInput

personalAccessTokenRotate arguments

Name Type Description
expiresAt ISO8601Date Expiration date of the token.
id PersonalAccessTokenID! Global ID of the personal access token that will be rotated.

personalAccessTokenRotate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
token String Created personal access token.

pipelineCancel

Input type: PipelineCancelInput

pipelineCancel arguments

Name Type Description
id CiPipelineID! ID of the pipeline to mutate.

pipelineCancel fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipeline Pipeline Pipeline after mutation.

pipelineCreate

Input type: PipelineCreateInput

pipelineCreate arguments

Name Type Description
async Boolean Introduced as an experiment in GitLab 17.8.

When true, the request does not wait for the pipeline to be created, and returns a unique identifier that can be used to check the creation status.
inputs [CiInputsInput!] Introduced as an experiment in GitLab 17.10.

Inputs for the pipeline.
mergeRequestIid String IID of the merge request to create pipeline for.
projectPath ID! Full path of the project that is triggering the pipeline.
ref String! 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.

pipelineCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipeline Pipeline Pipeline created after mutation. Null if async: true.
requestId String Introduced as an experiment in GitLab 17.8.

ID for checking the pipeline creation status. Null if async: false.

pipelineDestroy

Input type: PipelineDestroyInput

pipelineDestroy arguments

Name Type Description
id CiPipelineID! ID of the pipeline to mutate.

pipelineDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

pipelineExecutionSchedulePolicyTestRun

  • Status: Experiment

Triggers a test-run for a Scheduled Pipeline Execution Policy on a specific project.

Input type: PipelineExecutionSchedulePolicyTestRunInput

pipelineExecutionSchedulePolicyTestRun arguments

Name Type Description
policyId SecurityPolicyID! Global ID of the pipeline execution schedule policy to test.
projectPath ID! Full path of the project to run the test on.

pipelineExecutionSchedulePolicyTestRun fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
testRun PolicyScheduleTestRun Test-run record created.

pipelineRetry

Input type: PipelineRetryInput

pipelineRetry arguments

Name Type Description
id CiPipelineID! ID of the pipeline to mutate.

pipelineRetry fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipeline Pipeline Pipeline after mutation.

pipelineScheduleCreate

Input type: PipelineScheduleCreateInput

pipelineScheduleCreate arguments

Name Type Description
active Boolean Indicates if the pipeline schedule should be active or not.
cron String! Cron expression of the pipeline schedule.
cronTimezone String Cron time zone supported by ActiveSupport::TimeZone. For example: Pacific Time (US & Canada) (default: UTC).
description String! Description of the pipeline schedule.
inputs [CiInputsInput!] Introduced as an experiment in GitLab 17.10.

Inputs for the pipeline schedule.
projectPath ID! Full path of the project the pipeline schedule is associated with.
ref String! Ref of the pipeline schedule.
variables [PipelineScheduleVariableInput!] Variables for the pipeline schedule.

pipelineScheduleCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipelineSchedule PipelineSchedule Created pipeline schedule.

pipelineScheduleDelete

Input type: PipelineScheduleDeleteInput

pipelineScheduleDelete arguments

Name Type Description
id CiPipelineScheduleID! ID of the pipeline schedule to mutate.

pipelineScheduleDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

pipelineSchedulePlay

Input type: PipelineSchedulePlayInput

pipelineSchedulePlay arguments

Name Type Description
id CiPipelineScheduleID! ID of the pipeline schedule to mutate.

pipelineSchedulePlay fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipelineSchedule PipelineSchedule Pipeline schedule after mutation.

pipelineScheduleTakeOwnership

Input type: PipelineScheduleTakeOwnershipInput

pipelineScheduleTakeOwnership arguments

Name Type Description
id CiPipelineScheduleID! ID of the pipeline schedule to mutate.

pipelineScheduleTakeOwnership fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipelineSchedule PipelineSchedule Updated pipeline schedule ownership.

pipelineScheduleUpdate

Input type: PipelineScheduleUpdateInput

pipelineScheduleUpdate arguments

Name Type Description
active Boolean Indicates if the pipeline schedule should be active or not.
cron String Cron expression of the pipeline schedule.
cronTimezone String Cron time zone supported by ActiveSupport::TimeZone. For example: Pacific Time (US & Canada) (default: UTC).
description String Description of the pipeline schedule.
id CiPipelineScheduleID! ID of the pipeline schedule to mutate.
inputs [CiInputsInput!] Introduced as an experiment in GitLab 17.11.

Inputs for the pipeline schedule.
ref String Ref of the pipeline schedule.
variables [PipelineScheduleVariableInput!] Variables for the pipeline schedule.

pipelineScheduleUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipelineSchedule PipelineSchedule Updated pipeline schedule.

pipelineTriggerCreate

  • Status: Experiment

Input type: PipelineTriggerCreateInput

pipelineTriggerCreate arguments

Name Type Description
description String! Description of the pipeline trigger token.
expiresAt Time Timestamp of when the pipeline trigger token expires.
projectPath ID! Full path of the project that the pipeline trigger token to mutate is in.

pipelineTriggerCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipelineTrigger PipelineTrigger Mutated pipeline trigger token.

pipelineTriggerDelete

  • Status: Experiment

Input type: PipelineTriggerDeleteInput

pipelineTriggerDelete arguments

Name Type Description
id CiTriggerID! ID of the pipeline trigger token to delete.

pipelineTriggerDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

pipelineTriggerUpdate

  • Status: Experiment

Input type: PipelineTriggerUpdateInput

pipelineTriggerUpdate arguments

Name Type Description
description String! Description of the pipeline trigger token.
id CiTriggerID! ID of the pipeline trigger token to update.

pipelineTriggerUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pipelineTrigger PipelineTrigger Mutated pipeline trigger token.

processUserBillablePromotionRequest

  • Status: Experiment

Input type: ProcessUserBillablePromotionRequestInput

processUserBillablePromotionRequest arguments

Name Type Description
status MemberApprovalStatusType! Status for the member approval request (approved, denied, pending).
userId UserID! Global ID of user to be promoted.

processUserBillablePromotionRequest fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
result UserPromotionStatusType Status of the user promotion process (success, partial_success, failed).

projectBlobsRemove

  • Status: Experiment

Input type: projectBlobsRemoveInput

projectBlobsRemove arguments

Name Type Description
blobOids [String!]! List of blob oids.
projectPath ID! Full path of the project to replace.

projectBlobsRemove fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

projectCiCdSettingsUpdate

Input type: ProjectCiCdSettingsUpdateInput

projectCiCdSettingsUpdate arguments

Name Type Description
crossProjectPushForJobTokenAllowed Boolean Indicates the ability to push to this repository using a job token from an allowlisted project.
displayPipelineVariables Boolean Indicates whether pipeline variables can be displayed in the UI.
fullPath ID! Full Path of the project the settings belong to.
groupRunnersEnabled Boolean Indicates whether group runners are enabled for the project.
inboundJobTokenScopeEnabled Boolean Indicates whether CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabled Boolean Deprecated in GitLab 16.0. Outbound job token scope is being removed. This field can now only be set to false.
keepLatestArtifact Boolean Indicates whether the latest artifact should be kept for the project.
maxPipelinesPerMergeTrain Int Maximum number of parallel pipelines per merge train.
mergePipelinesEnabled Boolean Indicates if merged results pipelines are enabled for the project.
mergeTrainEnforcement MergeTrainEnforcement Merge train enforcement level for the project.
mergeTrainsEnabled Boolean Indicates if merge trains are enabled for the project.
mergeTrainsSkipTrainAllowed Boolean Indicates whether an option is allowed to merge without refreshing the merge train. Ignored unless the merge_trains_skip_train feature flag is also enabled.
pipelineVariablesMinimumOverrideRole String Minimum role required to set variables when creating a pipeline or running a job.
pushRepositoryForJobTokenAllowed Boolean Indicates the ability to push to the original project repository using a job token.
resourceGroupDefaultProcessMode ResourceGroupsProcessMode Default process mode for resource groups in the project.
skipBranchPipelinesForMrs Boolean Indicates whether branch pipelines are skipped if a merge request is open.

projectCiCdSettingsUpdate fields

Name Type Description
ciCdSettings ProjectCiCdSetting! CI/CD settings after mutation.
errors [String!]! Errors encountered during the mutation.

projectCustomAttributeSet

  • Status: Experiment

Sets (creates or updates) a custom attribute on a project. Only available to admins.

Input type: ProjectCustomAttributeSetInput

projectCustomAttributeSet arguments

Name Type Description
key String! Key of the custom attribute.
projectPath ID! Full path of the project.
value String! Value of the custom attribute.

projectCustomAttributeSet fields

Name Type Description
customAttribute CustomAttribute Custom attribute after mutation.
errors [String!]! Errors encountered during the mutation.

projectMemberBulkUpdate

Updates multiple members of a project. To use this mutation, you must have at least the Maintainer role.

Input type: ProjectMemberBulkUpdateInput

projectMemberBulkUpdate arguments

Name Type Description
accessLevel MemberAccessLevel! Access level to update the members to.
expiresAt Time Date and time the membership expires.
projectId ProjectID! Global ID of the project.
userIds [UserID!]! Global IDs of the members.

projectMemberBulkUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projectMembers [ProjectMember!] Project members after mutation.
queuedMemberApprovals MemberApprovalConnection List of queued pending members approvals. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

projectSavedReplyCreate

  • Status: Experiment

Input type: ProjectSavedReplyCreateInput

projectSavedReplyCreate arguments

Name Type Description
content String! Content of the saved reply.
name String! Name of the saved reply.
projectId ProjectID! Project for the saved reply.

projectSavedReplyCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply ProjectSavedReply Saved reply after mutation.

projectSavedReplyDestroy

  • Status: Experiment

Input type: ProjectSavedReplyDestroyInput

projectSavedReplyDestroy arguments

Name Type Description
id ProjectsSavedReplyID! Global ID of the project-level saved reply.

projectSavedReplyDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply ProjectSavedReply Saved reply after mutation.

projectSavedReplyUpdate

  • Status: Experiment

Input type: ProjectSavedReplyUpdateInput

projectSavedReplyUpdate arguments

Name Type Description
content String! Content of the saved reply.
id ProjectsSavedReplyID! Global ID of the project-level saved reply.
name String! Name of the saved reply.

projectSavedReplyUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply ProjectSavedReply Saved reply after mutation.

projectSecretCreate

Input type: ProjectSecretCreateInput

projectSecretCreate arguments

Name Type Description
branch String! Branches that can access the secret.
description String Description of the project secret.
environment String! Environments that can access the secret.
name String! Name of the project secret.
projectPath ID! Project of the secret.
rotationIntervalDays Int Number of days between rotation reminders for the secret.
secret String! Value of the project secret.

projectSecretCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projectSecret ProjectSecret Project secret.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

projectSecretCreateFromLeakedToken

Rotates the personal access token leaked in a specified secret detection vulnerability and stores the new token as a project secret. This revokes the leaked token and creates a token with the same lifetime. The new token value is not returned. Administrators can rotate tokens for any user. Non-administrators can only rotate their own tokens. Fine-grained tokens also need the rotate_personal_access_token permission on the user boundary.

Input type: ProjectSecretCreateFromLeakedTokenInput

projectSecretCreateFromLeakedToken arguments

Name Type Description
description String Description of the project secret.
name String! Name of the project secret.
vulnerabilityId VulnerabilityID! Global ID of the secret detection vulnerability whose leaked token to rotate.

projectSecretCreateFromLeakedToken fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projectSecret ProjectSecret Project secret created to store the rotated token.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

projectSecretDelete

Input type: ProjectSecretDeleteInput

projectSecretDelete arguments

Name Type Description
name String! Name of the project secret.
projectPath ID! Project of the secret.

projectSecretDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projectSecret ProjectSecret Deleted project secret.

projectSecretUpdate

Input type: ProjectSecretUpdateInput

projectSecretUpdate arguments

Name Type Description
branch String New branches that can access the secret.
description String New description of the project secret.
environment String New environments that can access the secret.
metadataCas Int! This should match the current metadata version of the project secret being updated.
name String! Name of the project secret to update.
projectPath ID! Project of the secret.
rotationIntervalDays Int Number of days between rotation reminders for the secret.
secret String New value of the project secret.

projectSecretUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projectSecret ProjectSecret Updated project secret.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

projectSecretsManagerDeprovision

Input type: ProjectSecretsManagerDeprovisionInput

projectSecretsManagerDeprovision arguments

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

projectSecretsManagerDeprovision fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projectSecretsManager ProjectSecretsManager Project secrets manager.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

projectSecretsManagerInitialize

Input type: ProjectSecretsManagerInitializeInput

projectSecretsManagerInitialize arguments

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

projectSecretsManagerInitialize fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projectSecretsManager ProjectSecretsManager Project secrets manager.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.

projectSecretsPermissionDelete

Input type: ProjectSecretsPermissionDeleteInput

projectSecretsPermissionDelete arguments

Name Type Description
principal PrincipalInput! User/MemberRole/Role whose access is being removed.
projectPath ID! Project from which the permissions are removed.

projectSecretsPermissionDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.
secretsPermission ProjectSecretsPermission Secrets Permission that was deleted.

projectSecretsPermissionUpdate

Input type: ProjectSecretsPermissionUpdateInput

projectSecretsPermissionUpdate arguments

Name Type Description
actions [SecretsManagementAction!]! Actions that can be performed on secrets.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
principal PrincipalInput! User/MemberRole/Role that is provided access.
projectPath ID! Project to which the permissions are added.

projectSecretsPermissionUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
reason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.2.

Reason the write was denied due to entitlement; null when not denied for that reason.
secretsPermission ProjectSecretsPermission Secrets Permission that was created.

projectSecurityExclusionCreate

Input type: ProjectSecurityExclusionCreateInput

projectSecurityExclusionCreate arguments

Name Type Description
active Boolean! Whether the exclusion is active.
description String Optional description for the exclusion.
projectPath ID! Full path of the project the exclusion will be associated with.
scanner ExclusionScannerEnum! Scanner to ignore values for based on the exclusion.
type ExclusionTypeEnum! Type of the exclusion.
value String! Value of the exclusion.

projectSecurityExclusionCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityExclusion ProjectSecurityExclusion Project security exclusion created.

projectSecurityExclusionDelete

Input type: ProjectSecurityExclusionDeleteInput

projectSecurityExclusionDelete arguments

Name Type Description
id SecurityProjectSecurityExclusionID! Global ID of the exclusion to be deleted.

projectSecurityExclusionDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

projectSecurityExclusionUpdate

Input type: ProjectSecurityExclusionUpdateInput

projectSecurityExclusionUpdate arguments

Name Type Description
active Boolean Whether the exclusion is active.
description String Optional description for the exclusion.
id SecurityProjectSecurityExclusionID! Global ID of the exclusion to be updated.
scanner ExclusionScannerEnum Scanner to ignore values for based on the exclusion.
type ExclusionTypeEnum Type of the exclusion.
value String Value of the exclusion.

projectSecurityExclusionUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityExclusion ProjectSecurityExclusion Project security exclusion updated.

projectSetComplianceFramework

Deprecated in GitLab 17.11. Use mutation ProjectUpdateComplianceFrameworks instead of this.

Input type: ProjectSetComplianceFrameworkInput

projectSetComplianceFramework arguments

Name Type Description
complianceFrameworkId ComplianceManagementFrameworkID ID of the compliance framework to assign to the project. Set to null to unset.
projectId ProjectID! ID of the project to change the compliance framework of.

projectSetComplianceFramework fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Project after mutation.

projectSetContinuousVulnerabilityScanning

Deprecated in GitLab 17.3. CVS has been enabled permanently. See this epic for more information.

Input type: ProjectSetContinuousVulnerabilityScanningInput

projectSetContinuousVulnerabilityScanning arguments

Name Type Description
enable Boolean! Desired status for continuous vulnerability scanning feature.
projectPath ID! Full path of the project.

projectSetContinuousVulnerabilityScanning fields

Name Type Description
continuousVulnerabilityScanningEnabled Boolean! Whether feature is enabled.
errors [String!]! Errors encountered during the mutation.

projectSetLocked

Input type: ProjectSetLockedInput

projectSetLocked arguments

Name Type Description
filePath String! Full path to the file.
lock Boolean! Whether or not to lock the file path.
projectPath ID! Full path of the project to mutate.

projectSetLocked fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Project after mutation.

projectSettingsUpdate

  • Status: Experiment

Input type: ProjectSettingsUpdateInput

projectSettingsUpdate arguments

Name Type Description
aiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events are stored for the project.
duoAutoModeEnabled Boolean Indicates whether Duo Agent Platform auto mode is enabled for the project.
duoContextExclusionSettings DuoContextExclusionSettingsInput Settings for excluding files from Duo context.
duoFeaturesEnabled Boolean Indicates whether GitLab Duo features are enabled for the project.
duoSastFpDetectionEnabled Boolean Indicates whether SAST False Positive Detection is enabled for the project.
duoSastVrWorkflowEnabled Boolean Indicates whether SAST Vulnerability Resolution workflow is enabled for the project.
duoSecretDetectionFpEnabled Boolean Indicates whether Secret Detection False Positive Detection is enabled for the project.
fullPath ID! Full Path of the project the settings belong to.
toolApprovalForSessionEnabled Boolean Indicates whether tool approval for Duo Workflow sessions is enabled for the project.
webBasedCommitSigningEnabled Boolean Introduced as an experiment in GitLab 18.2.

Indicates whether web-based commit signing is enabled for the project.

projectSettingsUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projectSettings ProjectSetting! Project settings after mutation.

projectSubscriptionCreate

Input type: ProjectSubscriptionCreateInput

projectSubscriptionCreate arguments

Name Type Description
projectPath String! Full path of the downstream project of the Project Subscription.
upstreamPath String! Full path of the upstream project of the Project Subscription.

projectSubscriptionCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
subscription CiSubscriptionsProject Project Subscription created by the mutation.

projectSubscriptionDelete

Input type: ProjectSubscriptionDeleteInput

projectSubscriptionDelete arguments

Name Type Description
subscriptionId CiSubscriptionsProjectID! ID of the subscription to delete.

projectSubscriptionDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Project after mutation.

projectSyncFork

  • Status: Experiment

Input type: ProjectSyncForkInput

projectSyncFork arguments

Name Type Description
projectPath ID! Full path of the fork to update.
targetBranch String! Branch of the fork to merge the upstream default branch into.

projectSyncFork fields

Name Type Description
details ForkDetails Updated fork details.
errors [String!]! Errors encountered during the mutation.

projectTargetBranchRuleCreate

Input type: ProjectTargetBranchRuleCreateInput

projectTargetBranchRuleCreate arguments

Name Type Description
name String! Name for the target branch rule.
projectId ProjectID! Project ID for the target branch rule.
targetBranch String! Target branch for the target branch rule.

projectTargetBranchRuleCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
targetBranchRule ProjectTargetBranchRule Target branch rule after mutation.

projectTargetBranchRuleDestroy

Input type: ProjectTargetBranchRuleDestroyInput

projectTargetBranchRuleDestroy arguments

Name Type Description
id ProjectsTargetBranchRuleID! ID for the target branch rule.

projectTargetBranchRuleDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

projectTextReplace

  • Status: Experiment

Input type: projectTextReplaceInput

projectTextReplace arguments

Name Type Description
projectPath ID! Full path of the project to replace.
replacements [String!]! List of text patterns to replace project-wide.

projectTextReplace fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

projectTransfer

  • Status: Experiment

Input type: ProjectTransferInput

projectTransfer arguments

Name Type Description
id ProjectID! Global ID of the project to transfer.
namespaceId NamespaceID! Global ID of the target namespace.

projectTransfer fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Project after mutation.

projectUpdateComplianceFrameworks

Update compliance frameworks for a project.

Input type: ProjectUpdateComplianceFrameworksInput

projectUpdateComplianceFrameworks arguments

Name Type Description
complianceFrameworkIds [ComplianceManagementFrameworkID!]! IDs of the compliance framework to update for the project.
projectId ProjectID! ID of the project to change the compliance framework of.

projectUpdateComplianceFrameworks fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Project after mutation.

prometheusIntegrationCreate

Deprecated in GitLab 18.2. Use HttpIntegrationCreate.

Input type: PrometheusIntegrationCreateInput

prometheusIntegrationCreate arguments

Name Type Description Default
active Boolean! Whether the integration is receiving alerts.
apiUrl String Deprecated in GitLab 18.2. Feature removed in 16.0.
name String Name of the integration. "Prometheus"
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!] Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonString Example of an alert payload.
projectPath ID! Project to create the integration in.
type AlertManagementIntegrationType Type of integration to create. Cannot be changed after creation. HTTP

prometheusIntegrationCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
integration AlertManagementPrometheusIntegration Newly created integration.

prometheusIntegrationResetToken

Deprecated in GitLab 18.2. Use HttpIntegrationResetToken.

Input type: PrometheusIntegrationResetTokenInput

prometheusIntegrationResetToken arguments

Name Type Description
id IntegrationsPrometheusID! ID of the integration to mutate.

prometheusIntegrationResetToken fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
integration AlertManagementPrometheusIntegration Updated integration.

prometheusIntegrationUpdate

Deprecated in GitLab 18.2. Use HttpIntegrationUpdate.

Input type: PrometheusIntegrationUpdateInput

prometheusIntegrationUpdate arguments

Name Type Description
active Boolean Whether the integration is receiving alerts.
apiUrl String Deprecated in GitLab 18.2. Feature removed in 16.0.
id IntegrationsPrometheusID! ID of the integration to mutate.
name String Name of the integration.
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!] Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonString Example of an alert payload.

prometheusIntegrationUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
integration AlertManagementPrometheusIntegration Updated integration.

promoteToEpic

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

Input type: PromoteToEpicInput

promoteToEpic arguments

Name Type Description
groupPath ID Group the promoted epic will belong to.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

promoteToEpic fields

Name Type Description
epic Epic Epic after issue promotion.
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

refreshFindingTokenStatus

Input type: RefreshFindingTokenStatusInput

refreshFindingTokenStatus arguments

Name Type Description
vulnerabilityId VulnerabilityID! Global ID of the Vulnerability whose token status should be refreshed.

refreshFindingTokenStatus fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
findingTokenStatus VulnerabilityFindingTokenStatus Updated token status record for the given finding.

refreshSecurityFindingTokenStatus

Input type: RefreshSecurityFindingTokenStatusInput

refreshSecurityFindingTokenStatus arguments

Name Type Description
securityFindingUuid String! UUID of the Security::Finding whose token status should be refreshed (MR context).

refreshSecurityFindingTokenStatus fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
findingTokenStatus SecurityFindingTokenStatus Updated token status record for the given Security::Finding.

refreshStandardsAdherenceChecks

Input type: RefreshStandardsAdherenceChecksInput

refreshStandardsAdherenceChecks arguments

Name Type Description
groupPath ID! Group path.

refreshStandardsAdherenceChecks fields

Name Type Description
adherenceChecksStatus StandardsAdherenceChecksStatus Progress of standards adherence checks.
errors [String!]! Errors encountered during the mutation.

refreshVulnerabilityFindingTokenStatus

Input type: RefreshVulnerabilityFindingTokenStatusInput

refreshVulnerabilityFindingTokenStatus arguments

Name Type Description
vulnerabilityId VulnerabilityID! Global ID of the Vulnerability whose token status should be refreshed.

refreshVulnerabilityFindingTokenStatus fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
findingTokenStatus VulnerabilityFindingTokenStatus Updated token status record for the given Vulnerabilities::Finding.

releaseAssetLinkCreate

Input type: ReleaseAssetLinkCreateInput

releaseAssetLinkCreate arguments

Name Type Description Default
directAssetPath String Relative path for a direct asset link.
linkType ReleaseAssetLinkType Type of the asset link. OTHER
name String! Name of the asset link.
projectPath ID! Full path of the project the asset link is associated with.
tagName String! Name of the associated release’s tag.
url String! URL of the asset link.

releaseAssetLinkCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
link ReleaseAssetLink Asset link after mutation.

releaseAssetLinkDelete

Input type: ReleaseAssetLinkDeleteInput

releaseAssetLinkDelete arguments

Name Type Description
id ReleasesLinkID! ID of the release asset link to delete.

releaseAssetLinkDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
link ReleaseAssetLink Deleted release asset link.

releaseAssetLinkUpdate

Input type: ReleaseAssetLinkUpdateInput

releaseAssetLinkUpdate arguments

Name Type Description
directAssetPath String Relative path for a direct asset link.
id ReleasesLinkID! ID of the release asset link to update.
linkType ReleaseAssetLinkType Type of the asset link.
name String Name of the asset link.
url String URL of the asset link.

releaseAssetLinkUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
link ReleaseAssetLink Asset link after mutation.

releaseCreate

Creates a release. Release creates and updates are rate limited per project (release_writes_limit_per_project application setting) and per user (release_writes_limit_per_user application setting). Requests over a limit are blocked when its feature flag (rate_limit_release_writes_per_project or rate_limit_release_writes_per_user) is enabled, and only logged otherwise.

Input type: ReleaseCreateInput

releaseCreate arguments

Name Type Description
assets ReleaseAssetsInput Assets associated to the release.
description String Description (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.
name String Name of the release.
projectPath ID! Full path of the project the release is associated with.
ref String Commit SHA or branch name to use if creating a new tag.
releasedAt Time Date 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.
tagMessage String Message to use if creating a new annotated tag.
tagName String! Name of the tag to associate with the release.

releaseCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
release Release Release after mutation.
warnings [String!] Non-fatal problems encountered while creating the release. The release was still created. Returns a warning, only if the release_evidence_size_limit feature flag is enabled, when the release evidence would exceed the release_evidence_max_size_bytes application setting even without its issues: no evidence was collected, or, for an upcoming release, none is collected on its release date if it still exceeds the limit then.

releaseDelete

Input type: ReleaseDeleteInput

releaseDelete arguments

Name Type Description
projectPath ID! Full path of the project the release is associated with.
tagName String! Name of the tag associated with the release to delete.

releaseDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
release Release Deleted release.

releaseUpdate

Updates a release. Release creates and updates are rate limited per project (release_writes_limit_per_project application setting) and per user (release_writes_limit_per_user application setting). Requests over a limit are blocked when its feature flag (rate_limit_release_writes_per_project or rate_limit_release_writes_per_user) is enabled, and only logged otherwise.

Input type: ReleaseUpdateInput

releaseUpdate arguments

Name Type Description
description String Description (release notes) of the release.
milestones [String!] Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
name String Name of the release.
projectPath ID! Full path of the project the release is associated with.
releasedAt Time Release date.
tagName String! Name of the tag associated with the release.

releaseUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
release Release Release after mutation.

removeProjectFromSecurityDashboard

Input type: RemoveProjectFromSecurityDashboardInput

removeProjectFromSecurityDashboard arguments

Name Type Description
id ProjectID! ID of the project to remove from the Instance Security Dashboard.

removeProjectFromSecurityDashboard fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

repositionImageDiffNote

Repositions a DiffNote on an image (a Note where the position.positionType is "image").

Input type: RepositionImageDiffNoteInput

repositionImageDiffNote arguments

Name Type Description
id DiffNoteID! Global ID of the DiffNote to update.
position UpdateDiffImagePositionInput! Position of the note on a diff.

repositionImageDiffNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

restorePagesDeployment

  • Status: Experiment

Restores a Pages deployment that has been scheduled for deletion.

Input type: RestorePagesDeploymentInput

restorePagesDeployment arguments

Name Type Description
id PagesDeploymentID! ID of the Pages Deployment.

restorePagesDeployment fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
pagesDeployment PagesDeployment! Restored Pages Deployment.

resyncSecurityPolicies

  • Status: Experiment

Triggers a resynchronization of security policies linked to the given project or group (full_path).

Input type: ResyncSecurityPoliciesInput

resyncSecurityPolicies arguments

Name Type Description Default
fullPath String! Full path of the project or group.
relationship RelationshipType Relationship of the policies to resync. DIRECT

resyncSecurityPolicies fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

runnerAssignToProject

  • Status: Experiment

Input type: RunnerAssignToProjectInput

runnerAssignToProject arguments

Name Type Description
projectPath ID! Full path of the project to which the runner will be assigned.
runnerId CiRunnerID! ID of the runner to assign to the project .

runnerAssignToProject fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

runnerBulkPause

  • Status: Experiment

Input type: RunnerBulkPauseInput

runnerBulkPause arguments

Name Type Description
ids [CiRunnerID!]! IDs of the runners to pause or unpause.
paused Boolean! Indicates the runner is not allowed to receive jobs.

runnerBulkPause fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
updatedCount Int Number of records effectively updated. Only present if operation was performed synchronously.
updatedRunners [CiRunner!] Runners after mutation.

runnerCacheClear

Input type: RunnerCacheClearInput

runnerCacheClear arguments

Name Type Description
projectId ProjectID! Global ID of the project that will have its runner cache cleared.

runnerCacheClear fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

runnerCreate

  • Status: Experiment

Input type: RunnerCreateInput

runnerCreate arguments

Name Type Description
accessLevel CiRunnerAccessLevel Access level of the runner.
description String Description of the runner.
groupId GroupID Global ID of the group that the runner is created in (valid only for group runner).
locked Boolean Indicates the runner is locked.
maintenanceNote String Runner’s maintenance notes.
maximumTimeout Int Maximum timeout (in seconds) for jobs processed by the runner.
paused Boolean Indicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor Float Introduced as an experiment in GitLab 17.7.

Private projects’ “compute cost factor” associated with the runner (GitLab.com only).
projectId ProjectID Global ID of the project that the runner is created in (valid only for project runner).
publicProjectsMinutesCostFactor Float Introduced as an experiment in GitLab 17.7.

Public projects’ “compute cost factor” associated with the runner (GitLab.com only).
runUntagged Boolean Indicates the runner is able to run untagged jobs.
runnerType CiRunnerType! Type of the runner to create.
tagList [String!] Tags associated with the runner.
tokenExpiresAt Time Token expiration time (ISO 8601 format). Must be between 5 minutes and 21 days in the future, and cannot exceed instance/group/project limits.
tokenRotationDeadline Time Introduced as an experiment in GitLab 18.10.

Deadline for token rotation (ISO 8601 format). Requires tokenExpiresAt. Must be <= tokenExpiresAt. Setting both to the same value disables token rotation.

runnerCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
runner CiRunner Runner after mutation.

runnerDelete

Input type: RunnerDeleteInput

runnerDelete arguments

Name Type Description
id CiRunnerID! ID of the runner to delete.

runnerDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

runnerUnassignFromProject

  • Status: Experiment

Input type: RunnerUnassignFromProjectInput

runnerUnassignFromProject arguments

Name Type Description
projectPath ID! Full path of the project from which the runner will be unassigned.
runnerId CiRunnerID! ID of the runner to unassign from the project.

runnerUnassignFromProject fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

runnerUpdate

Input type: RunnerUpdateInput

runnerUpdate arguments

Name Type Description
accessLevel CiRunnerAccessLevel Access level of the runner.
active Boolean Deprecated in GitLab 14.8. Renamed. Use paused instead.
associatedProjects [ProjectID!] Projects associated with the runner. Available only for project runners.
description String Description of the runner.
id CiRunnerID! ID of the runner to update.
locked Boolean Indicates the runner is locked.
maintenanceNote String Runner’s maintenance notes.
maximumTimeout Int Maximum timeout (in seconds) for jobs processed by the runner.
paused Boolean Indicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor Float Introduced as an experiment in GitLab 17.7.

Private projects’ “compute cost factor” associated with the runner (GitLab.com only).
publicProjectsMinutesCostFactor Float Introduced as an experiment in GitLab 17.7.

Public projects’ “compute cost factor” associated with the runner (GitLab.com only).
runUntagged Boolean Indicates the runner is able to run untagged jobs.
tagList [String!] Tags associated with the runner.

runnerUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
runner CiRunner Runner after mutation.

runnersExportUsage

Input type: RunnersExportUsageInput

runnersExportUsage arguments

Name Type Description Default
fromDate ISO8601Date UTC start date of the period to report on. Defaults to the start of last full month.
fullPath ID Filter jobs by the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
maxProjectCount Int Maximum number of projects to return. All other runner usage will be attributed to an <Other projects> entry. Defaults to 1000 projects. 1000
runnerType CiRunnerType Scope of the runners to include in the report.
toDate ISO8601Date UTC end date of the period to report on. " \ “Defaults to the end of the month specified by fromDate.

runnersExportUsage fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

runnersRegistrationTokenReset

Deprecated in GitLab 17.7. Underlying feature was deprecated in 15.6 and will be removed in 18.0.

Input type: RunnersRegistrationTokenResetInput

runnersRegistrationTokenReset arguments

Name Type Description
id ID ID of the project or group to reset the token for. Omit if resetting instance runner token.
type CiRunnerType! Scope of the object to reset the token for.

runnersRegistrationTokenReset fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
token String Runner token after mutation.

safeDisablePipelineVariables

Input type: SafeDisablePipelineVariablesInput

safeDisablePipelineVariables arguments

Name Type Description
fullPath ID! Full path of the group to disable pipeline variables for.

safeDisablePipelineVariables fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
success Boolean! Indicates whether the migration was successfully enqueued.

savedReplyCreate

Input type: SavedReplyCreateInput

savedReplyCreate arguments

Name Type Description
content String! Content of the saved reply.
name String! Name of the saved reply.

savedReplyCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply SavedReply Saved reply after mutation.

savedReplyDestroy

Input type: SavedReplyDestroyInput

savedReplyDestroy arguments

Name Type Description
id UsersSavedReplyID! Global ID of the user saved reply.

savedReplyDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply SavedReply Saved reply after mutation.

savedReplyUpdate

Input type: SavedReplyUpdateInput

savedReplyUpdate arguments

Name Type Description
content String! Content of the saved reply.
id UsersSavedReplyID! Global ID of the user saved reply.
name String! Name of the saved reply.

savedReplyUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedReply SavedReply Saved reply after mutation.

scanExecutionPolicyCommit

Commits the policy_yaml content to the assigned security policy project for the given project (full_path).

Input type: ScanExecutionPolicyCommitInput

scanExecutionPolicyCommit arguments

Name Type Description
fullPath String Full path of the project.
name String! Name of the policy. If the name is null, the name field from policy_yaml is used.
operationMode MutationOperationMode! Changes the operation mode.
policyYaml String! YAML snippet of the policy.
projectPath ID Deprecated in GitLab 14.10. Use fullPath.

scanExecutionPolicyCommit fields

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

secretsManagerEnableAddOn

  • Status: Experiment

Input type: SecretsManagerEnableAddOnInput

secretsManagerEnableAddOn arguments

Name Type Description
groupPath ID! Full path of the top-level group to enable the Secrets Manager add-on for.

secretsManagerEnableAddOn fields

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

secretsManagerInstanceEnableAddOn

  • Status: Experiment

Input type: SecretsManagerInstanceEnableAddOnInput

secretsManagerInstanceEnableAddOn fields

Name Type Description
entitlement SecretsManagerEntitlement Instance-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.

secretsManagerInstanceRefreshEntitlement

  • Status: Experiment

Input type: SecretsManagerInstanceRefreshEntitlementInput

secretsManagerInstanceRefreshEntitlement fields

Name Type Description
entitlement SecretsManagerEntitlement Instance-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.

secretsManagerInstanceStartTrial

  • Status: Experiment

Input type: SecretsManagerInstanceStartTrialInput

secretsManagerInstanceStartTrial fields

Name Type Description
entitlement SecretsManagerEntitlement Instance-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.

secretsManagerRefreshEntitlement

  • Status: Experiment

Input type: SecretsManagerRefreshEntitlementInput

secretsManagerRefreshEntitlement arguments

Name Type Description
groupPath ID! Full path of the top-level group to refresh the Secrets Manager entitlement for.

secretsManagerRefreshEntitlement fields

Name Type Description
entitlement SecretsManagerEntitlement Secrets 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.

secretsManagerStartTrial

  • Status: Experiment

Input type: SecretsManagerStartTrialInput

secretsManagerStartTrial arguments

Name Type Description
groupPath ID! Full path of the top-level group to start a Secrets Manager trial for.

secretsManagerStartTrial fields

Name Type Description
entitlement SecretsManagerEntitlement Secrets 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.

securityAiFlowFeedbackCreate

  • Status: Experiment

Submits feedback on the latest AI assessment of a vulnerability, such as a false positive detection. Emits an internal event and stores nothing.

Input type: SecurityAiFlowFeedbackCreateInput

securityAiFlowFeedbackCreate arguments

Name Type Description
reasons [SecurityAiFlowFeedbackReason!] Reasons for the feedback. Only allowed when the sentiment is DISAGREE. Maximum 5 reasons.
sentiment SecurityAiFlowFeedbackSentiment! Sentiment of the feedback.
vulnerabilityId VulnerabilityID! Global ID of the vulnerability whose latest AI assessment the feedback is about.

securityAiFlowFeedbackCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

securityAttributeCreate

Input type: SecurityAttributeCreateInput

securityAttributeCreate arguments

Name Type Description
attributes [SecurityAttributeInput!]! Attributes to create.
categoryId SecurityCategoryID! Global ID of the security category.
namespaceId NamespaceID! Global ID of the namespace.

securityAttributeCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityAttributes [SecurityAttribute!] Created security attributes.

securityAttributeDestroy

Input type: SecurityAttributeDestroyInput

securityAttributeDestroy arguments

Name Type Description
id SecurityAttributeID! Global ID of the security attribute to destroy.

securityAttributeDestroy fields

Name Type Description
deletedAttributeGid SecurityAttributeID Global ID of the destroyed security attribute.
errors [String!]! Errors encountered during the mutation.

securityAttributeProjectUpdate

Input type: SecurityAttributeProjectUpdateInput

securityAttributeProjectUpdate arguments

Name Type Description
addAttributeIds [SecurityAttributeID!] Global IDs of the security attributes to add to the project.
projectId ProjectID! Global ID of the project.
removeAttributeIds [SecurityAttributeID!] Global IDs of the security attributes to remove from the project.

securityAttributeProjectUpdate fields

Name Type Description
addedCount Int Number of attributes added.
errors [String!]! Errors encountered during the mutation.
project Project Updated project.
removedCount Int Number of attributes removed.

securityAttributeUpdate

Input type: SecurityAttributeUpdateInput

securityAttributeUpdate arguments

Name Type Description
color Color Color of the security attribute.
description String Description of the security attribute.
id SecurityAttributeID! Global ID of the security attribute.
name String Name of the security attribute.

securityAttributeUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityAttribute SecurityAttribute Updated security attribute.

securityCategoryCreate

Input type: SecurityCategoryCreateInput

securityCategoryCreate arguments

Name Type Description
description String Description of the security category.
multipleSelection Boolean Whether multiple attributes can be selected.
name String! Name of the security category.
namespaceId NamespaceID! Global ID of the category namespace.

securityCategoryCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityCategory SecurityCategory Created security category.

securityCategoryDestroy

Input type: SecurityCategoryDestroyInput

securityCategoryDestroy arguments

Name Type Description
id SecurityCategoryID! Global ID of the security category to destroy.

securityCategoryDestroy fields

Name Type Description
deletedAttributesGid [SecurityAttributeID!] Global IDs of the deleted security attributes.
deletedCategoryGid SecurityCategoryID Global ID of the deleted security category.
errors [String!]! Errors encountered during the mutation.

securityCategoryUpdate

Input type: SecurityCategoryUpdateInput

securityCategoryUpdate arguments

Name Type Description
description String Description of the security category.
id SecurityCategoryID! Global ID of the security category.
name String Name of the security category.
namespaceId NamespaceID! Global ID of the category namespace.

securityCategoryUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityCategory SecurityCategory Updated security category.

securityFindingConfirm

Input type: SecurityFindingConfirmInput

securityFindingConfirm arguments

Name Type Description
comment String Comment that explains why the finding was confirmed (maximum 50,000 characters).
projectPath ID! Full path of the project the finding belongs to.
uuid String! UUID of the finding to be confirmed.

securityFindingConfirm fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityFinding PipelineSecurityReportFinding Confirmed finding.

securityFindingCreateIssue

Input type: SecurityFindingCreateIssueInput

securityFindingCreateIssue arguments

Name Type Description
project ProjectID! ID of the project to attach the issue to.
uuid String! UUID of the security finding to be used to create an issue.

securityFindingCreateIssue fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue created after mutation.

securityFindingCreateMergeRequest

Input type: SecurityFindingCreateMergeRequestInput

securityFindingCreateMergeRequest arguments

Name Type Description
uuid String! UUID of the security finding to be used to create a merge request.

securityFindingCreateMergeRequest fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
mergeRequest MergeRequest Merge Request created after mutation.

securityFindingCreateVulnerability

  • Status: Experiment

Input type: SecurityFindingCreateVulnerabilityInput

securityFindingCreateVulnerability arguments

Name Type Description
uuid String! UUID of the security finding to be used to create a vulnerability.

securityFindingCreateVulnerability fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Vulnerability created after mutation.

securityFindingDismiss

Input type: SecurityFindingDismissInput

securityFindingDismiss arguments

Name Type Description
comment String Comment why finding should be dismissed (maximum 50,000 characters).
dismissalReason VulnerabilityDismissalReason Reason why finding should be dismissed.
uuid String! UUID of the finding to be dismissed.

securityFindingDismiss fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityFinding PipelineSecurityReportFinding Dismissed finding.
uuid String UUID of dismissed finding.

securityFindingExternalIssueLinkCreate

Input type: SecurityFindingExternalIssueLinkCreateInput

securityFindingExternalIssueLinkCreate arguments

Name Type Description
externalTracker VulnerabilityExternalIssueLinkExternalTracker! External tracker type of the external issue link.
linkType VulnerabilityExternalIssueLinkType! Type of the external issue link.
project ProjectID! ID of the project to attach the issue to.
uuid String! UUID of the security finding to be used to create an issue.

securityFindingExternalIssueLinkCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalIssueLink VulnerabilityExternalIssueLink Created external issue link.

securityFindingJiraIssueFormUrlCreate

  • Status: Experiment

Input type: SecurityFindingJiraIssueFormUrlCreateInput

securityFindingJiraIssueFormUrlCreate arguments

Name Type Description
project ProjectID! ID of the project to attach the issue to.
uuid String! UUID of the security finding to be used to create an issue.

securityFindingJiraIssueFormUrlCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
jiraIssueFormUrl String URL to Jira issue creation form with pre-filled vulnerability data.

securityFindingResolve

Input type: SecurityFindingResolveInput

securityFindingResolve arguments

Name Type Description
comment String Comment that explains why the finding was resolved (maximum 50,000 characters).
projectPath ID! Full path of the project the finding belongs to.
uuid String! UUID of the finding to be resolved.

securityFindingResolve fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityFinding PipelineSecurityReportFinding Resolved finding.

securityFindingRevertToDetected

Input type: SecurityFindingRevertToDetectedInput

securityFindingRevertToDetected arguments

Name Type Description
comment String Comment that explains why the finding was reverted to detected status (maximum 50,000 characters).
uuid String! UUID of the finding to be dismissed.

securityFindingRevertToDetected fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityFinding PipelineSecurityReportFinding Finding reverted to detected.

securityFindingSeverityOverride

Input type: SecurityFindingSeverityOverrideInput

securityFindingSeverityOverride arguments

Name Type Description
severity VulnerabilitySeverity! New severity value for the finding.
uuid String! UUID of the finding to modify.

securityFindingSeverityOverride fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
securityFinding PipelineSecurityReportFinding Finding of which the severity was modified.

securityPolicyProjectAssign

Assigns the specified project(security_policy_project_id) as security policy project for the given project(full_path). If the project already has a security policy project, this reassigns the project’s security policy project with the given security_policy_project_id.

Input type: SecurityPolicyProjectAssignInput

securityPolicyProjectAssign arguments

Name Type Description
fullPath String Full path of the project or group.
projectPath ID Deprecated in GitLab 14.10. Use fullPath.
securityPolicyProjectId ProjectID! ID of the security policy project.

securityPolicyProjectAssign fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

securityPolicyProjectCreate

Creates and assigns a security policy project for the given project or group (full_path).

Input type: SecurityPolicyProjectCreateInput

securityPolicyProjectCreate arguments

Name Type Description
fullPath String Full path of the project or group.
projectPath ID Deprecated in GitLab 14.10. Use fullPath.

securityPolicyProjectCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Security Policy Project that was created.

securityPolicyProjectCreateAsync

  • Status: Experiment

Creates and assigns a security policy project for the given project or group (full_path) async.

Input type: SecurityPolicyProjectCreateAsyncInput

securityPolicyProjectCreateAsync arguments

Name Type Description
fullPath String! Full path of the project or group.

securityPolicyProjectCreateAsync fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

securityPolicyProjectUnassign

Unassigns the security policy project for the given project (full_path).

Input type: SecurityPolicyProjectUnassignInput

securityPolicyProjectUnassign arguments

Name Type Description
fullPath String Full path of the project or group.
projectPath ID Deprecated in GitLab 14.10. Use fullPath.

securityPolicyProjectUnassign fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

securityRefsTrack

  • Status: Experiment

Input type: SecurityRefsTrackInput

securityRefsTrack arguments

Name Type Description
projectPath ID! Full path of the project.
refs [SecurityRefInput!]! Array of refs to be tracked.

securityRefsTrack fields

Name Type Description
errors [String!]! Errors encountered during the operation.
trackedRefs [SecurityTrackedRef!] Refs that were successfully tracked.

securityRefsUntrack

  • Status: Experiment

Input type: SecurityRefsUntrackInput

securityRefsUntrack arguments

Name Type Description
refIds [SecurityProjectTrackedContextID!]! Global IDs of the tracked refs to stop tracking.

securityRefsUntrack fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
untrackedRefIds [ID!] Global IDs of refs that were successfully untracked.

securityScanProfileAttach

  • Status: Experiment

Attaches a security scan profile to projects and groups. All projects and groups must belong to the same top-level group. Maximum of 100 project and group IDs combined.

Input type: SecurityScanProfileAttachInput

securityScanProfileAttach arguments

Name Type Description Default
groupIds [GroupID!] Group IDs to attach the profile to. Applies the profile to all subgroups and projects in the specified group. Errors for these projects are not returned. []
mode SecurityScanProfileAttachMode How to attach the profile relative to existing profiles of the same scan type. Defaults to SET. SET
projectIds [ProjectID!] Project IDs to attach the profile to. []
securityScanProfileId SecurityScanProfileID! Security scan profile ID to attach. For a default profile, use its identifier. For example, gid://gitlab/Security::ScanProfile/sast.

securityScanProfileAttach fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

securityScanProfileCreate

  • Status: Experiment

Input type: SecurityScanProfileCreateInput

securityScanProfileCreate arguments

Name Type Description Default
description String! Description of the scan profile.
name String! Name of the scan profile.
namespaceId NamespaceID! Global ID of the top level namespace to create the scan profile for.
scanType SecurityScanProfileType! Type of the scan profile.
stripDefaults Boolean When 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. true
triggers [SecurityScanProfileTriggerInput!]! Triggers with optional configuration for the scan profile. At least one is required.

securityScanProfileCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
scanProfile ScanProfileType Created scan profile.

securityScanProfileDelete

  • Status: Experiment

Input type: SecurityScanProfileDeleteInput

securityScanProfileDelete arguments

Name Type Description
id SecurityScanProfileID! Global ID of the scan profile to delete.

securityScanProfileDelete fields

Name Type Description
deletedScanProfileId SecurityScanProfileID Global ID of the deleted scan profile.
errors [String!]! Errors encountered during the mutation.

securityScanProfileDetach

  • Status: Experiment

Detaches a security scan profile from projects and groups. All projects and groups must belong to the same top-level group. Maximum of 100 project and group IDs combined.

Input type: SecurityScanProfileDetachInput

securityScanProfileDetach arguments

Name Type Description Default
groupIds [GroupID!] Group IDs to detach the profile from. Detaches the profile from all subgroups and projects in the specified group. Errors for these projects are not returned. []
projectIds [ProjectID!] Project IDs to detach the profile from. []
securityScanProfileId SecurityScanProfileID! Security scan profile ID to detach. Must be the ID of a profile, or the identifier of a default profile, such as gid://gitlab/Security::ScanProfile/sast.

securityScanProfileDetach fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

securityScanProfileUpdate

  • Status: Experiment

Input type: SecurityScanProfileUpdateInput

securityScanProfileUpdate arguments

Name Type Description Default
description String Description of the scan profile.
id SecurityScanProfileID! Global ID of the scan profile to update.
name String Name of the scan profile.
stripDefaults Boolean When 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. true
triggers [SecurityScanProfileTriggerInput!] Complete set of triggers with optional configuration for the scan profile. When provided, triggers omitted from the list are removed, and a trigger sent without a configuration has its existing configuration removed.

securityScanProfileUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
scanProfile ScanProfileType Updated scan profile.

securityTrainingUpdate

Input type: SecurityTrainingUpdateInput

securityTrainingUpdate arguments

Name Type Description
isEnabled Boolean! Sets the training provider as enabled for the project.
isPrimary Boolean Sets the training provider as primary for the project.
projectPath ID! Full path of the project.
providerId SecurityTrainingProviderID! ID of the provider.

securityTrainingUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
training ProjectSecurityTraining Represents the training entity subject to mutation.

securityUpdateTrackedContextQuota

  • Status: Experiment

Updates the tracked security context quota for an organization.

Input type: SecurityUpdateTrackedContextQuotaInput

securityUpdateTrackedContextQuota arguments

Name Type Description
organizationId OrganizationsOrganizationID! Organization to update the quota for.
quota Int! New tracked security context quota limit for the organization.

securityUpdateTrackedContextQuota fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
quotaInfo SecurityTrackedContextQuota Updated tracked security context quota information.

setContainerScanningForRegistry

Enable/disable container scanning for registry for the given project.

Input type: SetContainerScanningForRegistryInput

setContainerScanningForRegistry arguments

Name Type Description
enable Boolean! Desired status for container scanning for registry feature.
namespacePath ID! Full path of the namespace (project).

setContainerScanningForRegistry fields

Name Type Description
containerScanningForRegistryEnabled Boolean Whether the feature is enabled.
errors [String!]! Errors encountered during the mutation.

setCvsForContainerScanning

  • Status: Experiment

Enable or disable continuous vulnerability scanning for container scanning for the given project.

Input type: SetCvsForContainerScanningInput

setCvsForContainerScanning arguments

Name Type Description
enable Boolean! Desired status for CVS for container scanning.
projectPath ID! Full path of the project.

setCvsForContainerScanning fields

Name Type Description
cvsForContainerScanningEnabled Boolean Whether CVS for container scanning is enabled.
errors [String!]! Errors encountered during the mutation.

setCvsForDependencyScanning

  • Status: Experiment

Enable or disable continuous vulnerability scanning for dependency scanning for the given project.

Input type: SetCvsForDependencyScanningInput

setCvsForDependencyScanning arguments

Name Type Description
enable Boolean! Desired status for CVS for dependency scanning.
projectPath ID! Full path of the project.

setCvsForDependencyScanning fields

Name Type Description
cvsForDependencyScanningEnabled Boolean Whether CVS for dependency scanning is enabled.
errors [String!]! Errors encountered during the mutation.

setGroupCustomAttribute

  • Status: Experiment

Creates or updates a custom attribute on a group. Only available to admins.

Input type: SetGroupCustomAttributeInput

setGroupCustomAttribute arguments

Name Type Description
groupPath ID! Full path of the group.
key String! Key of the custom attribute.
value String! Value of the custom attribute.

setGroupCustomAttribute fields

Name Type Description
customAttribute CustomAttribute Custom attribute after mutation.
errors [String!]! Errors encountered during the mutation.

setGroupSecretPushProtection

Enable or disable secret push protection for a group.

Input type: SetGroupSecretPushProtectionInput

setGroupSecretPushProtection arguments

Name Type Description
namespacePath ID! Full path of the group.
projectsToExclude [Int!] IDs of projects to exclude from the feature.
secretPushProtectionEnabled Boolean! Whether to enable the feature.

setGroupSecretPushProtection fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

setGroupValidityChecks

Enable or disable Validity Checks for a group.

Input type: SetGroupValidityChecksInput

setGroupValidityChecks arguments

Name Type Description
namespacePath ID! Full path of the group.
projectsToExclude [Int!] IDs of projects to exclude from validity checks configuration.
validityChecksEnabled Boolean! Whether to enable validity checks for all projects in the group.

setGroupValidityChecks fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
validityChecksEnabled Boolean! Indicates whether validity checks have been enabled for the group.

setLicenseConfigurationSource

Set the license information source for a given project.

Input type: SetLicenseConfigurationSourceInput

setLicenseConfigurationSource arguments

Name Type Description
projectPath ID! Full path of the project.
source SecurityPreferredLicenseSourceConfiguration! Preferred source of license information for dependencies.

setLicenseConfigurationSource fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
licenseConfigurationSource SecurityPreferredLicenseSourceConfiguration Preferred source of license information for dependencies.

setLicenseScanningForCyclonedx

Enable/disable license scanning for CycloneDX SBOM files for the given project.

Input type: SetLicenseScanningForCyclonedxInput

setLicenseScanningForCyclonedx arguments

Name Type Description
enable Boolean! Desired status for license scanning for CycloneDX files.
projectPath ID! Full path of the project.

setLicenseScanningForCyclonedx fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
licenseScanningForCyclonedxEnabled Boolean Whether license scanning for CycloneDX files is enabled.

setPagesForceHttps

Input type: SetPagesForceHttpsInput

setPagesForceHttps arguments

Name Type Description
projectPath ID! Path of the project to set the pages force HTTPS.
value Boolean! Indicates user wants to enforce HTTPS on their pages.

setPagesForceHttps fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Project that was updated.

setPagesUseUniqueDomain

Input type: SetPagesUseUniqueDomainInput

setPagesUseUniqueDomain arguments

Name Type Description
projectPath ID! Path of the project to set the pages to use unique domains.
value Boolean! Indicates user wants to use unique subdomains for their pages.

setPagesUseUniqueDomain fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
project Project Project that was updated.

setPreReceiveSecretDetection

Enable/disable secret push protection for the given project.

Input type: SetPreReceiveSecretDetectionInput

setPreReceiveSecretDetection arguments

Name Type Description
enable Boolean! Desired status for secret push protection feature.
namespacePath ID! Full path of the namespace (project).

setPreReceiveSecretDetection fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
preReceiveSecretDetectionEnabled Boolean Whether the feature is enabled.
secretPushProtectionEnabled Boolean Whether the feature is enabled.

setSecretPushProtection

Enable/disable secret push protection for the given project.

Input type: SetSecretPushProtectionInput

setSecretPushProtection arguments

Name Type Description
enable Boolean! Desired status for secret push protection feature.
namespacePath ID! Full path of the namespace (project).

setSecretPushProtection fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
preReceiveSecretDetectionEnabled Boolean Whether the feature is enabled.
secretPushProtectionEnabled Boolean Whether the feature is enabled.

setValidityChecks

Enable/disable secret detection validity checks for the given project.

Input type: SetValidityChecksInput

setValidityChecks arguments

Name Type Description
enable Boolean! Desired status for validity checks feature.
namespacePath ID! Full path of the namespace (project).

setValidityChecks fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
validityChecksEnabled Boolean Whether the feature is enabled.

starProject

  • Status: Experiment

Input type: StarProjectInput

starProject arguments

Name Type Description
projectId ProjectID! Full path of the project to star or unstar.
starred Boolean! Indicates whether to star or unstar the project.

starProject fields

Name Type Description
count String! Number of stars for the project.
errors [String!]! Errors encountered during the mutation.

startVulnerabilityWorkflow

Creates and starts a vulnerability workflow execution.

Input type: StartVulnerabilityWorkflowInput

startVulnerabilityWorkflow arguments

Name Type Description
findingUuids [String!] Finding UUIDs to process, up to 1000. If omitted, all project findings are processed.
projectId ProjectID! Global ID of the project.
severities [VulnerabilitySeverity!] Severities to process. If omitted, all severities are processed.
workflow VulnerabilityDuoWorkflow! Workflow to execute.

startVulnerabilityWorkflow fields

Name Type Description
errorReason VulnerabilityWorkflowErrorReason Machine-readable reason for the mutation error.
errors [String!]! Errors encountered during the mutation.
execution VulnerabilityWorkflowExecution Workflow execution.

tagCreate

Creates a tag in a project repository. Rate limited per project by the tags_create_limit application setting.

Input type: TagCreateInput

tagCreate arguments

Name Type Description Default
message String Tagging message. ""
name String! Name of the tag.
projectPath ID! Project full path the branch is associated with.
ref String! Tag name or commit SHA to create tag from.

tagCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
tag Tag Tag after mutation.

tagDelete

Input type: TagDeleteInput

tagDelete arguments

Name Type Description
name String! Name of the tag.
projectPath ID! Project full path the branch is associated with.

tagDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
tag Tag Tag after mutation.

terraformStateDelete

Input type: TerraformStateDeleteInput

terraformStateDelete arguments

Name Type Description
id TerraformStateID! Global ID of the Terraform state.

terraformStateDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

terraformStateDeletePermanently

  • Status: Experiment

Permanently deletes a Terraform state that is already marked for deletion.

Input type: TerraformStateDeletePermanentlyInput

terraformStateDeletePermanently arguments

Name Type Description
id TerraformStateID! Global ID of the Terraform state.

terraformStateDeletePermanently fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

terraformStateLock

Input type: TerraformStateLockInput

terraformStateLock arguments

Name Type Description
id TerraformStateID! Global ID of the Terraform state.

terraformStateLock fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

terraformStateRestore

  • Status: Experiment

Restores a soft-deleted Terraform state. The state is not restored when terraform_state_delayed_deletion is disabled.

Input type: TerraformStateRestoreInput

terraformStateRestore arguments

Name Type Description
id TerraformStateID! Global ID of the Terraform state.

terraformStateRestore fields

Name Type Description
errors [String!]! Errors encountered during restore.
terraformState TerraformState Terraform state after restore.

terraformStateUnlock

Input type: TerraformStateUnlockInput

terraformStateUnlock arguments

Name Type Description
id TerraformStateID! Global ID of the Terraform state.

terraformStateUnlock fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

timelineEventCreate

  • Status: Experiment

Input type: TimelineEventCreateInput

timelineEventCreate arguments

Name Type Description
incidentId IssueID! Incident ID of the timeline event.
note String! Text note of the timeline event.
occurredAt Time! Timestamp of when the event occurred.
timelineEventTagNames [String!] Tags for the incident timeline event.

timelineEventCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
timelineEvent TimelineEventType Timeline event.

timelineEventDestroy

Input type: TimelineEventDestroyInput

timelineEventDestroy arguments

Name Type Description
id IncidentManagementTimelineEventID! Timeline event ID to remove.

timelineEventDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
timelineEvent TimelineEventType Timeline event.

timelineEventPromoteFromNote

Input type: TimelineEventPromoteFromNoteInput

timelineEventPromoteFromNote arguments

Name Type Description
noteId NoteID! Note ID from which the timeline event promoted.

timelineEventPromoteFromNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
timelineEvent TimelineEventType Timeline event.

timelineEventTagCreate

Input type: TimelineEventTagCreateInput

timelineEventTagCreate arguments

Name Type Description
name String! Name of the tag.
projectPath ID! Project to create the timeline event tag in.

timelineEventTagCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
timelineEventTag TimelineEventTagType Timeline event tag.

timelineEventUpdate

Input type: TimelineEventUpdateInput

timelineEventUpdate arguments

Name Type Description
id IncidentManagementTimelineEventID! ID of the timeline event to update.
note String Text note of the timeline event.
occurredAt Time Timestamp when the event occurred.
timelineEventTagNames [String!] Tags for the incident timeline event.

timelineEventUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
timelineEvent TimelineEventType Timeline event.

timelogCreate

Input type: TimelogCreateInput

timelogCreate arguments

Name Type Description
issuableId IssuableID! Global ID of the issuable (Issue, WorkItem or MergeRequest).
spentAt Time Timestamp of when the time was spent. If empty, defaults to current time.
summary String! Summary of time spent.
timeSpent String! Amount of time spent.

timelogCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
timelog Timelog Timelog.

timelogDelete

Input type: TimelogDeleteInput

timelogDelete arguments

Name Type Description
id TimelogID! Global ID of the timelog.

timelogDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
timelog Timelog Timelog.

todoCreate

Input type: TodoCreateInput

todoCreate arguments

Name Type Description
noteId NoteID Introduced as an experiment in GitLab 19.5.

Global ID of a comment on the target to associate with the to-do item. Ignored when the todo_for_comment feature flag is disabled.
targetId TodoableID! Global ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported.

todoCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todo Todo To-do item created.

todoDeleteAllDone

  • Status: Experiment

Input type: TodoDeleteAllDoneInput

todoDeleteAllDone arguments

Name Type Description
updatedBefore Time To-do items marked as done before the timestamp will be deleted.

todoDeleteAllDone fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

todoDeleteMany

  • Status: Experiment

Input type: TodoDeleteManyInput

todoDeleteMany arguments

Name Type Description
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).

todoDeleteMany fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

todoMarkDone

Input type: TodoMarkDoneInput

todoMarkDone arguments

Name Type Description
id TodoID! Global ID of the to-do item to mark as done.

todoMarkDone fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todo Todo! Requested to-do item.

todoResolveMany

  • Status: Experiment

Input type: TodoResolveManyInput

todoResolveMany arguments

Name Type Description
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).

todoResolveMany fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todos [Todo!]! Resolved to-do items.

todoRestore

Input type: TodoRestoreInput

todoRestore arguments

Name Type Description
id TodoID! Global ID of the to-do item to restore.

todoRestore fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todo Todo! Requested to-do item.

todoRestoreMany

Input type: TodoRestoreManyInput

todoRestoreMany arguments

Name Type Description
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).

todoRestoreMany fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todos [Todo!]! Restored to-do items.

todoSnooze

  • Status: Experiment

Input type: TodoSnoozeInput

todoSnooze arguments

Name Type Description
id TodoID! Global ID of the to-do item to be snoozed.
snoozeUntil Time! Time until which the todo should be snoozed.

todoSnooze fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todo Todo! Requested to-do item.

todoSnoozeMany

  • Status: Experiment

Input type: TodoSnoozeManyInput

todoSnoozeMany arguments

Name Type Description
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).
snoozeUntil Time! Time until which the todos should be snoozed.

todoSnoozeMany fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todos [Todo!]! Snoozed to-do items.

todoUnSnooze

  • Status: Experiment

Input type: TodoUnSnoozeInput

todoUnSnooze arguments

Name Type Description
id TodoID! Global ID of the to-do item to be snoozed.

todoUnSnooze fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todo Todo! Requested to-do item.

todoUnsnoozeMany

  • Status: Experiment

Input type: TodoUnsnoozeManyInput

todoUnsnoozeMany arguments

Name Type Description
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).

todoUnsnoozeMany fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todos [Todo!]! Unsnoozed to-do items.

todosMarkAllDone

Input type: TodosMarkAllDoneInput

todosMarkAllDone 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.
targetId TodoableID Global 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.

todosMarkAllDone fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
todos [Todo!]! Updated to-do items.

unlinkProjectComplianceViolationIssue

Input type: UnlinkProjectComplianceViolationIssueInput

unlinkProjectComplianceViolationIssue arguments

Name Type Description
issueIid String! IID of the issue to be unlinked.
projectPath ID! Full path of the project the issue belongs to.
violationId ComplianceManagementProjectsComplianceViolationID! Global ID of the project compliance violation.

unlinkProjectComplianceViolationIssue fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
violation ProjectComplianceViolation Updated project compliance violation.

updateAiToolRule

  • Status: Experiment

Updates the permission settings for an AI tool rule.

Input type: UpdateAiToolRuleInput

updateAiToolRule arguments

Name Type Description
backgroundAccess AiBackgroundToolPermission Introduced as an experiment in GitLab 19.3.

Permission mode for the background-flow surface.
fullPath ID! Full path of the root namespace to update the tool rule for.
localAccess AiToolPermission Permission mode for local or IDE surface.
projectPath ID Full 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.
toolId String! Tool name string identifying the tool to update. For example, “create_issue”.
unsetAccessTypes [AiToolAccessType!] Introduced as an experiment in GitLab 19.5.

Access types to clear so they fall back to their defaults. The rule is deleted when every access type is unset.
webAccess AiToolPermission Permission mode for web surface.

updateAiToolRule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
toolRule AiToolRule Updated tool rule after mutation.

updateAlertStatus

Input type: UpdateAlertStatusInput

updateAlertStatus arguments

Name Type Description
iid String! IID of the alert to mutate.
projectPath ID! Project the alert to mutate is in.
status AlertManagementStatus! Status to set the alert.

updateAlertStatus fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
errors [String!]! Errors encountered during the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

updateBoard

Input type: UpdateBoardInput

updateBoard arguments

Name Type Description
assigneeId UserID ID of user to be assigned to the board.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
id BoardID! Board global ID.
iterationCadenceId IterationsCadenceID ID of iteration cadence to be assigned to the board.
iterationId IterationID ID of iteration to be assigned to the board.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
milestoneId MilestoneID ID of milestone to be assigned to the board.
name String Board name.
weight Int Weight value to be assigned to the board.

updateBoard fields

Name Type Description
board Board Board after mutation.
errors [String!]! Errors encountered during the mutation.

updateBoardEpicUserPreferences

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: UpdateBoardEpicUserPreferencesInput

updateBoardEpicUserPreferences arguments

Name Type Description
boardId BoardID! Board global ID.
collapsed Boolean! Whether the epic should be collapsed in the board.
epicId EpicID! ID of an epic to set preferences for.

updateBoardEpicUserPreferences fields

Name Type Description
epicUserPreferences BoardEpicUserPreferences User preferences for the epic in the board after mutation.
errors [String!]! Errors encountered during the mutation.

updateBoardList

Input type: UpdateBoardListInput

updateBoardList arguments

Name Type Description
collapsed Boolean Indicates if the list is collapsed for the user.
listId ListID! Global ID of the list.
position Int Position of list within the board.

updateBoardList fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
list BoardList Mutated list.

updateComplianceFramework

Input type: UpdateComplianceFrameworkInput

updateComplianceFramework arguments

Name Type Description
id ComplianceManagementFrameworkID! Global ID of the compliance framework to update.
params ComplianceFrameworkInput! Parameters to update the compliance framework with.

updateComplianceFramework fields

Name Type Description
complianceFramework ComplianceFramework Compliance framework after mutation.
errors [String!]! Errors encountered during the mutation.

updateComplianceRequirement

  • Status: Experiment

Input type: UpdateComplianceRequirementInput

updateComplianceRequirement arguments

Name Type Description
controls [ComplianceRequirementsControlInput!] Controls to add or update to the compliance requirement.
id ComplianceManagementComplianceFrameworkComplianceRequirementID! Global ID of the compliance requirement to update.
params ComplianceRequirementInput! Parameters to update the compliance requirement with.

updateComplianceRequirement fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
requirement ComplianceRequirement Compliance requirement after updation.

updateComplianceRequirementsControl

  • Status: Experiment

Input type: UpdateComplianceRequirementsControlInput

updateComplianceRequirementsControl arguments

Name Type Description
id ComplianceManagementComplianceFrameworkComplianceRequirementsControlID! Global ID of the compliance requirement control to update.
params ComplianceRequirementsControlInput! Parameters to update the compliance requirement control with.

updateComplianceRequirementsControl fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
requirementsControl ComplianceRequirementsControl Compliance requirement control after updation.

updateContainerExpirationPolicy

Input type: UpdateContainerExpirationPolicyInput

updateContainerExpirationPolicy arguments

Name Type Description
cadence ContainerExpirationPolicyCadenceEnum Schedule of the container expiration policy.
enabled Boolean Indicates whether the container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnum Number of tags to retain.
nameRegex UntrustedRegexp Tags with names matching the regex pattern will expire.
nameRegexKeep UntrustedRegexp Tags with names matching the regex pattern will be preserved.
olderThan ContainerExpirationPolicyOlderThanEnum Tags older than the given age will expire.
projectPath ID! Project path where the container expiration policy is located.

updateContainerExpirationPolicy fields

Name Type Description
containerExpirationPolicy ContainerExpirationPolicy Deprecated in GitLab 17.5. Use container_tags_expiration_policy.
containerTagsExpirationPolicy ContainerTagsExpirationPolicy Container tags expiration policy after mutation.
errors [String!]! Errors encountered during the mutation.

updateContainerProtectionRepositoryRule

Updates a container repository protection rule that controls who can modify container images based on user roles.

Input type: UpdateContainerProtectionRepositoryRuleInput

updateContainerProtectionRepositoryRule arguments

Name Type Description
id ContainerRegistryProtectionRuleID! Global ID of the container repository protection rule to be updated.
minimumAccessLevelForDelete ContainerProtectionRepositoryRuleAccessLevel Introduced as an experiment in GitLab 17.11.

Minimum GitLab access level required to delete container images from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER. Valid only when feature flag container_registry_protected_containers_delete is enabled.
minimumAccessLevelForPush ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
repositoryPathPattern String Container repository path pattern protected by the protection rule. Must start with the project’s full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project’s full path.

updateContainerProtectionRepositoryRule fields

Name Type Description
containerProtectionRepositoryRule ContainerProtectionRepositoryRule Container repository protection rule after mutation.
errors [String!]! Errors encountered during the mutation.

updateContainerProtectionTagRule

  • Status: Experiment

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

Input type: UpdateContainerProtectionTagRuleInput

updateContainerProtectionTagRule arguments

Name Type Description
id ContainerRegistryProtectionTagRuleID! Global ID of the tag protection rule to update.
minimumAccessLevelForDelete ContainerProtectionTagRuleAccessLevel Minimum 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.
minimumAccessLevelForPush ContainerProtectionTagRuleAccessLevel Minimum 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.
tagNamePattern String The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.

updateContainerProtectionTagRule fields

Name Type Description
containerProtectionTagRule ContainerProtectionTagRule Protection rule for container image tags after creation.
errors [String!]! Errors encountered during the mutation.

updateCustomDashboard

  • Status: Experiment

Updates a custom dashboard.

Input type: UpdateCustomDashboardInput

updateCustomDashboard arguments

Name Type Description
config JSON Dashboard config, validated against the analytics dashboard JSON schema.
description String Deprecated in GitLab 19.6. Use config.description.
id AnalyticsCustomDashboardsDashboardID! Global ID of the dashboard to update.
name String Deprecated in GitLab 19.6. Use config.title.

updateCustomDashboard fields

Name Type Description
dashboard CustomDashboard Updated dashboard.
errors [String!]! Errors encountered during update.

updateDependencyProxyImageTtlGroupPolicy

These settings can be adjusted only by the group Owner.

Input type: UpdateDependencyProxyImageTtlGroupPolicyInput

updateDependencyProxyImageTtlGroupPolicy arguments

Name Type Description
enabled Boolean Indicates whether the policy is enabled or disabled.
groupPath ID! Group path for the group dependency proxy image TTL policy.
ttl Int Number of days to retain a cached image file.

updateDependencyProxyImageTtlGroupPolicy fields

Name Type Description
dependencyProxyImageTtlPolicy DependencyProxyImageTtlGroupPolicy Group image TTL policy after mutation.
errors [String!]! Errors encountered during the mutation.

updateDependencyProxyPackagesSettings

Updates or creates dependency proxy for packages settings. Requires the packages and dependency proxy to be enabled in the config. Requires the packages feature to be enabled at the project level.

Input type: UpdateDependencyProxyPackagesSettingsInput

updateDependencyProxyPackagesSettings arguments

Name Type Description
enabled Boolean Indicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryPassword String Password for the external Maven packages registry. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time.
mavenExternalRegistryUrl String URL for the external Maven packages registry.
mavenExternalRegistryUsername String Username for the external Maven packages registry.
projectPath ID! Project path for the dependency proxy for packages settings.

updateDependencyProxyPackagesSettings fields

Name Type Description
dependencyProxyPackagesSetting DependencyProxyPackagesSetting Dependency proxy for packages settings after mutation.
errors [String!]! Errors encountered during the mutation.

updateDependencyProxySettings

These settings can be adjusted only by the group Owner.

Input type: UpdateDependencyProxySettingsInput

updateDependencyProxySettings arguments

Name Type Description
enabled Boolean Indicates whether the policy is enabled or disabled.
groupPath ID! Group path for the group dependency proxy.
identity String Identity 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)).
secret String Secret credential used to authenticate with Docker Hub when pulling images. Can be a password, personal access token (PAT), or organization access token (OAT).

updateDependencyProxySettings fields

Name Type Description
dependencyProxySetting DependencyProxySetting Group dependency proxy settings after mutation.
errors [String!]! Errors encountered during the mutation.

updateDuoWorkflowAgentPrivileges

  • Status: Experiment

Input type: UpdateDuoWorkflowAgentPrivilegesInput

updateDuoWorkflowAgentPrivileges 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.
workflowId AiDuoWorkflowsWorkflowID! Global ID of the workflow to update.

updateDuoWorkflowAgentPrivileges fields

Name Type Description
errors [String!]! Errors encountered during update.
workflow DuoWorkflow Updated workflow.

updateDuoWorkflowToolCallApprovals

  • Status: Experiment

Input type: UpdateDuoWorkflowToolCallApprovalsInput

updateDuoWorkflowToolCallApprovals arguments

Name Type Description
approvalSource DuoWorkflowToolCallApprovalSource Introduced as an experiment in GitLab 19.3.

Source of the approval decision, for audit purposes.
pattern String Glob pattern to approve for matching tool call arguments.
toolCallArgs JSON Arguments for the tool call.
toolName String! Name of the tool to approve.
workflowId AiDuoWorkflowsWorkflowID! Global ID of the workflow to update.

updateDuoWorkflowToolCallApprovals fields

Name Type Description
errors [String!]! Errors encountered during update.
workflow DuoWorkflow Updated workflow with new tool approvals.

updateDuoWorkflowWebSearch

  • Status: Experiment

Input type: UpdateDuoWorkflowWebSearchInput

updateDuoWorkflowWebSearch arguments

Name Type Description
webSearchEnabled Boolean! Whether web search should be enabled for the session.
workflowId AiDuoWorkflowsWorkflowID! Global ID of the workflow to update.

updateDuoWorkflowWebSearch fields

Name Type Description
errors [String!]! Errors encountered during update.
workflow DuoWorkflow Updated workflow.

updateEpic

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

Input type: UpdateEpicInput

updateEpic 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.
color Color Color of the epic.
confidential Boolean Indicates if the epic is confidential.
description String Description of the epic.
dueDateFixed String End date of the epic.
dueDateIsFixed Boolean Indicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath ID! Group the epic to mutate is in.
iid ID! 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.
startDateFixed String Start date of the epic.
startDateIsFixed Boolean Indicates start date should be sourced from start_date_fixed field not the issue milestones.
stateEvent EpicStateEvent State event for the epic.
title String Title of the epic.

updateEpic fields

Name Type Description
epic Epic Epic after mutation.
errors [String!]! Errors encountered during the mutation.

updateEpicBoardList

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: UpdateEpicBoardListInput

updateEpicBoardList arguments

Name Type Description
collapsed Boolean Indicates if the list is collapsed for the user.
listId BoardsEpicListID! Global ID of the epic list.
position Int Position of list within the board.

updateEpicBoardList fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
list EpicList Mutated epic list.

updateImageDiffNote

Updates a DiffNote on an image (a Note where the position.positionType is "image"). If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.

Input type: UpdateImageDiffNoteInput

updateImageDiffNote arguments

Name Type Description
body String Content of the note.
id NoteID! Global ID of the note to update.
position UpdateDiffImagePositionInput Position of the note on a diff.

updateImageDiffNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

updateIssue

Input type: UpdateIssueInput

updateIssue arguments

Name Type Description
addLabelIds [ID!] IDs of labels to be added to the issue.
confidential Boolean Indicates the issue is confidential.
description String Description of the issue.
dueDate ISO8601Date Due date of the issue.
epicId EpicID Deprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
healthStatus HealthStatus Desired health status.
iid String! IID of the issue to mutate.
labelIds [ID!] IDs of labels to be set. Replaces existing issue labels.
locked Boolean Indicates discussion is locked on the issue.
milestoneId ID ID 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.
projectPath ID! Project the issue to mutate is in.
removeLabelIds [ID!] IDs of labels to be removed from the issue.
stateEvent IssueStateEvent Close or reopen an issue.
timeEstimate String Estimated time to complete the issue. Use null or 0 to remove the current estimate.
title String Title of the issue.
type IssueType Type of the issue.
weight Int Weight of the issue.

updateIssue fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue after mutation.

updateIteration

Input type: UpdateIterationInput

updateIteration arguments

Name Type Description
description String Description of the iteration.
dueDate String End date of the iteration.
groupPath ID! Group of the iteration.
id ID! Global ID of the iteration.
startDate String Start date of the iteration.
title String Title of the iteration.

updateIteration fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
iteration Iteration Updated iteration.

updateNamespacePackageSettings

These settings can be adjusted only by the group Owner.

Input type: UpdateNamespacePackageSettingsInput

updateNamespacePackageSettings arguments

Name Type Description
auditEventsEnabled Boolean Indicates whether audit events are created when publishing or deleting a package in the namespace (Premium and Ultimate only).
genericDuplicateExceptionRegex UntrustedRegexp When 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.
genericDuplicatesAllowed Boolean Indicates whether duplicate generic packages are allowed for the namespace.
lockMavenPackageRequestsForwarding Boolean Indicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwarding Boolean Indicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwarding Boolean Indicates whether PyPI package forwarding is locked for all descendent namespaces.
lockRubygemsPackageRequestsForwarding Boolean Indicates whether RubyGems package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegex UntrustedRegexp When 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.
mavenDuplicatesAllowed Boolean Indicates whether duplicate Maven packages are allowed for the namespace.
mavenPackageRequestsForwarding Boolean Indicates whether Maven package forwarding is allowed for the namespace.
namespacePath ID! Namespace path where the namespace package setting is located.
npmPackageRequestsForwarding Boolean Indicates whether npm package forwarding is allowed for the namespace.
nugetDuplicateExceptionRegex UntrustedRegexp When 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.
nugetDuplicatesAllowed Boolean Indicates whether duplicate NuGet packages are allowed for the namespace.
nugetSymbolServerEnabled Boolean Indicates whether the NuGet symbol server is enabled for the namespace.
pypiPackageRequestsForwarding Boolean Indicates whether PyPI package forwarding is allowed for the namespace.
rubygemsDuplicateExceptionRegex UntrustedRegexp When rubygems_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When rubygems_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
rubygemsDuplicatesAllowed Boolean Indicates whether duplicate RubyGems packages are allowed for the namespace.
rubygemsPackageRequestsForwarding Boolean Indicates whether RubyGems package forwarding is allowed for the namespace.
terraformModuleDuplicateExceptionRegex UntrustedRegexp When 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.
terraformModuleDuplicatesAllowed Boolean Indicates whether duplicate Terraform packages are allowed for the namespace.

updateNamespacePackageSettings fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
packageSettings PackageSettings Namespace package setting after mutation.

updateNote

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

Input type: UpdateNoteInput

updateNote arguments

Name Type Description
body String Content of the note.
id NoteID! Global ID of the note to update.

updateNote fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

updatePackagesCleanupPolicy

Input type: UpdatePackagesCleanupPolicyInput

updatePackagesCleanupPolicy arguments

Name Type Description
deleteGenericPackagesNotDownloadedInDays Int Introduced as an experiment in GitLab 19.6.

Number of days after which generic packages that have not been downloaded are deleted. null when disabled. The value is ignored unless the packages_cleanup_delete_generic_not_downloaded feature flag is enabled.
keepNDuplicatedPackageFiles PackagesCleanupKeepDuplicatedPackageFilesEnum Number of duplicated package files to retain.
projectPath ID! Project path where the packages cleanup policy is located.

updatePackagesCleanupPolicy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
packagesCleanupPolicy PackagesCleanupPolicy Packages cleanup policy after mutation.

updatePackagesProtectionRule

Updates a package protection rule to restrict access to project packages. You can prevent users without certain permissions from altering packages.

Input type: UpdatePackagesProtectionRuleInput

updatePackagesProtectionRule arguments

Name Type Description
id PackagesProtectionRuleID! Global ID of the package protection rule to be updated.
minimumAccessLevelForDelete PackagesProtectionRuleAccessLevelForDelete Introduced as an experiment in GitLab 17.10.

Minimum GitLab access required to delete packages from the package registry. Valid values include OWNER or ADMIN. If the value is nil, the default minimum access level is MAINTAINER. Available only when feature flag packages_protected_packages_delete is enabled.
minimumAccessLevelForPush PackagesProtectionRuleAccessLevel Minimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
packageNamePattern String Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageType PackagesProtectionRulePackageType Package type protected by the protection rule. For example, NPM, PYPI.

updatePackagesProtectionRule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
packageProtectionRule PackagesProtectionRule Packages protection rule after mutation.

updateProjectComplianceViolation

Input type: UpdateProjectComplianceViolationInput

updateProjectComplianceViolation arguments

Name Type Description
id ComplianceManagementProjectsComplianceViolationID! Global ID of the project compliance violation to update.
status ComplianceViolationStatus! New status for the project compliance violation.

updateProjectComplianceViolation fields

Name Type Description
complianceViolation ProjectComplianceViolation Compliance violation after status update.
errors [String!]! Errors encountered during the mutation.

updateRequirement

Input type: UpdateRequirementInput

updateRequirement arguments

Name Type Description
description String Description of the requirement.
iid String Deprecated in GitLab 15.8. Use work_item_iid instead.
lastTestReportState TestReportState Creates a test report for the requirement with the given state.
projectPath ID! Full project path the requirement is associated with.
state RequirementState State of the requirement.
title String Title of the requirement.
workItemIid String IID of the requirement work item to update.

updateRequirement fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
requirement Requirement Requirement after mutation.

updateSnippet

Input type: UpdateSnippetInput

updateSnippet arguments

Name Type Description
blobActions [SnippetBlobActionInputType!] Actions to perform over the snippet repository and blobs.
description String Description of the snippet.
id SnippetID! Global ID of the snippet to update.
title String Title of the snippet.
visibilityLevel VisibilityLevelsEnum Visibility level of the snippet.

updateSnippet fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
snippet Snippet Snippet after mutation.

updateTerraformStateProtectionRule

  • Status: Experiment

Updates a protection rule for a Terraform state backend.

Input type: UpdateTerraformStateProtectionRuleInput

updateTerraformStateProtectionRule arguments

Name Type Description
allowedFrom TerraformStateProtectionRuleAllowedFrom Introduced as an experiment in GitLab 18.11.

Restriction on the source of write requests. ANYWHERE allows all sources, CI_ONLY requires a CI job token, CI_ON_PROTECTED_BRANCH_ONLY requires a CI job on a protected branch.
id TerraformStateProtectionRuleID! Global ID of the Terraform state protection rule to update.
minimumAccessLevelForWrite TerraformStateProtectionRuleAccessLevel Introduced as an experiment in GitLab 18.11.

Minimum GitLab access level required to perform write operations on the Terraform state. Valid values include DEVELOPER, MAINTAINER, OWNER, or ADMIN.
stateName String Introduced as an experiment in GitLab 18.11.

Terraform state name protected by the rule.

updateTerraformStateProtectionRule fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
terraformStateProtectionRule TerraformStateProtectionRule Introduced as an experiment in GitLab 18.11.

Terraform state protection rule after mutation.

updateVirtualRegistriesSetting

  • Status: Experiment

Updates or creates virtual registries settings for a root group.

Input type: UpdateVirtualRegistriesSettingInput

updateVirtualRegistriesSetting arguments

Name Type Description
enabled Boolean Enable or disable the virtual registries.
fullPath ID! Group path for the group virtual registries.

updateVirtualRegistriesSetting fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
virtualRegistriesSetting VirtualRegistriesSetting Virtual registries settings after mutation.

uploadCreate

  • Status: Experiment

Creates an upload (uploads a file to a project or group for use in Markdown).

Input type: UploadCreateInput

uploadCreate arguments

Name Type Description
file Upload! File to upload.
groupPath ID Full path of the group with which the resource is associated.
projectPath ID Full path of the project with which the resource is associated.

uploadCreate fields

Name Type Description
alt String Alt text for the uploaded file. Usually the name of the file.
errors [String!]! Errors encountered during the mutation.
fullPath String Full path to the file.
markdown String Markdown-formatted link to the file.
upload FileUpload Uploaded file.
url String URL to access the file.

uploadDelete

Deletes an upload.

Input type: UploadDeleteInput

uploadDelete arguments

Name Type Description
filename String! Upload filename.
groupPath ID Full path of the group with which the resource is associated.
projectPath ID Full path of the project with which the resource is associated.
secret String! Secret part of upload path.

uploadDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
upload FileUpload Deleted upload.

upsertFlatUserCap

Update the flat per-user budget cap for a subscription.

Input type: UpsertFlatUserCapInput

upsertFlatUserCap arguments

Name Type Description
flatUserCap Float! Default per-user budget cap applied to all users.
flatUserCapEnabled Boolean! Whether the flat per-user budget cap is enabled.
namespacePath String Path of the top-level group namespace. Omit for self-managed instance scope.
organizationId OrganizationsOrganizationID Introduced as an experiment in GitLab 19.6.

Global ID of the organization.

upsertFlatUserCap fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
flatUserCap Float Updated flat per-user budget cap.
flatUserCapEnabled Boolean Whether the flat per-user budget cap is enabled.

upsertUserBudgetCapOverrides

Bulk upsert per-user budget cap overrides.

Input type: UpsertUserBudgetCapOverridesInput

upsertUserBudgetCapOverrides arguments

Name Type Description
namespacePath String Path of the top-level group namespace. Omit for self-managed instance scope.
organizationId OrganizationsOrganizationID Introduced as an experiment in GitLab 19.6.

Global ID of the organization.
overrides [BudgetCapUserOverrideInput!]! List of per-user budget cap overrides to upsert.

upsertUserBudgetCapOverrides fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userOverrides [GitlabSubscriptionBudgetCapUserOverride!] Updated user budget cap overrides.

userAchievementPrioritiesUpdate

Input type: UserAchievementPrioritiesUpdateInput

userAchievementPrioritiesUpdate arguments

Name Type Description
userAchievementIds [AchievementsUserAchievementID!]! Global IDs of the user achievements being prioritized, ordered from highest to lowest priority.

userAchievementPrioritiesUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userAchievements [UserAchievement!]! Updated user achievements.

userAchievementsDelete

Input type: UserAchievementsDeleteInput

userAchievementsDelete arguments

Name Type Description
userAchievementId AchievementsUserAchievementID! Global ID of the user achievement being deleted.

userAchievementsDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userAchievement UserAchievement Deleted user achievement.

userAchievementsUpdate

Input type: UserAchievementsUpdateInput

userAchievementsUpdate arguments

Name Type Description
awardMessage String Message to associate with the awarded achievement.
showOnProfile Boolean Indicates whether or not the user achievement is visible on the profile.
userAchievementId AchievementsUserAchievementID! Global ID of the user achievement being updated.

userAchievementsUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userAchievement UserAchievement Achievement award.

userAddOnAssignmentBulkCreate

Input type: UserAddOnAssignmentBulkCreateInput

userAddOnAssignmentBulkCreate arguments

Name Type Description
addOnPurchaseId GitlabSubscriptionsAddOnPurchaseID! Global ID of AddOnPurchase to be assigned to.
userIds [UserID!]! Global IDs of user to be assigned.

userAddOnAssignmentBulkCreate fields

Name Type Description
addOnPurchase AddOnPurchase AddOnPurchase state after mutation.
errors [String!]! Errors encountered during the mutation.
users AddOnUserConnection Users who the add-on purchase was assigned to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

userAddOnAssignmentBulkRemove

Input type: UserAddOnAssignmentBulkRemoveInput

userAddOnAssignmentBulkRemove arguments

Name Type Description
addOnPurchaseId GitlabSubscriptionsAddOnPurchaseID! Global ID of AddOnPurchase to be unassigned from.
userIds [UserID!]! Global IDs of user to be unassigned.

userAddOnAssignmentBulkRemove fields

Name Type Description
addOnPurchase AddOnPurchase AddOnPurchase state after mutation.
errors [String!]! Errors encountered during the mutation.
users AddOnUserConnection Users who was unassigned from the add-on purchase. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

userAddOnAssignmentCreate

Input type: UserAddOnAssignmentCreateInput

userAddOnAssignmentCreate arguments

Name Type Description
addOnPurchaseId GitlabSubscriptionsAddOnPurchaseID! Global ID of AddOnPurchase to be assigned to.
userId UserID! Global ID of user to be assigned.

userAddOnAssignmentCreate fields

Name Type Description
addOnPurchase AddOnPurchase AddOnPurchase state after mutation.
errors [String!]! Errors encountered during the mutation.
user AddOnUser User who the add-on purchase was assigned to.

userAddOnAssignmentRemove

Input type: UserAddOnAssignmentRemoveInput

userAddOnAssignmentRemove arguments

Name Type Description
addOnPurchaseId GitlabSubscriptionsAddOnPurchaseID! Global ID of AddOnPurchase assignment belongs to.
userId UserID! Global ID of user whose assignment will be removed.

userAddOnAssignmentRemove fields

Name Type Description
addOnPurchase AddOnPurchase AddOnPurchase state after mutation.
errors [String!]! Errors encountered during the mutation.
user AddOnUser User that the add-on was removed from.

userCalloutCreate

Input type: UserCalloutCreateInput

userCalloutCreate arguments

Name Type Description
featureName String! Feature name you want to dismiss the callout for.

userCalloutCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userCallout UserCallout! User callout dismissed.

userCalloutDelete

  • Status: Experiment

Input type: UserCalloutDeleteInput

userCalloutDelete arguments

Name Type Description
featureName String! Feature name of the callout dismissal to delete.

userCalloutDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userCallout UserCallout User callout deleted. Null if the callout was not dismissed.

userCustomAttributeSet

  • Status: Experiment

Creates or updates a custom attribute on a user. Only available to admins.

Input type: UserCustomAttributeSetInput

userCustomAttributeSet arguments

Name Type Description
key String! Key of the custom attribute.
userId UserID! Global ID of the user.
value String! Value of the custom attribute.

userCustomAttributeSet fields

Name Type Description
customAttribute CustomAttribute Custom attribute after mutation.
errors [String!]! Errors encountered during the mutation.

userGroupCalloutCreate

Input type: UserGroupCalloutCreateInput

userGroupCalloutCreate arguments

Name Type Description
featureName String! Feature name you want to dismiss the callout for.
groupId GroupID! Group for the callout.

userGroupCalloutCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userGroupCallout UserGroupCallout! User group callout dismissed.

userPreferencesUpdate

Input type: UserPreferencesUpdateInput

userPreferencesUpdate arguments

Name Type Description
duoDefaultNamespaceId Int Default namespace context for Duo features when namespace can not be inferred.
emojiSkinTone EmojiSkinTone Introduced as an experiment in GitLab 19.6.

Default skin tone for emoji that have skin tone variants.
extensionsMarketplaceOptInStatus ExtensionsMarketplaceOptInStatus Status of the Web IDE Extension Marketplace opt-in for the user.
firstDayOfWeek UserFirstDayOfWeek First day of the week in calendars and date pickers. Set to null to use the instance default.
issuesSort IssueSort Sort order for issue lists.
knowledgeGraphGoverningNamespaceId Int Governing and billing namespace for Orbit.
mergeRequestDashboardListType MergeRequestsDashboardListType Merge request dashboard list rendering type.
mergeRequestDashboardShowDrafts Boolean Show draft merge requests on the merge request dashboard.
mergeRequestsSort MergeRequestSort Sort order for issue lists.
orbitSettings JSON Introduced as an experiment in GitLab 19.0.

Orbit agent settings, e.g.: “{ enabled: false }”.
organizationGroupsProjectsDisplay OrganizationGroupProjectDisplay Introduced as an experiment in GitLab 17.2.

Default list view for organization groups and projects.
organizationGroupsProjectsSort OrganizationGroupProjectSort Introduced as an experiment in GitLab 17.2.

Sort order for organization groups and projects.
projectsSort ProjectSort Sort order for projects.
sidebarNavigationMode SidebarNavigationMode Introduced as an experiment in GitLab 19.6.

Navigation mode of the left sidebar. Applies only when the hide_unpinned_sidebar_items feature flag is enabled; otherwise the sidebar shows all navigation categories.
useWorkItemsView Boolean Deprecated in GitLab 19.5. Work item view is always used.
visibilityPipelineIdType VisibilityPipelineIdType Determines whether the pipeline list shows ID or IID.
wikiUseAutoCommitMessage Boolean Introduced as an experiment in GitLab 18.10.

Whether to skip the commit message modal and use the auto-generated commit message when saving changes to a wiki document.
workItemsDisplaySettings JSON Introduced as an experiment in GitLab 18.1.

Display settings for the work item lists, e.g.: “{ shouldOpenItemsInSidePanel: false }”.

userPreferencesUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userPreferences UserPreferences User preferences after mutation.

userSetNamespaceCommitEmail

Input type: UserSetNamespaceCommitEmailInput

userSetNamespaceCommitEmail arguments

Name Type Description
emailId EmailID ID of the email to set.
namespaceId NamespaceID! ID of the namespace to set the namespace commit email for.

userSetNamespaceCommitEmail fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespaceCommitEmail NamespaceCommitEmail User namespace commit email after mutation.

valueStreamCreate

  • Status: Experiment

Creates a value stream.

Input type: ValueStreamCreateInput

valueStreamCreate arguments

Name Type Description
name String! Value stream name.
namespacePath ID! Full path of the namespace(project or group) the value stream is created in.
setting ValueStreamSettingInput Value stream configuration.
stages [CreateValueStreamStageInput!] Value stream stages.

valueStreamCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
valueStream ValueStream Created value stream.

valueStreamDestroy

  • Status: Experiment

Destroy a value stream.

Input type: ValueStreamDestroyInput

valueStreamDestroy arguments

Name Type Description
id AnalyticsCycleAnalyticsValueStreamID! Global ID of the value stream to destroy.

valueStreamDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
valueStream ValueStream Value stream deleted after mutation.

valueStreamUpdate

  • Status: Experiment

Updates a value stream.

Input type: ValueStreamUpdateInput

valueStreamUpdate arguments

Name Type Description
id AnalyticsCycleAnalyticsValueStreamID! Global ID of the value stream to update.
name String Value stream name.
setting ValueStreamSettingInput Value stream configuration.
stages [UpdateValueStreamStageInput!] Value stream stages.

valueStreamUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
valueStream ValueStream Updated value stream.

verifiedNamespaceCreate

Create a verified namespace and mark all child catalog resources with the passed verification level info.

Input type: VerifiedNamespaceCreateInput

verifiedNamespaceCreate arguments

Name Type Description
namespacePath ID! Root namespace path.
verificationLevel CiCatalogResourceVerificationLevel! Verification level for a root namespace.

verifiedNamespaceCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

virtualRegistriesCleanupPolicyUpsert

  • Status: Experiment

Create or update virtual registries cleanup policy for a root group.

Input type: VirtualRegistriesCleanupPolicyUpsertInput

virtualRegistriesCleanupPolicyUpsert arguments

Name Type Description
cadence Int Job cadence for the cleanup process. Allowed values are 1, 7, 14, 30, 90. Default is 7.
enabled Boolean Enable or disable the virtual registries cleanup policy. Default is false.
fullPath ID! Group path for the group virtual registries.
keepNDaysAfterDownload Int Keep packages for the period after download. Range is 1-365. Default is 30.
notifyOnFailure Boolean Whether to notify group owners when cleanup runs fail. Default is false.
notifyOnSuccess Boolean Whether to notify group owners when cleanup runs succeed. Default is false.

virtualRegistriesCleanupPolicyUpsert fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
virtualRegistriesCleanupPolicy VirtualRegistryCleanupPolicy Virtual registries cleanup policy after mutation.

vulnerabilitiesArchive

  • Status: Experiment

Input type: VulnerabilitiesArchiveInput

vulnerabilitiesArchive arguments

Name Type Description
date Date! Last update date of vulnerabilities being archived.
projectId ProjectID! ID of the project to attach the vulnerability to.

vulnerabilitiesArchive fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
status String! Status of the action.

vulnerabilitiesCreateIssue

  • Status: Experiment

Input type: VulnerabilitiesCreateIssueInput

vulnerabilitiesCreateIssue arguments

Name Type Description
project ProjectID! 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.

vulnerabilitiesCreateIssue fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issue Issue Issue created after mutation.

vulnerabilitiesDismiss

Input type: VulnerabilitiesDismissInput

vulnerabilitiesDismiss arguments

Name Type Description
comment String Comment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReason VulnerabilityDismissalReason Reason why vulnerability should be dismissed.
vulnerabilityIds [VulnerabilityID!]! IDs of the vulnerabilities to be dismissed (maximum 100 entries).

vulnerabilitiesDismiss fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerabilities [Vulnerability!]! Vulnerabilities after state change.

vulnerabilitiesRemoveAllFromProject

Remove all Vulnerabilities and related information from a given project. Introduced in GitLab 16.7.

Input type: VulnerabilitiesRemoveAllFromProjectInput

vulnerabilitiesRemoveAllFromProject 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.
resolvedOnDefaultBranch Boolean When set as true, deletes only the vulnerabilities no longer detected. When set as false, deletes only the vulnerabilities still detected.

vulnerabilitiesRemoveAllFromProject fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
projects [Project!]! Projects for which the deletion was scheduled.

vulnerabilitiesSeverityOverride

Input type: vulnerabilitiesSeverityOverrideInput

vulnerabilitiesSeverityOverride arguments

Name Type Description
comment String! Comment why vulnerability severity was changed. Cannot be blank (maximum 50,000 characters).
severity VulnerabilitySeverity! New severity value for the severities.
vulnerabilityIds [VulnerabilityID!]! IDs of the vulnerabilities for which severity needs to be changed (maximum 100 entries).

vulnerabilitiesSeverityOverride fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerabilities [Vulnerability!]! Vulnerabilities after severity change.

vulnerabilityAutoRemediation

  • Status: Experiment

Triggers automated remediation for a single vulnerability. Currently supports dependency (SCA) vulnerabilities, where a remediation merge request is created asynchronously when a fix is available; other report types return UNSUPPORTED.

Input type: VulnerabilityAutoRemediationInput

vulnerabilityAutoRemediation arguments

Name Type Description
vulnerabilityId VulnerabilityID! ID of the vulnerability to remediate.

vulnerabilityAutoRemediation fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
status VulnerabilityAutoRemediationStatus Outcome of triggering auto-remediation.

vulnerabilityConfirm

Input type: VulnerabilityConfirmInput

vulnerabilityConfirm arguments

Name Type Description
comment String Comment why vulnerability was confirmed (maximum 50,000 characters).
id VulnerabilityID! ID of the vulnerability to be confirmed.

vulnerabilityConfirm fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Vulnerability after state change.

vulnerabilityCreate

Input type: VulnerabilityCreateInput

vulnerabilityCreate arguments

Name Type Description Default
confirmedAt Time Timestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is confirmed).
description String! Long text section that describes the vulnerability in more detail.
detectedAt Time Timestamp of when the vulnerability was first detected (defaults to creation time).
dismissedAt Time Timestamp 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.
name String! Name of the vulnerability.
project ProjectID! ID of the project to attach the vulnerability to.
projectTrackedContext ProjectTrackedContextInput Tracked context to associate with the vulnerability.
resolvedAt Time Timestamp of when the vulnerability state changed to resolved (defaults to creation time if status is resolved).
scanner VulnerabilityScannerInput! Information about the scanner used to discover the vulnerability.
severity VulnerabilitySeverity Severity of the vulnerability (defaults to unknown). UNKNOWN
solution String Instructions for how to fix the vulnerability.
state VulnerabilityState State of the vulnerability (defaults to detected). DETECTED

vulnerabilityCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Vulnerability created.

vulnerabilityDismiss

Input type: VulnerabilityDismissInput

vulnerabilityDismiss arguments

Name Type Description
comment String Comment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReason VulnerabilityDismissalReason Reason why vulnerability should be dismissed.
id VulnerabilityID! ID of the vulnerability to be dismissed.

vulnerabilityDismiss fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Vulnerability after state change.

vulnerabilityDismissFalsePositiveFlag

  • Status: Experiment

Dismiss a vulnerability false positive flag.

Input type: VulnerabilityDismissFalsePositiveFlagInput

vulnerabilityDismissFalsePositiveFlag arguments

Name Type Description
id VulnerabilityID! ID of the vulnerability to dismiss false positive flag for.

vulnerabilityDismissFalsePositiveFlag fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Vulnerability after dismissing false positive flag.

vulnerabilityExternalIssueLinkCreate

Input type: VulnerabilityExternalIssueLinkCreateInput

vulnerabilityExternalIssueLinkCreate arguments

Name Type Description
externalTracker VulnerabilityExternalIssueLinkExternalTracker! External tracker type of the external issue link.
id VulnerabilityID! ID of the vulnerability.
linkType VulnerabilityExternalIssueLinkType! Type of the external issue link.

vulnerabilityExternalIssueLinkCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
externalIssueLink VulnerabilityExternalIssueLink Created external issue link.

vulnerabilityExternalIssueLinkDestroy

Input type: VulnerabilityExternalIssueLinkDestroyInput

vulnerabilityExternalIssueLinkDestroy arguments

Name Type Description
id VulnerabilitiesExternalIssueLinkID! Global ID of the vulnerability external issue link.

vulnerabilityExternalIssueLinkDestroy fields

Name Type Description
errors [String!]! Errors encountered during the mutation.

vulnerabilityIssueLinkCreate

Input type: VulnerabilityIssueLinkCreateInput

vulnerabilityIssueLinkCreate arguments

Name Type Description
issueId IssueID! ID of the issue to link to.
vulnerabilityIds [VulnerabilityID!]! IDs of vulnerabilities to link to the given issue. Up to 100 can be provided.

vulnerabilityIssueLinkCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
issueLinks [VulnerabilityIssueLink!] Created issue links.

vulnerabilityLinkMergeRequest

  • Status: Experiment

Link a merge request to a vulnerability.

Input type: VulnerabilityLinkMergeRequestInput

vulnerabilityLinkMergeRequest arguments

Name Type Description
mergeRequestId MergeRequestID! ID of the merge request.
readinessScore Float Confidence 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.
vulnerabilityId VulnerabilityID! ID of the vulnerability.

vulnerabilityLinkMergeRequest fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Updated vulnerability.

vulnerabilityResolve

Input type: VulnerabilityResolveInput

vulnerabilityResolve arguments

Name Type Description
comment String Comment why vulnerability was resolved (maximum 50,000 characters).
id VulnerabilityID! ID of the vulnerability to be resolved.

vulnerabilityResolve fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Vulnerability after state change.

vulnerabilityRevertToDetected

Input type: VulnerabilityRevertToDetectedInput

vulnerabilityRevertToDetected arguments

Name Type Description
comment String Comment why vulnerability was reverted to detected (maximum 50,000 characters).
id VulnerabilityID! ID of the vulnerability to be reverted to detected.

vulnerabilityRevertToDetected fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Vulnerability after state change.

vulnerabilityUnlinkMergeRequest

  • Status: Experiment

Unlink a merge request from a vulnerability.

Input type: VulnerabilityUnlinkMergeRequestInput

vulnerabilityUnlinkMergeRequest arguments

Name Type Description
mergeRequestId MergeRequestID! ID of the merge request.
vulnerabilityId VulnerabilityID! ID of the vulnerability.

vulnerabilityUnlinkMergeRequest fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
vulnerability Vulnerability Updated vulnerability.

wikiPageSubscribe

  • Status: Experiment

Input type: WikiPageSubscribeInput

wikiPageSubscribe arguments

Name Type Description
id WikiPageMetaID! Global ID of the wiki page meta record.
subscribed Boolean! Desired state of the subscription.

wikiPageSubscribe fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
wikiPage WikiPage Wiki page after mutation.

workItemAddClosingMergeRequest

  • Status: Experiment

Adds a closing merge request to a work item.

Input type: WorkItemAddClosingMergeRequestInput

workItemAddClosingMergeRequest arguments

Name Type Description
contextNamespacePath ID Full 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.
id WorkItemID! Global ID of the work item.
mergeRequestReference String! Merge request reference (short, full or URL). Example: !1, project_full_path!1 or https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1.

workItemAddClosingMergeRequest fields

Name Type Description
closingMergeRequest WorkItemClosingMergeRequest Closing merge request added to the work item.
errors [String!]! Errors encountered during the mutation.
workItem WorkItem Work item with new closing merge requests.

workItemAddLinkedItems

  • Status: Experiment

Add linked items to the work item.

Input type: WorkItemAddLinkedItemsInput

workItemAddLinkedItems arguments

Name Type Description
id WorkItemID! Global ID of the work item.
linkType WorkItemRelatedLinkType Type of link. Defaults to RELATED.
workItemsIds [WorkItemID!]! Global IDs of the items to link. Maximum number of IDs you can provide: 10.

workItemAddLinkedItems fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
message String Linked items update result message.
workItem WorkItem Updated work item.

workItemAvailabilityToggle

  • Status: Experiment

Enables or disables a work item type for a namespace.

Input type: WorkItemAvailabilityToggleInput

workItemAvailabilityToggle arguments

Name Type Description
action WorkItemAvailabilityAction! Whether to enable or disable the work item type.
fullPath ID! Full path of the group or project.
scope WorkItemAvailabilityScope! Whether to apply to the namespace or propagate to all existing children.
workItemTypeId WorkItemsTypeID! Global ID of the work item type.

workItemAvailabilityToggle fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItemType WorkItemType Work item type after the availability change.

workItemBulkMove

  • Status: Experiment

Moves work items between projects or groups.

Input type: WorkItemBulkMoveInput

workItemBulkMove 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.
sourceFullPath String! Full path of the source namespace. For example, gitlab-org/gitlab-foss.
targetFullPath String! Full path of the target namespace. For example, gitlab-org/gitlab-foss. User paths are not supported.

workItemBulkMove fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
movedWorkItemCount Int Number of work items that were successfully moved.

workItemBulkUpdate

  • Status: Experiment

Allows updating several properties for a set of work items.

Input type: WorkItemBulkUpdateInput

workItemBulkUpdate arguments

Name Type Description
assigneesWidget WorkItemWidgetAssigneesInput Introduced as an experiment in GitLab 18.2.

Input for assignees widget.
confidential Boolean Introduced as an experiment in GitLab 18.2.

Sets the work item confidentiality.
fullPath ID! Full path of the project or group containing the work items that will be updated. User paths are not supported.
healthStatusWidget WorkItemWidgetHealthStatusInput Introduced as an experiment in GitLab 18.2.

Input for health status widget.
hierarchyWidget WorkItemWidgetHierarchyCreateInput Introduced as an experiment in GitLab 18.2.

Input for hierarchy widget.
ids [WorkItemID!]! Global ID array of the work items that will be updated. IDs that the user can’t update will be ignored. A max of 100 can be provided.
iterationWidget WorkItemWidgetIterationInput Introduced as an experiment in GitLab 18.2.

Input for iteration widget.
labelsWidget WorkItemWidgetLabelsUpdateInput Input for labels widget.
milestoneWidget WorkItemWidgetMilestoneInput Introduced as an experiment in GitLab 18.2.

Input for milestone widget.
stateEvent WorkItemStateEvent Introduced as an experiment in GitLab 18.2.

Close or reopen multiple work items at once.
statusWidget WorkItemWidgetStatusInput Introduced as an experiment in GitLab 18.3.

Input for status widget.
subscriptionEvent WorkItemSubscriptionEvent Introduced as an experiment in GitLab 18.2.

Subscribe or unsubscribe from the work items.

workItemBulkUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
updatedWorkItemCount Int Number of work items that were successfully updated.

workItemConvert

  • Status: Experiment

Converts the work item to a new type.

Input type: WorkItemConvertInput

workItemConvert arguments

Name Type Description
id WorkItemID! Global ID of the work item.
workItemTypeId WorkItemsTypeID! Global ID of the new work item type.

workItemConvert fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItem WorkItem Updated work item.

workItemCreate

  • Status: Experiment

Creates a work item.

Input type: WorkItemCreateInput

workItemCreate arguments

Name Type Description
agentPlanWidget WorkItemWidgetAgentPlanInput Introduced as an experiment in GitLab 19.0.

Input for agent plan widget.
assigneesWidget WorkItemWidgetAssigneesInput Input for assignees widget.
colorWidget WorkItemWidgetColorInput Input for color widget.
confidential Boolean Sets the work item confidentiality.
createSource String Source which triggered the creation of the work item. Used only for tracking purposes.
createdAt Time Timestamp when the work item was created. Available only for admins and project owners.
crmContactsWidget WorkItemWidgetCrmContactsCreateInput Input for CRM contacts widget.
customFieldsWidget [WorkItemWidgetCustomFieldValueInputType!] Introduced as an experiment in GitLab 17.10.

Input for custom fields widget.
description String Deprecated in GitLab 16.9. use description widget instead.
descriptionWidget WorkItemWidgetDescriptionInput Input for description widget.
developmentWidget WorkItemWidgetDevelopmentCreateInput Input for development widget.
discussionsToResolve WorkItemResolveDiscussionsInput Information required to resolve discussions in a noteable, when the work item is created.
healthStatusWidget WorkItemWidgetHealthStatusInput Input for health status widget.
hierarchyWidget WorkItemWidgetHierarchyCreateInput Input for hierarchy widget.
iterationWidget WorkItemWidgetIterationInput Iteration widget of the work item.
labelsWidget WorkItemWidgetLabelsCreateInput Input for labels widget.
linkedItemsWidget WorkItemWidgetLinkedItemsCreateInput Input for linked items widget.
milestoneWidget WorkItemWidgetMilestoneInput Input for milestone widget.
namespacePath ID Full path of the namespace(project or group) the work item is created in.
projectPath ID Deprecated in GitLab 15.10. Please use namespacePath instead. That will cover for both projects and groups.
severityWidget WorkItemWidgetSeverityInput Introduced as an experiment in GitLab 19.6.

Input for severity widget.
startAndDueDateWidget WorkItemWidgetStartAndDueDateUpdateInput Input for start and due date widget.
statusWidget WorkItemWidgetStatusInput Introduced as an experiment in GitLab 17.11.

Input for status widget.
title String! Title of the work item.
vulnerabilityId VulnerabilityID Introduced as an experiment in GitLab 17.9.

Input for linking an existing vulnerability to created work item.
weightWidget WorkItemWidgetWeightInput Input for weight widget.
workItemTypeId WorkItemsTypeID! Global ID of a work item type.

workItemCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItem WorkItem Created work item.

workItemCreateFromTask

  • Status: Experiment

Creates a work item from a task in another work item’s description.

Input type: WorkItemCreateFromTaskInput

workItemCreateFromTask arguments

Name Type Description
id WorkItemID! Global ID of the work item.
workItemData WorkItemConvertTaskInput! Arguments necessary to convert a task into a work item.

workItemCreateFromTask fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
newWorkItem WorkItem New work item created from task.
workItem WorkItem Updated work item.

workItemDecisionArchive

  • Status: Experiment

Archives 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

workItemDecisionArchive arguments

Name Type Description
id WorkItemsDecisionID! Global ID of the decision.

workItemDecisionArchive fields

Name Type Description
decision WorkItemDecision Decision after mutation.
errors [String!]! Errors encountered during the mutation.

workItemDecisionCreate

  • Status: Experiment

Records a decision in the decision log of a work item.

Input type: WorkItemDecisionCreateInput

workItemDecisionCreate arguments

Name Type Description
description String Context of the decision.
discussionId DiscussionID Global ID of the originating discussion thread.
options [WorkItemDecisionOptionInput!] Candidate options of the decision. Maximum of 5 options. Incompatible with resolution.
question String Question being decided. Required unless resolution is provided.
resolution WorkItemDecisionResolutionInput When present, records the decision as resolved at creation. Incompatible with options.
sourceLink String URL of the comment, discussion, or external resource that prompted the decision.
title String Deprecated in GitLab 19.6. Use question.
workItemId WorkItemID! Global ID of the work item.

workItemDecisionCreate fields

Name Type Description
decision WorkItemDecision Decision after mutation.
errors [String!]! Errors encountered during the mutation.

workItemDecisionDelete

  • Status: Experiment

Deletes 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

workItemDecisionDelete arguments

Name Type Description
id WorkItemsDecisionID! Global ID of the decision.

workItemDecisionDelete fields

Name Type Description
decision WorkItemDecision Deleted decision.
errors [String!]! Errors encountered during the mutation.

workItemDecisionResolve

  • Status: Experiment

Resolves a decision in the decision log of a work item.

Input type: WorkItemDecisionResolveInput

workItemDecisionResolve arguments

Name Type Description
id WorkItemsDecisionID! Global ID of the decision.
resolutionRationale String Reasoning for the resolution.
resolvingNoteId NoteID Global ID of the comment that resolved the decision.
selectedOptionContent String Content 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.

workItemDecisionResolve fields

Name Type Description
decision WorkItemDecision Decision after mutation.
errors [String!]! Errors encountered during the mutation.

workItemDecisionUpdate

  • Status: Experiment

Updates a decision in the decision log of a work item.

Input type: WorkItemDecisionUpdateInput

workItemDecisionUpdate arguments

Name Type Description
description String Context of the decision.
discussionId DiscussionID Global ID of the originating discussion thread.
id WorkItemsDecisionID! Global ID of the decision.
options [WorkItemDecisionOptionUpdateInput!] Existing options of the decision to update. Maximum of 6 options.
question String Question being decided.
resolutionRationale String Reasoning for the resolution. Can only be updated on resolved decisions.
resolvedById UserID Global ID of the user who resolved the decision. Can only be updated on resolved decisions.
resolvingNoteId NoteID Global ID of the comment that resolved the decision. Can only be updated on resolved decisions.
selectedOptionContent String Content 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.
sourceLink String URL of the comment, discussion, or external resource that prompted the decision.
title String Deprecated in GitLab 19.6. Use question.

workItemDecisionUpdate fields

Name Type Description
decision WorkItemDecision Decision after mutation.
errors [String!]! Errors encountered during the mutation.

workItemDelete

  • Status: Experiment

Deletes a work item.

Input type: WorkItemDeleteInput

workItemDelete arguments

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

workItemDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
namespace Namespace Namespace the deleted work item belonged to.
project Project Deprecated in GitLab 16.9. Use namespace.

workItemEnableAiPlanning

  • Status: Experiment

Enables AI planning for a work item. Once enabled, AI planning cannot be disabled.

Input type: WorkItemEnableAiPlanningInput

workItemEnableAiPlanning arguments

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

workItemEnableAiPlanning fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItem WorkItem Work item after mutation.

workItemExport

Deprecated in GitLab 18.0. Use WorkItemsCsvExport.

Input type: WorkItemExportInput

workItemExport arguments

Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername String Filter work items by author username.
closedAfter Time Work items closed after the date.
closedBefore Time Work items closed before the date.
confidential Boolean Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter Time Work items created after the timestamp.
createdBefore Time Work items created before the timestamp.
crmContactId String Filter by ID of CRM contact.
crmOrganizationId String Filter by ID of CRM contact organization.
dueAfter Time Work items due after the timestamp.
dueBefore Time Work items due before the timestamp.
healthStatusFilter HealthStatusFilter Introduced as an experiment in GitLab 18.2.

Health status of the work items, “none” and “any” values are supported.
hierarchyFilters HierarchyFilterInput Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids [WorkItemID!] Filter by global IDs of work items (maximum is 100 IDs).
iids [String!] List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeDescendantWorkItems Boolean Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
iterationCadenceId [IterationsCadenceID!] Introduced as an experiment in GitLab 18.2.

Filter by a list of iteration cadence IDs.
iterationId [ID] Introduced as an experiment in GitLab 18.2.

List of iteration Global IDs applied to the work items.
iterationWildcardId IterationWildcardId Introduced as an experiment in GitLab 18.2.

Filter by iteration ID wildcard.
labelName [String!] Labels applied to the work item (maximum is 100 labels).
milestoneTitle [String!] Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId MilestoneWildcardId Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not NegatedWorkItemFilterInput Negated work item arguments.
or UnionedWorkItemFilterInput List of arguments with inclusive OR.
parentIds [WorkItemID!] Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId WorkItemParentWildcardId Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
projectPath ID! Full project path.
relativeDateFilters WorkItemRelativeDateFiltersInput Introduced as an experiment in GitLab 19.6.

Date filters relative to today, in the instance time zone. Cannot be combined with the matching absolute argument, such as createdAfter.
releaseTag [String!] Release tag associated with the work item’s milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId ReleaseTagWildcardId Filter by release tag wildcard.
search String Search query for title or description.
selectedFields [AvailableExportFields!] List of selected fields to be exported. Omit to export all available fields.
state IssuableState Current state of the work item.
status WorkItemWidgetStatusFilterInput Introduced as an experiment in GitLab 18.7.

Filter by status.
subscribed SubscriptionStatus Work items the current user is subscribed to.
types [IssueType!] Filter work items by the given work item types.
updatedAfter Time Work items updated after the timestamp.
updatedBefore Time Work items updated before the timestamp.
weight String Introduced as an experiment in GitLab 18.2.

Weight applied to the work item, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Introduced as an experiment in GitLab 18.2.

Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds [WorkItemsTypeID!] Filter work items by work item type global IDs.

workItemExport fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
message String Export request result message.

workItemGenerateReadinessScore

  • Status: Experiment

Scores the readiness of a work item asynchronously through a Duo Agent Platform flow, instead of Duo Chat. Available only when the workplan feature flag is enabled; returns an error otherwise.

Input type: WorkItemGenerateReadinessScoreInput

workItemGenerateReadinessScore arguments

Name Type Description
id WorkItemID! Global ID of the work item to score readiness for.

workItemGenerateReadinessScore fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workflow DuoWorkflow Duo Agent Platform workflow started to score the readiness.

workItemGenerateWorkplan

  • Status: Experiment

Generates a workplan for a work item asynchronously through a Duo Agent Platform flow. Available only when the workplan feature flag is enabled; returns an error otherwise.

Input type: WorkItemGenerateWorkplanInput

workItemGenerateWorkplan arguments

Name Type Description
id WorkItemID! Global ID of the work item to generate a workplan for.

workItemGenerateWorkplan fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workflow DuoWorkflow Duo Agent Platform workflow started to generate the workplan.

workItemHierarchyAddChildrenItems

  • Status: Experiment

Adds children to a given work item’s hierarchy by Global ID.

Input type: WorkItemHierarchyAddChildrenItemsInput

workItemHierarchyAddChildrenItems arguments

Name Type Description
childrenIds [WorkItemID!]! Global IDs of child work items (maximum is 1000). When the work_item_hierarchy_add_children_limits feature flag is enabled, a request can add at most 50 child items.
id WorkItemID! Global ID of the work item.

workItemHierarchyAddChildrenItems fields

Name Type Description
addedChildren [WorkItem!]! Work items that were added as children.
errors [String!]! Errors encountered during the mutation.

workItemRemoveLinkedItems

  • Status: Experiment

Remove items linked to the work item.

Input type: WorkItemRemoveLinkedItemsInput

workItemRemoveLinkedItems arguments

Name Type Description
id WorkItemID! Global ID of the work item.
workItemsIds [WorkItemID!]! Global IDs of the items to unlink. Maximum number of IDs you can provide: 10.

workItemRemoveLinkedItems fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
message String Linked items update result message.
workItem WorkItem Updated work item.

workItemResolveWorkplanQuestions

  • Status: Experiment

Resolves every open question the workplan generation flow asked on a work item, without resuming the flow. Plain flow comments are converted to resolvable threads first. Available only when the workplan feature flag is enabled; returns an error otherwise.

Input type: WorkItemResolveWorkplanQuestionsInput

workItemResolveWorkplanQuestions arguments

Name Type Description
id WorkItemID! Global ID of the work item whose workplan questions to resolve.

workItemResolveWorkplanQuestions fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItem WorkItem Work item after the questions were resolved.

workItemResumeWorkplan

  • Status: Experiment

Resumes a paused workplan generation flow that is awaiting input, sending the replies left on the questions the flow asked. Available only when the workplan feature flag is enabled; returns an error otherwise.

Input type: WorkItemResumeWorkplanInput

workItemResumeWorkplan arguments

Name Type Description
id WorkItemID! Global ID of the work item whose workplan generation to resume.

workItemResumeWorkplan fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workflow DuoWorkflow Duo Agent Platform workflow that was resumed.

workItemSavedViewCreate

  • Status: Experiment

Creates a saved view.

Input type: WorkItemSavedViewCreateInput

workItemSavedViewCreate arguments

Name Type Description
description String Description of the saved view.
displaySettings JSON! Display settings associated with the saved view.
filters WorkItemSavedViewFilterInput! Filters associated with the saved view.
isPrivate Boolean Whether the saved view is private. Default is true.
name String! Name of the saved view.
namespacePath ID! Full path of the namespace to create the saved view in.
private Boolean Deprecated in GitLab 18.10. Replaced by isPrivate argument.
sort WorkItemSort! Sort option associated with the saved view.

workItemSavedViewCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView WorkItemSavedViewType Created saved view.

workItemSavedViewDelete

  • Status: Experiment

Deletes a saved view.

Input type: WorkItemSavedViewDeleteInput

workItemSavedViewDelete arguments

Name Type Description
id WorkItemsSavedViewsSavedViewID! Global ID of the saved view.

workItemSavedViewDelete fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView WorkItemSavedViewType Deleted saved view.

workItemSavedViewReorder

  • Status: Experiment

Reorders a saved view for the current user.

Input type: WorkItemSavedViewReorderInput

workItemSavedViewReorder arguments

Name Type Description
id WorkItemsSavedViewsSavedViewID! Global ID of the saved view to be reordered.
moveAfterId WorkItemsSavedViewsSavedViewID Global ID of a saved view that the reordered view should be placed after.
moveBeforeId WorkItemsSavedViewsSavedViewID Global ID of a saved view that the reordered view should be placed before.

workItemSavedViewReorder fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView WorkItemSavedViewType Reordered saved view.

workItemSavedViewSubscribe

  • Status: Experiment

Subscribes the current user to a saved view.

Input type: WorkItemSavedViewSubscribeInput

workItemSavedViewSubscribe arguments

Name Type Description
id WorkItemsSavedViewsSavedViewID! Global ID of the saved view to subscribe to.

workItemSavedViewSubscribe fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView WorkItemSavedViewType Subscribed saved view.

workItemSavedViewUnsubscribe

  • Status: Experiment

Unsubscribes the current user from a saved view.

Input type: WorkItemSavedViewUnsubscribeInput

workItemSavedViewUnsubscribe arguments

Name Type Description
id WorkItemsSavedViewsSavedViewID! Global ID of the saved view to unsubscribe from.

workItemSavedViewUnsubscribe fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView WorkItemSavedViewType Unsubscribed saved view.

workItemSavedViewUpdate

  • Status: Experiment

Updates a saved view.

Input type: WorkItemSavedViewUpdateInput

workItemSavedViewUpdate arguments

Name Type Description
description String Description of the saved view.
displaySettings JSON Display settings associated with the saved view.
filters WorkItemSavedViewFilterInput Filters associated with the saved view.
id WorkItemsSavedViewsSavedViewID! Global ID of the saved view.
isPrivate Boolean Whether the saved view is private.
name String Name of the saved view.
private Boolean Deprecated in GitLab 18.10. Replaced by isPrivate argument.
sort WorkItemSort Sorting option associated with the saved view.

workItemSavedViewUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
savedView WorkItemSavedViewType Updated saved view.

workItemSettingsUpdate

  • Status: Experiment

Updates work item settings for a root group or organization. Omit fullPath to update settings for the current organization.

Input type: WorkItemSettingsUpdateInput

workItemSettingsUpdate arguments

Name Type Description
customizableTypeVisibility Boolean Whether namespace admins can configure per-type work item visibility.
fullPath ID Full path of the root group. Omit to use the current organization.

workItemSettingsUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItemSettings WorkItemSettings Work item settings after mutation.

workItemSubscribe

  • Status: Experiment

Input type: WorkItemSubscribeInput

workItemSubscribe arguments

Name Type Description
id WorkItemID! Global ID of the work item.
subscribed Boolean! Desired state of the subscription.

workItemSubscribe fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItem WorkItem Work item after mutation.

workItemTypeCreate

  • Status: Experiment

Input type: WorkItemTypeCreateInput

workItemTypeCreate arguments

Name Type Description
enabledByDefaultForNewNamespaces Boolean Indicates the type is enabled by default for new child namespaces.
fullPath String Full path of the root group.
iconName String! Icon name for the work item type. Use the workItemTypeIconDefinitions query to retrieve the list of available icon names.
name String! Name for the work item type.

workItemTypeCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItemType WorkItemType Work item type that was created.

workItemTypeUpdate

  • Status: Experiment

Input type: WorkItemTypeUpdateInput

workItemTypeUpdate arguments

Name Type Description
archive Boolean Whether to archive the work item type.
enabledByDefaultForNewNamespaces Boolean Indicates the type is enabled by default for new child namespaces.
fullPath String Full path of the root group.
iconName String Icon name for the work item type. Use the workItemTypeIconDefinitions query to retrieve the list of available icon names.
id WorkItemsTypeID! Global ID of the work item type to update.
name String New name for the work item type.

workItemTypeUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItemType WorkItemType Work item type that was updated.

workItemUpdate

  • Status: Experiment

Updates a work item by Global ID.

Input type: WorkItemUpdateInput

workItemUpdate arguments

Name Type Description
agentPlanWidget WorkItemWidgetAgentPlanInput Introduced as an experiment in GitLab 19.0.

Input for agent plan widget.
assigneesWidget WorkItemWidgetAssigneesInput Input for assignees widget.
awardEmojiWidget WorkItemWidgetAwardEmojiUpdateInput Input for emoji reactions widget.
colorWidget WorkItemWidgetColorInput Input for color widget.
confidential Boolean Sets the work item confidentiality.
crmContactsWidget WorkItemWidgetCrmContactsUpdateInput Input for CRM contacts widget.
currentUserTodosWidget WorkItemWidgetCurrentUserTodosInput Input for to-dos widget.
customFieldsWidget [WorkItemWidgetCustomFieldValueInputType!] Introduced as an experiment in GitLab 17.10.

Input for custom fields widget.
descriptionWidget WorkItemWidgetDescriptionInput Input for description widget.
healthStatusWidget WorkItemWidgetHealthStatusInput Input for health status widget.
hierarchyWidget WorkItemWidgetHierarchyUpdateInput Input for hierarchy widget.
id WorkItemID! Global ID of the work item.
iterationWidget WorkItemWidgetIterationInput Input for iteration widget.
labelsWidget WorkItemWidgetLabelsUpdateInput Input for labels widget.
milestoneWidget WorkItemWidgetMilestoneInput Input for milestone widget.
moveAfterId WorkItemID Introduced as an experiment in GitLab 19.2.

Global ID of a work item that should be placed after the work item.
moveBeforeId WorkItemID Introduced as an experiment in GitLab 19.2.

Global ID of a work item that should be placed before the work item.
notesWidget WorkItemWidgetNotesInput Input for notes widget.
notificationsWidget WorkItemWidgetNotificationsUpdateInput Input for notifications widget.
progressWidget WorkItemWidgetProgressInput Input for progress widget.
severityWidget WorkItemWidgetSeverityInput Introduced as an experiment in GitLab 19.6.

Input for severity widget.
startAndDueDateWidget WorkItemWidgetStartAndDueDateUpdateInput Input for start and due date widget.
stateEvent WorkItemStateEvent Close or reopen a work item.
statusWidget WorkItemWidgetStatusInput Introduced as an experiment in GitLab 17.11.

Input for status widget.
timeTrackingWidget WorkItemWidgetTimeTrackingInput Input for time tracking widget.
title String Title of the work item.
verificationStatusWidget VerificationStatusInput Input for verification status widget.
weightWidget WorkItemWidgetWeightInput Input for weight widget.

workItemUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItem WorkItem Updated work item.

workItemUserPreferenceUpdate

  • Status: Experiment

Create or Update user preferences for a work item type and namespace.

Input type: WorkItemUserPreferenceUpdateInput

workItemUserPreferenceUpdate arguments

Name Type Description Default
displaySettings JSON Display settings for the work item lists.
namespacePath ID! Full path of the namespace on which the preference is set.
sort WorkItemSort Sort order for work item lists. CREATED_ASC
workItemTypeId WorkItemsTypeID Global ID of a work item type.

workItemUserPreferenceUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
userPreferences WorkItemTypesUserPreference User preferences.

workItemsCsvExport

  • Status: Experiment

Input type: WorkItemsCsvExportInput

workItemsCsvExport arguments

Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername String Filter work items by author username.
closedAfter Time Work items closed after the date.
closedBefore Time Work items closed before the date.
confidential Boolean Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter Time Work items created after the timestamp.
createdBefore Time Work items created before the timestamp.
crmContactId String Filter by ID of CRM contact.
crmOrganizationId String Filter by ID of CRM contact organization.
dueAfter Time Work items due after the timestamp.
dueBefore Time Work items due before the timestamp.
healthStatusFilter HealthStatusFilter Introduced as an experiment in GitLab 18.2.

Health status of the work items, “none” and “any” values are supported.
hierarchyFilters HierarchyFilterInput Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids [WorkItemID!] Filter by global IDs of work items (maximum is 100 IDs).
iids [String!] List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeDescendantWorkItems Boolean Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
iterationCadenceId [IterationsCadenceID!] Introduced as an experiment in GitLab 18.2.

Filter by a list of iteration cadence IDs.
iterationId [ID] Introduced as an experiment in GitLab 18.2.

List of iteration Global IDs applied to the work items.
iterationWildcardId IterationWildcardId Introduced as an experiment in GitLab 18.2.

Filter by iteration ID wildcard.
labelName [String!] Labels applied to the work item (maximum is 100 labels).
milestoneTitle [String!] Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId MilestoneWildcardId Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not NegatedWorkItemFilterInput Negated work item arguments.
or UnionedWorkItemFilterInput List of arguments with inclusive OR.
parentIds [WorkItemID!] Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId WorkItemParentWildcardId Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
projectPath ID! Full project path.
relativeDateFilters WorkItemRelativeDateFiltersInput Introduced as an experiment in GitLab 19.6.

Date filters relative to today, in the instance time zone. Cannot be combined with the matching absolute argument, such as createdAfter.
releaseTag [String!] Release tag associated with the work item’s milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId ReleaseTagWildcardId Filter by release tag wildcard.
search String Search query for title or description.
selectedFields [AvailableExportFields!] List of selected fields to be exported. Omit to export all available fields.
state IssuableState Current state of the work item.
status WorkItemWidgetStatusFilterInput Introduced as an experiment in GitLab 18.7.

Filter by status.
subscribed SubscriptionStatus Work items the current user is subscribed to.
types [IssueType!] Filter work items by the given work item types.
updatedAfter Time Work items updated after the timestamp.
updatedBefore Time Work items updated before the timestamp.
weight String Introduced as an experiment in GitLab 18.2.

Weight applied to the work item, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Introduced as an experiment in GitLab 18.2.

Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds [WorkItemsTypeID!] Filter work items by work item type global IDs.

workItemsCsvExport fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
message String Export request result message.

workItemsCsvImport

  • Status: Experiment

Input type: WorkItemsCsvImportInput

workItemsCsvImport arguments

Name Type Description
file Upload! CSV file to import work items from.
projectPath ID! Full project path.

workItemsCsvImport fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
message String Import request result message.

workItemsHierarchyReorder

  • Status: Experiment

Reorder a work item in the hierarchy tree.

Input type: workItemsHierarchyReorderInput

workItemsHierarchyReorder arguments

Name Type Description
adjacentWorkItemId WorkItemID ID of the work item to move next to. For example, the item above or below.
id WorkItemID! Global ID of the work item to be reordered.
parentId WorkItemID Global ID of the new parent work item.
relativePosition RelativePositionType Position relative to the adjacent work item. Valid values are BEFORE or AFTER.

workItemsHierarchyReorder fields

Name Type Description
adjacentWorkItem WorkItem Adjacent work item after mutation.
errors [String!]! Errors encountered during the mutation.
parentWorkItem WorkItem Work item’s parent after mutation.
workItem WorkItem Work item after mutation.

workItemsReorder

  • Status: Experiment

Reorders a work item.

Input type: workItemsReorderInput

workItemsReorder arguments

Name Type Description
id WorkItemID! Global ID of the work item to be reordered.
moveAfterId WorkItemID Global ID of a work item that should be placed after the work item.
moveBeforeId WorkItemID Global ID of a work item that should be placed before the work item.

workItemsReorder fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workItem WorkItem Work item after mutation.

workspaceCreate

Input type: WorkspaceCreateInput

workspaceCreate arguments

Name Type Description Default
clusterAgentId ClustersAgentID! GlobalID of the cluster agent the created workspace will be associated with.
desiredState String! Desired state of the created workspace.
devfilePath String Project path containing the devfile used to configure the workspace. If not provided, the GitLab default devfile is used. null
devfileRef String Deprecated in GitLab 17.8. Argument is renamed to project_ref.
editor String Deprecated in GitLab 17.5. Argument is not used.
maxHoursBeforeTermination Int Deprecated in GitLab 17.9. Field is not used.
projectId ProjectID! ID of the project that will provide the Devfile for the created workspace.
projectRef String Project 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.

Variables to inject into the workspace.
[]

workspaceCreate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workspace Workspace Created workspace.

workspaceUpdate

Input type: WorkspaceUpdateInput

workspaceUpdate arguments

Name Type Description
desiredState String! Desired state of the created workspace.
id RemoteDevelopmentWorkspaceID! Global ID of the workspace.

workspaceUpdate fields

Name Type Description
errors [String!]! Errors encountered during the mutation.
workspace Workspace Created workspace.