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

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being awarded.
awardMessageStringMessage to associate with the awarded achievement.
userIdUserID!Global ID of the user being awarded the achievement.

achievementsAward fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userAchievementUserAchievementAchievement award.

achievementsCreate

Input type: AchievementsCreateInput

achievementsCreate arguments

NameTypeDescription
avatarUploadAvatar for the achievement.
descriptionStringDescription of or notes for the achievement.
nameString!Name for the achievement.
namespaceIdNamespaceID!Namespace for the achievement.

achievementsCreate fields

NameTypeDescription
achievementAchievementAchievement created.
errors[String!]!Errors encountered during the mutation.

achievementsDelete

Input type: AchievementsDeleteInput

achievementsDelete arguments

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being deleted.

achievementsDelete fields

NameTypeDescription
achievementAchievementAchievement.
errors[String!]!Errors encountered during the mutation.

achievementsRevoke

Input type: AchievementsRevokeInput

achievementsRevoke arguments

NameTypeDescription
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being revoked.

achievementsRevoke fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userAchievementUserAchievementAchievement award.

achievementsUpdate

Input type: AchievementsUpdateInput

achievementsUpdate arguments

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being updated.
avatarUploadAvatar for the achievement.
descriptionStringDescription of or notes for the achievement.
nameStringName for the achievement.

achievementsUpdate fields

NameTypeDescription
achievementAchievementAchievement.
errors[String!]!Errors encountered during the mutation.

addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

addProjectToSecurityDashboard arguments

NameTypeDescription
idProjectID!ID of the project to be added to Instance Security Dashboard.

addProjectToSecurityDashboard fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectProject 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

NameTypeDescription
groupIdGroupID!Group to clear the GitLab Duo availability override from.

adminClearDuoAvailability fields

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

adminRolesLdapSync

  • Status: Experiment

Input type: AdminRolesLdapSyncInput

adminRolesLdapSync fields

NameTypeDescription
errors[String!]Errors encountered during operation.
successBooleanWhether the sync was successfully enqueued.

adminSetDuoAvailability

  • Status: Experiment

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

Input type: AdminSetDuoAvailabilityInput

adminSetDuoAvailability arguments

NameTypeDescriptionDefault
availabilityDuoAvailability!GitLab Duo availability state to lock on the group.
clearDescendantsBooleanClear conflicting admin-locked overrides on descendant groups instead of rejecting.false
groupIdGroupID!Group to set the GitLab Duo availability override on.

adminSetDuoAvailability fields

NameTypeDescription
adminLockedBooleanWhether the group has an admin-locked GitLab Duo availability override.
affectedAdminLockedDescendantsAdminDuoAvailabilityLockedAncestorConnectionDescendant groups with admin-locked overrides that must be cleared before this override can be applied. Present only when clearDescendants was false; the override was not applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
availabilityDuoAvailabilityResolved GitLab Duo availability for the group after the mutation.
conflictingAncestorAdminDuoAvailabilityLockedAncestorAncestor group whose admin lock blocked the mutation, if any. When present, the override was not applied.
errors[String!]!Errors encountered during the mutation.

adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

adminSidekiqQueuesDeleteJobs arguments

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

adminSidekiqQueuesDeleteJobs fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
resultDeleteJobsResponseInformation about the status of the deletion request.

aiAction

  • Status: Experiment

Input type: AiActionInput

aiAction arguments

NameTypeDescription
agenticChatAiAgenticChatInputInput for agentic_chat AI action.
chatAiChatInputInput for chat AI action.
clientSubscriptionIdStringClient generated ID that can be subscribed to, to receive a response for the mutation.
conversationTypeAiConversationsThreadsConversationTypeConversation type of the thread.
explainVulnerabilityAiExplainVulnerabilityInputInput for explain_vulnerability AI action.
generateCommitMessageAiGenerateCommitMessageInputInput for generate_commit_message AI action.
generateDescriptionAiGenerateDescriptionInputInput for generate_description AI action.
platformOriginStringSpecifies the origin platform of the request.
projectIdProjectIDGlobal ID of the project the user is acting on.
resolveVulnerabilityAiResolveVulnerabilityInputInput for resolve_vulnerability AI action.
rootNamespaceIdNamespaceIDGlobal ID of the top-level namespace the user is acting on.
summarizeNewMergeRequestAiSummarizeNewMergeRequestInputInput for summarize_new_merge_request AI action.
summarizeReviewAiSummarizeReviewInputInput for summarize_review AI action.
threadIdAiConversationThreadIDGlobal Id of the existing thread to continue the conversation. If it is not specified, a new thread will be created for the specified conversation_type.

aiAction fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
requestIdStringID of the request.
threadIdAiConversationThreadIDGlobal Id of the thread.

aiCatalogAgentCreate

  • Status: Experiment

Input type: AiCatalogAgentCreateInput

aiCatalogAgentCreate arguments

NameTypeDescription
descriptionString!Description for the agent.
mcpServers[AiCatalogMcpServerID!]Introduced as an experiment in GitLab 18.10.

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

List of MCP tools enabled for the agent.
nameString!Name for the agent.
projectIdProjectID!Project for the agent.
publicBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the agent.
systemPromptString!System prompt for the agent.
tools[AiCatalogBuiltInToolID!]List of GitLab built-in tools enabled for the agent.
userPromptStringUser prompt for the agent.
visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.

Visibility of the agent in the catalog.

aiCatalogAgentCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemAiCatalogAgentItem created.

aiCatalogAgentDelete

  • Status: Experiment

Input type: AiCatalogAgentDeleteInput

aiCatalogAgentDelete arguments

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

aiCatalogAgentDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
successBoolean!Returns true if catalog Agent was successfully deleted.

aiCatalogAgentUpdate

  • Status: Experiment

Input type: AiCatalogAgentUpdateInput

aiCatalogAgentUpdate arguments

NameTypeDescription
descriptionStringDescription for the agent.
idAiCatalogItemID!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.
mcpTools[String!]Introduced as an experiment in GitLab 18.11.

List of MCP tools enabled for the agent.
nameStringName for the agent.
publicBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the agent.
systemPromptStringSystem prompt for the agent.
tools[AiCatalogBuiltInToolID!]List of GitLab built-in tools enabled for the agent.
userPromptStringUser prompt for the agent.
versionBumpAiCatalogVersionBumpBump version, calculated from the last released version name.
visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.

Visibility of the agent in the catalog.

aiCatalogAgentUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemAiCatalogAgentAgent that was updated.

aiCatalogFlowCreate

  • Status: Experiment

Input type: AiCatalogFlowCreateInput

aiCatalogFlowCreate arguments

NameTypeDescription
definitionStringYAML definition for the flow.
descriptionString!Description for the flow.
nameString!Name for the flow.
projectIdProjectID!Project for the flow.
publicBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the flow.
visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.

Visibility of the flow in the catalog.

aiCatalogFlowCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemAiCatalogFlowItem created.

aiCatalogFlowDelete

  • Status: Experiment

Input type: AiCatalogFlowDeleteInput

aiCatalogFlowDelete arguments

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

aiCatalogFlowDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
successBoolean!Returns true if catalog flow was successfully deleted.

aiCatalogFlowUpdate

  • Status: Experiment

Input type: AiCatalogFlowUpdateInput

aiCatalogFlowUpdate arguments

NameTypeDescription
definitionStringYAML definition for the Flow.
descriptionStringDescription for the flow.
idAiCatalogItemID!Global ID of the catalog flow to update.
nameStringName for the flow.
publicBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the flow.
versionBumpAiCatalogVersionBumpBump version, calculated from the last released version name.
visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.

Visibility of the flow in the catalog.

aiCatalogFlowUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemAiCatalogFlowFlow that was updated.

aiCatalogItemConsumerBulkCreate

  • Status: Experiment

Input type: AiCatalogItemConsumerBulkCreateInput

aiCatalogItemConsumerBulkCreate arguments

NameTypeDescription
itemIdAiCatalogItemID!Global ID of the catalog item to enable.
pinnedVersionAiCatalogPinnedVersionVersion to pin the item to, in the format n.n.n. Must be a released version. Defaults to the latest released version. Ignored when enabling within the item’s managing project, which always tracks the latest released version.
projectIds[ProjectID!]!Global IDs of the projects to enable the catalog item in (maximum 100).
triggerConditionsAiCatalogTriggerConditionsInputIntroduced as an experiment in GitLab 19.3.

Filter conditions for the auto-created AI Catalog triggers, keyed by event type.
triggerFilterJSONDeprecated in GitLab 19.3. Use triggerConditions.
triggerGoalsJSONIntroduced 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

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

aiCatalogItemConsumerCreate

  • Status: Experiment

Input type: AiCatalogItemConsumerCreateInput

aiCatalogItemConsumerCreate arguments

NameTypeDescriptionDefault
consumerKindAiCatalogItemConsumerKindType of item configuration. INHERITANCE is only valid for a top-level group target.DIRECT
itemIdAiCatalogItemID!Item to configure.
parentItemConsumerIdAiCatalogItemConsumerIDParent item consumer belonging to the top-level group.
pinnedVersionAiCatalogPinnedVersionVersion to pin the item to, in the format n.n.n. Must be a released version. Defaults to the latest released version. Ignored when enabling within the item’s managing project, which always tracks the latest released version.
replaceExistingDirectConfigurationsBooleanConfirm replacement of a group configuration, and any project configurations, for this item when inheritance is turned on. Required when the item is already configured for the group.
targetItemConsumerTargetInput!Target project or top-level group in which the catalog item is configured.
triggerConditionsAiCatalogTriggerConditionsInputIntroduced as an experiment in GitLab 19.3.

Filter conditions for the auto-created AI Catalog triggers, keyed by event type.
triggerFilterJSONDeprecated in GitLab 19.3. Use triggerConditions.
triggerGoalsJSONIntroduced 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

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemConsumerAiCatalogItemConsumerItem configuration created.
warnings[String!]!Non-fatal problems encountered while configuring the item. The configuration was still created.

aiCatalogItemConsumerDelete

  • Status: Experiment

Input type: AiCatalogItemConsumerDeleteInput

aiCatalogItemConsumerDelete arguments

NameTypeDescription
idAiCatalogItemConsumerID!Global ID of the catalog item consumer to delete.

aiCatalogItemConsumerDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
successBoolean!Returns true if catalog item consumer was successfully deleted.

aiCatalogItemConsumerUpdate

  • Status: Experiment

Input type: AiCatalogItemConsumerUpdateInput

aiCatalogItemConsumerUpdate arguments

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

aiCatalogItemConsumerUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemConsumerAiCatalogItemConsumerItem consumer that was updated.

aiCatalogItemReport

  • Status: Experiment

Input type: AiCatalogItemReportInput

aiCatalogItemReport arguments

NameTypeDescription
bodyStringAdditional details about the report. Limited to 1000 characters.
idAiCatalogItemID!Global ID of the catalog item to report.
reasonAiCatalogItemReportReason!Reason for reporting the catalog item.

aiCatalogItemReport fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

aiCatalogItemStar

  • Status: Experiment

Input type: AiCatalogItemStarInput

aiCatalogItemStar arguments

NameTypeDescription
idAiCatalogItemID!Global ID of the catalog item to star or unstar.
starredBoolean!Indicates whether to star or unstar the catalog item.

aiCatalogItemStar fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
starCountInt!Number of stars for the catalog item.

aiCatalogItemVersionRestore

  • Status: Experiment

Input type: AiCatalogItemVersionRestoreInput

aiCatalogItemVersionRestore arguments

NameTypeDescriptionDefault
deprecateCurrentBooleanWhether to mark the current latest version as deprecated.false
idAiCatalogItemVersionID!Global ID of the item version to restore from.

aiCatalogItemVersionRestore fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemVersionAiCatalogItemVersionNewly created item version restored from the source version.

aiCatalogMcpServerCreate

  • Status: Experiment

Input type: AiCatalogMcpServerCreateInput

aiCatalogMcpServerCreate arguments

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

aiCatalogMcpServerCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mcpServerAiCatalogMcpServerMCP server created.

aiCatalogMcpServerSetBlock

  • Status: Experiment

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

Input type: AiCatalogMcpServerSetBlockInput

aiCatalogMcpServerSetBlock arguments

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

aiCatalogMcpServerSetBlock fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mcpServerAiCatalogMcpServerMCP server with its updated block status.

aiCatalogMcpServerUpdate

  • Status: Experiment

Input type: AiCatalogMcpServerUpdateInput

aiCatalogMcpServerUpdate arguments

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

aiCatalogMcpServerUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mcpServerAiCatalogMcpServerMCP server that was updated.

aiCatalogThirdPartyFlowCreate

  • Status: Experiment

Input type: AiCatalogThirdPartyFlowCreateInput

aiCatalogThirdPartyFlowCreate arguments

NameTypeDescription
definitionString!YAML definition for the Flow.
descriptionString!Description for the Flow.
nameString!Name for the Flow.
projectIdProjectID!Project for the Flow.
publicBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the Flow.
visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.

Visibility of the Flow in the catalog.

aiCatalogThirdPartyFlowCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemAiCatalogThirdPartyFlowItem created.

aiCatalogThirdPartyFlowDelete

  • Status: Experiment

Input type: AiCatalogThirdPartyFlowDeleteInput

aiCatalogThirdPartyFlowDelete arguments

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

aiCatalogThirdPartyFlowDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
successBoolean!Returns true if catalog Third Party Flow was successfully deleted.

aiCatalogThirdPartyFlowUpdate

  • Status: Experiment

Input type: AiCatalogThirdPartyFlowUpdateInput

aiCatalogThirdPartyFlowUpdate arguments

NameTypeDescription
definitionStringYAML definition for the Flow.
descriptionStringDescription for the Flow.
idAiCatalogItemID!Global ID of the catalog Flow to update.
nameStringName for the Flow.
publicBooleanDeprecated in GitLab 19.2. Use visibility.
releaseBooleanWhether to release the latest version of the Flow.
versionBumpAiCatalogVersionBumpBump version, calculated from the last released version name.
visibilityAiCatalogItemVisibilityIntroduced as an experiment in GitLab 19.2.

Visibility of the Flow in the catalog.

aiCatalogThirdPartyFlowUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
itemAiCatalogThirdPartyFlowFlow 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

NameTypeDescription
actionAiDomainSettingAction!Action to perform on the domain list.
domainSettingTypeAiDomainSettingType!Type of domain setting to update.
domains[String!]!List of domains to add or remove.

aiDomainSettingsInstanceUpdate fields

NameTypeDescription
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

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

aiDomainSettingsNamespaceUpdate fields

NameTypeDescription
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

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

aiDuoWorkflowCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the creation process.
workflowDuoWorkflowCreated workflow.

aiFeatureSettingModelAllowlistUpdate

  • Status: Experiment

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

Input type: AiFeatureSettingModelAllowlistUpdateInput

aiFeatureSettingModelAllowlistUpdate arguments

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

aiFeatureSettingModelAllowlistUpdate fields

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

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

aiFeatureSettingUpdate fields

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

aiFlowScheduleCreate

  • Status: Experiment

Input type: AiFlowScheduleCreateInput

aiFlowScheduleCreate arguments

NameTypeDescriptionDefault
activeBooleanIndicates whether the schedule should be active.true
cronString!Cron expression defining the schedule frequency.
cronTimezoneString!IANA timezone for the cron expression.
descriptionString!Description of the schedule.
flowTriggerIdAiFlowTriggerID!Global ID of the flow trigger to schedule.

aiFlowScheduleCreate fields

NameTypeDescription
aiFlowScheduleAiFlowScheduleTypeCreated flow schedule.
errors[String!]!Errors encountered during the mutation.

aiFlowScheduleDelete

  • Status: Experiment

Input type: AiFlowScheduleDeleteInput

aiFlowScheduleDelete arguments

NameTypeDescription
idAiFlowScheduleID!Global ID of the flow schedule to delete.

aiFlowScheduleDelete fields

NameTypeDescription
aiFlowScheduleAiFlowScheduleTypeDeleted flow schedule.
errors[String!]!Errors encountered during the mutation.

aiFlowScheduleUpdate

  • Status: Experiment

Input type: AiFlowScheduleUpdateInput

aiFlowScheduleUpdate arguments

NameTypeDescription
activeBooleanIndicates whether the schedule should be active.
cronStringCron expression defining the schedule frequency.
cronTimezoneStringIANA timezone for the cron expression.
descriptionStringDescription of the schedule.
idAiFlowScheduleID!Global ID of the flow schedule to update.

aiFlowScheduleUpdate fields

NameTypeDescription
aiFlowScheduleAiFlowScheduleTypeUpdated flow schedule.
errors[String!]!Errors encountered during the mutation.

aiFlowTriggerCreate

  • Status: Experiment

Input type: AiFlowTriggerCreateInput

aiFlowTriggerCreate arguments

NameTypeDescription
activeBooleanIntroduced as an experiment in GitLab 19.4.

Indicates whether the AI flow trigger is active. Defaults to true.
aiCatalogItemConsumerIdAiCatalogItemConsumerIDAI catalog item consumer to use instead of config_path.
configPathStringPath to the configuration file for the AI flow trigger.
descriptionString!Description of the AI flow trigger.
eventTypes[Int!]Event types that triggers the AI flow.
filterJSONIntroduced as an experiment in GitLab 19.0.

Filter conditions for the AI flow trigger.
goalsJSONIntroduced as an experiment in GitLab 19.5.

Goals for the AI flow trigger, keyed by event type.
projectPathID!Full path of the project the AI flow trigger is associated with.
readyMergeRequestsOnFinishBooleanIntroduced 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 ai_flow_trigger_status_on_finish 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.
statusOnFinishStringIntroduced 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 ai_flow_trigger_status_on_finish 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.
userIdUserIDService account for the AI flow trigger.

aiFlowTriggerCreate fields

NameTypeDescription
aiFlowTriggerAiFlowTriggerTypeCreated AI flow trigger.
errors[String!]!Errors encountered during the mutation.

aiFlowTriggerDelete

  • Status: Experiment

Input type: AiFlowTriggerDeleteInput

aiFlowTriggerDelete arguments

NameTypeDescription
idAiFlowTriggerID!ID of the flow trigger to delete.

aiFlowTriggerDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

aiFlowTriggerUpdate

  • Status: Experiment

Input type: AiFlowTriggerUpdateInput

aiFlowTriggerUpdate arguments

NameTypeDescription
activeBooleanIntroduced as an experiment in GitLab 19.4.

Indicates whether the AI flow trigger is active. Inactive triggers do not run automatically.
aiCatalogItemConsumerIdAiCatalogItemConsumerIDAI catalog item consumer to use instead of config_path.
configPathStringPath to the configuration file for the AI flow trigger.
descriptionStringDescription of the AI flow trigger.
eventTypes[Int!]Event types that triggers the AI flow.
filterJSONIntroduced as an experiment in GitLab 18.11.

Filter conditions for the AI flow trigger.
goalsJSONIntroduced as an experiment in GitLab 19.5.

Goals for the AI flow trigger, keyed by event type.
idAiFlowTriggerID!ID of the flow trigger to update.
readyMergeRequestsOnFinishBooleanIntroduced 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 ai_flow_trigger_status_on_finish 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.
statusOnFinishStringIntroduced 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 ai_flow_trigger_status_on_finish 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.
userIdUserIDService account for the AI flow trigger.

aiFlowTriggerUpdate fields

NameTypeDescription
aiFlowTriggerAiFlowTriggerTypeUpdated AI flow trigger.
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

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

aiModelSelectionNamespaceModelAllowlistUpdate fields

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

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

aiModelSelectionNamespaceUpdate fields

NameTypeDescription
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

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
endpointStringEndpoint of the self-hosted model.
iamRoleStringIAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.
providerAiSelfHostedModelProvider!Provider for the self-hosted model.

aiSelfHostedModelConnectionCheck fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
resultCloudConnectorProbeResultSelf-hosted hosted connection check result.

aiSelfHostedModelCreate

  • Status: Experiment

Input type: AiSelfHostedModelCreateInput

aiSelfHostedModelCreate arguments

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
endpointStringEndpoint of the self-hosted model.
iamRoleStringIAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.
providerAiSelfHostedModelProvider!Provider for the self-hosted model.

aiSelfHostedModelCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
selfHostedModelAiSelfHostedModelSelf-hosted model after mutation.

aiSelfHostedModelDelete

  • Status: Experiment

Deletes a self-hosted model.

Input type: AiSelfHostedModelDeleteInput

aiSelfHostedModelDelete arguments

NameTypeDescription
idAiSelfHostedModelID!Global ID of the self-hosted model to delete.

aiSelfHostedModelDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

aiSelfHostedModelUpdate

  • Status: Experiment

Updates a self-hosted model.

Input type: AiSelfHostedModelUpdateInput

aiSelfHostedModelUpdate arguments

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
endpointStringEndpoint of the self-hosted model.
iamRoleStringIAM role ARN that the AI Gateway assumes through STS AssumeRole when calling Amazon Bedrock. Only used by the Amazon Bedrock provider.
idAiSelfHostedModelID!Global ID of the self-hosted model to update.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.
providerAiSelfHostedModelProvider!Provider for the self-hosted model.

aiSelfHostedModelUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
selfHostedModelAiSelfHostedModelSelf-hosted model after mutation.

alertSetAssignees

Input type: AlertSetAssigneesInput

alertSetAssignees arguments

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

alertSetAssignees fields

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

alertTodoCreate

Input type: AlertTodoCreateInput

alertTodoCreate arguments

NameTypeDescription
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.

alertTodoCreate fields

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

approvalProjectRuleDelete

  • Status: Experiment

Input type: approvalProjectRuleDeleteInput

approvalProjectRuleDelete arguments

NameTypeDescription
idApprovalProjectRuleID!Global ID of the approval project rule to delete.

approvalProjectRuleDelete fields

NameTypeDescription
approvalRuleApprovalProjectRuleDeleted approval rule.
errors[String!]!Errors encountered during the mutation.

approvalProjectRuleUpdate

  • Status: Experiment

Input type: approvalProjectRuleUpdateInput

approvalProjectRuleUpdate arguments

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

approvalProjectRuleUpdate fields

NameTypeDescription
approvalRuleApprovalProjectRuleApproval rule after mutation.
errors[String!]!Errors encountered during the mutation.

approveDeployment

Input type: ApproveDeploymentInput

approveDeployment arguments

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

approveDeployment fields

NameTypeDescription
deploymentApprovalDeploymentApprovalDeploymentApproval after mutation.
errors[String!]!Errors encountered during the mutation.

artifactDestroy

Input type: ArtifactDestroyInput

artifactDestroy arguments

NameTypeDescription
idCiJobArtifactID!ID of the artifact to delete.

artifactDestroy fields

NameTypeDescription
artifactCiJobArtifactDeleted artifact.
errors[String!]!Errors encountered during the mutation.

artifactRegistryActivate

  • Status: Experiment

Activates an Artifact Registry for an organization by claiming a slug.

Input type: ArtifactRegistryActivateInput

artifactRegistryActivate arguments

NameTypeDescription
slugString!Slug to claim, Artifact Registry’s immutable identifier for the namespace.

artifactRegistryActivate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryArtifactRegistryIntroduced 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.

Input type: ArtifactRegistryArtifactDeleteInput

artifactRegistryArtifactDelete arguments

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

artifactRegistryArtifactDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
repositoryArtifactRegistryRepositoryRepository holding the deleted artifact. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.

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.

Input type: ArtifactRegistryContainerTagDeleteInput

artifactRegistryContainerTagDelete arguments

NameTypeDescription
imageIdID!ID of the image holding the tag in Artifact Registry, as returned by the id field on an image. Not a GitLab global ID.
nameString!Name of the repository holding the tag, unique within the organization.
tagNameString!Name of the tag to delete. Limited to 1024 characters.

artifactRegistryContainerTagDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
repositoryArtifactRegistryRepositoryRepository holding the deleted tag. A tag delete moves no repository counter. Null when the deletion was not accepted.

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

Input type: ArtifactRegistryDisableInput

artifactRegistryDisable fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryArtifactRegistryRegistry 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).

Input type: ArtifactRegistryEnableInput

artifactRegistryEnable fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryArtifactRegistryRegistry 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. Deletion is refused if another manifest indexes the target as a child, and the error lists at most 10 blocking digests plus the total count.

Input type: ArtifactRegistryManifestDeleteInput

artifactRegistryManifestDelete arguments

NameTypeDescription
digestString!Content-addressable digest of the manifest, as returned by the digest field on a manifest. Limited to 512 characters.
imageIdID!ID of the image holding the manifest in Artifact Registry, as returned by the id field on an image. Not a GitLab global ID.
nameString!Name of the repository holding the manifest, unique within the organization.

artifactRegistryManifestDelete fields

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

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.

Input type: ArtifactRegistryNpmDistTagDeleteInput

artifactRegistryNpmDistTagDelete arguments

NameTypeDescription
idID!ID of the dist-tag in Artifact Registry. Not a GitLab global ID.
nameString!Name of the repository holding the dist-tag, unique within the organization.

artifactRegistryNpmDistTagDelete fields

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

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.

Input type: ArtifactRegistryRepositoryArtifactsDeleteInput

artifactRegistryRepositoryArtifactsDelete arguments

NameTypeDescription
nameString!Name of the repository whose artifacts are deleted, unique within the organization.

artifactRegistryRepositoryArtifactsDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
repositoryArtifactRegistryRepositoryRepository the deletion targeted. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.

artifactRegistryRepositoryCreate

  • Status: Experiment

Creates a repository in Artifact Registry.

Input type: ArtifactRegistryRepositoryCreateInput

artifactRegistryRepositoryCreate arguments

NameTypeDescription
descriptionStringHuman-readable description of the repository.
formatArtifactRegistryRepositoryFormat!Package format the repository holds. Cannot be changed after creation.
kindArtifactRegistryRepositoryKindHow the repository sources its artifacts. Defaults to hosted in Artifact Registry.
nameString!Name of the repository, unique within the organization.
settingsArtifactRegistryRemoteSettingsInputIntroduced as an experiment in GitLab 19.4.

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.
visibilityArtifactRegistryRepositoryVisibilityWho can read the repository.

artifactRegistryRepositoryCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
refusedUpstreamRepositoryIdIDIntroduced 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.
repositoryArtifactRegistryRepositoryRepository 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.

Input type: ArtifactRegistryRepositoryDeleteInput

artifactRegistryRepositoryDelete arguments

NameTypeDescription
nameString!Name of the repository to delete, unique within the organization.

artifactRegistryRepositoryDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

artifactRegistryRepositoryTestConnection

  • Status: Experiment

Tests the upstream connection of a remote repository in Artifact Registry.

Input type: ArtifactRegistryRepositoryTestConnectionInput

artifactRegistryRepositoryTestConnection arguments

NameTypeDescription
nameString!Name of the repository to test, unique within the organization.

artifactRegistryRepositoryTestConnection fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
httpStatusIntStatus the upstream answered the probe with. Null when the probe failed in transport and no response arrived, and when no probe ran.
lastHealthCheckedAtTimeTimestamp of the most recent health probe of the upstream, as it reads after this probe. Null when no verdict is recorded, including when this probe’s own write did not land.
lastHealthStatusArtifactRegistryHealthStatusStored health verdict as it reads after the probe. Can differ from passed, because Artifact Registry moves it to UNHEALTHY only once consecutive failures reach its threshold. UNKNOWN when no verdict is recorded, including when this probe’s own write did not land, and for a status this schema does not recognize. Null when no probe ran.
passedBooleanIndicates the upstream answered the probe with a status below 500. Reports reachability rather than credential validity, so an upstream 401 or 404 passes. Null when no probe ran.

artifactRegistryRepositoryUpdate

  • Status: Experiment

Updates a repository in Artifact Registry. Artifact Registry writes the metadata fields and the settings in separate transactions, metadata first, so a failed update can leave a visibility or description change applied while the settings did not change. Re-sending the same mutation converges.

Input type: ArtifactRegistryRepositoryUpdateInput

artifactRegistryRepositoryUpdate arguments

NameTypeDescription
descriptionStringHuman-readable description of the repository.
nameString!Name of the repository to update, unique within the organization. Cannot be changed.
settingsArtifactRegistryRemoteSettingsInputIntroduced as an experiment in GitLab 19.4.

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.
visibilityArtifactRegistryRepositoryVisibilityWho can read the repository.

artifactRegistryRepositoryUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
refusedUpstreamRepositoryIdIDIntroduced 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.
repositoryArtifactRegistryRepositoryRepository 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

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

artifactRegistryRoleBulkGrant fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
grantedRoleCountIntNumber 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

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

artifactRegistryRoleBulkRevoke fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
revokedRoleCountIntNumber 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

NameTypeDescription
assigneeIdUserID!Global ID of the user to grant the role to.
resourceIdString!UUID of the Artifact Registry resource (repository or namespace) the role applies to.
roleArtifactRegistryRole!Artifact Registry role to grant.

artifactRegistryRoleGrant fields

NameTypeDescription
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

NameTypeDescription
assigneeIdUserID!Global ID of the user to revoke the role from.
resourceIdString!UUID of the Artifact Registry resource (repository or namespace) the role is assigned on.

artifactRegistryRoleRevoke fields

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

Input type: ArtifactRegistryUpstreamRepositoryDissociateInput

artifactRegistryUpstreamRepositoryDissociate arguments

NameTypeDescription
associationIdID!ID of the upstream repository association to remove, as returned by the id field on an upstream repository association. Not a GitLab global ID.
formatArtifactRegistryRepositoryFormat!Package format of the virtual repository.
nameString!Name of the virtual repository holding the upstream repository, unique within the organization.

artifactRegistryUpstreamRepositoryDissociate fields

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

Input type: ArtifactRegistryUpstreamTestConnectionInput

artifactRegistryUpstreamTestConnection arguments

NameTypeDescription
credentialsArtifactRegistryRemoteCredentialsInputUpstream credentials to probe with. Omit or pass null to probe unauthenticated. Accepted for every format, but ignored when probing a container upstream (docker or oci), whose probe is always unauthenticated.
formatArtifactRegistryRepositoryFormat!Package format of the upstream to probe. Decides the credential shape and the probe auth.
urlString!Base URL of the upstream to probe.

artifactRegistryUpstreamTestConnection fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
httpStatusIntStatus the upstream answered the probe with. Null when the probe failed in transport and no response arrived, and when no probe ran.
passedBooleanIndicates the upstream answered the probe with a status below 500. Reports reachability rather than credential validity, so an upstream 401 or 404 passes. Null when no probe ran.

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.

Input type: ArtifactRegistryVersionDeleteInput

artifactRegistryVersionDelete arguments

NameTypeDescription
idID!ID of the version in Artifact Registry, as returned by the id field on a version. Not a GitLab global ID.
nameString!Name of the repository holding the version, unique within the organization.

artifactRegistryVersionDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
repositoryArtifactRegistryRepositoryRepository holding the deleted version. Counters were read before the deletion applied, so they can lag its result. Null when the deletion was not applied.

ascpComponentCreate

  • Status: Experiment

Input type: AscpComponentCreateInput

ascpComponentCreate arguments

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

ascpComponentCreate fields

NameTypeDescription
componentAscpComponentIntroduced as an experiment in GitLab 18.11.

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

ascpScanCreate

  • Status: Experiment

Input type: AscpScanCreateInput

ascpScanCreate arguments

NameTypeDescriptionDefault
baseCommitShaStringBase commit SHA for incremental scans.
baseScanIdSecurityAscpScanIDID of the base scan for incremental scans.
commitShaString!Git commit SHA that was scanned.
projectPathID!Full path of the project.
scanTypeAscpScanTypeType of scan (default: full).FULL

ascpScanCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
scanAscpScanIntroduced as an experiment in GitLab 18.10.

Created scan.

ascpSecurityContextCreate

  • Status: Experiment

Input type: AscpSecurityContextCreateInput

ascpSecurityContextCreate arguments

NameTypeDescription
authenticationModelStringHow users authenticate to the component.
authorizationModelStringHow access is controlled.
componentIdSecurityAscpComponentID!ID of the component.
dataSensitivityStringTypes of sensitive data handled.
guidelines[AscpSecurityGuidelineInput!]!List of security guidelines.
projectPathID!Full path of the project.
scanIdSecurityAscpScanID!ID of the scan when the security context was created.
securityBoundary[AscpSecurityBoundary!]Security boundaries the component sits on.
summaryStringHigh-level threat model summary.

ascpSecurityContextCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityContextAscpSecurityContextIntroduced 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

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

auditEventsAmazonS3ConfigurationCreate fields

NameTypeDescription
amazonS3ConfigurationAmazonS3ConfigurationTypeconfiguration created.
errors[String!]!Errors encountered during the mutation.

auditEventsAmazonS3ConfigurationDelete

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.

Input type: AuditEventsAmazonS3ConfigurationDeleteInput

auditEventsAmazonS3ConfigurationDelete arguments

NameTypeDescription
idAuditEventsAmazonS3ConfigurationID!ID of the Amazon S3 configuration to destroy.

auditEventsAmazonS3ConfigurationDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

auditEventsAmazonS3ConfigurationUpdate

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: AuditEventsAmazonS3ConfigurationUpdateInput

auditEventsAmazonS3ConfigurationUpdate arguments

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

auditEventsAmazonS3ConfigurationUpdate fields

NameTypeDescription
amazonS3ConfigurationAmazonS3ConfigurationTypeUpdated Amazon S3 configuration.
errors[String!]!Errors encountered during the mutation.

auditEventsGroupDestinationDenylistEventsAdd

  • Status: Experiment

Input type: AuditEventsGroupDestinationDenylistEventsAddInput

auditEventsGroupDestinationDenylistEventsAdd arguments

NameTypeDescription
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add to the denylist.

auditEventsGroupDestinationDenylistEventsAdd fields

NameTypeDescription
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

NameTypeDescription
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from the denylist.

auditEventsGroupDestinationDenylistEventsDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

auditEventsGroupDestinationEventsAdd

  • Status: Experiment

Input type: AuditEventsGroupDestinationEventsAddInput

auditEventsGroupDestinationEventsAdd arguments

NameTypeDescription
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add for streaming.

auditEventsGroupDestinationEventsAdd fields

NameTypeDescription
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

NameTypeDescription
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from streaming.

auditEventsGroupDestinationEventsDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

auditEventsGroupDestinationNamespaceFilterCreate

  • Status: Experiment

Input type: AuditEventsGroupDestinationNamespaceFilterCreateInput

auditEventsGroupDestinationNamespaceFilterCreate arguments

NameTypeDescription
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination ID.
namespacePathStringFull path of the namespace(only project or group).

auditEventsGroupDestinationNamespaceFilterCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceFilterGroupAuditEventNamespaceFilterNamespace filter created.

auditEventsGroupDestinationNamespaceFilterDelete

  • Status: Experiment

Input type: AuditEventsGroupDestinationNamespaceFilterDeleteInput

auditEventsGroupDestinationNamespaceFilterDelete arguments

NameTypeDescription
namespaceFilterIdAuditEventsGroupNamespaceFilterID!Namespace filter ID.

auditEventsGroupDestinationNamespaceFilterDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

auditEventsInstanceAmazonS3ConfigurationCreate

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

Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput

auditEventsInstanceAmazonS3ConfigurationCreate arguments

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

auditEventsInstanceAmazonS3ConfigurationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
instanceAmazonS3ConfigurationInstanceAmazonS3ConfigurationTypeCreated instance Amazon S3 configuration.

auditEventsInstanceAmazonS3ConfigurationDelete

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput

auditEventsInstanceAmazonS3ConfigurationDelete arguments

NameTypeDescription
idAuditEventsInstanceAmazonS3ConfigurationID!ID of the instance-level Amazon S3 configuration to delete.

auditEventsInstanceAmazonS3ConfigurationDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

auditEventsInstanceAmazonS3ConfigurationUpdate

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput

auditEventsInstanceAmazonS3ConfigurationUpdate arguments

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

auditEventsInstanceAmazonS3ConfigurationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
instanceAmazonS3ConfigurationInstanceAmazonS3ConfigurationTypeUpdated instance-level Amazon S3 configuration.

auditEventsInstanceDestinationEventsAdd

  • Status: Experiment

Input type: AuditEventsInstanceDestinationEventsAddInput

auditEventsInstanceDestinationEventsAdd arguments

NameTypeDescription
destinationIdAuditEventsInstanceExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add for streaming.

auditEventsInstanceDestinationEventsAdd fields

NameTypeDescription
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

NameTypeDescription
destinationIdAuditEventsInstanceExternalStreamingDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from streaming.

auditEventsInstanceDestinationEventsDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

auditEventsInstanceDestinationNamespaceFilterCreate

  • Status: Experiment

Input type: AuditEventsInstanceDestinationNamespaceFilterCreateInput

auditEventsInstanceDestinationNamespaceFilterCreate arguments

NameTypeDescription
destinationIdAuditEventsInstanceExternalStreamingDestinationID!Destination ID.
namespacePathStringFull path of the namespace. Project or group namespaces only.

auditEventsInstanceDestinationNamespaceFilterCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceFilterInstanceAuditEventNamespaceFilterNamespace filter to be created.

auditEventsInstanceDestinationNamespaceFilterDelete

  • Status: Experiment

Input type: AuditEventsInstanceDestinationNamespaceFilterDeleteInput

auditEventsInstanceDestinationNamespaceFilterDelete arguments

NameTypeDescription
namespaceFilterIdAuditEventsInstanceNamespaceFilterID!Namespace filter ID.

auditEventsInstanceDestinationNamespaceFilterDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

auditEventsStreamingDestinationEventsAdd

Deprecated in GitLab 18.10. Use auditEventsGroupDestinationEventsAdd instead.

Input type: AuditEventsStreamingDestinationEventsAddInput

auditEventsStreamingDestinationEventsAdd arguments

NameTypeDescription
destinationIdAuditEventsExternalAuditEventDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add for streaming.

auditEventsStreamingDestinationEventsAdd fields

NameTypeDescription
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

NameTypeDescription
destinationIdAuditEventsExternalAuditEventDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from streaming.

auditEventsStreamingDestinationEventsRemove fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

auditEventsStreamingDestinationInstanceEventsAdd

Deprecated in GitLab 18.10. Use auditEventsInstanceDestinationEventsAdd instead.

Input type: AuditEventsStreamingDestinationInstanceEventsAddInput

auditEventsStreamingDestinationInstanceEventsAdd arguments

NameTypeDescription
destinationIdAuditEventsInstanceExternalAuditEventDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to add for streaming.

auditEventsStreamingDestinationInstanceEventsAdd fields

NameTypeDescription
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

NameTypeDescription
destinationIdAuditEventsInstanceExternalAuditEventDestinationID!Destination id.
eventTypeFilters[String!]!List of event type filters to remove from streaming.

auditEventsStreamingDestinationInstanceEventsRemove fields

NameTypeDescription
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

NameTypeDescriptionDefault
activeBooleanBoolean option determining whether header is active or not.true
destinationIdAuditEventsExternalAuditEventDestinationID!Destination to associate header with.
keyString!Header key.
valueString!Header value.

auditEventsStreamingHeadersCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
headerAuditEventStreamingHeaderCreated header.

auditEventsStreamingHeadersDestroy

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

Input type: AuditEventsStreamingHeadersDestroyInput

auditEventsStreamingHeadersDestroy arguments

NameTypeDescription
headerIdAuditEventsStreamingHeaderID!Header to delete.

auditEventsStreamingHeadersDestroy fields

NameTypeDescription
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

NameTypeDescriptionDefault
activeBooleanBoolean option determining whether header is active or not.null
headerIdAuditEventsStreamingHeaderID!Header to update.
keyStringHeader key.null
valueStringHeader value.null

auditEventsStreamingHeadersUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
headerAuditEventStreamingHeaderUpdates header.

auditEventsStreamingHttpNamespaceFiltersAdd

Deprecated in GitLab 18.10. Use auditEventsGroupDestinationNamespaceFilterCreate instead.

Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput

auditEventsStreamingHttpNamespaceFiltersAdd arguments

NameTypeDescription
destinationIdAuditEventsExternalAuditEventDestinationID!Destination ID.
groupPathIDFull path of the group.
projectPathIDFull path of the project.

auditEventsStreamingHttpNamespaceFiltersAdd fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceFilterAuditEventStreamingHTTPNamespaceFilterNamespace filter created.

auditEventsStreamingHttpNamespaceFiltersDelete

Deprecated in GitLab 18.10. Use auditEventsGroupDestinationNamespaceFilterDelete instead.

Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput

auditEventsStreamingHttpNamespaceFiltersDelete arguments

NameTypeDescription
namespaceFilterIdAuditEventsStreamingHTTPNamespaceFilterID!Namespace filter ID.

auditEventsStreamingHttpNamespaceFiltersDelete fields

NameTypeDescription
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

NameTypeDescriptionDefault
activeBooleanBoolean option determining whether header is active or not.true
destinationIdAuditEventsInstanceExternalAuditEventDestinationID!Instance level external destination to associate header with.
keyString!Header key.
valueString!Header value.

auditEventsStreamingInstanceHeadersCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
headerAuditEventsStreamingInstanceHeaderCreated header.

auditEventsStreamingInstanceHeadersDestroy

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

Input type: AuditEventsStreamingInstanceHeadersDestroyInput

auditEventsStreamingInstanceHeadersDestroy arguments

NameTypeDescription
headerIdAuditEventsStreamingInstanceHeaderID!Header to delete.

auditEventsStreamingInstanceHeadersDestroy fields

NameTypeDescription
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

NameTypeDescriptionDefault
activeBooleanBoolean option determining whether header is active or not.null
headerIdAuditEventsStreamingInstanceHeaderID!Header to update.
keyStringHeader key.null
valueStringHeader value.null

auditEventsStreamingInstanceHeadersUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
headerAuditEventsStreamingInstanceHeaderUpdates header.

awardEmojiAdd

Input type: AwardEmojiAddInput

awardEmojiAdd arguments

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
nameString!Emoji name.

awardEmojiAdd fields

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
errors[String!]!Errors encountered during the mutation.

awardEmojiRemove

Input type: AwardEmojiRemoveInput

awardEmojiRemove arguments

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
nameString!Emoji name.

awardEmojiRemove fields

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
errors[String!]!Errors encountered during the mutation.

awardEmojiToggle

Input type: AwardEmojiToggleInput

awardEmojiToggle arguments

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
nameString!Emoji name.

awardEmojiToggle fields

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
errors[String!]!Errors encountered during the mutation.
toggledOnBoolean!Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.

boardEpicCreate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: BoardEpicCreateInput

boardEpicCreate arguments

NameTypeDescription
boardIdBoardsEpicBoardID!Global ID of the board that the epic is in.
groupPathID!Group the epic to create is in.
listIdBoardsEpicListID!Global ID of the epic board list in which epic will be created.
titleString!Title of the epic.

boardEpicCreate fields

NameTypeDescription
epicEpicEpic after creation.
errors[String!]!Errors encountered during the mutation.

boardListCreate

Input type: BoardListCreateInput

boardListCreate arguments

NameTypeDescription
assigneeIdUserIDGlobal ID of an existing user.
backlogBooleanCreate the backlog list.
boardIdBoardID!Global ID of the issue board to mutate.
iterationIdIterationIDGlobal ID of an existing iteration.
labelIdLabelIDGlobal ID of an existing label.
milestoneIdMilestoneIDGlobal ID of an existing milestone.
positionIntPosition of the list.
statusIdWorkItemsStatusesStatusIDIntroduced as an experiment in GitLab 18.0.

Global ID of an existing status.

boardListCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
listBoardListIssue list in the issue board.

boardListUpdateLimitMetrics

Input type: BoardListUpdateLimitMetricsInput

boardListUpdateLimitMetrics arguments

NameTypeDescription
limitMetricListLimitMetricNew limit metric type for the list.
listIdListID!Global ID of the list.
maxIssueCountIntNew maximum issue count limit.
maxIssueWeightIntNew maximum issue weight limit.

boardListUpdateLimitMetrics fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
listBoardListUpdated list.

branchDelete

Input type: BranchDeleteInput

branchDelete arguments

NameTypeDescription
nameString!Name of the branch.
projectPathID!Project full path the branch is associated with.

branchDelete fields

NameTypeDescription
branchBranchBranch after mutation.
errors[String!]!Errors encountered during the mutation.

branchRuleApprovalProjectRuleCreate

  • Status: Experiment

Input type: branchRuleApprovalProjectRuleCreateInput

branchRuleApprovalProjectRuleCreate arguments

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

branchRuleApprovalProjectRuleCreate fields

NameTypeDescription
approvalRuleApprovalProjectRuleApproval rule after mutation.
errors[String!]!Errors encountered during the mutation.

branchRuleCreate

  • Status: Experiment

Input type: BranchRuleCreateInput

branchRuleCreate arguments

NameTypeDescription
nameString!Branch name, with wildcards, for the branch rules.
projectPathID!Full path to the project that the branch is associated with.

branchRuleCreate fields

NameTypeDescription
branchRuleBranchRuleBranch rule after mutation.
errors[String!]!Errors encountered during the mutation.

branchRuleDelete

  • Status: Experiment

Input type: BranchRuleDeleteInput

branchRuleDelete arguments

NameTypeDescription
idProjectsBranchRuleID!Global ID of the branch rule to destroy.

branchRuleDelete fields

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

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

branchRuleExternalStatusCheckCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalStatusCheckExternalStatusCheckNew status check after mutation.

branchRuleExternalStatusCheckDestroy

  • Status: Experiment

Destroy an external status check from a branch rule.

Input type: BranchRuleExternalStatusCheckDestroyInput

branchRuleExternalStatusCheckDestroy arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
idMergeRequestsExternalStatusCheckID!Global ID of the external status check to destroy.

branchRuleExternalStatusCheckDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

branchRuleExternalStatusCheckUpdate

  • Status: Experiment

Update an external status check from a branch rule.

Input type: BranchRuleExternalStatusCheckUpdateInput

branchRuleExternalStatusCheckUpdate arguments

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

branchRuleExternalStatusCheckUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalStatusCheckExternalStatusCheckUpdated external status check after mutation.

branchRuleSquashOptionCreate

  • Status: Experiment

Create a squash option for a branch rule.

Input type: BranchRuleSquashOptionCreateInput

branchRuleSquashOptionCreate arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
squashOptionSquashOptionSetting!Squash option to set for the branch rule.

branchRuleSquashOptionCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
squashOptionSquashOptionCreated squash option after mutation.

branchRuleSquashOptionDelete

  • Status: Experiment

Delete a squash option for a branch rule.

Input type: BranchRuleSquashOptionDeleteInput

branchRuleSquashOptionDelete arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.

branchRuleSquashOptionDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

branchRuleSquashOptionUpdate

  • Status: Experiment

Update a squash option for a branch rule.

Input type: BranchRuleSquashOptionUpdateInput

branchRuleSquashOptionUpdate arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
squashOptionSquashOptionSetting!Squash option after mutation.

branchRuleSquashOptionUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
squashOptionSquashOptionUpdated squash option after mutation.

branchRuleUpdate

  • Status: Experiment

Input type: BranchRuleUpdateInput

branchRuleUpdate arguments

NameTypeDescription
branchProtectionBranchProtectionInputBranch protections configured for the branch rule.
idProjectsBranchRuleID!Global ID of the branch rule to update.
nameString!Branch name, with wildcards, for the branch rules.

branchRuleUpdate fields

NameTypeDescription
branchRuleBranchRuleBranch rule after mutation.
errors[String!]!Errors encountered during the mutation.

bulkDestroyJobArtifacts

  • Status: Experiment

Input type: BulkDestroyJobArtifactsInput

bulkDestroyJobArtifacts arguments

NameTypeDescription
ids[CiJobArtifactID!]!Global IDs of the job artifacts to destroy.
projectIdProjectID!Global Project ID of the job artifacts to destroy. Incompatible with projectPath.

bulkDestroyJobArtifacts fields

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

NameTypeDescription
displayNamespaceIdNamespaceIDDisplay namespace ID.
namespaceIds[NamespaceID!]!List of Namespace IDs.

bulkEnableDevopsAdoptionNamespaces fields

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

bulkRunnerDelete

  • Status: Experiment

Input type: BulkRunnerDeleteInput

bulkRunnerDelete arguments

NameTypeDescription
ids[CiRunnerID!]IDs of the runners to delete.

bulkRunnerDelete fields

NameTypeDescription
deletedCountIntNumber of records effectively deleted. Only present if operation was performed synchronously.
deletedIds[CiRunnerID!]IDs of records effectively deleted. Only present if operation was performed synchronously.
errors[String!]!Errors encountered during the mutation.

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

NameTypeDescription
projectFullPathString!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

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

bulkUpdateAiToolRules

  • Status: Experiment

Bulk updates permission settings for multiple AI tool rules.

Input type: BulkUpdateAiToolRulesInput

bulkUpdateAiToolRules arguments

NameTypeDescription
fullPathID!Full path of the root namespace to update tool rules for.
projectPathIDFull path of the project to update tool rules for. When provided, rules can only be stricter than the namespace rule.
toolRules[BulkToolRuleInput!]!Tool rules to update (maximum 100 entries). Each entry replaces the whole rule, so a partial entry clears the access types it omits.

bulkUpdateAiToolRules fields

NameTypeDescription
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

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

bulkUpdateSecurityAttributes fields

NameTypeDescription
errors[String!]!Errors encountered while initiating the bulk update operation.

cancelVulnerabilityWorkflow

  • Status: Experiment

Cancels a vulnerability workflow execution.

Input type: CancelVulnerabilityWorkflowInput

cancelVulnerabilityWorkflow arguments

NameTypeDescription
projectIdProjectID!Global ID of the project.
workflowVulnerabilityDuoWorkflow!Workflow to cancel.

cancelVulnerabilityWorkflow fields

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

catalogResourcesCreate

  • Status: Experiment

Input type: CatalogResourcesCreateInput

catalogResourcesCreate arguments

NameTypeDescription
projectPathID!Project path belonging to the catalog resource.

catalogResourcesCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

catalogResourcesDestroy

  • Status: Experiment

Input type: CatalogResourcesDestroyInput

catalogResourcesDestroy arguments

NameTypeDescription
projectPathID!Project path belonging to the catalog resource.

catalogResourcesDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

cdApplicationCreate

  • Status: Experiment

Creates a continuous deployment application in an organization.

Input type: CdApplicationCreateInput

cdApplicationCreate arguments

NameTypeDescription
descriptionStringDescription of the application.
nameString!Name of the application.
organizationIdOrganizationsOrganizationID!Global ID of the organization to create the application in.
services[CdServiceInput!]Services to create in the application, up to 1000.

cdApplicationCreate fields

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

NameTypeDescription
applicationIdCdApplicationID!Global ID of the application to create the flow definition for.
definitionString!Body of the flow definition.

cdApplicationFlowDefinitionCreate fields

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

NameTypeDescription
applicationIdCdApplicationID!Global ID of the application to create the link in.
linkTypeCdApplicationLinkType!Type of the link.
nameString!Name of the link.
urlString!URL of the link.

cdApplicationLinkCreate fields

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

NameTypeDescription
idCdApplicationLinkID!Global ID of the link to delete.

cdApplicationLinkDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

cdApplicationLinkUpdate

  • Status: Experiment

Updates a link on a continuous deployment application.

Input type: CdApplicationLinkUpdateInput

cdApplicationLinkUpdate arguments

NameTypeDescription
idCdApplicationLinkID!Global ID of the link to update.
linkTypeCdApplicationLinkTypeType of the link.
nameStringName of the link.
urlStringURL of the link.

cdApplicationLinkUpdate fields

NameTypeDescription
applicationLinkCdApplicationLinkLink updated by the mutation.
errors[String!]!Errors encountered during the mutation.

cdApplicationUpdate

  • Status: Experiment

Updates a continuous deployment application.

Input type: CdApplicationUpdateInput

cdApplicationUpdate arguments

NameTypeDescription
descriptionStringDescription of the application.
idCdApplicationID!Global ID of the application to update.
nameStringName of the application.

cdApplicationUpdate fields

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

NameTypeDescription
nameString!Name of the artifact source.
serviceIdCdServiceID!Global ID of the service to create the artifact source for.
sourceConfigJSONConfiguration of the artifact source, defined by the consuming driver.
sourceRefString!Reference of the artifact source.

cdArtifactSourceCreate fields

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

NameTypeDescription
descriptionStringDescription of the environment.
environmentDriverBindingCdEnvironmentDriverBindingInput!Driver binding to create for the environment.
nameString!Name of the environment.
organizationIdOrganizationsOrganizationID!Global ID of the organization to create the environment in.
tierCdEnvironmentTier!Tier of the environment.

cdEnvironmentCreate fields

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

NameTypeDescription
environmentDriverBindingCdEnvironmentDriverBindingInput!Driver binding to create for the environment.
environmentIdCdEnvironmentID!Global ID of the environment to bind the driver to.

cdEnvironmentDriverBindingCreate fields

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

NameTypeDescription
descriptionStringDescription of the environment.
idCdEnvironmentID!Global ID of the environment to update.
nameStringName of the environment.
tierCdEnvironmentTierTier of the environment.

cdEnvironmentUpdate fields

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

NameTypeDescription
organizationIdOrganizationsOrganizationID!Global ID of the organization to create the rollout in.
versionSetIdCdVersionSetID!Global ID of the version set the rollout deploys.

cdRolloutCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
rolloutCdRolloutRollout 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

NameTypeDescription
idCdRolloutID!Global ID of the rollout whose approval gate is being resolved.
resolutionReasonStringReason for the decision.
statusCdRolloutGateStatus!Decision to record for the approval gate.

cdRolloutGateResolve fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
rolloutTransitionCdRolloutTransitionRollout transition journal entry created by the mutation.

cdServiceCreate

  • Status: Experiment

Creates a continuous deployment service in an application.

Input type: CdServiceCreateInput

cdServiceCreate arguments

NameTypeDescription
applicationIdCdApplicationID!Global ID of the application to create the service in.
descriptionStringDescription of the service.
nameString!Name of the service.

cdServiceCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
serviceCdServiceService created by the mutation.

cdServiceUpdate

  • Status: Experiment

Updates a continuous deployment service.

Input type: CdServiceUpdateInput

cdServiceUpdate arguments

NameTypeDescription
descriptionStringDescription of the service.
idCdServiceID!Global ID of the service to update.
nameStringName of the service.

cdServiceUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
serviceCdServiceService 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

NameTypeDescription
artifactSourceIdCdArtifactSourceID!Global ID of the artifact source to create the version for.
nameString!Name of the version.

cdVersionCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
versionCdVersionVersion created by the mutation.

cdVersionSetCreate

  • Status: Experiment

Creates a continuous deployment version set in an application.

Input type: CdVersionSetCreateInput

cdVersionSetCreate arguments

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

cdVersionSetCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
versionSetCdVersionSetVersion set created by the mutation.

ciJobTokenScopeAddGroupOrProject

Input type: CiJobTokenScopeAddGroupOrProjectInput

ciJobTokenScopeAddGroupOrProject arguments

NameTypeDescriptionDefault
defaultPermissionsBooleanIntroduced 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.
[]
projectPathID!Project that the CI job token scope belongs to.
targetPathID!Group or project to be added to the CI job token scope.

ciJobTokenScopeAddGroupOrProject fields

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntryCiJobTokenScopeAllowlistEntryIntroduced 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

NameTypeDescription
directionCiJobTokenScopeDirectionDeprecated in GitLab 16.0. Outbound job token scope is being removed. This field can now only be set to INBOUND.
projectPathID!Project that the CI job token scope belongs to.
targetProjectPathID!Project to be added to the CI job token scope.

ciJobTokenScopeAddProject fields

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntryCiJobTokenScopeAllowlistEntryIntroduced 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

NameTypeDescription
projectPathID!Project that the CI job token scope belongs to.
targetGroupPathID!Group to be removed from the CI job token scope.

ciJobTokenScopeRemoveGroup fields

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntryCiJobTokenScopeAllowlistEntryIntroduced 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

NameTypeDescription
directionCiJobTokenScopeDirectionDeprecated in GitLab 16.9. Outbound job token scope is being removed. This field can now only be set to INBOUND.
projectPathID!Project that the CI job token scope belongs to.
targetProjectPathID!Project to be removed from the CI job token scope.

ciJobTokenScopeRemoveProject fields

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntryCiJobTokenScopeAllowlistEntryIntroduced 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

NameTypeDescription
defaultPermissionsBoolean!Indicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
jobTokenPolicies[CiJobTokenScopePolicies!]!List of policies added to the CI job token scope.
projectPathID!Project that the CI job token scope belongs to.
targetPathID!Group or project that the CI job token targets.

ciJobTokenScopeUpdatePolicies fields

NameTypeDescription
ciJobTokenScopeAllowlistEntryCiJobTokenScopeAllowlistEntryIntroduced as an experiment in GitLab 17.6.

Allowlist entry for the CI job token’s access scope.
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

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

ciLint fields

NameTypeDescription
configCiConfigV2Linted CI config and metadata.
errors[String!]!Errors encountered during the mutation.

clusterAgentDelete

Input type: ClusterAgentDeleteInput

clusterAgentDelete arguments

NameTypeDescription
idClustersAgentID!Global ID of the cluster agent that will be deleted.

clusterAgentDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

clusterAgentTokenCreate

Input type: ClusterAgentTokenCreateInput

clusterAgentTokenCreate arguments

NameTypeDescription
clusterAgentIdClustersAgentID!Global ID of the cluster agent that will be associated with the new token.
descriptionStringDescription of the token.
nameString!Name of the token.

clusterAgentTokenCreate fields

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

clusterAgentTokenRevoke

Input type: ClusterAgentTokenRevokeInput

clusterAgentTokenRevoke arguments

NameTypeDescription
idClustersAgentTokenID!Global ID of the agent token that will be revoked.

clusterAgentTokenRevoke fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

clusterAgentUrlConfigurationCreate

Input type: ClusterAgentUrlConfigurationCreateInput

clusterAgentUrlConfigurationCreate arguments

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

clusterAgentUrlConfigurationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
urlConfigurationClusterAgentUrlConfigurationURL configuration created after mutation.

clusterAgentUrlConfigurationDelete

Input type: ClusterAgentUrlConfigurationDeleteInput

clusterAgentUrlConfigurationDelete arguments

NameTypeDescription
idClustersAgentsUrlConfigurationID!Global ID of the agent URL configuration that will be deleted.

clusterAgentUrlConfigurationDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

commitCreate

Input type: CommitCreateInput

commitCreate arguments

NameTypeDescriptionDefault
actions[CommitAction!]Array of action hashes to commit as a batch.[]
allowEmptyBooleanIndicates whether an empty commit can be created. Defaults to false.false
branchString!Name of the branch to commit into, it can be a new branch.
messageString!Raw commit message.
projectPathID!Project full path the branch is associated with.
startBranchStringIf on a new branch, name of the original branch.
startProjectPathIDFull path of the project to start the commit from. Must be the project itself or a project it was forked from.
startShaStringSHA of the commit to start the new branch from. Mutually exclusive with startBranch.

commitCreate fields

NameTypeDescription
commitCommitCommit after mutation.
commitPipelinePathStringETag 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

NameTypeDescription
projectPathID!Full path of the project.

configureContainerScanning fields

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

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

NameTypeDescription
projectPathID!Full path of the project.

configureDependencyScanning fields

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

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

NameTypeDescription
configurationSastCiConfigurationInput!SAST CI configuration for the project.
projectPathID!Full path of the project.

configureSast fields

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

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

NameTypeDescription
projectPathID!Full path of the project.

configureSastIac fields

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

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

NameTypeDescription
projectPathID!Full path of the project.

configureSecretDetection fields

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

containerCacheEntryDelete

  • Status: Experiment

Input type: ContainerCacheEntryDeleteInput

containerCacheEntryDelete arguments

NameTypeDescription
idString!ID of the cache entry.

containerCacheEntryDelete fields

NameTypeDescription
cacheEntryContainerUpstreamCacheEntryDeleted container cache entry.
errors[String!]!Errors encountered during the mutation.

containerUpstreamCacheDelete

  • Status: Experiment

Input type: ContainerUpstreamCacheDeleteInput

containerUpstreamCacheDelete arguments

NameTypeDescription
idVirtualRegistriesContainerUpstreamID!ID of the container virtual registry upstream.

containerUpstreamCacheDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
upstreamContainerUpstreamContainer virtual registry upstream.

containerUpstreamCreate

  • Status: Experiment

Input type: ContainerUpstreamCreateInput

containerUpstreamCreate arguments

NameTypeDescriptionDefault
cacheValidityHoursIntCache validity period. Defaults to 24 hours.24
descriptionStringDescription of the upstream registry.
idVirtualRegistriesContainerRegistryID!ID of the upstream registry.
nameString!Name of upstream registry.
passwordStringPassword of the upstream registry.
urlString!URL of the upstream registry.
usernameStringUsername of the upstream registry.

containerUpstreamCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
upstreamContainerUpstreamDetailsContainer upstream after the mutation.

containerUpstreamDelete

  • Status: Experiment

Input type: ContainerUpstreamDeleteInput

containerUpstreamDelete arguments

NameTypeDescription
idVirtualRegistriesContainerUpstreamID!ID of the upstream to be deleted.

containerUpstreamDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
upstreamContainerUpstreamDetailsDestroyed upstream.

containerUpstreamTest

  • Status: Experiment

Input type: ContainerUpstreamTestInput

containerUpstreamTest arguments

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

containerUpstreamTest fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
successBoolean!Whether the upstream connectivity test was successful.

containerUpstreamUpdate

  • Status: Experiment

Input type: ContainerUpstreamUpdateInput

containerUpstreamUpdate arguments

NameTypeDescription
cacheValidityHoursIntCache validity period.
descriptionStringDescription of the upstream registry.
idVirtualRegistriesContainerUpstreamID!ID of the container virtual registry upstream.
nameStringName of upstream registry.
passwordStringPassword of the upstream registry.
urlStringURL of the upstream registry.
usernameStringUsername of the upstream registry.

containerUpstreamUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
upstreamContainerUpstreamDetailsContainer upstream after the mutation.

containerVirtualRegistryCacheDelete

  • Status: Experiment

Input type: ContainerVirtualRegistryCacheDeleteInput

containerVirtualRegistryCacheDelete arguments

NameTypeDescription
idVirtualRegistriesContainerRegistryID!ID of the container virtual registry.

containerVirtualRegistryCacheDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryContainerRegistryContainer virtual registry.

containerVirtualRegistryCreate

  • Status: Experiment

Input type: ContainerVirtualRegistryCreateInput

containerVirtualRegistryCreate arguments

NameTypeDescription
descriptionStringDescription of the virtual registry.
groupPathIDFull path of the group with which the resource is associated.
nameString!Name of virtual registry.

containerVirtualRegistryCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryContainerRegistryContainer virtual registry after the mutation.

containerVirtualRegistryDelete

  • Status: Experiment

Input type: ContainerVirtualRegistryDeleteInput

containerVirtualRegistryDelete arguments

NameTypeDescription
idVirtualRegistriesContainerRegistryID!ID of the container virtual registry to be deleted.

containerVirtualRegistryDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryContainerRegistryDeleted container virtual registry.

containerVirtualRegistryUpdate

  • Status: Experiment

Input type: ContainerVirtualRegistryUpdateInput

containerVirtualRegistryUpdate arguments

NameTypeDescription
descriptionStringDescription of the virtual registry.
idVirtualRegistriesContainerRegistryID!ID of the container virtual registry to be updated.
nameStringName of virtual registry.

containerVirtualRegistryUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryContainerRegistryContainer virtual registry after the mutation.

containerVirtualRegistryUpstreamCreate

  • Status: Experiment

Input type: ContainerVirtualRegistryUpstreamCreateInput

containerVirtualRegistryUpstreamCreate arguments

NameTypeDescription
registryIdVirtualRegistriesContainerRegistryID!ID of the container virtual registry.
upstreamIdVirtualRegistriesContainerUpstreamID!ID of the upstream.

containerVirtualRegistryUpstreamCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryUpstreamContainerRegistryUpstreamWithRegistryContainer registry upstream after association.

containerVirtualRegistryUpstreamDelete

  • Status: Experiment

Input type: ContainerVirtualRegistryUpstreamDeleteInput

containerVirtualRegistryUpstreamDelete arguments

NameTypeDescription
upstreamIdVirtualRegistriesContainerRegistryUpstreamID!ID of the container virtual registry upstream.

containerVirtualRegistryUpstreamDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryUpstreamContainerRegistryUpstreamWithRegistryDeleted container registry upstream.

containerVirtualRegistryUpstreamUpdate

  • Status: Experiment

Input type: ContainerVirtualRegistryUpstreamUpdateInput

containerVirtualRegistryUpstreamUpdate arguments

NameTypeDescription
idVirtualRegistriesContainerRegistryUpstreamID!ID of the container virtual registry upstream.
positionInt!Priority order of an upstream within a virtual registry.

containerVirtualRegistryUpstreamUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryUpstreamContainerRegistryUpstreamWithRegistryContainer registry upstream after update.

corpusCreate

Input type: CorpusCreateInput

corpusCreate arguments

NameTypeDescription
fullPathID!Project the corpus belongs to.
packageIdPackagesPackageID!ID of the corpus package.

corpusCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

createAlertIssue

Input type: CreateAlertIssueInput

createAlertIssue arguments

NameTypeDescription
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.

createAlertIssue fields

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

createAnnotation

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

Input type: CreateAnnotationInput

createAnnotation arguments

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

createAnnotation fields

NameTypeDescription
annotationMetricsDashboardAnnotationCreated annotation.
errors[String!]!Errors encountered during the mutation.

createBoard

Input type: CreateBoardInput

createBoard arguments

NameTypeDescription
assigneeIdUserIDID of user to be assigned to the board.
groupPathIDFull path of the group with which the resource is associated.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
iterationCadenceIdIterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationIdIterationIDID of iteration to be assigned to the board.
labelIds[LabelID!]IDs of labels to be added to the board.
labels[String!]Labels of the issue.
milestoneIdMilestoneIDID of milestone to be assigned to the board.
nameStringBoard name.
projectPathIDFull path of the project with which the resource is associated.
weightIntWeight value to be assigned to the board.

createBoard fields

NameTypeDescription
boardBoardBoard after mutation.
errors[String!]!Errors encountered during the mutation.

createBranch

Input type: CreateBranchInput

createBranch arguments

NameTypeDescription
nameString!Name of the branch.
projectPathID!Project full path the branch is associated with.
refString!Branch name or commit SHA to create branch from.

createBranch fields

NameTypeDescription
branchBranchBranch after mutation.
errors[String!]!Errors encountered during the mutation.

createClusterAgent

Input type: CreateClusterAgentInput

createClusterAgent arguments

NameTypeDescription
nameString!Name of the cluster agent.
projectPathID!Full path of the associated project for the cluster agent.

createClusterAgent fields

NameTypeDescription
clusterAgentClusterAgentCluster agent created after mutation.
errors[String!]!Errors encountered during the mutation.

createComplianceFramework

Input type: CreateComplianceFrameworkInput

createComplianceFramework arguments

NameTypeDescription
namespacePathID!Full path of the namespace to add the compliance framework to.
paramsComplianceFrameworkInput!Parameters to update the compliance framework with.

createComplianceFramework fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
frameworkComplianceFrameworkCreated compliance framework.

createComplianceFrameworkFromTemplate

  • Status: Experiment

Input type: CreateComplianceFrameworkFromTemplateInput

createComplianceFrameworkFromTemplate arguments

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

createComplianceFrameworkFromTemplate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
frameworkComplianceFrameworkCreated compliance framework.

createComplianceRequirement

  • Status: Experiment

Input type: CreateComplianceRequirementInput

createComplianceRequirement arguments

NameTypeDescription
complianceFrameworkIdComplianceManagementFrameworkID!Global ID of the compliance framework of the new requirement.
controls[ComplianceRequirementsControlInput!]Controls to add to the compliance requirement.
paramsComplianceRequirementInput!Parameters to update the compliance requirement with.

createComplianceRequirement fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
requirementComplianceRequirementCreated compliance requirement.

createComplianceRequirementsControl

  • Status: Experiment

Input type: CreateComplianceRequirementsControlInput

createComplianceRequirementsControl arguments

NameTypeDescription
complianceRequirementIdComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement of the new control.
paramsComplianceRequirementsControlInput!Parameters to create the compliance requirement control.

createComplianceRequirementsControl fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
requirementsControlComplianceRequirementsControlCreated compliance requirements control.

createContainerProtectionRepositoryRule

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

Input type: CreateContainerProtectionRepositoryRuleInput

createContainerProtectionRepositoryRule arguments

NameTypeDescription
minimumAccessLevelForDeleteContainerProtectionRepositoryRuleAccessLevelIntroduced 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.
minimumAccessLevelForPushContainerProtectionRepositoryRuleAccessLevelMinimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
projectPathID!Full path of the project where a protection rule is located.
repositoryPathPatternString!Container repository path pattern protected by the protection rule. Must start with the project’s full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project’s full path.

createContainerProtectionRepositoryRule fields

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

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

createContainerProtectionTagRule fields

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

NameTypeDescription
configCustomDashboardConfigInput!Dashboard layout/config.
descriptionStringDashboard description.
nameString!Dashboard name.
namespaceIdNamespaceIDNamespace to scope the dashboard to.
organizationIdOrganizationsOrganizationIDOrganization the dashboard belongs to. Defaults to the current organization if not provided.

createCustomDashboard fields

NameTypeDescription
dashboardCustomDashboardNewly created dashboard.
errors[String!]!Errors encountered during creation.

createCustomEmoji

Input type: CreateCustomEmojiInput

createCustomEmoji arguments

NameTypeDescription
groupPathID!Namespace full path the emoji is associated with.
nameString!Name of the emoji.
urlString!Location of the emoji file.

createCustomEmoji fields

NameTypeDescription
customEmojiCustomEmojiNew custom emoji.
errors[String!]!Errors encountered during the mutation.

createDiffNote

Input type: CreateDiffNoteInput

createDiffNote arguments

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

createDiffNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

createDiscussion

Input type: CreateDiscussionInput

createDiscussion arguments

NameTypeDescription
bodyString!Content of the note.
internalBooleanInternal flag for a note. Default is false.
noteableIdNoteableID!Global ID of the resource to add a note to.

createDiscussion fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus 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

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

createEpic fields

NameTypeDescription
epicEpicCreated epic.
errors[String!]!Errors encountered during the mutation.

createFunctionalVerificationWorkflow

  • Status: Experiment

Input type: CreateFunctionalVerificationWorkflowInput

createFunctionalVerificationWorkflow arguments

NameTypeDescription
checkTypeFunctionalVerificationCheckType!Type of functional verification check to run.
fullPathID!Full path of the namespace to run the verification check against.

createFunctionalVerificationWorkflow fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workflowIdAiDuoWorkflowsWorkflowIDGlobal ID of the workflow created for the run.

createImageDiffNote

Input type: CreateImageDiffNoteInput

createImageDiffNote arguments

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

createImageDiffNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

createIssue

Input type: CreateIssueInput

createIssue arguments

NameTypeDescription
assigneeIds[UserID!]Array of user IDs to assign to the issue.
confidentialBooleanIndicates the issue is confidential.
createdAtTimeTimestamp when the issue was created. Available only for admins and project owners.
descriptionStringDescription of the issue.
discussionToResolveStringID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of.
dueDateISO8601DateDue date of the issue.
epicIdEpicIDDeprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
healthStatusHealthStatusDesired health status.
iidIntIID (internal ID) of a project issue. Only admins and project owners can modify.
iterationCadenceIdIterationsCadenceIDGlobal iteration cadence ID. Required when iterationWildcardId is provided.
iterationIdIterationIDGlobal iteration ID. Mutually exclusive argument with iterationWildcardId.
iterationWildcardIdIssueCreationIterationWildcardIdIteration wildcard ID. Supported values are: CURRENT. Mutually exclusive argument with iterationId. iterationCadenceId also required when this argument is provided.
labelIds[LabelID!]IDs of labels to be added to the issue.
labels[String!]Labels of the issue.
lockedBooleanIndicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOfMergeRequestIDIID of a merge request for which to resolve discussions.
milestoneIdMilestoneIDID of the milestone to assign to the issue. On update milestone will be removed if set to null.
moveAfterIdIssueIDGlobal ID of issue that should be placed after the current issue.
moveBeforeIdIssueIDGlobal ID of issue that should be placed before the current issue.
projectPathID!Project full path the issue is associated with.
statusIdWorkItemsStatusesStatusIDGlobal ID of the status.
titleString!Title of the issue.
typeIssueTypeType of the issue.
weightIntWeight of the issue.

createIssue fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

createIteration

Deprecated in GitLab 14.0. Use iterationCreate.

Input type: CreateIterationInput

createIteration arguments

NameTypeDescription
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathIDFull path of the group with which the resource is associated.
iterationsCadenceIdIterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPathIDFull path of the project with which the resource is associated.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

createIteration fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
iterationIterationCreated 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

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

createLatestDiffNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus 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

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

createNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

createPackagesProtectionRule

Creates a protection rule to restrict access to project packages.

Input type: CreatePackagesProtectionRuleInput

createPackagesProtectionRule arguments

NameTypeDescription
minimumAccessLevelForDeletePackagesProtectionRuleAccessLevelForDeleteIntroduced 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.
minimumAccessLevelForPushPackagesProtectionRuleAccessLevelMinimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
packageNamePatternString!Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageTypePackagesProtectionRulePackageType!Package type protected by the protection rule. For example, NPM, PYPI.
projectPathID!Full path of the project where a protection rule is located.

createPackagesProtectionRule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule after mutation.

createRequirement

Input type: CreateRequirementInput

createRequirement arguments

NameTypeDescription
descriptionStringDescription of the requirement.
projectPathID!Full project path the requirement is associated with.
titleStringTitle of the requirement.

createRequirement fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
requirementRequirementRequirement after mutation.

createSnippet

Input type: CreateSnippetInput

createSnippet arguments

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

createSnippet fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
snippetSnippetSnippet after mutation.

createTerraformStateProtectionRule

  • Status: Experiment

Creates a protection rule for a Terraform state backend.

Input type: CreateTerraformStateProtectionRuleInput

createTerraformStateProtectionRule arguments

NameTypeDescriptionDefault
allowedFromTerraformStateProtectionRuleAllowedFromIntroduced 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
minimumAccessLevelForWriteTerraformStateProtectionRuleAccessLevel!Minimum GitLab access level required to perform write operations on the Terraform state. Valid values include DEVELOPER, MAINTAINER, OWNER, or ADMIN.
projectPathID!Full path of the project where the protection rule is located.
stateNameString!Terraform state name protected by the rule.

createTerraformStateProtectionRule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
terraformStateProtectionRuleTerraformStateProtectionRuleIntroduced as an experiment in GitLab 19.1.

Terraform state protection rule after mutation.

createTestCase

Input type: CreateTestCaseInput

createTestCase arguments

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

createTestCase fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
testCaseIssueTest case created.

customFieldArchive

  • Status: Experiment

Input type: CustomFieldArchiveInput

customFieldArchive arguments

NameTypeDescription
idIssuablesCustomFieldID!Global ID of the custom field.

customFieldArchive fields

NameTypeDescription
customFieldCustomFieldArchived custom field.
errors[String!]!Errors encountered during the mutation.

customFieldCreate

  • Status: Experiment

Input type: CustomFieldCreateInput

customFieldCreate arguments

NameTypeDescription
fieldTypeCustomFieldType!Type of custom field.
groupPathID!Group path where the custom field is created.
nameString!Name of the custom field.
selectOptions[CustomFieldSelectOptionInput!]Available options for a select field.
workItemTypeIds[WorkItemsTypeID!]Work item type global IDs associated to the custom field.

customFieldCreate fields

NameTypeDescription
customFieldCustomFieldCreated custom field.
errors[String!]!Errors encountered during the mutation.

customFieldUnarchive

  • Status: Experiment

Input type: CustomFieldUnarchiveInput

customFieldUnarchive arguments

NameTypeDescription
idIssuablesCustomFieldID!Global ID of the custom field.

customFieldUnarchive fields

NameTypeDescription
customFieldCustomFieldUnarchived custom field.
errors[String!]!Errors encountered during the mutation.

customFieldUpdate

  • Status: Experiment

Input type: CustomFieldUpdateInput

customFieldUpdate arguments

NameTypeDescription
idIssuablesCustomFieldID!Global ID of the custom field.
nameStringName of the custom field.
selectOptions[CustomFieldSelectOptionInput!]Available options for a select field.
workItemTypeIds[WorkItemsTypeID!]Work item type global IDs associated to the custom field.

customFieldUpdate fields

NameTypeDescription
customFieldCustomFieldUpdated custom field.
errors[String!]!Errors encountered during the mutation.

customerRelationsContactCreate

Input type: CustomerRelationsContactCreateInput

customerRelationsContactCreate arguments

NameTypeDescription
descriptionStringDescription of or notes for the contact.
emailStringEmail address of the contact.
firstNameString!First name of the contact.
groupIdGroupID!Group for the contact.
lastNameString!Last name of the contact.
organizationIdCustomerRelationsOrganizationIDOrganization for the contact.
phoneStringPhone number of the contact.

customerRelationsContactCreate fields

NameTypeDescription
contactCustomerRelationsContactContact after the mutation.
errors[String!]!Errors encountered during the mutation.

customerRelationsContactUpdate

Input type: CustomerRelationsContactUpdateInput

customerRelationsContactUpdate arguments

NameTypeDescription
activeBooleanState of the contact.
descriptionStringDescription of or notes for the contact.
emailStringEmail address of the contact.
firstNameStringFirst name of the contact.
idCustomerRelationsContactID!Global ID of the contact.
lastNameStringLast name of the contact.
organizationIdCustomerRelationsOrganizationIDOrganization of the contact.
phoneStringPhone number of the contact.

customerRelationsContactUpdate fields

NameTypeDescription
contactCustomerRelationsContactContact after the mutation.
errors[String!]!Errors encountered during the mutation.

customerRelationsOrganizationCreate

Input type: CustomerRelationsOrganizationCreateInput

customerRelationsOrganizationCreate arguments

NameTypeDescription
defaultRateFloatStandard billing rate for the organization.
descriptionStringDescription of or notes for the organization.
groupIdGroupID!Group for the organization.
nameString!Name of the organization.

customerRelationsOrganizationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationCustomerRelationsOrganizationOrganization after the mutation.

customerRelationsOrganizationUpdate

Input type: CustomerRelationsOrganizationUpdateInput

customerRelationsOrganizationUpdate arguments

NameTypeDescription
activeBooleanState of the organization.
defaultRateFloatStandard billing rate for the organization.
descriptionStringDescription of or notes for the organization.
idCustomerRelationsOrganizationID!Global ID of the organization.
nameStringName of the organization.

customerRelationsOrganizationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationCustomerRelationsOrganization!Organization after the mutation.

dastOnDemandScanCreate

Input type: DastOnDemandScanCreateInput

dastOnDemandScanCreate arguments

NameTypeDescription
dastScannerProfileIdDastScannerProfileIDID of the scanner profile to be used for the scan.
dastSiteProfileIdDastSiteProfileID!ID of the site profile to be used for the scan.
fullPathID!Project the site profile belongs to.

dastOnDemandScanCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelineUrlStringURL of the pipeline that was created.

dastProfileCreate

Input type: DastProfileCreateInput

dastProfileCreate arguments

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

dastProfileCreate fields

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

dastProfileDelete

Input type: DastProfileDeleteInput

dastProfileDelete arguments

NameTypeDescription
idDastProfileID!ID of the profile to be deleted.

dastProfileDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

dastProfileRun

Input type: DastProfileRunInput

dastProfileRun arguments

NameTypeDescription
fullPathIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastProfileID!ID of the profile to be used for the scan.

dastProfileRun fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelineUrlStringURL of the pipeline that was created.

dastProfileUpdate

Input type: DastProfileUpdateInput

dastProfileUpdate arguments

NameTypeDescriptionDefault
branchNameStringAssociated branch.
dastProfileScheduleDastProfileScheduleInputRepresents a DAST profile schedule.
dastScannerProfileIdDastScannerProfileIDID of the scanner profile to be associated.
dastSiteProfileIdDastSiteProfileIDID of the site profile to be associated.
descriptionStringDescription of the profile. Defaults to an empty string.""
fullPathIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastProfileID!ID of the profile to be deleted.
nameStringName of the profile.
runAfterUpdateBooleanRun scan using profile after update. Defaults to false.false
tagList[String!]Indicates the runner tags associated with the profile.

dastProfileUpdate fields

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

dastScannerProfileCreate

Input type: DastScannerProfileCreateInput

dastScannerProfileCreate arguments

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

dastScannerProfileCreate fields

NameTypeDescription
dastScannerProfileDastScannerProfileCreated scanner profile.
errors[String!]!Errors encountered during the mutation.
idDastScannerProfileIDDeprecated in GitLab 14.10. use dastScannerProfile field.

dastScannerProfileDelete

Input type: DastScannerProfileDeleteInput

dastScannerProfileDelete arguments

NameTypeDescription
fullPathIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastScannerProfileID!ID of the scanner profile to be deleted.

dastScannerProfileDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

dastScannerProfileUpdate

Input type: DastScannerProfileUpdateInput

dastScannerProfileUpdate arguments

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

dastScannerProfileUpdate fields

NameTypeDescription
dastScannerProfileDastScannerProfileUpdated scanner profile.
errors[String!]!Errors encountered during the mutation.
idDastScannerProfileIDDeprecated in GitLab 14.10. use dastScannerProfile field.

dastSiteProfileCreate

Input type: DastSiteProfileCreateInput

dastSiteProfileCreate arguments

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

dastSiteProfileCreate fields

NameTypeDescription
dastSiteProfileDastSiteProfileSite Profile object.
errors[String!]!Errors encountered during the mutation.
idDastSiteProfileIDDeprecated in GitLab 14.10. use dastSiteProfile.id field.

dastSiteProfileDelete

Input type: DastSiteProfileDeleteInput

dastSiteProfileDelete arguments

NameTypeDescription
fullPathIDDeprecated in GitLab 14.5. Full path not required to qualify Global ID.
idDastSiteProfileID!ID of the site profile to be deleted.

dastSiteProfileDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

dastSiteProfileUpdate

Input type: DastSiteProfileUpdateInput

dastSiteProfileUpdate arguments

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

dastSiteProfileUpdate fields

NameTypeDescription
dastSiteProfileDastSiteProfileSite profile object.
errors[String!]!Errors encountered during the mutation.
idDastSiteProfileIDDeprecated in GitLab 14.10. use dastSiteProfile.id field.

dastSiteTokenCreate

Input type: DastSiteTokenCreateInput

dastSiteTokenCreate arguments

NameTypeDescription
fullPathID!Project the site token belongs to.
targetUrlStringURL of the target to be validated.

dastSiteTokenCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
idDastSiteTokenIDID of the site token.
statusDastSiteProfileValidationStatusEnumCurrent validation status of the target.
tokenStringToken string.

dastSiteValidationCreate

Input type: DastSiteValidationCreateInput

dastSiteValidationCreate arguments

NameTypeDescription
dastSiteTokenIdDastSiteTokenID!ID of the site token.
fullPathID!Project the site profile belongs to.
strategyDastSiteValidationStrategyEnumValidation strategy to be used.
validationPathString!Path to be requested during validation.

dastSiteValidationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
idDastSiteValidationIDID of the site validation.
statusDastSiteProfileValidationStatusEnumCurrent validation status.

dastSiteValidationRevoke

Input type: DastSiteValidationRevokeInput

dastSiteValidationRevoke arguments

NameTypeDescription
fullPathID!Project the site validation belongs to.
normalizedTargetUrlString!Normalized URL of the target to be revoked.

dastSiteValidationRevoke fields

NameTypeDescription
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

NameTypeDescription
idString!Global ID of the annotation to delete.

deleteAnnotation fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

deleteContainerProtectionRepositoryRule

Deletes a container repository protection rule.

Input type: DeleteContainerProtectionRepositoryRuleInput

deleteContainerProtectionRepositoryRule arguments

NameTypeDescription
idContainerRegistryProtectionRuleID!Global ID of the container repository protection rule to delete.

deleteContainerProtectionRepositoryRule fields

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

NameTypeDescription
idContainerRegistryProtectionTagRuleID!Global ID of the tag protection rule to delete.

deleteContainerProtectionTagRule fields

NameTypeDescription
containerProtectionTagRuleContainerProtectionTagRuleDeleted protection rule for container image tags.
errors[String!]!Errors encountered during the mutation.

deleteConversationThread

  • Status: Experiment

Input type: DeleteConversationThreadInput

deleteConversationThread arguments

NameTypeDescription
threadIdAiConversationThreadID!Global ID of the thread to delete.

deleteConversationThread fields

NameTypeDescription
errors[String!]!List of errors that occurred whilst trying to delete the thread.
successBoolean!Returns true if thread was successfully deleted.

deleteCustomDashboard

  • Status: Experiment

Deletes a custom dashboard.

Input type: DeleteCustomDashboardInput

deleteCustomDashboard arguments

NameTypeDescription
idAnalyticsCustomDashboardsDashboardID!Global ID of the dashboard to delete.

deleteCustomDashboard fields

NameTypeDescription
dashboardCustomDashboardDeleted dashboard.
errors[String!]!Errors encountered during deletion.

deleteDuoWorkflowsWorkflow

  • Status: Experiment

Input type: DeleteDuoWorkflowsWorkflowInput

deleteDuoWorkflowsWorkflow arguments

NameTypeDescription
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to delete.

deleteDuoWorkflowsWorkflow fields

NameTypeDescription
errors[String!]!List of errors that occurred whilst trying to delete the workflow.
successBoolean!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

NameTypeDescription
groupPathID!Full path of the group.
keyString!Key of the custom attribute to delete.

deleteGroupCustomAttribute fields

NameTypeDescription
customAttributeCustomAttributeDeleted custom attribute.
errors[String!]!Errors encountered during the mutation.

deletePackagesProtectionRule

Deletes a protection rule for packages.

Input type: DeletePackagesProtectionRuleInput

deletePackagesProtectionRule arguments

NameTypeDescription
idPackagesProtectionRuleID!Global ID of the package protection rule to delete.

deletePackagesProtectionRule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule that was deleted successfully.

deletePagesDeployment

  • Status: Experiment

Deletes a Pages deployment.

Input type: DeletePagesDeploymentInput

deletePagesDeployment arguments

NameTypeDescription
idPagesDeploymentID!ID of the Pages Deployment.

deletePagesDeployment fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pagesDeploymentPagesDeployment!Deleted Pages Deployment.

deleteProjectCustomAttribute

  • Status: Experiment

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

Input type: DeleteProjectCustomAttributeInput

deleteProjectCustomAttribute arguments

NameTypeDescription
keyString!Key of the custom attribute to delete.
projectPathID!Full path of the project.

deleteProjectCustomAttribute fields

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

NameTypeDescription
idTerraformStateProtectionRuleID!Global ID of the Terraform state protection rule to delete.

deleteTerraformStateProtectionRule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
terraformStateProtectionRuleTerraformStateProtectionRuleIntroduced 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

NameTypeDescription
keyString!Key of the custom attribute to delete.
userIdUserID!Global ID of the user.

deleteUserCustomAttribute fields

NameTypeDescription
customAttributeCustomAttributeDeleted custom attribute.
errors[String!]!Errors encountered during the mutation.

designManagementDelete

Input type: DesignManagementDeleteInput

designManagementDelete arguments

NameTypeDescription
filenames[String!]!Filenames of the designs to delete.
iidID!IID of the issue to modify designs for.
projectPathID!Project where the issue is to upload designs for.

designManagementDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
versionDesignVersionNew version in which the designs are deleted.

designManagementMove

Input type: DesignManagementMoveInput

designManagementMove arguments

NameTypeDescription
idDesignManagementDesignID!ID of the design to move.
nextDesignManagementDesignIDID of the immediately following design.
previousDesignManagementDesignIDID of the immediately preceding design.

designManagementMove fields

NameTypeDescription
designCollectionDesignCollectionCurrent state of the collection.
errors[String!]!Errors encountered during the mutation.

designManagementUpdate

Input type: DesignManagementUpdateInput

designManagementUpdate arguments

NameTypeDescription
descriptionStringDescription of the design.
idDesignManagementDesignID!ID of the design to update.

designManagementUpdate fields

NameTypeDescription
designDesign!Updated design.
errors[String!]!Errors encountered during the mutation.

designManagementUpload

Input type: DesignManagementUploadInput

designManagementUpload arguments

NameTypeDescription
files[Upload!]!Files to upload.
iidID!IID of the issue to modify designs for.
projectPathID!Project where the issue is to upload designs for.

designManagementUpload fields

NameTypeDescription
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

NameTypeDescription
idBoardID!Global ID of the board to destroy.

destroyBoard fields

NameTypeDescription
boardBoardBoard after mutation.
errors[String!]!Errors encountered during the mutation.

destroyBoardList

Input type: DestroyBoardListInput

destroyBoardList arguments

NameTypeDescription
listIdListID!Global ID of the list to destroy. Only label lists are accepted.

destroyBoardList fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
listBoardListList after mutation.

destroyComplianceFramework

Input type: DestroyComplianceFrameworkInput

destroyComplianceFramework arguments

NameTypeDescription
idComplianceManagementFrameworkID!Global ID of the compliance framework to destroy.

destroyComplianceFramework fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

destroyComplianceRequirement

  • Status: Experiment

Input type: DestroyComplianceRequirementInput

destroyComplianceRequirement arguments

NameTypeDescription
idComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement to destroy.

destroyComplianceRequirement fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

destroyComplianceRequirementsControl

  • Status: Experiment

Input type: DestroyComplianceRequirementsControlInput

destroyComplianceRequirementsControl arguments

NameTypeDescription
idComplianceManagementComplianceFrameworkComplianceRequirementsControlID!Global ID of the compliance requirement control to destroy.

destroyComplianceRequirementsControl fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

destroyContainerRepository

Input type: DestroyContainerRepositoryInput

destroyContainerRepository arguments

NameTypeDescription
idContainerRepositoryID!ID of the container repository.

destroyContainerRepository fields

NameTypeDescription
containerRepositoryContainerRepository!Container repository policy after scheduling the deletion.
errors[String!]!Errors encountered during the mutation.

destroyContainerRepositoryTags

Input type: DestroyContainerRepositoryTagsInput

destroyContainerRepositoryTags arguments

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

destroyContainerRepositoryTags fields

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

destroyCustomEmoji

Input type: DestroyCustomEmojiInput

destroyCustomEmoji arguments

NameTypeDescription
idCustomEmojiID!Global ID of the custom emoji to destroy.

destroyCustomEmoji fields

NameTypeDescription
customEmojiCustomEmojiDeleted custom emoji.
errors[String!]!Errors encountered during the mutation.

destroyEpicBoard

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: DestroyEpicBoardInput

destroyEpicBoard arguments

NameTypeDescription
idBoardsEpicBoardID!Global ID of the board to destroy.

destroyEpicBoard fields

NameTypeDescription
epicBoardEpicBoardEpic board after mutation.
errors[String!]!Errors encountered during the mutation.

destroyNote

Input type: DestroyNoteInput

destroyNote arguments

NameTypeDescription
idNoteID!Global ID of the note to destroy.

destroyNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

destroyPackage

Input type: DestroyPackageInput

destroyPackage arguments

NameTypeDescription
idPackagesPackageID!ID of the Package.

destroyPackage fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

destroyPackageFile

Input type: DestroyPackageFileInput

destroyPackageFile arguments

NameTypeDescription
idPackagesPackageFileID!ID of the Package file.

destroyPackageFile fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

destroyPackageFiles

Input type: DestroyPackageFilesInput

destroyPackageFiles arguments

NameTypeDescription
ids[PackagesPackageFileID!]!IDs of the Package file.
projectPathID!Project path where the packages cleanup policy is located.

destroyPackageFiles fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

destroyPackages

Input type: DestroyPackagesInput

destroyPackages arguments

NameTypeDescription
ids[PackagesPackageID!]!Global IDs of the Packages. Max 100.

destroyPackages fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

destroySnippet

Input type: DestroySnippetInput

destroySnippet arguments

NameTypeDescription
idSnippetID!Global ID of the snippet to destroy.

destroySnippet fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
snippetSnippetSnippet after mutation.

devfileValidate

  • Status: Experiment

Input type: DevfileValidateInput

devfileValidate arguments

NameTypeDescription
devfileYamlString!Input devfile.

devfileValidate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
validBooleanStatus whether devfile is valid or not.

disableDevopsAdoptionNamespace

Status: Beta.

Input type: DisableDevopsAdoptionNamespaceInput

disableDevopsAdoptionNamespace arguments

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

disableDevopsAdoptionNamespace fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

discussionToggleResolve

Toggles the resolved state of a discussion.

Input type: DiscussionToggleResolveInput

discussionToggleResolve arguments

NameTypeDescription
idDiscussionID!Global ID of the discussion.
resolveBoolean!Will resolve the discussion when true, and unresolve the discussion when false.

discussionToggleResolve fields

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

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

dismissPolicyViolations fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

duoSettingsUpdate

  • Status: Experiment

Updates GitLab Duo settings.

Input type: DuoSettingsUpdateInput

duoSettingsUpdate arguments

NameTypeDescription
aiGatewayTimeoutSecondsIntTimeout for the AI Gateway request.
aiGatewayUrlStringURL for the local AI Gateway server.
allowAllUnixSocketsBooleanIntroduced as an experiment in GitLab 19.0.

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

Whether to allow projects to extend the network access domain allowlist.
duoAgentPlatformServiceUrlStringURL for the local Duo Agent Platform service.
duoCliEnabledBooleanIntroduced as an experiment in GitLab 19.0.

Indicates whether GitLab Duo CLI access is enabled.
duoCoreFeaturesEnabledBooleanIndicates whether GitLab Duo Core features are enabled.
includeRecommendedAllowedBooleanIntroduced as an experiment in GitLab 19.0.

Whether to include recommended domains in the network access allowlist.
minimumAccessLevelEnableOnProjectsAccessLevelEnumIntroduced 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.
minimumAccessLevelExecuteAccessLevelEnumIntroduced 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.
minimumAccessLevelExecuteAsyncAccessLevelEnumIntroduced 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.
minimumAccessLevelManageAccessLevelEnumIntroduced 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.
selfHostedDuoAgentPlatformServiceSecureBooleanWhether to use secure transport (TLS) for the local Duo Agent Platform service.

duoSettingsUpdate fields

NameTypeDescription
duoSettingsDuoSettings!GitLab Duo settings after mutation.
errors[String!]!Errors encountered during the mutation.

duoUserFeedback

  • Status: Experiment

Input type: DuoUserFeedbackInput

duoUserFeedback arguments

NameTypeDescription
aiMessageIdString!ID of the AI Message.
trackingEventTrackingEventInputTracking event data.

duoUserFeedback fields

NameTypeDescription
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

NameTypeDescription
errors[String!]Errors to return to the user.
messages[String!]Messages to return to the user.

echoCreate fields

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

enableDevopsAdoptionNamespace

Status: Beta.

Input type: EnableDevopsAdoptionNamespaceInput

enableDevopsAdoptionNamespace arguments

NameTypeDescription
displayNamespaceIdNamespaceIDDisplay namespace ID.
namespaceIdNamespaceID!Namespace ID.

enableDevopsAdoptionNamespace fields

NameTypeDescription
enabledNamespaceDevopsAdoptionEnabledNamespaceEnabled namespace after mutation.
errors[String!]!Errors encountered during the mutation.

environmentCreate

Create an environment.

Input type: EnvironmentCreateInput

environmentCreate arguments

NameTypeDescription
autoStopSettingAutoStopSettingAuto stop setting of the environment.
clusterAgentIdClustersAgentIDCluster agent of the environment.
descriptionStringDescription of the environment.
externalUrlStringExternal URL of the environment.
fluxResourcePathStringFlux resource path of the environment.
kubernetesNamespaceStringKubernetes namespace of the environment.
nameString!Name of the environment.
projectPathID!Full path of the project.
tierDeploymentTierTier of the environment.

environmentCreate fields

NameTypeDescription
environmentEnvironmentCreated environment.
errors[String!]!Errors encountered during the mutation.

environmentDelete

Delete an environment.

Input type: EnvironmentDeleteInput

environmentDelete arguments

NameTypeDescription
idEnvironmentID!Global ID of the environment to Delete.

environmentDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

environmentStop

Stop an environment.

Input type: EnvironmentStopInput

environmentStop arguments

NameTypeDescription
forceBooleanForce environment to stop without executing on_stop actions.
idEnvironmentID!Global ID of the environment to stop.

environmentStop fields

NameTypeDescription
environmentEnvironmentEnvironment after attempt to stop.
errors[String!]!Errors encountered during the mutation.

environmentUpdate

Update an environment.

Input type: EnvironmentUpdateInput

environmentUpdate arguments

NameTypeDescription
autoStopSettingAutoStopSettingAuto stop setting of the environment.
clusterAgentIdClustersAgentIDCluster agent of the environment.
descriptionStringDescription of the environment.
externalUrlStringExternal URL of the environment.
fluxResourcePathStringFlux resource path of the environment.
idEnvironmentID!Global ID of the environment to update.
kubernetesNamespaceStringKubernetes namespace of the environment.
tierDeploymentTierTier of the environment.

environmentUpdate fields

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

NameTypeDescription
idEnvironmentID!Global ID of the environment to update.
weightInt!Weight of the Canary Ingress.

environmentsCanaryIngressUpdate fields

NameTypeDescription
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

NameTypeDescription
groupPathID!Group the epic to mutate belongs to.
iidID!IID of the epic to mutate.
issueIidString!IID of the issue to be added.
projectPathID!Full path of the project the issue belongs to.

epicAddIssue fields

NameTypeDescription
epicEpicEpic after mutation.
epicIssueEpicIssueEpic-issue relationship.
errors[String!]!Errors encountered during the mutation.

epicBoardCreate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicBoardCreateInput

epicBoardCreate arguments

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

epicBoardCreate fields

NameTypeDescription
epicBoardEpicBoardCreated epic board.
errors[String!]!Errors encountered during the mutation.

epicBoardListCreate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicBoardListCreateInput

epicBoardListCreate arguments

NameTypeDescription
backlogBooleanCreate the backlog list.
boardIdBoardsEpicBoardID!Global ID of the issue board to mutate.
labelIdLabelIDGlobal ID of an existing label.

epicBoardListCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
listEpicListEpic list in the epic board.

epicBoardListDestroy

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicBoardListDestroyInput

epicBoardListDestroy arguments

NameTypeDescription
listIdBoardsEpicListID!Global ID of the epic board list to destroy.

epicBoardListDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
listEpicListEpic board list. null if the board was destroyed successfully.

epicBoardUpdate

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicBoardUpdateInput

epicBoardUpdate arguments

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

epicBoardUpdate fields

NameTypeDescription
epicBoardEpicBoardUpdated epic board.
errors[String!]!Errors encountered during the mutation.

epicMoveList

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicMoveListInput

epicMoveList arguments

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

epicMoveList fields

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

NameTypeDescription
groupPathID!Group the epic to mutate belongs to.
iidID!IID of the epic to mutate.
subscribedStateBoolean!Desired state of the subscription.

epicSetSubscription fields

NameTypeDescription
epicEpicEpic after mutation.
errors[String!]!Errors encountered during the mutation.

epicTreeReorder

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: EpicTreeReorderInput

epicTreeReorder arguments

NameTypeDescription
baseEpicIdEpicID!ID of the base epic of the tree.
movedEpicTreeNodeFieldsInputType!Parameters for updating the tree positions.

epicTreeReorder fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

escalationPolicyCreate

Input type: EscalationPolicyCreateInput

escalationPolicyCreate arguments

NameTypeDescription
descriptionStringDescription of the escalation policy.
nameString!Name of the escalation policy.
projectPathID!Project to create the escalation policy for.
rules[EscalationRuleInput!]!Steps of the escalation policy.

escalationPolicyCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

escalationPolicyDestroy

Input type: EscalationPolicyDestroyInput

escalationPolicyDestroy arguments

NameTypeDescription
idIncidentManagementEscalationPolicyID!Escalation policy internal ID to remove.

escalationPolicyDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

escalationPolicyUpdate

Input type: EscalationPolicyUpdateInput

escalationPolicyUpdate arguments

NameTypeDescription
descriptionStringDescription of the escalation policy.
idIncidentManagementEscalationPolicyID!ID of the on-call schedule to create the on-call rotation in.
nameStringName of the escalation policy.
rules[EscalationRuleInput!]Steps of the escalation policy.

escalationPolicyUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

exportRequirements

Input type: ExportRequirementsInput

exportRequirements arguments

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

exportRequirements fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

externalAuditEventDestinationCreate

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsCreate instead.

Input type: ExternalAuditEventDestinationCreateInput

externalAuditEventDestinationCreate arguments

NameTypeDescription
destinationUrlString!Destination URL.
groupPathID!Group path.
nameStringDestination name.
verificationTokenStringVerification token.

externalAuditEventDestinationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationExternalAuditEventDestinationDestination created.

externalAuditEventDestinationDestroy

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.

Input type: ExternalAuditEventDestinationDestroyInput

externalAuditEventDestinationDestroy arguments

NameTypeDescription
idAuditEventsExternalAuditEventDestinationID!ID of external audit event destination to destroy.

externalAuditEventDestinationDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

externalAuditEventDestinationUpdate

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: ExternalAuditEventDestinationUpdateInput

externalAuditEventDestinationUpdate arguments

NameTypeDescription
activeBooleanActive status of the destination.
destinationUrlStringDestination URL to change.
idAuditEventsExternalAuditEventDestinationID!ID of external audit event destination to update.
nameStringDestination name.

externalAuditEventDestinationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationExternalAuditEventDestinationUpdated destination.

geoRegistriesBulkUpdate

  • Status: Experiment

Mutates multiple Geo registries for a given registry class.

Input type: GeoRegistriesBulkUpdateInput

geoRegistriesBulkUpdate arguments

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

geoRegistriesBulkUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryClassGeoRegistryClassUpdated Geo registry class.

geoRegistriesUpdate

  • Status: Experiment

Mutates a Geo registry.

Input type: GeoRegistriesUpdateInput

geoRegistriesUpdate arguments

NameTypeDescription
actionGeoRegistryAction!Action to be executed on a Geo registry.
registryIdGeoBaseRegistryID!ID of the Geo registry entry to be updated.

geoRegistriesUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryRegistrableUpdated Geo registry entry.

gitlabSubscriptionActivate

Input type: GitlabSubscriptionActivateInput

gitlabSubscriptionActivate arguments

NameTypeDescription
activationCodeString!Activation code received after purchasing a GitLab subscription.

gitlabSubscriptionActivate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
futureSubscriptions[SubscriptionFutureEntry!]Array of future subscriptions.
licenseCurrentLicenseCurrent license.

googleCloudLoggingConfigurationCreate

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

Input type: GoogleCloudLoggingConfigurationCreateInput

googleCloudLoggingConfigurationCreate arguments

NameTypeDescriptionDefault
clientEmailString!Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
googleProjectIdNameString!Unique identifier of the Google Cloud project to which the logging configuration belongs.
groupPathID!Group path.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events)."audit_events"
nameStringDestination name.
privateKeyString!Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

googleCloudLoggingConfigurationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
googleCloudLoggingConfigurationGoogleCloudLoggingConfigurationTypeconfiguration created.

googleCloudLoggingConfigurationDestroy

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsDelete instead.

Input type: GoogleCloudLoggingConfigurationDestroyInput

googleCloudLoggingConfigurationDestroy arguments

NameTypeDescription
idAuditEventsGoogleCloudLoggingConfigurationID!ID of the Google Cloud logging configuration to destroy.

googleCloudLoggingConfigurationDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

googleCloudLoggingConfigurationUpdate

Deprecated in GitLab 18.10. Use groupAuditEventStreamingDestinationsUpdate instead.

Input type: GoogleCloudLoggingConfigurationUpdateInput

googleCloudLoggingConfigurationUpdate arguments

NameTypeDescription
activeBooleanActive status of the destination.
clientEmailStringEmail address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
googleProjectIdNameStringUnique identifier of the Google Cloud project to which the logging configuration belongs.
idAuditEventsGoogleCloudLoggingConfigurationID!ID of the google Cloud configuration to update.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.
nameStringDestination name.
privateKeyStringPrivate Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

googleCloudLoggingConfigurationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
googleCloudLoggingConfigurationGoogleCloudLoggingConfigurationTypeconfiguration updated.

governPolicyCreate

  • Status: Experiment

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

Input type: GovernPolicyCreateInput

governPolicyCreate arguments

NameTypeDescription
actions[JSON!]Actions the policy takes. No more than 1000 actions.
descriptionStringDescription of the policy.
groupPathIDFull path of the group whose policy store to use. Exactly one of organizationId or groupPath is required.
lifecycleStateStringLifecycle state of the policy.
modeStringEnforcement mode of the policy.
nameString!Name of the policy.
organizationIdOrganizationsOrganizationIDGlobal ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required.
policyScopeJSONAuthored scope of the policy. Mutually exclusive with scopeRego.
rules[JSON!]!Rules of the policy, at least one. No more than 1000 rules.
scopeRegoStringRego expression scoping the policy. Mutually exclusive with policyScope.
triggerTypeString!Trigger the policy responds to.

governPolicyCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
policyGovernPolicyPolicy 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

NameTypeDescription
groupPathIDFull path of the group whose policy store to use. Exactly one of organizationId or groupPath is required.
idInt!ID of the policy to delete.
organizationIdOrganizationsOrganizationIDGlobal ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required.

governPolicyDelete fields

NameTypeDescription
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

NameTypeDescription
actions[JSON!]Actions the policy takes. No more than 1000 actions.
descriptionStringDescription of the policy.
groupPathIDFull path of the group whose policy store to use. Exactly one of organizationId or groupPath is required.
lifecycleStateStringLifecycle state of the policy.
modeStringEnforcement mode of the policy.
nameStringName of the policy.
organizationIdOrganizationsOrganizationIDGlobal ID of the organization whose policy store to use. Exactly one of organizationId or groupPath is required.
policyIdInt!ID of the policy.
policyScopeJSONAuthored scope of the policy. Mutually exclusive with scopeRego.
rules[JSON!]Rules of the policy, at least one when supplied. No more than 1000 rules.
scopeRegoStringRego expression scoping the policy. Mutually exclusive with policyScope.
triggerTypeStringTrigger the policy responds to.

governPolicyUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
policyGovernPolicyPolicy updated in the policy store.

groupAuditEventStreamingDestinationsCreate

  • Status: Experiment

Input type: GroupAuditEventStreamingDestinationsCreateInput

groupAuditEventStreamingDestinationsCreate arguments

NameTypeDescription
categoryString!Destination category.
configJSON!Destination config.
groupPathID!Group path.
nameStringDestination name.
secretTokenStringSecret token.

groupAuditEventStreamingDestinationsCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationGroupAuditEventStreamingDestinationDestination created.

groupAuditEventStreamingDestinationsDelete

  • Status: Experiment

Input type: GroupAuditEventStreamingDestinationsDeleteInput

groupAuditEventStreamingDestinationsDelete arguments

NameTypeDescription
idAuditEventsGroupExternalStreamingDestinationID!ID of the audit events external streaming destination to delete.

groupAuditEventStreamingDestinationsDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

groupAuditEventStreamingDestinationsUpdate

  • Status: Experiment

Input type: GroupAuditEventStreamingDestinationsUpdateInput

groupAuditEventStreamingDestinationsUpdate arguments

NameTypeDescription
activeBooleanActive status of the destination.
categoryStringDestination category.
configJSONDestination config.
idAuditEventsGroupExternalStreamingDestinationID!ID of external audit event destination to update.
nameStringDestination name.
secretTokenStringSecret token.

groupAuditEventStreamingDestinationsUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationGroupAuditEventStreamingDestinationUpdated destination.

groupMemberBulkUpdate

Input type: GroupMemberBulkUpdateInput

groupMemberBulkUpdate arguments

NameTypeDescription
accessLevelMemberAccessLevel!Access level to update the members to.
expiresAtTimeDate and time the membership expires.
groupIdGroupID!Global ID of the group.
userIds[UserID!]!Global IDs of the members.

groupMemberBulkUpdate fields

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

groupMembersExport

  • Status: Experiment

Input type: GroupMembersExportInput

groupMembersExport arguments

NameTypeDescription
groupIdGroupID!Global ID of the group.

groupMembersExport fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
messageStringExport request result message.

groupSavedReplyCreate

  • Status: Experiment

Input type: GroupSavedReplyCreateInput

groupSavedReplyCreate arguments

NameTypeDescription
contentString!Content of the saved reply.
groupIdGroupID!Group for the save reply.
nameString!Name of the saved reply.

groupSavedReplyCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

groupSavedReplyDestroy

  • Status: Experiment

Input type: GroupSavedReplyDestroyInput

groupSavedReplyDestroy arguments

NameTypeDescription
idGroupsSavedReplyID!Global ID of the group-level saved reply.

groupSavedReplyDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

groupSavedReplyUpdate

  • Status: Experiment

Input type: GroupSavedReplyUpdateInput

groupSavedReplyUpdate arguments

NameTypeDescription
contentString!Content of the saved reply.
idGroupsSavedReplyID!Global ID of the group-level saved reply.
nameString!Name of the saved reply.

groupSavedReplyUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

groupSecretCreate

Input type: GroupSecretCreateInput

groupSecretCreate arguments

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

groupSecretCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupSecretGroupSecretGroup secret.
reasonSecretsManagerWriteDenialReasonIntroduced 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

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

groupSecretDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupSecretGroupSecretDeleted group secret.

groupSecretUpdate

Input type: GroupSecretUpdateInput

groupSecretUpdate arguments

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

groupSecretUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupSecretGroupSecretUpdated group secret.
reasonSecretsManagerWriteDenialReasonIntroduced 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

NameTypeDescription
groupPathID!Group of the secrets manager.

groupSecretsManagerDeprovision fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupSecretsManagerGroupSecretsManagerGroup secrets manager.
reasonSecretsManagerWriteDenialReasonIntroduced 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

NameTypeDescription
groupPathID!Group of the secrets manager.

groupSecretsManagerInitialize fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupSecretsManagerGroupSecretsManagerGroup secrets manager.
reasonSecretsManagerWriteDenialReasonIntroduced 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

NameTypeDescription
groupPathID!Group permissions for the secret.
principalPrincipalInput!Whose permission to be deleted.

groupSecretsPermissionDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
reasonSecretsManagerWriteDenialReasonIntroduced as an experiment in GitLab 19.2.

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

groupSecretsPermissionUpdate

Input type: GroupSecretsPermissionUpdateInput

groupSecretsPermissionUpdate arguments

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

groupSecretsPermissionUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
reasonSecretsManagerWriteDenialReasonIntroduced as an experiment in GitLab 19.2.

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

groupTransfer

  • Status: Experiment

Input type: GroupTransferInput

groupTransfer arguments

NameTypeDescription
idGroupID!Global ID of the group to transfer.
targetIdGroupIDGlobal ID of the target parent group. Omit to make group top-level.

groupTransfer fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroupGroup after mutation.

groupUpdate

Input type: GroupUpdateInput

groupUpdate arguments

NameTypeDescription
aiAuditEventsStorageEnabledBooleanIntroduced as an experiment in GitLab 19.2.

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

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

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

Indicates whether GitLab Duo features are enabled for the group.
fullPathID!Full path of the group that will be updated.
lockAiAuditEventsStorageEnabledBooleanIntroduced as an experiment in GitLab 19.2.

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

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

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

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

Indicates if the tool approval for session setting is enforced for all subgroups.
mathRenderingLimitsEnabledBooleanIndicates if math rendering limits are used for the group.
nameStringName of the group.
pathStringPath of the namespace.
sharedRunnersSettingSharedRunnersSettingShared runners availability for the namespace and its descendants.
stepUpAuthRequiredOauthProviderStringOAuth provider required for step-up authentication.
toolApprovalForSessionEnabledBooleanIntroduced as an experiment in GitLab 18.11.

Indicates whether tool approval for session is enabled for the group.
visibilityVisibilityLevelsEnumVisibility of the namespace.
webBasedCommitSigningEnabledBooleanIntroduced as an experiment in GitLab 18.2.

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

groupUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroupGroup after update.

httpIntegrationCreate

Input type: HttpIntegrationCreateInput

httpIntegrationCreate arguments

NameTypeDescriptionDefault
activeBoolean!Whether the integration is receiving alerts.
nameString!Name of the integration.
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.
projectPathID!Project to create the integration in.
typeAlertManagementIntegrationTypeType of integration to create. Cannot be changed after creation.HTTP

httpIntegrationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementHttpIntegrationAlerting integration.

httpIntegrationDestroy

Input type: HttpIntegrationDestroyInput

httpIntegrationDestroy arguments

NameTypeDescription
idAlertManagementHttpIntegrationID!ID of the integration to remove.

httpIntegrationDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementHttpIntegrationAlerting integration.

httpIntegrationResetToken

Input type: HttpIntegrationResetTokenInput

httpIntegrationResetToken arguments

NameTypeDescription
idAlertManagementHttpIntegrationID!ID of the integration to mutate.

httpIntegrationResetToken fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementHttpIntegrationAlerting integration.

httpIntegrationUpdate

Input type: HttpIntegrationUpdateInput

httpIntegrationUpdate arguments

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

httpIntegrationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementHttpIntegrationAlerting integration.

importSourceUserCancelReassignment

  • Status: Experiment

Input type: ImportSourceUserCancelReassignmentInput

importSourceUserCancelReassignment arguments

NameTypeDescription
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserCancelReassignment fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

importSourceUserKeepAllAsPlaceholder

  • Status: Experiment

Input type: ImportSourceUserKeepAllAsPlaceholderInput

importSourceUserKeepAllAsPlaceholder arguments

NameTypeDescription
namespaceIdNamespaceID!Global ID of the namespace.

importSourceUserKeepAllAsPlaceholder fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
updatedImportSourceUserCountIntNumber of successfully updated mappings of users on source instance to their destination users.

importSourceUserKeepAsPlaceholder

  • Status: Experiment

Input type: ImportSourceUserKeepAsPlaceholderInput

importSourceUserKeepAsPlaceholder arguments

NameTypeDescription
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserKeepAsPlaceholder fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

importSourceUserReassign

  • Status: Experiment

Input type: ImportSourceUserReassignInput

importSourceUserReassign arguments

NameTypeDescription
assigneeUserIdUserID!Global ID of the assignee user.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserReassign fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

importSourceUserResendNotification

  • Status: Experiment

Input type: ImportSourceUserResendNotificationInput

importSourceUserResendNotification arguments

NameTypeDescription
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserResendNotification fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

importSourceUserRetryFailedReassignment

  • Status: Experiment

Input type: ImportSourceUserRetryFailedReassignmentInput

importSourceUserRetryFailedReassignment arguments

NameTypeDescription
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserRetryFailedReassignment fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

importSourceUserRevoke

  • Status: Experiment

Input type: ImportSourceUserRevokeInput

importSourceUserRevoke arguments

NameTypeDescription
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserRevoke fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

importSourceUserUndoKeepAsPlaceholder

  • Status: Experiment

Input type: ImportSourceUserUndoKeepAsPlaceholderInput

importSourceUserUndoKeepAsPlaceholder arguments

NameTypeDescription
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

importSourceUserUndoKeepAsPlaceholder fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

instanceAuditEventStreamingDestinationsCreate

  • Status: Experiment

Input type: InstanceAuditEventStreamingDestinationsCreateInput

instanceAuditEventStreamingDestinationsCreate arguments

NameTypeDescription
categoryString!Destination category.
configJSON!Destination config.
nameStringDestination name.
secretTokenStringSecret token.

instanceAuditEventStreamingDestinationsCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationInstanceAuditEventStreamingDestinationDestination created.

instanceAuditEventStreamingDestinationsDelete

  • Status: Experiment

Input type: InstanceAuditEventStreamingDestinationsDeleteInput

instanceAuditEventStreamingDestinationsDelete arguments

NameTypeDescription
idAuditEventsInstanceExternalStreamingDestinationID!ID of the audit events external streaming destination to delete.

instanceAuditEventStreamingDestinationsDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

instanceAuditEventStreamingDestinationsUpdate

  • Status: Experiment

Input type: InstanceAuditEventStreamingDestinationsUpdateInput

instanceAuditEventStreamingDestinationsUpdate arguments

NameTypeDescription
activeBooleanActive status of the destination.
categoryStringDestination category.
configJSONDestination config.
idAuditEventsInstanceExternalStreamingDestinationID!ID of external audit event destination to update.
nameStringDestination name.
secretTokenStringSecret token.

instanceAuditEventStreamingDestinationsUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalAuditEventDestinationInstanceAuditEventStreamingDestinationUpdated destination.

instanceExternalAuditEventDestinationCreate

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsCreate instead.

Input type: InstanceExternalAuditEventDestinationCreateInput

instanceExternalAuditEventDestinationCreate arguments

NameTypeDescription
destinationUrlString!Destination URL.
nameStringDestination name.

instanceExternalAuditEventDestinationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
instanceExternalAuditEventDestinationInstanceExternalAuditEventDestinationDestination created.

instanceExternalAuditEventDestinationDestroy

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: InstanceExternalAuditEventDestinationDestroyInput

instanceExternalAuditEventDestinationDestroy arguments

NameTypeDescription
idAuditEventsInstanceExternalAuditEventDestinationID!ID of the external instance audit event destination to destroy.

instanceExternalAuditEventDestinationDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

instanceExternalAuditEventDestinationUpdate

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: InstanceExternalAuditEventDestinationUpdateInput

instanceExternalAuditEventDestinationUpdate arguments

NameTypeDescription
activeBooleanActive status of the destination.
destinationUrlStringDestination URL to change.
idAuditEventsInstanceExternalAuditEventDestinationID!ID of the external instance audit event destination to update.
nameStringDestination name.

instanceExternalAuditEventDestinationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
instanceExternalAuditEventDestinationInstanceExternalAuditEventDestinationUpdated destination.

instanceGoogleCloudLoggingConfigurationCreate

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

Input type: InstanceGoogleCloudLoggingConfigurationCreateInput

instanceGoogleCloudLoggingConfigurationCreate arguments

NameTypeDescriptionDefault
clientEmailString!Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
googleProjectIdNameString!Unique identifier of the Google Cloud project to which the logging configuration belongs.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events)."audit_events"
nameStringDestination name.
privateKeyString!Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

instanceGoogleCloudLoggingConfigurationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
instanceGoogleCloudLoggingConfigurationInstanceGoogleCloudLoggingConfigurationTypeconfiguration created.

instanceGoogleCloudLoggingConfigurationDestroy

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsDelete instead.

Input type: InstanceGoogleCloudLoggingConfigurationDestroyInput

instanceGoogleCloudLoggingConfigurationDestroy arguments

NameTypeDescription
idAuditEventsInstanceGoogleCloudLoggingConfigurationID!ID of the Google Cloud logging configuration to destroy.

instanceGoogleCloudLoggingConfigurationDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

instanceGoogleCloudLoggingConfigurationUpdate

Deprecated in GitLab 18.10. Use instanceAuditEventStreamingDestinationsUpdate instead.

Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput

instanceGoogleCloudLoggingConfigurationUpdate arguments

NameTypeDescription
activeBooleanActive status of the destination.
clientEmailStringEmail address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
googleProjectIdNameStringUnique identifier of the Google Cloud project to which the logging configuration belongs.
idAuditEventsInstanceGoogleCloudLoggingConfigurationID!ID of the instance google Cloud configuration to update.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.
nameStringDestination name.
privateKeyStringPrivate Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

instanceGoogleCloudLoggingConfigurationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
instanceGoogleCloudLoggingConfigurationInstanceGoogleCloudLoggingConfigurationTypeconfiguration updated.

instanceSecretsManagerEnroll

Input type: InstanceSecretsManagerEnrollInput

instanceSecretsManagerEnroll fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

instanceSecretsManagerUnenroll

Input type: InstanceSecretsManagerUnenrollInput

instanceSecretsManagerUnenroll fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

integrationExclusionCreate

  • Status: Experiment

Input type: IntegrationExclusionCreateInput

integrationExclusionCreate arguments

NameTypeDescription
groupIds[GroupID!]IDs of groups to exclude up to a maximum of 100.
integrationNameIntegrationType!Type of integration to exclude.
projectIds[ProjectID!]IDs of projects to exclude up to a maximum of 100.

integrationExclusionCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
exclusions[IntegrationExclusion!]Integration exclusions created by the mutation.

integrationExclusionDelete

  • Status: Experiment

Input type: IntegrationExclusionDeleteInput

integrationExclusionDelete arguments

NameTypeDescription
groupIds[GroupID!]IDs of excluded groups.
integrationNameIntegrationType!Type of integration.
projectIds[ProjectID!]IDs of excluded projects.

integrationExclusionDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
exclusions[IntegrationExclusion!]Project no longer excluded due to the mutation.

issuableResourceLinkCreate

Input type: IssuableResourceLinkCreateInput

issuableResourceLinkCreate arguments

NameTypeDescription
idIssueID!Incident id to associate the resource link with.
linkString!Link of the resource.
linkTextStringLink text of the resource.
linkTypeIssuableResourceLinkTypeLink type of the resource.

issuableResourceLinkCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issuableResourceLinkIssuableResourceLinkIssuable resource link.

issuableResourceLinkDestroy

Input type: IssuableResourceLinkDestroyInput

issuableResourceLinkDestroy arguments

NameTypeDescription
idIncidentManagementIssuableResourceLinkID!Issuable resource link ID to remove.

issuableResourceLinkDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issuableResourceLinkIssuableResourceLinkIssuable resource link.

issueLinkAlerts

Input type: IssueLinkAlertsInput

issueLinkAlerts arguments

NameTypeDescription
alertReferences[String!]!Alerts references to be linked to the incident.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

issueLinkAlerts fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueMove

Input type: IssueMoveInput

issueMove arguments

NameTypeDescription
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
targetProjectPathID!Project to move the issue to.
targetWorkItemTypeIdWorkItemsTypeIDWork item type to use in the target project. When omitted, the source work item type is preserved.

issueMove fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueMoveList

Input type: IssueMoveListInput

issueMoveList arguments

NameTypeDescription
boardIdBoardID!Global ID of the board that the issue is in.
epicIdEpicIDDeprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
fromListIdIDID of the board list that the issue will be moved from.
iidString!IID of the issue to mutate.
moveAfterIdIDID of issue that should be placed after the current issue.
moveBeforeIdIDID of issue that should be placed before the current issue.
positionInListIntPosition of issue within the board list. Positions start at 0. Use -1 to move to the end of the list.
projectPathID!Project the issue to mutate is in.
toListIdIDID of the board list that the issue will be moved to.

issueMoveList fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetAssignees

Input type: IssueSetAssigneesInput

issueSetAssignees arguments

NameTypeDescriptionDefault
assigneeUsernames[String!]!Usernames to assign to the resource. Replaces existing assignees by default.
iidString!IID of the issue to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.REPLACE
projectPathID!Project the issue to mutate is in.

issueSetAssignees fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetConfidential

Input type: IssueSetConfidentialInput

issueSetConfidential arguments

NameTypeDescription
confidentialBoolean!Whether or not to set the issue as a confidential.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

issueSetConfidential fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetCrmContacts

Input type: IssueSetCrmContactsInput

issueSetCrmContacts arguments

NameTypeDescription
contactIds[CustomerRelationsContactID!]!Customer relations contact IDs to set. Replaces existing contacts by default.
iidString!IID of the issue to mutate.
operationModeMutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPathID!Project the issue to mutate is in.

issueSetCrmContacts fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetDueDate

Input type: IssueSetDueDateInput

issueSetDueDate arguments

NameTypeDescription
dueDateTimeDesired due date for the issue. Due date is removed if null.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

issueSetDueDate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetEpic

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: IssueSetEpicInput

issueSetEpic arguments

NameTypeDescription
epicIdEpicIDDeprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

issueSetEpic fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetEscalationPolicy

Input type: IssueSetEscalationPolicyInput

issueSetEscalationPolicy arguments

NameTypeDescription
escalationPolicyIdIncidentManagementEscalationPolicyIDGlobal ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

issueSetEscalationPolicy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetEscalationStatus

Input type: IssueSetEscalationStatusInput

issueSetEscalationStatus arguments

NameTypeDescription
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
statusIssueEscalationStatus!Set the escalation status.

issueSetEscalationStatus fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetIteration

Input type: IssueSetIterationInput

issueSetIteration arguments

NameTypeDescription
iidString!IID of the issue to mutate.
iterationIdIterationIDIteration to assign to the issue.
projectPathID!Project the issue to mutate is in.

issueSetIteration fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetLocked

Input type: IssueSetLockedInput

issueSetLocked arguments

NameTypeDescription
iidString!IID of the issue to mutate.
lockedBoolean!Whether or not to lock discussion on the issue.
projectPathID!Project the issue to mutate is in.

issueSetLocked fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetSeverity

Input type: IssueSetSeverityInput

issueSetSeverity arguments

NameTypeDescription
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
severityIssuableSeverity!Set the incident severity level.

issueSetSeverity fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetSubscription

Input type: IssueSetSubscriptionInput

issueSetSubscription arguments

NameTypeDescription
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
subscribedStateBoolean!Desired state of the subscription.

issueSetSubscription fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueSetWeight

Input type: IssueSetWeightInput

issueSetWeight arguments

NameTypeDescription
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
weightIntThe desired weight for the issue. If set to null, weight is removed.

issueSetWeight fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

issueUnlinkAlert

Input type: IssueUnlinkAlertInput

issueUnlinkAlert arguments

NameTypeDescription
alertIdAlertManagementAlertID!Global ID of the alert to unlink from the incident.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

issueUnlinkAlert fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

iterationCadenceCreate

Input type: IterationCadenceCreateInput

iterationCadenceCreate arguments

NameTypeDescription
activeBoolean!Whether the iteration cadence is active.
automaticBoolean!Whether the iteration cadence should automatically generate upcoming iterations.
descriptionStringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeksIntDuration in weeks of the iterations within the cadence.
groupPathID!Group where the iteration cadence is created.
iterationsInAdvanceIntNumber of future iterations to schedule in addition to the current one.
rollOverBooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDateTimeAutomation start date.
titleStringTitle of the iteration cadence.

iterationCadenceCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
iterationCadenceIterationCadenceCreated iteration cadence.

iterationCadenceDestroy

Input type: IterationCadenceDestroyInput

iterationCadenceDestroy arguments

NameTypeDescription
idIterationsCadenceID!Global ID of the iteration cadence.

iterationCadenceDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroup!Group the iteration cadence belongs to.

iterationCadenceUpdate

Input type: IterationCadenceUpdateInput

iterationCadenceUpdate arguments

NameTypeDescription
activeBooleanWhether the iteration cadence is active.
automaticBooleanWhether the iteration cadence should automatically generate upcoming iterations.
descriptionStringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeksIntDuration in weeks of the iterations within the cadence.
idIterationsCadenceID!Global ID of the iteration cadence.
iterationsInAdvanceIntNumber of future iterations to schedule in addition to the current one.
rollOverBooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDateTimeAutomation start date.
titleStringTitle of the iteration cadence.

iterationCadenceUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
iterationCadenceIterationCadenceUpdated iteration cadence.

iterationCreate

Input type: iterationCreateInput

iterationCreate arguments

NameTypeDescription
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathIDFull path of the group with which the resource is associated.
iterationsCadenceIdIterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPathIDFull path of the project with which the resource is associated.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

iterationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
iterationIterationCreated iteration.

iterationDelete

Input type: IterationDeleteInput

iterationDelete arguments

NameTypeDescription
idIterationID!ID of the iteration.

iterationDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroup!Group the iteration belongs to.

jiraImportStart

Input type: JiraImportStartInput

jiraImportStart arguments

NameTypeDescription
jiraProjectKeyString!Project key of the importer Jira project.
jiraProjectNameStringDeprecated in GitLab 17.4. Argument is not used.
projectPathID!Project to import the Jira project into.
usersMapping[JiraUsersMappingInputType!]Mapping of Jira to GitLab users.

jiraImportStart fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
jiraImportJiraImportJira import data after mutation.

jiraImportUsers

Input type: JiraImportUsersInput

jiraImportUsers arguments

NameTypeDescription
projectPathID!Project to import the Jira users into.
startAtIntIndex of the record the import should started at, default 0 (50 records returned).

jiraImportUsers fields

NameTypeDescription
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

NameTypeDescription
idCiBuildID!ID of the job to mutate.

jobArtifactsDestroy fields

NameTypeDescription
destroyedArtifactsCountInt!Number of artifacts deleted.
errors[String!]!Errors encountered during the mutation.
jobCiJobJob with artifacts to be deleted.

jobCancel

Input type: JobCancelInput

jobCancel arguments

NameTypeDescription
idCiBuildID!ID of the job to mutate.

jobCancel fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
jobCiJobJob after the mutation.

jobPlay

Input type: JobPlayInput

jobPlay arguments

NameTypeDescriptionDefault
idCiProcessableID!ID of the job to mutate.
inputs[CiInputsInput!]Inputs to use when playing the job.[]
variables[CiVariableInput!]Variables to use when playing a manual job.[]

jobPlay fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
jobCiJobJob after the mutation.

jobRetry

Input type: JobRetryInput

jobRetry arguments

NameTypeDescriptionDefault
idCiProcessableID!ID of the job to mutate.
inputs[CiInputsInput!]Inputs to use when retrying the job.[]
variables[CiVariableInput!]Variables to use when retrying a manual job.[]

jobRetry fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
jobCiJobJob after the mutation.

jobUnschedule

Input type: JobUnscheduleInput

jobUnschedule arguments

NameTypeDescription
idCiBuildID!ID of the job to mutate.

jobUnschedule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
jobCiJobJob after the mutation.

knowledgeGraphExcludedNamespaceCreate

  • Status: Experiment

Input type: KnowledgeGraphExcludedNamespaceCreateInput

knowledgeGraphExcludedNamespaceCreate arguments

NameTypeDescription
groupPathID!Full path of the top-level group to exclude.

knowledgeGraphExcludedNamespaceCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroupExcluded group.

knowledgeGraphExcludedNamespaceDestroy

  • Status: Experiment

Input type: KnowledgeGraphExcludedNamespaceDestroyInput

knowledgeGraphExcludedNamespaceDestroy arguments

NameTypeDescription
groupPathID!Full path of the top-level group to remove from exclusions.

knowledgeGraphExcludedNamespaceDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroupGroup removed from exclusions.

labelCreate

Input type: LabelCreateInput

labelCreate arguments

NameTypeDescriptionDefault
colorStringThe color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names. See List of color keywords at mozilla.org."#6699cc"
descriptionStringDescription of the label.
groupPathIDFull path of the group with which the resource is associated.
projectPathIDFull path of the project with which the resource is associated.
titleString!Title of the label.

labelCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
labelLabelLabel after mutation.

labelUpdate

Input type: LabelUpdateInput

labelUpdate arguments

NameTypeDescription
archivedBooleanWhether to archive the label. Introduced in GitLab 18.10.
idLabelID!Global ID of the label to update.

labelUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
labelLabelLabel after mutation.

ldapAdminRoleLinkCreate

  • Status: Experiment

Creates an instance-level custom admin role LDAP link.

Input type: LdapAdminRoleLinkCreateInput

ldapAdminRoleLinkCreate arguments

NameTypeDescription
adminMemberRoleIdMemberRoleID!Global ID of the custom admin role to be assigned to a user.
cnStringCommon Name (CN) of the LDAP group.
filterStringSearch filter for the LDAP group.
providerString!LDAP provider for the LDAP link.

ldapAdminRoleLinkCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
ldapAdminRoleLinkLdapAdminRoleLinkCreated instance-level LDAP link.

ldapAdminRoleLinkDestroy

  • Status: Experiment

Destroys an instance-level custom admin role LDAP link.

Input type: LdapAdminRoleLinkDestroyInput

ldapAdminRoleLinkDestroy arguments

NameTypeDescription
idAuthzLdapAdminRoleLinkID!Global ID of the instance-level LDAP link to delete.

ldapAdminRoleLinkDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
ldapAdminRoleLinkLdapAdminRoleLinkDeleted instance-level LDAP link.

lifecycleAttachWorkItemType

  • Status: Experiment

Input type: LifecycleAttachWorkItemTypeInput

lifecycleAttachWorkItemType arguments

NameTypeDescription
lifecycleIdWorkItemsStatusesLifecycleID!Global ID of the lifecycle to attach the work item type to.
namespacePathID!Namespace path where the lifecycle exists.
statusMappings[StatusMappingInput!]Status mappings from the old lifecycle to the new lifecycle.
workItemTypeIdWorkItemsTypeID!Global ID of the work item type to attach to the lifecycle.

lifecycleAttachWorkItemType fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
lifecycleWorkItemLifecycleLifecycle after attaching the work item type.

lifecycleCreate

  • Status: Experiment

Input type: LifecycleCreateInput

lifecycleCreate arguments

NameTypeDescription
defaultClosedStatusIndexInt!Index of the default closed status in the statuses array.
defaultDuplicateStatusIndexInt!Index of the default duplicated status in the statuses array.
defaultOpenStatusIndexInt!Index of the default open status in the statuses array.
nameString!Name of the lifecycle.
namespacePathID!Namespace path where the lifecycle will be created.
statuses[WorkItemStatusInput!]!Statuses of the lifecycle. Can be existing (with id) or new (without id).

lifecycleCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
lifecycleWorkItemLifecycleLifecycle created.

lifecycleDelete

  • Status: Experiment

Input type: LifecycleDeleteInput

lifecycleDelete arguments

NameTypeDescription
idWorkItemsStatusesLifecycleID!Global ID of the lifecycle to delete.
namespacePathID!Namespace path where the lifecycle exists.

lifecycleDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
lifecycleWorkItemLifecycleDeleted lifecycle.

lifecycleUpdate

  • Status: Experiment

Input type: LifecycleUpdateInput

lifecycleUpdate arguments

NameTypeDescription
defaultClosedStatusIndexIntIndex of the default closed status in the statuses array.
defaultDuplicateStatusIndexIntIndex of the default duplicated status in the statuses array.
defaultOpenStatusIndexIntIndex of the default open status in the statuses array.
idWorkItemsStatusesLifecycleID!Global ID of the lifecycle to be updated.
nameStringName of the lifecycle.
namespacePathID!Namespace path where the lifecycle exists.
statusMappings[StatusMappingInput!]Mappings for statuses being removed from the lifecycle. Maps old status to replacement status.
statuses[WorkItemStatusInput!]Statuses of the lifecycle. Can be existing (with id) or new (without id).

lifecycleUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
lifecycleWorkItemLifecycleLifecycle updated.

linkProjectComplianceViolationIssue

  • Status: Experiment

Input type: LinkProjectComplianceViolationIssueInput

linkProjectComplianceViolationIssue arguments

NameTypeDescription
issueIidString!IID of the issue to be linked.
projectPathID!Full path of the project the issue belongs to.
violationIdComplianceManagementProjectsComplianceViolationID!Global ID of the project compliance violation.

linkProjectComplianceViolationIssue fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
violationProjectComplianceViolationUpdated project compliance violation.

markAsSpamSnippet

Input type: MarkAsSpamSnippetInput

markAsSpamSnippet arguments

NameTypeDescription
idSnippetID!Global ID of the snippet to update.

markAsSpamSnippet fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
snippetSnippetSnippet after mutation.

mavenCacheEntryDelete

  • Status: Experiment

Input type: MavenCacheEntryDeleteInput

mavenCacheEntryDelete arguments

NameTypeDescription
idString!ID of the cache entry.

mavenCacheEntryDelete fields

NameTypeDescription
cacheEntryMavenUpstreamCacheEntryMaven cache entry.
errors[String!]!Errors encountered during the mutation.

mavenUpstreamCacheDelete

  • Status: Experiment

Input type: MavenUpstreamCacheDeleteInput

mavenUpstreamCacheDelete arguments

NameTypeDescription
idVirtualRegistriesPackagesMavenUpstreamID!ID of the Maven virtual registry upstream.

mavenUpstreamCacheDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
upstreamMavenUpstreamDetailsMaven virtual registry upstream.

mavenUpstreamCreate

  • Status: Experiment

Input type: MavenUpstreamCreateInput

mavenUpstreamCreate arguments

NameTypeDescriptionDefault
cacheValidityHoursIntCache validity period. Defaults to 24 hours.24
descriptionStringDescription of the upstream registry.
idVirtualRegistriesPackagesMavenRegistryID!ID of the upstream registry.
metadataCacheValidityHoursIntMetadata cache validity period. Defaults to 24 hours.24
nameString!Name of upstream registry.
passwordStringPassword of the upstream registry.
urlString!URL of the upstream registry.
usernameStringUsername of the upstream registry.

mavenUpstreamCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
upstreamMavenUpstreamDetailsMaven upstream after the mutation.

mavenUpstreamDelete

  • Status: Experiment

Input type: MavenUpstreamDeleteInput

mavenUpstreamDelete arguments

NameTypeDescription
idVirtualRegistriesPackagesMavenUpstreamID!ID of the upstream to be deleted.

mavenUpstreamDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
upstreamMavenUpstreamDetailsDestroyed upstream.

mavenUpstreamUpdate

  • Status: Experiment

Input type: MavenUpstreamUpdateInput

mavenUpstreamUpdate arguments

NameTypeDescription
cacheValidityHoursIntCache validity period.
descriptionStringDescription of the upstream registry.
idVirtualRegistriesPackagesMavenUpstreamID!ID of the upstream registry.
metadataCacheValidityHoursIntMetadata cache validity period.
nameStringName of upstream registry.
passwordStringPassword of the upstream registry.
urlStringURL of the upstream registry.
usernameStringUsername of the upstream registry.

mavenUpstreamUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
upstreamMavenUpstreamDetailsMaven upstream after the mutation.

mavenVirtualRegistryCacheDelete

  • Status: Experiment

Input type: MavenVirtualRegistryCacheDeleteInput

mavenVirtualRegistryCacheDelete arguments

NameTypeDescription
idVirtualRegistriesPackagesMavenRegistryID!ID of the Maven virtual registry.

mavenVirtualRegistryCacheDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryMavenRegistryMaven virtual registry.

mavenVirtualRegistryCreate

  • Status: Experiment

Input type: MavenVirtualRegistryCreateInput

mavenVirtualRegistryCreate arguments

NameTypeDescription
descriptionStringDescription of the virtual registry.
groupPathIDFull path of the group with which the resource is associated.
nameString!Name of virtual registry.

mavenVirtualRegistryCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryMavenRegistryMaven virtual registry after the mutation.

mavenVirtualRegistryDelete

  • Status: Experiment

Input type: MavenVirtualRegistryDeleteInput

mavenVirtualRegistryDelete arguments

NameTypeDescription
idVirtualRegistriesPackagesMavenRegistryID!ID of the Maven virtual registry to be deleted.

mavenVirtualRegistryDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryMavenRegistryDeleted Maven virtual registry.

mavenVirtualRegistryUpdate

  • Status: Experiment

Input type: MavenVirtualRegistryUpdateInput

mavenVirtualRegistryUpdate arguments

NameTypeDescription
descriptionStringDescription of the virtual registry.
idVirtualRegistriesPackagesMavenRegistryID!ID of the Maven virtual registry to be updated.
nameStringName of virtual registry.

mavenVirtualRegistryUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryMavenRegistryMaven virtual registry after the mutation.

mavenVirtualRegistryUpstreamDelete

  • Status: Experiment

Input type: MavenVirtualRegistryUpstreamDeleteInput

mavenVirtualRegistryUpstreamDelete arguments

NameTypeDescription
upstreamIdVirtualRegistriesPackagesMavenRegistryUpstreamID!ID of the Maven virtual registry upstream.

mavenVirtualRegistryUpstreamDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryUpstreamMavenRegistryUpstreamWithRegistryDeleted maven registry upstream.

mavenVirtualRegistryUpstreamUpdate

  • Status: Experiment

Input type: MavenVirtualRegistryUpstreamUpdateInput

mavenVirtualRegistryUpstreamUpdate arguments

NameTypeDescription
idVirtualRegistriesPackagesMavenRegistryUpstreamID!ID of the Maven virtual registry upstream.
positionInt!Priority order of an upstream within a virtual registry.

mavenVirtualRegistryUpstreamUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
registryUpstreamMavenRegistryUpstreamWithRegistryMaven registry upstream after update.

memberRoleAdminCreate

  • Status: Experiment

Input type: MemberRoleAdminCreateInput

memberRoleAdminCreate arguments

NameTypeDescription
descriptionStringDescription of the member role.
nameStringName of the member role.
permissions[MemberRoleAdminPermission!]List of all customizable admin permissions.

memberRoleAdminCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
memberRoleAdminMemberRoleMember role.

memberRoleAdminDelete

  • Status: Experiment

Input type: MemberRoleAdminDeleteInput

memberRoleAdminDelete arguments

NameTypeDescription
idMemberRoleID!ID of the admin member role to delete.

memberRoleAdminDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
memberRoleMemberRoleDeleted admin member role.

memberRoleAdminUpdate

  • Status: Experiment

Input type: MemberRoleAdminUpdateInput

memberRoleAdminUpdate arguments

NameTypeDescription
descriptionStringDescription of the member role.
idMemberRoleID!ID of the member role to mutate.
nameStringName of the member role.
permissions[MemberRoleAdminPermission!]List of all customizable admin permissions.

memberRoleAdminUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
memberRoleAdminMemberRoleMember role.

memberRoleCreate

  • Status: Experiment

Input type: MemberRoleCreateInput

memberRoleCreate arguments

NameTypeDescription
baseAccessLevelMemberRolesAccessLevel!Base access level for the custom role.
descriptionStringDescription of the member role.
groupPathIDGroup the member role to mutate is in. Required for SaaS.
nameStringName of the member role.
permissions[MemberRolePermission!]List of all customizable permissions.

memberRoleCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
memberRoleMemberRoleMember role.

memberRoleDelete

  • Status: Experiment

Input type: MemberRoleDeleteInput

memberRoleDelete arguments

NameTypeDescription
idMemberRoleID!ID of the member role to delete.

memberRoleDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
memberRoleMemberRoleDeleted member role.

memberRoleToUserAssign

  • Status: Experiment

Input type: MemberRoleToUserAssignInput

memberRoleToUserAssign arguments

NameTypeDescription
memberRoleIdMemberRoleIDGlobal ID of the custom role to be assigned to a user. Admin roles will be unassigned from the user if omitted or set as NULL.
userIdUserID!Global ID of the user to be assigned to a custom role.

memberRoleToUserAssign fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userMemberRoleUserMemberRoleCreated user member role or nil if the relation was deleted.

memberRoleUpdate

Input type: MemberRoleUpdateInput

memberRoleUpdate arguments

NameTypeDescription
descriptionStringDescription of the member role.
idMemberRoleID!ID of the member role to mutate.
nameStringName of the member role.
permissions[MemberRolePermission!]List of all customizable permissions.

memberRoleUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
memberRoleMemberRoleMember 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

NameTypeDescriptionDefault
commitMessageStringCustom merge commit message.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
shaString!HEAD SHA at the time when the merge was requested.
shouldRemoveSourceBranchBooleanShould the source branch be removed.
squashBooleanSquash commits on the source branch before merge.false
squashCommitMessageStringCustom squash commit message (if squash is true).
strategyMergeStrategyEnumHow to merge the merge request.

mergeRequestAccept fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestBypassSecurityPolicy

  • Status: Experiment

Bypasses security policies for a merge request.

Input type: MergeRequestBypassSecurityPolicyInput

mergeRequestBypassSecurityPolicy arguments

NameTypeDescription
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
reasonString!Reason for bypassing the security policy.
securityPolicyIds[ID!]!ID of the security policy to bypass.

mergeRequestBypassSecurityPolicy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestCreate

Input type: MergeRequestCreateInput

mergeRequestCreate arguments

NameTypeDescription
descriptionStringDescription of the merge request (Markdown rendered as HTML for caching).
labels[String!]Labels of the merge request.
mergeAfterTimeDate and time after which the merge request can be merged.
mergeBeforeTimeIntroduced as an experiment in GitLab 19.6.

Date and time before which the merge request can be merged.
projectPathID!Project full path the merge request is associated with.
removeSourceBranchBooleanIndicates if the source branch of the merge request will be deleted after merge.
sourceBranchString!Source branch of the merge request.
targetBranchString!Target branch of the merge request.
titleString!Title of the merge request.

mergeRequestCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestCreateWorkItemRelations

Links work items to a merge request.

Input type: MergeRequestCreateWorkItemRelationsInput

mergeRequestCreateWorkItemRelations arguments

NameTypeDescriptionDefault
iidString!IID of the merge request to mutate.
linkTypeMergeRequestWorkItemLinkTypeType of relationship to create. Defaults to RELATED. MENTIONED relations are managed automatically and cannot be created.RELATED
projectPathID!Project the merge request to mutate is in.
workItemIds[WorkItemID!]!Global IDs of the work items to link.

mergeRequestCreateWorkItemRelations fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.
workItemRelations[MergeRequestWorkItemRelation!]Created merge request to work item relations.

mergeRequestDestroyRequestedChanges

Input type: MergeRequestDestroyRequestedChangesInput

mergeRequestDestroyRequestedChanges arguments

NameTypeDescription
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

mergeRequestDestroyRequestedChanges fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestDestroyWorkItemRelations

Removes relations between a merge request and work items.

Input type: MergeRequestDestroyWorkItemRelationsInput

mergeRequestDestroyWorkItemRelations arguments

NameTypeDescription
ids[MergeRequestIssueID!]!Global IDs of the relations to remove.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

mergeRequestDestroyWorkItemRelations fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.
removedRelationIds[MergeRequestIssueID!]Global IDs of the removed relations.

mergeRequestRequestChanges

Input type: MergeRequestRequestChangesInput

mergeRequestRequestChanges arguments

NameTypeDescription
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

mergeRequestRequestChanges fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge 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

NameTypeDescription
iidString!IID of the merge request to re-evaluate.
projectPathID!Project the merge request belongs to.

mergeRequestResyncSecurityPolicies fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after the re-evaluation was scheduled.

mergeRequestReviewerRereview

Input type: MergeRequestReviewerRereviewInput

mergeRequestReviewerRereview arguments

NameTypeDescription
duoCodeReviewDepthDuoCodeReviewDepthIntroduced 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 unless the duo_code_review_deep_flow feature flag is enabled for the current user.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
userIdUserID!User ID for the user that has been requested for a new review.

mergeRequestReviewerRereview fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge 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

NameTypeDescription
filtersMergeRequestSavedViewFilterInputMerge request filters stored in the saved view.
nameString!Name of the saved view.

mergeRequestSavedViewCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewMergeRequestSavedViewSaved 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

NameTypeDescription
idMergeRequestsSavedViewID!Global ID of the saved view.

mergeRequestSavedViewDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewMergeRequestSavedViewSaved 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

NameTypeDescription
filtersMergeRequestSavedViewFilterInputMerge request filters stored in the saved view.
idMergeRequestsSavedViewID!Global ID of the saved view.
nameStringName of the saved view.

mergeRequestSavedViewUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewMergeRequestSavedViewSaved view after the mutation.

mergeRequestSetAssignees

Input type: MergeRequestSetAssigneesInput

mergeRequestSetAssignees arguments

NameTypeDescriptionDefault
assigneeUsernames[String!]!Usernames to assign to the resource. Replaces existing assignees by default.
iidString!IID of the merge request to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.REPLACE
projectPathID!Project the merge request to mutate is in.

mergeRequestSetAssignees fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestSetBlockingMergeRequests

Input type: MergeRequestSetBlockingMergeRequestsInput

mergeRequestSetBlockingMergeRequests arguments

NameTypeDescription
blockingMergeRequestReferences[String!]!Array of blocking merge request references (e.g., “!123”, “project!456”).
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

mergeRequestSetBlockingMergeRequests fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestSetDraft

Input type: MergeRequestSetDraftInput

mergeRequestSetDraft arguments

NameTypeDescription
draftBoolean!Whether or not to set the merge request as a draft.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

mergeRequestSetDraft fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestSetLabels

Input type: MergeRequestSetLabelsInput

mergeRequestSetLabels arguments

NameTypeDescription
iidString!IID of the merge request to mutate.
labelIds[LabelID!]!Label IDs to set. Replaces existing labels by default.
operationModeMutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPathID!Project the merge request to mutate is in.

mergeRequestSetLabels fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestSetLocked

Input type: MergeRequestSetLockedInput

mergeRequestSetLocked arguments

NameTypeDescription
iidString!IID of the merge request to mutate.
lockedBoolean!Whether or not to lock the merge request.
projectPathID!Project the merge request to mutate is in.

mergeRequestSetLocked fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestSetMilestone

Input type: MergeRequestSetMilestoneInput

mergeRequestSetMilestone arguments

NameTypeDescription
iidString!IID of the merge request to mutate.
milestoneIdMilestoneIDMilestone to assign to the merge request.
projectPathID!Project the merge request to mutate is in.

mergeRequestSetMilestone fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestSetReviewers

Input type: MergeRequestSetReviewersInput

mergeRequestSetReviewers arguments

NameTypeDescriptionDefault
iidString!IID of the merge request to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.REPLACE
projectPathID!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

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestSetSubscription

Input type: MergeRequestSetSubscriptionInput

mergeRequestSetSubscription arguments

NameTypeDescription
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
subscribedStateBoolean!Desired state of the subscription.

mergeRequestSetSubscription fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestUpdate

Update attributes of a merge request.

Input type: MergeRequestUpdateInput

mergeRequestUpdate arguments

NameTypeDescription
descriptionStringDescription of the merge request (Markdown rendered as HTML for caching).
iidString!IID of the merge request to mutate.
mergeAfterTimeDate and time after which the merge request can be merged.
mergeBeforeTimeIntroduced as an experiment in GitLab 19.6.

Date and time before which the merge request can be merged.
overrideRequestedChangesBooleanOverride all requested changes. Can only be set by users who have permissionto merge this merge request.
projectPathID!Project the merge request to mutate is in.
removeSourceBranchBooleanIndicates if the source branch of the merge request will be deleted after merge.
stateMergeRequestNewStateAction to perform to change the state.
targetBranchStringTarget branch of the merge request.
timeEstimateStringEstimated time to complete the merge request. Use null or 0 to remove the current estimate.
titleStringTitle of the merge request.

mergeRequestUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestUpdateApprovalRule

Input type: MergeRequestUpdateApprovalRuleInput

mergeRequestUpdateApprovalRule arguments

NameTypeDescriptionDefault
approvalRuleIdInt!ID of an approval rule.
approvalsRequiredInt!Number of required approvals for a given rule.
groupIds[String!]IDs of groups as approvers.[]
iidString!IID of the merge request to mutate.
nameString!Name of the approval rule.
projectPathID!Project the merge request to mutate is in.
removeHiddenGroupsBooleanWhether hidden groups should be removed.false
userIds[String!]IDs of users as approvers.[]

mergeRequestUpdateApprovalRule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge request after mutation.

mergeRequestsCsvExport

  • Status: Experiment

Input type: MergeRequestsCsvExportInput

mergeRequestsCsvExport arguments

NameTypeDescription
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeUsernames[String!]Usernames of users assigned to the merge request.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPathStringIntroduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfterTimeMerge requests closed after the date.
closedBeforeTimeMerge requests closed before the date.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
ignoredReviewerUsernameStringIntroduced 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.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
orUnionedMergeRequestFilterInputList of arguments with inclusive OR.
projectPathID!Full project path.
releaseTagStringFilter by release tag.
reviewStateMergeRequestReviewStateReviewer state of the merge request.
reviewStates[MergeRequestReviewState!]Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge requests the current user is subscribed to.
targetBranches[String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.

mergeRequestsCsvExport fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
messageStringExport request result message.

mergeTrainsDeleteCar

  • Status: Experiment

Input type: MergeTrainsDeleteCarInput

mergeTrainsDeleteCar arguments

NameTypeDescription
carIdMergeTrainsCarID!Global ID of the car.

mergeTrainsDeleteCar fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

mlModelCreate

  • Status: Experiment

Input type: MlModelCreateInput

mlModelCreate arguments

NameTypeDescription
descriptionStringDescription of the model.
nameString!Name of the model.
projectPathID!Project the model to mutate is in.

mlModelCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
modelMlModelModel after mutation.

mlModelDelete

  • Status: Experiment

Input type: MlModelDeleteInput

mlModelDelete arguments

NameTypeDescription
idMlModelID!Global ID of the model to be deleted.
projectPathID!Project the model to mutate is in.

mlModelDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
modelMlModelModel after mutation.

mlModelDestroy

  • Status: Experiment

Input type: MlModelDestroyInput

mlModelDestroy arguments

NameTypeDescription
idMlModelID!Global ID of the model to be deleted.
projectPathID!Project the model to mutate is in.

mlModelDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
messageStringModel deletion result message.
modelMlModelModel after mutation.

mlModelEdit

  • Status: Experiment

Input type: MlModelEditInput

mlModelEdit arguments

NameTypeDescription
descriptionStringDescription of the model.
modelIdIntId of the model.
nameString!Name of the model.
projectPathID!Project the model to mutate is in.

mlModelEdit fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
modelMlModelModel after mutation.

mlModelVersionCreate

  • Status: Experiment

Input type: MlModelVersionCreateInput

mlModelVersionCreate arguments

NameTypeDescription
candidateIdMlCandidateIDGlobal ID of a candidate to promote optionally.
descriptionStringDescription of the model version.
modelIdMlModelID!Global ID of the model the version belongs to.
projectPathID!Project the model to mutate is in.
versionStringModel version.

mlModelVersionCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
modelVersionMlModelVersionModel after mutation.

mlModelVersionDelete

  • Status: Experiment

Input type: MlModelVersionDeleteInput

mlModelVersionDelete arguments

NameTypeDescription
idMlModelVersionID!Global ID of the model version to be deleted.

mlModelVersionDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
modelVersionMlModelVersionDeleted model version.

mlModelVersionEdit

  • Status: Experiment

Input type: MlModelVersionEditInput

mlModelVersionEdit arguments

NameTypeDescription
descriptionString!Description of the model version.
modelIdMlModelID!Global ID of the model the version belongs to.
projectPathID!Project the model to mutate is in.
versionString!Model version.

mlModelVersionEdit fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
modelVersionMlModelVersionModel after mutation.

namespaceBanDestroy

Input type: NamespaceBanDestroyInput

namespaceBanDestroy arguments

NameTypeDescription
idNamespacesNamespaceBanID!Global ID of the namespace ban to remove.

namespaceBanDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceBanNamespaceBanNamespace Ban.

namespaceCiCdSettingsUpdate

Input type: NamespaceCiCdSettingsUpdateInput

namespaceCiCdSettingsUpdate arguments

NameTypeDescription
allowStaleRunnerPruningBooleanIndicates if stale runners directly belonging to the namespace should be periodically pruned.
fullPathID!Full path of the namespace the settings belong to.

namespaceCiCdSettingsUpdate fields

NameTypeDescription
ciCdSettingsNamespaceCiCdSetting!CI/CD settings after mutation.
errors[String!]!Errors encountered during the mutation.

namespaceCreateRemoteDevelopmentClusterAgentMapping

Input type: NamespaceCreateRemoteDevelopmentClusterAgentMappingInput

namespaceCreateRemoteDevelopmentClusterAgentMapping arguments

NameTypeDescription
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be associated with the namespace.
namespaceIdGroupID!GlobalID of the group to be associated with the cluster agent.

namespaceCreateRemoteDevelopmentClusterAgentMapping fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceClusterAgentMappingNamespaceClusterAgentMappingIntroduced as an experiment in GitLab 17.10.

Created namespace cluster agent mapping.

namespaceDeleteRemoteDevelopmentClusterAgentMapping

Input type: NamespaceDeleteRemoteDevelopmentClusterAgentMappingInput

namespaceDeleteRemoteDevelopmentClusterAgentMapping arguments

NameTypeDescription
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be un-associated from the namespace.
namespaceIdGroupID!GlobalID of the group to be un-associated from the cluster agent.

namespaceDeleteRemoteDevelopmentClusterAgentMapping fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceClusterAgentMappingNamespaceClusterAgentMappingIntroduced as an experiment in GitLab 17.11.

Created namespace cluster agent mapping.

namespaceSecretsManagerEnroll

Input type: NamespaceSecretsManagerEnrollInput

namespaceSecretsManagerEnroll arguments

NameTypeDescription
namespacePathID!Full path of the namespace to enroll.

namespaceSecretsManagerEnroll fields

NameTypeDescription
enrollmentSecretsManagerEnrollmentEnrollment record.
errors[String!]!Errors encountered during the mutation.

namespaceSecretsManagerUnenroll

Input type: NamespaceSecretsManagerUnenrollInput

namespaceSecretsManagerUnenroll arguments

NameTypeDescription
namespacePathID!Full path of the namespace to unenroll.

namespaceSecretsManagerUnenroll fields

NameTypeDescription
enrollmentSecretsManagerEnrollmentEnrollment record.
errors[String!]!Errors encountered during the mutation.

namespaceSettingsUpdate

  • Status: Experiment

Input type: NamespaceSettingsUpdateInput

namespaceSettingsUpdate arguments

NameTypeDescription
fullPathID!Full path of the namespace the settings belong to.
pipelineVariablesDefaultRolePipelineVariablesDefaultRoleTypeIndicates the default minimum role required to override pipeline variables in the namespace.

namespaceSettingsUpdate fields

NameTypeDescription
ciCdSettingsCiCdSettings!Namespace CI/CD settings after mutation.
errors[String!]!Errors encountered during the mutation.

namespacesRegenerateNewWorkItemEmailAddress

  • Status: Experiment

Input type: NamespacesRegenerateNewWorkItemEmailAddressInput

namespacesRegenerateNewWorkItemEmailAddress arguments

NameTypeDescription
fullPathID!Full path of the namespace to regenerate the new work item email address for.

namespacesRegenerateNewWorkItemEmailAddress fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceNamespaceNamespace after regenerating the new work item email address.

noteConvertToThread

Convert a standard comment to a resolvable thread.

Input type: NoteConvertToThreadInput

noteConvertToThread arguments

NameTypeDescription
idNoteID!Global ID of the Note to convert.

noteConvertToThread fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

oncallRotationCreate

Input type: OncallRotationCreateInput

oncallRotationCreate arguments

NameTypeDescription
activePeriodOncallRotationActivePeriodInputTypeActive period of time that the on-call rotation should take place.
endsAtOncallRotationDateInputTypeEnd date and time of the on-call rotation, in the timezone of the on-call schedule.
nameString!Name of the on-call rotation.
participants[OncallUserInputType!]!Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
projectPathID!Project to create the on-call schedule in.
rotationLengthOncallRotationLengthInputType!Rotation length of the on-call rotation.
scheduleIidString!IID of the on-call schedule to create the on-call rotation in.
startsAtOncallRotationDateInputType!Start date and time of the on-call rotation, in the timezone of the on-call schedule.

oncallRotationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

oncallRotationDestroy

Input type: OncallRotationDestroyInput

oncallRotationDestroy arguments

NameTypeDescription
idIncidentManagementOncallRotationID!ID of the on-call rotation to remove.
projectPathID!Project to remove the on-call schedule from.
scheduleIidString!IID of the on-call schedule to the on-call rotation belongs to.

oncallRotationDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

oncallRotationUpdate

Input type: OncallRotationUpdateInput

oncallRotationUpdate arguments

NameTypeDescription
activePeriodOncallRotationActivePeriodInputTypeActive period of time that the on-call rotation should take place.
endsAtOncallRotationDateInputTypeEnd date and time of the on-call rotation, in the timezone of the on-call schedule.
idIncidentManagementOncallRotationID!ID of the on-call schedule to create the on-call rotation in.
nameStringName of the on-call rotation.
participants[OncallUserInputType!]Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
rotationLengthOncallRotationLengthInputTypeRotation length of the on-call rotation.
startsAtOncallRotationDateInputTypeStart date and time of the on-call rotation, in the timezone of the on-call schedule.

oncallRotationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

oncallScheduleCreate

Input type: OncallScheduleCreateInput

oncallScheduleCreate arguments

NameTypeDescription
descriptionStringDescription of the on-call schedule.
nameString!Name of the on-call schedule.
projectPathID!Project to create the on-call schedule in.
timezoneString!Timezone of the on-call schedule.

oncallScheduleCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

oncallScheduleDestroy

Input type: OncallScheduleDestroyInput

oncallScheduleDestroy arguments

NameTypeDescription
iidString!On-call schedule internal ID to remove.
projectPathID!Project to remove the on-call schedule from.

oncallScheduleDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

oncallScheduleUpdate

Input type: OncallScheduleUpdateInput

oncallScheduleUpdate arguments

NameTypeDescription
descriptionStringDescription of the on-call schedule.
iidString!On-call schedule internal ID to update.
nameStringName of the on-call schedule.
projectPathID!Project to update the on-call schedule in.
timezoneStringTimezone of the on-call schedule.

oncallScheduleUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

orbitExcludedGroupCreate

  • Status: Experiment

Input type: OrbitExcludedGroupCreateInput

orbitExcludedGroupCreate arguments

NameTypeDescription
groupPathID!Full path of the top-level group to exclude.

orbitExcludedGroupCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroupExcluded group.

orbitExcludedGroupDestroy

  • Status: Experiment

Input type: OrbitExcludedGroupDestroyInput

orbitExcludedGroupDestroy arguments

NameTypeDescription
groupPathID!Full path of the top-level group to remove from exclusions.

orbitExcludedGroupDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroupGroup removed from exclusions.

orbitInstanceStartTrial

  • Status: Experiment

Input type: OrbitInstanceStartTrialInput

orbitInstanceStartTrial fields

NameTypeDescription
accessOrbitAccessInstance Orbit access state after starting the trial.
errors[String!]!Errors encountered during the mutation.

orbitStartTrial

  • Status: Experiment

Input type: OrbitStartTrialInput

orbitStartTrial arguments

NameTypeDescription
groupPathID!Full path of the top-level group.

orbitStartTrial fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroupGroup the trial was requested for, also returned on error. Read orbit { enabled access { trial } } from it.

orbitUpdate

  • Status: Experiment

Input type: OrbitUpdateInput

orbitUpdate arguments

NameTypeDescription
enabledBoolean!Whether to enable or disable the Knowledge Graph for the group.
groupPathID!Full path of the group to update.

orbitUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
groupGroupGroup after mutation.

organizationConfirm

  • Status: Experiment

Input type: OrganizationConfirmInput

organizationConfirm arguments

NameTypeDescription
groups[GroupID!]Global IDs of top-level groups to transfer to the organization.
idOrganizationsOrganizationID!Global ID of the organization to confirm.

organizationConfirm fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationOrganizationOrganization after mutation.

organizationCreate

  • Status: Experiment

Input type: OrganizationCreateInput

organizationCreate arguments

NameTypeDescription
avatarUploadAvatar for the organization.
descriptionStringDescription of the organization.
nameString!Name for the organization.
pathString!Path for the organization.
visibilityOrganizationVisibilityVisibility for the organization.

organizationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationOrganizationOrganization after mutation.

organizationCreateClusterAgentMapping

  • Status: Experiment

Input type: OrganizationCreateClusterAgentMappingInput

organizationCreateClusterAgentMapping arguments

NameTypeDescription
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be associated with the organization.
organizationIdOrganizationsOrganizationID!GlobalID of the organization to be associated with the cluster agent.

organizationCreateClusterAgentMapping fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

organizationDelete

  • Status: Experiment

Input type: OrganizationDeleteInput

organizationDelete arguments

NameTypeDescription
avatarUploadAvatar for the organization.
descriptionStringDescription of the organization.
idOrganizationsOrganizationID!ID of the organization to soft-delete.

organizationDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationOrganizationSoft-deleted organization.

organizationDeleteClusterAgentMapping

  • Status: Experiment

Input type: OrganizationDeleteClusterAgentMappingInput

organizationDeleteClusterAgentMapping arguments

NameTypeDescription
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be dissociated with the organization.
organizationIdOrganizationsOrganizationID!GlobalID of the organization to be dissociated with the cluster agent.

organizationDeleteClusterAgentMapping fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

organizationRestore

  • Status: Experiment

Input type: OrganizationRestoreInput

organizationRestore arguments

NameTypeDescription
idOrganizationsOrganizationID!ID of the organization to restore.

organizationRestore fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationOrganizationRestored organization.

organizationUpdate

  • Status: Experiment

Input type: OrganizationUpdateInput

organizationUpdate arguments

NameTypeDescription
avatarUploadAvatar for the organization.
descriptionStringDescription of the organization.
idOrganizationsOrganizationID!ID of the organization to mutate.
nameStringName for the organization.
pathStringPath for the organization.
policyStoreExperimentEnabledBooleanIntroduced as an experiment in GitLab 19.4.

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.
visibilityOrganizationVisibilityVisibility for the organization.

organizationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationOrganizationOrganization after mutation.

organizationUserCreate

  • Status: Experiment

Input type: OrganizationUserCreateInput

organizationUserCreate arguments

NameTypeDescription
organizationIdOrganizationsOrganizationID!ID of the organization to add the user to.
userTypeOrganizationUserType!Type to add the organization user with.
usernameString!Username of the user to add to the organization.

organizationUserCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationUserOrganizationUserIntroduced as an experiment in GitLab 19.3.

Organization user added by the mutation.

organizationUserDelete

  • Status: Experiment

Input type: OrganizationUserDeleteInput

organizationUserDelete arguments

NameTypeDescription
idOrganizationsOrganizationUserID!ID of the organization user to delete.

organizationUserDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationUserOrganizationUserIntroduced as an experiment in GitLab 19.3.

Organization user that was deleted.

organizationUserUpdate

  • Status: Experiment

Input type: OrganizationUserUpdateInput

organizationUserUpdate arguments

NameTypeDescription
accessLevelOrganizationUserAccessLevel!Access level to update the organization user to.
idOrganizationsOrganizationUserID!ID of the organization user to mutate.

organizationUserUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
organizationUserOrganizationUserIntroduced as an experiment in GitLab 17.5.

Organization user after mutation.

pagesMarkOnboardingComplete

Input type: PagesMarkOnboardingCompleteInput

pagesMarkOnboardingComplete arguments

NameTypeDescription
projectPathID!Full path of the project.

pagesMarkOnboardingComplete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
onboardingCompleteBoolean!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

NameTypeDescriptionDefault
descriptionStringDescription of the token.
expiresAtISO8601DateExpiration date of the token.
granularScopes[GranularScopeInput!]!List of granular scopes to assign to the token.
nameString!Name of the token.
sudoBooleanWhether the token can impersonate other users with sudo. Requires the token owner to be an administrator.false

personalAccessTokenCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
tokenStringCreated personal access token.

personalAccessTokenRevoke

  • Status: Experiment

Revokes a specified personal access token.

Input type: PersonalAccessTokenRevokeInput

personalAccessTokenRevoke arguments

NameTypeDescription
idPersonalAccessTokenID!Global ID of the personal access token that will be revoked.

personalAccessTokenRevoke fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

personalAccessTokenRotate

  • Status: Experiment

Rotate a specified personal access token.

Input type: PersonalAccessTokenRotateInput

personalAccessTokenRotate arguments

NameTypeDescription
expiresAtISO8601DateExpiration date of the token.
idPersonalAccessTokenID!Global ID of the personal access token that will be rotated.

personalAccessTokenRotate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
tokenStringCreated personal access token.

pipelineCancel

Input type: PipelineCancelInput

pipelineCancel arguments

NameTypeDescription
idCiPipelineID!ID of the pipeline to mutate.

pipelineCancel fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelinePipelinePipeline after mutation.

pipelineCreate

Input type: PipelineCreateInput

pipelineCreate arguments

NameTypeDescription
asyncBooleanIntroduced 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.
mergeRequestIidStringIID of the merge request to create pipeline for.
projectPathID!Full path of the project that is triggering the pipeline.
refString!Ref on which to run the pipeline. Ignored when mergeRequestIid is provided; the merge request ref path is used instead.
variables[CiVariableInput!]Variables for the pipeline.

pipelineCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelinePipelinePipeline created after mutation. Null if async: true.
requestIdStringIntroduced as an experiment in GitLab 17.8.

ID for checking the pipeline creation status. Null if async: false.

pipelineDestroy

Input type: PipelineDestroyInput

pipelineDestroy arguments

NameTypeDescription
idCiPipelineID!ID of the pipeline to mutate.

pipelineDestroy fields

NameTypeDescription
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

NameTypeDescription
policyIdSecurityPolicyID!Global ID of the pipeline execution schedule policy to test.
projectPathID!Full path of the project to run the test on.

pipelineExecutionSchedulePolicyTestRun fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
testRunPolicyScheduleTestRunTest-run record created.

pipelineRetry

Input type: PipelineRetryInput

pipelineRetry arguments

NameTypeDescription
idCiPipelineID!ID of the pipeline to mutate.

pipelineRetry fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelinePipelinePipeline after mutation.

pipelineScheduleCreate

Input type: PipelineScheduleCreateInput

pipelineScheduleCreate arguments

NameTypeDescription
activeBooleanIndicates if the pipeline schedule should be active or not.
cronString!Cron expression of the pipeline schedule.
cronTimezoneStringCron time zone supported by ActiveSupport::TimeZone. For example: Pacific Time (US & Canada) (default: UTC).
descriptionString!Description of the pipeline schedule.
inputs[CiInputsInput!]Introduced as an experiment in GitLab 17.10.

Inputs for the pipeline schedule.
projectPathID!Full path of the project the pipeline schedule is associated with.
refString!Ref of the pipeline schedule.
variables[PipelineScheduleVariableInput!]Variables for the pipeline schedule.

pipelineScheduleCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelineSchedulePipelineScheduleCreated pipeline schedule.

pipelineScheduleDelete

Input type: PipelineScheduleDeleteInput

pipelineScheduleDelete arguments

NameTypeDescription
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

pipelineScheduleDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

pipelineSchedulePlay

Input type: PipelineSchedulePlayInput

pipelineSchedulePlay arguments

NameTypeDescription
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

pipelineSchedulePlay fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelineSchedulePipelineSchedulePipeline schedule after mutation.

pipelineScheduleTakeOwnership

Input type: PipelineScheduleTakeOwnershipInput

pipelineScheduleTakeOwnership arguments

NameTypeDescription
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

pipelineScheduleTakeOwnership fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelineSchedulePipelineScheduleUpdated pipeline schedule ownership.

pipelineScheduleUpdate

Input type: PipelineScheduleUpdateInput

pipelineScheduleUpdate arguments

NameTypeDescription
activeBooleanIndicates if the pipeline schedule should be active or not.
cronStringCron expression of the pipeline schedule.
cronTimezoneStringCron time zone supported by ActiveSupport::TimeZone. For example: Pacific Time (US & Canada) (default: UTC).
descriptionStringDescription of the pipeline schedule.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.
inputs[CiInputsInput!]Introduced as an experiment in GitLab 17.11.

Inputs for the pipeline schedule.
refStringRef of the pipeline schedule.
variables[PipelineScheduleVariableInput!]Variables for the pipeline schedule.

pipelineScheduleUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelineSchedulePipelineScheduleUpdated pipeline schedule.

pipelineTriggerCreate

  • Status: Experiment

Input type: PipelineTriggerCreateInput

pipelineTriggerCreate arguments

NameTypeDescription
descriptionString!Description of the pipeline trigger token.
expiresAtTimeTimestamp of when the pipeline trigger token expires.
projectPathID!Full path of the project that the pipeline trigger token to mutate is in.

pipelineTriggerCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelineTriggerPipelineTriggerMutated pipeline trigger token.

pipelineTriggerDelete

  • Status: Experiment

Input type: PipelineTriggerDeleteInput

pipelineTriggerDelete arguments

NameTypeDescription
idCiTriggerID!ID of the pipeline trigger token to delete.

pipelineTriggerDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

pipelineTriggerUpdate

  • Status: Experiment

Input type: PipelineTriggerUpdateInput

pipelineTriggerUpdate arguments

NameTypeDescription
descriptionString!Description of the pipeline trigger token.
idCiTriggerID!ID of the pipeline trigger token to update.

pipelineTriggerUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pipelineTriggerPipelineTriggerMutated pipeline trigger token.

processUserBillablePromotionRequest

  • Status: Experiment

Input type: ProcessUserBillablePromotionRequestInput

processUserBillablePromotionRequest arguments

NameTypeDescription
statusMemberApprovalStatusType!Status for the member approval request (approved, denied, pending).
userIdUserID!Global ID of user to be promoted.

processUserBillablePromotionRequest fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
resultUserPromotionStatusTypeStatus of the user promotion process (success, partial_success, failed).

projectBlobsRemove

  • Status: Experiment

Input type: projectBlobsRemoveInput

projectBlobsRemove arguments

NameTypeDescription
blobOids[String!]!List of blob oids.
projectPathID!Full path of the project to replace.

projectBlobsRemove fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

projectCiCdSettingsUpdate

Input type: ProjectCiCdSettingsUpdateInput

projectCiCdSettingsUpdate arguments

NameTypeDescription
crossProjectPushForJobTokenAllowedBooleanIndicates the ability to push to this repository using a job token from an allowlisted project.
displayPipelineVariablesBooleanIndicates whether pipeline variables can be displayed in the UI.
fullPathID!Full Path of the project the settings belong to.
groupRunnersEnabledBooleanIndicates whether group runners are enabled for the project.
inboundJobTokenScopeEnabledBooleanIndicates whether CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabledBooleanDeprecated in GitLab 16.0. Outbound job token scope is being removed. This field can now only be set to false.
keepLatestArtifactBooleanIndicates whether the latest artifact should be kept for the project.
maxPipelinesPerMergeTrainIntMaximum number of parallel pipelines per merge train.
mergePipelinesEnabledBooleanIndicates if merged results pipelines are enabled for the project.
mergeTrainEnforcementMergeTrainEnforcementMerge train enforcement level for the project.
mergeTrainsEnabledBooleanIndicates if merge trains are enabled for the project.
mergeTrainsSkipTrainAllowedBooleanIndicates whether an option is allowed to merge without refreshing the merge train. Ignored unless the merge_trains_skip_train feature flag is also enabled.
pipelineVariablesMinimumOverrideRoleStringMinimum role required to set variables when creating a pipeline or running a job.
pushRepositoryForJobTokenAllowedBooleanIndicates the ability to push to the original project repository using a job token.
resourceGroupDefaultProcessModeResourceGroupsProcessModeDefault process mode for resource groups in the project.
skipBranchPipelinesForMrsBooleanIndicates whether branch pipelines are skipped if a merge request is open.

projectCiCdSettingsUpdate fields

NameTypeDescription
ciCdSettingsProjectCiCdSetting!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

NameTypeDescription
keyString!Key of the custom attribute.
projectPathID!Full path of the project.
valueString!Value of the custom attribute.

projectCustomAttributeSet fields

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

NameTypeDescription
accessLevelMemberAccessLevel!Access level to update the members to.
expiresAtTimeDate and time the membership expires.
projectIdProjectID!Global ID of the project.
userIds[UserID!]!Global IDs of the members.

projectMemberBulkUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectMembers[ProjectMember!]Project members after mutation.
queuedMemberApprovalsMemberApprovalConnectionList of queued pending members approvals. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

projectSavedReplyCreate

  • Status: Experiment

Input type: ProjectSavedReplyCreateInput

projectSavedReplyCreate arguments

NameTypeDescription
contentString!Content of the saved reply.
nameString!Name of the saved reply.
projectIdProjectID!Project for the saved reply.

projectSavedReplyCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

projectSavedReplyDestroy

  • Status: Experiment

Input type: ProjectSavedReplyDestroyInput

projectSavedReplyDestroy arguments

NameTypeDescription
idProjectsSavedReplyID!Global ID of the project-level saved reply.

projectSavedReplyDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

projectSavedReplyUpdate

  • Status: Experiment

Input type: ProjectSavedReplyUpdateInput

projectSavedReplyUpdate arguments

NameTypeDescription
contentString!Content of the saved reply.
idProjectsSavedReplyID!Global ID of the project-level saved reply.
nameString!Name of the saved reply.

projectSavedReplyUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

projectSecretCreate

Input type: ProjectSecretCreateInput

projectSecretCreate arguments

NameTypeDescription
branchString!Branches that can access the secret.
descriptionStringDescription of the project secret.
environmentString!Environments that can access the secret.
nameString!Name of the project secret.
projectPathID!Project of the secret.
rotationIntervalDaysIntNumber of days between rotation reminders for the secret.
secretString!Value of the project secret.

projectSecretCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectSecretProjectSecretProject secret.
reasonSecretsManagerWriteDenialReasonIntroduced 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

NameTypeDescription
nameString!Name of the project secret.
projectPathID!Project of the secret.

projectSecretDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectSecretProjectSecretDeleted project secret.

projectSecretUpdate

Input type: ProjectSecretUpdateInput

projectSecretUpdate arguments

NameTypeDescription
branchStringNew branches that can access the secret.
descriptionStringNew description of the project secret.
environmentStringNew environments that can access the secret.
metadataCasInt!This should match the current metadata version of the project secret being updated.
nameString!Name of the project secret to update.
projectPathID!Project of the secret.
rotationIntervalDaysIntNumber of days between rotation reminders for the secret.
secretStringNew value of the project secret.

projectSecretUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectSecretProjectSecretUpdated project secret.
reasonSecretsManagerWriteDenialReasonIntroduced 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

NameTypeDescription
projectPathID!Project of the secrets manager.

projectSecretsManagerDeprovision fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectSecretsManagerProjectSecretsManagerProject secrets manager.
reasonSecretsManagerWriteDenialReasonIntroduced 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

NameTypeDescription
projectPathID!Project of the secrets manager.

projectSecretsManagerInitialize fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectSecretsManagerProjectSecretsManagerProject secrets manager.
reasonSecretsManagerWriteDenialReasonIntroduced 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

NameTypeDescription
principalPrincipalInput!User/MemberRole/Role whose access is being removed.
projectPathID!Project from which the permissions are removed.

projectSecretsPermissionDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
reasonSecretsManagerWriteDenialReasonIntroduced as an experiment in GitLab 19.2.

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

projectSecretsPermissionUpdate

Input type: ProjectSecretsPermissionUpdateInput

projectSecretsPermissionUpdate arguments

NameTypeDescription
actions[SecretsManagementAction!]!Actions that can be performed on secrets.
expiredAtISO8601DateExpiration date for Secret Permission (optional).
principalPrincipalInput!User/MemberRole/Role that is provided access.
projectPathID!Project to which the permissions are added.

projectSecretsPermissionUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
reasonSecretsManagerWriteDenialReasonIntroduced as an experiment in GitLab 19.2.

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

projectSecurityExclusionCreate

Input type: ProjectSecurityExclusionCreateInput

projectSecurityExclusionCreate arguments

NameTypeDescription
activeBoolean!Whether the exclusion is active.
descriptionStringOptional description for the exclusion.
projectPathID!Full path of the project the exclusion will be associated with.
scannerExclusionScannerEnum!Scanner to ignore values for based on the exclusion.
typeExclusionTypeEnum!Type of the exclusion.
valueString!Value of the exclusion.

projectSecurityExclusionCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityExclusionProjectSecurityExclusionProject security exclusion created.

projectSecurityExclusionDelete

Input type: ProjectSecurityExclusionDeleteInput

projectSecurityExclusionDelete arguments

NameTypeDescription
idSecurityProjectSecurityExclusionID!Global ID of the exclusion to be deleted.

projectSecurityExclusionDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

projectSecurityExclusionUpdate

Input type: ProjectSecurityExclusionUpdateInput

projectSecurityExclusionUpdate arguments

NameTypeDescription
activeBooleanWhether the exclusion is active.
descriptionStringOptional description for the exclusion.
idSecurityProjectSecurityExclusionID!Global ID of the exclusion to be updated.
scannerExclusionScannerEnumScanner to ignore values for based on the exclusion.
typeExclusionTypeEnumType of the exclusion.
valueStringValue of the exclusion.

projectSecurityExclusionUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityExclusionProjectSecurityExclusionProject security exclusion updated.

projectSetComplianceFramework

Deprecated in GitLab 17.11. Use mutation ProjectUpdateComplianceFrameworks instead of this.

Input type: ProjectSetComplianceFrameworkInput

projectSetComplianceFramework arguments

NameTypeDescription
complianceFrameworkIdComplianceManagementFrameworkIDID of the compliance framework to assign to the project. Set to null to unset.
projectIdProjectID!ID of the project to change the compliance framework of.

projectSetComplianceFramework fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

projectSetContinuousVulnerabilityScanning

Deprecated in GitLab 17.3. CVS has been enabled permanently. See this epic for more information.

Input type: ProjectSetContinuousVulnerabilityScanningInput

projectSetContinuousVulnerabilityScanning arguments

NameTypeDescription
enableBoolean!Desired status for continuous vulnerability scanning feature.
projectPathID!Full path of the project.

projectSetContinuousVulnerabilityScanning fields

NameTypeDescription
continuousVulnerabilityScanningEnabledBoolean!Whether feature is enabled.
errors[String!]!Errors encountered during the mutation.

projectSetLocked

Input type: ProjectSetLockedInput

projectSetLocked arguments

NameTypeDescription
filePathString!Full path to the file.
lockBoolean!Whether or not to lock the file path.
projectPathID!Full path of the project to mutate.

projectSetLocked fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

projectSettingsUpdate

  • Status: Experiment

Input type: ProjectSettingsUpdateInput

projectSettingsUpdate arguments

NameTypeDescription
aiAuditEventsStorageEnabledBooleanIntroduced as an experiment in GitLab 19.2.

Indicates whether AI audit events are stored for the project.
duoAutoModeEnabledBooleanIndicates whether Duo Agent Platform auto mode is enabled for the project.
duoContextExclusionSettingsDuoContextExclusionSettingsInputSettings for excluding files from Duo context.
duoFeaturesEnabledBooleanIndicates whether GitLab Duo features are enabled for the project.
duoSastFpDetectionEnabledBooleanIndicates whether SAST False Positive Detection is enabled for the project.
duoSastVrWorkflowEnabledBooleanIndicates whether SAST Vulnerability Resolution workflow is enabled for the project.
duoSecretDetectionFpEnabledBooleanIndicates whether Secret Detection False Positive Detection is enabled for the project.
fullPathID!Full Path of the project the settings belong to.
toolApprovalForSessionEnabledBooleanIndicates whether tool approval for Duo Workflow sessions is enabled for the project.
webBasedCommitSigningEnabledBooleanIntroduced as an experiment in GitLab 18.2.

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

projectSettingsUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectSettingsProjectSetting!Project settings after mutation.

projectSubscriptionCreate

Input type: ProjectSubscriptionCreateInput

projectSubscriptionCreate arguments

NameTypeDescription
projectPathString!Full path of the downstream project of the Project Subscription.
upstreamPathString!Full path of the upstream project of the Project Subscription.

projectSubscriptionCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
subscriptionCiSubscriptionsProjectProject Subscription created by the mutation.

projectSubscriptionDelete

Input type: ProjectSubscriptionDeleteInput

projectSubscriptionDelete arguments

NameTypeDescription
subscriptionIdCiSubscriptionsProjectID!ID of the subscription to delete.

projectSubscriptionDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

projectSyncFork

  • Status: Experiment

Input type: ProjectSyncForkInput

projectSyncFork arguments

NameTypeDescription
projectPathID!Full path of the project to initialize.
targetBranchString!Ref of the fork to fetch into.

projectSyncFork fields

NameTypeDescription
detailsForkDetailsUpdated fork details.
errors[String!]!Errors encountered during the mutation.

projectTargetBranchRuleCreate

Input type: ProjectTargetBranchRuleCreateInput

projectTargetBranchRuleCreate arguments

NameTypeDescription
nameString!Name for the target branch rule.
projectIdProjectID!Project ID for the target branch rule.
targetBranchString!Target branch for the target branch rule.

projectTargetBranchRuleCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
targetBranchRuleProjectTargetBranchRuleTarget branch rule after mutation.

projectTargetBranchRuleDestroy

Input type: ProjectTargetBranchRuleDestroyInput

projectTargetBranchRuleDestroy arguments

NameTypeDescription
idProjectsTargetBranchRuleID!ID for the target branch rule.

projectTargetBranchRuleDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

projectTextReplace

  • Status: Experiment

Input type: projectTextReplaceInput

projectTextReplace arguments

NameTypeDescription
projectPathID!Full path of the project to replace.
replacements[String!]!List of text patterns to replace project-wide.

projectTextReplace fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

projectTransfer

  • Status: Experiment

Input type: ProjectTransferInput

projectTransfer arguments

NameTypeDescription
idProjectID!Global ID of the project to transfer.
namespaceIdNamespaceID!Global ID of the target namespace.

projectTransfer fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

projectUpdateComplianceFrameworks

Update compliance frameworks for a project.

Input type: ProjectUpdateComplianceFrameworksInput

projectUpdateComplianceFrameworks arguments

NameTypeDescription
complianceFrameworkIds[ComplianceManagementFrameworkID!]!IDs of the compliance framework to update for the project.
projectIdProjectID!ID of the project to change the compliance framework of.

projectUpdateComplianceFrameworks fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectProject after mutation.

prometheusIntegrationCreate

Deprecated in GitLab 18.2. Use HttpIntegrationCreate.

Input type: PrometheusIntegrationCreateInput

prometheusIntegrationCreate arguments

NameTypeDescriptionDefault
activeBoolean!Whether the integration is receiving alerts.
apiUrlStringDeprecated in GitLab 18.2. Feature removed in 16.0.
nameStringName of the integration."Prometheus"
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.
projectPathID!Project to create the integration in.
typeAlertManagementIntegrationTypeType of integration to create. Cannot be changed after creation.HTTP

prometheusIntegrationCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementPrometheusIntegrationNewly created integration.

prometheusIntegrationResetToken

Deprecated in GitLab 18.2. Use HttpIntegrationResetToken.

Input type: PrometheusIntegrationResetTokenInput

prometheusIntegrationResetToken arguments

NameTypeDescription
idIntegrationsPrometheusID!ID of the integration to mutate.

prometheusIntegrationResetToken fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementPrometheusIntegrationUpdated integration.

prometheusIntegrationUpdate

Deprecated in GitLab 18.2. Use HttpIntegrationUpdate.

Input type: PrometheusIntegrationUpdateInput

prometheusIntegrationUpdate arguments

NameTypeDescription
activeBooleanWhether the integration is receiving alerts.
apiUrlStringDeprecated in GitLab 18.2. Feature removed in 16.0.
idIntegrationsPrometheusID!ID of the integration to mutate.
nameStringName of the integration.
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.

prometheusIntegrationUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
integrationAlertManagementPrometheusIntegrationUpdated integration.

promoteToEpic

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

Input type: PromoteToEpicInput

promoteToEpic arguments

NameTypeDescription
groupPathIDGroup the promoted epic will belong to.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

promoteToEpic fields

NameTypeDescription
epicEpicEpic after issue promotion.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

refreshFindingTokenStatus

Input type: RefreshFindingTokenStatusInput

refreshFindingTokenStatus arguments

NameTypeDescription
vulnerabilityIdVulnerabilityID!Global ID of the Vulnerability whose token status should be refreshed.

refreshFindingTokenStatus fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
findingTokenStatusVulnerabilityFindingTokenStatusUpdated token status record for the given finding.

refreshSecurityFindingTokenStatus

Input type: RefreshSecurityFindingTokenStatusInput

refreshSecurityFindingTokenStatus arguments

NameTypeDescription
securityFindingUuidString!UUID of the Security::Finding whose token status should be refreshed (MR context).

refreshSecurityFindingTokenStatus fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
findingTokenStatusSecurityFindingTokenStatusUpdated token status record for the given Security::Finding.

refreshStandardsAdherenceChecks

Input type: RefreshStandardsAdherenceChecksInput

refreshStandardsAdherenceChecks arguments

NameTypeDescription
groupPathID!Group path.

refreshStandardsAdherenceChecks fields

NameTypeDescription
adherenceChecksStatusStandardsAdherenceChecksStatusProgress of standards adherence checks.
errors[String!]!Errors encountered during the mutation.

refreshVulnerabilityFindingTokenStatus

Input type: RefreshVulnerabilityFindingTokenStatusInput

refreshVulnerabilityFindingTokenStatus arguments

NameTypeDescription
vulnerabilityIdVulnerabilityID!Global ID of the Vulnerability whose token status should be refreshed.

refreshVulnerabilityFindingTokenStatus fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
findingTokenStatusVulnerabilityFindingTokenStatusUpdated token status record for the given Vulnerabilities::Finding.

releaseAssetLinkCreate

Input type: ReleaseAssetLinkCreateInput

releaseAssetLinkCreate arguments

NameTypeDescriptionDefault
directAssetPathStringRelative path for a direct asset link.
linkTypeReleaseAssetLinkTypeType of the asset link.OTHER
nameString!Name of the asset link.
projectPathID!Full path of the project the asset link is associated with.
tagNameString!Name of the associated release’s tag.
urlString!URL of the asset link.

releaseAssetLinkCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
linkReleaseAssetLinkAsset link after mutation.

releaseAssetLinkDelete

Input type: ReleaseAssetLinkDeleteInput

releaseAssetLinkDelete arguments

NameTypeDescription
idReleasesLinkID!ID of the release asset link to delete.

releaseAssetLinkDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
linkReleaseAssetLinkDeleted release asset link.

releaseAssetLinkUpdate

Input type: ReleaseAssetLinkUpdateInput

releaseAssetLinkUpdate arguments

NameTypeDescription
directAssetPathStringRelative path for a direct asset link.
idReleasesLinkID!ID of the release asset link to update.
linkTypeReleaseAssetLinkTypeType of the asset link.
nameStringName of the asset link.
urlStringURL of the asset link.

releaseAssetLinkUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
linkReleaseAssetLinkAsset link after mutation.

releaseCreate

Input type: ReleaseCreateInput

releaseCreate arguments

NameTypeDescription
assetsReleaseAssetsInputAssets associated to the release.
descriptionStringDescription (also known as “release notes”) of the release.
milestones[String!]Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
nameStringName of the release.
projectPathID!Full path of the project the release is associated with.
refStringCommit SHA or branch name to use if creating a new tag.
releasedAtTimeDate and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
tagMessageStringMessage to use if creating a new annotated tag.
tagNameString!Name of the tag to associate with the release.

releaseCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
releaseReleaseRelease after mutation.

releaseDelete

Input type: ReleaseDeleteInput

releaseDelete arguments

NameTypeDescription
projectPathID!Full path of the project the release is associated with.
tagNameString!Name of the tag associated with the release to delete.

releaseDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
releaseReleaseDeleted release.

releaseUpdate

Input type: ReleaseUpdateInput

releaseUpdate arguments

NameTypeDescription
descriptionStringDescription (release notes) of the release.
milestones[String!]Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
nameStringName of the release.
projectPathID!Full path of the project the release is associated with.
releasedAtTimeRelease date.
tagNameString!Name of the tag associated with the release.

releaseUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
releaseReleaseRelease after mutation.

removeProjectFromSecurityDashboard

Input type: RemoveProjectFromSecurityDashboardInput

removeProjectFromSecurityDashboard arguments

NameTypeDescription
idProjectID!ID of the project to remove from the Instance Security Dashboard.

removeProjectFromSecurityDashboard fields

NameTypeDescription
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

NameTypeDescription
idDiffNoteID!Global ID of the DiffNote to update.
positionUpdateDiffImagePositionInput!Position of the note on a diff.

repositionImageDiffNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

restorePagesDeployment

  • Status: Experiment

Restores a Pages deployment that has been scheduled for deletion.

Input type: RestorePagesDeploymentInput

restorePagesDeployment arguments

NameTypeDescription
idPagesDeploymentID!ID of the Pages Deployment.

restorePagesDeployment fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
pagesDeploymentPagesDeployment!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

NameTypeDescriptionDefault
fullPathString!Full path of the project or group.
relationshipRelationshipTypeRelationship of the policies to resync.DIRECT

resyncSecurityPolicies fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

runnerAssignToProject

  • Status: Experiment

Input type: RunnerAssignToProjectInput

runnerAssignToProject arguments

NameTypeDescription
projectPathID!Full path of the project to which the runner will be assigned.
runnerIdCiRunnerID!ID of the runner to assign to the project .

runnerAssignToProject fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

runnerBulkPause

  • Status: Experiment

Input type: RunnerBulkPauseInput

runnerBulkPause arguments

NameTypeDescription
ids[CiRunnerID!]!IDs of the runners to pause or unpause.
pausedBoolean!Indicates the runner is not allowed to receive jobs.

runnerBulkPause fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
updatedCountIntNumber of records effectively updated. Only present if operation was performed synchronously.
updatedRunners[CiRunner!]Runners after mutation.

runnerCacheClear

Input type: RunnerCacheClearInput

runnerCacheClear arguments

NameTypeDescription
projectIdProjectID!Global ID of the project that will have its runner cache cleared.

runnerCacheClear fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

runnerCreate

  • Status: Experiment

Input type: RunnerCreateInput

runnerCreate arguments

NameTypeDescription
accessLevelCiRunnerAccessLevelAccess level of the runner.
descriptionStringDescription of the runner.
groupIdGroupIDGlobal ID of the group that the runner is created in (valid only for group runner).
lockedBooleanIndicates the runner is locked.
maintenanceNoteStringRunner’s maintenance notes.
maximumTimeoutIntMaximum timeout (in seconds) for jobs processed by the runner.
pausedBooleanIndicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactorFloatIntroduced as an experiment in GitLab 17.7.

Private projects’ “compute cost factor” associated with the runner (GitLab.com only).
projectIdProjectIDGlobal ID of the project that the runner is created in (valid only for project runner).
publicProjectsMinutesCostFactorFloatIntroduced as an experiment in GitLab 17.7.

Public projects’ “compute cost factor” associated with the runner (GitLab.com only).
runUntaggedBooleanIndicates the runner is able to run untagged jobs.
runnerTypeCiRunnerType!Type of the runner to create.
tagList[String!]Tags associated with the runner.
tokenExpiresAtTimeToken expiration time (ISO 8601 format). Must be between 5 minutes and 21 days in the future, and cannot exceed instance/group/project limits.
tokenRotationDeadlineTimeIntroduced 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

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
runnerCiRunnerRunner after mutation.

runnerDelete

Input type: RunnerDeleteInput

runnerDelete arguments

NameTypeDescription
idCiRunnerID!ID of the runner to delete.

runnerDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

runnerUnassignFromProject

  • Status: Experiment

Input type: RunnerUnassignFromProjectInput

runnerUnassignFromProject arguments

NameTypeDescription
projectPathID!Full path of the project from which the runner will be unassigned.
runnerIdCiRunnerID!ID of the runner to unassign from the project.

runnerUnassignFromProject fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

runnerUpdate

Input type: RunnerUpdateInput

runnerUpdate arguments

NameTypeDescription
accessLevelCiRunnerAccessLevelAccess level of the runner.
activeBooleanDeprecated in GitLab 14.8. Renamed. Use paused instead.
associatedProjects[ProjectID!]Projects associated with the runner. Available only for project runners.
descriptionStringDescription of the runner.
idCiRunnerID!ID of the runner to update.
lockedBooleanIndicates the runner is locked.
maintenanceNoteStringRunner’s maintenance notes.
maximumTimeoutIntMaximum timeout (in seconds) for jobs processed by the runner.
pausedBooleanIndicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactorFloatIntroduced as an experiment in GitLab 17.7.

Private projects’ “compute cost factor” associated with the runner (GitLab.com only).
publicProjectsMinutesCostFactorFloatIntroduced as an experiment in GitLab 17.7.

Public projects’ “compute cost factor” associated with the runner (GitLab.com only).
runUntaggedBooleanIndicates the runner is able to run untagged jobs.
tagList[String!]Tags associated with the runner.

runnerUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
runnerCiRunnerRunner after mutation.

runnersExportUsage

Input type: RunnersExportUsageInput

runnersExportUsage arguments

NameTypeDescriptionDefault
fromDateISO8601DateUTC start date of the period to report on. Defaults to the start of last full month.
fullPathIDFilter jobs by the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
maxProjectCountIntMaximum number of projects to return. All other runner usage will be attributed to an <Other projects> entry. Defaults to 1000 projects.1000
runnerTypeCiRunnerTypeScope of the runners to include in the report.
toDateISO8601DateUTC end date of the period to report on. " \ “Defaults to the end of the month specified by fromDate.

runnersExportUsage fields

NameTypeDescription
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

NameTypeDescription
idIDID of the project or group to reset the token for. Omit if resetting instance runner token.
typeCiRunnerType!Scope of the object to reset the token for.

runnersRegistrationTokenReset fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
tokenStringRunner token after mutation.

safeDisablePipelineVariables

Input type: SafeDisablePipelineVariablesInput

safeDisablePipelineVariables arguments

NameTypeDescription
fullPathID!Full path of the group to disable pipeline variables for.

safeDisablePipelineVariables fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
successBoolean!Indicates whether the migration was successfully enqueued.

savedReplyCreate

Input type: SavedReplyCreateInput

savedReplyCreate arguments

NameTypeDescription
contentString!Content of the saved reply.
nameString!Name of the saved reply.

savedReplyCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplySavedReplySaved reply after mutation.

savedReplyDestroy

Input type: SavedReplyDestroyInput

savedReplyDestroy arguments

NameTypeDescription
idUsersSavedReplyID!Global ID of the user saved reply.

savedReplyDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplySavedReplySaved reply after mutation.

savedReplyUpdate

Input type: SavedReplyUpdateInput

savedReplyUpdate arguments

NameTypeDescription
contentString!Content of the saved reply.
idUsersSavedReplyID!Global ID of the user saved reply.
nameString!Name of the saved reply.

savedReplyUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedReplySavedReplySaved 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

NameTypeDescription
fullPathStringFull path of the project.
nameString!Name of the policy. If the name is null, the name field from policy_yaml is used.
operationModeMutationOperationMode!Changes the operation mode.
policyYamlString!YAML snippet of the policy.
projectPathIDDeprecated in GitLab 14.10. Use fullPath.

scanExecutionPolicyCommit fields

NameTypeDescription
branchStringName of the branch to which the policy changes are committed.
errors[String!]!Errors encountered during the mutation.
validationErrors[SecurityPolicyValidationError!]Validation errors encountered during execution of the mutation.

secretsManagerEnableAddOn

  • Status: Experiment

Input type: SecretsManagerEnableAddOnInput

secretsManagerEnableAddOn arguments

NameTypeDescription
groupPathID!Full path of the top-level group to enable the Secrets Manager add-on for.

secretsManagerEnableAddOn fields

NameTypeDescription
entitlementSecretsManagerEntitlementSecrets Manager entitlement state after enabling the add-on. Null when enabling failed; see errors for the reason.
errors[String!]!Errors encountered during the mutation.

secretsManagerInstanceEnableAddOn

  • Status: Experiment

Input type: SecretsManagerInstanceEnableAddOnInput

secretsManagerInstanceEnableAddOn fields

NameTypeDescription
entitlementSecretsManagerEntitlementInstance-level Secrets Manager entitlement state after enabling the add-on. Null when enabling failed; see errors for the reason.
errors[String!]!Errors encountered during the mutation.

secretsManagerInstanceRefreshEntitlement

  • Status: Experiment

Input type: SecretsManagerInstanceRefreshEntitlementInput

secretsManagerInstanceRefreshEntitlement fields

NameTypeDescription
entitlementSecretsManagerEntitlementInstance-wide Secrets Manager entitlement state as the subscription service reports it now. Null when refreshing failed; see errors for the reason.
errors[String!]!Errors encountered during the mutation.

secretsManagerInstanceStartTrial

  • Status: Experiment

Input type: SecretsManagerInstanceStartTrialInput

secretsManagerInstanceStartTrial fields

NameTypeDescription
entitlementSecretsManagerEntitlementInstance-wide Secrets Manager entitlement state after starting the trial. Null when the post-trial state cannot be resolved; query secretsManagerInstanceEntitlement instead.
errors[String!]!Errors encountered during the mutation.

secretsManagerRefreshEntitlement

  • Status: Experiment

Input type: SecretsManagerRefreshEntitlementInput

secretsManagerRefreshEntitlement arguments

NameTypeDescription
groupPathID!Full path of the top-level group to refresh the Secrets Manager entitlement for.

secretsManagerRefreshEntitlement fields

NameTypeDescription
entitlementSecretsManagerEntitlementSecrets Manager entitlement state as the subscription service reports it now. Null when the subscription service could not be reached; see errors.
errors[String!]!Errors encountered during the mutation.

secretsManagerStartTrial

  • Status: Experiment

Input type: SecretsManagerStartTrialInput

secretsManagerStartTrial arguments

NameTypeDescription
groupPathID!Full path of the top-level group to start a Secrets Manager trial for.

secretsManagerStartTrial fields

NameTypeDescription
entitlementSecretsManagerEntitlementSecrets Manager entitlement state after starting the trial. Null when the post-trial state cannot be resolved; query the group entitlement directly instead.
errors[String!]!Errors encountered during the mutation.

securityAttributeCreate

Input type: SecurityAttributeCreateInput

securityAttributeCreate arguments

NameTypeDescription
attributes[SecurityAttributeInput!]!Attributes to create.
categoryIdSecurityCategoryID!Global ID of the security category.
namespaceIdNamespaceID!Global ID of the namespace.

securityAttributeCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityAttributes[SecurityAttribute!]Created security attributes.

securityAttributeDestroy

Input type: SecurityAttributeDestroyInput

securityAttributeDestroy arguments

NameTypeDescription
idSecurityAttributeID!Global ID of the security attribute to destroy.

securityAttributeDestroy fields

NameTypeDescription
deletedAttributeGidSecurityAttributeIDGlobal ID of the destroyed security attribute.
errors[String!]!Errors encountered during the mutation.

securityAttributeProjectUpdate

Input type: SecurityAttributeProjectUpdateInput

securityAttributeProjectUpdate arguments

NameTypeDescription
addAttributeIds[SecurityAttributeID!]Global IDs of the security attributes to add to the project.
projectIdProjectID!Global ID of the project.
removeAttributeIds[SecurityAttributeID!]Global IDs of the security attributes to remove from the project.

securityAttributeProjectUpdate fields

NameTypeDescription
addedCountIntNumber of attributes added.
errors[String!]!Errors encountered during the mutation.
projectProjectUpdated project.
removedCountIntNumber of attributes removed.

securityAttributeUpdate

Input type: SecurityAttributeUpdateInput

securityAttributeUpdate arguments

NameTypeDescription
colorColorColor of the security attribute.
descriptionStringDescription of the security attribute.
idSecurityAttributeID!Global ID of the security attribute.
nameStringName of the security attribute.

securityAttributeUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityAttributeSecurityAttributeUpdated security attribute.

securityCategoryCreate

Input type: SecurityCategoryCreateInput

securityCategoryCreate arguments

NameTypeDescription
descriptionStringDescription of the security category.
multipleSelectionBooleanWhether multiple attributes can be selected.
nameString!Name of the security category.
namespaceIdNamespaceID!Global ID of the category namespace.

securityCategoryCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityCategorySecurityCategoryCreated security category.

securityCategoryDestroy

Input type: SecurityCategoryDestroyInput

securityCategoryDestroy arguments

NameTypeDescription
idSecurityCategoryID!Global ID of the security category to destroy.

securityCategoryDestroy fields

NameTypeDescription
deletedAttributesGid[SecurityAttributeID!]Global IDs of the deleted security attributes.
deletedCategoryGidSecurityCategoryIDGlobal ID of the deleted security category.
errors[String!]!Errors encountered during the mutation.

securityCategoryUpdate

Input type: SecurityCategoryUpdateInput

securityCategoryUpdate arguments

NameTypeDescription
descriptionStringDescription of the security category.
idSecurityCategoryID!Global ID of the security category.
nameStringName of the security category.
namespaceIdNamespaceID!Global ID of the category namespace.

securityCategoryUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityCategorySecurityCategoryUpdated security category.

securityFindingCreateIssue

Input type: SecurityFindingCreateIssueInput

securityFindingCreateIssue arguments

NameTypeDescription
projectProjectID!ID of the project to attach the issue to.
uuidString!UUID of the security finding to be used to create an issue.

securityFindingCreateIssue fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.

securityFindingCreateMergeRequest

Input type: SecurityFindingCreateMergeRequestInput

securityFindingCreateMergeRequest arguments

NameTypeDescription
uuidString!UUID of the security finding to be used to create a merge request.

securityFindingCreateMergeRequest fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
mergeRequestMergeRequestMerge Request created after mutation.

securityFindingCreateVulnerability

  • Status: Experiment

Input type: SecurityFindingCreateVulnerabilityInput

securityFindingCreateVulnerability arguments

NameTypeDescription
uuidString!UUID of the security finding to be used to create a vulnerability.

securityFindingCreateVulnerability fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability created after mutation.

securityFindingDismiss

Input type: SecurityFindingDismissInput

securityFindingDismiss arguments

NameTypeDescription
commentStringComment why finding should be dismissed.
dismissalReasonVulnerabilityDismissalReasonReason why finding should be dismissed.
uuidString!UUID of the finding to be dismissed.

securityFindingDismiss fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityFindingPipelineSecurityReportFindingDismissed finding.
uuidStringUUID of dismissed finding.

securityFindingExternalIssueLinkCreate

Input type: SecurityFindingExternalIssueLinkCreateInput

securityFindingExternalIssueLinkCreate arguments

NameTypeDescription
externalTrackerVulnerabilityExternalIssueLinkExternalTracker!External tracker type of the external issue link.
linkTypeVulnerabilityExternalIssueLinkType!Type of the external issue link.
projectProjectID!ID of the project to attach the issue to.
uuidString!UUID of the security finding to be used to create an issue.

securityFindingExternalIssueLinkCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalIssueLinkVulnerabilityExternalIssueLinkCreated external issue link.

securityFindingJiraIssueFormUrlCreate

  • Status: Experiment

Input type: SecurityFindingJiraIssueFormUrlCreateInput

securityFindingJiraIssueFormUrlCreate arguments

NameTypeDescription
projectProjectID!ID of the project to attach the issue to.
uuidString!UUID of the security finding to be used to create an issue.

securityFindingJiraIssueFormUrlCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
jiraIssueFormUrlStringURL to Jira issue creation form with pre-filled vulnerability data.

securityFindingRevertToDetected

Input type: SecurityFindingRevertToDetectedInput

securityFindingRevertToDetected arguments

NameTypeDescription
commentStringComment that explains why finding was reverted to detected status.
uuidString!UUID of the finding to be dismissed.

securityFindingRevertToDetected fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityFindingPipelineSecurityReportFindingFinding reverted to detected.

securityFindingSeverityOverride

Input type: SecurityFindingSeverityOverrideInput

securityFindingSeverityOverride arguments

NameTypeDescription
severityVulnerabilitySeverity!New severity value for the finding.
uuidString!UUID of the finding to modify.

securityFindingSeverityOverride fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
securityFindingPipelineSecurityReportFindingFinding 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

NameTypeDescription
fullPathStringFull path of the project or group.
projectPathIDDeprecated in GitLab 14.10. Use fullPath.
securityPolicyProjectIdProjectID!ID of the security policy project.

securityPolicyProjectAssign fields

NameTypeDescription
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

NameTypeDescription
fullPathStringFull path of the project or group.
projectPathIDDeprecated in GitLab 14.10. Use fullPath.

securityPolicyProjectCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectSecurity 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

NameTypeDescription
fullPathString!Full path of the project or group.

securityPolicyProjectCreateAsync fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

securityPolicyProjectUnassign

Unassigns the security policy project for the given project (full_path).

Input type: SecurityPolicyProjectUnassignInput

securityPolicyProjectUnassign arguments

NameTypeDescription
fullPathStringFull path of the project or group.
projectPathIDDeprecated in GitLab 14.10. Use fullPath.

securityPolicyProjectUnassign fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

securityRefsTrack

  • Status: Experiment

Input type: SecurityRefsTrackInput

securityRefsTrack arguments

NameTypeDescription
projectPathID!Full path of the project.
refs[SecurityRefInput!]!Array of refs to be tracked.

securityRefsTrack fields

NameTypeDescription
errors[String!]!Errors encountered during the operation.
trackedRefs[SecurityTrackedRef!]Refs that were successfully tracked.

securityRefsUntrack

  • Status: Experiment

Input type: SecurityRefsUntrackInput

securityRefsUntrack arguments

NameTypeDescription
refIds[SecurityProjectTrackedContextID!]!Global IDs of the tracked refs to stop tracking.

securityRefsUntrack fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
untrackedRefIds[ID!]Global IDs of refs that were successfully untracked.

securityScanProfileAttach

  • Status: Experiment

Input type: SecurityScanProfileAttachInput

securityScanProfileAttach arguments

NameTypeDescriptionDefault
groupIds[GroupID!]Group IDs to attach the profile to.[]
modeSecurityScanProfileAttachModeHow to attach the profile relative to existing profiles of the same scan type.REPLACE
projectIds[ProjectID!]Project IDs to attach the profile to.[]
securityScanProfileIdSecurityScanProfileID!Security scan profile ID to attach.

securityScanProfileAttach fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

securityScanProfileCreate

  • Status: Experiment

Input type: SecurityScanProfileCreateInput

securityScanProfileCreate arguments

NameTypeDescriptionDefault
descriptionString!Description of the scan profile.
nameString!Name of the scan profile.
namespaceIdNamespaceID!Global ID of the top level namespace to create the scan profile for.
scanTypeSecurityScanProfileType!Type of the scan profile.
stripDefaultsBooleanWhen true, trigger configuration values equal to the defaults are removed before storage so only overrides are persisted. When false, the configuration is stored as provided, ignoring defaults.true
triggers[SecurityScanProfileTriggerInput!]!Triggers with optional configuration for the scan profile. At least one is required.

securityScanProfileCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
scanProfileScanProfileTypeCreated scan profile.

securityScanProfileDelete

  • Status: Experiment

Input type: SecurityScanProfileDeleteInput

securityScanProfileDelete arguments

NameTypeDescription
idSecurityScanProfileID!Global ID of the scan profile to delete.

securityScanProfileDelete fields

NameTypeDescription
deletedScanProfileIdSecurityScanProfileIDGlobal ID of the deleted scan profile.
errors[String!]!Errors encountered during the mutation.

securityScanProfileDetach

  • Status: Experiment

Input type: SecurityScanProfileDetachInput

securityScanProfileDetach arguments

NameTypeDescriptionDefault
groupIds[GroupID!]Group IDs to detach the profile from.[]
projectIds[ProjectID!]Project IDs to detach the profile from.[]
securityScanProfileIdSecurityScanProfileID!Security scan profile ID to detach.

securityScanProfileDetach fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

securityScanProfileUpdate

  • Status: Experiment

Input type: SecurityScanProfileUpdateInput

securityScanProfileUpdate arguments

NameTypeDescriptionDefault
descriptionStringDescription of the scan profile.
idSecurityScanProfileID!Global ID of the scan profile to update.
nameStringName of the scan profile.
stripDefaultsBooleanWhen true, trigger configuration values equal to the defaults are removed before storage so only overrides are persisted. When false, the configuration is stored as provided, ignoring defaults.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

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
scanProfileScanProfileTypeUpdated scan profile.

securityTrainingUpdate

Input type: SecurityTrainingUpdateInput

securityTrainingUpdate arguments

NameTypeDescription
isEnabledBoolean!Sets the training provider as enabled for the project.
isPrimaryBooleanSets the training provider as primary for the project.
projectPathID!Full path of the project.
providerIdSecurityTrainingProviderID!ID of the provider.

securityTrainingUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
trainingProjectSecurityTrainingRepresents the training entity subject to mutation.

setContainerScanningForRegistry

Enable/disable container scanning for registry for the given project.

Input type: SetContainerScanningForRegistryInput

setContainerScanningForRegistry arguments

NameTypeDescription
enableBoolean!Desired status for container scanning for registry feature.
namespacePathID!Full path of the namespace (project).

setContainerScanningForRegistry fields

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

NameTypeDescription
enableBoolean!Desired status for CVS for container scanning.
projectPathID!Full path of the project.

setCvsForContainerScanning fields

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

NameTypeDescription
enableBoolean!Desired status for CVS for dependency scanning.
projectPathID!Full path of the project.

setCvsForDependencyScanning fields

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

NameTypeDescription
groupPathID!Full path of the group.
keyString!Key of the custom attribute.
valueString!Value of the custom attribute.

setGroupCustomAttribute fields

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

NameTypeDescription
namespacePathID!Full path of the group.
projectsToExclude[Int!]IDs of projects to exclude from the feature.
secretPushProtectionEnabledBoolean!Whether to enable the feature.

setGroupSecretPushProtection fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

setGroupValidityChecks

Enable or disable Validity Checks for a group.

Input type: SetGroupValidityChecksInput

setGroupValidityChecks arguments

NameTypeDescription
namespacePathID!Full path of the group.
projectsToExclude[Int!]IDs of projects to exclude from validity checks configuration.
validityChecksEnabledBoolean!Whether to enable validity checks for all projects in the group.

setGroupValidityChecks fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
validityChecksEnabledBoolean!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

NameTypeDescription
projectPathID!Full path of the project.
sourceSecurityPreferredLicenseSourceConfiguration!Preferred source of license information for dependencies.

setLicenseConfigurationSource fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
licenseConfigurationSourceSecurityPreferredLicenseSourceConfigurationPreferred source of license information for dependencies.

setLicenseScanningForCyclonedx

Enable/disable license scanning for CycloneDX SBOM files for the given project.

Input type: SetLicenseScanningForCyclonedxInput

setLicenseScanningForCyclonedx arguments

NameTypeDescription
enableBoolean!Desired status for license scanning for CycloneDX files.
projectPathID!Full path of the project.

setLicenseScanningForCyclonedx fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
licenseScanningForCyclonedxEnabledBooleanWhether license scanning for CycloneDX files is enabled.

setPagesForceHttps

Input type: SetPagesForceHttpsInput

setPagesForceHttps arguments

NameTypeDescription
projectPathID!Path of the project to set the pages force HTTPS.
valueBoolean!Indicates user wants to enforce HTTPS on their pages.

setPagesForceHttps fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectProject that was updated.

setPagesUseUniqueDomain

Input type: SetPagesUseUniqueDomainInput

setPagesUseUniqueDomain arguments

NameTypeDescription
projectPathID!Path of the project to set the pages to use unique domains.
valueBoolean!Indicates user wants to use unique subdomains for their pages.

setPagesUseUniqueDomain fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projectProjectProject that was updated.

setPreReceiveSecretDetection

Enable/disable secret push protection for the given project.

Input type: SetPreReceiveSecretDetectionInput

setPreReceiveSecretDetection arguments

NameTypeDescription
enableBoolean!Desired status for secret push protection feature.
namespacePathID!Full path of the namespace (project).

setPreReceiveSecretDetection fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
preReceiveSecretDetectionEnabledBooleanWhether the feature is enabled.
secretPushProtectionEnabledBooleanWhether the feature is enabled.

setSecretPushProtection

Enable/disable secret push protection for the given project.

Input type: SetSecretPushProtectionInput

setSecretPushProtection arguments

NameTypeDescription
enableBoolean!Desired status for secret push protection feature.
namespacePathID!Full path of the namespace (project).

setSecretPushProtection fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
preReceiveSecretDetectionEnabledBooleanWhether the feature is enabled.
secretPushProtectionEnabledBooleanWhether the feature is enabled.

setValidityChecks

Enable/disable secret detection validity checks for the given project.

Input type: SetValidityChecksInput

setValidityChecks arguments

NameTypeDescription
enableBoolean!Desired status for validity checks feature.
namespacePathID!Full path of the namespace (project).

setValidityChecks fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
validityChecksEnabledBooleanWhether the feature is enabled.

starProject

  • Status: Experiment

Input type: StarProjectInput

starProject arguments

NameTypeDescription
projectIdProjectID!Full path of the project to star or unstar.
starredBoolean!Indicates whether to star or unstar the project.

starProject fields

NameTypeDescription
countString!Number of stars for the project.
errors[String!]!Errors encountered during the mutation.

startVulnerabilityWorkflow

  • Status: Experiment

Creates and starts a vulnerability workflow execution.

Input type: StartVulnerabilityWorkflowInput

startVulnerabilityWorkflow arguments

NameTypeDescription
findingUuids[String!]Finding UUIDs to process, up to 1000. If omitted, all project findings are processed.
projectIdProjectID!Global ID of the project.
severities[VulnerabilitySeverity!]Severities to process. If omitted, all severities are processed.
workflowVulnerabilityDuoWorkflow!Workflow to execute.

startVulnerabilityWorkflow fields

NameTypeDescription
errorReasonVulnerabilityWorkflowErrorReasonMachine-readable reason for the mutation error.
errors[String!]!Errors encountered during the mutation.
executionVulnerabilityWorkflowExecutionWorkflow 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

NameTypeDescriptionDefault
messageStringTagging message.""
nameString!Name of the tag.
projectPathID!Project full path the branch is associated with.
refString!Tag name or commit SHA to create tag from.

tagCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
tagTagTag after mutation.

tagDelete

Input type: TagDeleteInput

tagDelete arguments

NameTypeDescription
nameString!Name of the tag.
projectPathID!Project full path the branch is associated with.

tagDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
tagTagTag after mutation.

terraformStateDelete

Input type: TerraformStateDeleteInput

terraformStateDelete arguments

NameTypeDescription
idTerraformStateID!Global ID of the Terraform state.

terraformStateDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

terraformStateLock

Input type: TerraformStateLockInput

terraformStateLock arguments

NameTypeDescription
idTerraformStateID!Global ID of the Terraform state.

terraformStateLock fields

NameTypeDescription
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

NameTypeDescription
idTerraformStateID!Global ID of the Terraform state.

terraformStateRestore fields

NameTypeDescription
errors[String!]!Errors encountered during restore.
terraformStateTerraformStateTerraform state after restore.

terraformStateUnlock

Input type: TerraformStateUnlockInput

terraformStateUnlock arguments

NameTypeDescription
idTerraformStateID!Global ID of the Terraform state.

terraformStateUnlock fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

timelineEventCreate

  • Status: Experiment

Input type: TimelineEventCreateInput

timelineEventCreate arguments

NameTypeDescription
incidentIdIssueID!Incident ID of the timeline event.
noteString!Text note of the timeline event.
occurredAtTime!Timestamp of when the event occurred.
timelineEventTagNames[String!]Tags for the incident timeline event.

timelineEventCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
timelineEventTimelineEventTypeTimeline event.

timelineEventDestroy

Input type: TimelineEventDestroyInput

timelineEventDestroy arguments

NameTypeDescription
idIncidentManagementTimelineEventID!Timeline event ID to remove.

timelineEventDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
timelineEventTimelineEventTypeTimeline event.

timelineEventPromoteFromNote

Input type: TimelineEventPromoteFromNoteInput

timelineEventPromoteFromNote arguments

NameTypeDescription
noteIdNoteID!Note ID from which the timeline event promoted.

timelineEventPromoteFromNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
timelineEventTimelineEventTypeTimeline event.

timelineEventTagCreate

Input type: TimelineEventTagCreateInput

timelineEventTagCreate arguments

NameTypeDescription
nameString!Name of the tag.
projectPathID!Project to create the timeline event tag in.

timelineEventTagCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
timelineEventTagTimelineEventTagTypeTimeline event tag.

timelineEventUpdate

Input type: TimelineEventUpdateInput

timelineEventUpdate arguments

NameTypeDescription
idIncidentManagementTimelineEventID!ID of the timeline event to update.
noteStringText note of the timeline event.
occurredAtTimeTimestamp when the event occurred.
timelineEventTagNames[String!]Tags for the incident timeline event.

timelineEventUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
timelineEventTimelineEventTypeTimeline event.

timelogCreate

Input type: TimelogCreateInput

timelogCreate arguments

NameTypeDescription
issuableIdIssuableID!Global ID of the issuable (Issue, WorkItem or MergeRequest).
spentAtTimeTimestamp of when the time was spent. If empty, defaults to current time.
summaryString!Summary of time spent.
timeSpentString!Amount of time spent.

timelogCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
timelogTimelogTimelog.

timelogDelete

Input type: TimelogDeleteInput

timelogDelete arguments

NameTypeDescription
idTimelogID!Global ID of the timelog.

timelogDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
timelogTimelogTimelog.

todoCreate

Input type: TodoCreateInput

todoCreate arguments

NameTypeDescription
noteIdNoteIDIntroduced 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.
targetIdTodoableID!Global ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported.

todoCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todoTodoTo-do item created.

todoDeleteAllDone

  • Status: Experiment

Input type: TodoDeleteAllDoneInput

todoDeleteAllDone arguments

NameTypeDescription
updatedBeforeTimeTo-do items marked as done before the timestamp will be deleted.

todoDeleteAllDone fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

todoDeleteMany

  • Status: Experiment

Input type: TodoDeleteManyInput

todoDeleteMany arguments

NameTypeDescription
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).

todoDeleteMany fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

todoMarkDone

Input type: TodoMarkDoneInput

todoMarkDone arguments

NameTypeDescription
idTodoID!Global ID of the to-do item to mark as done.

todoMarkDone fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todoTodo!Requested to-do item.

todoResolveMany

  • Status: Experiment

Input type: TodoResolveManyInput

todoResolveMany arguments

NameTypeDescription
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).

todoResolveMany fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Resolved to-do items.

todoRestore

Input type: TodoRestoreInput

todoRestore arguments

NameTypeDescription
idTodoID!Global ID of the to-do item to restore.

todoRestore fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todoTodo!Requested to-do item.

todoRestoreMany

Input type: TodoRestoreManyInput

todoRestoreMany arguments

NameTypeDescription
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).

todoRestoreMany fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Restored to-do items.

todoSnooze

  • Status: Experiment

Input type: TodoSnoozeInput

todoSnooze arguments

NameTypeDescription
idTodoID!Global ID of the to-do item to be snoozed.
snoozeUntilTime!Time until which the todo should be snoozed.

todoSnooze fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todoTodo!Requested to-do item.

todoSnoozeMany

  • Status: Experiment

Input type: TodoSnoozeManyInput

todoSnoozeMany arguments

NameTypeDescription
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).
snoozeUntilTime!Time until which the todos should be snoozed.

todoSnoozeMany fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Snoozed to-do items.

todoUnSnooze

  • Status: Experiment

Input type: TodoUnSnoozeInput

todoUnSnooze arguments

NameTypeDescription
idTodoID!Global ID of the to-do item to be snoozed.

todoUnSnooze fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todoTodo!Requested to-do item.

todoUnsnoozeMany

  • Status: Experiment

Input type: TodoUnsnoozeManyInput

todoUnsnoozeMany arguments

NameTypeDescription
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).

todoUnsnoozeMany fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Unsnoozed to-do items.

todosMarkAllDone

Input type: TodosMarkAllDoneInput

todosMarkAllDone arguments

NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
projectId[ID!]ID of a project.
targetIdTodoableIDGlobal ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported. If argument is omitted, all pending to-do items of the current user are marked as done.
type[TodoTargetEnum!]Type of the todo.

todosMarkAllDone fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
todos[Todo!]!Updated to-do items.

unlinkProjectComplianceViolationIssue

  • Status: Experiment

Input type: UnlinkProjectComplianceViolationIssueInput

unlinkProjectComplianceViolationIssue arguments

NameTypeDescription
issueIidString!IID of the issue to be unlinked.
projectPathID!Full path of the project the issue belongs to.
violationIdComplianceManagementProjectsComplianceViolationID!Global ID of the project compliance violation.

unlinkProjectComplianceViolationIssue fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
violationProjectComplianceViolationUpdated project compliance violation.

updateAiToolRule

  • Status: Experiment

Updates the permission settings for an AI tool rule.

Input type: UpdateAiToolRuleInput

updateAiToolRule arguments

NameTypeDescription
backgroundAccessAiBackgroundToolPermissionIntroduced as an experiment in GitLab 19.3.

Permission mode for the background-flow surface.
fullPathID!Full path of the root namespace to update the tool rule for.
localAccessAiToolPermissionPermission mode for local or IDE surface.
projectPathIDFull path of the project to update the tool rule for. When provided, creates a project-level rule that can only be stricter than the namespace rule.
toolIdString!Tool name string identifying the tool to update. For example, “create_issue”.
unsetAccessTypes[AiToolAccessType!]Introduced as an experiment in GitLab 19.5.

Access types to clear so they fall back to their defaults. The rule is deleted when every access type is unset.
webAccessAiToolPermissionPermission mode for web surface.

updateAiToolRule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
toolRuleAiToolRuleUpdated tool rule after mutation.

updateAlertStatus

Input type: UpdateAlertStatusInput

updateAlertStatus arguments

NameTypeDescription
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.
statusAlertManagementStatus!Status to set the alert.

updateAlertStatus fields

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

updateBoard

Input type: UpdateBoardInput

updateBoard arguments

NameTypeDescription
assigneeIdUserIDID of user to be assigned to the board.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
idBoardID!Board global ID.
iterationCadenceIdIterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationIdIterationIDID of iteration to be assigned to the board.
labelIds[LabelID!]IDs of labels to be added to the board.
labels[String!]Labels of the issue.
milestoneIdMilestoneIDID of milestone to be assigned to the board.
nameStringBoard name.
weightIntWeight value to be assigned to the board.

updateBoard fields

NameTypeDescription
boardBoardBoard after mutation.
errors[String!]!Errors encountered during the mutation.

updateBoardEpicUserPreferences

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: UpdateBoardEpicUserPreferencesInput

updateBoardEpicUserPreferences arguments

NameTypeDescription
boardIdBoardID!Board global ID.
collapsedBoolean!Whether the epic should be collapsed in the board.
epicIdEpicID!ID of an epic to set preferences for.

updateBoardEpicUserPreferences fields

NameTypeDescription
epicUserPreferencesBoardEpicUserPreferencesUser preferences for the epic in the board after mutation.
errors[String!]!Errors encountered during the mutation.

updateBoardList

Input type: UpdateBoardListInput

updateBoardList arguments

NameTypeDescription
collapsedBooleanIndicates if the list is collapsed for the user.
listIdListID!Global ID of the list.
positionIntPosition of list within the board.

updateBoardList fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
listBoardListMutated list.

updateComplianceFramework

Input type: UpdateComplianceFrameworkInput

updateComplianceFramework arguments

NameTypeDescription
idComplianceManagementFrameworkID!Global ID of the compliance framework to update.
paramsComplianceFrameworkInput!Parameters to update the compliance framework with.

updateComplianceFramework fields

NameTypeDescription
complianceFrameworkComplianceFrameworkCompliance framework after mutation.
errors[String!]!Errors encountered during the mutation.

updateComplianceRequirement

  • Status: Experiment

Input type: UpdateComplianceRequirementInput

updateComplianceRequirement arguments

NameTypeDescription
controls[ComplianceRequirementsControlInput!]Controls to add or update to the compliance requirement.
idComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement to update.
paramsComplianceRequirementInput!Parameters to update the compliance requirement with.

updateComplianceRequirement fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
requirementComplianceRequirementCompliance requirement after updation.

updateComplianceRequirementsControl

  • Status: Experiment

Input type: UpdateComplianceRequirementsControlInput

updateComplianceRequirementsControl arguments

NameTypeDescription
idComplianceManagementComplianceFrameworkComplianceRequirementsControlID!Global ID of the compliance requirement control to update.
paramsComplianceRequirementsControlInput!Parameters to update the compliance requirement control with.

updateComplianceRequirementsControl fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
requirementsControlComplianceRequirementsControlCompliance requirement control after updation.

updateContainerExpirationPolicy

Input type: UpdateContainerExpirationPolicyInput

updateContainerExpirationPolicy arguments

NameTypeDescription
cadenceContainerExpirationPolicyCadenceEnumSchedule of the container expiration policy.
enabledBooleanIndicates whether the container expiration policy is enabled.
keepNContainerExpirationPolicyKeepEnumNumber of tags to retain.
nameRegexUntrustedRegexpTags with names matching the regex pattern will expire.
nameRegexKeepUntrustedRegexpTags with names matching the regex pattern will be preserved.
olderThanContainerExpirationPolicyOlderThanEnumTags older than the given age will expire.
projectPathID!Project path where the container expiration policy is located.

updateContainerExpirationPolicy fields

NameTypeDescription
containerExpirationPolicyContainerExpirationPolicyDeprecated in GitLab 17.5. Use container_tags_expiration_policy.
containerTagsExpirationPolicyContainerTagsExpirationPolicyContainer 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

NameTypeDescription
idContainerRegistryProtectionRuleID!Global ID of the container repository protection rule to be updated.
minimumAccessLevelForDeleteContainerProtectionRepositoryRuleAccessLevelIntroduced 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.
minimumAccessLevelForPushContainerProtectionRepositoryRuleAccessLevelMinimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
repositoryPathPatternStringContainer repository path pattern protected by the protection rule. Must start with the project’s full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project’s full path.

updateContainerProtectionRepositoryRule fields

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

NameTypeDescription
idContainerRegistryProtectionTagRuleID!Global ID of the tag protection rule to update.
minimumAccessLevelForDeleteContainerProtectionTagRuleAccessLevelMinimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags.
minimumAccessLevelForPushContainerProtectionTagRuleAccessLevelMinimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags.
tagNamePatternStringThe pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.

updateContainerProtectionTagRule fields

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

NameTypeDescription
configCustomDashboardConfigInputDashboard layout/config.
descriptionStringDashboard description.
idAnalyticsCustomDashboardsDashboardID!Global ID of the dashboard to update.
nameStringDashboard name.

updateCustomDashboard fields

NameTypeDescription
dashboardCustomDashboardUpdated dashboard.
errors[String!]!Errors encountered during update.

updateDependencyProxyImageTtlGroupPolicy

These settings can be adjusted only by the group Owner.

Input type: UpdateDependencyProxyImageTtlGroupPolicyInput

updateDependencyProxyImageTtlGroupPolicy arguments

NameTypeDescription
enabledBooleanIndicates whether the policy is enabled or disabled.
groupPathID!Group path for the group dependency proxy image TTL policy.
ttlIntNumber of days to retain a cached image file.

updateDependencyProxyImageTtlGroupPolicy fields

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

NameTypeDescription
enabledBooleanIndicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryPasswordStringPassword for the external Maven packages registry. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time.
mavenExternalRegistryUrlStringURL for the external Maven packages registry.
mavenExternalRegistryUsernameStringUsername for the external Maven packages registry.
projectPathID!Project path for the dependency proxy for packages settings.

updateDependencyProxyPackagesSettings fields

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

NameTypeDescription
enabledBooleanIndicates whether the policy is enabled or disabled.
groupPathID!Group path for the group dependency proxy.
identityStringIdentity credential used to authenticate with Docker Hub when pulling images. Can be a username (for password or personal access token (PAT)) or organization name (for organization access token (OAT)).
secretStringSecret credential used to authenticate with Docker Hub when pulling images. Can be a password, personal access token (PAT), or organization access token (OAT).

updateDependencyProxySettings fields

NameTypeDescription
dependencyProxySettingDependencyProxySettingGroup dependency proxy settings after mutation.
errors[String!]!Errors encountered during the mutation.

updateDuoWorkflowAgentPrivileges

  • Status: Experiment

Input type: UpdateDuoWorkflowAgentPrivilegesInput

updateDuoWorkflowAgentPrivileges arguments

NameTypeDescription
agentPrivileges[Int!]Replaces the set of actions the agent is allowed to perform.
preApprovedAgentPrivileges[Int!]Replaces the set of actions the agent can perform without asking for approval.
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to update.

updateDuoWorkflowAgentPrivileges fields

NameTypeDescription
errors[String!]!Errors encountered during update.
workflowDuoWorkflowUpdated workflow.

updateDuoWorkflowToolCallApprovals

  • Status: Experiment

Input type: UpdateDuoWorkflowToolCallApprovalsInput

updateDuoWorkflowToolCallApprovals arguments

NameTypeDescription
approvalSourceDuoWorkflowToolCallApprovalSourceIntroduced as an experiment in GitLab 19.3.

Source of the approval decision, for audit purposes.
patternStringGlob pattern to approve for matching tool call arguments.
toolCallArgsJSONArguments for the tool call.
toolNameString!Name of the tool to approve.
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to update.

updateDuoWorkflowToolCallApprovals fields

NameTypeDescription
errors[String!]!Errors encountered during update.
workflowDuoWorkflowUpdated workflow with new tool approvals.

updateDuoWorkflowWebSearch

  • Status: Experiment

Input type: UpdateDuoWorkflowWebSearchInput

updateDuoWorkflowWebSearch arguments

NameTypeDescription
webSearchEnabledBoolean!Whether web search should be enabled for the session.
workflowIdAiDuoWorkflowsWorkflowID!Global ID of the workflow to update.

updateDuoWorkflowWebSearch fields

NameTypeDescription
errors[String!]!Errors encountered during update.
workflowDuoWorkflowUpdated workflow.

updateEpic

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

Input type: UpdateEpicInput

updateEpic arguments

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

updateEpic fields

NameTypeDescription
epicEpicEpic after mutation.
errors[String!]!Errors encountered during the mutation.

updateEpicBoardList

Deprecated in GitLab 17.5. Replaced by WorkItem type.

Input type: UpdateEpicBoardListInput

updateEpicBoardList arguments

NameTypeDescription
collapsedBooleanIndicates if the list is collapsed for the user.
listIdBoardsEpicListID!Global ID of the epic list.
positionIntPosition of list within the board.

updateEpicBoardList fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
listEpicListMutated 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

NameTypeDescription
bodyStringContent of the note.
idNoteID!Global ID of the note to update.
positionUpdateDiffImagePositionInputPosition of the note on a diff.

updateImageDiffNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

updateIssue

Input type: UpdateIssueInput

updateIssue arguments

NameTypeDescription
addLabelIds[ID!]IDs of labels to be added to the issue.
confidentialBooleanIndicates the issue is confidential.
descriptionStringDescription of the issue.
dueDateISO8601DateDue date of the issue.
epicIdEpicIDDeprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget.
healthStatusHealthStatusDesired health status.
iidString!IID of the issue to mutate.
labelIds[ID!]IDs of labels to be set. Replaces existing issue labels.
lockedBooleanIndicates discussion is locked on the issue.
milestoneIdIDID of the milestone to assign to the issue. Accepts either a global ID, for example "gid://gitlab/Milestone/42", or a numeric ID, for example "42". On update milestone will be removed if set to null.
projectPathID!Project the issue to mutate is in.
removeLabelIds[ID!]IDs of labels to be removed from the issue.
stateEventIssueStateEventClose or reopen an issue.
timeEstimateStringEstimated time to complete the issue. Use null or 0 to remove the current estimate.
titleStringTitle of the issue.
typeIssueTypeType of the issue.
weightIntWeight of the issue.

updateIssue fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue after mutation.

updateIteration

Input type: UpdateIterationInput

updateIteration arguments

NameTypeDescription
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathID!Group of the iteration.
idID!Global ID of the iteration.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

updateIteration fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
iterationIterationUpdated iteration.

updateNamespacePackageSettings

These settings can be adjusted only by the group Owner.

Input type: UpdateNamespacePackageSettingsInput

updateNamespacePackageSettings arguments

NameTypeDescription
auditEventsEnabledBooleanIndicates whether audit events are created when publishing or deleting a package in the namespace (Premium and Ultimate only).
genericDuplicateExceptionRegexUntrustedRegexpWhen generic_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When generic_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
genericDuplicatesAllowedBooleanIndicates whether duplicate generic packages are allowed for the namespace.
lockMavenPackageRequestsForwardingBooleanIndicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwardingBooleanIndicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwardingBooleanIndicates whether PyPI package forwarding is locked for all descendent namespaces.
lockRubygemsPackageRequestsForwardingBooleanIndicates whether RubyGems package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegexUntrustedRegexpWhen maven_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When maven_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
mavenDuplicatesAllowedBooleanIndicates whether duplicate Maven packages are allowed for the namespace.
mavenPackageRequestsForwardingBooleanIndicates whether Maven package forwarding is allowed for the namespace.
namespacePathID!Namespace path where the namespace package setting is located.
npmPackageRequestsForwardingBooleanIndicates whether npm package forwarding is allowed for the namespace.
nugetDuplicateExceptionRegexUntrustedRegexpWhen nuget_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When nuget_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
nugetDuplicatesAllowedBooleanIndicates whether duplicate NuGet packages are allowed for the namespace.
nugetSymbolServerEnabledBooleanIndicates whether the NuGet symbol server is enabled for the namespace.
pypiPackageRequestsForwardingBooleanIndicates whether PyPI package forwarding is allowed for the namespace.
rubygemsPackageRequestsForwardingBooleanIndicates whether RubyGems package forwarding is allowed for the namespace.
terraformModuleDuplicateExceptionRegexUntrustedRegexpWhen terraform_module_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. When terraform_module_duplicates_allowed is true, duplicate packages with names that match this regex are rejected.
terraformModuleDuplicatesAllowedBooleanIndicates whether duplicate Terraform packages are allowed for the namespace.

updateNamespacePackageSettings fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
packageSettingsPackageSettingsNamespace 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

NameTypeDescription
bodyStringContent of the note.
idNoteID!Global ID of the note to update.

updateNote fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

updatePackagesCleanupPolicy

Input type: UpdatePackagesCleanupPolicyInput

updatePackagesCleanupPolicy arguments

NameTypeDescription
keepNDuplicatedPackageFilesPackagesCleanupKeepDuplicatedPackageFilesEnumNumber of duplicated package files to retain.
projectPathID!Project path where the packages cleanup policy is located.

updatePackagesCleanupPolicy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
packagesCleanupPolicyPackagesCleanupPolicyPackages 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

NameTypeDescription
idPackagesProtectionRuleID!Global ID of the package protection rule to be updated.
minimumAccessLevelForDeletePackagesProtectionRuleAccessLevelForDeleteIntroduced 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.
minimumAccessLevelForPushPackagesProtectionRuleAccessLevelMinimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
packageNamePatternStringPackage name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageTypePackagesProtectionRulePackageTypePackage type protected by the protection rule. For example, NPM, PYPI.

updatePackagesProtectionRule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule after mutation.

updateProjectComplianceViolation

  • Status: Experiment

Input type: UpdateProjectComplianceViolationInput

updateProjectComplianceViolation arguments

NameTypeDescription
idComplianceManagementProjectsComplianceViolationID!Global ID of the project compliance violation to update.
statusComplianceViolationStatus!New status for the project compliance violation.

updateProjectComplianceViolation fields

NameTypeDescription
complianceViolationProjectComplianceViolationCompliance violation after status update.
errors[String!]!Errors encountered during the mutation.

updateRequirement

Input type: UpdateRequirementInput

updateRequirement arguments

NameTypeDescription
descriptionStringDescription of the requirement.
iidStringDeprecated in GitLab 15.8. Use work_item_iid instead.
lastTestReportStateTestReportStateCreates a test report for the requirement with the given state.
projectPathID!Full project path the requirement is associated with.
stateRequirementStateState of the requirement.
titleStringTitle of the requirement.
workItemIidStringIID of the requirement work item to update.

updateRequirement fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
requirementRequirementRequirement after mutation.

updateSnippet

Input type: UpdateSnippetInput

updateSnippet arguments

NameTypeDescription
blobActions[SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs.
descriptionStringDescription of the snippet.
idSnippetID!Global ID of the snippet to update.
titleStringTitle of the snippet.
visibilityLevelVisibilityLevelsEnumVisibility level of the snippet.

updateSnippet fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
snippetSnippetSnippet after mutation.

updateTerraformStateProtectionRule

  • Status: Experiment

Updates a protection rule for a Terraform state backend.

Input type: UpdateTerraformStateProtectionRuleInput

updateTerraformStateProtectionRule arguments

NameTypeDescription
allowedFromTerraformStateProtectionRuleAllowedFromIntroduced 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.
idTerraformStateProtectionRuleID!Global ID of the Terraform state protection rule to update.
minimumAccessLevelForWriteTerraformStateProtectionRuleAccessLevelIntroduced 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.
stateNameStringIntroduced as an experiment in GitLab 18.11.

Terraform state name protected by the rule.

updateTerraformStateProtectionRule fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
terraformStateProtectionRuleTerraformStateProtectionRuleIntroduced 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

NameTypeDescription
enabledBooleanEnable or disable the virtual registries.
fullPathID!Group path for the group virtual registries.

updateVirtualRegistriesSetting fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
virtualRegistriesSettingVirtualRegistriesSettingVirtual 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

NameTypeDescription
fileUpload!File to upload.
groupPathIDFull path of the group with which the resource is associated.
projectPathIDFull path of the project with which the resource is associated.

uploadCreate fields

NameTypeDescription
altStringAlt text for the uploaded file. Usually the name of the file.
errors[String!]!Errors encountered during the mutation.
fullPathStringFull path to the file.
markdownStringMarkdown-formatted link to the file.
uploadFileUploadUploaded file.
urlStringURL to access the file.

uploadDelete

Deletes an upload.

Input type: UploadDeleteInput

uploadDelete arguments

NameTypeDescription
filenameString!Upload filename.
groupPathIDFull path of the group with which the resource is associated.
projectPathIDFull path of the project with which the resource is associated.
secretString!Secret part of upload path.

uploadDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
uploadFileUploadDeleted upload.

upsertFlatUserCap

Update the flat per-user budget cap for a subscription.

Input type: UpsertFlatUserCapInput

upsertFlatUserCap arguments

NameTypeDescription
flatUserCapFloat!Default per-user budget cap applied to all users.
flatUserCapEnabledBoolean!Whether the flat per-user budget cap is enabled.
namespacePathStringPath of the top-level group namespace. Omit for self-managed instance scope.

upsertFlatUserCap fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
flatUserCapFloatUpdated flat per-user budget cap.
flatUserCapEnabledBooleanWhether the flat per-user budget cap is enabled.

upsertUserBudgetCapOverrides

Bulk upsert per-user budget cap overrides.

Input type: UpsertUserBudgetCapOverridesInput

upsertUserBudgetCapOverrides arguments

NameTypeDescription
namespacePathStringPath of the top-level group namespace. Omit for self-managed instance scope.
overrides[BudgetCapUserOverrideInput!]!List of per-user budget cap overrides to upsert.

upsertUserBudgetCapOverrides fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userOverrides[GitlabSubscriptionBudgetCapUserOverride!]Updated user budget cap overrides.

userAchievementPrioritiesUpdate

Input type: UserAchievementPrioritiesUpdateInput

userAchievementPrioritiesUpdate arguments

NameTypeDescription
userAchievementIds[AchievementsUserAchievementID!]!Global IDs of the user achievements being prioritized, ordered from highest to lowest priority.

userAchievementPrioritiesUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userAchievements[UserAchievement!]!Updated user achievements.

userAchievementsDelete

Input type: UserAchievementsDeleteInput

userAchievementsDelete arguments

NameTypeDescription
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being deleted.

userAchievementsDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userAchievementUserAchievementDeleted user achievement.

userAchievementsUpdate

Input type: UserAchievementsUpdateInput

userAchievementsUpdate arguments

NameTypeDescription
awardMessageStringMessage to associate with the awarded achievement.
showOnProfileBooleanIndicates whether or not the user achievement is visible on the profile.
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being updated.

userAchievementsUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userAchievementUserAchievementAchievement award.

userAddOnAssignmentBulkCreate

Input type: UserAddOnAssignmentBulkCreateInput

userAddOnAssignmentBulkCreate arguments

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be assigned to.
userIds[UserID!]!Global IDs of user to be assigned.

userAddOnAssignmentBulkCreate fields

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
errors[String!]!Errors encountered during the mutation.
usersAddOnUserConnectionUsers who the add-on purchase was assigned to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

userAddOnAssignmentBulkRemove

Input type: UserAddOnAssignmentBulkRemoveInput

userAddOnAssignmentBulkRemove arguments

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be unassigned from.
userIds[UserID!]!Global IDs of user to be unassigned.

userAddOnAssignmentBulkRemove fields

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
errors[String!]!Errors encountered during the mutation.
usersAddOnUserConnectionUsers who was unassigned from the add-on purchase. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

userAddOnAssignmentCreate

Input type: UserAddOnAssignmentCreateInput

userAddOnAssignmentCreate arguments

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be assigned to.
userIdUserID!Global ID of user to be assigned.

userAddOnAssignmentCreate fields

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
errors[String!]!Errors encountered during the mutation.
userAddOnUserUser who the add-on purchase was assigned to.

userAddOnAssignmentRemove

Input type: UserAddOnAssignmentRemoveInput

userAddOnAssignmentRemove arguments

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase assignment belongs to.
userIdUserID!Global ID of user whose assignment will be removed.

userAddOnAssignmentRemove fields

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
errors[String!]!Errors encountered during the mutation.
userAddOnUserUser that the add-on was removed from.

userCalloutCreate

Input type: UserCalloutCreateInput

userCalloutCreate arguments

NameTypeDescription
featureNameString!Feature name you want to dismiss the callout for.

userCalloutCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userCalloutUserCallout!User callout dismissed.

userCustomAttributeSet

  • Status: Experiment

Creates or updates a custom attribute on a user. Only available to admins.

Input type: UserCustomAttributeSetInput

userCustomAttributeSet arguments

NameTypeDescription
keyString!Key of the custom attribute.
userIdUserID!Global ID of the user.
valueString!Value of the custom attribute.

userCustomAttributeSet fields

NameTypeDescription
customAttributeCustomAttributeCustom attribute after mutation.
errors[String!]!Errors encountered during the mutation.

userGroupCalloutCreate

Input type: UserGroupCalloutCreateInput

userGroupCalloutCreate arguments

NameTypeDescription
featureNameString!Feature name you want to dismiss the callout for.
groupIdGroupID!Group for the callout.

userGroupCalloutCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userGroupCalloutUserGroupCallout!User group callout dismissed.

userPreferencesUpdate

Input type: UserPreferencesUpdateInput

userPreferencesUpdate arguments

NameTypeDescription
duoDefaultNamespaceIdIntDefault namespace context for Duo features when namespace can not be inferred.
emojiSkinToneEmojiSkinToneIntroduced as an experiment in GitLab 19.6.

Default skin tone for emoji that have skin tone variants.
extensionsMarketplaceOptInStatusExtensionsMarketplaceOptInStatusStatus of the Web IDE Extension Marketplace opt-in for the user.
firstDayOfWeekUserFirstDayOfWeekFirst day of the week in calendars and date pickers. Set to null to use the instance default.
issuesSortIssueSortSort order for issue lists.
knowledgeGraphGoverningNamespaceIdIntGoverning and billing namespace for Orbit.
mergeRequestDashboardListTypeMergeRequestsDashboardListTypeMerge request dashboard list rendering type.
mergeRequestDashboardShowDraftsBooleanShow draft merge requests on the merge request dashboard.
mergeRequestsSortMergeRequestSortSort order for issue lists.
orbitSettingsJSONIntroduced as an experiment in GitLab 19.0.

Orbit agent settings, e.g.: “{ enabled: false }”.
organizationGroupsProjectsDisplayOrganizationGroupProjectDisplayIntroduced as an experiment in GitLab 17.2.

Default list view for organization groups and projects.
organizationGroupsProjectsSortOrganizationGroupProjectSortIntroduced as an experiment in GitLab 17.2.

Sort order for organization groups and projects.
projectsSortProjectSortSort order for projects.
sidebarNavigationModeSidebarNavigationModeIntroduced 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.
useWorkItemsViewBooleanDeprecated in GitLab 19.5. Work item view is always used.
visibilityPipelineIdTypeVisibilityPipelineIdTypeDetermines whether the pipeline list shows ID or IID.
wikiUseAutoCommitMessageBooleanIntroduced as an experiment in GitLab 18.10.

Whether to skip the commit message modal and use the auto-generated commit message when saving changes to a wiki document.
workItemsDisplaySettingsJSONIntroduced as an experiment in GitLab 18.1.

Display settings for the work item lists, e.g.: “{ shouldOpenItemsInSidePanel: false }”.

userPreferencesUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userPreferencesUserPreferencesUser preferences after mutation.

userSetNamespaceCommitEmail

Input type: UserSetNamespaceCommitEmailInput

userSetNamespaceCommitEmail arguments

NameTypeDescription
emailIdEmailIDID of the email to set.
namespaceIdNamespaceID!ID of the namespace to set the namespace commit email for.

userSetNamespaceCommitEmail fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceCommitEmailNamespaceCommitEmailUser namespace commit email after mutation.

valueStreamCreate

  • Status: Experiment

Creates a value stream.

Input type: ValueStreamCreateInput

valueStreamCreate arguments

NameTypeDescription
nameString!Value stream name.
namespacePathID!Full path of the namespace(project or group) the value stream is created in.
settingValueStreamSettingInputValue stream configuration.
stages[CreateValueStreamStageInput!]Value stream stages.

valueStreamCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
valueStreamValueStreamCreated value stream.

valueStreamDestroy

  • Status: Experiment

Destroy a value stream.

Input type: ValueStreamDestroyInput

valueStreamDestroy arguments

NameTypeDescription
idAnalyticsCycleAnalyticsValueStreamID!Global ID of the value stream to destroy.

valueStreamDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
valueStreamValueStreamValue stream deleted after mutation.

valueStreamUpdate

  • Status: Experiment

Updates a value stream.

Input type: ValueStreamUpdateInput

valueStreamUpdate arguments

NameTypeDescription
idAnalyticsCycleAnalyticsValueStreamID!Global ID of the value stream to update.
nameStringValue stream name.
settingValueStreamSettingInputValue stream configuration.
stages[UpdateValueStreamStageInput!]Value stream stages.

valueStreamUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
valueStreamValueStreamUpdated value stream.

verifiedNamespaceCreate

Create a verified namespace and mark all child catalog resources with the passed verification level info.

Input type: VerifiedNamespaceCreateInput

verifiedNamespaceCreate arguments

NameTypeDescription
namespacePathID!Root namespace path.
verificationLevelCiCatalogResourceVerificationLevel!Verification level for a root namespace.

verifiedNamespaceCreate fields

NameTypeDescription
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

NameTypeDescription
cadenceIntJob cadence for the cleanup process. Allowed values are 1, 7, 14, 30, 90. Default is 7.
enabledBooleanEnable or disable the virtual registries cleanup policy. Default is false.
fullPathID!Group path for the group virtual registries.
keepNDaysAfterDownloadIntKeep packages for the period after download. Range is 1-365. Default is 30.
notifyOnFailureBooleanWhether to notify group owners when cleanup runs fail. Default is false.
notifyOnSuccessBooleanWhether to notify group owners when cleanup runs succeed. Default is false.

virtualRegistriesCleanupPolicyUpsert fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
virtualRegistriesCleanupPolicyVirtualRegistryCleanupPolicyVirtual registries cleanup policy after mutation.

vulnerabilitiesArchive

  • Status: Experiment

Input type: VulnerabilitiesArchiveInput

vulnerabilitiesArchive arguments

NameTypeDescription
dateDate!Last update date of vulnerabilities being archived.
projectIdProjectID!ID of the project to attach the vulnerability to.

vulnerabilitiesArchive fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
statusString!Status of the action.

vulnerabilitiesCreateIssue

  • Status: Experiment

Input type: VulnerabilitiesCreateIssueInput

vulnerabilitiesCreateIssue arguments

NameTypeDescription
projectProjectID!ID of the project to attach the issue to.
vulnerabilityIds[VulnerabilityID!]!IDs of vulnerabilities to link to the given issue. Up to 100 can be provided.

vulnerabilitiesCreateIssue fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
issueIssueIssue created after mutation.

vulnerabilitiesDismiss

Input type: VulnerabilitiesDismissInput

vulnerabilitiesDismiss arguments

NameTypeDescription
commentStringComment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReasonVulnerabilityDismissalReasonReason why vulnerability should be dismissed.
vulnerabilityIds[VulnerabilityID!]!IDs of the vulnerabilities to be dismissed (maximum 100 entries).

vulnerabilitiesDismiss fields

NameTypeDescription
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

NameTypeDescription
projectIds[ProjectID!]!IDs of project for which all Vulnerabilities should be removed. The deletion will happen in the background so the changes will not be visible immediately.
resolvedOnDefaultBranchBooleanWhen set as true, deletes only the vulnerabilities no longer detected. When set as false, deletes only the vulnerabilities still detected.

vulnerabilitiesRemoveAllFromProject fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
projects[Project!]!Projects for which the deletion was scheduled.

vulnerabilitiesSeverityOverride

Input type: vulnerabilitiesSeverityOverrideInput

vulnerabilitiesSeverityOverride arguments

NameTypeDescription
commentString!Comment why vulnerability severity was changed (maximum 50,000 characters).
severityVulnerabilitySeverity!New severity value for the severities.
vulnerabilityIds[VulnerabilityID!]!IDs of the vulnerabilities for which severity needs to be changed (maximum 100 entries).

vulnerabilitiesSeverityOverride fields

NameTypeDescription
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

NameTypeDescription
vulnerabilityIdVulnerabilityID!ID of the vulnerability to remediate.

vulnerabilityAutoRemediation fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
statusVulnerabilityAutoRemediationStatusOutcome of triggering auto-remediation.

vulnerabilityConfirm

Input type: VulnerabilityConfirmInput

vulnerabilityConfirm arguments

NameTypeDescription
commentStringComment why vulnerability was confirmed (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be confirmed.

vulnerabilityConfirm fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

vulnerabilityCreate

Input type: VulnerabilityCreateInput

vulnerabilityCreate arguments

NameTypeDescriptionDefault
confirmedAtTimeTimestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is confirmed).
descriptionString!Long text section that describes the vulnerability in more detail.
detectedAtTimeTimestamp of when the vulnerability was first detected (defaults to creation time).
dismissedAtTimeTimestamp of when the vulnerability state changed to dismissed (defaults to creation time if status is dismissed).
identifiers[VulnerabilityIdentifierInput!]!Array of CVE or CWE identifiers for the vulnerability.
nameString!Name of the vulnerability.
projectProjectID!ID of the project to attach the vulnerability to.
projectTrackedContextProjectTrackedContextInputTracked context to associate with the vulnerability.
resolvedAtTimeTimestamp of when the vulnerability state changed to resolved (defaults to creation time if status is resolved).
scannerVulnerabilityScannerInput!Information about the scanner used to discover the vulnerability.
severityVulnerabilitySeveritySeverity of the vulnerability (defaults to unknown).UNKNOWN
solutionStringInstructions for how to fix the vulnerability.
stateVulnerabilityStateState of the vulnerability (defaults to detected).DETECTED

vulnerabilityCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability created.

vulnerabilityDismiss

Input type: VulnerabilityDismissInput

vulnerabilityDismiss arguments

NameTypeDescription
commentStringComment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReasonVulnerabilityDismissalReasonReason why vulnerability should be dismissed.
idVulnerabilityID!ID of the vulnerability to be dismissed.

vulnerabilityDismiss fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

vulnerabilityDismissFalsePositiveFlag

  • Status: Experiment

Dismiss a vulnerability false positive flag.

Input type: VulnerabilityDismissFalsePositiveFlagInput

vulnerabilityDismissFalsePositiveFlag arguments

NameTypeDescription
idVulnerabilityID!ID of the vulnerability to dismiss false positive flag for.

vulnerabilityDismissFalsePositiveFlag fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after dismissing false positive flag.

vulnerabilityExternalIssueLinkCreate

Input type: VulnerabilityExternalIssueLinkCreateInput

vulnerabilityExternalIssueLinkCreate arguments

NameTypeDescription
externalTrackerVulnerabilityExternalIssueLinkExternalTracker!External tracker type of the external issue link.
idVulnerabilityID!ID of the vulnerability.
linkTypeVulnerabilityExternalIssueLinkType!Type of the external issue link.

vulnerabilityExternalIssueLinkCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
externalIssueLinkVulnerabilityExternalIssueLinkCreated external issue link.

vulnerabilityExternalIssueLinkDestroy

Input type: VulnerabilityExternalIssueLinkDestroyInput

vulnerabilityExternalIssueLinkDestroy arguments

NameTypeDescription
idVulnerabilitiesExternalIssueLinkID!Global ID of the vulnerability external issue link.

vulnerabilityExternalIssueLinkDestroy fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.

vulnerabilityIssueLinkCreate

Input type: VulnerabilityIssueLinkCreateInput

vulnerabilityIssueLinkCreate arguments

NameTypeDescription
issueIdIssueID!ID of the issue to link to.
vulnerabilityIds[VulnerabilityID!]!IDs of vulnerabilities to link to the given issue. Up to 100 can be provided.

vulnerabilityIssueLinkCreate fields

NameTypeDescription
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

NameTypeDescription
mergeRequestIdMergeRequestID!ID of the merge request.
readinessScoreFloatConfidence rating representing the estimated accuracy of the fix in the AI generated merge request. Decimal value between 0 and 1, with 1 being the highest.
vulnerabilityIdVulnerabilityID!ID of the vulnerability.

vulnerabilityLinkMergeRequest fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityUpdated vulnerability.

vulnerabilityResolve

Input type: VulnerabilityResolveInput

vulnerabilityResolve arguments

NameTypeDescription
commentStringComment why vulnerability was resolved (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be resolved.

vulnerabilityResolve fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

vulnerabilityRevertToDetected

Input type: VulnerabilityRevertToDetectedInput

vulnerabilityRevertToDetected arguments

NameTypeDescription
commentStringComment why vulnerability was reverted to detected (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be reverted to detected.

vulnerabilityRevertToDetected fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

vulnerabilityUnlinkMergeRequest

  • Status: Experiment

Unlink a merge request from a vulnerability.

Input type: VulnerabilityUnlinkMergeRequestInput

vulnerabilityUnlinkMergeRequest arguments

NameTypeDescription
mergeRequestIdMergeRequestID!ID of the merge request.
vulnerabilityIdVulnerabilityID!ID of the vulnerability.

vulnerabilityUnlinkMergeRequest fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
vulnerabilityVulnerabilityUpdated vulnerability.

wikiPageSubscribe

  • Status: Experiment

Input type: WikiPageSubscribeInput

wikiPageSubscribe arguments

NameTypeDescription
idWikiPageMetaID!Global ID of the wiki page meta record.
subscribedBoolean!Desired state of the subscription.

wikiPageSubscribe fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
wikiPageWikiPageWiki page after mutation.

workItemAddClosingMergeRequest

  • Status: Experiment

Adds a closing merge request to a work item.

Input type: WorkItemAddClosingMergeRequestInput

workItemAddClosingMergeRequest arguments

NameTypeDescription
contextNamespacePathIDFull path of the context namespace (project or group). Only project full paths are used to find a merge request using a short reference syntax like !1. Ignored for full references and URLs. Defaults to the namespace of the work item if not provided.
idWorkItemID!Global ID of the work item.
mergeRequestReferenceString!Merge request reference (short, full or URL). Example: !1, project_full_path!1 or https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1.

workItemAddClosingMergeRequest fields

NameTypeDescription
closingMergeRequestWorkItemClosingMergeRequestClosing merge request added to the work item.
errors[String!]!Errors encountered during the mutation.
workItemWorkItemWork item with new closing merge requests.

workItemAddLinkedItems

  • Status: Experiment

Add linked items to the work item.

Input type: WorkItemAddLinkedItemsInput

workItemAddLinkedItems arguments

NameTypeDescription
idWorkItemID!Global ID of the work item.
linkTypeWorkItemRelatedLinkTypeType of link. Defaults to RELATED.
workItemsIds[WorkItemID!]!Global IDs of the items to link. Maximum number of IDs you can provide: 10.

workItemAddLinkedItems fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
messageStringLinked items update result message.
workItemWorkItemUpdated work item.

workItemAvailabilityToggle

  • Status: Experiment

Enables or disables a work item type for a namespace.

Input type: WorkItemAvailabilityToggleInput

workItemAvailabilityToggle arguments

NameTypeDescription
actionWorkItemAvailabilityAction!Whether to enable or disable the work item type.
fullPathID!Full path of the group or project.
scopeWorkItemAvailabilityScope!Whether to apply to the namespace or propagate to all existing children.
workItemTypeIdWorkItemsTypeID!Global ID of the work item type.

workItemAvailabilityToggle fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemTypeWorkItemTypeWork item type after the availability change.

workItemBulkMove

  • Status: Experiment

Moves work items between projects or groups.

Input type: WorkItemBulkMoveInput

workItemBulkMove arguments

NameTypeDescription
ids[WorkItemID!]!Global ID array of the work items that will be moved. IDs that the user can’t move will be ignored. A max of 100 can be provided.
sourceFullPathString!Full path of the source namespace. For example, gitlab-org/gitlab-foss.
targetFullPathString!Full path of the target namespace. For example, gitlab-org/gitlab-foss. User paths are not supported.

workItemBulkMove fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
movedWorkItemCountIntNumber 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

NameTypeDescription
assigneesWidgetWorkItemWidgetAssigneesInputIntroduced as an experiment in GitLab 18.2.

Input for assignees widget.
confidentialBooleanIntroduced as an experiment in GitLab 18.2.

Sets the work item confidentiality.
fullPathID!Full path of the project or group containing the work items that will be updated. User paths are not supported.
healthStatusWidgetWorkItemWidgetHealthStatusInputIntroduced as an experiment in GitLab 18.2.

Input for health status widget.
hierarchyWidgetWorkItemWidgetHierarchyCreateInputIntroduced 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.
iterationWidgetWorkItemWidgetIterationInputIntroduced as an experiment in GitLab 18.2.

Input for iteration widget.
labelsWidgetWorkItemWidgetLabelsUpdateInputInput for labels widget.
milestoneWidgetWorkItemWidgetMilestoneInputIntroduced as an experiment in GitLab 18.2.

Input for milestone widget.
stateEventWorkItemStateEventIntroduced as an experiment in GitLab 18.2.

Close or reopen multiple work items at once.
statusWidgetWorkItemWidgetStatusInputIntroduced as an experiment in GitLab 18.3.

Input for status widget.
subscriptionEventWorkItemSubscriptionEventIntroduced as an experiment in GitLab 18.2.

Subscribe or unsubscribe from the work items.

workItemBulkUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
updatedWorkItemCountIntNumber of work items that were successfully updated.

workItemConvert

  • Status: Experiment

Converts the work item to a new type.

Input type: WorkItemConvertInput

workItemConvert arguments

NameTypeDescription
idWorkItemID!Global ID of the work item.
workItemTypeIdWorkItemsTypeID!Global ID of the new work item type.

workItemConvert fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemWorkItemUpdated work item.

workItemCreate

  • Status: Experiment

Creates a work item.

Input type: WorkItemCreateInput

workItemCreate arguments

NameTypeDescription
agentPlanWidgetWorkItemWidgetAgentPlanInputIntroduced as an experiment in GitLab 19.0.

Input for agent plan widget.
assigneesWidgetWorkItemWidgetAssigneesInputInput for assignees widget.
colorWidgetWorkItemWidgetColorInputInput for color widget.
confidentialBooleanSets the work item confidentiality.
createSourceStringSource which triggered the creation of the work item. Used only for tracking purposes.
createdAtTimeTimestamp when the work item was created. Available only for admins and project owners.
crmContactsWidgetWorkItemWidgetCrmContactsCreateInputInput for CRM contacts widget.
customFieldsWidget[WorkItemWidgetCustomFieldValueInputType!]Introduced as an experiment in GitLab 17.10.

Input for custom fields widget.
descriptionStringDeprecated in GitLab 16.9. use description widget instead.
descriptionWidgetWorkItemWidgetDescriptionInputInput for description widget.
developmentWidgetWorkItemWidgetDevelopmentCreateInputInput for development widget.
discussionsToResolveWorkItemResolveDiscussionsInputInformation required to resolve discussions in a noteable, when the work item is created.
healthStatusWidgetWorkItemWidgetHealthStatusInputInput for health status widget.
hierarchyWidgetWorkItemWidgetHierarchyCreateInputInput for hierarchy widget.
iterationWidgetWorkItemWidgetIterationInputIteration widget of the work item.
labelsWidgetWorkItemWidgetLabelsCreateInputInput for labels widget.
linkedItemsWidgetWorkItemWidgetLinkedItemsCreateInputInput for linked items widget.
milestoneWidgetWorkItemWidgetMilestoneInputInput for milestone widget.
namespacePathIDFull path of the namespace(project or group) the work item is created in.
projectPathIDDeprecated in GitLab 15.10. Please use namespacePath instead. That will cover for both projects and groups.
startAndDueDateWidgetWorkItemWidgetStartAndDueDateUpdateInputInput for start and due date widget.
statusWidgetWorkItemWidgetStatusInputIntroduced as an experiment in GitLab 17.11.

Input for status widget.
titleString!Title of the work item.
vulnerabilityIdVulnerabilityIDIntroduced as an experiment in GitLab 17.9.

Input for linking an existing vulnerability to created work item.
weightWidgetWorkItemWidgetWeightInputInput for weight widget.
workItemTypeIdWorkItemsTypeID!Global ID of a work item type.

workItemCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemWorkItemCreated work item.

workItemCreateFromTask

  • Status: Experiment

Creates a work item from a task in another work item’s description.

Input type: WorkItemCreateFromTaskInput

workItemCreateFromTask arguments

NameTypeDescription
idWorkItemID!Global ID of the work item.
workItemDataWorkItemConvertTaskInput!Arguments necessary to convert a task into a work item.

workItemCreateFromTask fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
newWorkItemWorkItemNew work item created from task.
workItemWorkItemUpdated 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

NameTypeDescription
idWorkItemsDecisionID!Global ID of the decision.

workItemDecisionArchive fields

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

NameTypeDescription
descriptionStringContext of the decision.
discussionIdDiscussionIDGlobal ID of the originating discussion thread.
options[WorkItemDecisionOptionInput!]Candidate options of the decision. Maximum of 5 options. Incompatible with resolution.
questionStringQuestion being decided. Required unless resolution is provided.
resolutionWorkItemDecisionResolutionInputWhen present, records the decision as resolved at creation. Incompatible with options.
sourceLinkStringURL of the comment, discussion, or external resource that prompted the decision.
titleStringDeprecated in GitLab 19.6. Use question.
workItemIdWorkItemID!Global ID of the work item.

workItemDecisionCreate fields

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

NameTypeDescription
idWorkItemsDecisionID!Global ID of the decision.

workItemDecisionDelete fields

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

NameTypeDescription
idWorkItemsDecisionID!Global ID of the decision.
resolutionRationaleStringReasoning for the resolution.
resolvingNoteIdNoteIDGlobal ID of the comment that resolved the decision.
selectedOptionContentStringContent of a custom option, added as the only selected option of the decision while every existing option is deselected. Incompatible with selectedOptionIds.
selectedOptionIds[WorkItemsDecisionOptionID!]Global IDs of the selected options. Maximum of 5 options.

workItemDecisionResolve fields

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

NameTypeDescription
descriptionStringContext of the decision.
discussionIdDiscussionIDGlobal ID of the originating discussion thread.
idWorkItemsDecisionID!Global ID of the decision.
options[WorkItemDecisionOptionUpdateInput!]Existing options of the decision to update. Maximum of 6 options.
questionStringQuestion being decided.
resolutionRationaleStringReasoning for the resolution. Can only be updated on resolved decisions.
resolvedByIdUserIDGlobal ID of the user who resolved the decision. Can only be updated on resolved decisions.
resolvingNoteIdNoteIDGlobal ID of the comment that resolved the decision. Can only be updated on resolved decisions.
selectedOptionContentStringContent of the selected option. Unless exactly one option is selected, a new selected option with this content is added and any selected options are deselected. Can only be updated on resolved decisions.
sourceLinkStringURL of the comment, discussion, or external resource that prompted the decision.
titleStringDeprecated in GitLab 19.6. Use question.

workItemDecisionUpdate fields

NameTypeDescription
decisionWorkItemDecisionDecision after mutation.
errors[String!]!Errors encountered during the mutation.

workItemDelete

  • Status: Experiment

Deletes a work item.

Input type: WorkItemDeleteInput

workItemDelete arguments

NameTypeDescription
idWorkItemID!Global ID of the work item.

workItemDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
namespaceNamespaceNamespace the deleted work item belonged to.
projectProjectDeprecated 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

NameTypeDescription
idWorkItemID!Global ID of the work item.

workItemEnableAiPlanning fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemWorkItemWork item after mutation.

workItemExport

Deprecated in GitLab 18.0. Use WorkItemsCsvExport.

Input type: WorkItemExportInput

workItemExport arguments

NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
crmContactIdStringFilter by ID of CRM contact.
crmOrganizationIdStringFilter by ID of CRM contact organization.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
healthStatusFilterHealthStatusFilterIntroduced as an experiment in GitLab 18.2.

Health status of the work items, “none” and “any” values are supported.
hierarchyFiltersHierarchyFilterInputIntroduced 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.'.
includeDescendantWorkItemsBooleanIntroduced 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.
iterationWildcardIdIterationWildcardIdIntroduced 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).
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
parentIds[WorkItemID!]Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardIdWorkItemParentWildcardIdIntroduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
projectPathID!Full project path.
releaseTag[String!]Release tag associated with the work item’s milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardIdReleaseTagWildcardIdFilter by release tag wildcard.
searchStringSearch query for title or description.
selectedFields[AvailableExportFields!]List of selected fields to be exported. Omit to export all available fields.
stateIssuableStateCurrent state of the work item.
statusWorkItemWidgetStatusFilterInputIntroduced as an experiment in GitLab 18.7.

Filter by status.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.
weightStringIntroduced as an experiment in GitLab 18.2.

Weight applied to the work item, “none” and “any” values are supported.
weightWildcardIdWeightWildcardIdIntroduced 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

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
messageStringExport 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_score feature flag is enabled; returns an error otherwise.

Input type: WorkItemGenerateReadinessScoreInput

workItemGenerateReadinessScore arguments

NameTypeDescription
idWorkItemID!Global ID of the work item to score readiness for.

workItemGenerateReadinessScore fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workflowDuoWorkflowDuo 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

NameTypeDescription
idWorkItemID!Global ID of the work item to generate a workplan for.

workItemGenerateWorkplan fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workflowDuoWorkflowDuo 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

NameTypeDescription
childrenIds[WorkItemID!]!Global IDs of children work items.
idWorkItemID!Global ID of the work item.

workItemHierarchyAddChildrenItems fields

NameTypeDescription
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

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

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
messageStringLinked items update result message.
workItemWorkItemUpdated work item.

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

NameTypeDescription
idWorkItemID!Global ID of the work item whose workplan generation to resume.

workItemResumeWorkplan fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workflowDuoWorkflowDuo Agent Platform workflow that was resumed.

workItemSavedViewCreate

  • Status: Experiment

Creates a saved view.

Input type: WorkItemSavedViewCreateInput

workItemSavedViewCreate arguments

NameTypeDescription
descriptionStringDescription of the saved view.
displaySettingsJSON!Display settings associated with the saved view.
filtersWorkItemSavedViewFilterInput!Filters associated with the saved view.
isPrivateBooleanWhether the saved view is private. Default is true.
nameString!Name of the saved view.
namespacePathID!Full path of the namespace to create the saved view in.
privateBooleanDeprecated in GitLab 18.10. Replaced by isPrivate argument.
sortWorkItemSort!Sort option associated with the saved view.

workItemSavedViewCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeCreated saved view.

workItemSavedViewDelete

  • Status: Experiment

Deletes a saved view.

Input type: WorkItemSavedViewDeleteInput

workItemSavedViewDelete arguments

NameTypeDescription
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view.

workItemSavedViewDelete fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeDeleted saved view.

workItemSavedViewReorder

  • Status: Experiment

Reorders a saved view for the current user.

Input type: WorkItemSavedViewReorderInput

workItemSavedViewReorder arguments

NameTypeDescription
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view to be reordered.
moveAfterIdWorkItemsSavedViewsSavedViewIDGlobal ID of a saved view that the reordered view should be placed after.
moveBeforeIdWorkItemsSavedViewsSavedViewIDGlobal ID of a saved view that the reordered view should be placed before.

workItemSavedViewReorder fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeReordered saved view.

workItemSavedViewSubscribe

  • Status: Experiment

Subscribes the current user to a saved view.

Input type: WorkItemSavedViewSubscribeInput

workItemSavedViewSubscribe arguments

NameTypeDescription
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view to subscribe to.

workItemSavedViewSubscribe fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeSubscribed saved view.

workItemSavedViewUnsubscribe

  • Status: Experiment

Unsubscribes the current user from a saved view.

Input type: WorkItemSavedViewUnsubscribeInput

workItemSavedViewUnsubscribe arguments

NameTypeDescription
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view to unsubscribe from.

workItemSavedViewUnsubscribe fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeUnsubscribed saved view.

workItemSavedViewUpdate

  • Status: Experiment

Updates a saved view.

Input type: WorkItemSavedViewUpdateInput

workItemSavedViewUpdate arguments

NameTypeDescription
descriptionStringDescription of the saved view.
displaySettingsJSONDisplay settings associated with the saved view.
filtersWorkItemSavedViewFilterInputFilters associated with the saved view.
idWorkItemsSavedViewsSavedViewID!Global ID of the saved view.
isPrivateBooleanWhether the saved view is private.
nameStringName of the saved view.
privateBooleanDeprecated in GitLab 18.10. Replaced by isPrivate argument.
sortWorkItemSortSorting option associated with the saved view.

workItemSavedViewUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
savedViewWorkItemSavedViewTypeUpdated 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

NameTypeDescription
customizableTypeVisibilityBooleanWhether namespace admins can configure per-type work item visibility.
fullPathIDFull path of the root group. Omit to use the current organization.

workItemSettingsUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemSettingsWorkItemSettingsWork item settings after mutation.

workItemSubscribe

  • Status: Experiment

Input type: WorkItemSubscribeInput

workItemSubscribe arguments

NameTypeDescription
idWorkItemID!Global ID of the work item.
subscribedBoolean!Desired state of the subscription.

workItemSubscribe fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemWorkItemWork item after mutation.

workItemTypeCreate

  • Status: Experiment

Input type: WorkItemTypeCreateInput

workItemTypeCreate arguments

NameTypeDescription
enabledByDefaultForNewNamespacesBooleanIndicates the type is enabled by default for new child namespaces.
fullPathStringFull path of the root group.
iconNameString!Icon name for the work item type. Use the workItemTypeIconDefinitions query to retrieve the list of available icon names.
nameString!Name for the work item type.

workItemTypeCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemTypeWorkItemTypeWork item type that was created.

workItemTypeUpdate

  • Status: Experiment

Input type: WorkItemTypeUpdateInput

workItemTypeUpdate arguments

NameTypeDescription
archiveBooleanWhether to archive the work item type.
enabledByDefaultForNewNamespacesBooleanIndicates the type is enabled by default for new child namespaces.
fullPathStringFull path of the root group.
iconNameStringIcon name for the work item type. Use the workItemTypeIconDefinitions query to retrieve the list of available icon names.
idWorkItemsTypeID!Global ID of the work item type to update.
nameStringNew name for the work item type.

workItemTypeUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemTypeWorkItemTypeWork item type that was updated.

workItemUpdate

  • Status: Experiment

Updates a work item by Global ID.

Input type: WorkItemUpdateInput

workItemUpdate arguments

NameTypeDescription
agentPlanWidgetWorkItemWidgetAgentPlanInputIntroduced as an experiment in GitLab 19.0.

Input for agent plan widget.
assigneesWidgetWorkItemWidgetAssigneesInputInput for assignees widget.
awardEmojiWidgetWorkItemWidgetAwardEmojiUpdateInputInput for emoji reactions widget.
colorWidgetWorkItemWidgetColorInputInput for color widget.
confidentialBooleanSets the work item confidentiality.
crmContactsWidgetWorkItemWidgetCrmContactsUpdateInputInput for CRM contacts widget.
currentUserTodosWidgetWorkItemWidgetCurrentUserTodosInputInput for to-dos widget.
customFieldsWidget[WorkItemWidgetCustomFieldValueInputType!]Introduced as an experiment in GitLab 17.10.

Input for custom fields widget.
descriptionWidgetWorkItemWidgetDescriptionInputInput for description widget.
healthStatusWidgetWorkItemWidgetHealthStatusInputInput for health status widget.
hierarchyWidgetWorkItemWidgetHierarchyUpdateInputInput for hierarchy widget.
idWorkItemID!Global ID of the work item.
iterationWidgetWorkItemWidgetIterationInputInput for iteration widget.
labelsWidgetWorkItemWidgetLabelsUpdateInputInput for labels widget.
milestoneWidgetWorkItemWidgetMilestoneInputInput for milestone widget.
moveAfterIdWorkItemIDIntroduced as an experiment in GitLab 19.2.

Global ID of a work item that should be placed after the work item.
moveBeforeIdWorkItemIDIntroduced as an experiment in GitLab 19.2.

Global ID of a work item that should be placed before the work item.
notesWidgetWorkItemWidgetNotesInputInput for notes widget.
notificationsWidgetWorkItemWidgetNotificationsUpdateInputInput for notifications widget.
progressWidgetWorkItemWidgetProgressInputInput for progress widget.
startAndDueDateWidgetWorkItemWidgetStartAndDueDateUpdateInputInput for start and due date widget.
stateEventWorkItemStateEventClose or reopen a work item.
statusWidgetWorkItemWidgetStatusInputIntroduced as an experiment in GitLab 17.11.

Input for status widget.
timeTrackingWidgetWorkItemWidgetTimeTrackingInputInput for time tracking widget.
titleStringTitle of the work item.
verificationStatusWidgetVerificationStatusInputInput for verification status widget.
weightWidgetWorkItemWidgetWeightInputInput for weight widget.

workItemUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemWorkItemUpdated work item.

workItemUserPreferenceUpdate

  • Status: Experiment

Create or Update user preferences for a work item type and namespace.

Input type: WorkItemUserPreferenceUpdateInput

workItemUserPreferenceUpdate arguments

NameTypeDescriptionDefault
displaySettingsJSONDisplay settings for the work item lists.
namespacePathID!Full path of the namespace on which the preference is set.
sortWorkItemSortSort order for work item lists.CREATED_ASC
workItemTypeIdWorkItemsTypeIDGlobal ID of a work item type.

workItemUserPreferenceUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
userPreferencesWorkItemTypesUserPreferenceUser preferences.

workItemsCsvExport

  • Status: Experiment

Input type: WorkItemsCsvExportInput

workItemsCsvExport arguments

NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
crmContactIdStringFilter by ID of CRM contact.
crmOrganizationIdStringFilter by ID of CRM contact organization.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
healthStatusFilterHealthStatusFilterIntroduced as an experiment in GitLab 18.2.

Health status of the work items, “none” and “any” values are supported.
hierarchyFiltersHierarchyFilterInputIntroduced 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.'.
includeDescendantWorkItemsBooleanIntroduced 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.
iterationWildcardIdIterationWildcardIdIntroduced 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).
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
parentIds[WorkItemID!]Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardIdWorkItemParentWildcardIdIntroduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
projectPathID!Full project path.
releaseTag[String!]Release tag associated with the work item’s milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardIdReleaseTagWildcardIdFilter by release tag wildcard.
searchStringSearch query for title or description.
selectedFields[AvailableExportFields!]List of selected fields to be exported. Omit to export all available fields.
stateIssuableStateCurrent state of the work item.
statusWorkItemWidgetStatusFilterInputIntroduced as an experiment in GitLab 18.7.

Filter by status.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.
weightStringIntroduced as an experiment in GitLab 18.2.

Weight applied to the work item, “none” and “any” values are supported.
weightWildcardIdWeightWildcardIdIntroduced 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

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
messageStringExport request result message.

workItemsCsvImport

  • Status: Experiment

Input type: WorkItemsCsvImportInput

workItemsCsvImport arguments

NameTypeDescription
fileUpload!CSV file to import work items from.
projectPathID!Full project path.

workItemsCsvImport fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
messageStringImport request result message.

workItemsHierarchyReorder

  • Status: Experiment

Reorder a work item in the hierarchy tree.

Input type: workItemsHierarchyReorderInput

workItemsHierarchyReorder arguments

NameTypeDescription
adjacentWorkItemIdWorkItemIDID of the work item to move next to. For example, the item above or below.
idWorkItemID!Global ID of the work item to be reordered.
parentIdWorkItemIDGlobal ID of the new parent work item.
relativePositionRelativePositionTypePosition relative to the adjacent work item. Valid values are BEFORE or AFTER.

workItemsHierarchyReorder fields

NameTypeDescription
adjacentWorkItemWorkItemAdjacent work item after mutation.
errors[String!]!Errors encountered during the mutation.
parentWorkItemWorkItemWork item’s parent after mutation.
workItemWorkItemWork item after mutation.

workItemsReorder

  • Status: Experiment

Reorders a work item.

Input type: workItemsReorderInput

workItemsReorder arguments

NameTypeDescription
idWorkItemID!Global ID of the work item to be reordered.
moveAfterIdWorkItemIDGlobal ID of a work item that should be placed after the work item.
moveBeforeIdWorkItemIDGlobal ID of a work item that should be placed before the work item.

workItemsReorder fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workItemWorkItemWork item after mutation.

workspaceCreate

Input type: WorkspaceCreateInput

workspaceCreate arguments

NameTypeDescriptionDefault
clusterAgentIdClustersAgentID!GlobalID of the cluster agent the created workspace will be associated with.
desiredStateString!Desired state of the created workspace.
devfilePathStringProject path containing the devfile used to configure the workspace. If not provided, the GitLab default devfile is used.null
devfileRefStringDeprecated in GitLab 17.8. Argument is renamed to project_ref.
editorStringDeprecated in GitLab 17.5. Argument is not used.
maxHoursBeforeTerminationIntDeprecated in GitLab 17.9. Field is not used.
projectIdProjectID!ID of the project that will provide the Devfile for the created workspace.
projectRefStringProject repo git ref.
variables[WorkspaceVariableInput!]Deprecated in GitLab 18.0. Argument is renamed to workspace_variables.[]
workspaceVariables[WorkspaceVariableInput!]Introduced as an experiment in GitLab 18.0.

Variables to inject into the workspace.
[]

workspaceCreate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workspaceWorkspaceCreated workspace.

workspaceUpdate

Input type: WorkspaceUpdateInput

workspaceUpdate arguments

NameTypeDescription
desiredStateString!Desired state of the created workspace.
idRemoteDevelopmentWorkspaceID!Global ID of the workspace.

workspaceUpdate fields

NameTypeDescription
errors[String!]!Errors encountered during the mutation.
workspaceWorkspaceCreated workspace.