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

NameTypeDescription
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

NameTypeDescription
searchTerm StringSearch 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 AiChatMessageConnection!.

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

Arguments

NameTypeDescription
requestIds [ID!]Array of request IDs to fetch.
roles [AiChatMessageRole!]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

NameTypeDescription
id ListID!Global ID of the list.
issueFilters BoardIssueInputFilters 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

NameTypeDescription
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

NameTypeDescription
projectPath IDProject with the namespace catalog.
sort CiCatalogResourceSortSort 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

NameTypeDescription
content String!Contents of .gitlab-ci.yml.
dryRun BooleanRun pipeline creation simulation, or only do static check.
projectPath ID!Project of the CI config.
sha StringSha for the pipeline.

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

NameTypeDescription
date DateDate for which to retrieve the usage data, should be the first day of a month.
namespaceId NamespaceIDGlobal ID of the Namespace for the monthly compute usage.

Query.ciPipelineStage

Stage belonging to a CI pipeline.

Returns CiStage.

Arguments

NameTypeDescription
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

NameTypeDescription
fromTime TimeStart of the requested time frame. Defaults to 3 hours ago.
runnerType CiRunnerTypeFilter jobs by the type of runner that executed them.
toTime TimeEnd 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

NameTypeDescription
sort CiVariableSortSort order of results.

Query.containerRepository

Find a container repository.

Returns ContainerRepositoryDetails.

Arguments

NameTypeDescription
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

NameTypeDescription
displayNamespaceId NamespaceIDFilter by display namespace.

Query.echo

Testing endpoint to validate the API with.

Returns String!.

Arguments

NameTypeDescription
text String!Text to echo back.

Query.epicBoardList

Returns EpicList.

Arguments

NameTypeDescription
epicFilters EpicFiltersFilters applied when getting epic metadata in the epic board list.
id BoardsEpicListID!Global ID of the list.

Query.explainVulnerabilityPrompt

Explain This Vulnerability 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

NameTypeDescription
vulnerabilityId VulnerabilityID!Vulnerability to generate a prompt for.

Query.geoNode

Find a Geo node.

Returns GeoNode.

Arguments

NameTypeDescription
name StringName 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

NameTypeDescription
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

NameTypeDescription
search StringSearch 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

NameTypeDescription
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

NameTypeDescription
assigneeId StringID 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 AssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername StringUsername of the author of the issue.
closedAfter TimeIssues closed after this date.
closedBefore TimeIssues closed before this date.
confidential BooleanFilter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfter TimeIssues created after this date.
createdBefore TimeIssues created before this date.
crmContactId StringID of a contact assigned to the issues.
crmOrganizationId StringID of an organization assigned to the issues.
epicId StringID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardId EpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatusFilter HealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iid StringIID 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 BooleanWhether to include issues from archived projects. Defaults to false.
includeSubepics BooleanWhether 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 StringFilter by iteration title.
iterationWildcardId IterationWildcardIdFilter by iteration ID wildcard.
labelName [String]Labels applied to this issue.
milestoneTitle [String]Milestone applied to this issue.
milestoneWildcardId MilestoneWildcardIdFilter issues by milestone ID wildcard.
myReactionEmoji StringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedIssueFilterInputNegated arguments.
or UnionedIssueFilterInputList of arguments with inclusive OR.
search StringSearch query for title or description.
sort IssueSortSort issues by this criteria.
state IssuableStateCurrent state of this issue.
types [IssueType!]Filter issues by the given issue types.
updatedAfter TimeIssues updated after this date.
updatedBefore TimeIssues updated before this date.
weight StringWeight applied to the issue, “none” and “any” values are supported.
weightWildcardId WeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.

Query.iteration

Find an iteration.

Returns Iteration.

Arguments

NameTypeDescription
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

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

NameTypeDescription
id MergeRequestID!Global ID of the merge request.

Query.metadata

Metadata about GitLab.

Returns Metadata.

Query.milestone

Find a milestone.

Returns Milestone.

Arguments

NameTypeDescription
id MilestoneID!Find a milestone by its ID.

Query.namespace

Find a namespace.

Returns Namespace.

Arguments

NameTypeDescription
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

NameTypeDescription
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

NameTypeDescription
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

NameTypeDescription
id PackagesPackageID!Global ID of the package.

Query.project

Find a project.

Returns Project.

Arguments

NameTypeDescription
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

NameTypeDescription
ids [ID!]Filter projects by IDs.
membership BooleanReturn only projects that the current user is a member of.
search StringSearch query, which can be for the project name, a path, or a description.
searchNamespaces BooleanInclude namespace in project search.
sort StringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics [String!]Filter projects by topics.
withIssuesEnabled BooleanReturn only projects with issues enabled.
withMergeRequestsEnabled BooleanReturn 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

NameTypeDescription
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

NameTypeDescription
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

NameTypeDescription
active Boolean Deprecated in 14.8. This was renamed. Use: paused.
paused BooleanFilter runners by paused (true) or active (false) status.
search StringFilter by full token or partial text in description field.
sort CiRunnerSortSort order of results.
status CiRunnerStatusFilter runners by status.
tagList [String!]Filter by tags associated with the runner (comma-separated or array).
type CiRunnerTypeFilter runners by type.
upgradeStatus CiRunnerUpgradeStatusFilter by upgrade status.

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

NameTypeDescription
authorId UserIDID of an author.
explore BooleanExplore personal snippets.
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
projectId ProjectIDID of a project.
type TypeEnumType of snippet.
visibility VisibilityScopesEnumVisibility 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

NameTypeDescription
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

NameTypeDescription
endDate TimeList timelogs within a date range where the logged date is equal to or before endDate.
endTime TimeList timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupIDList timelogs for a group.
projectId ProjectIDList timelogs for a project.
sort TimelogSortList timelogs in a particular order.
startDate TimeList timelogs within a date range where the logged date is equal to or after startDate.
startTime TimeList timelogs within a time range where the logged time is equal to or after startTime.
username StringList timelogs for a user.

Query.todo

Retrieve a single to-do item.

Returns Todo.

Arguments

NameTypeDescription
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

NameTypeDescription
search StringSearch 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

NameTypeDescription
identifier MeasurementIdentifier!Type of measurement or statistics to retrieve.
recordedAfter TimeMeasurement recorded after this date.
recordedBefore TimeMeasurement recorded before this date.

Query.user

Find a user.

Returns UserCore.

Arguments

NameTypeDescription
id UserIDID of the User.
username StringUsername 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

NameTypeDescription
admins BooleanReturn only admin users.
ids [ID!]List of user Global IDs.
search StringQuery to search users by name, username, or primary email.
sort SortSort 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

NameTypeDescription
clusterAgentId [ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId [ClustersClusterID!]Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason [VulnerabilityDismissalReason!]Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
hasIssues BooleanReturns only the vulnerabilities which have linked issues.
hasMergeRequest BooleanReturns only the vulnerabilities which have linked merge requests.
hasResolution BooleanReturns 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 VulnerabilitySortList 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

NameTypeDescription
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

NameTypeDescription
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

NameTypeDescription
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

NameTypeDescription
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

NameTypeDescription
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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
color StringThe 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
label LabelLabel 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

NameTypeDescription
achievementId AchievementsAchievementID!Global ID of the achievement being awarded.
clientMutationId StringA unique identifier for the client performing the mutation.
userId UserID!Global ID of the user being awarded the achievement.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
userAchievement UserAchievementAchievement 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

NameTypeDescription
avatar UploadAvatar for the achievement.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of or notes for the achievement.
name String!Name for the achievement.
namespaceId NamespaceID!Namespace for the achievement.

Fields

NameTypeDescription
achievement AchievementAchievement created.
clientMutationId StringA 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

NameTypeDescription
achievementId AchievementsAchievementID!Global ID of the achievement being deleted.
clientMutationId StringA unique identifier for the client performing the mutation.

Fields

NameTypeDescription
achievement AchievementAchievement.
clientMutationId StringA 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
userAchievementId AchievementsUserAchievementID!Global ID of the user achievement being revoked.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
userAchievement UserAchievementAchievement 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

NameTypeDescription
achievementId AchievementsAchievementID!Global ID of the achievement being updated.
avatar UploadAvatar for the achievement.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of or notes for the achievement.
name StringName for the achievement.

Fields

NameTypeDescription
achievement AchievementAchievement.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ProjectID!ID of the project to be added to Instance Security Dashboard.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
project ProjectProject that was added to the Instance Security Dashboard.

Mutation.adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

Arguments

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

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
result DeleteJobsResponseInformation 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

NameTypeDescription
analyzeCiJobFailure AnalyzeCiJobFailureInputInput for analyze_ci_job_failure AI action.
chat AiChatInputInput for chat AI action.
clientMutationId StringA unique identifier for the client performing the mutation.
clientSubscriptionId StringClient generated ID that can be subscribed to, to receive a response for the mutation.
explainCode AiExplainCodeInputInput for explain_code AI action.
explainVulnerability AiExplainVulnerabilityInputInput for explain_vulnerability AI action.
fillInMergeRequestTemplate AiFillInMergeRequestTemplateInputInput for fill_in_merge_request_template AI action.
generateCommitMessage AiGenerateCommitMessageInputInput for generate_commit_message AI action.
generateDescription AiGenerateDescriptionInputInput for generate_description AI action.
generateTestFile GenerateTestFileInputInput for generate_test_file AI action.
summarizeComments AiSummarizeCommentsInputInput for summarize_comments AI action.
summarizeReview AiSummarizeReviewInputInput for summarize_review AI action.
tanukiBot AiTanukiBotInputInput for tanuki_bot AI action.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
requestId StringID of the request.

Mutation.alertSetAssignees

Input type: AlertSetAssigneesInput

Arguments

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

Fields

NameTypeDescription
alert AlertManagementAlertAlert after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue created after mutation.
todo TodoTo-do item after mutation.

Mutation.alertTodoCreate

Input type: AlertTodoCreateInput

Arguments

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
alert AlertManagementAlertAlert after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
issue IssueIssue created after mutation.
todo TodoTo-do item after mutation.

Mutation.approveDeployment

Input type: ApproveDeploymentInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
comment StringComment to go with the approval.
id DeploymentID!ID of the deployment.
representedAs StringName 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

NameTypeDescription
clientMutationId StringA 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

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiJobArtifactID!ID of the artifact to delete.

Fields

NameTypeDescription
artifact CiJobArtifactDeleted artifact.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingDestinationEventsAdd

Input type: AuditEventsStreamingDestinationEventsAddInput

Arguments

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

Fields

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

Mutation.auditEventsStreamingDestinationEventsRemove

Input type: AuditEventsStreamingDestinationEventsRemoveInput

Arguments

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

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingDestinationInstanceEventsAdd

Input type: AuditEventsStreamingDestinationInstanceEventsAddInput

Arguments

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

Fields

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

Mutation.auditEventsStreamingDestinationInstanceEventsRemove

Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput

Arguments

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

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingHeadersCreate

Input type: AuditEventsStreamingHeadersCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID!Destination to associate header with.
key String!Header key.
value String!Header value.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
header AuditEventStreamingHeaderCreated header.

Mutation.auditEventsStreamingHeadersDestroy

Input type: AuditEventsStreamingHeadersDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
headerId AuditEventsStreamingHeaderID!Header to delete.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingHeadersUpdate

Input type: AuditEventsStreamingHeadersUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
headerId AuditEventsStreamingHeaderID!Header to update.
key String!Header key.
value String!Header value.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
header AuditEventStreamingHeaderUpdates header.

Mutation.auditEventsStreamingInstanceHeadersCreate

Input type: AuditEventsStreamingInstanceHeadersCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalAuditEventDestinationID!Instance level external destination to associate header with.
key String!Header key.
value String!Header value.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
header AuditEventsStreamingInstanceHeaderCreated header.

Mutation.auditEventsStreamingInstanceHeadersDestroy

Input type: AuditEventsStreamingInstanceHeadersDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
headerId AuditEventsStreamingInstanceHeaderID!Header to delete.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingInstanceHeadersUpdate

Input type: AuditEventsStreamingInstanceHeadersUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
headerId AuditEventsStreamingInstanceHeaderID!Header to update.
key String!Header key.
value String!Header value.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
header AuditEventsStreamingInstanceHeaderUpdates header.

Mutation.awardEmojiAdd

Input type: AwardEmojiAddInput

Arguments

NameTypeDescription
awardableId AwardableID!Global ID of the awardable resource.
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Emoji name.

Fields

NameTypeDescription
awardEmoji AwardEmojiEmoji reactions after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.awardEmojiRemove

Input type: AwardEmojiRemoveInput

Arguments

NameTypeDescription
awardableId AwardableID!Global ID of the awardable resource.
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Emoji name.

Fields

NameTypeDescription
awardEmoji AwardEmojiEmoji reactions after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.awardEmojiToggle

Input type: AwardEmojiToggleInput

Arguments

NameTypeDescription
awardableId AwardableID!Global ID of the awardable resource.
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Emoji name.

Fields

NameTypeDescription
awardEmoji AwardEmojiEmoji reactions after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
toggledOn Boolean!Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.

Mutation.boardEpicCreate

Input type: BoardEpicCreateInput

Arguments

NameTypeDescription
boardId BoardsEpicBoardID!Global ID of the board that the epic is in.
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath ID!Group the epic to create is in.
listId BoardsEpicListID!Global ID of the epic board list in which epic will be created.
title String!Title of the epic.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epic EpicEpic after creation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.boardListCreate

Input type: BoardListCreateInput

Arguments

NameTypeDescription
assigneeId UserIDGlobal ID of an existing user.
backlog BooleanCreate the backlog list.
boardId BoardID!Global ID of the issue board to mutate.
clientMutationId StringA unique identifier for the client performing the mutation.
iterationId IterationIDGlobal ID of an existing iteration.
labelId LabelIDGlobal ID of an existing label.
milestoneId MilestoneIDGlobal ID of an existing milestone.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
list BoardListIssue list in the issue board.

Mutation.boardListUpdateLimitMetrics

Input type: BoardListUpdateLimitMetricsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
limitMetric ListLimitMetricNew limit metric type for the list.
listId ListID!Global ID of the list.
maxIssueCount IntNew maximum issue count limit.
maxIssueWeight IntNew maximum issue weight limit.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
list BoardListUpdated list.

Mutation.buildForecast

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

Input type: BuildForecastInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
contextId GlobalID!Global ID of the context for the forecast to pick an appropriate model.
horizon Int!Number of data points to forecast.
type String!Type of the forecast.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
forecast Forecast!Created forecast.

Mutation.bulkDestroyJobArtifacts

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

Input type: BulkDestroyJobArtifactsInput

Arguments

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

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destroyedCount IntNumber of job artifacts deleted.
destroyedIds [CiJobArtifactID!]IDs of job artifacts that were deleted.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.bulkEnableDevopsAdoptionNamespaces

BETA This endpoint is subject to change without notice.

Input type: BulkEnableDevopsAdoptionNamespacesInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
displayNamespaceId NamespaceIDDisplay namespace ID.
namespaceIds [NamespaceID!]!List of Namespace IDs.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
enabledNamespaces [DevopsAdoptionEnabledNamespace!]Enabled namespaces after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.bulkRunnerDelete

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

Input type: BulkRunnerDeleteInput

Arguments

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

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
deletedCount IntNumber 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 execution of the mutation.

Mutation.catalogResourcesCreate

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