GraphQL API resources

This documentation is self-generated based on GitLab current GraphQL schema.

The API can be explored interactively using the GraphiQL IDE.

Each table below documents a GraphQL type. Types match loosely to models, but not all fields and methods on a model are available via GraphQL.

caution
Fields that are deprecated are marked with . Items (fields, enums, etc) that have been removed according to our deprecation process can be found in Removed Items.

Query type

The Query type contains the API’s top-level entry points for all executable queries.

Query.abuseReport

Find an abuse report.

caution
Introduced in 16.3. This feature is an Experiment. It can be changed or removed at any time.

Returns AbuseReport.

Arguments

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

Query.abuseReportLabels

Abuse report labels.

caution
Introduced in 16.3. This feature is an Experiment. It can be changed or removed at any time.

Returns LabelConnection.

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

Arguments

Name Type Description
searchTerm String Search term to find labels with.

Query.aiMessages

Find GitLab Duo Chat messages.

caution
Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time.

Returns AiMessageConnection!.

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

Arguments

Name Type Description
requestIds [ID!] Array of request IDs to fetch.
roles [AiMessageRole!] Array of roles to fetch.

Query.auditEventDefinitions

Definitions for all audit events available on the instance.

Returns AuditEventDefinitionConnection!.

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

Query.boardList

Find an issue board list.

Returns BoardList.

Arguments

Name Type Description
id ListID! Global ID of the list.
issueFilters BoardIssueInput Filters applied when getting issue metadata in the board list.

Query.ciApplicationSettings

CI related settings that apply to the entire instance.

Returns CiApplicationSettings.

Query.ciCatalogResource

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

caution
Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time.

Returns CiCatalogResource.

Arguments

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

Query.ciCatalogResources

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

caution
Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time.

Returns CiCatalogResourceConnection.

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

Arguments

Name Type Description
projectPath ID Project with the namespace catalog.
scope CiCatalogResourceScope Scope of the returned catalog resources.
search String Search term to filter the catalog resources by name or description.
sort CiCatalogResourceSort Sort catalog resources by given criteria.

Query.ciConfig

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

Returns CiConfig.

Arguments

Name Type Description
content String! Contents of .gitlab-ci.yml.
dryRun Boolean Run pipeline creation simulation, or only do static check.
projectPath ID! Project of the CI config.
sha String Sha for the pipeline.
skipVerifyProjectSha Boolean Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. If the provided sha is found in the project’s repository but is not associated with a Git reference (a detached commit), the verification fails and a validation error is returned. Otherwise, verification passes, even if the sha is invalid. Set to true to skip this verification process.

Query.ciMinutesUsage

Compute usage data for a namespace.

Returns CiMinutesNamespaceMonthlyUsageConnection.

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

Arguments

Name Type Description
date Date Date for which to retrieve the usage data, should be the first day of a month.
namespaceId NamespaceID Global ID of the Namespace for the monthly compute usage.

Query.ciPipelineStage

Stage belonging to a CI pipeline.

Returns CiStage.

Arguments

Name Type Description
id CiStageID! Global ID of the CI stage.

Query.ciQueueingHistory

Time it took for ci job to be picked up by runner in percentiles.

caution
Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time.

Returns QueueingDelayHistory.

Arguments

Name Type Description
fromTime Time Start of the requested time frame. Defaults to 3 hours ago.
runnerType CiRunnerType Filter jobs by the type of runner that executed them.
toTime Time End of the requested time frame. Defaults to current time.

Query.ciVariables

List of the instance’s CI/CD variables.

Returns CiInstanceVariableConnection.

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

Arguments

Name Type Description
sort CiVariableSort Sort order of results.

Query.containerRepository

Find a container repository.

Returns ContainerRepositoryDetails.

Arguments

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

Query.currentLicense

Fields related to the current license.

Returns CurrentLicense.

Query.currentUser

Get information about current user.

Returns UserCore.

Query.designManagement

Fields related to design management.

Returns DesignManagement!.

Query.devopsAdoptionEnabledNamespaces

Get configured DevOps adoption namespaces. BETA This endpoint is subject to change without notice.

Returns DevopsAdoptionEnabledNamespaceConnection.

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

Arguments

Name Type Description
displayNamespaceId NamespaceID Filter by display namespace.

Query.echo

Testing endpoint to validate the API with.

Returns String!.

Arguments

Name Type Description
text String! Text to echo back.

Query.epicBoardList

Returns EpicList.

Arguments

Name Type Description
epicFilters EpicFilters Filters applied when getting epic metadata in the epic board list.
id BoardsEpicListID! Global ID of the list.

Query.explainVulnerabilityPrompt

GitLab Duo Vulnerability summary prompt for a specified vulnerability.

caution
Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time.

Returns ExplainVulnerabilityPrompt.

Arguments

Name Type Description
vulnerabilityId VulnerabilityID! Vulnerability to generate a prompt for.

Query.frecentGroups

A user’s frecently visited groups. Requires the frecent_namespaces_suggestions feature flag to be enabled.

caution
Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time.

Returns [Group!].

Query.frecentProjects

A user’s frecently visited projects. Requires the frecent_namespaces_suggestions feature flag to be enabled.

caution
Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time.

Returns [Project!].

Query.geoNode

Find a Geo node.

Returns GeoNode.

Arguments

Name Type Description
name String Name of the Geo node. Defaults to the current Geo node name.

Query.gitpodEnabled

Whether Gitpod is enabled in application settings.

Returns Boolean.

Query.group

Find a group.

Returns Group.

Arguments

Name Type Description
fullPath ID! Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss.

Query.groups

Find groups.

Returns GroupConnection.

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

Arguments

Name Type Description
search String Search query for group name or group full path.

Query.instanceExternalAuditEventDestinations

Instance level external audit event destinations.

Returns InstanceExternalAuditEventDestinationConnection.

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

Query.instanceGoogleCloudLoggingConfigurations

Instance level google cloud logging configurations.

Returns InstanceGoogleCloudLoggingConfigurationTypeConnection.

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

Query.instanceSecurityDashboard

Fields related to Instance Security Dashboard.

Returns InstanceSecurityDashboard.

Query.issue

Find an issue.

Returns Issue.

Arguments

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

Query.issues

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

caution
Introduced in 15.6. This feature is an Experiment. It can be changed or removed at any time.

Returns IssueConnection.

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

Arguments

Name Type Description
assigneeId String ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername String Deprecated in 13.11. Use assigneeUsernames.
assigneeUsernames [String!] Usernames of users assigned to the issue.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername String Username of the author of the issue.
closedAfter Time Issues closed after this date.
closedBefore Time Issues closed before this date.
confidential Boolean Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfter Time Issues created after this date.
createdBefore Time Issues created before this date.
crmContactId String ID of a contact assigned to the issues.
crmOrganizationId String ID of an organization assigned to the issues.
epicId String ID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardId EpicWildcardId Filter by epic ID wildcard. Incompatible with epicId.
healthStatusFilter HealthStatusFilter Health status of the issue, “none” and “any” values are supported.
iid String IID of the issue. For example, “1”.
iids [String!] List of IIDs of issues. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Whether to include issues from archived projects. Defaults to false.
includeSubepics Boolean Whether to include subepics when filtering issues by epicId.
iterationCadenceId [IterationsCadenceID!] Filter by a list of iteration cadence IDs.
iterationId [ID] List of iteration Global IDs applied to the issue.
iterationTitle String Filter by iteration title.
iterationWildcardId IterationWildcardId Filter by iteration ID wildcard.
labelName [String] Labels applied to this issue.
milestoneTitle [String] Milestone applied to this issue.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedIssueFilterInput Negated arguments.
or UnionedIssueFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort IssueSort Sort issues by this criteria.
state IssuableState Current state of this issue.
types [IssueType!] Filter issues by the given issue types.
updatedAfter Time Issues updated after this date.
updatedBefore Time Issues updated before this date.
weight String Weight applied to the issue, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Filter by weight ID wildcard. Incompatible with weight.

Query.iteration

Find an iteration.

Returns Iteration.

Arguments

Name Type Description
id IterationID! Find an iteration by its ID.

Query.jobs

All jobs on this GitLab instance.

Returns CiJobConnection.

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

Arguments

Name Type Description
failureReason CiJobFailureReason Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Filter jobs by failure reason. Currently only RUNNER_SYSTEM_FAILURE together with runnerTypes: INSTANCE_TYPE is supported.
runnerTypes [CiRunnerType!] Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Filter jobs by runner type if feature flag :admin_jobs_filter_runner_type is enabled.
statuses [CiJobStatus!] Filter jobs by status.

Query.licenseHistoryEntries

Fields related to entries in the license history.

Returns LicenseHistoryEntryConnection.

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

Query.memberRole

Finds a single custom role.

caution
Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time.

Returns MemberRole.

Arguments

Name Type Description
id MemberRoleID Global ID of the member role to look up.

Query.memberRolePermissions

List of all customizable permissions.

Returns CustomizablePermissionConnection.

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

Query.mergeRequest

Find a merge request.

Returns MergeRequest.

Arguments

Name Type Description
id MergeRequestID! Global ID of the merge request.

Query.metadata

Metadata about GitLab.

Returns Metadata.

Query.milestone

Find a milestone.

Returns Milestone.

Arguments

Name Type Description
id MilestoneID! Find a milestone by its ID.

Query.namespace

Find a namespace.

Returns Namespace.

Arguments

Name Type Description
fullPath ID! Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss.

Query.note

Find a note.

caution
Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time.

Returns Note.

Arguments

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

Query.organization

Find an organization.

caution
Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time.

Returns Organization.

Arguments

Name Type Description
id OrganizationsOrganizationID! ID of the organization.

Query.package

Find a package. This field can only be resolved for one query in any single request. Returns null if a package has no default status.

Returns PackageDetailsType.

Arguments

Name Type Description
id PackagesPackageID! Global ID of the package.

Query.project

Find a project.

Returns Project.

Arguments

Name Type Description
fullPath ID! Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss.

Query.projects

Find projects visible to the current user.

Returns ProjectConnection.

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

Arguments

Name Type Description
fullPaths [String!] Filter projects by full paths. You cannot provide more than 50 full paths.
ids [ID!] Filter projects by IDs.
membership Boolean Return only projects that the current user is a member of.
search String Search query, which can be for the project name, a path, or a description.
searchNamespaces Boolean Include namespace in project search.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics [String!] Filter projects by topics.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.

Query.queryComplexity

Information about the complexity of the GraphQL query.

Returns QueryComplexity.

Query.runner

Find a runner.

Returns CiRunner.

Arguments

Name Type Description
id CiRunnerID! Runner ID.

Query.runnerPlatforms

Supported runner platforms.

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

Returns RunnerPlatformConnection.

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

Query.runnerSetup

Runner setup instructions.

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

Returns RunnerSetup.

Arguments

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

Query.runners

Get all runners in the GitLab instance (project and shared). Access is restricted to users with administrator access.

Returns CiRunnerConnection.

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

Arguments

Name Type Description
active Boolean Deprecated in 14.8. This was renamed. Use: paused.
creatorId UserID Filter runners by creator ID.
paused Boolean Filter runners by paused (true) or active (false) status.
search String Filter by full token or partial text in description field.
sort CiRunnerSort Sort order of results.
status CiRunnerStatus Filter runners by status.
tagList [String!] Filter by tags associated with the runner (comma-separated or array).
type CiRunnerType Filter runners by type.
upgradeStatus CiRunnerUpgradeStatus Filter by upgrade status.
versionPrefix String Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term ‘14.’ returns runner managers with versions ‘14.11.1’ and ‘14.2.3’.

Query.snippets

Find Snippets visible to the current user.

Returns SnippetConnection.

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

Arguments

Name Type Description
authorId UserID ID of an author.
explore Boolean Explore personal snippets.
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
projectId ProjectID ID of a project.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.

Query.subscriptionFutureEntries

Fields related to entries in future subscriptions.

Returns SubscriptionFutureEntryConnection.

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

Query.syntheticNote

Find a synthetic note.

caution
Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time.

Returns Note.

Arguments

Name Type Description
noteableId NoteableID! Global ID of the resource to search synthetic note on.
sha String! Global ID of the note.

Query.timelogs

Find timelogs visible to the current user.

Returns TimelogConnection.

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

Arguments

Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.

Query.todo

Retrieve a single to-do item.

Returns Todo.

Arguments

Name Type Description
id TodoID! ID of the to-do item.

Query.topics

Find project topics.

Returns TopicConnection.

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

Arguments

Name Type Description
search String Search query for topic name.

Query.usageTrendsMeasurements

Get statistics on the instance.

Returns UsageTrendsMeasurementConnection.

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

Arguments

Name Type Description
identifier MeasurementIdentifier! Type of measurement or statistics to retrieve.
recordedAfter Time Measurement recorded after this date.
recordedBefore Time Measurement recorded before this date.

Query.user

Find a user.

Returns UserCore.

Arguments

Name Type Description
id UserID ID of the User.
username String Username of the User.

Query.users

Find users.

Returns UserCoreConnection.

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

Arguments

Name Type Description
admins Boolean Return only admin users.
ids [ID!] List of user Global IDs.
search String Query to search users by name, username, or primary email.
sort Sort Sort users by this criteria.
usernames [String!] List of usernames.

Query.vulnerabilities

Vulnerabilities reported on projects on the current user’s instance security dashboard.

Returns VulnerabilityConnection.

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

Arguments

Name Type Description
clusterAgentId [ClustersAgentID!] Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId [ClustersClusterID!] Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason [VulnerabilityDismissalReason!] Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
hasIssues Boolean Returns only the vulnerabilities which have linked issues.
hasMergeRequest Boolean Returns only the vulnerabilities which have linked merge requests.
hasRemediations Boolean Returns only the vulnerabilities which have remediations.
hasResolution Boolean Returns only the vulnerabilities which have been resolved on default branch.
image [String!] Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning, cluster_image_scanning.
projectId [ID!] Filter vulnerabilities by project.
reportType [VulnerabilityReportType!] Filter vulnerabilities by report type.
scanner [String!] Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId [VulnerabilitiesScannerID!] Filter vulnerabilities by scanner ID.
severity [VulnerabilitySeverity!] Filter vulnerabilities by severity.
sort VulnerabilitySort List vulnerabilities by sort order.
state [VulnerabilityState!] Filter vulnerabilities by state.

Query.vulnerabilitiesCountByDay

The historical number of vulnerabilities per day for the projects on the current user’s instance security dashboard.

Returns VulnerabilitiesCountByDayConnection.

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

Arguments

Name Type Description
endDate ISO8601Date! Last day for which to fetch vulnerability history.
startDate ISO8601Date! First day for which to fetch vulnerability history.

Query.vulnerability

Find a vulnerability.

Returns Vulnerability.

Arguments

Name Type Description
id VulnerabilityID! Global ID of the Vulnerability.

Query.workItem

Find a work item.

caution
Introduced in 15.1. This feature is an Experiment. It can be changed or removed at any time.

Returns WorkItem.

Arguments

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

Query.workspace

Find a workspace.

caution
Introduced in 16.0. This feature is an Experiment. It can be changed or removed at any time.

Returns Workspace.

Arguments

Name Type Description
id RemoteDevelopmentWorkspaceID! Find a workspace by its ID.

Query.workspaces

Find workspaces owned by the current user by their IDs.

caution
Introduced in 16.0. This feature is an Experiment. It can be changed or removed at any time.

Returns WorkspaceConnection.

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

Arguments

Name Type Description
ids [RemoteDevelopmentWorkspaceID!] Array of global workspace IDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates [String!] Includes all workspaces that match any of the actual states.
projectIds [ProjectID!] Filter workspaces by project id.

Mutation type

The Mutation type contains all the mutations you can execute.

All mutations receive their arguments in a single input object named input, and all mutations support at least a return field errors containing a list of error messages.

All input objects may have a clientMutationId: String field, identifying the mutation.

For example: 

mutation($id: NoteableID!, $body: String!) {
  createNote(input: { noteableId: $id, body: $body }) {
    errors
  }
}

Mutation.abuseReportLabelCreate

caution
Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time.

Input type: AbuseReportLabelCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
color String The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names.
title String! Title of the label.

Fields

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

Mutation.achievementsAward

caution
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time.

Input type: AchievementsAwardInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being awarded.
clientMutationId String A unique identifier for the client performing the mutation.
userId UserID! Global ID of the user being awarded the achievement.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievement UserAchievement Achievement award.

Mutation.achievementsCreate

caution
Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time.

Input type: AchievementsCreateInput

Arguments

Name Type Description
avatar Upload Avatar for the achievement.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the achievement.
name String! Name for the achievement.
namespaceId NamespaceID! Namespace for the achievement.

Fields

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

Mutation.achievementsDelete

caution
Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time.

Input type: AchievementsDeleteInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being deleted.
clientMutationId String A unique identifier for the client performing the mutation.

Fields

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

Mutation.achievementsRevoke

caution
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time.

Input type: AchievementsRevokeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
userAchievementId AchievementsUserAchievementID! Global ID of the user achievement being revoked.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievement UserAchievement Achievement award.

Mutation.achievementsUpdate

caution
Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time.

Input type: AchievementsUpdateInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being updated.
avatar Upload Avatar for the achievement.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the achievement.
name String Name for the achievement.

Fields

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

Mutation.addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectID! ID of the project to be added to Instance Security Dashboard.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Project that was added to the Instance Security Dashboard.

Mutation.adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

Arguments

Name Type Description
aiResource String Delete jobs matching ai_resource in the context metadata.
artifactSize String Delete jobs matching artifact_size in the context metadata.
artifactUsedCdn String Delete jobs matching artifact_used_cdn in the context metadata.
artifactsDependenciesCount String Delete jobs matching artifacts_dependencies_count in the context metadata.
artifactsDependenciesSize String Delete jobs matching artifacts_dependencies_size in the context metadata.
callerId String Delete jobs matching caller_id in the context metadata.
clientId String Delete jobs matching client_id in the context metadata.
clientMutationId String A unique identifier for the client performing the mutation.
featureCategory String Delete jobs matching feature_category in the context metadata.
jobId String Delete jobs matching job_id in the context metadata.
mergeActionStatus String Delete jobs matching merge_action_status in the context metadata.
pipelineId String Delete jobs matching pipeline_id in the context metadata.
project String Delete jobs matching project in the context metadata.
queueName String! Name of the queue to delete jobs from.
relatedClass String Delete jobs matching related_class in the context metadata.
remoteIp String Delete jobs matching remote_ip in the context metadata.
rootCallerId String Delete jobs matching root_caller_id in the context metadata.
rootNamespace String Delete jobs matching root_namespace in the context metadata.
subscriptionPlan String Delete jobs matching subscription_plan in the context metadata.
user String Delete jobs matching user in the context metadata.
userId String Delete jobs matching user_id in the context metadata.
workerClass String Delete jobs with the given worker class.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
result DeleteJobsResponse Information about the status of the deletion request.

Mutation.aiAction

caution
Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time.

Input type: AiActionInput

Arguments

Name Type Description
analyzeCiJobFailure AnalyzeCiJobFailureInput Input for analyze_ci_job_failure AI action.
chat AiChatInput Input for chat AI action.
clientMutationId String A unique identifier for the client performing the mutation.
clientSubscriptionId String Client generated ID that can be subscribed to, to receive a response for the mutation.
explainCode AiExplainCodeInput Input for explain_code AI action.
explainVulnerability AiExplainVulnerabilityInput Input for explain_vulnerability AI action.
fillInMergeRequestTemplate AiFillInMergeRequestTemplateInput Input for fill_in_merge_request_template AI action.
generateCommitMessage AiGenerateCommitMessageInput Input for generate_commit_message AI action.
generateDescription AiGenerateDescriptionInput Input for generate_description AI action.
generateTestFile GenerateTestFileInput Input for generate_test_file AI action.
resolveVulnerability AiResolveVulnerabilityInput Input for resolve_vulnerability AI action.
summarizeComments AiSummarizeCommentsInput Input for summarize_comments AI action.
summarizeReview AiSummarizeReviewInput Input for summarize_review AI action.
tanukiBot AiTanukiBotInput Input for tanuki_bot AI action.

Fields

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

Mutation.alertSetAssignees

Input type: AlertSetAssigneesInput

Arguments

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

Fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.alertTodoCreate

Input type: AlertTodoCreateInput

Arguments

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

Fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.approveDeployment

Input type: ApproveDeploymentInput

Arguments

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

Fields

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

Mutation.artifactDestroy

Input type: ArtifactDestroyInput

Arguments

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

Fields

Name Type Description
artifact CiJobArtifact Deleted artifact.
clientMutationId