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

Find AI messages.

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

Returns AiCachedMessageTypeConnection!.

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 [AiCachedMessageRole!]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.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.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
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.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.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

Find runners visible to the current user.

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.
hasIssues BooleanReturns only the vulnerabilities which have linked issues.
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.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.
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.
markupFormat MarkupFormatIndicates the response format.
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 URL.
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.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 AwardEmojiAward emoji 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 AwardEmojiAward emoji 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 AwardEmojiAward emoji 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.

Input type: CatalogResourcesCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Project to convert to a catalog resource.

Fields

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

Mutation.ciAiGenerateConfig

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

Input type: CiAiGenerateConfigInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Project path for the project related to the open config editor.
userContent String!Content of the user message to be sent to the language model.

Fields

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

Mutation.ciJobTokenScopeAddProject

Input type: CiJobTokenScopeAddProjectInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
direction CiJobTokenScopeDirection Deprecated: Outbound job token scope is being removed. This field can now only be set to INBOUND. Deprecated in 16.0.
projectPath ID!Project that the CI job token scope belongs to.
targetProjectPath ID!Project to be added to the CI job token scope.

Fields

NameTypeDescription
ciJobTokenScope CiJobTokenScopeTypeCI job token’s access scope.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeRemoveProject

Input type: CiJobTokenScopeRemoveProjectInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
direction CiJobTokenScopeDirectionDirection of access, which defaults to outbound.
projectPath ID!Project that the CI job token scope belongs to.
targetProjectPath ID!Project to be removed from the CI job token scope.

Fields

NameTypeDescription
ciJobTokenScope CiJobTokenScopeTypeCI job token’s scope of access.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.clusterAgentDelete

Input type: ClusterAgentDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ClustersAgentID!Global ID of the cluster agent that will be deleted.

Fields

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

Mutation.clusterAgentTokenCreate

Input type: ClusterAgentTokenCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID!Global ID of the cluster agent that will be associated with the new token.
description StringDescription of the token.
name String!Name of the token.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
secret StringToken secret value. Make sure you save it - you won’t be able to access it again.
token ClusterAgentTokenToken created after mutation.

Mutation.clusterAgentTokenRevoke

Input type: ClusterAgentTokenRevokeInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ClustersAgentTokenID!Global ID of the agent token that will be revoked.

Fields

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

Mutation.commitCreate

Input type: CommitCreateInput

Arguments

NameTypeDescription
actions [CommitAction!]!Array of action hashes to commit as a batch.
branch String!Name of the branch to commit into, it can be a new branch.
clientMutationId StringA unique identifier for the client performing the mutation.
message String!Raw commit message.
projectPath ID!Project full path the branch is associated with.
startBranch StringIf on a new branch, name of the original branch.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
commit CommitCommit after mutation.
commitPipelinePath StringETag path for the commit’s pipeline.
content [String!]Contents of the commit.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.configureContainerScanning

Configure Container Scanning for a project by enabling Container Scanning 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 part of the response.

Input type: ConfigureContainerScanningInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

Mutation.configureDependencyScanning

Configure Dependency Scanning for a project by enabling Dependency Scanning 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: ConfigureDependencyScanningInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

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

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
configuration SastCiConfigurationInput!SAST CI configuration for the project.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

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

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

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

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
branch StringBranch that has the new/modified .gitlab-ci.yml file.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
successPath StringRedirect path to use when the response is successful.

Mutation.corpusCreate

Input type: CorpusCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Project the corpus belongs to.
packageId PackagesPackageID!ID of the corpus package.

Fields

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

Mutation.createAlertIssue

Input type: CreateAlertIssueInput

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

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

Input type: CreateAnnotationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
clusterId ClustersClusterIDGlobal ID of the cluster to add an annotation to.
dashboardPath String!Path to a file defining the dashboard on which the annotation should be added.
description String!Description of the annotation.
endingAt TimeTimestamp indicating ending moment to which the annotation relates.
environmentId EnvironmentIDGlobal ID of the environment to add an annotation to.
startingAt Time!Timestamp indicating starting moment to which the annotation relates.

Fields

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

Mutation.createBoard

Input type: CreateBoardInput

Arguments

NameTypeDescription
assigneeId UserIDID of user to be assigned to the board.
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath IDFull path of the group with which the resource is associated.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
iterationCadenceId IterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationId IterationIDID of iteration to be assigned to the board.
labelIds [LabelID!]IDs of labels to be added to the board.
labels [String!]Labels of the issue.
milestoneId MilestoneIDID of milestone to be assigned to the board.
name StringBoard name.
projectPath IDFull path of the project with which the resource is associated.
weight IntWeight value to be assigned to the board.

Fields

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

Mutation.createBranch

Input type: CreateBranchInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Name of the branch.
projectPath ID!Project full path the branch is associated with.
ref String!Branch name or commit SHA to create branch from.

Fields

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

Mutation.createClusterAgent

Input type: CreateClusterAgentInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Name of the cluster agent.
projectPath ID!Full path of the associated project for the cluster agent.

Fields

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

Mutation.createComplianceFramework

Input type: CreateComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
namespacePath ID!Full path of the namespace to add the compliance framework to.
params ComplianceFrameworkInput!Parameters to update the compliance framework with.

Fields

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

Mutation.createCustomEmoji

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

Input type: CreateCustomEmojiInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath ID!Namespace full path the emoji is associated with.
name String!Name of the emoji.
url String!Location of the emoji file.

Fields

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

Mutation.createDiffNote

Input type: CreateDiffNoteInput

Arguments

NameTypeDescription
body String!Content of the note.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
internal BooleanInternal flag for a note. Default is false.
noteableId NoteableID!Global ID of the resource to add a note to.
position DiffPositionInput!Position of this note on a diff.

Fields

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

Mutation.createEpic

Input type: CreateEpicInput

Arguments

NameTypeDescription
addLabelIds [ID!]IDs of labels to be added to the epic.
addLabels [String!]Array of labels to be added to the epic.
clientMutationId StringA unique identifier for the client performing the mutation.
color ColorColor of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
confidential BooleanIndicates if the epic is confidential.
description StringDescription of the epic.
dueDateFixed StringEnd date of the epic.
dueDateIsFixed BooleanIndicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath ID!Group the epic to mutate is in.
removeLabelIds [ID!]IDs of labels to be removed from the epic.
startDateFixed StringStart date of the epic.
startDateIsFixed BooleanIndicates start date should be sourced from start_date_fixed field not the issue milestones.
title StringTitle of the epic.

Fields

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

Mutation.createImageDiffNote

Input type: CreateImageDiffNoteInput

Arguments

NameTypeDescription
body String!Content of the note.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
internal BooleanInternal flag for a note. Default is false.
noteableId NoteableID!Global ID of the resource to add a note to.
position DiffImagePositionInput!Position of this note on a diff.

Fields

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

Mutation.createIssue

Input type: CreateIssueInput

Arguments

NameTypeDescription
assigneeIds [UserID!]Array of user IDs to assign to the issue.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential BooleanIndicates the issue is confidential.
createdAt TimeTimestamp when the issue was created. Available only for admins and project owners.
description StringDescription of the issue.
discussionToResolve StringID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of.
dueDate ISO8601DateDue date of the issue.
epicId EpicIDID of an epic to associate the issue with.
healthStatus HealthStatusDesired health status.
iid IntIID (internal ID) of a project issue. Only admins and project owners can modify.
iterationCadenceId IterationsCadenceIDGlobal iteration cadence ID. Required when iterationWildcardId is provided.
iterationId IterationIDGlobal iteration ID. Mutually exlusive argument with iterationWildcardId.
iterationWildcardId IssueCreationIterationWildcardIdIteration wildcard ID. Supported values are: CURRENT. Mutually exclusive argument with iterationId. iterationCadenceId also required when this argument is provided.
labelIds [LabelID!]IDs of labels to be added to the issue.
labels [String!]Labels of the issue.
locked BooleanIndicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOf MergeRequestIDIID of a merge request for which to resolve discussions.
milestoneId MilestoneIDID of the milestone to assign to the issue. On update milestone will be removed if set to null.
moveAfterId IssueIDGlobal ID of issue that should be placed after the current issue.
moveBeforeId IssueIDGlobal ID of issue that should be placed before the current issue.
projectPath ID!Project full path the issue is associated with.
title String!Title of the issue.
type IssueTypeType of the issue.
weight IntWeight of the issue.

Fields

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

Mutation.createIteration

caution
Deprecated in 14.0. Use iterationCreate.

Input type: CreateIterationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration.
dueDate StringEnd date of the iteration.
groupPath IDFull path of the group with which the resource is associated.
iterationsCadenceId IterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPath IDFull path of the project with which the resource is associated.
startDate StringStart date of the iteration.
title StringTitle of the iteration.

Fields

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

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

Arguments

NameTypeDescription
body String!Content of the note.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean Deprecated: This was renamed. Please use internal. Deprecated in 15.3.
discussionId DiscussionIDGlobal ID of the discussion the note is in reply to.
internal BooleanInternal flag for a note. Default is false.
mergeRequestDiffHeadSha StringSHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent.
noteableId NoteableID!Global ID of the resource to add a note to.

Fields

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

Mutation.createRequirement

Input type: CreateRequirementInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the requirement.
projectPath ID!Full project path the requirement is associated with.
title StringTitle of the requirement.

Fields

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

Mutation.createSnippet

Input type: CreateSnippetInput

Arguments

NameTypeDescription
blobActions [SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the snippet.
projectPath IDFull path of the project the snippet is associated with.
title String!Title of the snippet.
uploadedFiles [String!]Paths to files uploaded in the snippet description.
visibilityLevel VisibilityLevelsEnum!Visibility level of the snippet.

Fields

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

Mutation.createTestCase

Input type: CreateTestCaseInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringTest case description.
labelIds [ID!]IDs of labels to be added to the test case.
projectPath ID!Project full path to create the test case in.
title String!Test case title.

Fields

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

Mutation.customerRelationsContactCreate

Input type: CustomerRelationsContactCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of or notes for the contact.
email StringEmail address of the contact.
firstName String!First name of the contact.
groupId GroupID!Group for the contact.
lastName String!Last name of the contact.
organizationId CustomerRelationsOrganizationIDOrganization for the contact.
phone StringPhone number of the contact.

Fields

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

Mutation.customerRelationsContactUpdate

Input type: CustomerRelationsContactUpdateInput

Arguments

NameTypeDescription
active BooleanState of the contact.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of or notes for the contact.
email StringEmail address of the contact.
firstName StringFirst name of the contact.
id CustomerRelationsContactID!Global ID of the contact.
lastName StringLast name of the contact.
organizationId CustomerRelationsOrganizationIDOrganization of the contact.
phone StringPhone number of the contact.

Fields

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

Mutation.customerRelationsOrganizationCreate

Input type: CustomerRelationsOrganizationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
defaultRate FloatStandard billing rate for the organization.
description StringDescription of or notes for the organization.
groupId GroupID!Group for the organization.
name String!Name of the organization.

Fields

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

Mutation.customerRelationsOrganizationUpdate

Input type: CustomerRelationsOrganizationUpdateInput

Arguments

NameTypeDescription
active BooleanState of the organization.
clientMutationId StringA unique identifier for the client performing the mutation.
defaultRate FloatStandard billing rate for the organization.
description StringDescription of or notes for the organization.
id CustomerRelationsOrganizationID!Global ID of the organization.
name StringName of the organization.

Fields

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

Mutation.dastOnDemandScanCreate

Input type: DastOnDemandScanCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastScannerProfileId DastScannerProfileIDID of the scanner profile to be used for the scan.
dastSiteProfileId DastSiteProfileID!ID of the site profile to be used for the scan.
fullPath ID!Project the site profile belongs to.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
pipelineUrl StringURL of the pipeline that was created.

Mutation.dastProfileCreate

Input type: DastProfileCreateInput

Arguments

NameTypeDescription
branchName StringAssociated branch.
clientMutationId StringA unique identifier for the client performing the mutation.
dastProfileSchedule DastProfileScheduleInputRepresents a DAST Profile Schedule.
dastScannerProfileId DastScannerProfileID!ID of the scanner profile to be associated.
dastSiteProfileId DastSiteProfileID!ID of the site profile to be associated.
description StringDescription of the profile. Defaults to an empty string.
fullPath ID!Project the profile belongs to.
name String!Name of the profile.
runAfterCreate BooleanRun scan using profile after creation. Defaults to false.
tagList [String!]Indicates the runner tags associated with the profile.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastProfile DastProfileCreated profile.
errors [String!]!Errors encountered during execution of the mutation.
pipelineUrl StringURL of the pipeline that was created. Requires runAfterCreate to be set to true.

Mutation.dastProfileDelete

Input type: DastProfileDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id DastProfileID!ID of the profile to be deleted.

Fields

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

Mutation.dastProfileRun

Input type: DastProfileRunInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastProfileID!ID of the profile to be used for the scan.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
pipelineUrl StringURL of the pipeline that was created.

Mutation.dastProfileUpdate

Input type: DastProfileUpdateInput

Arguments

NameTypeDescription
branchName StringAssociated branch.
clientMutationId StringA unique identifier for the client performing the mutation.
dastProfileSchedule DastProfileScheduleInputRepresents a DAST profile schedule.
dastScannerProfileId DastScannerProfileIDID of the scanner profile to be associated.
dastSiteProfileId DastSiteProfileIDID of the site profile to be associated.
description StringDescription of the profile. Defaults to an empty string.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastProfileID!ID of the profile to be deleted.
name StringName of the profile.
runAfterUpdate BooleanRun scan using profile after update. Defaults to false.
tagList [String!]Indicates the runner tags associated with the profile.

Fields

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

Mutation.dastScannerProfileCreate

Input type: DastScannerProfileCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Project the scanner profile belongs to.
profileName String!Name of the scanner profile.
scanType DastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages BooleanIndicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout IntMaximum number of minutes allowed for the spider to traverse the site.
tagList [String!] Deprecated: Moved to DastProfile. Deprecated in 15.8.
targetTimeout IntMaximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider BooleanIndicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastScannerProfile DastScannerProfileCreated scanner profile.
errors [String!]!Errors encountered during execution of the mutation.
id DastScannerProfileID Deprecated: use dastScannerProfile field. Deprecated in 14.10.

Mutation.dastScannerProfileDelete

Input type: DastScannerProfileDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastScannerProfileID!ID of the scanner profile to be deleted.

Fields

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

Mutation.dastScannerProfileUpdate

Input type: DastScannerProfileUpdateInput

Arguments

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

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastScannerProfile DastScannerProfileUpdated scanner profile.
errors [String!]!Errors encountered during execution of the mutation.
id DastScannerProfileID Deprecated: use dastScannerProfile field. Deprecated in 14.10.

Mutation.dastSiteProfileCreate

Input type: DastSiteProfileCreateInput

Arguments

NameTypeDescription
auth DastSiteProfileAuthInputParameters for authentication.
clientMutationId StringA unique identifier for the client performing the mutation.
excludedUrls [String!]URLs to skip during an authenticated scan. Defaults to [].
fullPath ID!Project the site profile belongs to.
profileName String!Name of the site profile.
requestHeaders StringComma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath StringFile Path or URL used as input for the scan method.
scanMethod DastScanMethodTypeScan method by the scanner.
targetType DastTargetTypeEnumType of target to be scanned.
targetUrl StringURL of the target to be scanned.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastSiteProfile DastSiteProfileSite Profile object.
errors [String!]!Errors encountered during execution of the mutation.
id DastSiteProfileID Deprecated: use dastSiteProfile.id field. Deprecated in 14.10.

Mutation.dastSiteProfileDelete

Input type: DastSiteProfileDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastSiteProfileID!ID of the site profile to be deleted.

Fields

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

Mutation.dastSiteProfileUpdate

Input type: DastSiteProfileUpdateInput

Arguments

NameTypeDescription
auth DastSiteProfileAuthInputParameters for authentication.
clientMutationId StringA unique identifier for the client performing the mutation.
excludedUrls [String!]URLs to skip during an authenticated scan.
fullPath ID Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5.
id DastSiteProfileID!ID of the site profile to be updated.
profileName String!Name of the site profile.
requestHeaders StringComma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath StringFile Path or URL used as input for the scan method.
scanMethod DastScanMethodTypeScan method by the scanner.
targetType DastTargetTypeEnumType of target to be scanned.
targetUrl StringURL of the target to be scanned.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastSiteProfile DastSiteProfileSite profile object.
errors [String!]!Errors encountered during execution of the mutation.
id DastSiteProfileID Deprecated: use dastSiteProfile.id field. Deprecated in 14.10.

Mutation.dastSiteTokenCreate

Input type: DastSiteTokenCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Project the site token belongs to.
targetUrl StringURL of the target to be validated.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
id DastSiteTokenIDID of the site token.
status DastSiteProfileValidationStatusEnumCurrent validation status of the target.
token StringToken string.

Mutation.dastSiteValidationCreate

Input type: DastSiteValidationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dastSiteTokenId DastSiteTokenID!ID of the site token.
fullPath ID!Project the site profile belongs to.
strategy DastSiteValidationStrategyEnumValidation strategy to be used.
validationPath String!Path to be requested during validation.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
id DastSiteValidationIDID of the site validation.
status DastSiteProfileValidationStatusEnumCurrent validation status.

Mutation.dastSiteValidationRevoke

Input type: DastSiteValidationRevokeInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Project the site validation belongs to.
normalizedTargetUrl String!Normalized URL of the target to be revoked.

Fields

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

Mutation.deleteAnnotation

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

Input type: DeleteAnnotationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id MetricsDashboardAnnotationID!Global ID of the annotation to delete.

Fields

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

Mutation.designManagementDelete

Input type: DesignManagementDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
filenames [String!]!Filenames of the designs to delete.
iid ID!IID of the issue to modify designs for.
projectPath ID!Project where the issue is to upload designs for.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
version DesignVersionNew version in which the designs are deleted.

Mutation.designManagementMove

Input type: DesignManagementMoveInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id DesignManagementDesignID!ID of the design to move.
next DesignManagementDesignIDID of the immediately following design.
previous DesignManagementDesignIDID of the immediately preceding design.

Fields

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

Mutation.designManagementUpdate

Input type: DesignManagementUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the design.
id DesignManagementDesignID!ID of the design to update.

Fields

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

Mutation.designManagementUpload

Input type: DesignManagementUploadInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
files [Upload!]!Files to upload.
iid ID!IID of the issue to modify designs for.
projectPath ID!Project where the issue is to upload designs for.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
designs [Design!]!Designs that were uploaded by the mutation.
errors [String!]!Errors encountered during execution of 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.

Mutation.destroyBoard

Input type: DestroyBoardInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id BoardID!Global ID of the board to destroy.

Fields

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

Mutation.destroyBoardList

Input type: DestroyBoardListInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
listId ListID!Global ID of the list to destroy. Only label lists are accepted.

Fields

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

Mutation.destroyComplianceFramework

Input type: DestroyComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ComplianceManagementFrameworkID!Global ID of the compliance framework to destroy.

Fields

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

Mutation.destroyContainerRepository

Input type: DestroyContainerRepositoryInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ContainerRepositoryID!ID of the container repository.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
containerRepository ContainerRepository!Container repository policy after scheduling the deletion.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.destroyContainerRepositoryTags

Input type: DestroyContainerRepositoryTagsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ContainerRepositoryID!ID of the container repository.
tagNames [String!]!Container repository tag(s) to delete. Total number can’t be greater than 20.

Fields

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

Mutation.destroyCustomEmoji

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

Input type: DestroyCustomEmojiInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CustomEmojiID!Global ID of the custom emoji to destroy.

Fields

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

Mutation.destroyEpicBoard

Input type: DestroyEpicBoardInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id BoardsEpicBoardID!Global ID of the board to destroy.

Fields

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

Mutation.destroyNote

Input type: DestroyNoteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id NoteID!Global ID of the note to destroy.

Fields

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

Mutation.destroyPackage

Input type: DestroyPackageInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id PackagesPackageID!ID of the Package.

Fields

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

Mutation.destroyPackageFile

Input type: DestroyPackageFileInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id PackagesPackageFileID!ID of the Package file.

Fields

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

Mutation.destroyPackageFiles

Input type: DestroyPackageFilesInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
ids [PackagesPackageFileID!]!IDs of the Package file.
projectPath ID!Project path where the packages cleanup policy is located.

Fields

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

Mutation.destroyPackages

Input type: DestroyPackagesInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
ids [PackagesPackageID!]!Global IDs of the Packages. Max 20.

Fields

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

Mutation.destroySnippet

Input type: DestroySnippetInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id SnippetID!Global ID of the snippet to destroy.

Fields

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

Mutation.disableDevopsAdoptionNamespace

BETA This endpoint is subject to change without notice.

Input type: DisableDevopsAdoptionNamespaceInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id [AnalyticsDevopsAdoptionEnabledNamespaceID!]!One or many IDs of the enabled namespaces to disable.

Fields

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

Mutation.discussionToggleResolve

Toggles the resolved state of a discussion.

Input type: DiscussionToggleResolveInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id DiscussionID!Global ID of the discussion.
resolve Boolean!Will resolve the discussion when true, and unresolve the discussion when false.

Fields

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

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

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]Errors to return to the user.
messages [String!]Messages to return to the user.

Fields

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

Mutation.enableDevopsAdoptionNamespace

BETA This endpoint is subject to change without notice.

Input type: EnableDevopsAdoptionNamespaceInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
displayNamespaceId NamespaceIDDisplay namespace ID.
namespaceId NamespaceID!Namespace ID.

Fields

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

Mutation.environmentCreate

Create an environment.

Input type: EnvironmentCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentIDCluster agent of the environment.
externalUrl StringExternal URL of the environment.
kubernetesNamespace StringKubernetes namespace of the environment.
name String!Name of the environment.
projectPath ID!Full path of the project.
tier DeploymentTierTier of the environment.

Fields

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

Mutation.environmentDelete

Delete an environment.

Input type: EnvironmentDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id EnvironmentID!Global ID of the environment to Delete.

Fields

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

Mutation.environmentStop

Stop an environment.

Input type: EnvironmentStopInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
force BooleanForce environment to stop without executing on_stop actions.
id EnvironmentID!Global ID of the environment to stop.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
environment EnvironmentEnvironment after attempt to stop.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.environmentUpdate

Update an environment.

Input type: EnvironmentUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentIDCluster agent of the environment.
externalUrl StringExternal URL of the environment.
id EnvironmentID!Global ID of the environment to update.
kubernetesNamespace StringKubernetes namespace of the environment.
tier DeploymentTierTier of the environment.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
environment EnvironmentEnvironment after attempt to update.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.environmentsCanaryIngressUpdate

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

Input type: EnvironmentsCanaryIngressUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id EnvironmentID!Global ID of the environment to update.
weight Int!Weight of the Canary Ingress.

Fields

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

Mutation.epicAddIssue

Input type: EpicAddIssueInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath ID!Group the epic to mutate belongs to.
iid ID!IID of the epic to mutate.
issueIid String!IID of the issue to be added.
projectPath ID!Full path of the project the issue belongs to.

Fields

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

Mutation.epicBoardCreate

Input type: EpicBoardCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
displayColors BooleanWhether or not display epic colors. Ignored unless epic_color_highlight flag is enabled.
groupPath IDFull path of the group with which the resource is associated.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
labelIds [LabelID!]IDs of labels to be added to the board.
labels [String!]Labels of the issue.
name StringBoard name.

Fields

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

Mutation.epicBoardListCreate

Input type: EpicBoardListCreateInput

Arguments

NameTypeDescription
backlog BooleanCreate the backlog list.
boardId BoardsEpicBoardID!Global ID of the issue board to mutate.
clientMutationId StringA unique identifier for the client performing the mutation.
labelId LabelIDGlobal ID of an existing label.

Fields

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

Mutation.epicBoardListDestroy

Destroys an epic board list.

Input type: EpicBoardListDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
listId BoardsEpicListID!Global ID of the epic board list to destroy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
list EpicListEpic board list. null if the board was destroyed successfully.

Mutation.epicBoardUpdate

Input type: EpicBoardUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
displayColors BooleanWhether or not display epic colors. Ignored unless epic_color_highlight flag is enabled.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
id BoardsEpicBoardID!Epic board global ID.
labelIds [LabelID!]IDs of labels to be added to the board.
labels [String!]Labels of the issue.
name StringBoard name.

Fields

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

Mutation.epicMoveList

Input type: EpicMoveListInput

Arguments

NameTypeDescription
boardId BoardsEpicBoardID!Global ID of the board that the epic is in.
clientMutationId StringA unique identifier for the client performing the mutation.
epicId EpicID!ID of the epic to mutate.
fromListId BoardsEpicListIDID of the board list that the epic will be moved from. Required if moving between lists.
moveAfterId EpicIDID of epic that should be placed after the current epic.
moveBeforeId EpicIDID of epic that should be placed before the current epic.
positionInList IntPosition of epics within the board list. Positions start at 0. Use -1 to move to the end of the list.
toListId BoardsEpicListID!ID of the list the epic will be in after mutation.

Fields

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

Mutation.epicSetSubscription

Input type: EpicSetSubscriptionInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath ID!Group the epic to mutate belongs to.
iid ID!IID of the epic to mutate.
subscribedState Boolean!Desired state of the subscription.

Fields

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

Mutation.epicTreeReorder

Input type: EpicTreeReorderInput

Arguments

NameTypeDescription
baseEpicId EpicID!ID of the base epic of the tree.
clientMutationId StringA unique identifier for the client performing the mutation.
moved EpicTreeNodeFieldsInputType!Parameters for updating the tree positions.

Fields

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

Mutation.escalationPolicyCreate

Input type: EscalationPolicyCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the escalation policy.
name String!Name of the escalation policy.
projectPath ID!Project to create the escalation policy for.
rules [EscalationRuleInput!]!Steps of the escalation policy.

Fields

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

Mutation.escalationPolicyDestroy

Input type: EscalationPolicyDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IncidentManagementEscalationPolicyID!Escalation policy internal ID to remove.

Fields

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

Mutation.escalationPolicyUpdate

Input type: EscalationPolicyUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the escalation policy.
id IncidentManagementEscalationPolicyID!ID of the on-call schedule to create the on-call rotation in.
name StringName of the escalation policy.
rules [EscalationRuleInput!]Steps of the escalation policy.

Fields

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

Mutation.exportRequirements

Input type: ExportRequirementsInput

Arguments

NameTypeDescription
authorUsername [String!]Filter requirements by author username.
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full project path the requirements are associated with.
search StringSearch query for requirement title.
selectedFields [String!]List of selected requirements fields to be exported.
sort SortList requirements by sort order.
state RequirementStateFilter requirements by state.

Fields

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

Mutation.externalAuditEventDestinationCreate

Input type: ExternalAuditEventDestinationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationUrl String!Destination URL.
groupPath ID!Group path.
name StringDestination name.
verificationToken StringVerification token.

Fields

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

Mutation.externalAuditEventDestinationDestroy

Input type: ExternalAuditEventDestinationDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id AuditEventsExternalAuditEventDestinationID!ID of external audit event destination to destroy.

Fields

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

Mutation.externalAuditEventDestinationUpdate

Input type: ExternalAuditEventDestinationUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationUrl StringDestination URL to change.
id AuditEventsExternalAuditEventDestinationID!ID of external audit event destination to update.
name StringDestination name.

Fields

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

Mutation.geoRegistriesUpdate

Mutates a Geo registry. Does not mutate the registry entry if geo_registries_update_mutation feature flag is disabled.

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

Input type: GeoRegistriesUpdateInput

Arguments

NameTypeDescription
action GeoRegistryAction!Action to be executed on a Geo registry.
clientMutationId StringA unique identifier for the client performing the mutation.
registryClass GeoRegistryClass!Class of the Geo registry to be updated.
registryId GeoBaseRegistryID!ID of the Geo registry entry to be updated.

Fields

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

Mutation.gitlabSubscriptionActivate

Input type: GitlabSubscriptionActivateInput

Arguments

NameTypeDescription
activationCode String!Activation code received after purchasing a GitLab subscription.
clientMutationId StringA unique identifier for the client performing the mutation.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
futureSubscriptions [SubscriptionFutureEntry!]Array of future subscriptions.
license CurrentLicenseCurrent license.

Mutation.googleCloudLoggingConfigurationCreate

Input type: GoogleCloudLoggingConfigurationCreateInput

Arguments

NameTypeDescription
clientEmail String!Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationId StringA unique identifier for the client performing the mutation.
googleProjectIdName String!Unique identifier of the Google Cloud project to which the logging configuration belongs.
groupPath ID!Group path.
logIdName StringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events).
privateKey String!Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

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

Mutation.googleCloudLoggingConfigurationDestroy

Input type: GoogleCloudLoggingConfigurationDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id AuditEventsGoogleCloudLoggingConfigurationID!ID of the Google Cloud logging configuration to destroy.

Fields

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

Mutation.googleCloudLoggingConfigurationUpdate

Input type: GoogleCloudLoggingConfigurationUpdateInput

Arguments

NameTypeDescription
clientEmail StringEmail 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.
clientMutationId StringA unique identifier for the client performing the mutation.
googleProjectIdName StringUnique identifier of the Google Cloud project to which the logging configuration belongs.
id AuditEventsGoogleCloudLoggingConfigurationID!ID of the google Cloud configuration to update.
logIdName StringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.
privateKey StringPrivate Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

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

Mutation.groupMemberBulkUpdate

Input type: GroupMemberBulkUpdateInput

Arguments

NameTypeDescription
accessLevel MemberAccessLevel!Access level to update the members to.
clientMutationId StringA unique identifier for the client performing the mutation.
expiresAt TimeDate and time the membership expires.
groupId GroupID!Global ID of the group.
userIds [UserID!]!Global IDs of the members.

Fields

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

Mutation.groupUpdate

Input type: GroupUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Full path of the group that will be updated.
sharedRunnersSetting SharedRunnersSetting!Shared runners availability for the namespace and its descendants.

Fields

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

Mutation.httpIntegrationCreate

Input type: HttpIntegrationCreateInput

Arguments

NameTypeDescription
active Boolean!Whether the integration is receiving alerts.
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Name of the integration.
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonStringExample of an alert payload.
projectPath ID!Project to create the integration in.

Fields

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

Mutation.httpIntegrationDestroy

Input type: HttpIntegrationDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID!ID of the integration to remove.

Fields

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

Mutation.httpIntegrationResetToken

Input type: HttpIntegrationResetTokenInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID!ID of the integration to mutate.

Fields

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

Mutation.httpIntegrationUpdate

Input type: HttpIntegrationUpdateInput

Arguments

NameTypeDescription
active BooleanWhether the integration is receiving alerts.
clientMutationId StringA unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID!ID of the integration to mutate.
name StringName of the integration.
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonStringExample of an alert payload.

Fields

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

Mutation.instanceExternalAuditEventDestinationCreate

Input type: InstanceExternalAuditEventDestinationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationUrl String!Destination URL.
name StringDestination name.

Fields

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

Mutation.instanceExternalAuditEventDestinationDestroy

Input type: InstanceExternalAuditEventDestinationDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id AuditEventsInstanceExternalAuditEventDestinationID!ID of the external instance audit event destination to destroy.

Fields

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

Mutation.instanceExternalAuditEventDestinationUpdate

Input type: InstanceExternalAuditEventDestinationUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destinationUrl StringDestination URL to change.
id AuditEventsInstanceExternalAuditEventDestinationID!ID of the external instance audit event destination to update.
name StringDestination name.

Fields

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

Mutation.issuableResourceLinkCreate

Input type: IssuableResourceLinkCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IssueID!Incident id to associate the resource link with.
link String!Link of the resource.
linkText StringLink text of the resource.
linkType IssuableResourceLinkTypeLink type of the resource.

Fields

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

Mutation.issuableResourceLinkDestroy

Input type: IssuableResourceLinkDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IncidentManagementIssuableResourceLinkID!Issuable resource link ID to remove.

Fields

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

Mutation.issueLinkAlerts

Input type: IssueLinkAlertsInput

Arguments

NameTypeDescription
alertReferences [String!]!Alerts references to be linked to the incident.
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issueMove

Input type: IssueMoveInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
targetProjectPath ID!Project to move the issue to.

Fields

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

Mutation.issueMoveList

Input type: IssueMoveListInput

Arguments

NameTypeDescription
boardId BoardID!Global ID of the board that the issue is in.
clientMutationId StringA unique identifier for the client performing the mutation.
epicId EpicIDID of the parent epic. NULL when removing the association.
fromListId IDID of the board list that the issue will be moved from.
iid String!IID of the issue to mutate.
moveAfterId IDID of issue that should be placed after the current issue.
moveBeforeId IDID of issue that should be placed before the current issue.
positionInList IntPosition of issue within the board list. Positions start at 0. Use -1 to move to the end of the list.
projectPath ID!Project the issue to mutate is in.
toListId IDID of the board list that the issue will be moved to.

Fields

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

Mutation.issueSetAssignees

Input type: IssueSetAssigneesInput

Arguments

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

Fields

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

Mutation.issueSetConfidential

Input type: IssueSetConfidentialInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean!Whether or not to set the issue as a confidential.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issueSetCrmContacts

Input type: IssueSetCrmContactsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
contactIds [CustomerRelationsContactID!]!Customer relations contact IDs to set. Replaces existing contacts by default.
iid String!IID of the issue to mutate.
operationMode MutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issueSetDueDate

Input type: IssueSetDueDateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dueDate TimeDesired due date for the issue. Due date is removed if null.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issueSetEpic

Input type: IssueSetEpicInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epicId EpicIDGlobal ID of the epic to be assigned to the issue, epic will be removed if absent or set to null.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issueSetEscalationPolicy

Input type: IssueSetEscalationPolicyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
escalationPolicyId IncidentManagementEscalationPolicyIDGlobal ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issueSetEscalationStatus

Input type: IssueSetEscalationStatusInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
status IssueEscalationStatus!Set the escalation status.

Fields

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

Mutation.issueSetIteration

Input type: IssueSetIterationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
iterationId IterationIDIteration to assign to the issue.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issueSetLocked

Input type: IssueSetLockedInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
locked Boolean!Whether or not to lock discussion on the issue.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issueSetSeverity

Input type: IssueSetSeverityInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
severity IssuableSeverity!Set the incident severity level.

Fields

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

Mutation.issueSetSubscription

Input type: IssueSetSubscriptionInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
subscribedState Boolean!Desired state of the subscription.

Fields

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

Mutation.issueSetWeight

Input type: IssueSetWeightInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.
weight IntThe desired weight for the issue. If set to null, weight is removed.

Fields

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

Mutation.issueUnlinkAlert

Input type: IssueUnlinkAlertInput

Arguments

NameTypeDescription
alertId AlertManagementAlertID!Global ID of the alert to unlink from the incident.
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.issuesBulkUpdate

Allows updating several properties for a set of issues. Does nothing if the bulk_update_issues_mutation feature flag is disabled.

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

Input type: IssuesBulkUpdateInput

Arguments

NameTypeDescription
addLabelIds [LabelID!]Global ID array of the labels that will be added to the issues.
assigneeIds [UserID!]Global ID array of the users that will be assigned to the given issues. Existing assignees will be replaced with the ones on this list.
clientMutationId StringA unique identifier for the client performing the mutation.
epicId EpicIDGlobal ID of the epic that will be assigned to the issues.
healthStatus HealthStatusHealth status that will be assigned to the issues.
ids [IssueID!]!Global ID array of the issues that will be updated. IDs that the user can’t update will be ignored. A max of 100 can be provided.
iterationId IterationIDGlobal ID of the iteration that will be assigned to the issues.
milestoneId MilestoneIDGlobal ID of the milestone that will be assigned to the issues.
parentId IssueParentID!Global ID of the parent to which the bulk update will be scoped. The parent can be a project or a group . Example IssueParentID are "gid://gitlab/Project/1" and "gid://gitlab/Group/1".
removeLabelIds [LabelID!]Global ID array of the labels that will be removed from the issues.
stateEvent IssueStateEventClose or reopen an issue.
subscriptionEvent IssuableSubscriptionEventSubscribe to or unsubscribe from issue notifications.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
updatedIssueCount IntNumber of issues that were successfully updated.

Mutation.iterationCadenceCreate

Input type: IterationCadenceCreateInput

Arguments

NameTypeDescription
active Boolean!Whether the iteration cadence is active.
automatic Boolean!Whether the iteration cadence should automatically generate upcoming iterations.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks IntDuration in weeks of the iterations within this cadence.
groupPath ID!Group where the iteration cadence is created.
iterationsInAdvance IntUpcoming iterations to be created when iteration cadence is set to automatic.
rollOver BooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDate TimeTimestamp of the automation start date.
title StringTitle of the iteration cadence.

Fields

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

Mutation.iterationCadenceDestroy

Input type: IterationCadenceDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IterationsCadenceID!Global ID of the iteration cadence.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
group Group!Group the iteration cadence belongs to.

Mutation.iterationCadenceUpdate

Input type: IterationCadenceUpdateInput

Arguments

NameTypeDescription
active BooleanWhether the iteration cadence is active.
automatic BooleanWhether the iteration cadence should automatically generate upcoming iterations.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks IntDuration in weeks of the iterations within this cadence.
id IterationsCadenceID!Global ID of the iteration cadence.
iterationsInAdvance IntUpcoming iterations to be created when iteration cadence is set to automatic.
rollOver BooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDate TimeTimestamp of the automation start date.
title StringTitle of the iteration cadence.

Fields

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

Mutation.iterationCreate

Input type: iterationCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration.
dueDate StringEnd date of the iteration.
groupPath IDFull path of the group with which the resource is associated.
iterationsCadenceId IterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPath IDFull path of the project with which the resource is associated.
startDate StringStart date of the iteration.
title StringTitle of the iteration.

Fields

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

Mutation.iterationDelete

Input type: IterationDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IterationID!ID of the iteration.

Fields

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

Mutation.jiraImportStart

Input type: JiraImportStartInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
jiraProjectKey String!Project key of the importer Jira project.
jiraProjectName StringProject name of the importer Jira project.
projectPath ID!Project to import the Jira project into.
usersMapping [JiraUsersMappingInputType!]Mapping of Jira to GitLab users.

Fields

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

Mutation.jiraImportUsers

Input type: JiraImportUsersInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Project to import the Jira users into.
startAt IntIndex of the record the import should started at, default 0 (50 records returned).

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
jiraUsers [JiraUser!]Users returned from Jira, matched by email and name if possible.

Mutation.jobArtifactsDestroy

Input type: JobArtifactsDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiBuildID!ID of the job to mutate.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
destroyedArtifactsCount Int!Number of artifacts deleted.
errors [String!]!Errors encountered during execution of the mutation.
job CiJobJob with artifacts to be deleted.

Mutation.jobCancel

Input type: JobCancelInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiBuildID!ID of the job to mutate.

Fields

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

Mutation.jobPlay

Input type: JobPlayInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiBuildID!ID of the job to mutate.
variables [CiVariableInput!]Variables to use when playing a manual job.

Fields

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

Mutation.jobRetry

Input type: JobRetryInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiBuildID!ID of the job to mutate.
variables [CiVariableInput!]Variables to use when retrying a manual job.

Fields

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

Mutation.jobUnschedule

Input type: JobUnscheduleInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiBuildID!ID of the job to mutate.

Fields

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

Mutation.labelCreate

Input type: LabelCreateInput

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.
description StringDescription of the label.
groupPath IDFull path of the group with which the resource is associated.
projectPath IDFull path of the project with which the resource is associated.
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.markAsSpamSnippet

Input type: MarkAsSpamSnippetInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id SnippetID!Global ID of the snippet to update.

Fields

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

Mutation.mergeRequestAccept

Accepts a merge request. When accepted, the source branch will be merged into the target branch, either immediately if possible, or using one of the automatic merge strategies.

Input type: MergeRequestAcceptInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
commitMessage StringCustom merge commit message.
iid String!IID of the merge request to mutate.
projectPath ID!Project the merge request to mutate is in.
sha String!HEAD SHA at the time when the merge was requested.
shouldRemoveSourceBranch BooleanShould the source branch be removed.
squash BooleanSquash commits on the source branch before merge.
squashCommitMessage StringCustom squash commit message (if squash is true).
strategy MergeStrategyEnumHow to merge the merge request.

Fields

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

Mutation.mergeRequestCreate

Input type: MergeRequestCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the merge request (Markdown rendered as HTML for caching).
labels [String!]Labels of the merge request.
projectPath ID!Project full path the merge request is associated with.
sourceBranch String!Source branch of the merge request.
targetBranch String!Target branch of the merge request.
title String!Title of the merge request.

Fields

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

Mutation.mergeRequestReviewerRereview

Input type: MergeRequestReviewerRereviewInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the merge request to mutate.
projectPath ID!Project the merge request to mutate is in.
userId UserID!User ID for the user that has been requested for a new review.

Fields

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

Mutation.mergeRequestSetAssignees

Input type: MergeRequestSetAssigneesInput

Arguments

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

Fields

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

Mutation.mergeRequestSetDraft

Input type: MergeRequestSetDraftInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
draft Boolean!Whether or not to set the merge request as a draft.
iid String!IID of the merge request to mutate.
projectPath ID!Project the merge request to mutate is in.

Fields

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

Mutation.mergeRequestSetLabels

Input type: MergeRequestSetLabelsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the merge request to mutate.
labelIds [LabelID!]!Label IDs to set. Replaces existing labels by default.
operationMode MutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPath ID!Project the merge request to mutate is in.

Fields

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

Mutation.mergeRequestSetLocked

Input type: MergeRequestSetLockedInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the merge request to mutate.
locked Boolean!Whether or not to lock the merge request.
projectPath ID!Project the merge request to mutate is in.

Fields

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

Mutation.mergeRequestSetMilestone

Input type: MergeRequestSetMilestoneInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the merge request to mutate.
milestoneId MilestoneIDMilestone to assign to the merge request.
projectPath ID!Project the merge request to mutate is in.

Fields

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

Mutation.mergeRequestSetReviewers

Input type: MergeRequestSetReviewersInput

Arguments

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

Fields

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

Mutation.mergeRequestSetSubscription

Input type: MergeRequestSetSubscriptionInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!IID of the merge request to mutate.
projectPath ID!Project the merge request to mutate is in.
subscribedState Boolean!Desired state of the subscription.

Fields

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

Mutation.mergeRequestUpdate

Update attributes of a merge request.

Input type: MergeRequestUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the merge request (Markdown rendered as HTML for caching).
iid String!IID of the merge request to mutate.
projectPath ID!Project the merge request to mutate is in.
state MergeRequestNewStateAction to perform to change the state.
targetBranch StringTarget branch of the merge request.
timeEstimate StringEstimated time to complete the merge request, or 0 to remove the current estimate.
title StringTitle of the merge request.

Fields

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

Mutation.mergeRequestUpdateApprovalRule

Input type: MergeRequestUpdateApprovalRuleInput

Arguments

NameTypeDescription
approvalRuleId Int!ID of an approval rule.
approvalsRequired Int!Number of required approvals for a given rule.
clientMutationId StringA unique identifier for the client performing the mutation.
groupIds [String!]IDs of groups as approvers.
iid String!IID of the merge request to mutate.
name String!Name of the approval rule.
projectPath ID!Project the merge request to mutate is in.
removeHiddenGroups BooleanWhether hidden groups should be removed.
userIds [String!]IDs of users as approvers.

Fields

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

Mutation.namespaceBanDestroy

Input type: NamespaceBanDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id NamespacesNamespaceBanID!Global ID of the namespace ban to remove.

Fields

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

Mutation.namespaceCiCdSettingsUpdate

Input type: NamespaceCiCdSettingsUpdateInput

Arguments

NameTypeDescription
allowStaleRunnerPruning BooleanIndicates if stale runners directly belonging to this namespace should be periodically pruned.
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Full path of the namespace the settings belong to.

Fields

NameTypeDescription
ciCdSettings NamespaceCiCdSetting!CI/CD settings after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.namespaceIncreaseStorageTemporarily

Input type: NamespaceIncreaseStorageTemporarilyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id NamespaceID!Global ID of the namespace to mutate.

Fields

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

Mutation.oncallRotationCreate

Input type: OncallRotationCreateInput

Arguments

NameTypeDescription
activePeriod OncallRotationActivePeriodInputTypeActive period of time that the on-call rotation should take place.
clientMutationId StringA unique identifier for the client performing the mutation.
endsAt OncallRotationDateInputTypeEnd date and time of the on-call rotation, in the timezone of the on-call schedule.
name String!Name of the on-call rotation.
participants [OncallUserInputType!]!Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
projectPath ID!Project to create the on-call schedule in.
rotationLength OncallRotationLengthInputType!Rotation length of the on-call rotation.
scheduleIid String!IID of the on-call schedule to create the on-call rotation in.
startsAt OncallRotationDateInputType!Start date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields

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

Mutation.oncallRotationDestroy

Input type: OncallRotationDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IncidentManagementOncallRotationID!ID of the on-call rotation to remove.
projectPath ID!Project to remove the on-call schedule from.
scheduleIid String!IID of the on-call schedule to the on-call rotation belongs to.

Fields

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

Mutation.oncallRotationUpdate

Input type: OncallRotationUpdateInput

Arguments

NameTypeDescription
activePeriod OncallRotationActivePeriodInputTypeActive period of time that the on-call rotation should take place.
clientMutationId StringA unique identifier for the client performing the mutation.
endsAt OncallRotationDateInputTypeEnd date and time of the on-call rotation, in the timezone of the on-call schedule.
id IncidentManagementOncallRotationID!ID of the on-call schedule to create the on-call rotation in.
name StringName of the on-call rotation.
participants [OncallUserInputType!]Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
rotationLength OncallRotationLengthInputTypeRotation length of the on-call rotation.
startsAt OncallRotationDateInputTypeStart date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields

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

Mutation.oncallScheduleCreate

Input type: OncallScheduleCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the on-call schedule.
name String!Name of the on-call schedule.
projectPath ID!Project to create the on-call schedule in.
timezone String!Timezone of the on-call schedule.

Fields

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

Mutation.oncallScheduleDestroy

Input type: OncallScheduleDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
iid String!On-call schedule internal ID to remove.
projectPath ID!Project to remove the on-call schedule from.

Fields

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

Mutation.oncallScheduleUpdate

Input type: OncallScheduleUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the on-call schedule.
iid String!On-call schedule internal ID to update.
name StringName of the on-call schedule.
projectPath ID!Project to update the on-call schedule in.
timezone StringTimezone of the on-call schedule.

Fields

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

Mutation.pagesMarkOnboardingComplete

Input type: PagesMarkOnboardingCompleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
onboardingComplete Boolean!Indicates the new onboarding_complete state of the project’s Pages metadata.

Mutation.pipelineCancel

Input type: PipelineCancelInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiPipelineID!ID of the pipeline to mutate.

Fields

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

Mutation.pipelineDestroy

Input type: PipelineDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiPipelineID!ID of the pipeline to mutate.

Fields

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

Mutation.pipelineRetry

Input type: PipelineRetryInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiPipelineID!ID of the pipeline to mutate.

Fields

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

Mutation.pipelineScheduleCreate

Input type: PipelineScheduleCreateInput

Arguments

NameTypeDescription
active BooleanIndicates if the pipeline schedule should be active or not.
clientMutationId StringA unique identifier for the client performing the mutation.
cron String!Cron expression of the pipeline schedule.
cronTimezone StringCron time zone supported by ActiveSupport::TimeZone. For example: “Pacific Time (US & Canada)” (default: “UTC”).
description String!Description of the pipeline schedule.
projectPath ID!Full path of the project the pipeline schedule is associated with.
ref String!Ref of the pipeline schedule.
variables [PipelineScheduleVariableInput!]Variables for the pipeline schedule.

Fields

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

Mutation.pipelineScheduleDelete

Input type: PipelineScheduleDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields

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

Mutation.pipelineSchedulePlay

Input type: PipelineSchedulePlayInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields

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

Mutation.pipelineScheduleTakeOwnership

Input type: PipelineScheduleTakeOwnershipInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id CiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields

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

Mutation.pipelineScheduleUpdate

Input type: PipelineScheduleUpdateInput

Arguments

NameTypeDescription
active BooleanIndicates if the pipeline schedule should be active or not.
clientMutationId StringA unique identifier for the client performing the mutation.
cron StringCron expression of the pipeline schedule.
cronTimezone StringCron time zone supported by ActiveSupport::TimeZone. For example: “Pacific Time (US & Canada)” (default: “UTC”).
description StringDescription of the pipeline schedule.
id CiPipelineScheduleID!ID of the pipeline schedule to mutate.
ref StringRef of the pipeline schedule.
variables [PipelineScheduleVariableInput!]Variables for the pipeline schedule.

Fields

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

Mutation.projectCiCdSettingsUpdate

Input type: ProjectCiCdSettingsUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath ID!Full Path of the project the settings belong to.
inboundJobTokenScopeEnabled BooleanIndicates CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabled Boolean Deprecated: Outbound job token scope is being removed. This field can now only be set to false. Deprecated in 16.0.
keepLatestArtifact BooleanIndicates if the latest artifact should be kept for the project.
mergePipelinesEnabled BooleanIndicates if merge pipelines are enabled for the project.
mergeTrainsEnabled BooleanIndicates if merge trains are enabled for the project.

Fields

NameTypeDescription
ciCdSettings ProjectCiCdSetting!CI/CD settings after mutation.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.projectInitializeProductAnalytics

Input type: ProjectInitializeProductAnalyticsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project to initialize.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
project ProjectProject on which the initialization took place.

Mutation.projectMemberBulkUpdate

Updates multiple members of a project. To use this mutation, you must have at least the Maintainer role.

Input type: ProjectMemberBulkUpdateInput

Arguments

NameTypeDescription
accessLevel MemberAccessLevel!Access level to update the members to.
clientMutationId StringA unique identifier for the client performing the mutation.
expiresAt TimeDate and time the membership expires.
projectId ProjectID!Global ID of the project.
userIds [UserID!]!Global IDs of the members.

Fields

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

Mutation.projectSetComplianceFramework

Assign (or unset) a compliance framework to a project.

Input type: ProjectSetComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
complianceFrameworkId ComplianceManagementFrameworkIDID of the compliance framework to assign to the project. Set to null to unset.
projectId ProjectID!ID of the project to change the compliance framework of.

Fields

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

Mutation.projectSetLocked

Input type: ProjectSetLockedInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
filePath String!Full path to the file.
lock Boolean!Whether or not to lock the file path.
projectPath ID!Full path of the project to mutate.

Fields

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

Mutation.projectSyncFork

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

Input type: ProjectSyncForkInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project to initialize.
targetBranch String!Ref of the fork to fetch into.

Fields

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

Mutation.prometheusIntegrationCreate

Input type: PrometheusIntegrationCreateInput

Arguments

NameTypeDescription
active Boolean!Whether the integration is receiving alerts.
apiUrl StringEndpoint at which Prometheus can be queried.
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Project to create the integration in.

Fields

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

Mutation.prometheusIntegrationResetToken

Input type: PrometheusIntegrationResetTokenInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IntegrationsPrometheusID!ID of the integration to mutate.

Fields

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

Mutation.prometheusIntegrationUpdate

Input type: PrometheusIntegrationUpdateInput

Arguments

NameTypeDescription
active BooleanWhether the integration is receiving alerts.
apiUrl StringEndpoint at which Prometheus can be queried.
clientMutationId StringA unique identifier for the client performing the mutation.
id IntegrationsPrometheusID!ID of the integration to mutate.

Fields

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

Mutation.promoteToEpic

Input type: PromoteToEpicInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
groupPath IDGroup the promoted epic will belong to.
iid String!IID of the issue to mutate.
projectPath ID!Project the issue to mutate is in.

Fields

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

Mutation.releaseAssetLinkCreate

Input type: ReleaseAssetLinkCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
directAssetPath StringRelative path for a direct asset link.
linkType ReleaseAssetLinkTypeType of the asset link.
name String!Name of the asset link.
projectPath ID!Full path of the project the asset link is associated with.
tagName String!Name of the associated release’s tag.
url String!URL of the asset link.

Fields

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

Mutation.releaseAssetLinkDelete

Input type: ReleaseAssetLinkDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ReleasesLinkID!ID of the release asset link to delete.

Fields

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

Mutation.releaseAssetLinkUpdate

Input type: ReleaseAssetLinkUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
directAssetPath StringRelative path for a direct asset link.
id ReleasesLinkID!ID of the release asset link to update.
linkType ReleaseAssetLinkTypeType of the asset link.
name StringName of the asset link.
url StringURL of the asset link.

Fields

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

Mutation.releaseCreate

Input type: ReleaseCreateInput

Arguments

NameTypeDescription
assets ReleaseAssetsInputAssets associated to the release.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription (also known as “release notes”) of the release.
milestones [String!]Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
name StringName of the release.
projectPath ID!Full path of the project the release is associated with.
ref StringCommit SHA or branch name to use if creating a new tag.
releasedAt TimeDate and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
tagMessage StringMessage to use if creating a new annotated tag.
tagName String!Name of the tag to associate with the release.

Fields

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

Mutation.releaseDelete

Input type: ReleaseDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
projectPath ID!Full path of the project the release is associated with.
tagName String!Name of the tag associated with the release to delete.

Fields

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

Mutation.releaseUpdate

Input type: ReleaseUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription (release notes) of the release.
milestones [String!]Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
name StringName of the release.
projectPath ID!Full path of the project the release is associated with.
releasedAt TimeRelease date.
tagName String!Name of the tag associated with the release.

Fields

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

Mutation.removeProjectFromSecurityDashboard

Input type: RemoveProjectFromSecurityDashboardInput

Arguments

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

Fields

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

Mutation.repositionImageDiffNote

Repositions a DiffNote on an image (a Note where the position.positionType is "image").

Input type: RepositionImageDiffNoteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id DiffNoteID!Global ID of the DiffNote to update.
position UpdateDiffImagePositionInput!Position of this note on a diff.

Fields

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

Mutation.runnerCreate

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

Input type: RunnerCreateInput

Arguments

NameTypeDescription
accessLevel CiRunnerAccessLevelAccess level of the runner.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the runner.
groupId GroupIDGlobal ID of the group that the runner is created in (valid only for group runner).
locked BooleanIndicates the runner is locked.
maintenanceNote StringRunner’s maintenance notes.
maximumTimeout IntMaximum timeout (in seconds) for jobs processed by the runner.
paused BooleanIndicates the runner is not allowed to receive jobs.
projectId ProjectIDGlobal ID of the project that the runner is created in (valid only for project runner).
runUntagged BooleanIndicates the runner is able to run untagged jobs.
runnerType CiRunnerType!Type of the runner to create.
tagList [String!]Tags associated with the runner.

Fields

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

Mutation.runnerDelete

Input type: RunnerDeleteInput

Arguments

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

Fields

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

Mutation.runnerUpdate

Input type: RunnerUpdateInput

Arguments

NameTypeDescription
accessLevel CiRunnerAccessLevelAccess level of the runner.
active Boolean Deprecated: This was renamed. Please use paused. Deprecated in 14.8.
associatedProjects [ProjectID!]Projects associated with the runner. Available only for project runners.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the runner.
id CiRunnerID!ID of the runner to update.
locked BooleanIndicates the runner is locked.
maintenanceNote StringRunner’s maintenance notes.
maximumTimeout IntMaximum timeout (in seconds) for jobs processed by the runner.
paused BooleanIndicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor FloatPrivate projects’ “compute cost factor” associated with the runner (GitLab.com only).
publicProjectsMinutesCostFactor FloatPublic projects’ “compute cost factor” associated with the runner (GitLab.com only).
runUntagged BooleanIndicates the runner is able to run untagged jobs.
tagList [String!]Tags associated with the runner.

Fields

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

Mutation.runnersRegistrationTokenReset

Input type: RunnersRegistrationTokenResetInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IDID of the project or group to reset the token for. Omit if resetting instance runner token.
type CiRunnerType!Scope of the object to reset the token for.

Fields

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

Mutation.savedReplyCreate

Input type: SavedReplyCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
content String!Content of the saved reply.
name String!Name of the saved reply.

Fields

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

Mutation.savedReplyDestroy

Input type: SavedReplyDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id UsersSavedReplyID!Global ID of the saved reply.

Fields

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

Mutation.savedReplyUpdate

Input type: SavedReplyUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
content String!Content of the saved reply.
id UsersSavedReplyID!Global ID of the saved reply.
name String!Name of the saved reply.

Fields

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

Mutation.scanExecutionPolicyCommit

Commits the policy_yaml content to the assigned security policy project for the given project (full_path).

Input type: ScanExecutionPolicyCommitInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath StringFull path of the project.
name String!Name of the policy. If the name is null, the name field from policy_yaml is used.
operationMode MutationOperationMode!Changes the operation mode.
policyYaml String!YAML snippet of the policy.
projectPath ID Deprecated: Use fullPath. Deprecated in 14.10.

Fields

NameTypeDescription
branch StringName of the branch to which the policy changes are committed.
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
validationErrors [SecurityPolicyValidationError!]Validation errors encountered during execution of the mutation.

Mutation.securityFindingCreateIssue

Input type: SecurityFindingCreateIssueInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
project ProjectID!ID of the project to attach the issue to.
uuid String!UUID of the security finding to be used to create an issue.

Fields

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

Mutation.securityFindingCreateMergeRequest

Input type: SecurityFindingCreateMergeRequestInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
uuid String!UUID of the security finding to be used to create a merge request.

Fields

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

Mutation.securityFindingDismiss

Input type: SecurityFindingDismissInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
comment StringComment why finding should be dismissed.
dismissalReason VulnerabilityDismissalReasonReason why finding should be dismissed.
uuid String!UUID of the finding to be dismissed.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
securityFinding PipelineSecurityReportFindingDismissed finding.
uuid StringUUID of dismissed finding.

Mutation.securityFindingRevertToDetected

Input type: SecurityFindingRevertToDetectedInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
uuid String!UUID of the finding to be dismissed.

Fields

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

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

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath StringFull path of the project or group.
projectPath ID Deprecated: Use fullPath. Deprecated in 14.10.
securityPolicyProjectId ProjectID!ID of the security policy project.

Fields

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

Mutation.securityPolicyProjectCreate

Creates and assigns a security policy project for the given project (full_path).

Input type: SecurityPolicyProjectCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath StringFull path of the project or group.
projectPath ID Deprecated: Use fullPath. Deprecated in 14.10.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
project ProjectSecurity Policy Project that was created.

Mutation.securityPolicyProjectUnassign

Unassigns the security policy project for the given project (full_path).

Input type: SecurityPolicyProjectUnassignInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
fullPath StringFull path of the project or group.
projectPath ID Deprecated: Use fullPath. Deprecated in 14.10.

Fields

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

Mutation.securityTrainingUpdate

Input type: SecurityTrainingUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
isEnabled Boolean!Sets the training provider as enabled for the project.
isPrimary BooleanSets the training provider as primary for the project.
projectPath ID!Full path of the project.
providerId SecurityTrainingProviderID!ID of the provider.

Fields

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

Mutation.terraformStateDelete

Input type: TerraformStateDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id TerraformStateID!Global ID of the Terraform state.

Fields

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

Mutation.terraformStateLock

Input type: TerraformStateLockInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id TerraformStateID!Global ID of the Terraform state.

Fields

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

Mutation.terraformStateUnlock

Input type: TerraformStateUnlockInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id TerraformStateID!Global ID of the Terraform state.

Fields

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

Mutation.timelineEventCreate

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

Input type: TimelineEventCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
incidentId IssueID!Incident ID of the timeline event.
note String!Text note of the timeline event.
occurredAt Time!Timestamp of when the event occurred.
timelineEventTagNames [String!]Tags for the incident timeline event.

Fields

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

Mutation.timelineEventDestroy

Input type: TimelineEventDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IncidentManagementTimelineEventID!Timeline event ID to remove.

Fields

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

Mutation.timelineEventPromoteFromNote

Input type: TimelineEventPromoteFromNoteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
noteId NoteID!Note ID from which the timeline event promoted.

Fields

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

Mutation.timelineEventTagCreate

Input type: TimelineEventTagCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
name String!Name of the tag.
projectPath ID!Project to create the timeline event tag in.

Fields

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

Mutation.timelineEventUpdate

Input type: TimelineEventUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id IncidentManagementTimelineEventID!ID of the timeline event to update.
note StringText note of the timeline event.
occurredAt TimeTimestamp when the event occurred.
timelineEventTagNames [String!]Tags for the incident timeline event.

Fields

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

Mutation.timelogCreate

Input type: TimelogCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
issuableId IssuableID!Global ID of the issuable (Issue, WorkItem or MergeRequest).
spentAt Time!When the time was spent.
summary String!Summary of time spent.
timeSpent String!Amount of time spent.

Fields

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

Mutation.timelogDelete

Input type: TimelogDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id TimelogID!Global ID of the timelog.

Fields

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

Mutation.todoCreate

Input type: TodoCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
targetId TodoableID!Global ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported.

Fields

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

Mutation.todoMarkDone

Input type: TodoMarkDoneInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id TodoID!Global ID of the to-do item to mark as done.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
todo Todo!Requested to-do item.

Mutation.todoRestore

Input type: TodoRestoreInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id TodoID!Global ID of the to-do item to restore.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
todo Todo!Requested to-do item.

Mutation.todoRestoreMany

Input type: TodoRestoreManyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
ids [TodoID!]!Global IDs of the to-do items to restore (a maximum of 50 is supported at once).

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
todos [Todo!]!Updated to-do items.

Mutation.todosMarkAllDone

Input type: TodosMarkAllDoneInput

Arguments

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

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
todos [Todo!]!Updated to-do items.

Mutation.updateAlertStatus

Input type: UpdateAlertStatusInput

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.
status AlertManagementStatus!Status to set the alert.

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

Input type: UpdateBoardInput

Arguments

NameTypeDescription
assigneeId UserIDID of user to be assigned to the board.
clientMutationId StringA unique identifier for the client performing the mutation.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
id BoardID!Board global ID.
iterationCadenceId IterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationId IterationIDID of iteration to be assigned to the board.
labelIds [LabelID!]IDs of labels to be added to the board.
labels [String!]Labels of the issue.
milestoneId MilestoneIDID of milestone to be assigned to the board.
name StringBoard name.
weight IntWeight value to be assigned to the board.

Fields

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

Mutation.updateBoardEpicUserPreferences

Input type: UpdateBoardEpicUserPreferencesInput

Arguments

NameTypeDescription
boardId BoardID!Board global ID.
clientMutationId StringA unique identifier for the client performing the mutation.
collapsed Boolean!Whether the epic should be collapsed in the board.
epicId EpicID!ID of an epic to set preferences for.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
epicUserPreferences BoardEpicUserPreferencesUser preferences for the epic in the board after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.updateBoardList

Input type: UpdateBoardListInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
collapsed BooleanIndicates if the list is collapsed for the user.
listId ListID!Global ID of the list.
position IntPosition of list within the board.

Fields

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

Mutation.updateComplianceFramework

Input type: UpdateComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id ComplianceManagementFrameworkID!Global ID of the compliance framework to update.
params ComplianceFrameworkInput!Parameters to update the compliance framework with.

Fields

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

Mutation.updateContainerExpirationPolicy

Input type: UpdateContainerExpirationPolicyInput

Arguments

NameTypeDescription
cadence ContainerExpirationPolicyCadenceEnumThis container expiration policy schedule.
clientMutationId StringA unique identifier for the client performing the mutation.
enabled BooleanIndicates whether this container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnumNumber of tags to retain.
nameRegex UntrustedRegexpTags with names matching this regex pattern will expire.
nameRegexKeep UntrustedRegexpTags with names matching this regex pattern will be preserved.
olderThan ContainerExpirationPolicyOlderThanEnumTags older that this will expire.
projectPath ID!Project path where the container expiration policy is located.

Fields

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

Mutation.updateDependencyProxyImageTtlGroupPolicy

These settings can be adjusted by the group Owner or Maintainer. Issue 370471 proposes limiting this to Owners only to match the permissions level in the user interface.

Input type: UpdateDependencyProxyImageTtlGroupPolicyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
enabled BooleanIndicates whether the policy is enabled or disabled.
groupPath ID!Group path for the group dependency proxy image TTL policy.
ttl IntNumber of days to retain a cached image file.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dependencyProxyImageTtlPolicy DependencyProxyImageTtlGroupPolicyGroup image TTL policy after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.updateDependencyProxySettings

These settings can be adjusted by the group Owner or Maintainer. Issue 370471 proposes limiting this to Owners only to match the permissions level in the user interface.

Input type: UpdateDependencyProxySettingsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
enabled BooleanIndicates whether the policy is enabled or disabled.
groupPath ID!Group path for the group dependency proxy.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
dependencyProxySetting DependencyProxySettingGroup dependency proxy settings after mutation.
errors [String!]!Errors encountered during execution of the mutation.

Mutation.updateEpic

Input type: UpdateEpicInput

Arguments

NameTypeDescription
addLabelIds [ID!]IDs of labels to be added to the epic.
addLabels [String!]Array of labels to be added to the epic.
clientMutationId StringA unique identifier for the client performing the mutation.
color ColorColor of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
confidential BooleanIndicates if the epic is confidential.
description StringDescription of the epic.
dueDateFixed StringEnd date of the epic.
dueDateIsFixed BooleanIndicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath ID!Group the epic to mutate is in.
iid ID!IID of the epic to mutate.
removeLabelIds [ID!]IDs of labels to be removed from the epic.
removeLabels [String!]Array of labels to be removed from the epic.
startDateFixed StringStart date of the epic.
startDateIsFixed BooleanIndicates start date should be sourced from start_date_fixed field not the issue milestones.
stateEvent EpicStateEventState event for the epic.
title StringTitle of the epic.

Fields

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

Mutation.updateEpicBoardList

Input type: UpdateEpicBoardListInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
collapsed BooleanIndicates if the list is collapsed for the user.
listId BoardsEpicListID!Global ID of the epic list.
position IntPosition of list within the board.

Fields

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

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

Arguments

NameTypeDescription
body StringContent of the note.
clientMutationId StringA unique identifier for the client performing the mutation.
id NoteID!Global ID of the note to update.
position UpdateDiffImagePositionInputPosition of this note on a diff.

Fields

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

Mutation.updateIssue

Input type: UpdateIssueInput

Arguments

NameTypeDescription
addLabelIds [ID!]IDs of labels to be added to the issue.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential BooleanIndicates the issue is confidential.
description StringDescription of the issue.
dueDate ISO8601DateDue date of the issue.
epicId EpicIDID of the parent epic. NULL when removing the association.
healthStatus HealthStatusDesired health status.
iid String!IID of the issue to mutate.
labelIds [ID!]IDs of labels to be set. Replaces existing issue labels.
locked BooleanIndicates discussion is locked on the issue.
milestoneId IDID of the milestone to assign to the issue. On update milestone will be removed if set to null.
projectPath ID!Project the issue to mutate is in.
removeLabelIds [ID!]IDs of labels to be removed from the issue.
stateEvent IssueStateEventClose or reopen an issue.
timeEstimate StringEstimated time to complete the issue, or 0 to remove the current estimate.
title StringTitle of the issue.
type IssueTypeType of the issue.
weight IntWeight of the issue.

Fields

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

Mutation.updateIteration

Input type: UpdateIterationInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the iteration.
dueDate StringEnd date of the iteration.
groupPath ID!Group of the iteration.
id ID!Global ID of the iteration.
startDate StringStart date of the iteration.
title StringTitle of the iteration.

Fields

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

Mutation.updateNamespacePackageSettings

These settings can be adjusted by the group Owner or Maintainer. Issue 370471 proposes limiting this to Owners only to match the permissions level in the user interface.

Input type: UpdateNamespacePackageSettingsInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
genericDuplicateExceptionRegex UntrustedRegexpWhen generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
genericDuplicatesAllowed BooleanIndicates whether duplicate generic packages are allowed for this namespace.
lockMavenPackageRequestsForwarding BooleanIndicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwarding BooleanIndicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwarding BooleanIndicates whether PyPI package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegex UntrustedRegexpWhen maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
mavenDuplicatesAllowed BooleanIndicates whether duplicate Maven packages are allowed for this namespace.
mavenPackageRequestsForwarding BooleanIndicates whether Maven package forwarding is allowed for this namespace.
namespacePath ID!Namespace path where the namespace package setting is located.
npmPackageRequestsForwarding BooleanIndicates whether npm package forwarding is allowed for this namespace.
pypiPackageRequestsForwarding BooleanIndicates whether PyPI package forwarding is allowed for this namespace.

Fields

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

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

Arguments

NameTypeDescription
body StringContent of the note.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential Boolean Deprecated: No longer allowed to update confidentiality of notes. Deprecated in 14.10.
id NoteID!Global ID of the note to update.

Fields

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

Mutation.updatePackagesCleanupPolicy

Input type: UpdatePackagesCleanupPolicyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
keepNDuplicatedPackageFiles PackagesCleanupKeepDuplicatedPackageFilesEnumNumber of duplicated package files to retain.
projectPath ID!Project path where the packages cleanup policy is located.

Fields

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

Mutation.updateRequirement

Input type: UpdateRequirementInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the requirement.
iid String Deprecated: Use work_item_iid instead. Deprecated in 15.8.
lastTestReportState TestReportStateCreates a test report for the requirement with the given state.
projectPath ID!Full project path the requirement is associated with.
state RequirementStateState of the requirement.
title StringTitle of the requirement.
workItemIid StringIID of the requirement work item to update.

Fields

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

Mutation.updateSnippet

Input type: UpdateSnippetInput

Arguments

NameTypeDescription
blobActions [SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs.
clientMutationId StringA unique identifier for the client performing the mutation.
description StringDescription of the snippet.
id SnippetID!Global ID of the snippet to update.
title StringTitle of the snippet.
visibilityLevel VisibilityLevelsEnumVisibility level of the snippet.

Fields

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

Mutation.uploadDelete

Deletes an upload.

Input type: UploadDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
filename String!Upload filename.
groupPath IDFull path of the group with which the resource is associated.
projectPath IDFull path of the project with which the resource is associated.
secret String!Secret part of upload path.

Fields

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

Mutation.userAchievementsDelete

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

Input type: UserAchievementsDeleteInput

Arguments

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

Fields

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

Mutation.userCalloutCreate

Input type: UserCalloutCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
featureName String!Feature name you want to dismiss the callout for.

Fields

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

Mutation.userPreferencesUpdate

Input type: UserPreferencesUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
issuesSort IssueSortSort order for issue lists.
visibilityPipelineIdType VisibilityPipelineIdTypeDetermines whether the pipeline list shows ID or IID.

Fields

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

Mutation.userSetNamespaceCommitEmail

Input type: UserSetNamespaceCommitEmailInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
emailId EmailIDID of the email to set.
namespaceId NamespaceID!ID of the namespace to set the namespace commit email for.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
namespaceCommitEmail NamespaceCommitEmailUser namespace commit email after mutation.

Mutation.vulnerabilitiesDismiss

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

Input type: VulnerabilitiesDismissInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
comment StringComment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReason VulnerabilityDismissalReasonReason why vulnerability should be dismissed.
vulnerabilityIds [VulnerabilityID!]!IDs of the vulnerabilities to be dismissed.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
vulnerabilities [Vulnerability!]! Deprecated: This feature is an Experiment. It can be changed or removed at any time. Introduced in 16.2.

Mutation.vulnerabilityConfirm

Input type: VulnerabilityConfirmInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
comment StringComment why vulnerability was confirmed (maximum 50,000 characters).
id VulnerabilityID!ID of the vulnerability to be confirmed.

Fields

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

Mutation.vulnerabilityCreate

Input type: VulnerabilityCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
confidence VulnerabilityConfidence Deprecated: This field will be removed from the Vulnerability domain model. Deprecated in 15.4.
confirmedAt TimeTimestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is confirmed).
description String!Long text section that describes the vulnerability in more detail.
detectedAt TimeTimestamp of when the vulnerability was first detected (defaults to creation time).
dismissedAt TimeTimestamp 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.
message String Deprecated: message field has been removed from security reports schema. Deprecated in 16.1.
name String!Name of the vulnerability.
project ProjectID!ID of the project to attach the vulnerability to.
resolvedAt TimeTimestamp of when the vulnerability state changed to resolved (defaults to creation time if status is resolved).
scanner VulnerabilityScannerInput!Information about the scanner used to discover the vulnerability.
severity VulnerabilitySeveritySeverity of the vulnerability (defaults to unknown).
solution StringInstructions for how to fix the vulnerability.
state VulnerabilityStateState of the vulnerability (defaults to detected).

Fields

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

Mutation.vulnerabilityDismiss

Input type: VulnerabilityDismissInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
comment StringComment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReason VulnerabilityDismissalReasonReason why vulnerability should be dismissed.
id VulnerabilityID!ID of the vulnerability to be dismissed.

Fields

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

Mutation.vulnerabilityExternalIssueLinkCreate

Input type: VulnerabilityExternalIssueLinkCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
externalTracker VulnerabilityExternalIssueLinkExternalTracker!External tracker type of the external issue link.
id VulnerabilityID!ID of the vulnerability.
linkType VulnerabilityExternalIssueLinkType!Type of the external issue link.

Fields

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

Mutation.vulnerabilityExternalIssueLinkDestroy

Input type: VulnerabilityExternalIssueLinkDestroyInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id VulnerabilitiesExternalIssueLinkID!Global ID of the vulnerability external issue link.

Fields

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

Mutation.vulnerabilityIssueLinkCreate

Input type: VulnerabilityIssueLinkCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
issueId IssueID!ID of the issue to link to.
vulnerabilityIds [VulnerabilityID!]!IDs of vulnerabilities to link to the given issue. Up to 100 can be provided.

Fields

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

Mutation.vulnerabilityResolve

Input type: VulnerabilityResolveInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
comment StringComment why vulnerability was resolved (maximum 50,000 characters).
id VulnerabilityID!ID of the vulnerability to be resolved.

Fields

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

Mutation.vulnerabilityRevertToDetected

Input type: VulnerabilityRevertToDetectedInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
comment StringComment why vulnerability was reverted to detected (maximum 50,000 characters).
id VulnerabilityID!ID of the vulnerability to be reverted to detected.

Fields

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

Mutation.workItemConvert

Converts the work item to a new type.

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

Input type: WorkItemConvertInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id WorkItemID!Global ID of the work item.
workItemTypeId WorkItemsTypeID!Global ID of the new work item type.

Fields

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

Mutation.workItemCreate

Creates a work item.

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

Input type: WorkItemCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
confidential BooleanSets the work item confidentiality.
description StringDescription of the work item.
hierarchyWidget WorkItemWidgetHierarchyCreateInputInput for hierarchy widget.
iterationWidget WorkItemWidgetIterationInputIteration widget of the work item.
milestoneWidget WorkItemWidgetMilestoneInputInput for milestone widget.
namespacePath IDFull path of the namespace(project or group) the work item is created in.
projectPath ID Deprecated: Please use namespace_path instead. That will cover for both projects and groups. Deprecated in 15.10.
title String!Title of the work item.
workItemTypeId WorkItemsTypeID!Global ID of a work item type.

Fields

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

Mutation.workItemCreateFromTask

Creates a work item from a task in another work item’s description.

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

Input type: WorkItemCreateFromTaskInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id WorkItemID!Global ID of the work item.
workItemData WorkItemConvertTaskInput!Arguments necessary to convert a task into a work item.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
newWorkItem WorkItemNew work item created from task.
workItem WorkItemUpdated work item.

Mutation.workItemDelete

Deletes a work item.

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

Input type: WorkItemDeleteInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id WorkItemID!Global ID of the work item.

Fields

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
errors [String!]!Errors encountered during execution of the mutation.
project ProjectProject the deleted work item belonged to.

Mutation.workItemDeleteTask

Deletes a task in a work item’s description.

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

Input type: WorkItemDeleteTaskInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id WorkItemID!Global ID of the work item.
lockVersion Int!Current lock version of the work item containing the task in the description.
taskData WorkItemDeletedTaskInput!Arguments necessary to delete a task from a work item’s description.

Fields

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

Mutation.workItemExport

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

Input type: WorkItemExportInput

Arguments

NameTypeDescription
authorUsername String Deprecated: This feature is an Experiment. It can be changed or removed at any time. Introduced in 15.9.
clientMutationId StringA unique identifier for the client performing the mutation.
iids [String!]List of IIDs of work items. For example, ["1", "2"].
in [IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
projectPath ID!Full project path.
search StringSearch query for title or description.
selectedFields [AvailableExportFields!]List of selected fields to be exported. Omit to export all available fields.
state IssuableStateCurrent state of the work item.
types [IssueType!]Filter work items by the given work item types.

Fields

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

Mutation.workItemUpdate

Updates a work item by Global ID.

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

Input type: WorkItemUpdateInput

Arguments

NameTypeDescription
assigneesWidget WorkItemWidgetAssigneesInputInput for assignees widget.
awardEmojiWidget WorkItemWidgetAwardEmojiUpdateInputInput for award emoji widget.
clientMutationId StringA unique identifier for the client performing the mutation.
confidential BooleanSets the work item confidentiality.
currentUserTodosWidget WorkItemWidgetCurrentUserTodosInputInput for to-dos widget.
descriptionWidget WorkItemWidgetDescriptionInputInput for description widget.
healthStatusWidget WorkItemWidgetHealthStatusInputInput for health status widget.
hierarchyWidget WorkItemWidgetHierarchyUpdateInputInput for hierarchy widget.
id WorkItemID!Global ID of the work item.
iterationWidget WorkItemWidgetIterationInputInput for iteration widget.
labelsWidget WorkItemWidgetLabelsUpdateInputInput for labels widget.
milestoneWidget WorkItemWidgetMilestoneInputInput for milestone widget.
notificationsWidget WorkItemWidgetNotificationsUpdateInputInput for notifications widget.
progressWidget WorkItemWidgetProgressInputInput for progress widget.
startAndDueDateWidget WorkItemWidgetStartAndDueDateUpdateInputInput for start and due date widget.
stateEvent WorkItemStateEventClose or reopen a work item.
statusWidget StatusInputInput for status widget.
title StringTitle of the work item.
weightWidget WorkItemWidgetWeightInputInput for weight widget.

Fields

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

Mutation.workItemUpdateTask

Updates a work item’s task by Global ID.

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

Input type: WorkItemUpdateTaskInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
id WorkItemID!Global ID of the work item.
taskData WorkItemUpdatedTaskInput!Arguments necessary to update a task.

Fields

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

Mutation.workspaceCreate

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

Input type: WorkspaceCreateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID!ID of the cluster agent the created workspace will be associated with.
desiredState String!Desired state of the created workspace.
devfilePath String!Project repo git path containing the devfile used to configure the workspace.
devfileRef String!Project repo git ref containing the devfile used to configure the workspace.
editor String!Editor to inject into the created workspace. Must match a configured template.
maxHoursBeforeTermination Int!Maximum hours the workspace can exist before it is automatically terminated.
projectId ProjectID!ID of the project that will provide the Devfile for the created workspace.

Fields

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

Mutation.workspaceUpdate

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

Input type: WorkspaceUpdateInput

Arguments

NameTypeDescription
clientMutationId StringA unique identifier for the client performing the mutation.
desiredState String!Desired state of the created workspace.
id RemoteDevelopmentWorkspaceID!Global ID of the workspace.

Fields

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

Connections

Some types in our schema are Connection types - they represent a paginated collection of edges between two nodes in the graph. These follow the Relay cursor connections specification.

Pagination arguments

All connection fields support the following pagination arguments:

NameTypeDescription
afterStringReturns the elements in the list that come after the specified cursor.
beforeStringReturns the elements in the list that come before the specified cursor.
firstIntReturns the first n elements from the list.
lastIntReturns the last n elements from the list.

Since these arguments are common to all connection fields, they are not repeated for each connection.

Connection fields

All connections have at least the following fields:

NameTypeDescription
pageInfoPageInfo!Pagination information.
edges[edge!]The edges.
nodes[item!]The items in the current page.

The precise type of Edge and Item depends on the kind of connection. A ProjectConnection will have nodes that have the type [Project!], and edges that have the type ProjectEdge.

Connection types

Some of the types in the schema exist solely to model connections. Each connection has a distinct, named type, with a distinct named edge type. These are listed separately below.

AchievementConnection

The connection type for Achievement.

Fields
NameTypeDescription
edges [AchievementEdge]A list of edges.
nodes [Achievement]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AchievementEdge

The edge type for Achievement.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AchievementThe item at the end of the edge.

AgentConfigurationConnection

The connection type for AgentConfiguration.

Fields
NameTypeDescription
edges [AgentConfigurationEdge]A list of edges.
nodes [AgentConfiguration]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AgentConfigurationEdge

The edge type for AgentConfiguration.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AgentConfigurationThe item at the end of the edge.

AiCachedMessageTypeConnection

The connection type for AiCachedMessageType.

Fields
NameTypeDescription
edges [AiCachedMessageTypeEdge]A list of edges.
nodes [AiCachedMessageType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AiCachedMessageTypeEdge

The edge type for AiCachedMessageType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AiCachedMessageTypeThe item at the end of the edge.

AiMessageTypeConnection

The connection type for AiMessageType.

Fields
NameTypeDescription
edges [AiMessageTypeEdge]A list of edges.
nodes [AiMessageType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AiMessageTypeEdge

The edge type for AiMessageType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AiMessageTypeThe item at the end of the edge.

AlertManagementAlertConnection

The connection type for AlertManagementAlert.

Fields
NameTypeDescription
edges [AlertManagementAlertEdge]A list of edges.
nodes [AlertManagementAlert]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AlertManagementAlertEdge

The edge type for AlertManagementAlert.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AlertManagementAlertThe item at the end of the edge.

AlertManagementHttpIntegrationConnection

The connection type for AlertManagementHttpIntegration.

Fields
NameTypeDescription
edges [AlertManagementHttpIntegrationEdge]A list of edges.
nodes [AlertManagementHttpIntegration]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AlertManagementHttpIntegrationEdge

The edge type for AlertManagementHttpIntegration.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AlertManagementHttpIntegrationThe item at the end of the edge.

AlertManagementIntegrationConnection

The connection type for AlertManagementIntegration.

Fields
NameTypeDescription
edges [AlertManagementIntegrationEdge]A list of edges.
nodes [AlertManagementIntegration]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AlertManagementIntegrationEdge

The edge type for AlertManagementIntegration.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AlertManagementIntegrationThe item at the end of the edge.

ApprovalProjectRuleConnection

The connection type for ApprovalProjectRule.

Fields
NameTypeDescription
edges [ApprovalProjectRuleEdge]A list of edges.
nodes [ApprovalProjectRule]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ApprovalProjectRuleEdge

The edge type for ApprovalProjectRule.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ApprovalProjectRuleThe item at the end of the edge.

AuditEventDefinitionConnection

The connection type for AuditEventDefinition.

Fields
NameTypeDescription
edges [AuditEventDefinitionEdge]A list of edges.
nodes [AuditEventDefinition]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AuditEventDefinitionEdge

The edge type for AuditEventDefinition.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AuditEventDefinitionThe item at the end of the edge.

AuditEventStreamingHeaderConnection

The connection type for AuditEventStreamingHeader.

Fields
NameTypeDescription
edges [AuditEventStreamingHeaderEdge]A list of edges.
nodes [AuditEventStreamingHeader]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AuditEventStreamingHeaderEdge

The edge type for AuditEventStreamingHeader.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AuditEventStreamingHeaderThe item at the end of the edge.

AuditEventsStreamingInstanceHeaderConnection

The connection type for AuditEventsStreamingInstanceHeader.

Fields
NameTypeDescription
edges [AuditEventsStreamingInstanceHeaderEdge]A list of edges.
nodes [AuditEventsStreamingInstanceHeader]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AuditEventsStreamingInstanceHeaderEdge

The edge type for AuditEventsStreamingInstanceHeader.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AuditEventsStreamingInstanceHeaderThe item at the end of the edge.

AwardEmojiConnection

The connection type for AwardEmoji.

Fields
NameTypeDescription
edges [AwardEmojiEdge]A list of edges.
nodes [AwardEmoji]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

AwardEmojiEdge

The edge type for AwardEmoji.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node AwardEmojiThe item at the end of the edge.

BlobConnection

The connection type for Blob.

Fields
NameTypeDescription
edges [BlobEdge]A list of edges.
nodes [Blob]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

BlobEdge

The edge type for Blob.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node BlobThe item at the end of the edge.

BoardConnection

The connection type for Board.

Fields
NameTypeDescription
edges [BoardEdge]A list of edges.
nodes [Board]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

BoardEdge

The edge type for Board.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node BoardThe item at the end of the edge.

BoardEpicConnection

The connection type for BoardEpic.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [BoardEpicEdge]A list of edges.
nodes [BoardEpic]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

BoardEpicEdge

The edge type for BoardEpic.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node BoardEpicThe item at the end of the edge.

BoardListConnection

The connection type for BoardList.

Fields
NameTypeDescription
edges [BoardListEdge]A list of edges.
nodes [BoardList]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

BoardListEdge

The edge type for BoardList.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node BoardListThe item at the end of the edge.

BranchRuleConnection

The connection type for BranchRule.

Fields
NameTypeDescription
edges [BranchRuleEdge]A list of edges.
nodes [BranchRule]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

BranchRuleEdge

The edge type for BranchRule.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node BranchRuleThe item at the end of the edge.

CiBuildNeedConnection

The connection type for CiBuildNeed.

Fields
NameTypeDescription
edges [CiBuildNeedEdge]A list of edges.
nodes [CiBuildNeed]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiBuildNeedEdge

The edge type for CiBuildNeed.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiBuildNeedThe item at the end of the edge.

CiCatalogResourceConnection

The connection type for CiCatalogResource.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [CiCatalogResourceEdge]A list of edges.
nodes [CiCatalogResource]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiCatalogResourceEdge

The edge type for CiCatalogResource.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiCatalogResourceThe item at the end of the edge.

CiConfigGroupConnection

The connection type for CiConfigGroup.

Fields
NameTypeDescription
edges [CiConfigGroupEdge]A list of edges.
nodes [CiConfigGroup]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiConfigGroupEdge

The edge type for CiConfigGroup.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiConfigGroupThe item at the end of the edge.

CiConfigJobConnection

The connection type for CiConfigJob.

Fields
NameTypeDescription
edges [CiConfigJobEdge]A list of edges.
nodes [CiConfigJob]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiConfigJobEdge

The edge type for CiConfigJob.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiConfigJobThe item at the end of the edge.

CiConfigNeedConnection

The connection type for CiConfigNeed.

Fields
NameTypeDescription
edges [CiConfigNeedEdge]A list of edges.
nodes [CiConfigNeed]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiConfigNeedEdge

The edge type for CiConfigNeed.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiConfigNeedThe item at the end of the edge.

CiConfigStageConnection

The connection type for CiConfigStage.

Fields
NameTypeDescription
edges [CiConfigStageEdge]A list of edges.
nodes [CiConfigStage]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiConfigStageEdge

The edge type for CiConfigStage.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiConfigStageThe item at the end of the edge.

CiGroupConnection

The connection type for CiGroup.

Fields
NameTypeDescription
edges [CiGroupEdge]A list of edges.
nodes [CiGroup]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiGroupEdge

The edge type for CiGroup.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiGroupThe item at the end of the edge.

CiGroupEnvironmentScopeConnection

The connection type for CiGroupEnvironmentScope.

Fields
NameTypeDescription
edges [CiGroupEnvironmentScopeEdge]A list of edges.
nodes [CiGroupEnvironmentScope]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiGroupEnvironmentScopeEdge

The edge type for CiGroupEnvironmentScope.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiGroupEnvironmentScopeThe item at the end of the edge.

CiGroupVariableConnection

The connection type for CiGroupVariable.

Fields
NameTypeDescription
edges [CiGroupVariableEdge]A list of edges.
limit Int!Maximum amount of group CI/CD variables.
nodes [CiGroupVariable]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiGroupVariableEdge

The edge type for CiGroupVariable.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiGroupVariableThe item at the end of the edge.

CiInstanceVariableConnection

The connection type for CiInstanceVariable.

Fields
NameTypeDescription
edges [CiInstanceVariableEdge]A list of edges.
nodes [CiInstanceVariable]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiInstanceVariableEdge

The edge type for CiInstanceVariable.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiInstanceVariableThe item at the end of the edge.

CiJobArtifactConnection

The connection type for CiJobArtifact.

Fields
NameTypeDescription
edges [CiJobArtifactEdge]A list of edges.
nodes [CiJobArtifact]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiJobArtifactEdge

The edge type for CiJobArtifact.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiJobArtifactThe item at the end of the edge.

CiJobConnection

The connection type for CiJob.

Fields
NameTypeDescription
edges [CiJobEdge]A list of edges.
nodes [CiJob]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.
Fields with arguments
CiJobConnection.count

Limited count of collection. Returns limit + 1 for counts greater than the limit.

Returns Int!.

# Arguments
NameTypeDescription
limit IntLimit value to be applied to the count query. Default is 1000.

CiJobEdge

The edge type for CiJob.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiJobThe item at the end of the edge.

CiManualVariableConnection

The connection type for CiManualVariable.

Fields
NameTypeDescription
edges [CiManualVariableEdge]A list of edges.
nodes [CiManualVariable]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiManualVariableEdge

The edge type for CiManualVariable.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiManualVariableThe item at the end of the edge.

CiMinutesNamespaceMonthlyUsageConnection

The connection type for CiMinutesNamespaceMonthlyUsage.

Fields
NameTypeDescription
edges [CiMinutesNamespaceMonthlyUsageEdge]A list of edges.
nodes [CiMinutesNamespaceMonthlyUsage]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiMinutesNamespaceMonthlyUsageEdge

The edge type for CiMinutesNamespaceMonthlyUsage.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiMinutesNamespaceMonthlyUsageThe item at the end of the edge.

CiMinutesProjectMonthlyUsageConnection

The connection type for CiMinutesProjectMonthlyUsage.

Fields
NameTypeDescription
edges [CiMinutesProjectMonthlyUsageEdge]A list of edges.
nodes [CiMinutesProjectMonthlyUsage]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiMinutesProjectMonthlyUsageEdge

The edge type for CiMinutesProjectMonthlyUsage.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiMinutesProjectMonthlyUsageThe item at the end of the edge.

CiProjectVariableConnection

The connection type for CiProjectVariable.

Fields
NameTypeDescription
edges [CiProjectVariableEdge]A list of edges.
limit Int!Maximum amount of project CI/CD variables.
nodes [CiProjectVariable]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiProjectVariableEdge

The edge type for CiProjectVariable.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiProjectVariableThe item at the end of the edge.

CiRunnerConnection

The connection type for CiRunner.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [CiRunnerEdge]A list of edges.
jobsStatistics CiJobsStatisticsJobs statistics for jobs executed by a collection of runners. Available only to admins.
nodes [CiRunner]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiRunnerEdge

The edge type for CiRunner.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
editUrl StringWeb URL of the runner edit page. The value depends on where you put this field in the query. You can use it for projects or groups.
node CiRunnerThe item at the end of the edge.
webUrl StringWeb URL of the runner. The value depends on where you put this field in the query. You can use it for projects or groups.

CiRunnerManagerConnection

The connection type for CiRunnerManager.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [CiRunnerManagerEdge]A list of edges.
nodes [CiRunnerManager]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiRunnerManagerEdge

The edge type for CiRunnerManager.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiRunnerManagerThe item at the end of the edge.

CiSecureFileRegistryConnection

The connection type for CiSecureFileRegistry.

Fields
NameTypeDescription
edges [CiSecureFileRegistryEdge]A list of edges.
nodes [CiSecureFileRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiSecureFileRegistryEdge

The edge type for CiSecureFileRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiSecureFileRegistryThe item at the end of the edge.

CiStageConnection

The connection type for CiStage.

Fields
NameTypeDescription
edges [CiStageEdge]A list of edges.
nodes [CiStage]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CiStageEdge

The edge type for CiStage.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CiStageThe item at the end of the edge.

ClusterAgentActivityEventConnection

The connection type for ClusterAgentActivityEvent.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [ClusterAgentActivityEventEdge]A list of edges.
nodes [ClusterAgentActivityEvent]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ClusterAgentActivityEventEdge

The edge type for ClusterAgentActivityEvent.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ClusterAgentActivityEventThe item at the end of the edge.

ClusterAgentAuthorizationCiAccessConnection

The connection type for ClusterAgentAuthorizationCiAccess.

Fields
NameTypeDescription
edges [ClusterAgentAuthorizationCiAccessEdge]A list of edges.
nodes [ClusterAgentAuthorizationCiAccess]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ClusterAgentAuthorizationCiAccessEdge

The edge type for ClusterAgentAuthorizationCiAccess.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ClusterAgentAuthorizationCiAccessThe item at the end of the edge.

ClusterAgentAuthorizationUserAccessConnection

The connection type for ClusterAgentAuthorizationUserAccess.

Fields
NameTypeDescription
edges [ClusterAgentAuthorizationUserAccessEdge]A list of edges.
nodes [ClusterAgentAuthorizationUserAccess]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ClusterAgentAuthorizationUserAccessEdge

The edge type for ClusterAgentAuthorizationUserAccess.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ClusterAgentAuthorizationUserAccessThe item at the end of the edge.

ClusterAgentConnection

The connection type for ClusterAgent.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [ClusterAgentEdge]A list of edges.
nodes [ClusterAgent]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ClusterAgentEdge

The edge type for ClusterAgent.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ClusterAgentThe item at the end of the edge.

ClusterAgentTokenConnection

The connection type for ClusterAgentToken.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [ClusterAgentTokenEdge]A list of edges.
nodes [ClusterAgentToken]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ClusterAgentTokenEdge

The edge type for ClusterAgentToken.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ClusterAgentTokenThe item at the end of the edge.

CodeCoverageActivityConnection

The connection type for CodeCoverageActivity.

Fields
NameTypeDescription
edges [CodeCoverageActivityEdge]A list of edges.
nodes [CodeCoverageActivity]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CodeCoverageActivityEdge

The edge type for CodeCoverageActivity.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CodeCoverageActivityThe item at the end of the edge.

CodeQualityDegradationConnection

The connection type for CodeQualityDegradation.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [CodeQualityDegradationEdge]A list of edges.
nodes [CodeQualityDegradation]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CodeQualityDegradationEdge

The edge type for CodeQualityDegradation.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CodeQualityDegradationThe item at the end of the edge.

CommitConnection

The connection type for Commit.

Fields
NameTypeDescription
edges [CommitEdge]A list of edges.
nodes [Commit]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CommitEdge

The edge type for Commit.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CommitThe item at the end of the edge.

ComplianceFrameworkConnection

The connection type for ComplianceFramework.

Fields
NameTypeDescription
edges [ComplianceFrameworkEdge]A list of edges.
nodes [ComplianceFramework]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ComplianceFrameworkEdge

The edge type for ComplianceFramework.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ComplianceFrameworkThe item at the end of the edge.

ComplianceStandardsAdherenceConnection

The connection type for ComplianceStandardsAdherence.

Fields
NameTypeDescription
edges [ComplianceStandardsAdherenceEdge]A list of edges.
nodes [ComplianceStandardsAdherence]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ComplianceStandardsAdherenceEdge

The edge type for ComplianceStandardsAdherence.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ComplianceStandardsAdherenceThe item at the end of the edge.

ComplianceViolationConnection

The connection type for ComplianceViolation.

Fields
NameTypeDescription
edges [ComplianceViolationEdge]A list of edges.
nodes [ComplianceViolation]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ComplianceViolationEdge

The edge type for ComplianceViolation.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ComplianceViolationThe item at the end of the edge.

ConnectedAgentConnection

The connection type for ConnectedAgent.

Fields
NameTypeDescription
edges [ConnectedAgentEdge]A list of edges.
nodes [ConnectedAgent]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ConnectedAgentEdge

The edge type for ConnectedAgent.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ConnectedAgentThe item at the end of the edge.

ContainerRepositoryConnection

The connection type for ContainerRepository.

Fields
NameTypeDescription
edges [ContainerRepositoryEdge]A list of edges.
nodes [ContainerRepository]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ContainerRepositoryEdge

The edge type for ContainerRepository.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ContainerRepositoryThe item at the end of the edge.

ContainerRepositoryRegistryConnection

The connection type for ContainerRepositoryRegistry.

Fields
NameTypeDescription
edges [ContainerRepositoryRegistryEdge]A list of edges.
nodes [ContainerRepositoryRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ContainerRepositoryRegistryEdge

The edge type for ContainerRepositoryRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ContainerRepositoryRegistryThe item at the end of the edge.

ContainerRepositoryTagConnection

The connection type for ContainerRepositoryTag.

Fields
NameTypeDescription
edges [ContainerRepositoryTagEdge]A list of edges.
nodes [ContainerRepositoryTag]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ContainerRepositoryTagEdge

The edge type for ContainerRepositoryTag.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ContainerRepositoryTagThe item at the end of the edge.

ContributionAnalyticsContributionConnection

The connection type for ContributionAnalyticsContribution.

Fields
NameTypeDescription
edges [ContributionAnalyticsContributionEdge]A list of edges.
nodes [ContributionAnalyticsContribution]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ContributionAnalyticsContributionEdge

The edge type for ContributionAnalyticsContribution.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ContributionAnalyticsContributionThe item at the end of the edge.

CoverageFuzzingCorpusConnection

The connection type for CoverageFuzzingCorpus.

Fields
NameTypeDescription
edges [CoverageFuzzingCorpusEdge]A list of edges.
nodes [CoverageFuzzingCorpus]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CoverageFuzzingCorpusEdge

The edge type for CoverageFuzzingCorpus.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CoverageFuzzingCorpusThe item at the end of the edge.

CustomEmojiConnection

The connection type for CustomEmoji.

Fields
NameTypeDescription
edges [CustomEmojiEdge]A list of edges.
nodes [CustomEmoji]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CustomEmojiEdge

The edge type for CustomEmoji.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CustomEmojiThe item at the end of the edge.

CustomerRelationsContactConnection

The connection type for CustomerRelationsContact.

Fields
NameTypeDescription
edges [CustomerRelationsContactEdge]A list of edges.
nodes [CustomerRelationsContact]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CustomerRelationsContactEdge

The edge type for CustomerRelationsContact.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CustomerRelationsContactThe item at the end of the edge.

CustomerRelationsOrganizationConnection

The connection type for CustomerRelationsOrganization.

Fields
NameTypeDescription
edges [CustomerRelationsOrganizationEdge]A list of edges.
nodes [CustomerRelationsOrganization]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

CustomerRelationsOrganizationEdge

The edge type for CustomerRelationsOrganization.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node CustomerRelationsOrganizationThe item at the end of the edge.

DastProfileConnection

The connection type for DastProfile.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [DastProfileEdge]A list of edges.
nodes [DastProfile]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DastProfileEdge

The edge type for DastProfile.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DastProfileThe item at the end of the edge.

DastScannerProfileConnection

The connection type for DastScannerProfile.

Fields
NameTypeDescription
edges [DastScannerProfileEdge]A list of edges.
nodes [DastScannerProfile]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DastScannerProfileEdge

The edge type for DastScannerProfile.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DastScannerProfileThe item at the end of the edge.

DastSiteProfileConnection

The connection type for DastSiteProfile.

Fields
NameTypeDescription
edges [DastSiteProfileEdge]A list of edges.
nodes [DastSiteProfile]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DastSiteProfileEdge

The edge type for DastSiteProfile.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DastSiteProfileThe item at the end of the edge.

DastSiteValidationConnection

The connection type for DastSiteValidation.

Fields
NameTypeDescription
edges [DastSiteValidationEdge]A list of edges.
nodes [DastSiteValidation]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DastSiteValidationEdge

The edge type for DastSiteValidation.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DastSiteValidationThe item at the end of the edge.

DependencyConnection

The connection type for Dependency.

Fields
NameTypeDescription
edges [DependencyEdge]A list of edges.
nodes [Dependency]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DependencyEdge

The edge type for Dependency.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DependencyThe item at the end of the edge.

DependencyProxyBlobConnection

The connection type for DependencyProxyBlob.

Fields
NameTypeDescription
edges [DependencyProxyBlobEdge]A list of edges.
nodes [DependencyProxyBlob]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DependencyProxyBlobEdge

The edge type for DependencyProxyBlob.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DependencyProxyBlobThe item at the end of the edge.

DependencyProxyBlobRegistryConnection

The connection type for DependencyProxyBlobRegistry.

Fields
NameTypeDescription
edges [DependencyProxyBlobRegistryEdge]A list of edges.
nodes [DependencyProxyBlobRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DependencyProxyBlobRegistryEdge

The edge type for DependencyProxyBlobRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DependencyProxyBlobRegistryThe item at the end of the edge.

DependencyProxyManifestConnection

The connection type for DependencyProxyManifest.

Fields
NameTypeDescription
edges [DependencyProxyManifestEdge]A list of edges.
nodes [DependencyProxyManifest]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DependencyProxyManifestEdge

The edge type for DependencyProxyManifest.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DependencyProxyManifestThe item at the end of the edge.

DependencyProxyManifestRegistryConnection

The connection type for DependencyProxyManifestRegistry.

Fields
NameTypeDescription
edges [DependencyProxyManifestRegistryEdge]A list of edges.
nodes [DependencyProxyManifestRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DependencyProxyManifestRegistryEdge

The edge type for DependencyProxyManifestRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DependencyProxyManifestRegistryThe item at the end of the edge.

DeploymentConnection

The connection type for Deployment.

Fields
NameTypeDescription
edges [DeploymentEdge]A list of edges.
nodes [Deployment]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DeploymentEdge

The edge type for Deployment.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DeploymentThe item at the end of the edge.

DesignAtVersionConnection

The connection type for DesignAtVersion.

Fields
NameTypeDescription
edges [DesignAtVersionEdge]A list of edges.
nodes [DesignAtVersion]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DesignAtVersionEdge

The edge type for DesignAtVersion.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DesignAtVersionThe item at the end of the edge.

DesignConnection

The connection type for Design.

Fields
NameTypeDescription
edges [DesignEdge]A list of edges.
nodes [Design]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DesignEdge

The edge type for Design.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DesignThe item at the end of the edge.

DesignManagementRepositoryRegistryConnection

The connection type for DesignManagementRepositoryRegistry.

Fields
NameTypeDescription
edges [DesignManagementRepositoryRegistryEdge]A list of edges.
nodes [DesignManagementRepositoryRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DesignManagementRepositoryRegistryEdge

The edge type for DesignManagementRepositoryRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DesignManagementRepositoryRegistryThe item at the end of the edge.

DesignVersionConnection

The connection type for DesignVersion.

Fields
NameTypeDescription
edges [DesignVersionEdge]A list of edges.
nodes [DesignVersion]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DesignVersionEdge

The edge type for DesignVersion.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DesignVersionThe item at the end of the edge.

DevopsAdoptionEnabledNamespaceConnection

The connection type for DevopsAdoptionEnabledNamespace.

Fields
NameTypeDescription
edges [DevopsAdoptionEnabledNamespaceEdge]A list of edges.
nodes [DevopsAdoptionEnabledNamespace]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DevopsAdoptionEnabledNamespaceEdge

The edge type for DevopsAdoptionEnabledNamespace.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DevopsAdoptionEnabledNamespaceThe item at the end of the edge.

DevopsAdoptionSnapshotConnection

The connection type for DevopsAdoptionSnapshot.

Fields
NameTypeDescription
edges [DevopsAdoptionSnapshotEdge]A list of edges.
nodes [DevopsAdoptionSnapshot]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DevopsAdoptionSnapshotEdge

The edge type for DevopsAdoptionSnapshot.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DevopsAdoptionSnapshotThe item at the end of the edge.

DiscussionConnection

The connection type for Discussion.

Fields
NameTypeDescription
edges [DiscussionEdge]A list of edges.
nodes [Discussion]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DiscussionEdge

The edge type for Discussion.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DiscussionThe item at the end of the edge.

DoraPerformanceScoreCountConnection

The connection type for DoraPerformanceScoreCount.

Fields
NameTypeDescription
edges [DoraPerformanceScoreCountEdge]A list of edges.
nodes [DoraPerformanceScoreCount]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

DoraPerformanceScoreCountEdge

The edge type for DoraPerformanceScoreCount.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node DoraPerformanceScoreCountThe item at the end of the edge.

EgressNodeConnection

The connection type for EgressNode.

Fields
NameTypeDescription
edges [EgressNodeEdge]A list of edges.
nodes [EgressNode]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

EgressNodeEdge

The edge type for EgressNode.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EgressNodeThe item at the end of the edge.

EmailConnection

The connection type for Email.

Fields
NameTypeDescription
edges [EmailEdge]A list of edges.
nodes [Email]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

EmailEdge

The edge type for Email.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EmailThe item at the end of the edge.

EnvironmentConnection

The connection type for Environment.

Fields
NameTypeDescription
edges [EnvironmentEdge]A list of edges.
nodes [Environment]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

EnvironmentEdge

The edge type for Environment.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EnvironmentThe item at the end of the edge.

EpicBoardConnection

The connection type for EpicBoard.

Fields
NameTypeDescription
edges [EpicBoardEdge]A list of edges.
nodes [EpicBoard]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

EpicBoardEdge

The edge type for EpicBoard.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EpicBoardThe item at the end of the edge.

EpicConnection

The connection type for Epic.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [EpicEdge]A list of edges.
nodes [Epic]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

EpicEdge

The edge type for Epic.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EpicThe item at the end of the edge.

EpicIssueConnection

The connection type for EpicIssue.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [EpicIssueEdge]A list of edges.
nodes [EpicIssue]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.
weight Int!Total weight of issues collection.

EpicIssueEdge

The edge type for EpicIssue.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EpicIssueThe item at the end of the edge.

EpicListConnection

The connection type for EpicList.

Fields
NameTypeDescription
edges [EpicListEdge]A list of edges.
nodes [EpicList]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

EpicListEdge

The edge type for EpicList.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EpicListThe item at the end of the edge.

EscalationPolicyTypeConnection

The connection type for EscalationPolicyType.

Fields
NameTypeDescription
edges [EscalationPolicyTypeEdge]A list of edges.
nodes [EscalationPolicyType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

EscalationPolicyTypeEdge

The edge type for EscalationPolicyType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EscalationPolicyTypeThe item at the end of the edge.

EventConnection

The connection type for Event.

Fields
NameTypeDescription
edges [EventEdge]A list of edges.
nodes [Event]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

EventEdge

The edge type for Event.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node EventThe item at the end of the edge.

ExternalAuditEventDestinationConnection

The connection type for ExternalAuditEventDestination.

Fields
NameTypeDescription
edges [ExternalAuditEventDestinationEdge]A list of edges.
nodes [ExternalAuditEventDestination]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ExternalAuditEventDestinationEdge

The edge type for ExternalAuditEventDestination.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ExternalAuditEventDestinationThe item at the end of the edge.

ExternalStatusCheckConnection

The connection type for ExternalStatusCheck.

Fields
NameTypeDescription
edges [ExternalStatusCheckEdge]A list of edges.
nodes [ExternalStatusCheck]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ExternalStatusCheckEdge

The edge type for ExternalStatusCheck.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ExternalStatusCheckThe item at the end of the edge.

ForecastDatapointConnection

The connection type for ForecastDatapoint.

Fields
NameTypeDescription
edges [ForecastDatapointEdge]A list of edges.
nodes [ForecastDatapoint]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ForecastDatapointEdge

The edge type for ForecastDatapoint.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ForecastDatapointThe item at the end of the edge.

GoogleCloudLoggingConfigurationTypeConnection

The connection type for GoogleCloudLoggingConfigurationType.

Fields
NameTypeDescription
edges [GoogleCloudLoggingConfigurationTypeEdge]A list of edges.
nodes [GoogleCloudLoggingConfigurationType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

GoogleCloudLoggingConfigurationTypeEdge

The edge type for GoogleCloudLoggingConfigurationType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node GoogleCloudLoggingConfigurationTypeThe item at the end of the edge.

GroupConnection

The connection type for Group.

Fields
NameTypeDescription
edges [GroupEdge]A list of edges.
nodes [Group]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

GroupEdge

The edge type for Group.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node GroupThe item at the end of the edge.

GroupMemberConnection

The connection type for GroupMember.

Fields
NameTypeDescription
edges [GroupMemberEdge]A list of edges.
nodes [GroupMember]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

GroupMemberEdge

The edge type for GroupMember.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node GroupMemberThe item at the end of the edge.

GroupWikiRepositoryRegistryConnection

The connection type for GroupWikiRepositoryRegistry.

Fields
NameTypeDescription
edges [GroupWikiRepositoryRegistryEdge]A list of edges.
nodes [GroupWikiRepositoryRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

GroupWikiRepositoryRegistryEdge

The edge type for GroupWikiRepositoryRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node GroupWikiRepositoryRegistryThe item at the end of the edge.

IncidentManagementOncallRotationConnection

The connection type for IncidentManagementOncallRotation.

Fields
NameTypeDescription
edges [IncidentManagementOncallRotationEdge]A list of edges.
nodes [IncidentManagementOncallRotation]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

IncidentManagementOncallRotationEdge

The edge type for IncidentManagementOncallRotation.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node IncidentManagementOncallRotationThe item at the end of the edge.

IncidentManagementOncallScheduleConnection

The connection type for IncidentManagementOncallSchedule.

Fields
NameTypeDescription
edges [IncidentManagementOncallScheduleEdge]A list of edges.
nodes [IncidentManagementOncallSchedule]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

IncidentManagementOncallScheduleEdge

The edge type for IncidentManagementOncallSchedule.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node IncidentManagementOncallScheduleThe item at the end of the edge.

IncidentManagementOncallShiftConnection

The connection type for IncidentManagementOncallShift.

Fields
NameTypeDescription
edges [IncidentManagementOncallShiftEdge]A list of edges.
nodes [IncidentManagementOncallShift]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

IncidentManagementOncallShiftEdge

The edge type for IncidentManagementOncallShift.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node IncidentManagementOncallShiftThe item at the end of the edge.

InheritedCiVariableConnection

The connection type for InheritedCiVariable.

Fields
NameTypeDescription
edges [InheritedCiVariableEdge]A list of edges.
nodes [InheritedCiVariable]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

InheritedCiVariableEdge

The edge type for InheritedCiVariable.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node InheritedCiVariableThe item at the end of the edge.

InstanceExternalAuditEventDestinationConnection

The connection type for InstanceExternalAuditEventDestination.

Fields
NameTypeDescription
edges [InstanceExternalAuditEventDestinationEdge]A list of edges.
nodes [InstanceExternalAuditEventDestination]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

InstanceExternalAuditEventDestinationEdge

The edge type for InstanceExternalAuditEventDestination.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node InstanceExternalAuditEventDestinationThe item at the end of the edge.

IssuableResourceLinkConnection

The connection type for IssuableResourceLink.

Fields
NameTypeDescription
edges [IssuableResourceLinkEdge]A list of edges.
nodes [IssuableResourceLink]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

IssuableResourceLinkEdge

The edge type for IssuableResourceLink.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node IssuableResourceLinkThe item at the end of the edge.

IssueConnection

The connection type for Issue.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [IssueEdge]A list of edges.
nodes [Issue]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.
weight Int!Total weight of issues collection.

IssueEdge

The edge type for Issue.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node IssueThe item at the end of the edge.

IterationCadenceConnection

The connection type for IterationCadence.

Fields
NameTypeDescription
edges [IterationCadenceEdge]A list of edges.
nodes [IterationCadence]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

IterationCadenceEdge

The edge type for IterationCadence.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node IterationCadenceThe item at the end of the edge.

IterationConnection

The connection type for Iteration.

Fields
NameTypeDescription
edges [IterationEdge]A list of edges.
nodes [Iteration]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

IterationEdge

The edge type for Iteration.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node IterationThe item at the end of the edge.

JiraImportConnection

The connection type for JiraImport.

Fields
NameTypeDescription
edges [JiraImportEdge]A list of edges.
nodes [JiraImport]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

JiraImportEdge

The edge type for JiraImport.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node JiraImportThe item at the end of the edge.

JiraProjectConnection

The connection type for JiraProject.

Fields
NameTypeDescription
edges [JiraProjectEdge]A list of edges.
nodes [JiraProject]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

JiraProjectEdge

The edge type for JiraProject.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node JiraProjectThe item at the end of the edge.

JobArtifactRegistryConnection

The connection type for JobArtifactRegistry.

Fields
NameTypeDescription
edges [JobArtifactRegistryEdge]A list of edges.
nodes [JobArtifactRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

JobArtifactRegistryEdge

The edge type for JobArtifactRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node JobArtifactRegistryThe item at the end of the edge.

JobNeedUnionConnection

The connection type for JobNeedUnion.

Fields
NameTypeDescription
edges [JobNeedUnionEdge]A list of edges.
nodes [JobNeedUnion]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

JobNeedUnionEdge

The edge type for JobNeedUnion.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node JobNeedUnionThe item at the end of the edge.

LabelConnection

The connection type for Label.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [LabelEdge]A list of edges.
nodes [Label]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

LabelEdge

The edge type for Label.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node LabelThe item at the end of the edge.

LfsObjectRegistryConnection

The connection type for LfsObjectRegistry.

Fields
NameTypeDescription
edges [LfsObjectRegistryEdge]A list of edges.
nodes [LfsObjectRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

LfsObjectRegistryEdge

The edge type for LfsObjectRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node LfsObjectRegistryThe item at the end of the edge.

LicenseHistoryEntryConnection

The connection type for LicenseHistoryEntry.

Fields
NameTypeDescription
edges [LicenseHistoryEntryEdge]A list of edges.
nodes [LicenseHistoryEntry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

LicenseHistoryEntryEdge

The edge type for LicenseHistoryEntry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node LicenseHistoryEntryThe item at the end of the edge.

MemberInterfaceConnection

The connection type for MemberInterface.

Fields
NameTypeDescription
edges [MemberInterfaceEdge]A list of edges.
nodes [MemberInterface]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MemberInterfaceEdge

The edge type for MemberInterface.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MemberInterfaceThe item at the end of the edge.

MergeAccessLevelConnection

The connection type for MergeAccessLevel.

Fields
NameTypeDescription
edges [MergeAccessLevelEdge]A list of edges.
nodes [MergeAccessLevel]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MergeAccessLevelEdge

The edge type for MergeAccessLevel.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeAccessLevelThe item at the end of the edge.

MergeRequestAssigneeConnection

The connection type for MergeRequestAssignee.

Fields
NameTypeDescription
edges [MergeRequestAssigneeEdge]A list of edges.
nodes [MergeRequestAssignee]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MergeRequestAssigneeEdge

The edge type for MergeRequestAssignee.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeRequestAssigneeThe item at the end of the edge.

MergeRequestConnection

The connection type for MergeRequest.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [MergeRequestEdge]A list of edges.
nodes [MergeRequest]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.
totalTimeToMerge FloatTotal sum of time to merge, in seconds, for the collection of merge requests.

MergeRequestDiffConnection

The connection type for MergeRequestDiff.

Fields
NameTypeDescription
edges [MergeRequestDiffEdge]A list of edges.
nodes [MergeRequestDiff]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MergeRequestDiffEdge

The edge type for MergeRequestDiff.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeRequestDiffThe item at the end of the edge.

MergeRequestDiffLlmSummaryConnection

The connection type for MergeRequestDiffLlmSummary.

Fields
NameTypeDescription
edges [MergeRequestDiffLlmSummaryEdge]A list of edges.
nodes [MergeRequestDiffLlmSummary]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MergeRequestDiffLlmSummaryEdge

The edge type for MergeRequestDiffLlmSummary.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeRequestDiffLlmSummaryThe item at the end of the edge.

MergeRequestDiffRegistryConnection

The connection type for MergeRequestDiffRegistry.

Fields
NameTypeDescription
edges [MergeRequestDiffRegistryEdge]A list of edges.
nodes [MergeRequestDiffRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MergeRequestDiffRegistryEdge

The edge type for MergeRequestDiffRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeRequestDiffRegistryThe item at the end of the edge.

MergeRequestEdge

The edge type for MergeRequest.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeRequestThe item at the end of the edge.

MergeRequestParticipantConnection

The connection type for MergeRequestParticipant.

Fields
NameTypeDescription
edges [MergeRequestParticipantEdge]A list of edges.
nodes [MergeRequestParticipant]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MergeRequestParticipantEdge

The edge type for MergeRequestParticipant.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeRequestParticipantThe item at the end of the edge.

MergeRequestReviewLlmSummaryConnection

The connection type for MergeRequestReviewLlmSummary.

Fields
NameTypeDescription
edges [MergeRequestReviewLlmSummaryEdge]A list of edges.
nodes [MergeRequestReviewLlmSummary]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MergeRequestReviewLlmSummaryEdge

The edge type for MergeRequestReviewLlmSummary.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeRequestReviewLlmSummaryThe item at the end of the edge.

MergeRequestReviewerConnection

The connection type for MergeRequestReviewer.

Fields
NameTypeDescription
edges [MergeRequestReviewerEdge]A list of edges.
nodes [MergeRequestReviewer]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MergeRequestReviewerEdge

The edge type for MergeRequestReviewer.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MergeRequestReviewerThe item at the end of the edge.

MilestoneConnection

The connection type for Milestone.

Fields
NameTypeDescription
edges [MilestoneEdge]A list of edges.
nodes [Milestone]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

MilestoneEdge

The edge type for Milestone.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node MilestoneThe item at the end of the edge.

NamespaceCommitEmailConnection

The connection type for NamespaceCommitEmail.

Fields
NameTypeDescription
edges [NamespaceCommitEmailEdge]A list of edges.
nodes [NamespaceCommitEmail]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

NamespaceCommitEmailEdge

The edge type for NamespaceCommitEmail.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node NamespaceCommitEmailThe item at the end of the edge.

NamespaceConnection

The connection type for Namespace.

Fields
NameTypeDescription
edges [NamespaceEdge]A list of edges.
nodes [Namespace]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

NamespaceEdge

The edge type for Namespace.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node NamespaceThe item at the end of the edge.

NestedEnvironmentConnection

The connection type for NestedEnvironment.

Fields
NameTypeDescription
edges [NestedEnvironmentEdge]A list of edges.
nodes [NestedEnvironment]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

NestedEnvironmentEdge

The edge type for NestedEnvironment.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node NestedEnvironmentThe item at the end of the edge.

NetworkPolicyConnection

The connection type for NetworkPolicy.

Fields
NameTypeDescription
edges [NetworkPolicyEdge]A list of edges.
nodes [NetworkPolicy]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

NetworkPolicyEdge

The edge type for NetworkPolicy.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node NetworkPolicyThe item at the end of the edge.

NoteConnection

The connection type for Note.

Fields
NameTypeDescription
edges [NoteEdge]A list of edges.
nodes [Note]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

NoteEdge

The edge type for Note.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node NoteThe item at the end of the edge.

OncallParticipantTypeConnection

The connection type for OncallParticipantType.

Fields
NameTypeDescription
edges [OncallParticipantTypeEdge]A list of edges.
nodes [OncallParticipantType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

OncallParticipantTypeEdge

The edge type for OncallParticipantType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node OncallParticipantTypeThe item at the end of the edge.

PackageBaseConnection

The connection type for PackageBase.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [PackageBaseEdge]A list of edges.
nodes [PackageBase]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PackageBaseEdge

The edge type for PackageBase.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PackageBaseThe item at the end of the edge.

PackageConnection

The connection type for Package.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [PackageEdge]A list of edges.
nodes [Package]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PackageDependencyLinkConnection

The connection type for PackageDependencyLink.

Fields
NameTypeDescription
edges [PackageDependencyLinkEdge]A list of edges.
nodes [PackageDependencyLink]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PackageDependencyLinkEdge

The edge type for PackageDependencyLink.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PackageDependencyLinkThe item at the end of the edge.

PackageEdge

The edge type for Package.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PackageThe item at the end of the edge.

PackageFileConnection

The connection type for PackageFile.

Fields
NameTypeDescription
edges [PackageFileEdge]A list of edges.
nodes [PackageFile]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PackageFileEdge

The edge type for PackageFile.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PackageFileThe item at the end of the edge.

PackageFileRegistryConnection

The connection type for PackageFileRegistry.

Fields
NameTypeDescription
edges [PackageFileRegistryEdge]A list of edges.
nodes [PackageFileRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PackageFileRegistryEdge

The edge type for PackageFileRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PackageFileRegistryThe item at the end of the edge.

PackageTagConnection

The connection type for PackageTag.

Fields
NameTypeDescription
edges [PackageTagEdge]A list of edges.
nodes [PackageTag]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PackageTagEdge

The edge type for PackageTag.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PackageTagThe item at the end of the edge.

PagesDeploymentRegistryConnection

The connection type for PagesDeploymentRegistry.

Fields
NameTypeDescription
edges [PagesDeploymentRegistryEdge]A list of edges.
nodes [PagesDeploymentRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PagesDeploymentRegistryEdge

The edge type for PagesDeploymentRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PagesDeploymentRegistryThe item at the end of the edge.

PathLockConnection

The connection type for PathLock.

Fields
NameTypeDescription
edges [PathLockEdge]A list of edges.
nodes [PathLock]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PathLockEdge

The edge type for PathLock.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PathLockThe item at the end of the edge.

PipelineArtifactRegistryConnection

The connection type for PipelineArtifactRegistry.

Fields
NameTypeDescription
edges [PipelineArtifactRegistryEdge]A list of edges.
nodes [PipelineArtifactRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PipelineArtifactRegistryEdge

The edge type for PipelineArtifactRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PipelineArtifactRegistryThe item at the end of the edge.

PipelineConnection

The connection type for Pipeline.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [PipelineEdge]A list of edges.
nodes [Pipeline]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PipelineEdge

The edge type for Pipeline.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PipelineThe item at the end of the edge.

PipelineScheduleConnection

The connection type for PipelineSchedule.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [PipelineScheduleEdge]A list of edges.
nodes [PipelineSchedule]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PipelineScheduleEdge

The edge type for PipelineSchedule.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PipelineScheduleThe item at the end of the edge.

PipelineScheduleVariableConnection

The connection type for PipelineScheduleVariable.

Fields
NameTypeDescription
edges [PipelineScheduleVariableEdge]A list of edges.
nodes [PipelineScheduleVariable]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PipelineScheduleVariableEdge

The edge type for PipelineScheduleVariable.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PipelineScheduleVariableThe item at the end of the edge.

PipelineSecurityReportFindingConnection

The connection type for PipelineSecurityReportFinding.

Fields
NameTypeDescription
edges [PipelineSecurityReportFindingEdge]A list of edges.
nodes [PipelineSecurityReportFinding]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PipelineSecurityReportFindingEdge

The edge type for PipelineSecurityReportFinding.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PipelineSecurityReportFindingThe item at the end of the edge.

ProductAnalyticsDashboardConnection

The connection type for ProductAnalyticsDashboard.

Fields
NameTypeDescription
edges [ProductAnalyticsDashboardEdge]A list of edges.
nodes [ProductAnalyticsDashboard]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProductAnalyticsDashboardEdge

The edge type for ProductAnalyticsDashboard.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProductAnalyticsDashboardThe item at the end of the edge.

ProductAnalyticsDashboardPanelConnection

The connection type for ProductAnalyticsDashboardPanel.

Fields
NameTypeDescription
edges [ProductAnalyticsDashboardPanelEdge]A list of edges.
nodes [ProductAnalyticsDashboardPanel]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProductAnalyticsDashboardPanelEdge

The edge type for ProductAnalyticsDashboardPanel.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProductAnalyticsDashboardPanelThe item at the end of the edge.

ProductAnalyticsDashboardVisualizationConnection

The connection type for ProductAnalyticsDashboardVisualization.

Fields
NameTypeDescription
edges [ProductAnalyticsDashboardVisualizationEdge]A list of edges.
nodes [ProductAnalyticsDashboardVisualization]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProductAnalyticsDashboardVisualizationEdge

The edge type for ProductAnalyticsDashboardVisualization.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProductAnalyticsDashboardVisualizationThe item at the end of the edge.

ProjectConnection

The connection type for Project.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [ProjectEdge]A list of edges.
nodes [Project]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProjectEdge

The edge type for Project.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProjectThe item at the end of the edge.

ProjectMemberConnection

The connection type for ProjectMember.

Fields
NameTypeDescription
edges [ProjectMemberEdge]A list of edges.
nodes [ProjectMember]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProjectMemberEdge

The edge type for ProjectMember.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProjectMemberThe item at the end of the edge.

ProjectRepositoryRegistryConnection

The connection type for ProjectRepositoryRegistry.

Fields
NameTypeDescription
edges [ProjectRepositoryRegistryEdge]A list of edges.
nodes [ProjectRepositoryRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProjectRepositoryRegistryEdge

The edge type for ProjectRepositoryRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProjectRepositoryRegistryThe item at the end of the edge.

ProjectWikiRepositoryRegistryConnection

The connection type for ProjectWikiRepositoryRegistry.

Fields
NameTypeDescription
edges [ProjectWikiRepositoryRegistryEdge]A list of edges.
nodes [ProjectWikiRepositoryRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProjectWikiRepositoryRegistryEdge

The edge type for ProjectWikiRepositoryRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProjectWikiRepositoryRegistryThe item at the end of the edge.

ProtectedEnvironmentApprovalRuleConnection

The connection type for ProtectedEnvironmentApprovalRule.

Fields
NameTypeDescription
edges [ProtectedEnvironmentApprovalRuleEdge]A list of edges.
nodes [ProtectedEnvironmentApprovalRule]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProtectedEnvironmentApprovalRuleEdge

The edge type for ProtectedEnvironmentApprovalRule.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProtectedEnvironmentApprovalRuleThe item at the end of the edge.

ProtectedEnvironmentConnection

The connection type for ProtectedEnvironment.

Fields
NameTypeDescription
edges [ProtectedEnvironmentEdge]A list of edges.
nodes [ProtectedEnvironment]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProtectedEnvironmentDeployAccessLevelConnection

The connection type for ProtectedEnvironmentDeployAccessLevel.

Fields
NameTypeDescription
edges [ProtectedEnvironmentDeployAccessLevelEdge]A list of edges.
nodes [ProtectedEnvironmentDeployAccessLevel]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ProtectedEnvironmentDeployAccessLevelEdge

The edge type for ProtectedEnvironmentDeployAccessLevel.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProtectedEnvironmentDeployAccessLevelThe item at the end of the edge.

ProtectedEnvironmentEdge

The edge type for ProtectedEnvironment.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ProtectedEnvironmentThe item at the end of the edge.

PushAccessLevelConnection

The connection type for PushAccessLevel.

Fields
NameTypeDescription
edges [PushAccessLevelEdge]A list of edges.
nodes [PushAccessLevel]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

PushAccessLevelEdge

The edge type for PushAccessLevel.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node PushAccessLevelThe item at the end of the edge.

ReleaseAssetLinkConnection

The connection type for ReleaseAssetLink.

Fields
NameTypeDescription
edges [ReleaseAssetLinkEdge]A list of edges.
nodes [ReleaseAssetLink]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ReleaseAssetLinkEdge

The edge type for ReleaseAssetLink.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ReleaseAssetLinkThe item at the end of the edge.

ReleaseConnection

The connection type for Release.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [ReleaseEdge]A list of edges.
nodes [Release]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ReleaseEdge

The edge type for Release.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ReleaseThe item at the end of the edge.

ReleaseEvidenceConnection

The connection type for ReleaseEvidence.

Fields
NameTypeDescription
edges [ReleaseEvidenceEdge]A list of edges.
nodes [ReleaseEvidence]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ReleaseEvidenceEdge

The edge type for ReleaseEvidence.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ReleaseEvidenceThe item at the end of the edge.

ReleaseSourceConnection

The connection type for ReleaseSource.

Fields
NameTypeDescription
edges [ReleaseSourceEdge]A list of edges.
nodes [ReleaseSource]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ReleaseSourceEdge

The edge type for ReleaseSource.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ReleaseSourceThe item at the end of the edge.

RepositoryBlobConnection

The connection type for RepositoryBlob.

Fields
NameTypeDescription
edges [RepositoryBlobEdge]A list of edges.
nodes [RepositoryBlob]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

RepositoryBlobEdge

The edge type for RepositoryBlob.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node RepositoryBlobThe item at the end of the edge.

RequirementConnection

The connection type for Requirement.

Fields
NameTypeDescription
edges [RequirementEdge]A list of edges.
nodes [Requirement]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

RequirementEdge

The edge type for Requirement.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node RequirementThe item at the end of the edge.

RunnerArchitectureConnection

The connection type for RunnerArchitecture.

Fields
NameTypeDescription
edges [RunnerArchitectureEdge]A list of edges.
nodes [RunnerArchitecture]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

RunnerArchitectureEdge

The edge type for RunnerArchitecture.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node RunnerArchitectureThe item at the end of the edge.

RunnerPlatformConnection

The connection type for RunnerPlatform.

Fields
NameTypeDescription
edges [RunnerPlatformEdge]A list of edges.
nodes [RunnerPlatform]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

RunnerPlatformEdge

The edge type for RunnerPlatform.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node RunnerPlatformThe item at the end of the edge.

SastCiConfigurationAnalyzersEntityConnection

The connection type for SastCiConfigurationAnalyzersEntity.

Fields
NameTypeDescription
edges [SastCiConfigurationAnalyzersEntityEdge]A list of edges.
nodes [SastCiConfigurationAnalyzersEntity]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SastCiConfigurationAnalyzersEntityEdge

The edge type for SastCiConfigurationAnalyzersEntity.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SastCiConfigurationAnalyzersEntityThe item at the end of the edge.

SastCiConfigurationEntityConnection

The connection type for SastCiConfigurationEntity.

Fields
NameTypeDescription
edges [SastCiConfigurationEntityEdge]A list of edges.
nodes [SastCiConfigurationEntity]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SastCiConfigurationEntityEdge

The edge type for SastCiConfigurationEntity.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SastCiConfigurationEntityThe item at the end of the edge.

SastCiConfigurationOptionsEntityConnection

The connection type for SastCiConfigurationOptionsEntity.

Fields
NameTypeDescription
edges [SastCiConfigurationOptionsEntityEdge]A list of edges.
nodes [SastCiConfigurationOptionsEntity]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SastCiConfigurationOptionsEntityEdge

The edge type for SastCiConfigurationOptionsEntity.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SastCiConfigurationOptionsEntityThe item at the end of the edge.

SavedReplyConnection

The connection type for SavedReply.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [SavedReplyEdge]A list of edges.
nodes [SavedReply]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SavedReplyEdge

The edge type for SavedReply.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SavedReplyThe item at the end of the edge.

ScanConnection

The connection type for Scan.

Fields
NameTypeDescription
edges [ScanEdge]A list of edges.
nodes [Scan]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ScanEdge

The edge type for Scan.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ScanThe item at the end of the edge.

ScanExecutionPolicyConnection

The connection type for ScanExecutionPolicy.

Fields
NameTypeDescription
edges [ScanExecutionPolicyEdge]A list of edges.
nodes [ScanExecutionPolicy]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ScanExecutionPolicyEdge

The edge type for ScanExecutionPolicy.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ScanExecutionPolicyThe item at the end of the edge.

ScanResultPolicyConnection

The connection type for ScanResultPolicy.

Fields
NameTypeDescription
edges [ScanResultPolicyEdge]A list of edges.
nodes [ScanResultPolicy]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ScanResultPolicyEdge

The edge type for ScanResultPolicy.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ScanResultPolicyThe item at the end of the edge.

ScannedResourceConnection

The connection type for ScannedResource.

Fields
NameTypeDescription
edges [ScannedResourceEdge]A list of edges.
nodes [ScannedResource]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ScannedResourceEdge

The edge type for ScannedResource.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ScannedResourceThe item at the end of the edge.

SentryErrorConnection

The connection type for SentryError.

Fields
NameTypeDescription
edges [SentryErrorEdge]A list of edges.
nodes [SentryError]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SentryErrorEdge

The edge type for SentryError.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SentryErrorThe item at the end of the edge.

ServiceConnection

The connection type for Service.

Fields
NameTypeDescription
edges [ServiceEdge]A list of edges.
nodes [Service]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

ServiceEdge

The edge type for Service.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node ServiceThe item at the end of the edge.

SnippetBlobConnection

The connection type for SnippetBlob.

Fields
NameTypeDescription
edges [SnippetBlobEdge]A list of edges.
hasUnretrievableBlobs Boolean!Indicates if the snippet has unretrievable blobs.
nodes [SnippetBlob]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SnippetBlobEdge

The edge type for SnippetBlob.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SnippetBlobThe item at the end of the edge.

SnippetConnection

The connection type for Snippet.

Fields
NameTypeDescription
edges [SnippetEdge]A list of edges.
nodes [Snippet]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SnippetEdge

The edge type for Snippet.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SnippetThe item at the end of the edge.

SnippetRepositoryRegistryConnection

The connection type for SnippetRepositoryRegistry.

Fields
NameTypeDescription
edges [SnippetRepositoryRegistryEdge]A list of edges.
nodes [SnippetRepositoryRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SnippetRepositoryRegistryEdge

The edge type for SnippetRepositoryRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SnippetRepositoryRegistryThe item at the end of the edge.

SubmoduleConnection

The connection type for Submodule.

Fields
NameTypeDescription
edges [SubmoduleEdge]A list of edges.
nodes [Submodule]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SubmoduleEdge

The edge type for Submodule.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SubmoduleThe item at the end of the edge.

SubscriptionFutureEntryConnection

The connection type for SubscriptionFutureEntry.

Fields
NameTypeDescription
edges [SubscriptionFutureEntryEdge]A list of edges.
nodes [SubscriptionFutureEntry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

SubscriptionFutureEntryEdge

The edge type for SubscriptionFutureEntry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node SubscriptionFutureEntryThe item at the end of the edge.

TerraformStateConnection

The connection type for TerraformState.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [TerraformStateEdge]A list of edges.
nodes [TerraformState]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TerraformStateEdge

The edge type for TerraformState.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TerraformStateThe item at the end of the edge.

TerraformStateVersionRegistryConnection

The connection type for TerraformStateVersionRegistry.

Fields
NameTypeDescription
edges [TerraformStateVersionRegistryEdge]A list of edges.
nodes [TerraformStateVersionRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TerraformStateVersionRegistryEdge

The edge type for TerraformStateVersionRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TerraformStateVersionRegistryThe item at the end of the edge.

TestCaseConnection

The connection type for TestCase.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [TestCaseEdge]A list of edges.
nodes [TestCase]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TestCaseEdge

The edge type for TestCase.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TestCaseThe item at the end of the edge.

TestReportConnection

The connection type for TestReport.

Fields
NameTypeDescription
edges [TestReportEdge]A list of edges.
nodes [TestReport]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TestReportEdge

The edge type for TestReport.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TestReportThe item at the end of the edge.

TestSuiteSummaryConnection

The connection type for TestSuiteSummary.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [TestSuiteSummaryEdge]A list of edges.
nodes [TestSuiteSummary]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TestSuiteSummaryEdge

The edge type for TestSuiteSummary.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TestSuiteSummaryThe item at the end of the edge.

TimeTrackingTimelogCategoryConnection

The connection type for TimeTrackingTimelogCategory.

Fields
NameTypeDescription
edges [TimeTrackingTimelogCategoryEdge]A list of edges.
nodes [TimeTrackingTimelogCategory]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TimeTrackingTimelogCategoryEdge

The edge type for TimeTrackingTimelogCategory.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TimeTrackingTimelogCategoryThe item at the end of the edge.

TimelineEventTagTypeConnection

The connection type for TimelineEventTagType.

Fields
NameTypeDescription
edges [TimelineEventTagTypeEdge]A list of edges.
nodes [TimelineEventTagType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TimelineEventTagTypeEdge

The edge type for TimelineEventTagType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TimelineEventTagTypeThe item at the end of the edge.

TimelineEventTypeConnection

The connection type for TimelineEventType.

Fields
NameTypeDescription
edges [TimelineEventTypeEdge]A list of edges.
nodes [TimelineEventType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TimelineEventTypeEdge

The edge type for TimelineEventType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TimelineEventTypeThe item at the end of the edge.

TimelogConnection

The connection type for Timelog.

Fields
NameTypeDescription
count Int!Total count of collection.
edges [TimelogEdge]A list of edges.
nodes [Timelog]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.
totalSpentTime BigInt!Total time spent in seconds.

TimelogEdge

The edge type for Timelog.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TimelogThe item at the end of the edge.

TodoConnection

The connection type for Todo.

Fields
NameTypeDescription
edges [TodoEdge]A list of edges.
nodes [Todo]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TodoEdge

The edge type for Todo.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TodoThe item at the end of the edge.

TopicConnection

The connection type for Topic.

Fields
NameTypeDescription
edges [TopicEdge]A list of edges.
nodes [Topic]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TopicEdge

The edge type for Topic.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TopicThe item at the end of the edge.

TreeConnection

The connection type for Tree.

Fields
NameTypeDescription
edges [TreeEdge]A list of edges.
nodes [Tree]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TreeEdge

The edge type for Tree.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TreeThe item at the end of the edge.

TreeEntryConnection

The connection type for TreeEntry.

Fields
NameTypeDescription
edges [TreeEntryEdge]A list of edges.
nodes [TreeEntry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

TreeEntryEdge

The edge type for TreeEntry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node TreeEntryThe item at the end of the edge.

UnprotectAccessLevelConnection

The connection type for UnprotectAccessLevel.

Fields
NameTypeDescription
edges [UnprotectAccessLevelEdge]A list of edges.
nodes [UnprotectAccessLevel]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

UnprotectAccessLevelEdge

The edge type for UnprotectAccessLevel.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node UnprotectAccessLevelThe item at the end of the edge.

UploadRegistryConnection

The connection type for UploadRegistry.

Fields
NameTypeDescription
edges [UploadRegistryEdge]A list of edges.
nodes [UploadRegistry]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

UploadRegistryEdge

The edge type for UploadRegistry.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node UploadRegistryThe item at the end of the edge.

UsageTrendsMeasurementConnection

The connection type for UsageTrendsMeasurement.

Fields
NameTypeDescription
edges [UsageTrendsMeasurementEdge]A list of edges.
nodes [UsageTrendsMeasurement]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

UsageTrendsMeasurementEdge

The edge type for UsageTrendsMeasurement.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node UsageTrendsMeasurementThe item at the end of the edge.

UserAchievementConnection

The connection type for UserAchievement.

Fields
NameTypeDescription
edges [UserAchievementEdge]A list of edges.
nodes [UserAchievement]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

UserAchievementEdge

The edge type for UserAchievement.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node UserAchievementThe item at the end of the edge.

UserCalloutConnection

The connection type for UserCallout.

Fields
NameTypeDescription
edges [UserCalloutEdge]A list of edges.
nodes [UserCallout]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

UserCalloutEdge

The edge type for UserCallout.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node UserCalloutThe item at the end of the edge.

UserCoreConnection

The connection type for UserCore.

Fields
NameTypeDescription
edges [UserCoreEdge]A list of edges.
nodes [UserCore]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

UserCoreEdge

The edge type for UserCore.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node UserCoreThe item at the end of the edge.

VulnerabilitiesCountByDayConnection

The connection type for VulnerabilitiesCountByDay.

Fields
NameTypeDescription
edges [VulnerabilitiesCountByDayEdge]A list of edges.
nodes [VulnerabilitiesCountByDay]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

VulnerabilitiesCountByDayEdge

The edge type for VulnerabilitiesCountByDay.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node VulnerabilitiesCountByDayThe item at the end of the edge.

VulnerabilityConnection

The connection type for Vulnerability.

Fields
NameTypeDescription
edges [VulnerabilityEdge]A list of edges.
nodes [Vulnerability]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

VulnerabilityContainerImageConnection

The connection type for VulnerabilityContainerImage.

Fields
NameTypeDescription
edges [VulnerabilityContainerImageEdge]A list of edges.
nodes [VulnerabilityContainerImage]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

VulnerabilityContainerImageEdge

The edge type for VulnerabilityContainerImage.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node VulnerabilityContainerImageThe item at the end of the edge.

VulnerabilityEdge

The edge type for Vulnerability.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node VulnerabilityThe item at the end of the edge.

VulnerabilityExternalIssueLinkConnection

The connection type for VulnerabilityExternalIssueLink.

Fields
NameTypeDescription
edges [VulnerabilityExternalIssueLinkEdge]A list of edges.
nodes [VulnerabilityExternalIssueLink]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

VulnerabilityExternalIssueLinkEdge

The edge type for VulnerabilityExternalIssueLink.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node VulnerabilityExternalIssueLinkThe item at the end of the edge.

VulnerabilityIssueLinkConnection

The connection type for VulnerabilityIssueLink.

Fields
NameTypeDescription
edges [VulnerabilityIssueLinkEdge]A list of edges.
nodes [VulnerabilityIssueLink]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

VulnerabilityIssueLinkEdge

The edge type for VulnerabilityIssueLink.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node VulnerabilityIssueLinkThe item at the end of the edge.

VulnerabilityScannerConnection

The connection type for VulnerabilityScanner.

Fields
NameTypeDescription
edges [VulnerabilityScannerEdge]A list of edges.
nodes [VulnerabilityScanner]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

VulnerabilityScannerEdge

The edge type for VulnerabilityScanner.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node VulnerabilityScannerThe item at the end of the edge.

VulnerabilityStateTransitionTypeConnection

The connection type for VulnerabilityStateTransitionType.

Fields
NameTypeDescription
edges [VulnerabilityStateTransitionTypeEdge]A list of edges.
nodes [VulnerabilityStateTransitionType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

VulnerabilityStateTransitionTypeEdge

The edge type for VulnerabilityStateTransitionType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node VulnerabilityStateTransitionTypeThe item at the end of the edge.

WorkItemConnection

The connection type for WorkItem.

Fields
NameTypeDescription
edges [WorkItemEdge]A list of edges.
nodes [WorkItem]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

WorkItemEdge

The edge type for WorkItem.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node WorkItemThe item at the end of the edge.

WorkItemTypeConnection

The connection type for WorkItemType.

Fields
NameTypeDescription
edges [WorkItemTypeEdge]A list of edges.
nodes [WorkItemType]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

WorkItemTypeEdge

The edge type for WorkItemType.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node WorkItemTypeThe item at the end of the edge.

WorkspaceConnection

The connection type for Workspace.

Fields
NameTypeDescription
edges [WorkspaceEdge]A list of edges.
nodes [Workspace]A list of nodes.
pageInfo PageInfo!Information to aid in pagination.

WorkspaceEdge

The edge type for Workspace.

Fields
NameTypeDescription
cursor String!A cursor for use in pagination.
node WorkspaceThe item at the end of the edge.

Object types

Object types represent the resources that the GitLab GraphQL API can return. They contain fields. Each field has its own type, which will either be one of the basic GraphQL scalar types (e.g.: String or Boolean) or other object types. Fields may have arguments. Fields with arguments are exactly like top-level queries, and are listed beneath the table of fields for each object type.

For more information, see Object Types and Fields on graphql.org.

AccessLevel

Represents the access level of a relationship between a User and object that it is related to.

Fields

NameTypeDescription
integerValue IntInteger representation of access level.
stringValue AccessLevelEnumString representation of access level.

AccessLevelGroup

Representation of a GitLab group.

Fields

NameTypeDescription
avatarUrl StringAvatar URL of the group.
id ID!ID of the group.
name String!Name of the group.
parent AccessLevelGroupParent group.
webUrl String!Web URL of the group.

AccessLevelUser

Representation of a GitLab user.

Fields

NameTypeDescription
avatarUrl StringURL of the user’s avatar.
id ID!ID of the user.
name String!Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
publicEmail StringUser’s public email.
username String!Username of the user. Unique within this instance of GitLab.
webPath String!Web path of the user.
webUrl String!Web URL of the user.

Achievement

Fields

NameTypeDescription
avatarUrl StringURL to avatar of the achievement.
createdAt Time!Timestamp the achievement was created.
description StringDescription or notes for the achievement.
id AchievementsAchievementID!ID of the achievement.
name String!Name of the achievement.
namespace NamespaceNamespace of the achievement.
updatedAt Time!Timestamp the achievement was last updated.
userAchievements UserAchievementConnection Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Recipients for the achievement.

AddOnPurchase

Represents AddOn purchase for Namespace.

Fields

NameTypeDescription
assignedQuantity Int!Number of seats assigned.
id GitlabSubscriptionsAddOnPurchaseID!ID of AddOnPurchase.
name String!Name of AddOn.
purchasedQuantity Int!Number of seats purchased.

AgentConfiguration

Configuration details for an Agent.

Fields

NameTypeDescription
agentName StringName of the agent.

AgentMetadata

Information about a connected Agent.

Fields

NameTypeDescription
commit StringAgent version commit.
podName StringName of the pod running the Agent.
podNamespace StringNamespace of the pod running the Agent.
version StringAgent version tag.

AiCachedMessageType

Fields

NameTypeDescription
content StringContent of the message. Can be null for failed responses.
errors [String!]!Errors that occurred while asynchronously fetching an AI (assistant) response.
id IDUUID of the message.
requestId IDUUID of the original request message.
role AiCachedMessageRole!Message role.
timestamp Time!Message timestamp.

AiMessageType

Fields

NameTypeDescription
content StringContent of the message or null if loading.
errors [String!]!Errors that occurred while asynchronously fetching an AI(assistant) response.
id IDGlobal ID of the message.
isFetching BooleanWhether the content is still being fetched, for a message with the assistant role.
role String!Role of the message (system, user, assistant).

AiResponse

Fields

NameTypeDescription
errors [String!]Errors return by AI API as response.
requestId StringID of the original request.
responseBody StringResponse body from AI API.

AlertManagementAlert

Describes an alert from the project’s Alert Management.

Fields

NameTypeDescription
assignees UserCoreConnectionAssignees of the alert. (see Connections)
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
createdAt TimeTimestamp the alert was created.
description StringDescription of the alert.
details JSONAlert details.
detailsUrl String!URL of the alert detail page.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
endedAt TimeTimestamp the alert ended.
environment EnvironmentEnvironment for the alert.
eventCount IntNumber of events of this alert.
hosts [String!]List of hosts the alert came from.
id ID!ID of the alert.
iid ID!Internal ID of the alert.
issue IssueIssue attached to the alert.
issueIid ID Deprecated in 13.10. Use issue field.
monitoringTool StringMonitoring tool the alert came from.
notes NoteConnection!All notes on this noteable. (see Connections)
prometheusAlert PrometheusAlertAlert condition for Prometheus.
runbook StringRunbook for the alert as defined in alert details.
service StringService the alert came from.
severity AlertManagementSeveritySeverity of the alert.
startedAt TimeTimestamp the alert was raised.
status AlertManagementStatusStatus of the alert.
title StringTitle of the alert.
updatedAt TimeTimestamp the alert was last updated.
webUrl String!URL of the alert.

Fields with arguments

AlertManagementAlert.todos

To-do items of the current user for the alert.

Returns TodoConnection.

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

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.
state [TodoStateEnum!]State of the todo.
type [TodoTargetEnum!]Type of the todo.

AlertManagementAlertStatusCountsType

Represents total number of alerts for the represented categories.

Fields

NameTypeDescription
acknowledged IntNumber of alerts with status ACKNOWLEDGED for the project.
all IntTotal number of alerts for the project.
ignored IntNumber of alerts with status IGNORED for the project.
open IntNumber of alerts with status TRIGGERED or ACKNOWLEDGED for the project.
resolved IntNumber of alerts with status RESOLVED for the project.
triggered IntNumber of alerts with status TRIGGERED for the project.

AlertManagementHttpIntegration

An endpoint and credentials used to accept alerts for a project.

Fields

NameTypeDescription
active BooleanWhether the endpoint is currently accepting alerts.
apiUrl StringURL at which Prometheus metrics can be queried to populate the metrics dashboard.
id ID!ID of the integration.
name StringName of the integration.
payloadAlertFields [AlertManagementPayloadAlertField!]Extract alert fields from payload example for custom mapping.
payloadAttributeMappings [AlertManagementPayloadAlertMappingField!]The custom mapping of GitLab alert attributes to fields from the payload_example.
payloadExample JsonStringExample of an alert payload.
token StringToken used to authenticate alert notification requests.
type AlertManagementIntegrationType!Type of integration.
url StringEndpoint which accepts alert notifications.

AlertManagementPayloadAlertField

Parsed field from an alert used for custom mappings.

Fields

NameTypeDescription
label StringHuman-readable label of the payload path.
path [PayloadAlertFieldPathSegment!]Path to value inside payload JSON.
type AlertManagementPayloadAlertFieldTypeType of the parsed value.

AlertManagementPayloadAlertMappingField

Parsed field (with its name) from an alert used for custom mappings.

Fields

NameTypeDescription
fieldName AlertManagementPayloadAlertFieldNameGitLab alert field name.
label StringHuman-readable label of the payload path.
path [PayloadAlertFieldPathSegment!]Path to value inside payload JSON.
type AlertManagementPayloadAlertFieldTypeType of the parsed value.

AlertManagementPrometheusIntegration

An endpoint and credentials used to accept Prometheus alerts for a project.

Fields

NameTypeDescription
active BooleanWhether the endpoint is currently accepting alerts.
apiUrl StringURL at which Prometheus metrics can be queried to populate the metrics dashboard.
id ID!ID of the integration.
name StringName of the integration.
token StringToken used to authenticate alert notification requests.
type AlertManagementIntegrationType!Type of integration.
url StringEndpoint which accepts alert notifications.

ApiFuzzingCiConfiguration

Data associated with configuring API fuzzing scans in GitLab CI.

Fields

NameTypeDescription
scanModes [ApiFuzzingScanMode!]All available scan modes.
scanProfiles [ApiFuzzingScanProfile!]All default scan profiles.

ApiFuzzingScanProfile

An API Fuzzing scan profile.

Fields

NameTypeDescription
description StringShort description of the profile.
name StringUnique name of the profile.
yaml StringSyntax highlighted HTML representation of the YAML.

ApprovalProjectRule

Describes a project approval rule regarding who can approve merge requests.

Fields

NameTypeDescription
approvalsRequired IntNumber of required approvals.
eligibleApprovers UserCoreConnectionList of users eligible to approve merge requests for this approval rule. (see Connections)
id GlobalID!ID of the rule.
name StringName of the rule.
type ApprovalRuleTypeType of the rule.

ApprovalRule

Describes a rule for who can approve merge requests.

Fields

NameTypeDescription
allowMergeWhenInvalid BooleanIndicates if the rule can be ignored if it is invalid.
approvalsRequired IntNumber of required approvals.
approved BooleanIndicates if the rule is satisfied.
approvedBy UserCoreConnectionList of users defined in the rule that approved the merge request. (see Connections)
commentedBy UserCoreConnectionList of users, defined in the rule, who commented on the merge request. (see Connections)
containsHiddenGroups BooleanIndicates if the rule contains approvers from a hidden group.
eligibleApprovers [UserCore!]List of all users eligible to approve the merge request (defined explicitly and from associated groups).
groups GroupConnectionList of groups added as approvers for the rule. (see Connections)
id GlobalID!ID of the rule.
invalid BooleanIndicates if the rule is invalid and cannot be approved.
name StringName of the rule.
overridden BooleanIndicates if the rule was overridden for the merge request.
section StringNamed section of the Code Owners file that the rule applies to.
sourceRule ApprovalRuleSource rule used to create the rule.
type ApprovalRuleTypeType of the rule.
users UserCoreConnectionList of users added as approvers for the rule. (see Connections)

AssetType

Represents a vulnerability asset type.

Fields

NameTypeDescription
name String!Name of the asset.
type String!Type of the asset.
url String!URL of the asset.

AuditEventDefinition

Represents the YAML definitions for audit events defined in ee/config/audit_events/types/<event-type-name>.yml and config/audit_events/types/<event-type-name>.yml.

Fields

NameTypeDescription
description String!Description of what action the audit event tracks.
featureCategory String!Feature category associated with the event.
introducedByIssue StringLink to the issue introducing the event. For olderaudit events, it can be a commit URL rather than amerge request URL.
introducedByMr StringLink to the merge request introducing the event. Forolder audit events, it can be a commit URL rather thana merge request URL.
milestone String!Milestone the event was introduced in.
name String!Key name of the audit event.
savedToDatabase Boolean!Indicates if the event is saved to PostgreSQL database.
streamed Boolean!Indicates if the event is streamed to an external destination.

AuditEventStreamingHeader

Represents a HTTP header key/value that belongs to an audit streaming destination.

Fields

NameTypeDescription
id ID!ID of the header.
key String!Key of the header.
value String!Value of the header.

AuditEventsStreamingInstanceHeader

Represents a HTTP header key/value that belongs to an instance level audit streaming destination.

Fields

NameTypeDescription
id ID!ID of the header.
key String!Key of the header.
value String!Value of the header.

AwardEmoji

An emoji awarded by a user.

Fields

NameTypeDescription
description String!Emoji description.
emoji String!Emoji as an icon.
name String!Emoji name.
unicode String!Emoji in Unicode.
unicodeVersion String!Unicode version for this emoji.
user UserCore!User who awarded the emoji.

BaseService

Fields

NameTypeDescription
active BooleanIndicates if the service is active.
serviceType ServiceTypeType of the service.
type StringClass name of the service.

Blob

Fields

NameTypeDescription
flatPath String!Flat path of the entry.
id ID!ID of the entry.
lfsOid StringLFS ID of the blob.
mode StringBlob mode in numeric format.
name String!Name of the entry.
path String!Path of the entry.
sha String!Last commit SHA for the entry.
type EntryType!Type of tree entry.
webPath StringWeb path of the blob.
webUrl StringWeb URL of the blob.

BlobViewer

Represents how the blob content should be displayed.

Fields

NameTypeDescription
collapsed Boolean!Shows whether the blob should be displayed collapsed.
fileType String!Content file type.
loadAsync Boolean!Shows whether the blob content is loaded asynchronously.
loadingPartialName String!Loading partial name.
renderError StringError rendering the blob content.
tooLarge Boolean!Shows whether the blob is too large to be displayed.
type BlobViewersType!Type of blob viewer.

Board

Represents a project or group issue board.

Fields

NameTypeDescription
assignee UserCoreBoard assignee.
createdAt Time!Timestamp of when the board was created.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
id ID!ID (global ID) of the board.
iteration IterationBoard iteration.
iterationCadence IterationCadenceBoard iteration cadence.
labels LabelConnectionLabels of the board. (see Connections)
milestone MilestoneBoard milestone.
name StringName of the board.
updatedAt Time!Timestamp of when the board was last updated.
webPath String!Web path of the board.
webUrl String!Web URL of the board.
weight IntWeight of the board.

Fields with arguments

Board.epics

Epics associated with board issues.

Returns BoardEpicConnection.

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

Arguments
NameTypeDescription
issueFilters BoardIssueInputFilters applied when selecting issues on the board.
Board.lists

Lists of the board.

Returns BoardListConnection.

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

Arguments
NameTypeDescription
id ListIDFind a list by its global ID.
issueFilters BoardIssueInputFilters applied when getting issue metadata in the board list.

BoardEpic

Represents an epic on an issue board.

Fields

NameTypeDescription
author UserCore!Author of the epic.
awardEmoji AwardEmojiConnectionList of award emojis associated with the epic. (see Connections)
blocked BooleanIndicates the epic is blocked.
blockedByCount IntCount of epics blocking this epic.
blockedByEpics EpicConnectionEpics blocking this epic. (see Connections)
blockingCount IntCount of epics that this epic is blocking.
closedAt TimeTimestamp of when the epic was closed.
color StringColor of the epic. Returns null if epic_color_highlight feature flag is disabled.
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
confidential BooleanIndicates if the epic is confidential.
createdAt TimeTimestamp of when the epic was created.
defaultProjectForIssueCreation ProjectDefault Project for issue creation. Based on the project the user created the last issue in.
descendantCounts EpicDescendantCountNumber of open and closed descendant epics and issues.
descendantWeightSum EpicDescendantWeightsTotal weight of open and closed issues in the epic and its descendants.
description StringDescription of the epic.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
downvotes Int!Number of downvotes the epic has received.
dueDate TimeDue date of the epic.
dueDateFixed TimeFixed due date of the epic.
dueDateFromInheritedSource TimeInherited due date of the epic from child epics or milestones.
dueDateFromMilestones TimeInherited due date of the epic from milestones.
dueDateIsFixed BooleanIndicates if the due date has been manually set.
events EventConnectionList of events associated with the object. (see Connections)
group Group!Group to which the epic belongs.
hasChildren Boolean!Indicates if the epic has children.
hasIssues Boolean!Indicates if the epic has direct issues.
hasParent Boolean!Indicates if the epic has a parent epic.
healthStatus EpicHealthStatusCurrent health status of the epic.
id ID!ID of the epic.
iid ID!Internal ID of the epic.
issues EpicIssueConnectionA list of issues associated with the epic. (see Connections)
labels LabelConnectionLabels assigned to the epic. (see Connections)
notes NoteConnection!All notes on this noteable. (see Connections)
parent EpicParent epic of the epic.
participants UserCoreConnectionList of participants for the epic. (see Connections)
relationPath StringURI path of the epic-issue relationship.
relativePosition IntRelative position of the epic in the epic tree.
startDate TimeStart date of the epic.
startDateFixed TimeFixed start date of the epic.
startDateFromInheritedSource TimeInherited start date of the epic from child epics or milestones.
startDateFromMilestones TimeInherited start date of the epic from milestones.
startDateIsFixed BooleanIndicates if the start date has been manually set.
state EpicState!State of the epic.
subscribed Boolean!Indicates the currently logged in user is subscribed to the epic.
textColor StringText color generated for the epic. Returns null if epic_color_highlight feature flag is disabled.
title StringTitle of the epic.
titleHtml StringGitLab Flavored Markdown rendering of title.
updatedAt TimeTimestamp of when the epic was updated.
upvotes Int!Number of upvotes the epic has received.
userDiscussionsCount Int!Number of user discussions in the epic.
userNotesCount Int!Number of user notes of the epic.
userPermissions EpicPermissions!Permissions for the current user on the resource.
userPreferences BoardEpicUserPreferencesUser preferences for the epic on the issue board.
webPath String!Web path of the epic.
webUrl String!Web URL of the epic.

Fields with arguments

BoardEpic.ancestors

Ancestors (parents) of the epic.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsername StringFilter epics by author.
confidential BooleanFilter epics by given confidentiality.
createdAfter TimeEpics created after this date.
createdBefore TimeEpics created before this date.
iid IDIID of the epic, e.g., “1”.
iidStartsWith StringFilter epics by IID for autocomplete.
iids [ID!]List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups BooleanInclude epics from ancestor groups.
includeDescendantGroups BooleanInclude epics from descendant groups.
labelName [String!]Filter epics by labels.
milestoneTitle StringFilter epics by milestone title, computed from epic’s issues.
myReactionEmoji StringFilter by reaction emoji applied by the current user.
not NegatedEpicFilterInputNegated epic arguments.
or UnionedEpicFilterInput Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
search StringSearch query for title or description.
sort EpicSortList epics by sort order.
state EpicStateFilter epics by state.
timeframe TimeframeList items overlapping the given timeframe.
topLevelHierarchyOnly BooleanFilter epics with a top-level hierarchy.
updatedAfter TimeEpics updated after this date.
updatedBefore TimeEpics updated before this date.
BoardEpic.children

Children (sub-epics) of the epic.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsername StringFilter epics by author.
confidential BooleanFilter epics by given confidentiality.
createdAfter TimeEpics created after this date.
createdBefore TimeEpics created before this date.
iid IDIID of the epic, e.g., “1”.
iidStartsWith StringFilter epics by IID for autocomplete.
iids [ID!]List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups BooleanInclude child epics from ancestor groups.
includeDescendantGroups BooleanInclude epics from descendant groups.
labelName [String!]Filter epics by labels.
milestoneTitle StringFilter epics by milestone title, computed from epic’s issues.
myReactionEmoji StringFilter by reaction emoji applied by the current user.
not NegatedEpicFilterInputNegated epic arguments.
or UnionedEpicFilterInput Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
search StringSearch query for title or description.
sort EpicSortList epics by sort order.
state EpicStateFilter epics by state.
timeframe TimeframeList items overlapping the given timeframe.
topLevelHierarchyOnly BooleanFilter epics with a top-level hierarchy.
updatedAfter TimeEpics updated after this date.
updatedBefore TimeEpics updated before this date.
BoardEpic.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
state TodoStateEnumState of the to-do items.
BoardEpic.reference

Internal reference of the epic. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
full BooleanIndicates if the reference should be returned in full.

BoardEpicUserPreferences

Represents user preferences for a board epic.

Fields

NameTypeDescription
collapsed Boolean!Indicates epic should be displayed as collapsed.

BoardList

Represents a list for an issue board.

Fields

NameTypeDescription
assignee UserCoreAssignee in the list.
collapsed BooleanIndicates if the list is collapsed for this user.
id ID!ID (global ID) of the list.
issuesCount IntCount of issues in the list.
iteration IterationIteration of the list.
label LabelLabel of the list.
limitMetric ListLimitMetricCurrent limit metric for the list.
listType String!Type of the list.
maxIssueCount IntMaximum number of issues in the list.
maxIssueWeight IntMaximum weight of issues in the list.
milestone MilestoneMilestone of the list.
position IntPosition of list within the board.
title String!Title of the list.
totalIssueWeight BigIntTotal weight of all issues in the list, encoded as a string.
totalWeight Int Deprecated in 16.2. Use totalIssueWeight.

Fields with arguments

BoardList.issues

Board issues.

Returns IssueConnection.

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

Arguments
NameTypeDescription
filters BoardIssueInputFilters applied when selecting issues in the board list.

Branch

Fields

NameTypeDescription
commit CommitCommit for the branch.
name String!Name of the branch.

BranchProtection

Branch protection details for a branch rule.

Fields

NameTypeDescription
allowForcePush Boolean!Toggle force push to the branch for users with write access.
codeOwnerApprovalRequired Boolean!Enforce code owner approvals before allowing a merge.
mergeAccessLevels MergeAccessLevelConnectionDetails about who can merge when this branch is the source branch. (see Connections)
pushAccessLevels PushAccessLevelConnectionDetails about who can push when this branch is the source branch. (see Connections)
unprotectAccessLevels UnprotectAccessLevelConnectionDetails about who can unprotect this branch. (see Connections)

BranchRule

List of branch rules for a project, grouped by branch name.

Fields

NameTypeDescription
approvalRules ApprovalProjectRuleConnectionMerge request approval rules configured for this branch rule. (see Connections)
branchProtection BranchProtectionBranch protections configured for this branch rule.
createdAt Time!Timestamp of when the branch rule was created.
externalStatusChecks ExternalStatusCheckConnectionExternal status checks configured for this branch rule. (see Connections)
isDefault Boolean!Check if this branch rule protects the project’s default branch.
isProtected Boolean!Check if this branch rule protects access for the branch.
matchingBranchesCount Int!Number of existing branches that match this branch rule.
name String!Branch name, with wildcards, for the branch rules.
updatedAt Time!Timestamp of when the branch rule was last updated.

BurnupChartDailyTotals

Represents the total number of issues and their weights for a particular day.

Fields

NameTypeDescription
completedCount Int!Number of closed issues as of this day.
completedWeight Int!Total weight of closed issues as of this day.
date ISO8601Date!Date for burnup totals.
scopeCount Int!Number of issues as of this day.
scopeWeight Int!Total weight of issues as of this day.

CiApplicationSettings

Fields

NameTypeDescription
keepLatestArtifact BooleanWhether to keep the latest jobs artifacts.

CiBuildNeed

Fields

NameTypeDescription
id ID!ID of the BuildNeed.
name StringName of the job we need to complete.

CiCatalogResource

Fields

NameTypeDescription
description String Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Description of the catalog resource.
forksCount Int! Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Number of times the catalog resource has been forked.
icon String Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Icon for the catalog resource.
id ID! Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. ID of the catalog resource.
latestVersion Release Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Latest version of the catalog resource.
name String Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Name of the catalog resource.
readmeHtml String! Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. GitLab Flavored Markdown rendering of readme.
rootNamespace Namespace Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Root namespace of the catalog resource.
starCount Int! Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Number of times the catalog resource has been starred.
webPath String Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Web path of the catalog resource.

Fields with arguments

CiCatalogResource.versions

Versions of the catalog resource. This field can only be resolved for one catalog resource in any single request.

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

Returns ReleaseConnection.

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

Arguments
NameTypeDescription
sort ReleaseSortSort releases by given criteria.

CiConfig

Fields

NameTypeDescription
errors [String!]Linting errors.
includes [CiConfigInclude!]List of included files.
mergedYaml StringMerged CI configuration YAML.
stages CiConfigStageConnectionStages of the pipeline. (see Connections)
status CiConfigStatusStatus of linting, can be either valid or invalid.
warnings [String!]Linting warnings.

CiConfigGroup

Fields

NameTypeDescription
jobs CiConfigJobConnectionJobs in group. (see Connections)
name StringName of the job group.
size IntSize of the job group.

CiConfigInclude

Fields

NameTypeDescription
blob StringFile blob location. It can be masked if it contains masked variables. For example, "https://gitlab.com/gitlab-org/gitlab/-/blob/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml".
contextProject StringCurrent project scope, e.g., “gitlab-org/gitlab”.
contextSha StringCurrent sha scope.
extra JSONExtra information for the include, which can contain job_name, project, and ref. Values can be masked if they contain masked variables.
location StringFile location. It can be masked if it contains masked variables. For example, ".gitlab/ci/build-images.gitlab-ci.yml".
raw StringFile raw location. It can be masked if it contains masked variables. For example, "https://gitlab.com/gitlab-org/gitlab/-/raw/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml".
type CiConfigIncludeTypeInclude type.

CiConfigJob

Fields

NameTypeDescription
afterScript [String!]Override a set of commands that are executed after the job.
allowFailure BooleanAllow job to fail.
beforeScript [String!]Override a set of commands that are executed before the job.
environment StringName of an environment to which the job deploys.
except CiConfigJobRestrictionLimit when jobs are not created.
groupName StringName of the job group.
name StringName of the job.
needs CiConfigNeedConnectionBuilds that must complete before the jobs run. (see Connections)
only CiConfigJobRestrictionJobs are created when these conditions do not apply.
script [String!]Shell script that is executed by a runner.
stage StringName of the job stage.
tags [String!]List of tags that are used to select a runner.
when StringWhen to run the job.

CiConfigJobRestriction

Fields

NameTypeDescription
refs [String!]Git refs the job restriction applies to.

CiConfigNeed

Fields

NameTypeDescription
name StringName of the need.

CiConfigStage

Fields

NameTypeDescription
groups CiConfigGroupConnectionGroups of jobs for the stage. (see Connections)
name StringName of the stage.

CiConfigVariable

CI/CD config variables.

Fields

NameTypeDescription
description StringDescription for the CI/CD config variable.
key StringName of the variable.
value StringValue of the variable.
valueOptions [String!]Value options for the variable.

CiFreezePeriod

Represents a deployment freeze window of a project.

Fields

NameTypeDescription
cronTimezone StringTime zone for the cron fields, defaults to UTC if not provided.
endCron String!End of the freeze period in cron format.
endTime TimeTimestamp (UTC) of when the current/next active period ends.
startCron String!Start of the freeze period in cron format.
startTime TimeTimestamp (UTC) of when the current/next active period starts.
status CiFreezePeriodStatus!Freeze period status.

CiGroup

Fields

NameTypeDescription
detailedStatus DetailedStatusDetailed status of the group.
id String!ID for a group.
jobs CiJobConnectionJobs in group. (see Connections)
name StringName of the job group.
size IntSize of the group.

CiGroupEnvironmentScope

Ci/CD environment scope for a group.

Fields

NameTypeDescription
name StringScope name defininig the enviromnments that can use the variable.

CiGroupVariable

CI/CD variables for a group.

Fields

NameTypeDescription
description StringDescription of the variable.
environmentScope StringScope defining the environments that can use the variable.
id ID!ID of the variable.
key StringName of the variable.
masked BooleanIndicates whether the variable is masked.
protected BooleanIndicates whether the variable is protected.
raw BooleanIndicates whether the variable is raw.
value StringValue of the variable.
variableType CiVariableTypeType of the variable.

CiInstanceVariable

CI/CD variables for a GitLab instance.

Fields

NameTypeDescription
environmentScope String Deprecated in 15.3. No longer used, only available for GroupVariableType and ProjectVariableType.
id ID!ID of the variable.
key StringName of the variable.
masked BooleanIndicates whether the variable is masked.
protected BooleanIndicates whether the variable is protected.
raw BooleanIndicates whether the variable is raw.
value StringValue of the variable.
variableType CiVariableTypeType of the variable.

CiJob

Fields

NameTypeDescription
active Boolean!Indicates the job is active.
aiFailureAnalysis String Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Ai generated analysis of the root cause of failure.
allowFailure Boolean!Whether the job is allowed to fail.
artifacts CiJobArtifactConnectionArtifacts generated by the job. (see Connections)
browseArtifactsPath StringURL for browsing the artifact’s archive.
canPlayJob Boolean!Indicates whether the current user can play the job.
cancelable Boolean!Indicates the job can be canceled.
commitPath StringPath to the commit that triggered the job.
coverage FloatCoverage level of the job.
createdAt Time!When the job was created.
createdByTag Boolean!Whether the job was created by a tag.
detailedStatus DetailedStatusDetailed status of the job.
downstreamPipeline PipelineDownstream pipeline for a bridge.
duration IntDuration of the job in seconds.
erasedAt TimeWhen the job was erased.
failureMessage StringMessage on why the job failed.
finishedAt TimeWhen a job has finished running.
id JobIDID of the job.
kind CiJobKind!Indicates the type of job.
manualJob BooleanWhether the job has a manual action.
manualVariables CiManualVariableConnectionVariables added to a manual job when the job is triggered. (see Connections)
name StringName of the job.
needs CiBuildNeedConnectionReferences to builds that must complete before the jobs run. (see Connections)
pipeline PipelinePipeline the job belongs to.
playPath StringPlay path of the job.
playable Boolean!Indicates the job can be played.
previousStageJobsOrNeeds JobNeedUnionConnectionJobs that must complete before the job runs. Returns BuildNeed, which is the needed jobs if the job uses the needs keyword, or the previous stage jobs otherwise. (see Connections)
project ProjectProject that the job belongs to.
queuedAt TimeWhen the job was enqueued and marked as pending.
queuedDuration DurationHow long the job was enqueued before starting.
refName StringRef name of the job.
refPath StringPath to the ref.
retried BooleanIndicates that the job has been retried.
retryable Boolean!Indicates the job can be retried.
runner CiRunnerRunner assigned to execute the job.
runnerManager CiRunnerManager Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Runner manager assigned to the job.
scheduled Boolean!Indicates the job is scheduled.
scheduledAt TimeSchedule for the build.
schedulingType StringType of job scheduling. Value is dag if the job uses the needs keyword, and stage otherwise.
shortSha String!Short SHA1 ID of the commit.
stage CiStageStage of the job.
startedAt TimeWhen the job was started.
status CiJobStatusStatus of the job.
stuck Boolean!Indicates the job is stuck.
tags [String!]Tags for the current job.
trace CiJobTraceTrace generated by the job.
triggered BooleanWhether the job was triggered.
userPermissions JobPermissions!Permissions for the current user on the resource.
webPath StringWeb path of the job.

CiJobArtifact

Fields

NameTypeDescription
downloadPath StringURL for downloading the artifact’s file.
expireAt TimeExpiry date of the artifact.
fileType JobArtifactFileTypeFile type of the artifact.
id CiJobArtifactID!ID of the artifact.
name StringFile name of the artifact.
size BigInt!Size of the artifact in bytes.

CiJobTokenScopeType

Fields

NameTypeDescription
inboundAllowlist ProjectConnection!Allow list of projects that can access the current project through its CI Job tokens. (see Connections)
outboundAllowlist ProjectConnection!Allow list of projects that are accessible using the current project’s CI Job tokens. (see Connections)
projects ProjectConnection! Deprecated in 15.9. The projects attribute is being deprecated. Use outbound_allowlist.

CiJobTrace

Fields

NameTypeDescription
htmlSummary String! Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. HTML summary containing the last 10 lines of the trace.

CiJobsDurationStatistics

Representation of duration statistics for a group of CI jobs.

Fields

NameTypeDescription
p50 Duration Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 50th percentile. 50% of the durations are lower than this value.
p75 Duration Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 75th percentile. 75% of the durations are lower than this value.
p90 Duration Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 90th percentile. 90% of the durations are lower than this value.
p95 Duration Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 95th percentile. 95% of the durations are lower than this value.
p99 Duration Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 99th percentile. 99% of the durations are lower than this value.

CiJobsStatistics

Statistics for a group of CI jobs.

Fields

NameTypeDescription
queuedDuration CiJobsDurationStatistics Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. Statistics for amount of time that jobs were waiting to be picked up. The calculation is performed based on the most recent 100 jobs executed by the 5000 most recently created runners in context. If no filter is applied to runners, the calculation is performed based on the most recent 100 jobs globally.

CiManualVariable

CI/CD variables given to a manual job.

Fields

NameTypeDescription
environmentScope String Deprecated in 15.3. No longer used, only available for GroupVariableType and ProjectVariableType.
id ID!ID of the variable.
key StringName of the variable.
raw BooleanIndicates whether the variable is raw.
value StringValue of the variable.
variableType CiVariableTypeType of the variable.

CiMinutesNamespaceMonthlyUsage

Fields

NameTypeDescription
minutes IntTotal number of compute minutes used by all projects in the namespace.
month StringMonth related to the usage data.
monthIso8601 ISO8601DateMonth related to the usage data in ISO 8601 date format.
projects CiMinutesProjectMonthlyUsageConnectionCompute usage data for projects in the namespace. (see Connections)
sharedRunnersDuration IntTotal duration (in seconds) of shared runners use by the namespace for the month.

CiMinutesProjectMonthlyUsage

Fields

NameTypeDescription
minutes IntNumber of compute minutes used by the project in the month.
name String Deprecated in 15.6. Use project.name.
project ProjectProject having the recorded usage.
sharedRunnersDuration IntTotal duration (in seconds) of shared runners use by the project for the month.

CiProjectVariable

CI/CD variables for a project.

Fields

NameTypeDescription
description StringDescription of the variable.
environmentScope StringScope defining the environments that can use the variable.
id ID!ID of the variable.
key StringName of the variable.
masked BooleanIndicates whether the variable is masked.
protected BooleanIndicates whether the variable is protected.
raw BooleanIndicates whether the variable is raw.
value StringValue of the variable.
variableType CiVariableTypeType of the variable.

CiRunner

Fields

NameTypeDescription
accessLevel CiRunnerAccessLevel!Access level of the runner.
active Boolean! Deprecated in 14.8. Use paused.
adminUrl StringAdmin URL of the runner. Only available for administrators.
architectureName String Deprecated in 16.2. Use field in manager object instead.
contactedAt TimeTimestamp of last contact from this runner.
createdAt TimeTimestamp of creation of this runner.
createdBy UserCoreUser that created this runner.
description StringDescription of the runner.
editAdminUrl StringAdmin form URL of the runner. Only available for administrators.
ephemeralAuthenticationToken String Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. Ephemeral authentication token used for runner manager registration. Only available for the creator of the runner for a limited time during registration.
ephemeralRegisterUrl String Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. URL of the registration page of the runner manager. Only available for the creator of the runner for a limited time during registration.
executorName String Deprecated in 16.2. Use field in manager object instead.
groups GroupConnectionGroups the runner is associated with. For group runners only. (see Connections)
id CiRunnerID!ID of the runner.
ipAddress String Deprecated in 16.2. Use field in manager object instead.
jobExecutionStatus CiRunnerJobExecutionStatus Introduced in 15.7. This feature is an Experiment. It can be changed or removed at any time. Job execution status of the runner.
locked BooleanIndicates the runner is locked.
maintenanceNote StringRunner’s maintenance notes.
maintenanceNoteHtml StringGitLab Flavored Markdown rendering of maintenance_note.
managers CiRunnerManagerConnection Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Machines associated with the runner configuration.
maximumTimeout IntMaximum timeout (in seconds) for jobs processed by the runner.
ownerProject ProjectProject that owns the runner. For project runners only.
paused Boolean!Indicates the runner is paused and not available to run jobs.
platformName String Deprecated in 16.2. Use field in manager object instead.
privateProjectsMinutesCostFactor FloatPrivate projects’ “compute cost factor” associated with the runner (GitLab.com only).
projectCount IntNumber of projects that the runner is associated with.
publicProjectsMinutesCostFactor FloatPublic projects’ “compute cost factor” associated with the runner (GitLab.com only).
registerAdminUrl StringURL of the temporary registration page of the runner. Only available before the runner is registered. Only available for administrators.
revision String Deprecated in 16.2. Use field in manager object instead.
runUntagged Boolean!Indicates the runner is able to run untagged jobs.
runnerType CiRunnerType!Type of the runner.
shortSha StringFirst eight characters of the runner’s token used to authenticate new job requests. Used as the runner’s unique ID.
tagList [String!]Tags associated with the runner.
tokenExpiresAt TimeRunner token expiration time.
upgradeStatus CiRunnerUpgradeStatus Introduced in 14.10. This feature is an Experiment. It can be changed or removed at any time. Availability of upgrades for the runner.
userPermissions RunnerPermissions!Permissions for the current user on the resource.
version String Deprecated in 16.2. Use field in manager object instead.

Fields with arguments

CiRunner.jobCount

Number of jobs processed by the runner (limited to 1000, plus one to indicate that more items exist).

Returns Int.

Arguments
NameTypeDescription
statuses [CiJobStatus!] Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Filter jobs by status.
CiRunner.jobs

Jobs assigned to the runner. This field can only be resolved for one runner in any single request.

Returns CiJobConnection.

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

Arguments
NameTypeDescription
statuses [CiJobStatus!]Filter jobs by status.
CiRunner.projects

Find projects the runner is associated with. For project runners only.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
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 String Deprecated in 15.4. Default sort order will change in GitLab 17.0. Specify "id_asc" if you require the query results to be ordered by ascending IDs.
topics [String!]Filter projects by topics.
CiRunner.status

Status of the runner.

Returns CiRunnerStatus!.

Arguments
NameTypeDescription
legacyMode String Deprecated in 15.0. Will be removed in 17.0.

CiRunnerManager

Fields

NameTypeDescription
architectureName StringArchitecture provided by the runner manager.
contactedAt TimeTimestamp of last contact from the runner manager.
createdAt TimeTimestamp of creation of the runner manager.
executorName StringExecutor last advertised by the runner.
id CiRunnerManagerID!ID of the runner manager.
ipAddress StringIP address of the runner manager.
platformName StringPlatform provided by the runner manager.
revision StringRevision of the runner.
runner CiRunnerRunner configuration for the runner manager.
status CiRunnerStatus!Status of the runner manager.
systemId String!System ID associated with the runner manager.
upgradeStatus CiRunnerUpgradeStatus Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Availability of upgrades for the runner manager.
version StringVersion of the runner.

CiSecureFileRegistry

Represents the Geo replication and verification state of a ci_secure_file.

Fields

NameTypeDescription
ciSecureFileId ID!ID of the Ci Secure File.
createdAt TimeTimestamp when the CiSecureFileRegistry was created.
id ID!ID of the CiSecureFileRegistry.
lastSyncFailure StringError message during sync of the CiSecureFileRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the CiSecureFileRegistry.
retryAt TimeTimestamp after which the CiSecureFileRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the CiSecureFileRegistry.
state RegistryStateSync state of the CiSecureFileRegistry.
verificationRetryAt TimeTimestamp after which the CiSecureFileRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the CiSecureFileRegistry.

CiStage

Fields

NameTypeDescription
detailedStatus DetailedStatusDetailed status of the stage.
groups CiGroupConnectionGroup of jobs for the stage. (see Connections)
id ID!ID of the stage.
jobs CiJobConnectionJobs for the stage. (see Connections)
name StringName of the stage.
status StringStatus of the pipeline stage.

CiTemplate

GitLab CI/CD configuration template.

Fields

NameTypeDescription
content String!Contents of the CI template.
name String!Name of the CI template.

ClusterAgent

Fields

NameTypeDescription
activityEvents ClusterAgentActivityEventConnectionRecent activity for the cluster agent. (see Connections)
connections ConnectedAgentConnectionActive connections for the cluster agent. (see Connections)
createdAt TimeTimestamp the cluster agent was created.
createdByUser UserCoreUser object, containing information about the person who created the agent.
id ID!ID of the cluster agent.
name StringName of the cluster agent.
project ProjectProject this cluster agent is associated with.
tokens ClusterAgentTokenConnectionTokens associated with the cluster agent. (see Connections)
updatedAt TimeTimestamp the cluster agent was updated.
vulnerabilityImages VulnerabilityContainerImageConnectionContainer images reported on the agent vulnerabilities. (see Connections)
webPath StringWeb path of the cluster agent.

ClusterAgentActivityEvent

Fields

NameTypeDescription
agentToken ClusterAgentTokenAgent token associated with the event.
kind StringType of event.
level StringSeverity of the event.
recordedAt TimeTimestamp the event was recorded.
user UserCoreUser associated with the event.

ClusterAgentAuthorizationCiAccess

Fields

NameTypeDescription
agent ClusterAgentAuthorized cluster agent.
config JSONConfiguration for the authorized project.

ClusterAgentAuthorizationUserAccess

Fields

NameTypeDescription
agent ClusterAgentAuthorized cluster agent.
config JSONConfiguration for the authorized project.

ClusterAgentToken

Fields

NameTypeDescription
clusterAgent ClusterAgentCluster agent this token is associated with.
createdAt TimeTimestamp the token was created.
createdByUser UserCoreUser who created the token.
description StringDescription of the token.
id ClustersAgentTokenID!Global ID of the token.
lastUsedAt TimeTimestamp the token was last used.
name StringName given to the token.
status AgentTokenStatusCurrent status of the token.

CodeCoverageActivity

Represents the code coverage activity for a group.

Fields

NameTypeDescription
averageCoverage FloatAverage percentage of the different code coverage results available for the group.
coverageCount IntNumber of different code coverage results available for the group.
date Date!Date when the code coverage was created.
projectCount IntNumber of projects with code coverage results for the group.

CodeCoverageSummary

Represents the code coverage summary for a project.

Fields

NameTypeDescription
averageCoverage FloatAverage percentage of the different code coverage results available for the project.
coverageCount IntNumber of different code coverage results available.
lastUpdatedOn DateLatest date when the code coverage was created for the project.

CodeQualityDegradation

Represents a code quality degradation on the pipeline.

Fields

NameTypeDescription
description String!Description of the code quality degradation.
engineName String!Code Quality plugin that reported the finding.
fingerprint String!Unique fingerprint to identify the code quality degradation. For example, an MD5 hash.
line Int!Line on which the code quality degradation occurred.
path String!Relative path to the file containing the code quality degradation.
severity CodeQualityDegradationSeverity!Status of the degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO, UNKNOWN).
webUrl StringURL to the file along with line number.

CodeQualityReportSummary

Code Quality report for a pipeline.

Fields

NameTypeDescription
blocker IntTotal number of blocker status.
count IntTotal number of Code Quality reports.
critical IntTotal number of critical status.
info IntTotal number of info status.
major IntTotal number of major status.
minor IntTotal number of minor status.
unknown IntTotal number of unknown status.

Commit

Fields

NameTypeDescription
author UserCoreAuthor of the commit.
authorEmail StringCommit author’s email.
authorGravatar StringCommit authors gravatar.
authorName StringCommit authors name.
authoredDate TimeTimestamp of when the commit was authored.
description StringDescription of the commit message.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
fullTitle StringFull title of the commit message.
fullTitleHtml StringGitLab Flavored Markdown rendering of full_title.
id ID!ID (global ID) of the commit.
message StringRaw commit message.
sha String!SHA1 ID of the commit.
shortId String!Short SHA1 ID of the commit.
signature CommitSignatureSignature of the commit.
signatureHtml StringRendered HTML of the commit signature.
title StringTitle of the commit message.
titleHtml StringGitLab Flavored Markdown rendering of title.
webPath String!Web path of the commit.
webUrl String!Web URL of the commit.

Fields with arguments

Commit.pipelines

Pipelines of the commit ordered latest first.

Returns PipelineConnection.

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

Arguments
NameTypeDescription
ref StringFilter pipelines by the ref they are run for.
scope PipelineScopeEnumFilter pipelines by scope.
sha StringFilter pipelines by the sha of the commit they are run for.
source StringFilter pipelines by their source.
status PipelineStatusEnumFilter pipelines by their status.
updatedAfter TimePipelines updated after this date.
updatedBefore TimePipelines updated before this date.
username StringFilter pipelines by the user that triggered the pipeline.

CommitParentNames

Fields

NameTypeDescription
names [String!]Names of the commit parent (branch or tag).

CommitReferences

Fields with arguments

CommitReferences.containingBranches

Get branch names containing a given commit.

Returns CommitParentNames.

Arguments
NameTypeDescription
excludeTipped Boolean!Exclude tipping refs. WARNING: This argument can be confusing, if there is a limit. for example set the limit to 5 and in the 5 out a total of 25 refs there is 2 tipped refs, then the method will only 3 refs, even though there is more.
limit Int!Number of ref names to return.
CommitReferences.containingTags

Get tag names containing a given commit.

Returns CommitParentNames.

Arguments
NameTypeDescription
excludeTipped Boolean!Exclude tipping refs. WARNING: This argument can be confusing, if there is a limit. for example set the limit to 5 and in the 5 out a total of 25 refs there is 2 tipped refs, then the method will only 3 refs, even though there is more.
limit Int!Number of ref names to return.
CommitReferences.tippingBranches

Get branch names tipping at a given commit.

Returns CommitParentNames.

Arguments
NameTypeDescription
limit Int!Number of ref names to return.
CommitReferences.tippingTags

Get tag names tipping at a given commit.

Returns CommitParentNames.

Arguments
NameTypeDescription
limit Int!Number of ref names to return.

ComparedSecurityReport

Represents compared security report.

Fields

NameTypeDescription
added [ComparedSecurityReportFinding!] Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. New vulnerability findings.
baseReportCreatedAt TimeTime of the base report creation.
baseReportOutOfDate BooleanIndicates whether the base report out of date.
fixed [ComparedSecurityReportFinding!] Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Fixed vulnerability findings.
headReportCreatedAt TimeTime of the base report creation.

ComparedSecurityReportFinding

Represents finding.

Fields

NameTypeDescription
description StringDescription of the vulnerability finding.
foundByPipelineIid StringIID of the pipeline.
severity VulnerabilitySeveritySeverity of the vulnerability finding.
state VulnerabilityStateFinding status.
title StringTitle of the vulnerability finding.
uuid StringUUIDv5 digest based on the vulnerability’s report type, primary identifier, location, fingerprint, project identifier.

ComplianceFramework

Represents a ComplianceFramework associated with a Project.

Fields

NameTypeDescription
color String!Hexadecimal representation of compliance framework’s label color.
default BooleanDefault compliance framework for the group.
description String!Description of the compliance framework.
id ID!Compliance framework ID.
name String!Name of the compliance framework.
pipelineConfigurationFullPath StringFull path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa .

ComplianceStandardsAdherence

Compliance standards adherence for a project.

Fields

NameTypeDescription
checkName ComplianceStandardsAdherenceCheckName!Name of the check for the compliance standard.
id ID!Compliance standards adherence ID.
project Project!Project adhering to the compliance standard.
standard ComplianceStandardsAdherenceStandard!Name of the compliance standard.
status ComplianceStandardsAdherenceStatus!Status of the compliance standards adherence.
updatedAt Time!Timestamp when the adherence was updated.

ComplianceViolation

Compliance violation associated with a merged merge request.

Fields

NameTypeDescription
id ID!Compliance violation ID.
mergeRequest MergeRequest!Merge request the compliance violation occurred in.
reason ComplianceViolationReason!Reason the compliance violation occurred.
severityLevel ComplianceViolationSeverity!Severity of the compliance violation.
violatingUser UserCore!User suspected of causing the compliance violation.

ComposerMetadata

Composer metadata.

Fields

NameTypeDescription
composerJson PackageComposerJsonType!Data of the Composer JSON file.
targetSha String!Target SHA of the package.

ConanFileMetadata

Conan file metadata.

Fields

NameTypeDescription
conanFileType ConanMetadatumFileTypeEnum!Type of the Conan file.
conanPackageReference StringReference of the Conan package.
createdAt Time!Date of creation.
id PackagesConanFileMetadatumID!ID of the metadatum.
packageRevision StringRevision of the package.
recipeRevision String!Revision of the Conan recipe.
updatedAt Time!Date of most recent update.

ConanMetadata

Conan metadata.

Fields

NameTypeDescription
createdAt Time!Date of creation.
id PackagesConanMetadatumID!ID of the metadatum.
packageChannel String!Channel of the Conan package.
packageUsername String!Username of the Conan package.
recipe String!Recipe of the Conan package.
recipePath String!Recipe path of the Conan package.
updatedAt Time!Date of most recent update.

ConnectedAgent

Connection details for an Agent.

Fields

NameTypeDescription
connectedAt TimeWhen the connection was established.
connectionId BigIntID of the connection.
metadata AgentMetadataInformation about the Agent.

ContactStateCounts

Represents the total number of contacts for the represented states.

Fields

NameTypeDescription
active IntNumber of contacts with state ACTIVE.
all IntNumber of contacts with state ALL.
inactive IntNumber of contacts with state INACTIVE.

ContainerExpirationPolicy

A tag expiration policy designed to keep only the images that matter most.

Fields

NameTypeDescription
cadence ContainerExpirationPolicyCadenceEnum!This container expiration policy schedule.
createdAt Time!Timestamp of when the container expiration policy was created.
enabled Boolean!Indicates whether this container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnumNumber of tags to retain.
nameRegex UntrustedRegexpTags with names matching this regex pattern will expire.
nameRegexKeep UntrustedRegexpTags with names matching this regex pattern will be preserved.
nextRunAt TimeNext time that this container expiration policy will get executed.
olderThan ContainerExpirationPolicyOlderThanEnumTags older that this will expire.
updatedAt Time!Timestamp of when the container expiration policy was updated.

ContainerRepository

A container repository.

Fields

NameTypeDescription
canDelete Boolean!Can the current user delete the container repository.
createdAt Time!Timestamp when the container repository was created.
expirationPolicyCleanupStatus ContainerRepositoryCleanupStatusTags cleanup status for the container repository.
expirationPolicyStartedAt TimeTimestamp when the cleanup done by the expiration policy was started on the container repository.
id ID!ID of the container repository.
lastCleanupDeletedTagsCount IntNumber of deleted tags from the last cleanup.
location String!URL of the container repository.
migrationState String!Migration state of the container repository.
name String!Name of the container repository.
path String!Path of the container repository.
project Project!Project of the container registry.
status ContainerRepositoryStatusStatus of the container repository.
tagsCount Int!Number of tags associated with this image.
updatedAt Time!Timestamp when the container repository was updated.

ContainerRepositoryDetails

Details of a container repository.

Fields

NameTypeDescription
canDelete Boolean!Can the current user delete the container repository.
createdAt Time!Timestamp when the container repository was created.
expirationPolicyCleanupStatus ContainerRepositoryCleanupStatusTags cleanup status for the container repository.
expirationPolicyStartedAt TimeTimestamp when the cleanup done by the expiration policy was started on the container repository.
id ID!ID of the container repository.
lastCleanupDeletedTagsCount IntNumber of deleted tags from the last cleanup.
location String!URL of the container repository.
migrationState String!Migration state of the container repository.
name String!Name of the container repository.
path String!Path of the container repository.
project Project!Project of the container registry.
size FloatDeduplicated size of the image repository in bytes. This is only available on GitLab.com for repositories created after 2021-11-04.
status ContainerRepositoryStatusStatus of the container repository.
tagsCount Int!Number of tags associated with this image.
updatedAt Time!Timestamp when the container repository was updated.

Fields with arguments

ContainerRepositoryDetails.tags

Tags of the container repository.

Returns ContainerRepositoryTagConnection.

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

Arguments
NameTypeDescription
name StringSearch by tag name.
sort ContainerRepositoryTagSortSort tags by these criteria.

ContainerRepositoryRegistry

Represents the Geo replication and verification state of an Container Repository.

Fields

NameTypeDescription
containerRepositoryId ID!ID of the ContainerRepository.
createdAt TimeTimestamp when the ContainerRepositoryRegistry was created.
id ID!ID of the ContainerRepositoryRegistry.
lastSyncFailure StringError message during sync of the ContainerRepositoryRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the ContainerRepositoryRegistry.
retryAt TimeTimestamp after which the ContainerRepositoryRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the ContainerRepositoryRegistry.
state RegistryStateSync state of the ContainerRepositoryRegistry.
verificationRetryAt TimeTimestamp after which the ContainerRepositoryRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the ContainerRepositoryRegistry.

ContainerRepositoryTag

A tag from a container repository.

Fields

NameTypeDescription
canDelete Boolean!Can the current user delete this tag.
createdAt TimeTimestamp when the tag was created.
digest StringDigest of the tag.
location String!URL of the tag.
name String!Name of the tag.
path String!Path of the tag.
revision StringRevision of the tag.
shortRevision StringShort revision of the tag.
totalSize BigIntSize of the tag.

ContributionAnalyticsContribution

Represents the contributions of a user.

Fields

NameTypeDescription
issuesClosed IntNumber of issues closed by the user.
issuesCreated IntNumber of issues created by the user.
mergeRequestsApproved IntNumber of merge requests approved by the user.
mergeRequestsClosed IntNumber of merge requests closed by the user.
mergeRequestsCreated IntNumber of merge requests created by the user.
mergeRequestsMerged IntNumber of merge requests merged by the user.
repoPushed IntNumber of repository pushes the user made.
totalEvents IntTotal number of events contributed by the user.
user UserCoreContributor User object.

CoverageFuzzingCorpus

Corpus for a coverage fuzzing job.

Fields

NameTypeDescription
id AppSecFuzzingCoverageCorpusID!ID of the corpus.
package PackageDetailsType!Package of the corpus.

CurrentLicense

Represents the current license.

Fields

NameTypeDescription
activatedAt DateDate when the license was activated.
billableUsersCount IntNumber of billable users on the system.
blockChangesAt DateDate, including grace period, when licensed features will be blocked.
company StringCompany of the licensee.
createdAt DateDate when the license was added.
email StringEmail of the licensee.
expiresAt DateDate when the license expires.
id ID!ID of the license extracted from the license data.
lastSync TimeDate when the license was last synced.
maximumUserCount IntHighest number of billable users on the system during the term of the current license.
name StringName of the licensee.
plan String!Name of the subscription plan.
startsAt DateDate when the license started.
type String!Type of the license.
usersInLicenseCount IntNumber of paid users in the license.
usersOverLicenseCount IntNumber of users over the paid users in the license.

CustomEmoji

A custom emoji uploaded by user.

Fields

NameTypeDescription
external Boolean!Whether the emoji is an external link.
id CustomEmojiID!ID of the emoji.
name String!Name of the emoji.
url String!Link to file of the emoji.

CustomerRelationsContact

Fields

NameTypeDescription
active Boolean!State of the contact.
createdAt Time!Timestamp the contact was created.
description StringDescription of or notes for the contact.
email StringEmail address of the contact.
firstName String!First name of the contact.
id ID!Internal ID of the contact.
lastName String!Last name of the contact.
organization CustomerRelationsOrganizationOrganization of the contact.
phone StringPhone number of the contact.
updatedAt Time!Timestamp the contact was last updated.

CustomerRelationsOrganization

Fields

NameTypeDescription
active Boolean!State of the organization.
createdAt Time!Timestamp the organization was created.
defaultRate FloatStandard billing rate for the organization.
description StringDescription of or notes for the organization.
id ID!Internal ID of the organization.
name String!Name of the organization.
updatedAt Time!Timestamp the organization was last updated.

DastPreScanVerification

Represents a DAST Pre Scan Verification.

Fields

NameTypeDescription
preScanVerificationSteps [DastPreScanVerificationStep!]Pre Scan Verifications Steps.
status DastPreScanVerificationStatusStatus of the pre scan verification.
valid Boolean!Whether or not the configuration has changed after the last pre scan run.

DastPreScanVerificationStep

Represents a DAST Pre Scan Verification Step.

Fields

NameTypeDescription
checkType DastPreScanVerificationCheckTypeType of the pre scan verification check.
errors [String!]Errors that occurred in the pre scan verification step.
name String Deprecated in 15.10. This was renamed. Use: DastPreScanVerificationStep.checkType.
success Boolean!Whether or not the pre scan verification step has errors.

DastProfile

Represents a DAST Profile.

Fields

NameTypeDescription
branch DastProfileBranchAssociated branch.
dastPreScanVerification DastPreScanVerificationDAST Pre Scan Verification associated with the site profile. Will always return null if dast_on_demand_scans_scheduler feature flag is disabled.
dastProfileSchedule DastProfileScheduleAssociated profile schedule.
dastScannerProfile DastScannerProfileAssociated scanner profile.
dastSiteProfile DastSiteProfileAssociated site profile.
description StringDescription of the scan.
editPath StringRelative web path to the edit page of a profile.
id DastProfileID!ID of the profile.
name StringName of the profile.
tagList [String!]Runner tags associated with the profile.

DastProfileBranch

Represents a DAST Profile Branch.

Fields

NameTypeDescription
exists BooleanIndicates whether or not the branch exists.
name StringName of the branch.

DastProfileCadence

Represents DAST Profile Cadence.

Fields

NameTypeDescription
duration IntDuration of the DAST profile cadence.
unit DastProfileCadenceUnitUnit for the duration of DAST profile cadence.

DastProfileSchedule

Represents a DAST profile schedule.

Fields

NameTypeDescription
active BooleanStatus of the DAST profile schedule.
cadence DastProfileCadenceCadence of the DAST profile schedule.
id DastProfileScheduleID!ID of the DAST profile schedule.
nextRunAt TimeNext run time of the DAST profile schedule in the given timezone.
ownerValid BooleanStatus of the current owner of the DAST profile schedule.
startsAt TimeStart time of the DAST profile schedule in the given timezone.
timezone StringTime zone of the start time of the DAST profile schedule.

DastScannerProfile

Represents a DAST scanner profile.

Fields

NameTypeDescription
editPath StringRelative web path to the edit page of a scanner profile.
id DastScannerProfileID!ID of the DAST scanner profile.
profileName StringName of the DAST scanner profile.
referencedInSecurityPolicies [String!]List of security policy names that are referencing given project.
scanType DastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages Boolean!Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout IntMaximum number of minutes allowed for the spider to traverse the site.
tagList [String!] Deprecated in 15.8. Moved to DastProfile.
targetTimeout IntMaximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider Boolean!Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

DastSiteProfile

Represents a DAST Site Profile.

Fields

NameTypeDescription
auth DastSiteProfileAuthTarget authentication details.
editPath StringRelative web path to the edit page of a site profile.
excludedUrls [String!]URLs to skip during an authenticated scan.
id DastSiteProfileID!ID of the site profile.
normalizedTargetUrl StringNormalized URL of the target to be scanned.
profileName StringName of the site profile.
referencedInSecurityPolicies [String!]List of security policy names that are referencing given project.
requestHeaders StringComma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath StringScan File Path used as input for the scanner.
scanMethod DastScanMethodTypeScan method used by the scanner.
targetType DastTargetTypeEnumType of target to be scanned.
targetUrl StringURL of the target to be scanned.
userPermissions DastSiteProfilePermissions!Permissions for the current user on the resource.
validationStartedAt TimeSite profile validation start time.
validationStatus DastSiteProfileValidationStatusEnumCurrent validation status of the site profile.

DastSiteProfileAuth

Input type for DastSiteProfile authentication.

Fields

NameTypeDescription
enabled BooleanIndicates whether authentication is enabled.
password StringRedacted password to authenticate with on the target website.
passwordField StringName of password field at the sign-in HTML form.
submitField StringName or ID of sign-in submit button at the sign-in HTML form.
url StringThe URL of the page containing the sign-in HTML form on the target website.
username StringUsername to authenticate with on the target website.
usernameField StringName of username field at the sign-in HTML form.

DastSiteProfilePermissions

Check permissions for the current user on site profile.

Fields

NameTypeDescription
createOnDemandDastScan Boolean!Indicates the user can perform create_on_demand_dast_scan on this resource.

DastSiteValidation

Represents a DAST Site Validation.

Fields

NameTypeDescription
id DastSiteValidationID!Global ID of the site validation.
normalizedTargetUrl StringNormalized URL of the target to be validated.
status DastSiteProfileValidationStatusEnum!Status of the site validation.
validationStartedAt TimeTimestamp of when the validation started.

DeleteJobsResponse

The response from the AdminSidekiqQueuesDeleteJobs mutation.

Fields

NameTypeDescription
completed BooleanWhether or not the entire queue was processed in time; if not, retrying the same request is safe.
deletedJobs IntNumber of matching jobs deleted.
queueSize IntQueue size after processing.

DeletedNote

Fields

NameTypeDescription
discussionId DiscussionIDID of the discussion for the deleted note.
id NoteID!ID of the deleted note.
lastDiscussionNote BooleanWhether deleted note is the last note in the discussion.

Dependency

A software dependency used by a project.

Fields

NameTypeDescription
id GlobalID!ID of the dependency.
location LocationInformation about where the dependency is located.
name String!Name of the dependency.
packager PackageManagerDescription of the tool used to manage the dependency.
version StringVersion of the dependency.

DependencyProxyBlob

Dependency proxy blob.

Fields

NameTypeDescription
createdAt Time!Date of creation.
fileName String!Name of the blob.
size String!Size of the blob file.
updatedAt Time!Date of most recent update.

DependencyProxyBlobRegistry

Represents the Geo replication and verification state of a dependency_proxy_blob.

Fields

NameTypeDescription
createdAt TimeTimestamp when the DependencyProxyBlobRegistry was created.
dependencyProxyBlobId ID!ID of the Dependency Proxy Blob.
id ID!ID of the DependencyProxyBlobRegistry.
lastSyncFailure StringError message during sync of the DependencyProxyBlobRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the DependencyProxyBlobRegistry.
retryAt TimeTimestamp after which the DependencyProxyBlobRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the DependencyProxyBlobRegistry.
state RegistryStateSync state of the DependencyProxyBlobRegistry.
verificationRetryAt TimeTimestamp after which the DependencyProxyBlobRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the DependencyProxyBlobRegistry.

DependencyProxyImageTtlGroupPolicy

Group-level Dependency Proxy TTL policy settings.

Fields

NameTypeDescription
createdAt TimeTimestamp of creation.
enabled Boolean!Indicates whether the policy is enabled or disabled.
ttl IntNumber of days to retain a cached image file.
updatedAt TimeTimestamp of the most recent update.

DependencyProxyManifest

Dependency proxy manifest.

Fields

NameTypeDescription
createdAt Time!Date of creation.
digest String!Digest of the manifest.
fileName String!Name of the manifest.
id DependencyProxyManifestID!ID of the manifest.
imageName String!Name of the image.
size String!Size of the manifest file.
status DependencyProxyManifestStatus!Status of the manifest (default, pending_destruction, processing, error).
updatedAt Time!Date of most recent update.

DependencyProxyManifestRegistry

Represents the Geo replication and verification state of a dependency_proxy_manifest.

Fields

NameTypeDescription
createdAt TimeTimestamp when the DependencyProxyManifestRegistry was created.
dependencyProxyManifestId ID!ID of the Dependency Proxy Manifest.
id ID!ID of the DependencyProxyManifestRegistry.
lastSyncFailure StringError message during sync of the DependencyProxyManifestRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the DependencyProxyManifestRegistry.
retryAt TimeTimestamp after which the DependencyProxyManifestRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the DependencyProxyManifestRegistry.
state RegistryStateSync state of the DependencyProxyManifestRegistry.
verificationRetryAt TimeTimestamp after which the DependencyProxyManifestRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the DependencyProxyManifestRegistry.

DependencyProxySetting

Group-level Dependency Proxy settings.

Fields

NameTypeDescription
enabled Boolean!Indicates whether the dependency proxy is enabled for the group.

Deployment

The deployment of an environment.

Fields

NameTypeDescription
approvalSummary DeploymentApprovalSummaryApproval summary of the deployment.This field can only be resolved for one deployment in any single request.
approvals [DeploymentApproval!]Current approvals of the deployment.
commit CommitCommit details of the deployment.
createdAt TimeWhen the deployment record was created.
finishedAt TimeWhen the deployment finished.
id IDGlobal ID of the deployment.
iid IDProject-level internal ID of the deployment.
job CiJobPipeline job of the deployment.
pendingApprovalCount IntNumber of pending unified approvals on the deployment.
ref StringGit-Ref that the deployment ran on.
sha StringGit-SHA that the deployment ran on.
status DeploymentStatusStatus of the deployment.
tag BooleanTrue or false if the deployment ran on a Git-tag.
tags [DeploymentTag!]Git tags that contain this deployment. This field can only be resolved for two deployments in any single request.
triggerer UserCoreUser who executed the deployment.
updatedAt TimeWhen the deployment record was updated.
userPermissions DeploymentPermissions!Permissions for the current user on the resource.

DeploymentApproval

Approval of the deployment.

Fields

NameTypeDescription
comment StringAdditional comment.
createdAt TimeWhen the user approved/rejected first time.
status DeploymentsApprovalStatusWhether the deployment was approved/rejected.
updatedAt TimeWhen the user updated the approval.
user UserCoreUser who approved or rejected the deployment.

DeploymentApprovalSummary

Approval summary of the deployment.

Fields

NameTypeDescription
rules [ProtectedEnvironmentApprovalRuleForSummary!]Approval Rules for the deployment.
status DeploymentApprovalSummaryStatusStatus of the approvals.
totalPendingApprovalCount IntTotal pending approval count.
totalRequiredApprovals IntTotal number of required approvals.

DeploymentPermissions

Fields

NameTypeDescription
approveDeployment Boolean!Indicates the user can perform approve_deployment on this resource. This field can only be resolved for one environment in any single request.
destroyDeployment Boolean!Indicates the user can perform destroy_deployment on this resource.
updateDeployment Boolean!Indicates the user can perform update_deployment on this resource.

DeploymentTag

Tags for a given deployment.

Fields

NameTypeDescription
name StringName of this git tag.
path StringPath for this tag.

DescriptionVersion

Fields

NameTypeDescription
canDelete Boolean Deprecated in 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deletePath String Deprecated in 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deleted Boolean Deprecated in 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
description StringContent of the given description version.
diffPath String Deprecated in 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
id DescriptionVersionID!ID of the description version.

Fields with arguments

DescriptionVersion.diff

Description diff between versions.

Returns String.

Arguments
NameTypeDescription
versionId DescriptionVersionIDID of a previous version to compare. If not specified first previous version is used.

Design

A single design.

Fields

NameTypeDescription
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
description StringDescription of the design.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
diffRefs DiffRefs!Diff refs for this design.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
event DesignVersionEvent!How this design was changed in the current version.
filename String!Filename of the design.
fullPath String!Full path to the design file.
id ID!ID of this design.
image String!URL of the full-sized image.
imageV432x230 StringThe URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
issue Issue!Issue the design belongs to.
notes NoteConnection!All notes on this noteable. (see Connections)
notesCount Int!Total count of user-created notes for this design.
project Project!Project the design belongs to.
webUrl String!URL of the design.

Fields with arguments

Design.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
state TodoStateEnumState of the to-do items.
Design.versions

All versions related to this design ordered newest first.

Returns DesignVersionConnection!.

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

Arguments
NameTypeDescription
earlierOrEqualToId DesignManagementVersionIDGlobal ID of the most recent acceptable version.
earlierOrEqualToSha StringSHA256 of the most recent acceptable version.

DesignAtVersion

A design pinned to a specific version. The image field reflects the design as of the associated version.

Fields

NameTypeDescription
design Design!Underlying design.
diffRefs DiffRefs!Diff refs for this design.
event DesignVersionEvent!How this design was changed in the current version.
filename String!Filename of the design.
fullPath String!Full path to the design file.
id ID!ID of this design.
image String!URL of the full-sized image.
imageV432x230 StringThe URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
issue Issue!Issue the design belongs to.
notesCount Int!Total count of user-created notes for this design.
project Project!Project the design belongs to.
version DesignVersion!Version this design-at-versions is pinned to.

DesignCollection

A collection of designs.

Fields

NameTypeDescription
copyState DesignCollectionCopyStateCopy state of the design collection.
issue Issue!Issue associated with the design collection.
project Project!Project associated with the design collection.

Fields with arguments

DesignCollection.design

Find a specific design.

Returns Design.

Arguments
NameTypeDescription
filename StringFind a design by its filename.
id DesignManagementDesignIDFind a design by its ID.
DesignCollection.designAtVersion

Find a design as of a version.

Returns DesignAtVersion.

Arguments
NameTypeDescription
id DesignManagementDesignAtVersionID!Global ID of the design at this version.
DesignCollection.designs

All designs for the design collection.

Returns DesignConnection!.

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

Arguments
NameTypeDescription
atVersion DesignManagementVersionIDFilters designs to only those that existed at the version. If argument is omitted or nil then all designs will reflect the latest version.
filenames [String!]Filters designs by their filename.
ids [DesignManagementDesignID!]Filters designs by their ID.
DesignCollection.version

A specific version.

Returns DesignVersion.

Arguments
NameTypeDescription
id DesignManagementVersionIDGlobal ID of the version.
sha StringSHA256 of a specific version.
DesignCollection.versions

All versions related to all designs, ordered newest first.

Returns DesignVersionConnection!.

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

Arguments
NameTypeDescription
earlierOrEqualToId DesignManagementVersionIDGlobal ID of the most recent acceptable version.
earlierOrEqualToSha StringSHA256 of the most recent acceptable version.

DesignManagement

Fields with arguments

DesignManagement.designAtVersion

Find a design as of a version.

Returns DesignAtVersion.

Arguments
NameTypeDescription
id DesignManagementDesignAtVersionID!Global ID of the design at this version.
DesignManagement.version

Find a version.

Returns DesignVersion.

Arguments
NameTypeDescription
id DesignManagementVersionID!Global ID of the version.

DesignManagementRepositoryRegistry

Represents the Geo replication and verification state of a Design Management Repository.

Fields

NameTypeDescription
createdAt TimeTimestamp when the DesignManagementRepositoryRegistry was created.
designManagementRepositoryId ID!ID of the Design Management Repository.
id ID!ID of the DesignManagementRepositoryRegistry.
lastSyncFailure StringError message during sync of the DesignManagementRepositoryRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the DesignManagementRepositoryRegistry.
retryAt TimeTimestamp after which the DesignManagementRepositoryRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the DesignManagementRepositoryRegistry.
state RegistryStateSync state of the DesignManagementRepositoryRegistry.
verificationRetryAt TimeTimestamp after which the DesignManagementRepositoryRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the DesignManagementRepositoryRegistry.

DesignVersion

A specific version in which designs were added, modified or deleted.

Fields

NameTypeDescription
author UserCore!Author of the version.
createdAt Time!Timestamp of when the version was created.
designs DesignConnection!All designs that were changed in the version. (see Connections)
id ID!ID of the design version.
sha ID!SHA of the design version.

Fields with arguments

DesignVersion.designAtVersion

A particular design as of this version, provided it is visible at this version.

Returns DesignAtVersion!.

Arguments
NameTypeDescription
designId DesignManagementDesignIDID of a specific design.
filename StringFilename of a specific design.
id DesignManagementDesignAtVersionIDID of the DesignAtVersion.
DesignVersion.designsAtVersion

All designs that are visible at this version, as of this version.

Returns DesignAtVersionConnection!.

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

Arguments
NameTypeDescription
filenames [String!]Filters designs by their filename.
ids [DesignManagementDesignID!]Filters designs by their ID.

DetailedStatus

Fields

NameTypeDescription
action StatusActionAction information for the status. This includes method, button title, icon, path, and title.
detailsPath StringPath of the details for the status.
favicon StringFavicon of the status.
group StringGroup of the status.
hasDetails BooleanIndicates if the status has further details.
icon StringIcon of the status.
id String!ID for a detailed status.
label StringLabel of the status.
text StringText of the status.
tooltip StringTooltip associated with the status.

DevopsAdoptionEnabledNamespace

Enabled namespace for DevopsAdoption.

Fields

NameTypeDescription
displayNamespace NamespaceNamespace where data should be displayed.
id ID!ID of the enabled namespace.
latestSnapshot DevopsAdoptionSnapshotMetrics snapshot for previous month for the enabled namespace.
namespace NamespaceNamespace which should be calculated.

Fields with arguments

DevopsAdoptionEnabledNamespace.snapshots

Data snapshots of the namespace.

Returns DevopsAdoptionSnapshotConnection.

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

Arguments
NameTypeDescription
endTimeAfter TimeFilter to snapshots with month end after the provided date.
endTimeBefore TimeFilter to snapshots with month end before the provided date.

DevopsAdoptionSnapshot

Snapshot.

Fields

NameTypeDescription
codeOwnersUsedCount IntTotal number of projects with existing CODEOWNERS file.
coverageFuzzingEnabledCount IntTotal number of projects with enabled coverage fuzzing.
dastEnabledCount IntTotal number of projects with enabled DAST.
dependencyScanningEnabledCount IntTotal number of projects with enabled dependency scanning.
deploySucceeded Boolean!At least one deployment succeeded.
endTime Time!End time for the snapshot where the data points were collected.
issueOpened Boolean!At least one issue was opened.
mergeRequestApproved Boolean!At least one merge request was approved.
mergeRequestOpened Boolean!At least one merge request was opened.
pipelineSucceeded Boolean!At least one pipeline succeeded.
recordedAt Time!Time the snapshot was recorded.
runnerConfigured Boolean!At least one runner was used.
sastEnabledCount IntTotal number of projects with enabled SAST.
startTime Time!Start time for the snapshot where the data points were collected.
totalProjectsCount IntTotal number of projects.
vulnerabilityManagementUsedCount IntTotal number of projects with vulnerability management used at least once.

DiffPosition

Fields

NameTypeDescription
diffRefs DiffRefs!Information about the branch, HEAD, and base at the time of commenting.
filePath String!Path of the file that was changed.
height IntTotal height of the image.
newLine IntLine on HEAD SHA that was changed.
newPath StringPath of the file on the HEAD SHA.
oldLine IntLine on start SHA that was changed.
oldPath StringPath of the file on the start SHA.
positionType DiffPositionType!Type of file the position refers to.
width IntTotal width of the image.
x IntX position of the note.
y IntY position of the note.

DiffRefs

Fields

NameTypeDescription
baseSha StringMerge base of the branch the comment was made on.
headSha String!SHA of the HEAD at the time the comment was made.
startSha String!SHA of the branch being compared against.

DiffStats

Changes to a single file.

Fields

NameTypeDescription
additions Int!Number of lines added to this file.
deletions Int!Number of lines deleted from this file.
path String!File path, relative to repository root.

DiffStatsSummary

Aggregated summary of changes.

Fields

NameTypeDescription
additions Int!Number of lines added.
changes Int!Number of lines changed.
deletions Int!Number of lines deleted.
fileCount Int!Number of files changed.

Discussion

Fields

NameTypeDescription
createdAt Time!Timestamp of the discussion’s creation.
id DiscussionID!ID of this discussion.
noteable NoteableTypeObject which the discussion belongs to.
notes NoteConnection!All notes in the discussion. (see Connections)
replyId DiscussionID!ID used to reply to this discussion.
resolvable Boolean!Indicates if the object can be resolved.
resolved Boolean!Indicates if the object is resolved.
resolvedAt TimeTimestamp of when the object was resolved.
resolvedBy UserCoreUser who resolved the object.

Dora

All information related to DORA metrics.

Fields with arguments

Dora.metrics

DORA metrics for the current group or project.

Returns [DoraMetric!].

Arguments
NameTypeDescription
endDate DateDate range to end at. Default is the current date.
environmentTiers [DeploymentTier!]Deployment tiers of the environments to return. Defaults to [PRODUCTION].
interval DoraMetricBucketingIntervalHow the metric should be aggregated. Defaults to DAILY. In the case of ALL, the date field in the response will be null.
metric DoraMetricType Deprecated in 15.10. Superseded by metrics fields. See DoraMetric type.
startDate DateDate range to start from. Default is 3 months ago.

DoraMetric

Fields

NameTypeDescription
changeFailureRate FloatPercentage of deployments that caused incidents in production.
date StringDate of the data point.
deploymentFrequency FloatNumber of deployments per day.
leadTimeForChanges FloatMedian time to deploy a merged merge request.
timeToRestoreService FloatMedian time to close an incident.
value Float Deprecated in 15.10. Moved to corresponding metric field.

DoraPerformanceScoreCount

Aggregated DORA score counts for projects for the last complete month.

Fields

NameTypeDescription
highProjectsCount IntNumber of projects that score “high” on the metric.
lowProjectsCount IntNumber of projects that score “low” on the metric.
mediumProjectsCount IntNumber of projects that score “medium” on the metric.
metricName String!Name of the DORA metric.
noDataProjectsCount IntNumber of projects with no data.

EgressNode

Fields

NameTypeDescription
artifactsEgress BigInt!Artifacts egress for that project in that period of time.
date String!First day of the node range. There is one node per month.
packagesEgress BigInt!Packages egress for that project in that period of time.
registryEgress BigInt!Registry egress for that project in that period of time.
repositoryEgress BigInt!Repository egress for that project in that period of time.
totalEgress BigInt!Total egress for that project in that period of time.

Email

Fields

NameTypeDescription
confirmedAt TimeTimestamp the email was confirmed.
createdAt Time!Timestamp the email was created.
email String!Email address.
id ID!Internal ID of the email.
updatedAt Time!Timestamp the email was last updated.

Environment

Describes where code is deployed for a project.

Fields

NameTypeDescription
autoDeleteAt TimeWhen the environment is going to be deleted automatically.
autoStopAt TimeWhen the environment is going to be stopped automatically.
clusterAgent ClusterAgentCluster agent of the environment.
createdAt TimeWhen the environment was created.
deployFreezes [CiFreezePeriod!]Deployment freeze periods of the environment.
environmentType StringFolder name of the environment.
externalUrl StringExternal URL of the environment.
id ID!ID of the environment.
kubernetesNamespace StringKubernetes namespace of the environment.
latestOpenedMostSevereAlert AlertManagementAlertMost severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned.
name String!Human-readable name of the environment.
path String!Path to the environment.
protectedEnvironments ProtectedEnvironmentConnectionProtected Environments for the environment. (see Connections)
slug StringSlug of the environment.
state String!State of the environment, for example: available/stopped.
tier DeploymentTierDeployment tier of the environment.
updatedAt TimeWhen the environment was updated.
userPermissions EnvironmentPermissions!Permissions for the current user on the resource. This field can only be resolved for one environment in any single request.

Fields with arguments

Environment.deployments

Deployments of the environment. This field can only be resolved for one environment in any single request.

Returns DeploymentConnection.

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

Arguments
NameTypeDescription
orderBy DeploymentsOrderByInputOrder by a specified field.
statuses [DeploymentStatus!]Statuses of the deployments.
Environment.lastDeployment

Last deployment of the environment.

Returns Deployment.

Arguments
NameTypeDescription
status DeploymentStatus!Status of the Deployment.

EnvironmentPermissions

Fields

NameTypeDescription
destroyEnvironment Boolean!Indicates the user can perform destroy_environment on this resource.
stopEnvironment Boolean!Indicates the user can perform stop_environment on this resource.
updateEnvironment Boolean!Indicates the user can perform update_environment on this resource.

Epic

Represents an epic.

Fields

NameTypeDescription
author UserCore!Author of the epic.
awardEmoji AwardEmojiConnectionList of award emojis associated with the epic. (see Connections)
blocked BooleanIndicates the epic is blocked.
blockedByCount IntCount of epics blocking this epic.
blockedByEpics EpicConnectionEpics blocking this epic. (see Connections)
blockingCount IntCount of epics that this epic is blocking.
closedAt TimeTimestamp of when the epic was closed.
color StringColor of the epic. Returns null if epic_color_highlight feature flag is disabled.
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
confidential BooleanIndicates if the epic is confidential.
createdAt TimeTimestamp of when the epic was created.
defaultProjectForIssueCreation ProjectDefault Project for issue creation. Based on the project the user created the last issue in.
descendantCounts EpicDescendantCountNumber of open and closed descendant epics and issues.
descendantWeightSum EpicDescendantWeightsTotal weight of open and closed issues in the epic and its descendants.
description StringDescription of the epic.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
downvotes Int!Number of downvotes the epic has received.
dueDate TimeDue date of the epic.
dueDateFixed TimeFixed due date of the epic.
dueDateFromInheritedSource TimeInherited due date of the epic from child epics or milestones.
dueDateFromMilestones TimeInherited due date of the epic from milestones.
dueDateIsFixed BooleanIndicates if the due date has been manually set.
events EventConnectionList of events associated with the object. (see Connections)
group Group!Group to which the epic belongs.
hasChildren Boolean!Indicates if the epic has children.
hasIssues Boolean!Indicates if the epic has direct issues.
hasParent Boolean!Indicates if the epic has a parent epic.
healthStatus EpicHealthStatusCurrent health status of the epic.
id ID!ID of the epic.
iid ID!Internal ID of the epic.
issues EpicIssueConnectionA list of issues associated with the epic. (see Connections)
labels LabelConnectionLabels assigned to the epic. (see Connections)
notes NoteConnection!All notes on this noteable. (see Connections)
parent EpicParent epic of the epic.
participants UserCoreConnectionList of participants for the epic. (see Connections)
relationPath StringURI path of the epic-issue relationship.
relativePosition IntRelative position of the epic in the epic tree.
startDate TimeStart date of the epic.
startDateFixed TimeFixed start date of the epic.
startDateFromInheritedSource TimeInherited start date of the epic from child epics or milestones.
startDateFromMilestones TimeInherited start date of the epic from milestones.
startDateIsFixed BooleanIndicates if the start date has been manually set.
state EpicState!State of the epic.
subscribed Boolean!Indicates the currently logged in user is subscribed to the epic.
textColor StringText color generated for the epic. Returns null if epic_color_highlight feature flag is disabled.
title StringTitle of the epic.
titleHtml StringGitLab Flavored Markdown rendering of title.
updatedAt TimeTimestamp of when the epic was updated.
upvotes Int!Number of upvotes the epic has received.
userDiscussionsCount Int!Number of user discussions in the epic.
userNotesCount Int!Number of user notes of the epic.
userPermissions EpicPermissions!Permissions for the current user on the resource.
webPath String!Web path of the epic.
webUrl String!Web URL of the epic.

Fields with arguments

Epic.ancestors

Ancestors (parents) of the epic.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsername StringFilter epics by author.
confidential BooleanFilter epics by given confidentiality.
createdAfter TimeEpics created after this date.
createdBefore TimeEpics created before this date.
iid IDIID of the epic, e.g., “1”.
iidStartsWith StringFilter epics by IID for autocomplete.
iids [ID!]List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups BooleanInclude epics from ancestor groups.
includeDescendantGroups BooleanInclude epics from descendant groups.
labelName [String!]Filter epics by labels.
milestoneTitle StringFilter epics by milestone title, computed from epic’s issues.
myReactionEmoji StringFilter by reaction emoji applied by the current user.
not NegatedEpicFilterInputNegated epic arguments.
or UnionedEpicFilterInput Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
search StringSearch query for title or description.
sort EpicSortList epics by sort order.
state EpicStateFilter epics by state.
timeframe TimeframeList items overlapping the given timeframe.
topLevelHierarchyOnly BooleanFilter epics with a top-level hierarchy.
updatedAfter TimeEpics updated after this date.
updatedBefore TimeEpics updated before this date.
Epic.children

Children (sub-epics) of the epic.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsername StringFilter epics by author.
confidential BooleanFilter epics by given confidentiality.
createdAfter TimeEpics created after this date.
createdBefore TimeEpics created before this date.
iid IDIID of the epic, e.g., “1”.
iidStartsWith StringFilter epics by IID for autocomplete.
iids [ID!]List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups BooleanInclude child epics from ancestor groups.
includeDescendantGroups BooleanInclude epics from descendant groups.
labelName [String!]Filter epics by labels.
milestoneTitle StringFilter epics by milestone title, computed from epic’s issues.
myReactionEmoji StringFilter by reaction emoji applied by the current user.
not NegatedEpicFilterInputNegated epic arguments.
or UnionedEpicFilterInput Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
search StringSearch query for title or description.
sort EpicSortList epics by sort order.
state EpicStateFilter epics by state.
timeframe TimeframeList items overlapping the given timeframe.
topLevelHierarchyOnly BooleanFilter epics with a top-level hierarchy.
updatedAfter TimeEpics updated after this date.
updatedBefore TimeEpics updated before this date.
Epic.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
state TodoStateEnumState of the to-do items.
Epic.reference

Internal reference of the epic. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
full BooleanIndicates if the reference should be returned in full.

EpicBoard

Represents an epic board.

Fields

NameTypeDescription
displayColors BooleanWhether or not display epic colors.
hideBacklogList BooleanWhether or not backlog list is hidden.
hideClosedList BooleanWhether or not closed list is hidden.
id BoardsEpicBoardID!Global ID of the epic board.
labels LabelConnectionLabels of the board. (see Connections)
name StringName of the epic board.
webPath String!Web path of the epic board.
webUrl String!Web URL of the epic board.

Fields with arguments

EpicBoard.lists

Epic board lists.

Returns EpicListConnection.

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

Arguments
NameTypeDescription
epicFilters EpicFiltersFilters applied when getting epic metadata in the epic board list.
id BoardsEpicListIDFind an epic board list by ID.

EpicDescendantCount

Counts of descendent epics.

Fields

NameTypeDescription
closedEpics IntNumber of closed child epics.
closedIssues IntNumber of closed epic issues.
openedEpics IntNumber of opened child epics.
openedIssues IntNumber of opened epic issues.

EpicDescendantWeights

Total weight of open and closed descendant issues.

Fields

NameTypeDescription
closedIssues IntTotal weight of completed (closed) issues in this epic, including epic descendants.
openedIssues IntTotal weight of opened issues in this epic, including epic descendants.

EpicHealthStatus

Health status of child issues.

Fields

NameTypeDescription
issuesAtRisk IntNumber of issues at risk.
issuesNeedingAttention IntNumber of issues that need attention.
issuesOnTrack IntNumber of issues on track.

EpicIssue

Relationship between an epic and an issue.

Fields

NameTypeDescription
alertManagementAlert AlertManagementAlert Deprecated in 15.6. Use alert_management_alerts.
assignees UserCoreConnectionAssignees of the issue. (see Connections)
author UserCore!User that created the issue.
blocked Boolean!Indicates the issue is blocked.
blockedByCount IntCount of issues blocking this issue.
blockedByIssues IssueConnectionIssues blocking this issue. (see Connections)
blockingCount Int!Count of issues this issue is blocking.
closedAsDuplicateOf IssueIssue this issue was closed as a duplicate of.
closedAt TimeTimestamp of when the issue was closed.
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
confidential Boolean!Indicates the issue is confidential.
createNoteEmail StringUser specific email address for the issue.
createdAt Time!Timestamp of when the issue was created.
customerRelationsContacts CustomerRelationsContactConnectionCustomer relations contacts of the issue. (see Connections)
description StringDescription of the issue.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
designCollection DesignCollectionCollection of design images associated with this issue.
discussionLocked Boolean!Indicates discussion is locked on the issue.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
downvotes Int!Number of downvotes the issue has received.
dueDate TimeDue date of the issue.
emailsDisabled Boolean!Indicates if a project has email notifications disabled: true if email notifications are disabled.
epic EpicEpic to which this issue belongs.
epicIssueId ID!ID of the epic-issue relation.
escalationPolicy EscalationPolicyTypeEscalation policy associated with the issue. Available for issues which support escalation.
escalationStatus IssueEscalationStatusEscalation status of the issue.
hasEpic Boolean!Indicates if the issue belongs to an epic. Can return true and not show an associated epic when the user has no access to the epic.
healthStatus HealthStatusCurrent health status.
hidden BooleanIndicates the issue is hidden because the author has been banned.
humanTimeEstimate StringHuman-readable time estimate of the issue.
humanTotalTimeSpent StringHuman-readable total time reported as spent on the issue.
id IDGlobal ID of the epic-issue relation.
iid ID!Internal ID of the issue.
iteration IterationIteration of the issue.
labels LabelConnectionLabels of the issue. (see Connections)
mergeRequestsCount Int!Number of merge requests that close the issue on merge.
metricImages [MetricImage!]Metric images associated to the issue.
milestone MilestoneMilestone of the issue.
moved BooleanIndicates if issue got moved from other project.
movedTo IssueUpdated Issue after it got moved to another project.
notes NoteConnection!All notes on this noteable. (see Connections)
participants UserCoreConnectionList of participants in the issue. (see Connections)
projectId Int!ID of the issue project.
relatedMergeRequests MergeRequestConnectionMerge requests related to the issue. This field can only be resolved for one issue in any single request. (see Connections)
relatedVulnerabilities VulnerabilityConnectionRelated vulnerabilities of the issue. (see Connections)
relationPath StringURI path of the epic-issue relation.
relativePosition IntRelative position of the issue (used for positioning in epic tree and issue boards).
severity IssuableSeveritySeverity level of the incident.
slaDueAt TimeTimestamp of when the issue SLA expires.
state IssueState!State of the issue.
statusPagePublishedIncident BooleanIndicates whether an issue is published to the status page.
subscribed Boolean!Indicates the currently logged in user is subscribed to the issue.
taskCompletionStatus TaskCompletionStatus!Task completion status of the issue.
timeEstimate Int!Time estimate of the issue.
timelogs TimelogConnection!Timelogs on the issue. (see Connections)
title String!Title of the issue.
titleHtml StringGitLab Flavored Markdown rendering of title.
totalTimeSpent Int!Total time reported as spent on the issue.
type IssueTypeType of the issue.
updatedAt Time!Timestamp of when the issue was last updated.
updatedBy UserCoreUser that last updated the issue.
upvotes Int!Number of upvotes the issue has received.
userDiscussionsCount Int!Number of user discussions in the issue.
userNotesCount Int!Number of user notes of the issue.
userPermissions IssuePermissions!Permissions for the current user on the resource.
webPath String!Web path of the issue.
webUrl String!Web URL of the issue.
weight IntWeight of the issue.

Fields with arguments

EpicIssue.alertManagementAlerts

Alert Management alerts associated to this issue.

Returns AlertManagementAlertConnection.

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

Arguments
NameTypeDescription
assigneeUsername StringUsername of a user assigned to the issue.
domain AlertManagementDomainFilter!Filter query for given domain.
iid StringIID of the alert. For example, “1”.
search StringSearch query for title, description, service, or monitoring_tool.
sort AlertManagementAlertSortSort alerts by this criteria.
statuses [AlertManagementStatus!]Alerts with the specified statues. For example, [TRIGGERED].
EpicIssue.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
state TodoStateEnumState of the to-do items.

Issuable resource links of the incident issue.

Returns IssuableResourceLinkConnection.

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

Arguments
NameTypeDescription
incidentId IssueID!ID of the incident.
EpicIssue.reference

Internal reference of the issue. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
full BooleanBoolean option specifying whether the reference should be returned in full.

EpicList

Represents an epic board list.

Fields

NameTypeDescription
collapsed BooleanIndicates if this list is collapsed for this user.
epicsCount Int Deprecated in 14.9. This was renamed. Use: metadata.
id BoardsEpicListID!Global ID of the board list.
label LabelLabel of the list.
listType String!Type of the list.
metadata EpicListMetadataEpic list metatada.
position IntPosition of the list within the board.
title String!Title of the list.

Fields with arguments

EpicList.epics

List epics.

Returns EpicConnection.

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

Arguments
NameTypeDescription
filters EpicFiltersFilters applied when selecting epics in the board list.

EpicListMetadata

Represents epic board list metadata.

Fields

NameTypeDescription
epicsCount IntCount of epics in the list.
totalWeight Int Introduced in 14.7. This feature is an Experiment. It can be changed or removed at any time. Total weight of all issues in the list.

EpicPermissions

Check permissions for the current user on an epic.

Fields

NameTypeDescription
adminEpic Boolean!Indicates the user can perform admin_epic on this resource.
awardEmoji Boolean!Indicates the user can perform award_emoji on this resource.
createEpic Boolean!Indicates the user can perform create_epic on this resource.
createNote Boolean!Indicates the user can perform create_note on this resource.
destroyEpic Boolean!Indicates the user can perform destroy_epic on this resource.
readEpic Boolean!Indicates the user can perform read_epic on this resource.
readEpicIid Boolean!Indicates the user can perform read_epic_iid on this resource.
updateEpic Boolean!Indicates the user can perform update_epic on this resource.

EscalationPolicyType

Represents an escalation policy.

Fields

NameTypeDescription
description StringDescription of the escalation policy.
id IncidentManagementEscalationPolicyIDID of the escalation policy.
name StringName of the escalation policy.
rules [EscalationRuleType!]Steps of the escalation policy.

EscalationRuleType

Represents an escalation rule for an escalation policy.

Fields

NameTypeDescription
elapsedTimeSeconds IntTime in seconds before the rule is activated.
id IncidentManagementEscalationRuleIDID of the escalation policy.
oncallSchedule IncidentManagementOncallScheduleOn-call schedule to notify.
status EscalationRuleStatusStatus required to prevent the rule from activating.
user UserCoreUser to notify.

Event

Representing an event.

Fields

NameTypeDescription
action EventAction!Action of the event.
author UserCore!Author of this event.
createdAt Time!When this event was created.
id ID!ID of the event.
updatedAt Time!When this event was updated.

ExplainVulnerabilityPrompt

Fields

NameTypeDescription
promptWithCode StringAI text prompt generated using the vulnerability’s information, including the vulnerable code.
promptWithoutCode StringAI text prompt generated using the vulnerability’s information, excluding the vulnerable code.

ExternalAuditEventDestination

Represents an external resource to send audit events to.

Fields

NameTypeDescription
destinationUrl String!External destination to send audit events to.
eventTypeFilters [String!]!List of event type filters added for streaming.
group Group!Group the destination belongs to.
headers AuditEventStreamingHeaderConnection!List of additional HTTP headers sent with each event. (see Connections)
id ID!ID of the destination.
name String!Name of the external destination to send audit events to.
verificationToken String!Verification token to validate source of event.

ExternalIssue

Represents an external issue.

Fields

NameTypeDescription
createdAt TimeTimestamp of when the issue was created.
externalTracker StringType of external tracker.
relativeReference StringRelative reference of the issue in the external tracker.
status StringStatus of the issue in the external tracker.
title StringTitle of the issue in the external tracker.
updatedAt TimeTimestamp of when the issue was updated.
webUrl StringURL to the issue in the external tracker.

ExternalStatusCheck

Describes an external status check.

Fields

NameTypeDescription
externalUrl String!External URL for the status check.
id GlobalID!ID of the rule.
name String!Name of the rule.

FileUpload

Fields

NameTypeDescription
id UploadID!Global ID of the upload.
path String!Path of the upload.
size Int!Size of the upload in bytes.

FindingReportsComparer

Represents security reports comparison for vulnerability findings.

Fields

NameTypeDescription
report ComparedSecurityReport Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Compared security report.
status FindingReportsComparerStatusComparison status.
statusReason StringText explaining the status.

Forecast

Information about specific forecast created.

Fields

NameTypeDescription
status ForecastStatus!Status of the forecast.
values ForecastDatapointConnectionActual forecast values. (see Connections)

ForecastDatapoint

Information about specific forecast datapoint.

Fields

NameTypeDescription
datapoint String!Datapoint of the forecast. Usually a date.
value FloatValue of the given datapoint.

ForkDetails

Details of the fork project compared to its upstream project.

Fields

NameTypeDescription
ahead IntNumber of commits ahead of upstream.
behind IntNumber of commits behind upstream.
hasConflicts BooleanIndicates if the fork conflicts with its upstream project.
isSyncing BooleanIndicates if there is a synchronization in progress.

GeoNode

Fields

NameTypeDescription
containerRepositoriesMaxCapacity IntMaximum concurrency of container repository sync for this secondary node.
enabled BooleanIndicates whether this Geo node is enabled.
filesMaxCapacity IntMaximum concurrency of LFS/attachment backfill for this secondary node.
id ID!ID of this GeoNode.
internalUrl StringURL defined on the primary node secondary nodes should use to contact it.
minimumReverificationInterval IntInterval (in days) in which the repository verification is valid. After expiry, it is reverted.
name StringUnique identifier for this Geo node.
primary BooleanIndicates whether this Geo node is the primary.
reposMaxCapacity IntMaximum concurrency of repository backfill for this secondary node.
selectiveSyncNamespaces NamespaceConnectionNamespaces that should be synced, if selective_sync_type == namespaces. (see Connections)
selectiveSyncShards [String!]Repository storages whose projects should be synced, if selective_sync_type == shards.
selectiveSyncType StringIndicates if syncing is limited to only specific groups, or shards.
syncObjectStorage BooleanIndicates if this secondary node will replicate blobs in Object Storage.
url StringUser-facing URL for this Geo node.
verificationMaxCapacity IntMaximum concurrency of repository verification for this secondary node.

Fields with arguments

GeoNode.ciSecureFileRegistries

Find Ci Secure File registries on this Geo node.

Returns CiSecureFileRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.containerRepositoryRegistries

Find Container Repository registries on this Geo node.

Returns ContainerRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.dependencyProxyBlobRegistries

Find Dependency Proxy Blob registries on this Geo node.

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

Returns DependencyProxyBlobRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.dependencyProxyManifestRegistries

Find Dependency Proxy Manifest registries on this Geo node.

Returns DependencyProxyManifestRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.designManagementRepositoryRegistries

Find Design Repository registries on this Geo node. Ignored if geo_design_management_repository_replication feature flag is disabled.

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

Returns DesignManagementRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.groupWikiRepositoryRegistries

Find group wiki repository registries on this Geo node.

Returns GroupWikiRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.jobArtifactRegistries

Find Job Artifact registries on this Geo node.

Returns JobArtifactRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.lfsObjectRegistries

Find LFS object registries on this Geo node.

Returns LfsObjectRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.mergeRequestDiffRegistries

Find merge request diff registries on this Geo node.

Returns MergeRequestDiffRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.packageFileRegistries

Package file registries of the GeoNode.

Returns PackageFileRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.pagesDeploymentRegistries

Find Pages Deployment registries on this Geo node.

Returns PagesDeploymentRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.pipelineArtifactRegistries

Find pipeline artifact registries on this Geo node.

Returns PipelineArtifactRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.projectRepositoryRegistries

Find Project registries on this Geo node. Ignored if geo_project_repository_replication feature flag is disabled.

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

Returns ProjectRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.projectWikiRepositoryRegistries

Find Project Wiki Repository registries on this Geo node. Ignored if geo_project_wiki_repository_replication feature flag is disabled.

Returns ProjectWikiRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.snippetRepositoryRegistries

Find snippet repository registries on this Geo node.

Returns SnippetRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.terraformStateVersionRegistries

Find terraform state version registries on this Geo node.

Returns TerraformStateVersionRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.
GeoNode.uploadRegistries

Find Upload registries on this Geo node.

Returns UploadRegistryConnection.

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

Arguments
NameTypeDescription
ids [ID!]Filters registries by their ID.
keyword StringFilters registries by their attributes using a keyword.
replicationState ReplicationStateEnumFilters registries by their replication state.
verificationState VerificationStateEnumFilters registries by their verification state.

GoogleCloudLoggingConfigurationType

Stores Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Fields

NameTypeDescription
clientEmail String!Client email.
googleProjectIdName String!Google project ID.
group Group!Group the configuration belongs to.
id ID!ID of the configuration.
logIdName String!Log ID.

GpgSignature

GPG signature for a signed commit.

Fields

NameTypeDescription
commitSha StringSHA of the associated commit.
gpgKeyPrimaryKeyid StringID of the GPG key.
gpgKeyUserEmail StringUser email associated with the GPG key.
gpgKeyUserName StringUser name associated with the GPG key.
project ProjectProject of the associated commit.
user UserCoreUser associated with the key.
verificationStatus VerificationStatusIndicates verification status of the associated key or certificate.

GrafanaIntegration

Fields

NameTypeDescription
createdAt Time!Timestamp of the issue’s creation.
enabled Boolean!Indicates whether Grafana integration is enabled.
grafanaUrl String!URL for the Grafana host for the Grafana integration.
id ID!Internal ID of the Grafana integration.
updatedAt Time!Timestamp of the issue’s last activity.

Group

Fields

NameTypeDescription
actualRepositorySizeLimit FloatSize limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement.
actualSizeLimit FloatActual storage size limit for the namespace in bytes. This limit is agnostic of enforcement type.
additionalPurchasedStorageSize FloatAdditional storage purchased for the root namespace in bytes.
allowStaleRunnerPruning Boolean!Indicates whether to regularly prune stale group runners. Defaults to false.
autoDevopsEnabled BooleanIndicates whether Auto DevOps is enabled for all projects within this group.
avatarUrl StringAvatar URL of the group.
containerRepositoriesCount Int!Number of container repositories in the group.
containsLockedProjects Boolean!Includes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
crossProjectPipelineAvailable Boolean!Indicates if the cross_project_pipeline feature is available for the namespace.
customEmoji CustomEmojiConnection Introduced in 13.6. This feature is an Experiment. It can be changed or removed at any time. Custom emoji within this namespace.
dependencyProxyBlobCount Int!Number of dependency proxy blobs cached in the group.
dependencyProxyBlobs DependencyProxyBlobConnectionDependency Proxy blobs. (see Connections)
dependencyProxyImageCount Int!Number of dependency proxy images cached in the group.
dependencyProxyImagePrefix String!Prefix for pulling images when using the dependency proxy.
dependencyProxyImageTtlPolicy DependencyProxyImageTtlGroupPolicyDependency proxy TTL policy for the group.
dependencyProxyManifests DependencyProxyManifestConnectionDependency Proxy manifests. (see Connections)
dependencyProxySetting DependencyProxySettingDependency Proxy settings for the group.
dependencyProxyTotalSize String!Total size of the dependency proxy cached images.
dependencyProxyTotalSizeBytes BigInt!Total size of the dependency proxy cached images in bytes, encoded as a string.
dependencyProxyTotalSizeInBytes Int! Deprecated in 16.1. Use dependencyProxyTotalSizeBytes.
description StringDescription of the namespace.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
dora DoraGroup’s DORA metrics.
doraPerformanceScoreCounts DoraPerformanceScoreCountConnectionGroup’s DORA scores for all projects by DORA key metric for the last complete month. (see Connections)
emailsDisabled BooleanIndicates if a group has email notifications disabled.
enforceFreeUserCap BooleanIndicates whether the group has limited users for a free plan.
epicBoards EpicBoardConnectionFind epic boards. (see Connections)
epicsEnabled BooleanIndicates if Epics are enabled for namespace.
externalAuditEventDestinations ExternalAuditEventDestinationConnectionExternal locations that receive audit events belonging to the group. (see Connections)
flowMetrics GroupValueStreamAnalyticsFlowMetrics Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Flow metrics for value stream analytics.
fullName String!Full name of the namespace.
fullPath ID!Full path of the namespace.
googleCloudLoggingConfigurations GoogleCloudLoggingConfigurationTypeConnectionGoogle Cloud logging configurations that receive audit events belonging to the group. (see Connections)
id ID!ID of the namespace.
isTemporaryStorageIncreaseEnabled Boolean!Status of the temporary storage increase.
lfsEnabled BooleanIndicates if Large File Storage (LFS) is enabled for namespace.
mentionsDisabled BooleanIndicates if a group is disabled from getting mentioned.
name String!Name of the namespace.
packageSettings PackageSettingsPackage settings for the namespace.
parent GroupParent group.
path String!Path of the namespace.
projectCreationLevel StringPermission level required to create projects in the group.
recentIssueBoards BoardConnectionList of recently visited boards of the group. Maximum size is 4. (see Connections)
repositorySizeExcessProjectCount Int!Number of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
requestAccessEnabled BooleanIndicates if users can request access to namespace.
requireTwoFactorAuthentication BooleanIndicates if all users in this group are required to set up two-factor authentication.
rootStorageStatistics RootStorageStatisticsAggregated storage statistics of the namespace. Only available for root namespaces.
shareWithGroupLock BooleanIndicates if sharing a project with another group within this group is prevented.
sharedRunnersSetting SharedRunnersSettingShared runners availability for the namespace and its descendants.
stats GroupStatsGroup statistics.
storageSizeLimit FloatStorage limit included in the root namespace plan in bytes. This limit only applies to namespaces under Namespace limit enforcement.
subgroupCreationLevel StringPermission level required to create subgroups within the group.
temporaryStorageIncreaseEndsOn TimeDate until the temporary storage increase is active.
timelogCategories TimeTrackingTimelogCategoryConnection Introduced in 15.3. This feature is an Experiment. It can be changed or removed at any time. Timelog categories for the namespace.
totalRepositorySize FloatTotal repository size of all projects in the root namespace in bytes.
totalRepositorySizeExcess FloatTotal excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement.
twoFactorGracePeriod IntTime before two-factor authentication is enforced.
userPermissions GroupPermissions!Permissions for the current user on the resource.
visibility StringVisibility of the namespace.
vulnerabilityScanners VulnerabilityScannerConnectionVulnerability scanners reported on the project vulnerabilities of the group and its subgroups. (see Connections)
webUrl String!Web URL of the group.

Fields with arguments

Group.achievements

Achievements for the namespace. Returns null if the achievements feature flag is disabled.

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

Returns AchievementConnection.

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

Arguments
NameTypeDescription
ids [AchievementsAchievementID!]Filter achievements by IDs.
Group.addOnPurchase

AddOnPurchase associated with the namespace.

Returns AddOnPurchase.

Arguments
NameTypeDescription
addOnName String!AddOn name.
Group.billableMembersCount

Number of billable users in the group.

Returns Int.

Arguments
NameTypeDescription
requestedHostedPlan StringPlan from which to get billable members.
Group.board

A single board of the group.

Returns Board.

Arguments
NameTypeDescription
id BoardID!ID of the board.
Group.boards

Boards of the group.

Returns BoardConnection.

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

Arguments
NameTypeDescription
id BoardIDFind a board by its ID.
Group.ciVariables

List of the group’s CI/CD variables.

Returns CiGroupVariableConnection.

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.
Group.clusterAgents

Cluster agents associated with projects in the group and its subgroups.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
hasRemoteDevelopmentAgentConfig BooleanReturns only cluster agents which have an associated remote development agent config.
hasVulnerabilities BooleanReturns only cluster agents which have vulnerabilities.
Group.codeCoverageActivities

Represents the code coverage activity for this group.

Returns CodeCoverageActivityConnection.

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

Arguments
NameTypeDescription
startDate Date!First day for which to fetch code coverage activity (maximum time window is set to 90 days).
Group.complianceFrameworks

Compliance frameworks available to projects in this namespace.

Returns ComplianceFrameworkConnection.

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

Arguments
NameTypeDescription
id ComplianceManagementFrameworkIDGlobal ID of a specific compliance framework to return.
Group.contactStateCounts

Counts of contacts by state for the group.

Returns ContactStateCounts.

Arguments
NameTypeDescription
search StringSearch term to find contacts with.
state CustomerRelationsContactStateState of the contacts to search for.
Group.contacts

Find contacts of this group.

Returns CustomerRelationsContactConnection.

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

Arguments
NameTypeDescription
ids [CustomerRelationsContactID!]Filter contacts by IDs.
search StringSearch term to find contacts with.
sort ContactSortCriteria to sort contacts by.
state CustomerRelationsContactStateState of the contacts to search for.
Group.containerRepositories

Container repositories of the group.

Returns ContainerRepositoryConnection.

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

Arguments
NameTypeDescription
name StringFilter the container repositories by their name.
sort ContainerRepositorySortSort container repositories by this criteria.
Group.contributions

Provides the aggregated contributions by users within the group and its subgroups.

Returns ContributionAnalyticsContributionConnection.

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

Arguments
NameTypeDescription
from ISO8601Date!Start date of the reporting time range.
to ISO8601Date!End date of the reporting time range. The end date must be within 93 days after the start date.
Group.dataTransfer

Data transfer data point for a specific period. This is mocked data under a development feature flag.

Returns GroupDataTransfer.

Arguments
NameTypeDescription
from DateRetain egress data for one year. Data for the current month will increase dynamically as egress occurs.
to DateEnd date for the data.
Group.descendantGroups

List of descendant groups of this group.

Returns GroupConnection.

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

Arguments
NameTypeDescription
includeParentDescendants BooleanList of descendant groups of the parent group.
owned BooleanLimit result to groups owned by authenticated user.
search StringSearch query for group name or group full path.
Group.environmentScopes

Environment scopes of the group.

Returns CiGroupEnvironmentScopeConnection.

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

Arguments
NameTypeDescription
name StringName of the environment scope.
search StringSearch query for environment scope name.
Group.epic

Find a single epic.

Returns Epic.

Arguments
NameTypeDescription
authorUsername StringFilter epics by author.
confidential BooleanFilter epics by given confidentiality.
createdAfter TimeEpics created after this date.
createdBefore TimeEpics created before this date.
iid IDIID of the epic, e.g., “1”.
iidStartsWith StringFilter epics by IID for autocomplete.
iids [ID!]List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups BooleanInclude epics from ancestor groups.
includeDescendantGroups BooleanInclude epics from descendant groups.
labelName [String!]Filter epics by labels.
milestoneTitle StringFilter epics by milestone title, computed from epic’s issues.
myReactionEmoji StringFilter by reaction emoji applied by the current user.
not NegatedEpicFilterInputNegated epic arguments.
or UnionedEpicFilterInput Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
search StringSearch query for title or description.
sort EpicSortList epics by sort order.
state EpicStateFilter epics by state.
timeframe TimeframeList items overlapping the given timeframe.
topLevelHierarchyOnly BooleanFilter epics with a top-level hierarchy.
updatedAfter TimeEpics updated after this date.
updatedBefore TimeEpics updated before this date.
Group.epicBoard

Find a single epic board.

Returns EpicBoard.

Arguments
NameTypeDescription
id BoardsEpicBoardID!Find an epic board by ID.
Group.epics

Find epics.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsername StringFilter epics by author.
confidential BooleanFilter epics by given confidentiality.
createdAfter TimeEpics created after this date.
createdBefore TimeEpics created before this date.
iid IDIID of the epic, e.g., “1”.
iidStartsWith StringFilter epics by IID for autocomplete.
iids [ID!]List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups BooleanInclude epics from ancestor groups.
includeDescendantGroups BooleanInclude epics from descendant groups.
labelName [String!]Filter epics by labels.
milestoneTitle StringFilter epics by milestone title, computed from epic’s issues.
myReactionEmoji StringFilter by reaction emoji applied by the current user.
not NegatedEpicFilterInputNegated epic arguments.
or UnionedEpicFilterInput Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
search StringSearch query for title or description.
sort EpicSortList epics by sort order.
state EpicStateFilter epics by state.
timeframe TimeframeList items overlapping the given timeframe.
topLevelHierarchyOnly BooleanFilter epics with a top-level hierarchy.
updatedAfter TimeEpics updated after this date.
updatedBefore TimeEpics updated before this date.
Group.gitlabSubscriptionsPreviewBillableUserChange

Preview Billable User Changes.

Returns PreviewBillableUserChange.

Arguments
NameTypeDescription
addGroupId IntGroup ID to add.
addUserEmails [String!]User emails to add.
addUserIds [Int!]User IDs to add.
role GitlabSubscriptionsUserRole!Role of users being added to group.
Group.groupMembers

A membership of a user within this group.

Returns GroupMemberConnection.

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

Arguments
NameTypeDescription
accessLevels [AccessLevelEnum!]Filter members by the given access levels.
relations [GroupMemberRelation!]Filter members by the given member relations.
search StringSearch query.
sort MemberSortsort query.
Group.issues

Issues for projects in this group.

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.
healthStatus HealthStatus Deprecated in 15.4. Use healthStatusFilter.
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 BooleanReturn issues from archived projects.
includeSubepics BooleanWhether to include subepics when filtering issues by epicId.
includeSubgroups BooleanInclude issues belonging to subgroups.
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.
Group.iterationCadences

Find iteration cadences.

Returns IterationCadenceConnection.

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

Arguments
NameTypeDescription
active BooleanWhether the iteration cadence is active.
automatic BooleanWhether the iteration cadence should automatically generate upcoming iterations.
durationInWeeks IntDuration in weeks of the iterations within this cadence.
id IterationsCadenceIDGlobal ID of the iteration cadence to look up.
includeAncestorGroups BooleanWhether to include ancestor groups to search iterations cadences in.
title StringFuzzy search by title.
Group.iterations

Find iterations.

Returns IterationConnection.

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

Arguments
NameTypeDescription
id IDGlobal ID of the Iteration to look up.
iid IDInternal ID of the Iteration to look up.
in [IterationSearchableField!]Fields in which the fuzzy-search should be performed with the query given in the argument search. Defaults to [title].
includeAncestors BooleanWhether to include ancestor iterations. Defaults to true.
iterationCadenceIds [IterationsCadenceID!]Global iteration cadence IDs by which to look up the iterations.
search StringQuery used for fuzzy-searching in the fields selected in the argument in. Returns all iterations if empty.
sort IterationSortList iterations by sort order. If unspecified, an arbitrary order (subject to change) is used.
state IterationStateFilter iterations by state.
timeframe TimeframeList items overlapping the given timeframe.
title String Deprecated in 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
Group.label

Label available on this group.

Returns Label.

Arguments
NameTypeDescription
title String!Title of the label.
Group.labels

Labels available on this group.

Returns LabelConnection.

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

Arguments
NameTypeDescription
includeAncestorGroups BooleanInclude labels from ancestor groups.
includeDescendantGroups BooleanInclude labels from descendant groups.
onlyGroupLabels BooleanInclude only group level labels.
searchTerm StringSearch term to find labels with.
Group.mergeRequestViolations

Compliance violations reported on merge requests merged within the group.

Returns ComplianceViolationConnection.

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

Arguments
NameTypeDescription
filters ComplianceViolationInputFilters applied when retrieving compliance violations.
sort ComplianceViolationSortList compliance violations by sort order.
Group.mergeRequests

Merge requests for projects in this group.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
includeArchived BooleanReturn merge requests from archived projects.
includeSubgroups BooleanInclude merge requests belonging to subgroups.
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
Group.milestones

Milestones of the group.

Returns MilestoneConnection.

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

Arguments
NameTypeDescription
containingDate TimeDate the milestone contains.
ids [ID!]Array of global milestone IDs, e.g., "gid://gitlab/Milestone/1".
includeAncestors BooleanInclude milestones from all parent groups.
includeDescendants BooleanInclude milestones from all subgroups and subprojects.
searchTitle StringSearch string for the title.
sort MilestoneSortSort milestones by this criteria.
state MilestoneStateEnumFilter milestones by state.
timeframe TimeframeList items overlapping the given timeframe.
title StringTitle of the milestone.
Group.organizationStateCounts

Counts of organizations by status for the group.

Returns OrganizationStateCounts.

Arguments
NameTypeDescription
search StringSearch term to find organizations with.
state CustomerRelationsOrganizationStateState of the organizations to search for.
Group.organizations

Find organizations of this group.

Returns CustomerRelationsOrganizationConnection.

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

Arguments
NameTypeDescription
ids [CustomerRelationsOrganizationID!]Filter organizations by IDs.
search StringSearch term used to find organizations with.
sort OrganizationSortCriteria to sort organizations by.
state CustomerRelationsOrganizationStateState of the organization to search for.
Group.packages

Packages of the group. This field can only be resolved for one group in any single request.

Returns PackageConnection.

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

Arguments
NameTypeDescription
includeVersionless BooleanInclude versionless packages.
packageName StringSearch a package by name.
packageType PackageTypeEnumFilter a package by type.
sort PackageGroupSortSort packages by this criteria.
status PackageStatusFilter a package by status.
Group.projectComplianceStandardsAdherence

Compliance standards adherence for the projects in a group and its subgroups.

Returns ComplianceStandardsAdherenceConnection.

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

Arguments
NameTypeDescription
filters ComplianceStandardsAdherenceInputFilters applied when retrieving compliance standards adherence.
Group.projects

Projects within this namespace.

Returns ProjectConnection!.

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

Arguments
NameTypeDescription
complianceFrameworkFilters ComplianceFrameworkFiltersFilters applied when selecting a compliance framework.
hasCodeCoverage BooleanReturns only the projects which have code coverage.
hasVulnerabilities BooleanReturns only the projects which have vulnerabilities.
ids [ID!]Filter projects by IDs.
includeSubgroups BooleanInclude also subgroup projects.
notAimedForDeletion BooleanInclude projects that are not aimed for deletion.
sbomComponentId IDReturn only the projects related to the specified SBOM component.
search StringSearch project with most similar names or paths.
sort NamespaceProjectSortSort projects by this criteria.
withIssuesEnabled BooleanReturn only projects with issues enabled.
withMergeRequestsEnabled BooleanReturn only projects with merge requests enabled.
Group.releases

Releases belonging to projects in the group.

Returns ReleaseConnection.

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

Arguments
NameTypeDescription
sort GroupReleaseSortSort group releases by given criteria.
Group.runners

Find runners visible to the current user.

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.
membership CiRunnerMembershipFilterControl which runners to include in the results.
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.
Group.scanExecutionPolicies

Scan Execution Policies of the namespace.

Returns ScanExecutionPolicyConnection.

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

Arguments
NameTypeDescription
actionScanTypes [SecurityReportTypeEnum!]Filters policies by the action scan type. Only these scan types are supported: dast, secret_detection, cluster_image_scanning, container_scanning, sast, sast_iac, dependency_scanning.
relationship SecurityPolicyRelationTypeFilter policies by the given policy relationship.
Group.scanResultPolicies

Scan Result Policies of the project.

Returns ScanResultPolicyConnection.

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

Arguments
NameTypeDescription
relationship SecurityPolicyRelationTypeFilter policies by the given policy relationship.
Group.timelogs

Time logged on issues and merge requests in the group and its subgroups.

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.
Group.vulnerabilities

Vulnerabilities reported on the projects in the group and its subgroups.

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.
hasIssues BooleanReturns only the vulnerabilities which have linked issues.
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.
Group.vulnerabilitiesCountByDay

The historical number of vulnerabilities per day for the projects in the group and its subgroups.

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.
Group.vulnerabilityGrades

Represents vulnerable project counts for each grade.

Returns [VulnerableProjectsByGrade!].

Arguments
NameTypeDescription
includeSubgroups BooleanInclude grades belonging to subgroups.
letterGrade VulnerabilityGradeFilter the response by given letter grade.
Group.vulnerabilitySeveritiesCount

Counts for each vulnerability severity in the group and its subgroups.

Returns VulnerabilitySeveritiesCount.

Arguments
NameTypeDescription
clusterAgentId [ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
hasIssues BooleanFilter vulnerabilities that do or do not have issues.
hasResolution BooleanFilter vulnerabilities that do or do not have a resolution.
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 scanner.
scannerId [VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity [VulnerabilitySeverity!]Filter vulnerabilities by severity.
state [VulnerabilityState!]Filter vulnerabilities by state.
Group.workItemTypes

Work item types available to the group.

Returns WorkItemTypeConnection.

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

Arguments
NameTypeDescription
taskable BooleanIf true, only taskable work item types will be returned. Argument is experimental and can be removed in the future without notice.

GroupDataTransfer

Fields

NameTypeDescription
egressNodes EgressNodeConnectionData nodes. (see Connections)

GroupMember

Represents a Group Membership.

Fields

NameTypeDescription
accessLevel AccessLevelGitLab::Access level.
createdAt TimeDate and time the membership was created.
createdBy UserCoreUser that authorized membership.
expiresAt TimeDate and time the membership expires.
group GroupGroup that a User is a member of.
id ID!ID of the member.
notificationEmail StringGroup notification email for User. Only available for admins.
updatedAt TimeDate and time the membership was last updated.
user UserCoreUser that is associated with the member object.
userPermissions GroupPermissions!Permissions for the current user on the resource.

Fields with arguments

GroupMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
NameTypeDescription
id MergeRequestID!Global ID of the merge request.

GroupPermissions

Fields

NameTypeDescription
createProjects Boolean!Indicates the user can perform create_projects on this resource.
readGroup Boolean!Indicates the user can perform read_group on this resource.

GroupReleaseStats

Contains release-related statistics about a group.

Fields

NameTypeDescription
releasesCount IntTotal number of releases in all descendant projects of the group.
releasesPercentage IntPercentage of the group’s descendant projects that have at least one release.

GroupSecurityPolicySource

Represents the source of a security policy belonging to a group.

Fields

NameTypeDescription
inherited Boolean!Indicates whether this policy is inherited from parent group.
namespace NamespaceProject the policy is associated with.

GroupStats

Contains statistics about a group.

Fields

NameTypeDescription
releaseStats GroupReleaseStatsStatistics related to releases within the group.

GroupValueStreamAnalyticsFlowMetrics

Exposes aggregated value stream flow metrics.

Fields with arguments

GroupValueStreamAnalyticsFlowMetrics.cycleTime

Median time from first commit to issue closed.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames [String!]Usernames of users assigned to the issue.
authorUsername StringUsername of the author of the issue.
from Time!Timestamp marking the start date and time.
labelNames [String!]Labels applied to the issue.
milestoneTitle StringMilestone applied to the issue.
projectIds [ID!]Project IDs within the group hierarchy.
to Time!Timestamp marking the end date and time.
GroupValueStreamAnalyticsFlowMetrics.deploymentCount

Number of production deployments in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
from Time!Timestamp marking the start date and time.
projectIds [ID!]Project IDs within the group hierarchy.
to Time!Timestamp marking the end date and time.
GroupValueStreamAnalyticsFlowMetrics.issueCount

Number of issues opened in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames [String!]Usernames of users assigned to the issue.
authorUsername StringUsername of the author of the issue.
from Time!Timestamp marking the start date and time.
labelNames [String!]Labels applied to the issue.
milestoneTitle StringMilestone applied to the issue.
projectIds [ID!]Project IDs within the group hierarchy.
to Time!Timestamp marking the end date and time.
GroupValueStreamAnalyticsFlowMetrics.issuesCompletedCount

Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames [String!]Usernames of users assigned to the issue.
authorUsername StringUsername of the author of the issue.
from Time!Timestamp marking the start date and time.
labelNames [String!]Labels applied to the issue.
milestoneTitle StringMilestone applied to the issue.
projectIds [ID!]Project IDs within the group hierarchy.
to Time!Timestamp marking the end date and time.
GroupValueStreamAnalyticsFlowMetrics.leadTime

Median time from when the issue was created to when it was closed.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames [String!]Usernames of users assigned to the issue.
authorUsername StringUsername of the author of the issue.
from Time!Timestamp marking the start date and time.
labelNames [String!]Labels applied to the issue.
milestoneTitle StringMilestone applied to the issue.
projectIds [ID!]Project IDs within the group hierarchy.
to Time!Timestamp marking the end date and time.

GroupWikiRepositoryRegistry

Represents the Geo sync and verification state of a group wiki repository.

Fields

NameTypeDescription
createdAt TimeTimestamp when the GroupWikiRepositoryRegistry was created.
groupWikiRepositoryId ID!ID of the Group Wiki Repository.
id ID!ID of the GroupWikiRepositoryRegistry.
lastSyncFailure StringError message during sync of the GroupWikiRepositoryRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the GroupWikiRepositoryRegistry.
retryAt TimeTimestamp after which the GroupWikiRepositoryRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the GroupWikiRepositoryRegistry.
state RegistryStateSync state of the GroupWikiRepositoryRegistry.
verificationRetryAt TimeTimestamp after which the GroupWikiRepositoryRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the GroupWikiRepositoryRegistry.

HelmFileMetadata

Helm file metadata.

Fields

NameTypeDescription
channel String!Channel of the Helm chart.
createdAt Time!Date of creation.
metadata PackageHelmMetadataType!Metadata of the Helm chart.
updatedAt Time!Date of most recent update.

Ide

IDE settings and feature flags.

Fields

NameTypeDescription
codeSuggestionsEnabled Boolean!Indicates whether AI assisted code suggestions are enabled.

IncidentManagementOncallRotation

Describes an incident management on-call rotation.

Fields

NameTypeDescription
activePeriod OncallRotationActivePeriodTypeActive period for the on-call rotation.
endsAt TimeEnd date and time of the on-call rotation.
id IncidentManagementOncallRotationID!ID of the on-call rotation.
length IntLength of the on-call schedule, in the units specified by lengthUnit.
lengthUnit OncallRotationUnitEnumUnit of the on-call rotation length.
name String!Name of the on-call rotation.
participants OncallParticipantTypeConnectionParticipants of the on-call rotation. (see Connections)
startsAt TimeStart date of the on-call rotation.

Fields with arguments

IncidentManagementOncallRotation.shifts

Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month.

Returns IncidentManagementOncallShiftConnection.

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

Arguments
NameTypeDescription
endTime Time!End of timeframe to include shifts for. Cannot exceed one month after start.
startTime Time!Start of timeframe to include shifts for.

IncidentManagementOncallSchedule

Describes an incident management on-call schedule.

Fields

NameTypeDescription
description StringDescription of the on-call schedule.
iid ID!Internal ID of the on-call schedule.
name String!Name of the on-call schedule.
oncallUsers [UserCore!] 
rotations IncidentManagementOncallRotationConnection!On-call rotations for the on-call schedule. (see Connections)
timezone String!Time zone of the on-call schedule.

Fields with arguments

IncidentManagementOncallSchedule.rotation

On-call rotation for the on-call schedule.

Returns IncidentManagementOncallRotation.

Arguments
NameTypeDescription
id IncidentManagementOncallRotationID!ID of the on-call rotation.

IncidentManagementOncallShift

A block of time for which a participant is on-call.

Fields

NameTypeDescription
endsAt TimeEnd time of the on-call shift.
participant OncallParticipantTypeParticipant assigned to the on-call shift.
startsAt TimeStart time of the on-call shift.

InheritedCiVariable

CI/CD variables a project inherites from its parent group and ancestors.

Fields

NameTypeDescription
environmentScope StringScope defining the environments that can use the variable.
groupCiCdSettingsPath StringIndicates the path to the CI/CD settings of the group the variable belongs to.
groupName StringIndicates group the variable belongs to.
id ID!ID of the variable.
key StringName of the variable.
masked BooleanIndicates whether the variable is masked.
protected BooleanIndicates whether the variable is protected.
raw BooleanIndicates whether the variable is raw.
variableType CiVariableTypeType of the variable.

InstanceExternalAuditEventDestination

Represents an external resource to send instance audit events to.

Fields

NameTypeDescription
destinationUrl String!External destination to send audit events to.
eventTypeFilters [String!]!List of event type filters added for streaming.
headers AuditEventsStreamingInstanceHeaderConnection!List of additional HTTP headers sent with each event. (see Connections)
id ID!ID of the destination.
name String!Name of the external destination to send audit events to.
verificationToken String!Verification token to validate source of event.

InstanceSecurityDashboard

Fields

NameTypeDescription
vulnerabilityScanners VulnerabilityScannerConnectionVulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. (see Connections)

Fields with arguments

InstanceSecurityDashboard.clusterAgents

Cluster agents associated with projects selected in the Instance Security Dashboard.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
hasRemoteDevelopmentAgentConfig BooleanReturns only cluster agents which have an associated remote development agent config.
hasVulnerabilities BooleanReturns only cluster agents which have vulnerabilities.
InstanceSecurityDashboard.projects

Projects selected in Instance Security Dashboard.

Returns ProjectConnection!.

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, which can be for the project name, a path, or a description.
InstanceSecurityDashboard.vulnerabilityGrades

Represents vulnerable project counts for each grade.

Returns [VulnerableProjectsByGrade!]!.

Arguments
NameTypeDescription
letterGrade VulnerabilityGradeFilter the response by given letter grade.
InstanceSecurityDashboard.vulnerabilitySeveritiesCount

Counts for each vulnerability severity from projects selected in Instance Security Dashboard.

Returns VulnerabilitySeveritiesCount.

Arguments
NameTypeDescription
clusterAgentId [ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
hasIssues BooleanFilter vulnerabilities that do or do not have issues.
hasResolution BooleanFilter vulnerabilities that do or do not have a resolution.
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 scanner.
scannerId [VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity [VulnerabilitySeverity!]Filter vulnerabilities by severity.
state [VulnerabilityState!]Filter vulnerabilities by state.

Describes an issuable resource link for incident issues.

Fields

NameTypeDescription
id IncidentManagementIssuableResourceLinkID!ID of the Issuable resource link.
issue Issue!Incident of the resource link.
link String!Web Link to the resource.
linkText StringOptional text for the link.
linkType IssuableResourceLinkType!Type of the resource link.

Issue

Fields

NameTypeDescription
alertManagementAlert AlertManagementAlert Deprecated in 15.6. Use alert_management_alerts.
assignees UserCoreConnectionAssignees of the issue. (see Connections)
author UserCore!User that created the issue.
blocked Boolean!Indicates the issue is blocked.
blockedByCount IntCount of issues blocking this issue.
blockedByIssues IssueConnectionIssues blocking this issue. (see Connections)
blockingCount Int!Count of issues this issue is blocking.
closedAsDuplicateOf IssueIssue this issue was closed as a duplicate of.
closedAt TimeTimestamp of when the issue was closed.
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
confidential Boolean!Indicates the issue is confidential.
createNoteEmail StringUser specific email address for the issue.
createdAt Time!Timestamp of when the issue was created.
customerRelationsContacts CustomerRelationsContactConnectionCustomer relations contacts of the issue. (see Connections)
description StringDescription of the issue.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
designCollection DesignCollectionCollection of design images associated with this issue.
discussionLocked Boolean!Indicates discussion is locked on the issue.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
downvotes Int!Number of downvotes the issue has received.
dueDate TimeDue date of the issue.
emailsDisabled Boolean!Indicates if a project has email notifications disabled: true if email notifications are disabled.
epic EpicEpic to which this issue belongs.
escalationPolicy EscalationPolicyTypeEscalation policy associated with the issue. Available for issues which support escalation.
escalationStatus IssueEscalationStatusEscalation status of the issue.
hasEpic Boolean!Indicates if the issue belongs to an epic. Can return true and not show an associated epic when the user has no access to the epic.
healthStatus HealthStatusCurrent health status.
hidden BooleanIndicates the issue is hidden because the author has been banned.
humanTimeEstimate StringHuman-readable time estimate of the issue.
humanTotalTimeSpent StringHuman-readable total time reported as spent on the issue.
id ID!ID of the issue.
iid ID!Internal ID of the issue.
iteration IterationIteration of the issue.
labels LabelConnectionLabels of the issue. (see Connections)
mergeRequestsCount Int!Number of merge requests that close the issue on merge.
metricImages [MetricImage!]Metric images associated to the issue.
milestone MilestoneMilestone of the issue.
moved BooleanIndicates if issue got moved from other project.
movedTo IssueUpdated Issue after it got moved to another project.
notes NoteConnection!All notes on this noteable. (see Connections)
participants UserCoreConnectionList of participants in the issue. (see Connections)
projectId Int!ID of the issue project.
relatedMergeRequests MergeRequestConnectionMerge requests related to the issue. This field can only be resolved for one issue in any single request. (see Connections)
relatedVulnerabilities VulnerabilityConnectionRelated vulnerabilities of the issue. (see Connections)
relativePosition IntRelative position of the issue (used for positioning in epic tree and issue boards).
severity IssuableSeveritySeverity level of the incident.
slaDueAt TimeTimestamp of when the issue SLA expires.
state IssueState!State of the issue.
statusPagePublishedIncident BooleanIndicates whether an issue is published to the status page.
subscribed Boolean!Indicates the currently logged in user is subscribed to the issue.
taskCompletionStatus TaskCompletionStatus!Task completion status of the issue.
timeEstimate Int!Time estimate of the issue.
timelogs TimelogConnection!Timelogs on the issue. (see Connections)
title String!Title of the issue.
titleHtml StringGitLab Flavored Markdown rendering of title.
totalTimeSpent Int!Total time reported as spent on the issue.
type IssueTypeType of the issue.
updatedAt Time!Timestamp of when the issue was last updated.
updatedBy UserCoreUser that last updated the issue.
upvotes Int!Number of upvotes the issue has received.
userDiscussionsCount Int!Number of user discussions in the issue.
userNotesCount Int!Number of user notes of the issue.
userPermissions IssuePermissions!Permissions for the current user on the resource.
webPath String!Web path of the issue.
webUrl String!Web URL of the issue.
weight IntWeight of the issue.

Fields with arguments

Issue.alertManagementAlerts

Alert Management alerts associated to this issue.

Returns AlertManagementAlertConnection.

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

Arguments
NameTypeDescription
assigneeUsername StringUsername of a user assigned to the issue.
domain AlertManagementDomainFilter!Filter query for given domain.
iid StringIID of the alert. For example, “1”.
search StringSearch query for title, description, service, or monitoring_tool.
sort AlertManagementAlertSortSort alerts by this criteria.
statuses [AlertManagementStatus!]Alerts with the specified statues. For example, [TRIGGERED].
Issue.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
state TodoStateEnumState of the to-do items.

Issuable resource links of the incident issue.

Returns IssuableResourceLinkConnection.

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

Arguments
NameTypeDescription
incidentId IssueID!ID of the incident.
Issue.reference

Internal reference of the issue. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
full BooleanBoolean option specifying whether the reference should be returned in full.

IssuePermissions

Check permissions for the current user on a issue.

Fields

NameTypeDescription
adminIssue Boolean!Indicates the user can perform admin_issue on this resource.
createDesign Boolean!Indicates the user can perform create_design on this resource.
createNote Boolean!Indicates the user can perform create_note on this resource.
destroyDesign Boolean!Indicates the user can perform destroy_design on this resource.
readDesign Boolean!Indicates the user can perform read_design on this resource.
readIssue Boolean!Indicates the user can perform read_issue on this resource.
reopenIssue Boolean!Indicates the user can perform reopen_issue on this resource.
updateDesign Boolean!Indicates the user can perform update_design on this resource.
updateIssue Boolean!Indicates the user can perform update_issue on this resource.

IssueStatusCountsType

Represents total number of issues for the represented statuses.

Fields

NameTypeDescription
all IntNumber of issues with status ALL for the project.
closed IntNumber of issues with status CLOSED for the project.
opened IntNumber of issues with status OPENED for the project.

Iteration

Represents an iteration object.

Fields

NameTypeDescription
createdAt Time!Timestamp of iteration creation.
description StringDescription of the iteration.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
dueDate TimeTimestamp of the iteration due date.
id ID!ID of the iteration.
iid ID!Internal ID of the iteration.
iterationCadence IterationCadence!Cadence of the iteration.
scopedPath StringWeb path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.
scopedUrl StringWeb URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.
sequence Int!Sequence number for the iteration when you sort the containing cadence’s iterations by the start and end date. The earliest starting and ending iteration is assigned 1.
startDate TimeTimestamp of the iteration start date.
state IterationState!State of the iteration.
title StringTitle of the iteration.
updatedAt Time!Timestamp of last iteration update.
webPath String!Web path of the iteration.
webUrl String!Web URL of the iteration.

Fields with arguments

Iteration.report

Historically accurate report about the timebox.

Returns TimeboxReport.

Arguments
NameTypeDescription
fullPath StringFull path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

IterationCadence

Represents an iteration cadence.

Fields

NameTypeDescription
active BooleanWhether the iteration cadence is active.
automatic BooleanWhether the iteration cadence should automatically generate upcoming iterations.
description StringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks IntDuration in weeks of the iterations within this cadence.
id IterationsCadenceID!Global ID of the iteration cadence.
iterationsInAdvance IntUpcoming iterations to be created when iteration cadence is set to automatic.
rollOver Boolean!Whether the iteration cadence should roll over issues to the next iteration or not.
startDate TimeTimestamp of the automation start date.
title String!Title of the iteration cadence.

JiraImport

Fields

NameTypeDescription
createdAt TimeTimestamp of when the Jira import was created.
failedToImportCount Int!Count of issues that failed to import.
importedIssuesCount Int!Count of issues that were successfully imported.
jiraProjectKey String!Project key for the imported Jira project.
scheduledAt TimeTimestamp of when the Jira import was scheduled.
scheduledBy UserCoreUser that started the Jira import.
totalIssueCount Int!Total count of issues that were attempted to import.

JiraProject

Fields

NameTypeDescription
key String!Key of the Jira project.
name StringName of the Jira project.
projectId Int!ID of the Jira project.

JiraService

Fields

NameTypeDescription
active BooleanIndicates if the service is active.
serviceType ServiceTypeType of the service.
type StringClass name of the service.

Fields with arguments

JiraService.projects

List of all Jira projects fetched through Jira REST API.

Returns JiraProjectConnection.

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

Arguments
NameTypeDescription
name StringProject name or key.

JiraUser

Fields

NameTypeDescription
gitlabId IntID of the matched GitLab user.
gitlabName StringName of the matched GitLab user.
gitlabUsername StringUsername of the matched GitLab user.
jiraAccountId String!Account ID of the Jira user.
jiraDisplayName String!Display name of the Jira user.
jiraEmail StringEmail of the Jira user, returned only for users with public emails.

JobArtifactRegistry

Represents the Geo replication and verification state of a job_artifact.

Fields

NameTypeDescription
artifactId ID!ID of the Job Artifact.
createdAt TimeTimestamp when the JobArtifactRegistry was created.
id ID!ID of the JobArtifactRegistry.
lastSyncFailure StringError message during sync of the JobArtifactRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the JobArtifactRegistry.
retryAt TimeTimestamp after which the JobArtifactRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the JobArtifactRegistry.
state RegistryStateSync state of the JobArtifactRegistry.
verificationRetryAt TimeTimestamp after which the JobArtifactRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the JobArtifactRegistry.

JobPermissions

Fields

NameTypeDescription
readBuild Boolean!Indicates the user can perform read_build on this resource.
readJobArtifacts Boolean!Indicates the user can perform read_job_artifacts on this resource.
updateBuild Boolean!Indicates the user can perform update_build on this resource.

Kas

Fields

NameTypeDescription
enabled Boolean!Indicates whether the Kubernetes Agent Server is enabled.
externalUrl StringURL used by the Agents to communicate with KAS.
version StringKAS version.

Key

Represents an SSH key.

Fields

NameTypeDescription
createdAt Time!Timestamp of when the key was created.
expiresAt Time!Timestamp of when the key expires. It’s null if it never expires.
id ID!ID of the key.
key String!Public key of the key pair.
title String!Title of the key.

Label

Fields

NameTypeDescription
color String!Background color of the label.
createdAt Time!When this label was created.
description StringDescription of the label (Markdown rendered as HTML for caching).
descriptionHtml StringGitLab Flavored Markdown rendering of description.
id ID!Label ID.
textColor String!Text color of the label.
title String!Content of the label.
updatedAt Time!When this label was last updated.

LfsObjectRegistry

Represents the Geo sync and verification state of an LFS object.

Fields

NameTypeDescription
createdAt TimeTimestamp when the LfsObjectRegistry was created.
id ID!ID of the LfsObjectRegistry.
lastSyncFailure StringError message during sync of the LfsObjectRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the LfsObjectRegistry.
lfsObjectId ID!ID of the LFS object.
retryAt TimeTimestamp after which the LfsObjectRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the LfsObjectRegistry.
state RegistryStateSync state of the LfsObjectRegistry.
verificationRetryAt TimeTimestamp after which the LfsObjectRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the LfsObjectRegistry.

LicenseHistoryEntry

Represents an entry from the Cloud License history.

Fields

NameTypeDescription
activatedAt DateDate when the license was activated.
blockChangesAt DateDate, including grace period, when licensed features will be blocked.
company StringCompany of the licensee.
createdAt DateDate when the license was added.
email StringEmail of the licensee.
expiresAt DateDate when the license expires.
id ID!ID of the license extracted from the license data.
name StringName of the licensee.
plan String!Name of the subscription plan.
startsAt DateDate when the license started.
type String!Type of the license.
usersInLicenseCount IntNumber of paid users in the license.

Location

Fields

NameTypeDescription
blobPath StringHTTP URI path to view the input file in GitLab.
path StringPath, relative to the root of the repository, of the filewhich was analyzed to detect the dependency.

MavenMetadata

Maven metadata.

Fields

NameTypeDescription
appGroup String!App group of the Maven package.
appName String!App name of the Maven package.
appVersion StringApp version of the Maven package.
createdAt Time!Date of creation.
id PackagesMavenMetadatumID!ID of the metadatum.
path String!Path of the Maven package.
updatedAt Time!Date of most recent update.

MergeAccessLevel

Defines which user roles, users, or groups can merge into a protected branch.

Fields

NameTypeDescription
accessLevel Int!GitLab::Access level.
accessLevelDescription String!Human readable representation for this access level.
group AccessLevelGroupGroup associated with this access level.
user AccessLevelUserUser associated with this access level.

MergeRequest

Fields

NameTypeDescription
allowCollaboration BooleanIndicates if members of the target project can push to the fork.
approvalState MergeRequestApprovalState!Information relating to rules that must be satisfied to merge this merge request.
approvalsLeft IntNumber of approvals left.
approvalsRequired IntNumber of approvals required.
approved Boolean!Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured.
approvedBy UserCoreConnectionUsers who approved the merge request. (see Connections)
assignees MergeRequestAssigneeConnectionAssignees of the merge request. (see Connections)
author MergeRequestAuthorUser who created this merge request.
autoMergeEnabled Boolean!Indicates if auto merge is enabled for the merge request.
autoMergeStrategy StringSelected auto merge strategy.
availableAutoMergeStrategies [String!]Array of available auto merge strategies.
awardEmoji AwardEmojiConnectionList of award emojis associated with the merge request. (see Connections)
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
commitCount IntNumber of commits in the merge request.
commits CommitConnectionMerge request commits. (see Connections)
commitsWithoutMergeCommits CommitConnectionMerge request commits excluding merge commits. (see Connections)
committers UserCoreConnectionUsers who have added commits to the merge request. (see Connections)
conflicts Boolean!Indicates if the merge request has conflicts.
createdAt Time!Timestamp of when the merge request was created.
defaultMergeCommitMessage StringDefault merge commit message of the merge request.
defaultSquashCommitMessage StringDefault squash commit message of the merge request.
description StringDescription of the merge request (Markdown rendered as HTML for caching).
descriptionHtml StringGitLab Flavored Markdown rendering of description.
detailedMergeStatus DetailedMergeStatusDetailed merge status of the merge request.
diffHeadSha StringDiff head SHA of the merge request.
diffLlmSummaries MergeRequestDiffLlmSummaryConnection Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Diff summaries generated by AI.
diffRefs DiffRefsReferences of the base SHA, the head SHA, and the start SHA for this merge request.
diffStatsSummary DiffStatsSummarySummary of which files were changed in this merge request.
discussionLocked Boolean!Indicates if comments on the merge request are locked to members only.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
divergedFromTargetBranch Boolean!Indicates if the source branch is behind the target branch.
downvotes Int!Number of downvotes for the merge request.
draft Boolean!Indicates if the merge request is a draft.
forceRemoveSourceBranch BooleanIndicates if the project settings will lead to source branch deletion after merge.
hasCi Boolean!Indicates if the merge request has CI.
hasSecurityReports Boolean!Indicates if the source branch has any security reports.
headPipeline PipelinePipeline running on the branch HEAD of the merge request.
humanTimeEstimate StringHuman-readable time estimate of the merge request.
humanTotalTimeSpent StringHuman-readable total time reported as spent on the merge request.
id ID!ID of the merge request.
iid String!Internal ID of the merge request.
inProgressMergeCommitSha StringCommit SHA of the merge request if merge is in progress.
labels LabelConnectionLabels of the merge request. (see Connections)
mergeCommitSha StringSHA of the merge request commit (set once merged).
mergeError StringError message due to a merge error.
mergeOngoing Boolean!Indicates if a merge is currently occurring.
mergeRequestDiffs MergeRequestDiffConnection Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Diff versions of a merge request.
mergeStatus String Deprecated in 14.0. This was renamed. Use: MergeRequest.mergeStatusEnum.
mergeStatusEnum MergeStatusMerge status of the merge request.
mergeTrainsCount IntNumber of merge requests in the merge train.
mergeUser UserCoreUser who merged this merge request or set it to auto-merge.
mergeWhenPipelineSucceeds BooleanIndicates if the merge has been set to auto-merge.
mergeable Boolean!Indicates if the merge request is mergeable.
mergeableDiscussionsState BooleanIndicates if all discussions in the merge request have been resolved, allowing the merge request to be merged.
mergedAt TimeTimestamp of when the merge request was merged, null if not merged.
milestone MilestoneMilestone of the merge request.
notes NoteConnection!All notes on this noteable. (see Connections)
participants MergeRequestParticipantConnectionParticipants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. (see Connections)
preparedAt TimeTimestamp of when the merge request was prepared.
project Project!Alias for target_project.
projectId Int!ID of the merge request project.
rebaseCommitSha StringRebase commit SHA of the merge request.
rebaseInProgress Boolean!Indicates if there is a rebase currently in progress for the merge request.
reviewers MergeRequestReviewerConnectionUsers from whom a review has been requested. (see Connections)
securityAutoFix BooleanIndicates if the merge request is created by @GitLab-Security-Bot.
securityReportsUpToDateOnTargetBranch Boolean!Indicates if the target branch security reports are out of date.
shouldBeRebased Boolean!Indicates if the merge request will be rebased.
shouldRemoveSourceBranch BooleanIndicates if the source branch of the merge request will be deleted after merge.
sourceBranch String!Source branch of the merge request.
sourceBranchExists Boolean!Indicates if the source branch of the merge request exists.
sourceBranchProtected Boolean!Indicates if the source branch is protected.
sourceProject ProjectSource project of the merge request.
sourceProjectId IntID of the merge request source project.
squash Boolean!Indicates if the merge request is set to be squashed when merged. Project settings may override this value. Use squash_on_merge instead to take project squash options into account.
squashOnMerge Boolean!Indicates if the merge request will be squashed when merged.
state MergeRequestState!State of the merge request.
subscribed Boolean!Indicates if the currently logged in user is subscribed to this merge request.
suggestedReviewers SuggestedReviewersType Introduced in 15.4. This feature is an Experiment. It can be changed or removed at any time. Suggested reviewers for merge request. Returns null if suggested_reviewers feature flag is disabled. This flag is disabled by default and only available on GitLab.com because the feature is experimental and is subject to change without notice.
targetBranch String!Target branch of the merge request.
targetBranchExists Boolean!Indicates if the target branch of the merge request exists.
targetProject Project!Target project of the merge request.
targetProjectId Int!ID of the merge request target project.
taskCompletionStatus TaskCompletionStatus!Completion status of tasks.
timeEstimate Int!Time estimate of the merge request.
timelogs TimelogConnection!Timelogs on the merge request. (see Connections)
title String!Title of the merge request.
titleHtml StringGitLab Flavored Markdown rendering of title.
totalTimeSpent Int!Total time reported as spent on the merge request.
updatedAt Time!Timestamp of when the merge request was last updated.
upvotes Int!Number of upvotes for the merge request.
userDiscussionsCount IntNumber of user discussions in the merge request.
userNotesCount IntUser notes count of the merge request.
userPermissions MergeRequestPermissions!Permissions for the current user on the resource.
webUrl StringWeb URL of the merge request.

Fields with arguments

MergeRequest.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
state TodoStateEnumState of the to-do items.
MergeRequest.diffStats

Details about which files were changed in this merge request.

Returns [DiffStats!].

Arguments
NameTypeDescription
path StringSpecific file path.
MergeRequest.findingReportsComparer

Vulnerability finding reports comparison reported on the merge request.

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

Returns FindingReportsComparer.

Arguments
NameTypeDescription
reportType ComparableSecurityReportType!Filter vulnerability findings by report type.
MergeRequest.pipelines

Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned.

Returns PipelineConnection.

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

Arguments
NameTypeDescription
ref StringFilter pipelines by the ref they are run for.
scope PipelineScopeEnumFilter pipelines by scope.
sha StringFilter pipelines by the sha of the commit they are run for.
source StringFilter pipelines by their source.
status PipelineStatusEnumFilter pipelines by their status.
updatedAfter TimePipelines updated after this date.
updatedBefore TimePipelines updated before this date.
username StringFilter pipelines by the user that triggered the pipeline.
MergeRequest.reference

Internal reference of the merge request. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
full BooleanBoolean option specifying whether the reference should be returned in full.

MergeRequestApprovalState

Information relating to rules that must be satisfied to merge this merge request.

Fields

NameTypeDescription
approvalRulesOverwritten BooleanIndicates if the merge request approval rules are overwritten for the merge request.
invalidApproversRules [ApprovalRule!]List of approval rules that are associated with the merge request, but invalid.
rules [ApprovalRule!]List of approval rules associated with the merge request.
suggestedApprovers UserCoreConnectionList of suggested approvers. (see Connections)

MergeRequestAssignee

A user assigned to a merge request.

Fields

NameTypeDescription
avatarUrl StringURL of the user’s avatar.
bio StringBio of the user.
bot Boolean!Indicates if the user is a bot.
callouts UserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmail StringUser’s default commit email.
createdAt TimeTimestamp of when the user was created.
discord StringDiscord ID of the user.
email String Deprecated in 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnectionUser’s email addresses. (see Connections)
gitpodEnabled BooleanWhether Gitpod is enabled at the user level.
groupCount IntGroup count for the user.
groupMemberships GroupMemberConnectionGroup memberships of the user. (see Connections)
id ID!ID of the user.
ide IdeIDE settings.
jobTitle StringJob title of the user.
linkedin StringLinkedIn profile name of the user.
location StringLocation of the user.
mergeRequestInteraction UserMergeRequestInteractionDetails of this user’s interactions with the merge request.
name String!Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace NamespacePersonal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organization StringWho the user represents or works for.
preferencesGitpodPath StringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPath StringWeb path to enable Gitpod for the user.
projectMemberships ProjectMemberConnectionProject memberships of the user. (see Connections)
pronouns StringPronouns of the user.
publicEmail StringUser’s public email.
savedReplies SavedReplyConnectionSaved replies authored by the user. Will not return saved replies if saved_replies feature flag is disabled. (see Connections)
state UserState!State of the user.
status UserStatusUser status.
twitter StringTwitter username of the user.
userAchievements UserAchievementConnection Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
userPermissions UserPermissions!Permissions for the current user on the resource.
username String!Username of the user. Unique within this instance of GitLab.
webPath String!Web path of the user.
webUrl String!Web URL of the user.

Fields with arguments

MergeRequestAssignee.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestAssignee.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestAssignee.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScope GroupPermissionFilter by permissions the user has on groups.
search StringSearch by group name or path.
MergeRequestAssignee.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestAssignee.savedReply

Saved reply authored by the user. Will not return saved reply if saved_replies feature flag is disabled.

Returns SavedReply.

Arguments
NameTypeDescription
id UsersSavedReplyID!ID of a saved reply.
MergeRequestAssignee.snippets

Snippets authored by the 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
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnumType of snippet.
visibility VisibilityScopesEnumVisibility of the snippet.
MergeRequestAssignee.starredProjects

Projects starred by the 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
search StringSearch query.
MergeRequestAssignee.timelogs

Time logged by the 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.
MergeRequestAssignee.todos

To-do items of the user.

Returns TodoConnection.

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

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.
state [TodoStateEnum!]State of the todo.
type [TodoTargetEnum!]Type of the todo.
MergeRequestAssignee.workspaces

Workspaces owned by the current user.

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.

MergeRequestAuthor

The author of the merge request.

Fields

NameTypeDescription
avatarUrl StringURL of the user’s avatar.
bio StringBio of the user.
bot Boolean!Indicates if the user is a bot.
callouts UserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmail StringUser’s default commit email.
createdAt TimeTimestamp of when the user was created.
discord StringDiscord ID of the user.
email String Deprecated in 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnectionUser’s email addresses. (see Connections)
gitpodEnabled BooleanWhether Gitpod is enabled at the user level.
groupCount IntGroup count for the user.
groupMemberships GroupMemberConnectionGroup memberships of the user. (see Connections)
id ID!ID of the user.
ide IdeIDE settings.
jobTitle StringJob title of the user.
linkedin StringLinkedIn profile name of the user.
location StringLocation of the user.
mergeRequestInteraction UserMergeRequestInteractionDetails of this user’s interactions with the merge request.
name String!Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace NamespacePersonal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organization StringWho the user represents or works for.
preferencesGitpodPath StringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPath StringWeb path to enable Gitpod for the user.
projectMemberships ProjectMemberConnectionProject memberships of the user. (see Connections)
pronouns StringPronouns of the user.
publicEmail StringUser’s public email.
savedReplies SavedReplyConnectionSaved replies authored by the user. Will not return saved replies if saved_replies feature flag is disabled. (see Connections)
state UserState!State of the user.
status UserStatusUser status.
twitter StringTwitter username of the user.
userAchievements UserAchievementConnection Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
userPermissions UserPermissions!Permissions for the current user on the resource.
username String!Username of the user. Unique within this instance of GitLab.
webPath String!Web path of the user.
webUrl String!Web URL of the user.

Fields with arguments

MergeRequestAuthor.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestAuthor.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestAuthor.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScope GroupPermissionFilter by permissions the user has on groups.
search StringSearch by group name or path.
MergeRequestAuthor.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestAuthor.savedReply

Saved reply authored by the user. Will not return saved reply if saved_replies feature flag is disabled.

Returns SavedReply.

Arguments
NameTypeDescription
id UsersSavedReplyID!ID of a saved reply.
MergeRequestAuthor.snippets

Snippets authored by the 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
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnumType of snippet.
visibility VisibilityScopesEnumVisibility of the snippet.
MergeRequestAuthor.starredProjects

Projects starred by the 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
search StringSearch query.
MergeRequestAuthor.timelogs

Time logged by the 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.
MergeRequestAuthor.todos

To-do items of the user.

Returns TodoConnection.

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

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.
state [TodoStateEnum!]State of the todo.
type [TodoTargetEnum!]Type of the todo.
MergeRequestAuthor.workspaces

Workspaces owned by the current user.

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.

MergeRequestDiff

A diff version of a merge request.

Fields

NameTypeDescription
createdAt Time!Timestamp of when the diff was created.
diffLlmSummary MergeRequestDiffLlmSummaryDiff summary generated by AI.
reviewLlmSummaries MergeRequestReviewLlmSummaryConnectionReview summaries generated by AI. (see Connections)
updatedAt Time!Timestamp of when the diff was updated.

MergeRequestDiffLlmSummary

A diff summary generated by AI.

Fields

NameTypeDescription
content String!Content of the diff summary.
createdAt Time!Timestamp of when the diff summary was created.
mergeRequestDiffId ID!ID of the Merge Request diff associated with the diff summary.
provider String!AI provider that generated the summary.
updatedAt Time!Timestamp of when the diff summary was updated.
user UserCoreUser associated with the diff summary.

MergeRequestDiffRegistry

Represents the Geo sync and verification state of a Merge Request diff.

Fields

NameTypeDescription
createdAt TimeTimestamp when the MergeRequestDiffRegistry was created.
id ID!ID of the MergeRequestDiffRegistry.
lastSyncFailure StringError message during sync of the MergeRequestDiffRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the MergeRequestDiffRegistry.
mergeRequestDiffId ID!ID of the Merge Request diff.
retryAt TimeTimestamp after which the MergeRequestDiffRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the MergeRequestDiffRegistry.
state RegistryStateSync state of the MergeRequestDiffRegistry.
verificationRetryAt TimeTimestamp after which the MergeRequestDiffRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the MergeRequestDiffRegistry.

MergeRequestParticipant

A user participating in a merge request.

Fields

NameTypeDescription
avatarUrl StringURL of the user’s avatar.
bio StringBio of the user.
bot Boolean!Indicates if the user is a bot.
callouts UserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmail StringUser’s default commit email.
createdAt TimeTimestamp of when the user was created.
discord StringDiscord ID of the user.
email String Deprecated in 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnectionUser’s email addresses. (see Connections)
gitpodEnabled BooleanWhether Gitpod is enabled at the user level.
groupCount IntGroup count for the user.
groupMemberships GroupMemberConnectionGroup memberships of the user. (see Connections)
id ID!ID of the user.
ide IdeIDE settings.
jobTitle StringJob title of the user.
linkedin StringLinkedIn profile name of the user.
location StringLocation of the user.
mergeRequestInteraction UserMergeRequestInteractionDetails of this user’s interactions with the merge request.
name String!Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace NamespacePersonal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organization StringWho the user represents or works for.
preferencesGitpodPath StringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPath StringWeb path to enable Gitpod for the user.
projectMemberships ProjectMemberConnectionProject memberships of the user. (see Connections)
pronouns StringPronouns of the user.
publicEmail StringUser’s public email.
savedReplies SavedReplyConnectionSaved replies authored by the user. Will not return saved replies if saved_replies feature flag is disabled. (see Connections)
state UserState!State of the user.
status UserStatusUser status.
twitter StringTwitter username of the user.
userAchievements UserAchievementConnection Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
userPermissions UserPermissions!Permissions for the current user on the resource.
username String!Username of the user. Unique within this instance of GitLab.
webPath String!Web path of the user.
webUrl String!Web URL of the user.

Fields with arguments

MergeRequestParticipant.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestParticipant.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestParticipant.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScope GroupPermissionFilter by permissions the user has on groups.
search StringSearch by group name or path.
MergeRequestParticipant.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestParticipant.savedReply

Saved reply authored by the user. Will not return saved reply if saved_replies feature flag is disabled.

Returns SavedReply.

Arguments
NameTypeDescription
id UsersSavedReplyID!ID of a saved reply.
MergeRequestParticipant.snippets

Snippets authored by the 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
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnumType of snippet.
visibility VisibilityScopesEnumVisibility of the snippet.
MergeRequestParticipant.starredProjects

Projects starred by the 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
search StringSearch query.
MergeRequestParticipant.timelogs

Time logged by the 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.
MergeRequestParticipant.todos

To-do items of the user.

Returns TodoConnection.

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

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.
state [TodoStateEnum!]State of the todo.
type [TodoTargetEnum!]Type of the todo.
MergeRequestParticipant.workspaces

Workspaces owned by the current user.

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.

MergeRequestPermissions

Check permissions for the current user on a merge request.

Fields

NameTypeDescription
adminMergeRequest Boolean!Indicates the user can perform admin_merge_request on this resource.
canApprove Boolean!Indicates the user can perform can_approve on this resource.
canMerge Boolean!Indicates the user can perform can_merge on this resource.
cherryPickOnCurrentMergeRequest Boolean!Indicates the user can perform cherry_pick_on_current_merge_request on this resource.
createNote Boolean!Indicates the user can perform create_note on this resource.
pushToSourceBranch Boolean!Indicates the user can perform push_to_source_branch on this resource.
readMergeRequest Boolean!Indicates the user can perform read_merge_request on this resource.
removeSourceBranch Boolean!Indicates the user can perform remove_source_branch on this resource.
revertOnCurrentMergeRequest Boolean!Indicates the user can perform revert_on_current_merge_request on this resource.
updateMergeRequest Boolean!Indicates the user can perform update_merge_request on this resource.

MergeRequestReviewLlmSummary

A review summary generated by AI.

Fields

NameTypeDescription
content String!Content of the review summary.
createdAt Time!Timestamp of when the review summary was created.
mergeRequestDiffId ID!ID of the Merge Request diff associated with the review summary.
provider String!AI provider that generated the summary.
reviewer UserCoreUser who authored the review associated with the review summary.
updatedAt Time!Timestamp of when the review summary was updated.
user UserCoreUser associated with the review summary.

MergeRequestReviewer

A user assigned to a merge request as a reviewer.

Fields

NameTypeDescription
avatarUrl StringURL of the user’s avatar.
bio StringBio of the user.
bot Boolean!Indicates if the user is a bot.
callouts UserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmail StringUser’s default commit email.
createdAt TimeTimestamp of when the user was created.
discord StringDiscord ID of the user.
email String Deprecated in 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnectionUser’s email addresses. (see Connections)
gitpodEnabled BooleanWhether Gitpod is enabled at the user level.
groupCount IntGroup count for the user.
groupMemberships GroupMemberConnectionGroup memberships of the user. (see Connections)
id ID!ID of the user.
ide IdeIDE settings.
jobTitle StringJob title of the user.
linkedin StringLinkedIn profile name of the user.
location StringLocation of the user.
mergeRequestInteraction UserMergeRequestInteractionDetails of this user’s interactions with the merge request.
name String!Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace NamespacePersonal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organization StringWho the user represents or works for.
preferencesGitpodPath StringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPath StringWeb path to enable Gitpod for the user.
projectMemberships ProjectMemberConnectionProject memberships of the user. (see Connections)
pronouns StringPronouns of the user.
publicEmail StringUser’s public email.
savedReplies SavedReplyConnectionSaved replies authored by the user. Will not return saved replies if saved_replies feature flag is disabled. (see Connections)
state UserState!State of the user.
status UserStatusUser status.
twitter StringTwitter username of the user.
userAchievements UserAchievementConnection Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
userPermissions UserPermissions!Permissions for the current user on the resource.
username String!Username of the user. Unique within this instance of GitLab.
webPath String!Web path of the user.
webUrl String!Web URL of the user.

Fields with arguments

MergeRequestReviewer.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestReviewer.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestReviewer.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScope GroupPermissionFilter by permissions the user has on groups.
search StringSearch by group name or path.
MergeRequestReviewer.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
MergeRequestReviewer.savedReply

Saved reply authored by the user. Will not return saved reply if saved_replies feature flag is disabled.

Returns SavedReply.

Arguments
NameTypeDescription
id UsersSavedReplyID!ID of a saved reply.
MergeRequestReviewer.snippets

Snippets authored by the 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
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnumType of snippet.
visibility VisibilityScopesEnumVisibility of the snippet.
MergeRequestReviewer.starredProjects

Projects starred by the 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
search StringSearch query.
MergeRequestReviewer.timelogs

Time logged by the 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.
MergeRequestReviewer.todos

To-do items of the user.

Returns TodoConnection.

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

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.
state [TodoStateEnum!]State of the todo.
type [TodoTargetEnum!]Type of the todo.
MergeRequestReviewer.workspaces

Workspaces owned by the current user.

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.

Metadata

Fields

NameTypeDescription
enterprise Boolean!Enterprise edition.
kas Kas!Metadata about KAS.
revision String!Revision.
version String!Version.

MetricImage

Represents a metric image upload.

Fields

NameTypeDescription
fileName StringFile name of the metric image.
filePath StringFile path of the metric image.
id ID!ID of the metric upload.
iid ID!Internal ID of the metric upload.
url String!URL of the metric source.

MetricsDashboardAnnotation

Fields

NameTypeDescription
description StringDescription of the annotation.
endingAt TimeTimestamp marking end of annotated time span.
id ID!ID of the annotation.
panelId StringID of a dashboard panel to which the annotation should be scoped.
startingAt TimeTimestamp marking start of annotated time span.

Milestone

Represents a milestone.

Fields

NameTypeDescription
createdAt Time!Timestamp of milestone creation.
description StringDescription of the milestone.
dueDate TimeTimestamp of the milestone due date.
expired Boolean!Expired state of the milestone (a milestone is expired when the due date is past the current date). Defaults to false when due date has not been set.
groupMilestone Boolean!Indicates if milestone is at group level.
id ID!ID of the milestone.
iid ID!Internal ID of the milestone.
projectMilestone Boolean!Indicates if milestone is at project level.
releases ReleaseConnectionReleases associated with this milestone. (see Connections)
startDate TimeTimestamp of the milestone start date.
state MilestoneStateEnum!State of the milestone.
stats MilestoneStatsMilestone statistics.
subgroupMilestone Boolean!Indicates if milestone is at subgroup level.
title String!Title of the milestone.
updatedAt Time!Timestamp of last milestone update.
webPath String!Web path of the milestone.

Fields with arguments

Milestone.report

Historically accurate report about the timebox.

Returns TimeboxReport.

Arguments
NameTypeDescription
fullPath StringFull path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

MilestoneStats

Contains statistics about a milestone.

Fields

NameTypeDescription
closedIssuesCount IntNumber of closed issues associated with the milestone.
totalIssuesCount IntTotal number of issues associated with the milestone.

Namespace

Fields

NameTypeDescription
actualRepositorySizeLimit FloatSize limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement.
actualSizeLimit FloatActual storage size limit for the namespace in bytes. This limit is agnostic of enforcement type.
additionalPurchasedStorageSize FloatAdditional storage purchased for the root namespace in bytes.
containsLockedProjects Boolean!Includes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
crossProjectPipelineAvailable Boolean!Indicates if the cross_project_pipeline feature is available for the namespace.
description StringDescription of the namespace.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
fullName String!Full name of the namespace.
fullPath ID!Full path of the namespace.
id ID!ID of the namespace.
isTemporaryStorageIncreaseEnabled Boolean!Status of the temporary storage increase.
lfsEnabled BooleanIndicates if Large File Storage (LFS) is enabled for namespace.
name String!Name of the namespace.
packageSettings PackageSettingsPackage settings for the namespace.
path String!Path of the namespace.
repositorySizeExcessProjectCount Int!Number of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
requestAccessEnabled BooleanIndicates if users can request access to namespace.
rootStorageStatistics RootStorageStatisticsAggregated storage statistics of the namespace. Only available for root namespaces.
sharedRunnersSetting SharedRunnersSettingShared runners availability for the namespace and its descendants.
storageSizeLimit FloatStorage limit included in the root namespace plan in bytes. This limit only applies to namespaces under Namespace limit enforcement.
temporaryStorageIncreaseEndsOn TimeDate until the temporary storage increase is active.
timelogCategories TimeTrackingTimelogCategoryConnection Introduced in 15.3. This feature is an Experiment. It can be changed or removed at any time. Timelog categories for the namespace.
totalRepositorySize FloatTotal repository size of all projects in the root namespace in bytes.
totalRepositorySizeExcess FloatTotal excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement.
visibility StringVisibility of the namespace.

Fields with arguments

Namespace.achievements

Achievements for the namespace. Returns null if the achievements feature flag is disabled.

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

Returns AchievementConnection.

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

Arguments
NameTypeDescription
ids [AchievementsAchievementID!]Filter achievements by IDs.
Namespace.addOnPurchase

AddOnPurchase associated with the namespace.

Returns AddOnPurchase.

Arguments
NameTypeDescription
addOnName String!AddOn name.
Namespace.complianceFrameworks

Compliance frameworks available to projects in this namespace.

Returns ComplianceFrameworkConnection.

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

Arguments
NameTypeDescription
id ComplianceManagementFrameworkIDGlobal ID of a specific compliance framework to return.
Namespace.projects

Projects within this namespace.

Returns ProjectConnection!.

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

Arguments
NameTypeDescription
complianceFrameworkFilters ComplianceFrameworkFiltersFilters applied when selecting a compliance framework.
hasCodeCoverage BooleanReturns only the projects which have code coverage.
hasVulnerabilities BooleanReturns only the projects which have vulnerabilities.
ids [ID!]Filter projects by IDs.
includeSubgroups BooleanInclude also subgroup projects.
notAimedForDeletion BooleanInclude projects that are not aimed for deletion.
sbomComponentId IDReturn only the projects related to the specified SBOM component.
search StringSearch project with most similar names or paths.
sort NamespaceProjectSortSort projects by this criteria.
withIssuesEnabled BooleanReturn only projects with issues enabled.
withMergeRequestsEnabled BooleanReturn only projects with merge requests enabled.
Namespace.scanExecutionPolicies

Scan Execution Policies of the namespace.

Returns ScanExecutionPolicyConnection.

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

Arguments
NameTypeDescription
actionScanTypes [SecurityReportTypeEnum!]Filters policies by the action scan type. Only these scan types are supported: dast, secret_detection, cluster_image_scanning, container_scanning, sast, sast_iac, dependency_scanning.
relationship SecurityPolicyRelationTypeFilter policies by the given policy relationship.
Namespace.scanResultPolicies

Scan Result Policies of the project.

Returns ScanResultPolicyConnection.

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

Arguments
NameTypeDescription
relationship SecurityPolicyRelationTypeFilter policies by the given policy relationship.

NamespaceBan

Fields

NameTypeDescription
id GlobalID!Global ID of the namespace ban.
namespace Namespace!Root namespace to which the ban applies.
user UserCore!User to which the namespace ban applies.

NamespaceCiCdSetting

Fields

NameTypeDescription
allowStaleRunnerPruning BooleanIndicates if stale runners directly belonging to this namespace should be periodically pruned.
namespace NamespaceNamespace the CI/CD settings belong to.

NamespaceCommitEmail

Fields

NameTypeDescription
createdAt Time!Timestamp the namespace commit email was created.
email Email!Email.
id ID!Internal ID of the namespace commit email.
namespace Namespace!Namespace.
updatedAt Time!Timestamp the namespace commit email was last updated.

NestedEnvironment

Describes where code is deployed for a project organized by folder.

Fields

NameTypeDescription
environment EnvironmentLatest environment in the folder.
name String!Human-readable name of the environment.
size Int!Number of environments nested in the folder.

NetworkPolicy

Represents the network policy.

Fields

NameTypeDescription
enabled Boolean!Indicates whether this policy is enabled.
environments EnvironmentConnectionEnvironments where this policy is applied. (see Connections)
fromAutoDevops Boolean!Indicates whether this policy is created from AutoDevops.
kind NetworkPolicyKind!Kind of the policy.
name String!Name of the policy.
namespace String!Namespace of the policy.
updatedAt Time!Timestamp of when the policy YAML was last updated.
yaml String!YAML definition of the policy.

Note

Fields

NameTypeDescription
author UserCore!User who wrote this note.
authorIsContributor BooleanIndicates whether the note author is a contributor.
awardEmoji AwardEmojiConnectionList of award emojis associated with the note. (see Connections)
body String!Content of the note.
bodyHtml StringGitLab Flavored Markdown rendering of note.
confidential Boolean Deprecated in 15.5. This was renamed. Use: internal.
createdAt Time!Timestamp of the note creation.
discussion DiscussionDiscussion this note is a part of.
id NoteID!ID of the note.
internal BooleanIndicates if this note is internal.
lastEditedAt TimeTimestamp when note was last edited.
lastEditedBy UserCoreUser who last edited the note.
maxAccessLevelOfAuthor StringMax access level of the note author in the project.
position DiffPositionPosition of this note on a diff.
project ProjectProject associated with the note.
resolvable Boolean!Indicates if the object can be resolved.
resolved Boolean!Indicates if the object is resolved.
resolvedAt TimeTimestamp of when the object was resolved.
resolvedBy UserCoreUser who resolved the object.
system Boolean!Indicates whether this note was created by the system or by a user.
systemNoteIconName StringName of the icon corresponding to a system note.
systemNoteMetadata SystemNoteMetadataMetadata for the given note if it is a system note.
updatedAt Time!Timestamp of the note’s last activity.
url StringURL to view this Note in the Web UI.
userPermissions NotePermissions!Permissions for the current user on the resource.

NotePermissions

Fields

NameTypeDescription
adminNote Boolean!Indicates the user can perform admin_note on this resource.
awardEmoji Boolean!Indicates the user can perform award_emoji on this resource.
createNote Boolean!Indicates the user can perform create_note on this resource.
readNote Boolean!Indicates the user can perform read_note on this resource.
repositionNote Boolean!Indicates the user can perform reposition_note on this resource.
resolveNote Boolean!Indicates the user can perform resolve_note on this resource.

NugetDependencyLinkMetadata

Nuget dependency link metadata.

Fields

NameTypeDescription
id PackagesNugetDependencyLinkMetadatumID!ID of the metadatum.
targetFramework String!Target framework of the dependency link package.

NugetMetadata

Nuget metadata.

Fields

NameTypeDescription
iconUrl StringIcon URL of the Nuget package.
id PackagesNugetMetadatumID!ID of the metadatum.
licenseUrl StringLicense URL of the Nuget package.
projectUrl StringProject URL of the Nuget package.

OncallParticipantType

The rotation participant and color palette.

Fields

NameTypeDescription
colorPalette StringColor palette to assign to the on-call user. For example “blue”.
colorWeight StringColor weight to assign to for the on-call user, for example “500”. Max 4 chars. For easy identification of the user.
id IncidentManagementOncallParticipantID!ID of the on-call participant.
user UserCore!User who is participating.

OncallRotationActivePeriodType

Active period time range for on-call rotation.

Fields

NameTypeDescription
endTime StringEnd of the rotation active period.
startTime StringStart of the rotation active period.

OrganizationStateCounts

Represents the total number of organizations for the represented states.

Fields

NameTypeDescription
active IntNumber of organizations with state ACTIVE.
all IntNumber of organizations with state ALL.
inactive IntNumber of organizations with state INACTIVE.

Package

Represents a package with pipelines in the Package Registry.

Fields

NameTypeDescription
_links PackageLinks!Map of links to perform actions on the package.
canDestroy Boolean!Whether the user can destroy the package.
createdAt Time!Date of creation.
id PackagesPackageID!ID of the package.
metadata PackageMetadataPackage metadata.
name String!Name of the package.
packageType PackageTypeEnum!Package type.
pipelines PipelineConnectionPipelines that built the package. Max page size 20. (see Connections)
project Project!Project where the package is stored.
status PackageStatus!Package status.
tags PackageTagConnectionPackage tags. (see Connections)
updatedAt Time!Date of most recent update.
version StringVersion string.

PackageBase

Represents a package in the Package Registry.

Fields

NameTypeDescription
_links PackageLinks!Map of links to perform actions on the package.
canDestroy Boolean!Whether the user can destroy the package.
createdAt Time!Date of creation.
id PackagesPackageID!ID of the package.
metadata PackageMetadataPackage metadata.
name String!Name of the package.
packageType PackageTypeEnum!Package type.
project Project!Project where the package is stored.
status PackageStatus!Package status.
tags PackageTagConnectionPackage tags. (see Connections)
updatedAt Time!Date of most recent update.
version StringVersion string.

PackageComposerJsonType

Represents a composer JSON file.

Fields

NameTypeDescription
license StringLicense set in the Composer JSON file.
name StringName set in the Composer JSON file.
type StringType set in the Composer JSON file.
version StringVersion set in the Composer JSON file.

PackageDependency

Represents a package dependency.

Fields

NameTypeDescription
id PackagesDependencyID!ID of the dependency.
name String!Name of the dependency.
versionPattern String!Version pattern of the dependency.

Represents a package dependency link.

Fields

NameTypeDescription
dependency PackageDependencyDependency.
dependencyType PackageDependencyType!Dependency type.
id PackagesDependencyLinkID!ID of the dependency link.
metadata DependencyLinkMetadataDependency link metadata.

PackageDetailsType

Represents a package details in the Package Registry.

Fields

NameTypeDescription
_links PackageLinks!Map of links to perform actions on the package.
canDestroy Boolean!Whether the user can destroy the package.
composerConfigRepositoryUrl StringUrl of the Composer setup endpoint.
composerUrl StringUrl of the Composer endpoint.
conanUrl StringUrl of the Conan project endpoint.
createdAt Time!Date of creation.
dependencyLinks PackageDependencyLinkConnectionDependency link. (see Connections)
id PackagesPackageID!ID of the package.
lastDownloadedAt TimeLast time that a file of this package was downloaded.
mavenUrl StringUrl of the Maven project endpoint.
metadata PackageMetadataPackage metadata.
name String!Name of the package.
npmUrl StringUrl of the NPM project endpoint.
nugetUrl StringUrl of the Nuget project endpoint.
packageFiles PackageFileConnectionPackage files. (see Connections)
packageType PackageTypeEnum!Package type.
pipelines PipelineConnectionPipelines that built the package. Max page size 20. (see Connections)
project Project!Project where the package is stored.
publicPackage BooleanIndicates if there is public access to the package.
pypiSetupUrl StringUrl of the PyPi project setup endpoint.
pypiUrl StringUrl of the PyPi project endpoint.
status PackageStatus!Package status.
tags PackageTagConnectionPackage tags. (see Connections)
updatedAt Time!Date of most recent update.
version StringVersion string.
versions PackageBaseConnectionOther versions of the package. (see Connections)

PackageFile

Represents a package file.

Fields

NameTypeDescription
createdAt Time!Created date.
downloadPath String!Download path of the package file.
fileMd5 StringMd5 of the package file.
fileMetadata PackageFileMetadataFile metadata.
fileName String!Name of the package file.
fileSha1 StringSha1 of the package file.
fileSha256 StringSha256 of the package file.
id PackagesPackageFileID!ID of the file.
size String!Size of the package file.
updatedAt Time!Updated date.

PackageFileRegistry

Represents the Geo sync and verification state of a package file.

Fields

NameTypeDescription
createdAt TimeTimestamp when the PackageFileRegistry was created.
id ID!ID of the PackageFileRegistry.
lastSyncFailure StringError message during sync of the PackageFileRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the PackageFileRegistry.
packageFileId ID!ID of the PackageFile.
retryAt TimeTimestamp after which the PackageFileRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the PackageFileRegistry.
state RegistryStateSync state of the PackageFileRegistry.
verificationRetryAt TimeTimestamp after which the PackageFileRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the PackageFileRegistry.

PackageHelmDependencyType

Represents a Helm dependency.

Fields

NameTypeDescription
alias StringAlias of the dependency.
condition StringCondition of the dependency.
enabled BooleanIndicates the dependency is enabled.
importValues [JSON!]Import-values of the dependency.
name StringName of the dependency.
repository StringRepository of the dependency.
tags [String!]Tags of the dependency.
version StringVersion of the dependency.

PackageHelmMaintainerType

Represents a Helm maintainer.

Fields

NameTypeDescription
email StringEmail of the maintainer.
name StringName of the maintainer.
url StringURL of the maintainer.

PackageHelmMetadataType

Represents the contents of a Helm Chart.yml file.

Fields

NameTypeDescription
annotations JSONAnnotations for the chart.
apiVersion String!API version of the chart.
appVersion StringApp version of the chart.
condition StringCondition for the chart.
dependencies [PackageHelmDependencyType!]Dependencies of the chart.
deprecated BooleanIndicates if the chart is deprecated.
description StringDescription of the chart.
home StringURL of the home page.
icon StringURL to an SVG or PNG image for the chart.
keywords [String!]Keywords for the chart.
kubeVersion StringKubernetes versions for the chart.
maintainers [PackageHelmMaintainerType!]Maintainers of the chart.
name String!Name of the chart.
sources [String!]URLs of the source code for the chart.
tags StringTags for the chart.
type StringType of the chart.
version String!Version of the chart.

Represents links to perform actions on the package.

Fields

NameTypeDescription
webPath StringPath to the package details page.

PackageSettings

Namespace-level Package Registry settings.

Fields

NameTypeDescription
genericDuplicateExceptionRegex UntrustedRegexpWhen generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
genericDuplicatesAllowed Boolean!Indicates whether duplicate generic packages are allowed for this namespace.
lockMavenPackageRequestsForwarding Boolean!Indicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwarding Boolean!Indicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwarding Boolean!Indicates whether PyPI package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegex UntrustedRegexpWhen maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
mavenDuplicatesAllowed Boolean!Indicates whether duplicate Maven packages are allowed for this namespace.
mavenPackageRequestsForwarding BooleanIndicates whether Maven package forwarding is allowed for this namespace.
mavenPackageRequestsForwardingLocked Boolean!Indicates whether Maven package forwarding settings are locked by a parent namespace.
npmPackageRequestsForwarding BooleanIndicates whether npm package forwarding is allowed for this namespace.
npmPackageRequestsForwardingLocked Boolean!Indicates whether npm package forwarding settings are locked by a parent namespace.
pypiPackageRequestsForwarding BooleanIndicates whether PyPI package forwarding is allowed for this namespace.
pypiPackageRequestsForwardingLocked Boolean!Indicates whether PyPI package forwarding settings are locked by a parent namespace.

PackageTag

Represents a package tag.

Fields

NameTypeDescription
createdAt Time!Created date.
id ID!ID of the tag.
name String!Name of the tag.
updatedAt Time!Updated date.

PackagesCleanupPolicy

A packages cleanup policy designed to keep only packages and packages assets that matter most.

Fields

NameTypeDescription
keepNDuplicatedPackageFiles PackagesCleanupKeepDuplicatedPackageFilesEnum!Number of duplicated package files to retain.
nextRunAt TimeNext time that this packages cleanup policy will be executed.

PageInfo

Information about pagination in a connection.

Fields

NameTypeDescription
endCursor StringWhen paginating forwards, the cursor to continue.
hasNextPage Boolean!When paginating forwards, are there more items?.
hasPreviousPage Boolean!When paginating backwards, are there more items?.
startCursor StringWhen paginating backwards, the cursor to continue.

PagesDeploymentRegistry

Represents the Geo replication and verification state of a pages_deployment.

Fields

NameTypeDescription
createdAt TimeTimestamp when the PagesDeploymentRegistry was created.
id ID!ID of the PagesDeploymentRegistry.
lastSyncFailure StringError message during sync of the PagesDeploymentRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the PagesDeploymentRegistry.
pagesDeploymentId ID!ID of the Pages Deployment.
retryAt TimeTimestamp after which the PagesDeploymentRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the PagesDeploymentRegistry.
state RegistryStateSync state of the PagesDeploymentRegistry.
verificationRetryAt TimeTimestamp after which the PagesDeploymentRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the PagesDeploymentRegistry.

PathLock

Represents a file or directory in the project repository that has been locked.

Fields

NameTypeDescription
id PathLockID!ID of the path lock.
path StringLocked path.
user UserCoreUser that has locked this path.

Pipeline

Fields

NameTypeDescription
active Boolean!Indicates if the pipeline is active.
beforeSha StringBase SHA of the source branch.
cancelable Boolean!Specifies if a pipeline can be canceled.
codeQualityReportSummary CodeQualityReportSummaryCode Quality report summary for a pipeline.
codeQualityReports CodeQualityDegradationConnectionCode Quality degradations reported on the pipeline. (see Connections)
commit CommitGit commit of the pipeline.
commitPath StringPath to the commit that triggered the pipeline.
committedAt TimeTimestamp of the pipeline’s commit.
complete Boolean!Indicates if a pipeline is complete.
configSource PipelineConfigSourceEnumConfiguration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE, SECURITY_POLICIES_DEFAULT_SOURCE).
coverage FloatCoverage percentage.
createdAt Time!Timestamp of the pipeline’s creation.
dastProfile DastProfileDAST profile associated with the pipeline.
detailedStatus DetailedStatus!Detailed status of the pipeline.
downstream PipelineConnectionPipelines this pipeline will trigger. (see Connections)
duration IntDuration of the pipeline in seconds.
finishedAt TimeTimestamp of the pipeline’s completion.
id ID!ID of the pipeline.
iid String!Internal ID of the pipeline.
jobArtifacts [CiJobArtifact!]Job artifacts of the pipeline.
mergeRequestEventType PipelineMergeRequestEventTypeEvent type of the pipeline associated with a merge request.
path StringRelative path to the pipeline’s page.
project ProjectProject the pipeline belongs to.
queuedDuration DurationHow long the pipeline was queued before starting.
ref StringReference to the branch from which the pipeline was triggered.
refPath StringReference path to the branch from which the pipeline was triggered.
retryable Boolean!Specifies if a pipeline can be retried.
securityReportSummary SecurityReportSummaryVulnerability and scanned resource counts for each security scanner of the pipeline.
sourceJob CiJobJob where pipeline was triggered from.
stages CiStageConnectionStages of the pipeline. (see Connections)
startedAt TimeTimestamp when the pipeline was started.
status PipelineStatusEnum!Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED).
testReportSummary TestReportSummary!Summary of the test report generated by the pipeline.
updatedAt Time!Timestamp of the pipeline’s last activity.
upstream PipelinePipeline that triggered the pipeline.
user UserCorePipeline user.
userPermissions PipelinePermissions!Permissions for the current user on the resource.
usesNeeds BooleanIndicates if the pipeline has jobs with needs dependencies.
warningMessages [PipelineMessage!]Pipeline warning messages.
warnings Boolean!Indicates if a pipeline has warnings.

Fields with arguments

Pipeline.job

Specific job in this pipeline, either by name or ID.

Returns CiJob.

Arguments
NameTypeDescription
id JobIDID of the job.
name StringName of the job.
Pipeline.jobs

Jobs belonging to the pipeline.

Returns CiJobConnection.

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

Arguments
NameTypeDescription
jobKind CiJobKindFilter jobs by kind.
retried BooleanFilter jobs by retry-status.
securityReportTypes [SecurityReportTypeEnum!]Filter jobs by the type of security report they produce.
statuses [CiJobStatus!]Filter jobs by status.
whenExecuted [String!]Filter jobs by when they are executed.
Pipeline.securityReportFinding

Vulnerability finding reported on the pipeline.

Returns PipelineSecurityReportFinding.

Arguments
NameTypeDescription
uuid String!UUID of the security report finding.
Pipeline.securityReportFindings

Vulnerability findings reported on the pipeline.

Returns PipelineSecurityReportFindingConnection.

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

Arguments
NameTypeDescription
reportType [String!]Filter vulnerability findings by report type.
scanner [String!]Filter vulnerability findings by Scanner.externalId.
severity [String!]Filter vulnerability findings by severity.
state [VulnerabilityState!]Filter vulnerability findings by state.
Pipeline.sha

SHA of the pipeline’s commit.

Returns String.

Arguments
NameTypeDescription
format ShaFormatFormat of the SHA.
Pipeline.testSuite

A specific test suite in a pipeline test report.

Returns TestSuite.

Arguments
NameTypeDescription
buildIds [ID!]!IDs of the builds used to run the test suite.

PipelineAnalytics

Fields

NameTypeDescription
monthPipelinesLabels [String!]Labels for the monthly pipeline count.
monthPipelinesSuccessful [Int!]Total monthly successful pipeline count.
monthPipelinesTotals [Int!]Total monthly pipeline count.
pipelineTimesLabels [String!]Pipeline times labels.
pipelineTimesValues [Int!]Pipeline times.
weekPipelinesLabels [String!]Labels for the weekly pipeline count.
weekPipelinesSuccessful [Int!]Total weekly successful pipeline count.
weekPipelinesTotals [Int!]Total weekly pipeline count.
yearPipelinesLabels [String!]Labels for the yearly pipeline count.
yearPipelinesSuccessful [Int!]Total yearly successful pipeline count.
yearPipelinesTotals [Int!]Total yearly pipeline count.

PipelineArtifactRegistry

Represents the Geo sync and verification state of a pipeline artifact.

Fields

NameTypeDescription
createdAt TimeTimestamp when the PipelineArtifactRegistry was created.
id ID!ID of the PipelineArtifactRegistry.
lastSyncFailure StringError message during sync of the PipelineArtifactRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the PipelineArtifactRegistry.
pipelineArtifactId ID!ID of the pipeline artifact.
retryAt TimeTimestamp after which the PipelineArtifactRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the PipelineArtifactRegistry.
state RegistryStateSync state of the PipelineArtifactRegistry.
verificationRetryAt TimeTimestamp after which the PipelineArtifactRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the PipelineArtifactRegistry.

PipelineCounts

Represents pipeline counts for the project.

Fields

NameTypeDescription
all IntTotal number of pipelines for the project.
finished IntNumber of pipelines with scope FINISHED for the project.
pending IntNumber of pipelines with scope PENDING for the project.
running IntNumber of pipelines with scope RUNNING for the project.

PipelineMessage

Fields

NameTypeDescription
content String!Content of the pipeline message.
id ID!ID of the pipeline message.

PipelinePermissions

Fields

NameTypeDescription
adminPipeline Boolean!Indicates the user can perform admin_pipeline on this resource.
destroyPipeline Boolean!Indicates the user can perform destroy_pipeline on this resource.
updatePipeline Boolean!Indicates the user can perform update_pipeline on this resource.

PipelineSchedule

Represents a pipeline schedule.

Fields

NameTypeDescription
active Boolean!Indicates if the pipeline schedule is active.
createdAt Time!Timestamp of when the pipeline schedule was created.
cron String!Cron notation for the schedule.
cronTimezone String!Timezone for the pipeline schedule.
description StringDescription of the pipeline schedule.
editPath StringEdit path of the pipeline schedule.
forTag Boolean!Indicates if a pipelines schedule belongs to a tag.
id ID!ID of the pipeline schedule.
lastPipeline PipelineLast pipeline object.
nextRunAt Time!Time when the next pipeline will run.
owner UserCore!Owner of the pipeline schedule.
project ProjectProject of the pipeline schedule.
realNextRun Time!Time when the next pipeline will run.
ref StringRef of the pipeline schedule.
refForDisplay StringGit ref for the pipeline schedule.
refPath StringPath to the ref that triggered the pipeline.
updatedAt Time!Timestamp of when the pipeline schedule was last updated.
userPermissions PipelineSchedulePermissions!Permissions for the current user on the resource.
variables PipelineScheduleVariableConnectionPipeline schedule variables. (see Connections)

PipelineSchedulePermissions

Fields

NameTypeDescription
adminPipelineSchedule Boolean!Indicates the user can perform admin_pipeline_schedule on this resource.
playPipelineSchedule Boolean!Indicates the user can perform play_pipeline_schedule on this resource.
takeOwnershipPipelineSchedule Boolean! Deprecated in 15.9. Use admin_pipeline_schedule permission to determine if the user can take ownership of a pipeline schedule.
updatePipelineSchedule Boolean!Indicates the user can perform update_pipeline_schedule on this resource.

PipelineScheduleVariable

Fields

NameTypeDescription
id ID!ID of the variable.
key StringName of the variable.
raw BooleanIndicates whether the variable is raw.
value StringValue of the variable.
variableType CiVariableTypeType of the variable.

PipelineSecurityReportFinding

Represents vulnerability finding of a security report on the pipeline.

Fields

NameTypeDescription
assets [AssetType!]List of assets associated with the vulnerability.
description StringDescription of the vulnerability finding.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
details [VulnerabilityDetail!]!Details of the security finding.
dismissalReason VulnerabilityDismissalReasonReason for the dismissal of the security report finding.
dismissedAt TimeTime of the dismissal of the security report finding.
dismissedBy UserCoreUser who dismissed the security report finding.
evidence VulnerabilityEvidenceEvidence for the vulnerability.
falsePositive BooleanIndicates whether the vulnerability is a false positive.
identifiers [VulnerabilityIdentifier!]!Identifiers of the vulnerability finding.
issueLinks VulnerabilityIssueLinkConnectionList of issue links related to the vulnerability. (see Connections)
links [VulnerabilityLink!]List of links associated with the vulnerability.
location VulnerabilityLocationLocation metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability.
mergeRequest MergeRequestMerge request that fixes the vulnerability.
project ProjectProject on which the vulnerability finding was found.
projectFingerprint String Deprecated in 16.1. Use uuid instead.
remediations [VulnerabilityRemediationType!]Remediations of the security report finding.
reportType VulnerabilityReportTypeType of the security report that found the vulnerability finding.
scanner VulnerabilityScannerScanner metadata for the vulnerability.
severity VulnerabilitySeveritySeverity of the vulnerability finding.
solution StringSolution for resolving the security report finding.
state VulnerabilityStateFinding status.
stateComment StringComment for the state of the security report finding.
title StringTitle of the vulnerability finding.
uuid StringUUIDv5 digest based on the vulnerability’s report type, primary identifier, location, fingerprint, project identifier.
vulnerability VulnerabilityVulnerability related to the security report finding.

PreviewBillableUserChange

Fields

NameTypeDescription
newBillableUserCount IntTotal number of billable users after change.
seatsInSubscription IntNumber of seats in subscription.
willIncreaseOverage BooleanIf the group will have an increased overage after change.

ProductAnalyticsDashboard

Represents a product analytics dashboard.

Fields

NameTypeDescription
description StringDescription of the dashboard.
panels ProductAnalyticsDashboardPanelConnection!Panels shown on the dashboard. (see Connections)
slug String!Slug of the dashboard.
title String!Title of the dashboard.
userDefined Boolean!Indicates whether the dashboard is user-defined or provided by GitLab.

ProductAnalyticsDashboardPanel

Represents a product analytics dashboard panel.

Fields

NameTypeDescription
gridAttributes JSONDescription of the position and size of the panel.
queryOverrides JSONOverrides for the visualization query object.
title String!Title of the panel.
visualization ProductAnalyticsDashboardVisualization!Visualization of the panel.

ProductAnalyticsDashboardVisualization

Represents a product analytics dashboard visualization.

Fields

NameTypeDescription
data JSON!Data of the visualization.
options JSON!Options of the visualization.
slug String!Slug of the visualization.
type String!Type of the visualization.

Project

Fields

NameTypeDescription
actualRepositorySizeLimit FloatSize limit for the repository in bytes.
agentConfigurations AgentConfigurationConnectionAgent configurations defined by the project. (see Connections)
aiConversations ProjectConversations Introduced in 16.0. This feature is an Experiment. It can be changed or removed at any time. Ai Chat conversations related to a given project.
allowMergeOnSkippedPipeline BooleanIf only_allow_merge_if_pipeline_succeeds is true, indicates if merge requests of the project can also be merged with skipped jobs.
apiFuzzingCiConfiguration ApiFuzzingCiConfigurationAPI fuzzing configuration for the project.
archived BooleanIndicates the archived status of the project.
autocloseReferencedIssues BooleanIndicates if issues referenced by merge requests and commits within the default branch are closed automatically.
avatarUrl StringURL to avatar image file of the project.
branchRules BranchRuleConnectionBranch rules configured for the project. (see Connections)
ciAccessAuthorizedAgents ClusterAgentAuthorizationCiAccessConnectionAuthorized cluster agents for the project through ci_access keyword. (see Connections)
ciCdSettings ProjectCiCdSettingCI/CD settings for the project.
ciConfigPathOrDefault String!Path of the CI configuration file.
ciJobTokenScope CiJobTokenScopeTypeThe CI Job Tokens scope of access.
codeCoverageSummary CodeCoverageSummaryCode coverage summary associated with the project.
complianceFrameworks ComplianceFrameworkConnectionCompliance frameworks associated with the project. (see Connections)
containerExpirationPolicy ContainerExpirationPolicyContainer expiration policy of the project.
containerRegistryEnabled BooleanIndicates if Container Registry is enabled for the current user.
containerRepositoriesCount Int!Number of container repositories in the project.
corpuses CoverageFuzzingCorpusConnectionFind corpuses of the project. (see Connections)
createdAt TimeTimestamp of the project creation.
dastScannerProfiles DastScannerProfileConnectionDAST scanner profiles associated with the project. (see Connections)
dastSiteProfiles DastSiteProfileConnectionDAST Site Profiles associated with the project. (see Connections)
description StringShort description of the project.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
dora DoraProject’s DORA metrics.
flowMetrics ProjectValueStreamAnalyticsFlowMetrics Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Flow metrics for value stream analytics.
forksCount Int!Number of times the project has been forked.
fullPath ID!Full path of the project.
grafanaIntegration GrafanaIntegrationGrafana integration details for the project.
group GroupGroup of the project.
hasJiraVulnerabilityIssueCreationEnabled Boolean!Indicates whether Jira issue creation from vulnerabilities is enabled.
httpUrlToRepo StringURL to connect to the project via HTTPS.
id ID!ID of the project.
importStatus StringStatus of import background job of the project.
incidentManagementTimelineEventTags [TimelineEventTagType!]Timeline event tags for the project.
isCatalogResource Boolean Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Indicates if a project is a catalog resource.
issuesEnabled BooleanIndicates if Issues are enabled for the current user.
jiraImportStatus StringStatus of Jira import background job of the project.
jiraImports JiraImportConnectionJira imports into the project. (see Connections)
jobsEnabled BooleanIndicates if CI/CD pipeline jobs are enabled for the current user.
languages [RepositoryLanguage!]Programming languages used in the project.
lastActivityAt TimeTimestamp of the project last activity.
lfsEnabled BooleanIndicates if the project has Large File Storage (LFS) enabled.
mergeCommitTemplate StringTemplate used to create merge commit message in merge requests.
mergeRequestsDisableCommittersApproval Boolean!Indicates that committers of the given merge request cannot approve.
mergeRequestsEnabled BooleanIndicates if Merge Requests are enabled for the current user.
mergeRequestsFfOnlyEnabled BooleanIndicates if no merge commits should be created and all merges should instead be fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded.
name String!Name of the project (without namespace).
nameWithNamespace String!Full name of the project with its namespace.
namespace NamespaceNamespace of the project.
onlyAllowMergeIfAllDiscussionsAreResolved BooleanIndicates if merge requests of the project can only be merged when all the discussions are resolved.
onlyAllowMergeIfAllStatusChecksPassed BooleanIndicates that merges of merge requests should be blocked unless all status checks have passed.
onlyAllowMergeIfPipelineSucceeds BooleanIndicates if merge requests of the project can only be merged with successful jobs.
openIssuesCount IntNumber of open issues for the project.
packagesCleanupPolicy PackagesCleanupPolicyPackages cleanup policy for the project.
path String!Path of the project.
pathLocks PathLockConnectionThe project’s path locks. (see Connections)
pipelineAnalytics PipelineAnalyticsPipeline analytics.
printingMergeRequestLinkEnabled BooleanIndicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line.
productAnalyticsInstrumentationKey String Introduced in 16.0. This feature is an Experiment. It can be changed or removed at any time. Product Analytics instrumentation key assigned to the project.
productAnalyticsState ProductAnalyticsState Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Current state of the product analytics stack for this project.Can only be called for one project in a single request.
publicJobs BooleanIndicates if there is public access to pipelines and job details of the project, including output logs and artifacts.
pushRules PushRulesProject’s push rules settings.
recentIssueBoards BoardConnectionList of recently visited boards of the project. Maximum size is 4. (see Connections)
removeSourceBranchAfterMerge BooleanIndicates if Delete source branch option should be enabled by default for all new merge requests of the project.
repository RepositoryGit repository of the project.
repositorySizeExcess FloatSize of repository that exceeds the limit in bytes.
requestAccessEnabled BooleanIndicates if users can request member access to the project.
requirementStatesCount RequirementStatesCountNumber of requirements for the project by their state.
sastCiConfiguration SastCiConfigurationSAST CI configuration for the project.
securityDashboardPath StringPath to project’s security dashboard.
securityScanners SecurityScannersInformation about security analyzers used in the project.
sentryErrors SentryErrorCollectionPaginated collection of Sentry errors on the project.
serviceDeskAddress StringE-mail address of the Service Desk.
serviceDeskEnabled BooleanIndicates if the project has Service Desk enabled.
sharedRunnersEnabled BooleanIndicates if shared runners are enabled for the project.
snippetsEnabled BooleanIndicates if Snippets are enabled for the current user.
squashCommitTemplate StringTemplate used to create squash commit message in merge requests.
squashReadOnly Boolean!Indicates if squashReadOnly is enabled.
sshUrlToRepo StringURL to connect to the project via SSH.
starCount Int!Number of times the project has been starred.
statistics ProjectStatisticsStatistics of the project.
statisticsDetailsPaths ProjectStatisticsRedirectRedirects for Statistics of the project.
suggestionCommitMessage StringCommit message used to apply merge request suggestions.
tagList String Deprecated in 13.12. Use topics.
terraformStates TerraformStateConnectionTerraform states associated with the project. (see Connections)
timelogCategories TimeTrackingTimelogCategoryConnection Introduced in 15.3. This feature is an Experiment. It can be changed or removed at any time. Timelog categories for the project.
topics [String!]List of project topics.
trackingKey String Introduced in 16.0. This feature is an Experiment. It can be changed or removed at any time. Tracking key assigned to the project.
userAccessAuthorizedAgents ClusterAgentAuthorizationUserAccessConnectionAuthorized cluster agents for the project through user_access keyword. (see Connections)
userPermissions ProjectPermissions!Permissions for the current user on the resource.
visibility StringVisibility of the project.
vulnerabilityImages VulnerabilityContainerImageConnectionContainer images reported on the project vulnerabilities. (see Connections)
vulnerabilityScanners VulnerabilityScannerConnectionVulnerability scanners reported on the project vulnerabilities. (see Connections)
webUrl StringWeb URL of the project.
wikiEnabled BooleanIndicates if Wikis are enabled for the current user.

Fields with arguments

Project.alertManagementAlert

A single Alert Management alert of the project.

Returns AlertManagementAlert.

Arguments
NameTypeDescription
assigneeUsername StringUsername of a user assigned to the issue.
domain AlertManagementDomainFilter!Filter query for given domain.
iid StringIID of the alert. For example, “1”.
search StringSearch query for title, description, service, or monitoring_tool.
sort AlertManagementAlertSortSort alerts by this criteria.
statuses [AlertManagementStatus!]Alerts with the specified statues. For example, [TRIGGERED].
Project.alertManagementAlertStatusCounts

Counts of alerts by status for the project.

Returns AlertManagementAlertStatusCountsType.

Arguments
NameTypeDescription
assigneeUsername StringUsername of a user assigned to the issue.
search StringSearch query for title, description, service, or monitoring_tool.
Project.alertManagementAlerts

Alert Management alerts of the project.

Returns AlertManagementAlertConnection.

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

Arguments
NameTypeDescription
assigneeUsername StringUsername of a user assigned to the issue.
domain AlertManagementDomainFilter!Filter query for given domain.
iid StringIID of the alert. For example, “1”.
search StringSearch query for title, description, service, or monitoring_tool.
sort AlertManagementAlertSortSort alerts by this criteria.
statuses [AlertManagementStatus!]Alerts with the specified statues. For example, [TRIGGERED].
Project.alertManagementHttpIntegrations

HTTP Integrations which can receive alerts for the project.

Returns AlertManagementHttpIntegrationConnection.

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

Arguments
NameTypeDescription
id AlertManagementHttpIntegrationIDID of the integration.
Project.alertManagementIntegrations

Integrations which can receive alerts for the project.

Returns AlertManagementIntegrationConnection.

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

Arguments
NameTypeDescription
id GlobalIDID of the integration.
Project.alertManagementPayloadFields

Extract alert fields from payload for custom mapping.

Returns [AlertManagementPayloadAlertField!].

Arguments
NameTypeDescription
payloadExample String!Sample payload for extracting alert fields for custom mappings.
Project.board

A single board of the project.

Returns Board.

Arguments
NameTypeDescription
id BoardID!ID of the board.
Project.boards

Boards of the project.

Returns BoardConnection.

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

Arguments
NameTypeDescription
id BoardIDFind a board by its ID.
Project.ciConfigVariables

CI/CD config variable.

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

Returns [CiConfigVariable!].

Arguments
NameTypeDescription
ref String!Ref.
Project.ciTemplate

Find a single CI/CD template by name.

Returns CiTemplate.

Arguments
NameTypeDescription
name String!Name of the CI/CD template to search for. Template must be formatted as Name.gitlab-ci.yml.
Project.ciVariables

List of the project’s CI/CD variables.

Returns CiProjectVariableConnection.

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.
Project.clusterAgent

Find a single cluster agent by name.

Returns ClusterAgent.

Arguments
NameTypeDescription
hasRemoteDevelopmentAgentConfig BooleanReturns only cluster agents which have an associated remote development agent config.
hasVulnerabilities BooleanReturns only cluster agents which have vulnerabilities.
name String!Name of the cluster agent.
Project.clusterAgents

Cluster agents associated with the project.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
hasRemoteDevelopmentAgentConfig BooleanReturns only cluster agents which have an associated remote development agent config.
hasVulnerabilities BooleanReturns only cluster agents which have vulnerabilities.
Project.commitReferences

Get tag names containing a given commit.

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

Returns CommitReferences.

Arguments
NameTypeDescription
commitSha String!Project commit SHA identifier. For example, 287774414568010855642518513f085491644061.
Project.containerRepositories

Container repositories of the project.

Returns ContainerRepositoryConnection.

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

Arguments
NameTypeDescription
name StringFilter the container repositories by their name.
sort ContainerRepositorySortSort container repositories by this criteria.
Project.dastProfile

DAST Profile associated with the project.

Returns DastProfile.

Arguments
NameTypeDescription
hasDastProfileSchedule BooleanFilter DAST Profiles by whether or not they have a schedule.
id DastProfileID!ID of the DAST Profile.
Project.dastProfiles

DAST Profiles associated with the project.

Returns DastProfileConnection.

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

Arguments
NameTypeDescription
hasDastProfileSchedule BooleanFilter DAST Profiles by whether or not they have a schedule.
Project.dastSiteProfile

DAST Site Profile associated with the project.

Returns DastSiteProfile.

Arguments
NameTypeDescription
id DastSiteProfileID!ID of the site profile.
Project.dastSiteValidations

DAST Site Validations associated with the project.

Returns DastSiteValidationConnection.

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

Arguments
NameTypeDescription
normalizedTargetUrls [String!]Normalized URL of the target to be scanned.
status DastSiteValidationStatusEnumStatus of the site validation.
Project.dataTransfer

Data transfer data point for a specific period. This is mocked data under a development feature flag.

Returns ProjectDataTransfer.

Arguments
NameTypeDescription
from DateRetain egress data for one year. Data for the current month will increase dynamically as egress occurs.
to DateEnd date for the data.
Project.dependencies

Software dependencies used by the project.

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

Returns DependencyConnection.

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

Arguments
NameTypeDescription
componentNames [String!]Filter dependencies by component names.
packageManagers [PackageManager!]Filter dependencies by package managers.
sort DependencySortSort dependencies by given criteria.
Project.deployment

Details of the deployment of the project.

Returns Deployment.

Arguments
NameTypeDescription
iid ID!Project-level internal ID of the Deployment.
Project.environment

A single environment of the project.

Returns Environment.

Arguments
NameTypeDescription
name StringName of the environment.
search StringSearch query for environment name.
states [String!]States of environments that should be included in result.
type StringSearch query for environment type.
Project.environments

Environments of the project. This field can only be resolved for one project in any single request.

Returns EnvironmentConnection.

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

Arguments
NameTypeDescription
name StringName of the environment.
search StringSearch query for environment name.
states [String!]States of environments that should be included in result.
type StringSearch query for environment type.
Project.forkDetails

Details of the fork project compared to its upstream project.

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

Returns ForkDetails.

Arguments
NameTypeDescription
ref StringRef of the fork. Default value is HEAD.
Project.forkTargets

Namespaces in which the current user can fork the project into.

Returns NamespaceConnection.

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 path or name.
Project.gitlabSubscriptionsPreviewBillableUserChange

Preview Billable User Changes.

Returns PreviewBillableUserChange.

Arguments
NameTypeDescription
addGroupId IntGroup ID to add.
addUserEmails [String!]User emails to add.
addUserIds [Int!]User IDs to add.
role GitlabSubscriptionsUserRole!Role of users being added to group.
Project.incidentManagementEscalationPolicies

Incident Management escalation policies of the project.

Returns EscalationPolicyTypeConnection.

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

Arguments
NameTypeDescription
name StringFuzzy search by escalation policy name.
Project.incidentManagementEscalationPolicy

Incident Management escalation policy of the project.

Returns EscalationPolicyType.

Arguments
NameTypeDescription
id IncidentManagementEscalationPolicyID!ID of the escalation policy.
name StringFuzzy search by escalation policy name.
Project.incidentManagementOncallSchedules

Incident Management On-call schedules of the project.

Returns IncidentManagementOncallScheduleConnection.

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

Arguments
NameTypeDescription
iids [ID!]IIDs of on-call schedules.
Project.incidentManagementTimelineEvent

Incident Management Timeline event associated with the incident.

Returns TimelineEventType.

Arguments
NameTypeDescription
id IncidentManagementTimelineEventID!ID of the timeline event.
incidentId IssueID!ID of the incident.
Project.incidentManagementTimelineEvents

Incident Management Timeline events associated with the incident.

Returns TimelineEventTypeConnection.

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

Arguments
NameTypeDescription
incidentId IssueID!ID of the incident.
Project.inheritedCiVariables

List of CI/CD variables the project inherited from its parent group and ancestors.

Returns InheritedCiVariableConnection.

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

Arguments
NameTypeDescription
sort CiGroupVariablesSortSort variables by the criteria.
Project.issue

A single issue of the project.

Returns Issue.

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.
healthStatus HealthStatus Deprecated in 15.4. Use healthStatusFilter.
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.’.
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.
releaseTag [String!]Release tag associated with the issue’s milestone.
releaseTagWildcardId ReleaseTagWildcardIdFilter issues by release tag ID wildcard.
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.
Project.issueStatusCounts

Counts of issues by status for the project.

Returns IssueStatusCountsType.

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.’.
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.
releaseTag [String!]Release tag associated with the issue’s milestone.
releaseTagWildcardId ReleaseTagWildcardIdFilter issues by release tag ID wildcard.
search StringSearch query for title or description.
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.
Project.issues

Issues of the project.

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.
healthStatus HealthStatus Deprecated in 15.4. Use healthStatusFilter.
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.’.
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.
releaseTag [String!]Release tag associated with the issue’s milestone.
releaseTagWildcardId ReleaseTagWildcardIdFilter issues by release tag ID wildcard.
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.
Project.iterationCadences

Find iteration cadences.

Returns IterationCadenceConnection.

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

Arguments
NameTypeDescription
active BooleanWhether the iteration cadence is active.
automatic BooleanWhether the iteration cadence should automatically generate upcoming iterations.
durationInWeeks IntDuration in weeks of the iterations within this cadence.
id IterationsCadenceIDGlobal ID of the iteration cadence to look up.
includeAncestorGroups BooleanWhether to include ancestor groups to search iterations cadences in.
title StringFuzzy search by title.
Project.iterations

Find iterations.

Returns IterationConnection.

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

Arguments
NameTypeDescription
id IDGlobal ID of the Iteration to look up.
iid IDInternal ID of the Iteration to look up.
in [IterationSearchableField!]Fields in which the fuzzy-search should be performed with the query given in the argument search. Defaults to [title].
includeAncestors BooleanWhether to include ancestor iterations. Defaults to true.
iterationCadenceIds [IterationsCadenceID!]Global iteration cadence IDs by which to look up the iterations.
search StringQuery used for fuzzy-searching in the fields selected in the argument in. Returns all iterations if empty.
sort IterationSortList iterations by sort order. If unspecified, an arbitrary order (subject to change) is used.
state IterationStateFilter iterations by state.
timeframe TimeframeList items overlapping the given timeframe.
title String Deprecated in 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
Project.job

One job belonging to the project, selected by ID.

Returns CiJob.

Arguments
NameTypeDescription
id JobID!ID of the job.
Project.jobs

Jobs of a project. This field can only be resolved for one project in any single request.

Returns CiJobConnection.

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

Arguments
NameTypeDescription
statuses [CiJobStatus!]Filter jobs by status.
withArtifacts BooleanFilter by artifacts presence.
Project.label

Label available on this project.

Returns Label.

Arguments
NameTypeDescription
title String!Title of the label.
Project.labels

Labels available on this project.

Returns LabelConnection.

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

Arguments
NameTypeDescription
includeAncestorGroups BooleanInclude labels from ancestor groups.
searchTerm StringSearch term to find labels with.
Project.mergeRequest

A single merge request of the project.

Returns MergeRequest.

Arguments
NameTypeDescription
iid String!IID of the merge request, for example 1.
Project.mergeRequests

Merge requests of the project.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
Project.milestones

Milestones of the project.

Returns MilestoneConnection.

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

Arguments
NameTypeDescription
containingDate TimeDate the milestone contains.
ids [ID!]Array of global milestone IDs, e.g., "gid://gitlab/Milestone/1".
includeAncestors BooleanAlso return milestones in the project’s parent group and its ancestors.
searchTitle StringSearch string for the title.
sort MilestoneSortSort milestones by this criteria.
state MilestoneStateEnumFilter milestones by state.
timeframe TimeframeList items overlapping the given timeframe.
title StringTitle of the milestone.
Project.nestedEnvironments

Environments for this project with nested folders, can only be resolved for one project in any single request.

Returns NestedEnvironmentConnection.

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

Arguments
NameTypeDescription
name StringName of the environment.
search StringSearch query for environment name.
states [String!]States of environments that should be included in result.
type StringSearch query for environment type.
Project.networkPolicies

Network Policies of the project.

caution
Deprecated in 14.8. Network policies are deprecated and will be removed in GitLab 16.0. Since GitLab 15.0 this field returns no data.

Returns NetworkPolicyConnection.

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

Arguments
NameTypeDescription
environmentId EnvironmentIDGlobal ID of the environment to filter policies.
Project.packages

Packages of the project.

Returns PackageConnection.

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

Arguments
NameTypeDescription
includeVersionless BooleanInclude versionless packages.
packageName StringSearch a package by name.
packageType PackageTypeEnumFilter a package by type.
sort PackageSortSort packages by this criteria.
status PackageStatusFilter a package by status.
Project.pipeline

Build pipeline of the project.

Returns Pipeline.

Arguments
NameTypeDescription
iid IDIID of the Pipeline. For example, “1”.
sha StringSHA of the Pipeline. For example, “dyd0f15ay83993f5ab66k927w28673882x99100b”.
Project.pipelineCounts

Build pipeline counts of the project.

Returns PipelineCounts.

Arguments
NameTypeDescription
ref StringFilter pipelines by the ref they are run for.
sha StringFilter pipelines by the SHA of the commit they are run for.
source StringFilter pipelines by their source.
Project.pipelineSchedules

Pipeline schedules of the project. This field can only be resolved for one project per request.

Returns PipelineScheduleConnection.

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 pipeline schedules by IDs.
status PipelineScheduleStatusFilter pipeline schedules by active status.
Project.pipelines

Build pipelines of the project.

Returns PipelineConnection.

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

Arguments
NameTypeDescription
ref StringFilter pipelines by the ref they are run for.
scope PipelineScopeEnumFilter pipelines by scope.
sha StringFilter pipelines by the sha of the commit they are run for.
source StringFilter pipelines by their source.
status PipelineStatusEnumFilter pipelines by their status.
updatedAfter TimePipelines updated after this date.
updatedBefore TimePipelines updated before this date.
username StringFilter pipelines by the user that triggered the pipeline.
Project.productAnalyticsDashboards

Product Analytics dashboards of the project.

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

Returns ProductAnalyticsDashboardConnection.

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

Arguments
NameTypeDescription
slug StringFind by dashboard slug.
Project.productAnalyticsVisualizations

Visualizations of the project or associated configuration project.

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

Returns ProductAnalyticsDashboardVisualizationConnection.

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

Arguments
NameTypeDescription
slug StringSlug of the visualization to return.
Project.projectMembers

Members of the project.

Returns MemberInterfaceConnection.

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

Arguments
NameTypeDescription
relations [ProjectMemberRelation!]Filter members by the given member relations.
search StringSearch query.
sort MemberSortsort query.
Project.release

A single release of the project.

Returns Release.

Arguments
NameTypeDescription
tagName String!Name of the tag associated to the release.
Project.releases

Releases of the project.

Returns ReleaseConnection.

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

Arguments
NameTypeDescription
sort ReleaseSortSort releases by given criteria.
Project.requirement

Find a single requirement.

Returns Requirement.

Arguments
NameTypeDescription
authorUsername [String!]Filter requirements by author username.
iid ID Deprecated in 15.8. Use work_item_iid instead.
iids [ID!] Deprecated in 15.8. Use work_item_iids instead.
lastTestReportState RequirementStatusFilterState of latest requirement test report.
search StringSearch query for requirement title.
sort SortList requirements by sort order.
state RequirementStateFilter requirements by state.
workItemIid IDIID of the requirement work item, for example, “1”.
workItemIids [ID!]List of IIDs of requirement work items, for example, [1, 2].
Project.requirements

Find requirements.

Returns RequirementConnection.

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

Arguments
NameTypeDescription
authorUsername [String!]Filter requirements by author username.
iid ID Deprecated in 15.8. Use work_item_iid instead.
iids [ID!] Deprecated in 15.8. Use work_item_iids instead.
lastTestReportState RequirementStatusFilterState of latest requirement test report.
search StringSearch query for requirement title.
sort SortList requirements by sort order.
state RequirementStateFilter requirements by state.
workItemIid IDIID of the requirement work item, for example, “1”.
workItemIids [ID!]List of IIDs of requirement work items, for example, [1, 2].
Project.runners

Find runners visible to the current user.

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.
Project.scanExecutionPolicies

Scan Execution Policies of the project.

Returns ScanExecutionPolicyConnection.

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

Arguments
NameTypeDescription
actionScanTypes [SecurityReportTypeEnum!]Filters policies by the action scan type. Only these scan types are supported: dast, secret_detection, cluster_image_scanning, container_scanning, sast, sast_iac, dependency_scanning.
relationship SecurityPolicyRelationTypeFilter policies by the given policy relationship.
Project.scanResultPolicies

Scan Result Policies of the project.

Returns ScanResultPolicyConnection.

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

Arguments
NameTypeDescription
relationship SecurityPolicyRelationTypeFilter policies by the given policy relationship.
Project.securityTrainingProviders

List of security training providers for the project.

Returns [ProjectSecurityTraining!].

Arguments
NameTypeDescription
onlyEnabled BooleanFilter the list by only enabled security trainings.
Project.securityTrainingUrls

Security training URLs for the enabled training providers of the project.

Returns [SecurityTrainingUrl!].

Arguments
NameTypeDescription
filename StringFilename to filter security training URLs by programming language.
identifierExternalIds [String!]!List of external IDs of vulnerability identifiers.
Project.sentryDetailedError

Detailed version of a Sentry error on the project.

Returns SentryDetailedError.

Arguments
NameTypeDescription
id GitlabErrorTrackingDetailedErrorID!ID of the Sentry issue.
Project.services

Project services.

caution
Deprecated in 15.9. This will be renamed to Project.integrations.

Returns ServiceConnection.

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

Arguments
NameTypeDescription
active BooleanIndicates if the integration is active.
type ServiceTypeType of integration.
Project.snippets

Snippets of the project.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
visibility VisibilityScopesEnumVisibility of the snippet.
Project.terraformState

Find a single Terraform state by name.

Returns TerraformState.

Arguments
NameTypeDescription
name String!Name of the Terraform state.
Project.timelogs

Time logged on issues and merge requests in the project.

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.
Project.visibleForks

Visible forks of the project.

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

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minimumAccessLevel AccessLevelEnumMinimum access level.
Project.vulnerabilities

Vulnerabilities reported on the project.

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.
hasIssues BooleanReturns only the vulnerabilities which have linked issues.
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.
Project.vulnerabilitiesCountByDay

The historical number of vulnerabilities per day for the project.

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.
Project.vulnerabilitySeveritiesCount

Counts for each vulnerability severity in the project.

Returns VulnerabilitySeveritiesCount.

Arguments
NameTypeDescription
clusterAgentId [ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
hasIssues BooleanFilter vulnerabilities that do or do not have issues.
hasResolution BooleanFilter vulnerabilities that do or do not have a resolution.
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 scanner.
scannerId [VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity [VulnerabilitySeverity!]Filter vulnerabilities by severity.
state [VulnerabilityState!]Filter vulnerabilities by state.
Project.workItemTypes

Work item types available to the project.

Returns WorkItemTypeConnection.

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

Arguments
NameTypeDescription
taskable BooleanIf true, only taskable work item types will be returned. Argument is experimental and can be removed in the future without notice.
Project.workItems

Work items of the project.

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

Returns WorkItemConnection.

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

Arguments
NameTypeDescription
authorUsername String Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. Filter work items by author username.
iid StringIID of the work item. For example, “1”.
iids [String!]List of IIDs of work items. For example, ["1", "2"].
in [IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
requirementLegacyWidget RequirementLegacyFilterInput Deprecated in 15.9. Use work item IID filter instead.
search StringSearch query for title or description.
sort WorkItemSortSort work items by criteria.
state IssuableStateCurrent state of the work item.
statusWidget StatusFilterInputInput for status widget filter. Ignored if work_items_mvc_2 is disabled.
types [IssueType!]Filter work items by the given work item types.

ProjectCiCdSetting

Fields

NameTypeDescription
inboundJobTokenScopeEnabled BooleanIndicates CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabled BooleanIndicates CI/CD job tokens generated in this project have restricted access to other projects.
keepLatestArtifact BooleanWhether to keep the latest builds artifacts.
mergePipelinesEnabled BooleanWhether merge pipelines are enabled.
mergeTrainsEnabled BooleanWhether merge trains are enabled.
project ProjectProject the CI/CD settings belong to.

ProjectConversations

Fields

NameTypeDescription
ciConfigMessages AiMessageTypeConnection Introduced in 16.0. This feature is an Experiment. It can be changed or removed at any time. Messages generated by open ai and the user.

ProjectDataTransfer

Fields

NameTypeDescription
egressNodes EgressNodeConnectionData nodes. (see Connections)
totalEgress BigIntTotal egress for that project in that period of time.

ProjectMember

Represents a Project Membership.

Fields

NameTypeDescription
accessLevel AccessLevelGitLab::Access level.
createdAt TimeDate and time the membership was created.
createdBy UserCoreUser that authorized membership.
expiresAt TimeDate and time the membership expires.
id ID!ID of the member.
project ProjectProject that User is a member of.
updatedAt TimeDate and time the membership was last updated.
user UserCoreUser that is associated with the member object.
userPermissions ProjectPermissions!Permissions for the current user on the resource.

Fields with arguments

ProjectMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
NameTypeDescription
id MergeRequestID!Global ID of the merge request.

ProjectPermissions

Fields

NameTypeDescription
adminOperations Boolean!Indicates the user can perform admin_operations on this resource.
adminPathLocks Boolean!Indicates the user can perform admin_path_locks on this resource.
adminProject Boolean!Indicates the user can perform admin_project on this resource.
adminRemoteMirror Boolean!Indicates the user can perform admin_remote_mirror on this resource.
adminWiki Boolean!Indicates the user can perform admin_wiki on this resource.
archiveProject Boolean!Indicates the user can perform archive_project on this resource.
changeNamespace Boolean!Indicates the user can perform change_namespace on this resource.
changeVisibilityLevel Boolean!Indicates the user can perform change_visibility_level on this resource.
createDeployment Boolean!Indicates the user can perform create_deployment on this resource.
createDesign Boolean!Indicates the user can perform create_design on this resource.
createIssue Boolean!Indicates the user can perform create_issue on this resource.
createLabel Boolean!Indicates the user can perform create_label on this resource.
createMergeRequestFrom Boolean!Indicates the user can perform create_merge_request_from on this resource.
createMergeRequestIn Boolean!Indicates the user can perform create_merge_request_in on this resource.
createPages Boolean!Indicates the user can perform create_pages on this resource.
createPipeline Boolean!Indicates the user can perform create_pipeline on this resource.
createPipelineSchedule Boolean!Indicates the user can perform create_pipeline_schedule on this resource.
createSnippet Boolean!Indicates the user can perform create_snippet on this resource.
createWiki Boolean!Indicates the user can perform create_wiki on this resource.
destroyDesign Boolean!Indicates the user can perform destroy_design on this resource.
destroyPages Boolean!Indicates the user can perform destroy_pages on this resource.
destroyWiki Boolean!Indicates the user can perform destroy_wiki on this resource.
downloadCode Boolean!Indicates the user can perform download_code on this resource.
downloadWikiCode Boolean!Indicates the user can perform download_wiki_code on this resource.
forkProject Boolean!Indicates the user can perform fork_project on this resource.
pushCode Boolean!Indicates the user can perform push_code on this resource.
pushToDeleteProtectedBranch Boolean!Indicates the user can perform push_to_delete_protected_branch on this resource.
readCommitStatus Boolean!Indicates the user can perform read_commit_status on this resource.
readCycleAnalytics Boolean!Indicates the user can perform read_cycle_analytics on this resource.
readDesign Boolean!Indicates the user can perform read_design on this resource.
readEnvironment Boolean!Indicates the user can perform read_environment on this resource.
readMergeRequest Boolean!Indicates the user can perform read_merge_request on this resource.
readPagesContent Boolean!Indicates the user can perform read_pages_content on this resource.
readProject Boolean!Indicates the user can perform read_project on this resource.
readProjectMember Boolean!Indicates the user can perform read_project_member on this resource.
readWiki Boolean!Indicates the user can perform read_wiki on this resource.
removeForkProject Boolean!Indicates the user can perform remove_fork_project on this resource.
removePages Boolean!Indicates the user can perform remove_pages on this resource.
removeProject Boolean!Indicates the user can perform remove_project on this resource.
renameProject Boolean!Indicates the user can perform rename_project on this resource.
requestAccess Boolean!Indicates the user can perform request_access on this resource.
updatePages Boolean!Indicates the user can perform update_pages on this resource.
updateWiki Boolean!Indicates the user can perform update_wiki on this resource.
uploadFile Boolean!Indicates the user can perform upload_file on this resource.

ProjectRepositoryRegistry

Represents the Geo replication and verification state of a project repository.

Fields

NameTypeDescription
createdAt TimeTimestamp when the ProjectRepositoryRegistry was created.
id ID!ID of the ProjectRepositoryRegistry.
lastSyncFailure StringError message during sync of the ProjectRepositoryRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the ProjectRepositoryRegistry.
projectId ID!ID of the Project.
retryAt TimeTimestamp after which the ProjectRepositoryRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the ProjectRepositoryRegistry.
state RegistryStateSync state of the ProjectRepositoryRegistry.
verificationRetryAt TimeTimestamp after which the ProjectRepositoryRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the ProjectRepositoryRegistry.

ProjectSecurityPolicySource

Represents the source of a security policy belonging to a project.

Fields

NameTypeDescription
project ProjectProject the policy is associated with.

ProjectSecurityTraining

Fields

NameTypeDescription
description StringDescription of the training provider.
id GlobalID!ID of the training provider.
isEnabled Boolean!Represents whether the provider is enabled or not.
isPrimary Boolean!Represents whether the provider is set as primary or not.
logoUrl StringLogo URL of the provider.
name String!Name of the training provider.
url String!URL of the provider.

ProjectStatistics

Fields

NameTypeDescription
buildArtifactsSize Float!Build artifacts size of the project in bytes.
commitCount Float!Commit count of the project.
containerRegistrySize FloatContainer Registry size of the project in bytes.
costFactoredStorageSize Float! Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Storage size in bytes with any applicable cost factor for forks applied. This will equal storage_size if there is no applicable cost factor.
lfsObjectsSize Float!Large File Storage (LFS) object size of the project in bytes.
packagesSize Float!Packages size of the project in bytes.
pipelineArtifactsSize FloatCI Pipeline artifacts size in bytes.
repositorySize Float!Repository size of the project in bytes.
snippetsSize FloatSnippets size of the project in bytes.
storageSize Float!Storage size of the project in bytes.
uploadsSize FloatUploads size of the project in bytes.
wikiSize FloatWiki size of the project in bytes.

ProjectStatisticsRedirect

Fields

NameTypeDescription
buildArtifacts String!Redirection Route for job_artifacts.
containerRegistry String!Redirection Route for container_registry.
packages String!Redirection Route for packages.
repository String!Redirection Route for repository.
snippets String!Redirection Route for snippets.
wiki String!Redirection Route for wiki.

ProjectValueStreamAnalyticsFlowMetrics

Exposes aggregated value stream flow metrics.

Fields with arguments

ProjectValueStreamAnalyticsFlowMetrics.cycleTime

Median time from first commit to issue closed.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames [String!]Usernames of users assigned to the issue.
authorUsername StringUsername of the author of the issue.
from Time!Timestamp marking the start date and time.
labelNames [String!]Labels applied to the issue.
milestoneTitle StringMilestone applied to the issue.
to Time!Timestamp marking the end date and time.
ProjectValueStreamAnalyticsFlowMetrics.deploymentCount

Number of production deployments in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
from Time!Timestamp marking the start date and time.
to Time!Timestamp marking the end date and time.
ProjectValueStreamAnalyticsFlowMetrics.issueCount

Number of issues opened in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames [String!]Usernames of users assigned to the issue.
authorUsername StringUsername of the author of the issue.
from Time!Timestamp marking the start date and time.
labelNames [String!]Labels applied to the issue.
milestoneTitle StringMilestone applied to the issue.
to Time!Timestamp marking the end date and time.
ProjectValueStreamAnalyticsFlowMetrics.issuesCompletedCount

Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames [String!]Usernames of users assigned to the issue.
authorUsername StringUsername of the author of the issue.
from Time!Timestamp marking the start date and time.
labelNames [String!]Labels applied to the issue.
milestoneTitle StringMilestone applied to the issue.
to Time!Timestamp marking the end date and time.
ProjectValueStreamAnalyticsFlowMetrics.leadTime

Median time from when the issue was created to when it was closed.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames [String!]Usernames of users assigned to the issue.
authorUsername StringUsername of the author of the issue.
from Time!Timestamp marking the start date and time.
labelNames [String!]Labels applied to the issue.
milestoneTitle StringMilestone applied to the issue.
to Time!Timestamp marking the end date and time.

ProjectWikiRepositoryRegistry

Represents the Geo replication and verification state of a project_wiki_repository.

Fields

NameTypeDescription
createdAt TimeTimestamp when the ProjectWikiRepositoryRegistry was created.
id ID!ID of the ProjectWikiRepositoryRegistry.
lastSyncFailure StringError message during sync of the ProjectWikiRepositoryRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the ProjectWikiRepositoryRegistry.
projectWikiRepositoryId ID!ID of the Project Wiki Repository.
retryAt TimeTimestamp after which the ProjectWikiRepositoryRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the ProjectWikiRepositoryRegistry.
state RegistryStateSync state of the ProjectWikiRepositoryRegistry.
verificationRetryAt TimeTimestamp after which the ProjectWikiRepositoryRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the ProjectWikiRepositoryRegistry.

PrometheusAlert

The alert condition for Prometheus.

Fields

NameTypeDescription
humanizedText String!Human-readable text of the alert condition.
id ID!ID of the alert condition.

ProtectedEnvironment

Protected Environments of the environment.

Fields

NameTypeDescription
approvalRules ProtectedEnvironmentApprovalRuleConnectionWhich group, user or role is allowed to approve deployments to the environment. (see Connections)
deployAccessLevels ProtectedEnvironmentDeployAccessLevelConnectionWhich group, user or role is allowed to execute deployments to the environment. (see Connections)
group GroupGroup details. Present if it’s group-level protected environment.
name StringName of the environment if it’s a project-level protected environment. Tier of the environment if it’s a group-level protected environment.
project ProjectProject details. Present if it’s project-level protected environment.
requiredApprovalCount IntRequired approval count for Unified Approval Setting.

ProtectedEnvironmentApprovalRule

Which group, user or role is allowed to approve deployments to the environment.

Fields

NameTypeDescription
accessLevel AccessLevelRole details. Present if it’s role specific access control.
group GroupGroup details. Present if it’s group specific access control.
requiredApprovals IntNumber of required approvals.
user UserCoreUser details. Present if it’s user specific access control.

ProtectedEnvironmentApprovalRuleForSummary

Which group, user or role is allowed to approve deployments to the environment.

Fields

NameTypeDescription
accessLevel AccessLevelRole details. Present if it’s role specific access control.
approvals [DeploymentApproval!]Current approvals of the deployment.
approvedCount IntApproved count.
group GroupGroup details. Present if it’s group specific access control.
pendingApprovalCount IntPending approval count.
requiredApprovals IntNumber of required approvals.
status DeploymentApprovalSummaryStatusStatus of the approval summary.
user UserCoreUser details. Present if it’s user specific access control.

ProtectedEnvironmentDeployAccessLevel

Which group, user or role is allowed to execute deployments to the environment.

Fields

NameTypeDescription
accessLevel AccessLevelRole details. Present if it’s role specific access control.
group GroupGroup details. Present if it’s group specific access control.
user UserCoreUser details. Present if it’s user specific access control.

PushAccessLevel

Defines which user roles, users, or groups can push to a protected branch.

Fields

NameTypeDescription
accessLevel Int!GitLab::Access level.
accessLevelDescription String!Human readable representation for this access level.
group AccessLevelGroupGroup associated with this access level.
user AccessLevelUserUser associated with this access level.

PushRules

Represents rules that commit pushes must follow.

Fields

NameTypeDescription
rejectUnsignedCommits Boolean!Indicates whether commits not signed through GPG will be rejected.

PypiMetadata

Pypi metadata.

Fields

NameTypeDescription
id PackagesPypiMetadatumID!ID of the metadatum.
requiredPython StringRequired Python version of the Pypi package.

QueryComplexity

Fields

NameTypeDescription
limit IntGraphQL query complexity limit. See GitLab documentation on this limit.
score IntGraphQL query complexity score.

RecentFailures

Recent failure history of a test case.

Fields

NameTypeDescription
baseBranch StringName of the base branch of the project.
count IntNumber of times the test case has failed in the past 14 days.

Release

Represents a release.

Fields

NameTypeDescription
assets ReleaseAssetsAssets of the release.
author UserCoreUser that created the release.
commit CommitCommit associated with the release.
createdAt TimeTimestamp of when the release was created.
description StringDescription (also known as “release notes”) of the release.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
evidences ReleaseEvidenceConnectionEvidence for the release. (see Connections)
historicalRelease BooleanIndicates the release is an historical release.
id ReleaseID!Global ID of the release.
links ReleaseLinksLinks of the release.
milestones MilestoneConnectionMilestones associated to the release. (see Connections)
name StringName of the release.
releasedAt TimeTimestamp of when the release was released.
tagName StringName of the tag associated with the release.
tagPath StringRelative web path to the tag associated with the release.
upcomingRelease BooleanIndicates the release is an upcoming release.

Represents an asset link associated with a release.

Fields

NameTypeDescription
directAssetPath StringRelative path for the direct asset link.
directAssetUrl StringDirect asset URL of the link.
id ID!ID of the link.
linkType ReleaseAssetLinkTypeType of the link: other, runbook, image, package; defaults to other.
name StringName of the link.
url StringURL of the link.

ReleaseAssets

A container for all assets associated with a release.

Fields

NameTypeDescription
count IntNumber of assets of the release.
links ReleaseAssetLinkConnectionAsset links of the release. (see Connections)
sources ReleaseSourceConnectionSources of the release. (see Connections)

ReleaseEvidence

Evidence for a release.

Fields

NameTypeDescription
collectedAt TimeTimestamp when the evidence was collected.
filepath StringURL from where the evidence can be downloaded.
id ID!ID of the evidence.
sha StringSHA1 ID of the evidence hash.

Fields

NameTypeDescription
closedIssuesUrl StringHTTP URL of the issues page, filtered by this release and state=closed.
closedMergeRequestsUrl StringHTTP URL of the merge request page , filtered by this release and state=closed.
editUrl StringHTTP URL of the release’s edit page.
mergedMergeRequestsUrl StringHTTP URL of the merge request page , filtered by this release and state=merged.
openedIssuesUrl StringHTTP URL of the issues page, filtered by this release and state=open.
openedMergeRequestsUrl StringHTTP URL of the merge request page, filtered by this release and state=open.
selfUrl StringHTTP URL of the release.

ReleaseSource

Represents the source code attached to a release in a particular format.

Fields

NameTypeDescription
format StringFormat of the source.
url StringDownload URL of the source.

Repository

Fields

NameTypeDescription
diskPath StringShows a disk path of the repository.
empty Boolean!Indicates repository has no visible content.
exists Boolean!Indicates a corresponding Git repository exists on disk.
rootRef StringDefault branch of the repository.

Fields with arguments

Repository.blobs

Blobs contained within the repository.

Returns RepositoryBlobConnection.

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

Arguments
NameTypeDescription
paths [String!]!Array of desired blob paths.
ref StringCommit ref to get the blobs from. Default value is HEAD.
refType RefTypeType of ref.
Repository.branchNames

Names of branches available in this repository that match the search pattern.

Returns [String!].

Arguments
NameTypeDescription
limit Int!Number of branch names to return.
offset Int!Number of branch names to skip.
searchPattern String!Pattern to search for branch names by.
Repository.codeOwnersPath

Path to CODEOWNERS file in a ref.

Returns String.

Arguments
NameTypeDescription
ref StringName of the ref.
Repository.paginatedTree

Paginated tree of the repository.

Returns TreeConnection.

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

Arguments
NameTypeDescription
path StringPath to get the tree for. Default value is the root of the repository.
recursive BooleanUsed to get a recursive tree. Default is false.
ref StringCommit ref to get the tree for. Default value is HEAD.
refType RefTypeType of ref.
Repository.tree

Tree of the repository.

Returns Tree.

Arguments
NameTypeDescription
path StringPath to get the tree for. Default value is the root of the repository.
recursive BooleanUsed to get a recursive tree. Default is false.
ref StringCommit ref to get the tree for. Default value is HEAD.
refType RefTypeType of ref.
Repository.validateCodeownerFile

Shows linting errors in the CODEOWNER file of the repository.

Returns RepositoryCodeownerValidation.

Arguments
NameTypeDescription
ref StringRef where code owners file needs to be checked. Defaults to the repository’s default branch.

RepositoryBlob

Fields

NameTypeDescription
archived BooleanWhether the current project is archived.
blamePath StringWeb path to blob blame page.
canCurrentUserPushToBranch BooleanWhether the current user can push to the branch.
canModifyBlob BooleanWhether the current user can modify the blob.
codeNavigationPath StringWeb path for code navigation.
codeOwners [UserCore!]List of code owners for the blob.
editBlobPath StringWeb path to edit the blob in the old-style editor.
environmentExternalUrlForRouteMap StringWeb path to blob on an environment.
environmentFormattedExternalUrl StringEnvironment on which the blob is available.
externalStorage StringExternal storage being used, if enabled (for instance, ‘LFS’).
externalStorageUrl StringWeb path to download the raw blob via external storage, if enabled.
fileType StringExpected format of the blob based on the extension.
findFilePath StringWeb path to find file.
forkAndEditPath StringWeb path to edit this blob using a forked project.
forkAndViewPath StringWeb path to view this blob using a forked project.
gitpodBlobUrl StringURL to the blob within Gitpod.
historyPath StringWeb path to blob history page.
id ID!ID of the blob.
ideEditPath StringWeb path to edit this blob in the Web IDE.
ideForkAndEditPath StringWeb path to edit this blob in the Web IDE using a forked project.
language StringBlob language.
lfsOid StringLFS OID of the blob.
mode StringBlob mode.
name StringBlob name.
oid String!OID of the blob.
path String!Path of the blob.
permalinkPath StringWeb path to blob permalink.
pipelineEditorPath StringWeb path to edit .gitlab-ci.yml file.
plainData StringBlob plain highlighted data.
projectBlobPathRoot StringWeb path for the root of the blob.
rawBlob StringRaw content of the blob.
rawPath StringWeb path to download the raw blob.
rawSize BigIntSize (in bytes) of the blob, or the blob target if stored externally.
rawTextBlob StringRaw content of the blob, if the blob is text data.
replacePath StringWeb path to replace the blob content.
richViewer BlobViewerBlob content rich viewer.
simpleViewer BlobViewer!Blob content simple viewer.
size BigIntSize (in bytes) of the blob.
storedExternally BooleanWhether the blob’s content is stored externally (for instance, in LFS).
webPath StringWeb path of the blob.

RepositoryCodeownerError

Fields

NameTypeDescription
code String!Linting error code.
lines [Int!]!Lines where the error occurred.

RepositoryCodeownerValidation

Fields

NameTypeDescription
total Int!Total number of validation error in the file.
validationErrors [RepositoryCodeownerError!]!Specific lint error code.

RepositoryLanguage

Fields

NameTypeDescription
color ColorColor to visualize the repository language.
name String!Name of the repository language.
share FloatPercentage of the repository’s languages.

Requirement

Represents a requirement.

Fields

NameTypeDescription
author UserCore!Author of the requirement.
createdAt Time!Timestamp of when the requirement was created.
description StringDescription of the requirement.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
id ID!ID of the requirement.
iid ID! Deprecated in 15.8. Use work_item_iid instead.
lastTestReportManuallyCreated BooleanIndicates if latest test report was created by user.
lastTestReportState TestReportStateLatest requirement test report state.
project Project!Project to which the requirement belongs.
state RequirementState!State of the requirement.
title StringTitle of the requirement.
titleHtml StringGitLab Flavored Markdown rendering of title.
updatedAt Time!Timestamp of when the requirement was last updated.
userPermissions RequirementPermissions!Permissions for the current user on the resource.
workItemIid ID!Work item IID of the requirement, will replace current IID as identifier soon.

Fields with arguments

Requirement.testReports

Test reports of the requirement.

Returns TestReportConnection.

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

Arguments
NameTypeDescription
sort SortList test reports by sort order.

RequirementPermissions

Check permissions for the current user on a requirement.

Fields

NameTypeDescription
adminRequirement Boolean!Indicates the user can perform admin_requirement on this resource.
createRequirement Boolean!Indicates the user can perform create_requirement on this resource.
destroyRequirement Boolean!Indicates the user can perform destroy_requirement on this resource.
readRequirement Boolean!Indicates the user can perform read_requirement on this resource.
updateRequirement Boolean!Indicates the user can perform update_requirement on this resource.

RequirementStatesCount

Counts of requirements by their state.

Fields

NameTypeDescription
archived IntNumber of archived requirements.
opened IntNumber of opened requirements.

RootStorageStatistics

Fields

NameTypeDescription
buildArtifactsSize Float!CI artifacts size in bytes.
containerRegistrySize Float!Container Registry size in bytes.
containerRegistrySizeIsEstimated Boolean!Indicates whether the deduplicated Container Registry size for the namespace is an estimated value or not.
costFactoredStorageSize Float! Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Total storage in bytes with any applicable cost factor for forks applied. This will equal storage_size if there is no applicable cost factor.
dependencyProxySize Float!Dependency Proxy sizes in bytes.
lfsObjectsSize Float!LFS objects size in bytes.
packagesSize Float!Packages size in bytes.
pipelineArtifactsSize Float!CI pipeline artifacts size in bytes.
registrySizeEstimated Boolean! Deprecated in 16.2. Use container_registry_size_is_estimated.
repositorySize Float!Git repository size in bytes.
snippetsSize Float!Snippets size in bytes.
storageSize Float!Total storage in bytes.
uploadsSize Float!Uploads size in bytes.
wikiSize Float!Wiki size in bytes.

RunnerArchitecture

Fields

NameTypeDescription
downloadLocation String!Download location for the runner for the platform architecture.
name String!Name of the runner platform architecture.

RunnerPermissions

Fields

NameTypeDescription
assignRunner Boolean!Indicates the user can perform assign_runner on this resource.
deleteRunner Boolean!Indicates the user can perform delete_runner on this resource.
readRunner Boolean!Indicates the user can perform read_runner on this resource.
updateRunner Boolean!Indicates the user can perform update_runner on this resource.

RunnerPlatform

Fields

NameTypeDescription
architectures RunnerArchitectureConnectionRunner architectures supported for the platform. (see Connections)
humanReadableName String!Human readable name of the runner platform.
name String!Name slug of the runner platform.

RunnerSetup

Fields

NameTypeDescription
installInstructions String!Instructions for installing the runner on the specified architecture.
registerInstructions StringInstructions for registering the runner. The actual registration tokens are not included in the commands. Instead, a placeholder $REGISTRATION_TOKEN is shown.

SastCiConfiguration

Represents a CI configuration of SAST.

Fields

NameTypeDescription
analyzers SastCiConfigurationAnalyzersEntityConnectionList of analyzers entities attached to SAST configuration. (see Connections)
global SastCiConfigurationEntityConnectionList of global entities related to SAST configuration. (see Connections)
pipeline SastCiConfigurationEntityConnectionList of pipeline entities related to SAST configuration. (see Connections)

SastCiConfigurationAnalyzersEntity

Represents an analyzer entity in SAST CI configuration.

Fields

NameTypeDescription
description StringAnalyzer description that is displayed on the form.
enabled BooleanIndicates whether an analyzer is enabled.
label StringAnalyzer label used in the config UI.
name StringName of the analyzer.
variables SastCiConfigurationEntityConnectionList of supported variables. (see Connections)

SastCiConfigurationEntity

Represents an entity in SAST CI configuration.

Fields

NameTypeDescription
defaultValue StringDefault value that is used if value is empty.
description StringEntity description that is displayed on the form.
field StringCI keyword of entity.
label StringLabel for entity used in the form.
options SastCiConfigurationOptionsEntityConnectionDifferent possible values of the field. (see Connections)
size SastUiComponentSizeSize of the UI component.
type StringType of the field value.
value StringCurrent value of the entity.

SastCiConfigurationOptionsEntity

Represents an entity for options in SAST CI configuration.

Fields

NameTypeDescription
label StringLabel of option entity.
value StringValue of option entity.

SavedReply

Fields

NameTypeDescription
content String!Content of the saved reply.
id UsersSavedReplyID!Global ID of the saved reply.
name String!Name of the saved reply.

Scan

Represents the security scan information.

Fields

NameTypeDescription
errors [String!]!List of errors.
name String!Name of the scan.
status ScanStatus!Indicates the status of the scan.
warnings [String!]!List of warnings.

ScanExecutionPolicy

Represents the scan execution policy.

Fields

NameTypeDescription
description String!Description of the policy.
enabled Boolean!Indicates whether this policy is enabled.
name String!Name of the policy.
source SecurityPolicySource!Source of the policy. Its fields depend on the source type.
updatedAt Time!Timestamp of when the policy YAML was last updated.
yaml String!YAML definition of the policy.

ScanResultPolicy

Represents the scan result policy.

Fields

NameTypeDescription
description String!Description of the policy.
enabled Boolean!Indicates whether this policy is enabled.
groupApprovers [Group!]Approvers of the group type.
name String!Name of the policy.
roleApprovers [MemberAccessLevelName!]Approvers of the role type. Users belonging to these role(s) alone will be approvers.
source SecurityPolicySource!Source of the policy. Its fields depend on the source type.
updatedAt Time!Timestamp of when the policy YAML was last updated.
userApprovers [UserCore!]Approvers of the user type.
yaml String!YAML definition of the policy.

ScannedResource

Represents a resource scanned by a security scan.

Fields

NameTypeDescription
requestMethod StringHTTP request method used to access the URL.
url StringURL scanned by the scanner.

SecurityPolicyValidationError

Security policy validation error.

Fields

NameTypeDescription
field String!Error field.
level String!Error level.
message String!Error message.
title StringError title.

SecurityReportSummary

Represents summary of a security report.

Fields

NameTypeDescription
apiFuzzing SecurityReportSummarySectionAggregated counts for the api_fuzzing scan.
clusterImageScanning SecurityReportSummarySectionAggregated counts for the cluster_image_scanning scan.
containerScanning SecurityReportSummarySectionAggregated counts for the container_scanning scan.
coverageFuzzing SecurityReportSummarySectionAggregated counts for the coverage_fuzzing scan.
dast SecurityReportSummarySectionAggregated counts for the dast scan.
dependencyScanning SecurityReportSummarySectionAggregated counts for the dependency_scanning scan.
generic SecurityReportSummarySectionAggregated counts for the generic scan.
sast SecurityReportSummarySectionAggregated counts for the sast scan.
secretDetection SecurityReportSummarySectionAggregated counts for the secret_detection scan.

SecurityReportSummarySection

Represents a section of a summary of a security report.

Fields

NameTypeDescription
scannedResources ScannedResourceConnectionList of the first 20 scanned resources. (see Connections)
scannedResourcesCount IntTotal number of scanned resources.
scannedResourcesCsvPath StringPath to download all the scanned resources in CSV format.
scans ScanConnection!List of security scans ran for the type. (see Connections)
vulnerabilitiesCount IntTotal number of vulnerabilities.

SecurityScanners

Represents a list of security scanners.

Fields

NameTypeDescription
available [SecurityScannerType!]List of analyzers which are available for the project.
enabled [SecurityScannerType!]List of analyzers which are enabled for the project.
pipelineRun [SecurityScannerType!]List of analyzers which ran successfully in the latest pipeline.

SecurityTrainingUrl

Represents a URL related to a security training.

Fields

NameTypeDescription
identifier StringName of the vulnerability identifier.
name StringName of the training provider.
status TrainingUrlRequestStatusStatus of the request to training provider.
url StringURL of the link for security training content.

SentryDetailedError

A Sentry error.

Fields

NameTypeDescription
count Int!Count of occurrences.
culprit String!Culprit of the error.
externalBaseUrl String!External Base URL of the Sentry Instance.
externalUrl String!External URL of the error.
firstReleaseLastCommit StringCommit the error was first seen.
firstReleaseShortVersion StringRelease short version the error was first seen.
firstReleaseVersion StringRelease version the error was first seen.
firstSeen Time!Timestamp when the error was first seen.
frequency [SentryErrorFrequency!]!Last 24hr stats of the error.
gitlabCommit StringGitLab commit SHA attributed to the Error based on the release version.
gitlabCommitPath StringPath to the GitLab page for the GitLab commit attributed to the error.
gitlabIssuePath StringURL of GitLab Issue.
id ID!ID (global ID) of the error.
integrated BooleanError tracking backend.
lastReleaseLastCommit StringCommit the error was last seen.
lastReleaseShortVersion StringRelease short version the error was last seen.
lastReleaseVersion StringRelease version the error was last seen.
lastSeen Time!Timestamp when the error was last seen.
message StringSentry metadata message of the error.
sentryId String!ID (Sentry ID) of the error.
sentryProjectId ID!ID of the project (Sentry project).
sentryProjectName String!Name of the project affected by the error.
sentryProjectSlug String!Slug of the project affected by the error.
shortId String!Short ID (Sentry ID) of the error.
status SentryErrorStatus!Status of the error.
tags SentryErrorTags!Tags associated with the Sentry Error.
title String!Title of the error.
type String!Type of the error.
userCount Int!Count of users affected by the error.

SentryError

A Sentry error. A simplified version of SentryDetailedError.

Fields

NameTypeDescription
count Int!Count of occurrences.
culprit String!Culprit of the error.
externalUrl String!External URL of the error.
firstSeen Time!Timestamp when the error was first seen.
frequency [SentryErrorFrequency!]!Last 24hr stats of the error.
id ID!ID (global ID) of the error.
lastSeen Time!Timestamp when the error was last seen.
message StringSentry metadata message of the error.
sentryId String!ID (Sentry ID) of the error.
sentryProjectId ID!ID of the project (Sentry project).
sentryProjectName String!Name of the project affected by the error.
sentryProjectSlug String!Slug of the project affected by the error.
shortId String!Short ID (Sentry ID) of the error.
status SentryErrorStatus!Status of the error.
title String!Title of the error.
type String!Type of the error.
userCount Int!Count of users affected by the error.

SentryErrorCollection

An object containing a collection of Sentry errors, and a detailed error.

Fields

NameTypeDescription
externalUrl StringExternal URL for Sentry.

Fields with arguments

SentryErrorCollection.detailedError

Detailed version of a Sentry error on the project.

Returns SentryDetailedError.

Arguments
NameTypeDescription
id GitlabErrorTrackingDetailedErrorID!ID of the Sentry issue.
SentryErrorCollection.errorStackTrace

Stack Trace of Sentry Error.

Returns SentryErrorStackTrace.

Arguments
NameTypeDescription
id GitlabErrorTrackingDetailedErrorID!ID of the Sentry issue.
SentryErrorCollection.errors

Collection of Sentry Errors.

Returns SentryErrorConnection.

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

Arguments
NameTypeDescription
searchTerm StringSearch query for the Sentry error details.
sort StringAttribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default.

SentryErrorFrequency

Fields

NameTypeDescription
count Int!Count of errors received since the previously recorded time.
time Time!Time the error frequency stats were recorded.

SentryErrorStackTrace

An object containing a stack trace entry for a Sentry error.

Fields

NameTypeDescription
dateReceived String!Time the stack trace was received by Sentry.
issueId String!ID of the Sentry error.
stackTraceEntries [SentryErrorStackTraceEntry!]!Stack trace entries for the Sentry error.

SentryErrorStackTraceContext

An object context for a Sentry error stack trace.

Fields

NameTypeDescription
code String!Code number of the context.
line Int!Line number of the context.

SentryErrorStackTraceEntry

An object containing a stack trace entry for a Sentry error.

Fields

NameTypeDescription
col StringFunction in which the Sentry error occurred.
fileName StringFile in which the Sentry error occurred.
function StringFunction in which the Sentry error occurred.
line StringFunction in which the Sentry error occurred.
traceContext [SentryErrorStackTraceContext!]Context of the Sentry error.

SentryErrorTags

State of a Sentry error.

Fields

NameTypeDescription
level StringSeverity level of the Sentry Error.
logger StringLogger of the Sentry Error.

Snippet

Represents a snippet entry.

Fields

NameTypeDescription
author UserCoreOwner of the snippet.
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
createdAt Time!Timestamp this snippet was created.
description StringDescription of the snippet.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
fileName StringFile Name of the snippet.
httpUrlToRepo StringHTTP URL to the snippet repository.
id SnippetID!ID of the snippet.
notes NoteConnection!All notes on this noteable. (see Connections)
project ProjectProject the snippet is associated with.
rawUrl String!Raw URL of the snippet.
sshUrlToRepo StringSSH URL to the snippet repository.
title String!Title of the snippet.
updatedAt Time!Timestamp this snippet was updated.
userPermissions SnippetPermissions!Permissions for the current user on the resource.
visibilityLevel VisibilityLevelsEnum!Visibility Level of the snippet.
webUrl String!Web URL of the snippet.

Fields with arguments

Snippet.blobs

Snippet blobs.

Returns SnippetBlobConnection.

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

Arguments
NameTypeDescription
paths [String!]Paths of the blobs.

SnippetBlob

Represents the snippet blob.

Fields

NameTypeDescription
binary Boolean!Shows whether the blob is binary.
externalStorage StringBlob external storage.
mode StringBlob mode.
name StringBlob name.
path StringBlob path.
plainData StringBlob plain highlighted data.
rawPath String!Blob raw content endpoint path.
rawPlainData StringRaw content of the blob, if the blob is text data.
renderedAsText Boolean!Shows whether the blob is rendered as text.
richData StringBlob highlighted data.
richViewer SnippetBlobViewerBlob content rich viewer.
simpleViewer SnippetBlobViewer!Blob content simple viewer.
size Int!Blob size.

SnippetBlobViewer

Represents how the blob content should be displayed.

Fields

NameTypeDescription
collapsed Boolean!Shows whether the blob should be displayed collapsed.
fileType String!Content file type.
loadAsync Boolean!Shows whether the blob content is loaded asynchronously.
loadingPartialName String!Loading partial name.
renderError StringError rendering the blob content.
tooLarge Boolean!Shows whether the blob is too large to be displayed.
type BlobViewersType!Type of blob viewer.

SnippetPermissions

Fields

NameTypeDescription
adminSnippet Boolean!Indicates the user can perform admin_snippet on this resource.
awardEmoji Boolean!Indicates the user can perform award_emoji on this resource.
createNote Boolean!Indicates the user can perform create_note on this resource.
readSnippet Boolean!Indicates the user can perform read_snippet on this resource.
reportSnippet Boolean!Indicates the user can perform report_snippet on this resource.
updateSnippet Boolean!Indicates the user can perform update_snippet on this resource.

SnippetRepositoryRegistry

Represents the Geo sync and verification state of a snippet repository.

Fields

NameTypeDescription
createdAt TimeTimestamp when the SnippetRepositoryRegistry was created.
id ID!ID of the SnippetRepositoryRegistry.
lastSyncFailure StringError message during sync of the SnippetRepositoryRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the SnippetRepositoryRegistry.
retryAt TimeTimestamp after which the SnippetRepositoryRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the SnippetRepositoryRegistry.
snippetRepositoryId ID!ID of the Snippet Repository.
state RegistryStateSync state of the SnippetRepositoryRegistry.
verificationRetryAt TimeTimestamp after which the SnippetRepositoryRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the SnippetRepositoryRegistry.

SshSignature

SSH signature for a signed commit.

Fields

NameTypeDescription
commitSha StringSHA of the associated commit.
key KeySSH key used for the signature.
keyFingerprintSha256 StringFingerprint of the key.
project ProjectProject of the associated commit.
user UserCoreUser associated with the key.
verificationStatus VerificationStatusIndicates verification status of the associated key or certificate.

StatusAction

Fields

NameTypeDescription
buttonTitle StringTitle for the button, for example: Retry this job.
icon StringIcon used in the action button.
id String!ID for a status action.
method StringMethod for the action, for example: :post.
path StringPath for the action.
title StringTitle for the action, for example: Retry.

Submodule

Fields

NameTypeDescription
flatPath String!Flat path of the entry.
id ID!ID of the entry.
name String!Name of the entry.
path String!Path of the entry.
sha String!Last commit SHA for the entry.
treeUrl StringTree URL for the sub-module.
type EntryType!Type of tree entry.
webUrl StringWeb URL for the sub-module.

SubscriptionFutureEntry

Represents an entry from the future subscriptions.

Fields

NameTypeDescription
company StringCompany of the licensee.
email StringEmail of the licensee.
expiresAt DateDate when the license expires.
name StringName of the licensee.
plan String!Name of the subscription plan.
startsAt DateDate when the license started.
type String!Type of license the subscription will yield.
usersInLicenseCount IntNumber of paid user seats.

SuggestedReviewersType

Represents a Suggested Reviewers result set.

Fields

NameTypeDescription
accepted [String!]List of accepted reviewer usernames.
createdAt Time!Timestamp of when the suggestions were created.
suggested [String!]!List of suggested reviewer usernames.
updatedAt Time!Timestamp of when the suggestions were updated.

SystemNoteMetadata

Fields

NameTypeDescription
action StringSystem note metadata action.
descriptionVersion DescriptionVersionVersion of the changed description.
id SystemNoteMetadataID!Global ID of the specific system note metadata.

TaskCompletionStatus

Completion status of tasks.

Fields

NameTypeDescription
completedCount Int!Number of completed tasks.
count Int!Number of total tasks.

TerraformState

Fields

NameTypeDescription
createdAt Time!Timestamp the Terraform state was created.
deletedAt TimeTimestamp the Terraform state was deleted.
id ID!ID of the Terraform state.
latestVersion TerraformStateVersionLatest version of the Terraform state.
lockedAt TimeTimestamp the Terraform state was locked.
lockedByUser UserCoreUser currently holding a lock on the Terraform state.
name String!Name of the Terraform state.
updatedAt Time!Timestamp the Terraform state was updated.

TerraformStateVersion

Fields

NameTypeDescription
createdAt Time!Timestamp the version was created.
createdByUser UserCoreUser that created this version.
downloadPath StringURL for downloading the version’s JSON file.
id ID!ID of the Terraform state version.
job CiJobJob that created this version.
serial IntSerial number of the version.
updatedAt Time!Timestamp the version was updated.

TerraformStateVersionRegistry

Represents the Geo sync and verification state of a terraform state version.

Fields

NameTypeDescription
createdAt TimeTimestamp when the TerraformStateVersionRegistry was created.
id ID!ID of the TerraformStateVersionRegistry.
lastSyncFailure StringError message during sync of the TerraformStateVersionRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the TerraformStateVersionRegistry.
retryAt TimeTimestamp after which the TerraformStateVersionRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the TerraformStateVersionRegistry.
state RegistryStateSync state of the TerraformStateVersionRegistry.
terraformStateVersionId ID!ID of the terraform state version.
verificationRetryAt TimeTimestamp after which the TerraformStateVersionRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the TerraformStateVersionRegistry.

TestCase

Test case in pipeline test report.

Fields

NameTypeDescription
attachmentUrl StringURL of the test case attachment file.
classname StringClassname of the test case.
executionTime FloatTest case execution time in seconds.
file StringPath to the file of the test case.
name StringName of the test case.
recentFailures RecentFailuresRecent failure history of the test case on the base branch.
stackTrace StringStack trace of the test case.
status TestCaseStatusStatus of the test case (error, failed, success, skipped).
systemOutput StringSystem output of the test case.

TestReport

Represents a requirement test report.

Fields

NameTypeDescription
author UserCoreAuthor of the test report.
createdAt Time!Timestamp of when the test report was created.
id ID!ID of the test report.
state TestReportState!State of the test report.
usesLegacyIid BooleanIndicates whether the test report was generated with references to legacy requirement IIDs.

TestReportSummary

Test report for a pipeline.

Fields

NameTypeDescription
testSuites TestSuiteSummaryConnection!Test suites belonging to a pipeline test report. (see Connections)
total TestReportTotal!Total report statistics for a pipeline test report.

TestReportTotal

Total test report statistics.

Fields

NameTypeDescription
count IntTotal number of the test cases.
error IntTotal number of test cases that had an error.
failed IntTotal number of test cases that failed.
skipped IntTotal number of test cases that were skipped.
success IntTotal number of test cases that succeeded.
suiteError StringTest suite error message.
time FloatTotal duration of the tests.

TestSuite

Test suite in a pipeline test report.

Fields

NameTypeDescription
errorCount IntTotal number of test cases that had an error.
failedCount IntTotal number of test cases that failed in the test suite.
name StringName of the test suite.
skippedCount IntTotal number of test cases that were skipped in the test suite.
successCount IntTotal number of test cases that succeeded in the test suite.
suiteError StringTest suite error message.
testCases TestCaseConnectionTest cases in the test suite. (see Connections)
totalCount IntTotal number of the test cases in the test suite.
totalTime FloatTotal duration of the tests in the test suite.

TestSuiteSummary

Test suite summary in a pipeline test report.

Fields

NameTypeDescription
buildIds [ID!]IDs of the builds used to run the test suite.
errorCount IntTotal number of test cases that had an error.
failedCount IntTotal number of test cases that failed in the test suite.
name StringName of the test suite.
skippedCount IntTotal number of test cases that were skipped in the test suite.
successCount IntTotal number of test cases that succeeded in the test suite.
suiteError StringTest suite error message.
totalCount IntTotal number of the test cases in the test suite.
totalTime FloatTotal duration of the tests in the test suite.

TimeReportStats

Represents the time report stats for timeboxes.

Fields

NameTypeDescription
complete TimeboxMetricsCompleted issues metrics.
incomplete TimeboxMetricsIncomplete issues metrics.
total TimeboxMetricsTotal issues metrics.

TimeTrackingTimelogCategory

Fields

NameTypeDescription
billable BooleanWhether the category is billable or not.
billingRate FloatBilling rate for the category.
color ColorColor assigned to the category.
createdAt Time!When the category was created.
description StringDescription of the category.
id ID!Internal ID of the timelog category.
name String!Name of the category.
updatedAt Time!When the category was last updated.

TimeboxMetrics

Represents measured stats metrics for timeboxes.

Fields

NameTypeDescription
count Int!Count metric.
weight Int!Weight metric.

TimeboxReport

Represents a historically accurate report about the timebox.

Fields

NameTypeDescription
burnupTimeSeries [BurnupChartDailyTotals!]Daily scope and completed totals for burnup charts.
error TimeboxReportErrorIf the report cannot be generated, information about why.
stats TimeReportStatsRepresents the time report stats for the timebox.

TimeboxReportError

Explains why we could not generate a timebox report.

Fields

NameTypeDescription
code TimeboxReportErrorReasonMachine readable code, categorizing the error.
message StringHuman readable message explaining what happened.

TimelineEventTagType

Describes a tag on an incident management timeline event.

Fields

NameTypeDescription
id IncidentManagementTimelineEventTagID!ID of the timeline event tag.
name String!Name of the timeline event tag.

TimelineEventType

Describes an incident management timeline event.

Fields

NameTypeDescription
action String!Indicates the timeline event icon.
author UserCoreUser that created the timeline event.
createdAt Time!Timestamp when the event created.
editable Boolean!Indicates the timeline event is editable.
id IncidentManagementTimelineEventID!ID of the timeline event.
incident Issue!Incident of the timeline event.
note StringText note of the timeline event.
noteHtml StringHTML note of the timeline event.
occurredAt Time!Timestamp when the event occurred.
promotedFromNote NoteNote from which the timeline event was created.
timelineEventTags TimelineEventTagTypeConnectionTags for the incident timeline event. (see Connections)
updatedAt Time!Timestamp when the event updated.
updatedByUser UserCoreUser that updated the timeline event.

Timelog

Fields

NameTypeDescription
id ID!Internal ID of the timelog.
issue IssueIssue that logged time was added to.
mergeRequest MergeRequestMerge request that logged time was added to.
note NoteNote where the quick action was executed to add the logged time.
project Project!Target project of the timelog merge request or issue.
spentAt TimeTimestamp of when the time tracked was spent at.
summary StringSummary of how the time was spent.
timeSpent Int!Time spent displayed in seconds.
user UserCore!User that logged the time.
userPermissions TimelogPermissions!Permissions for the current user on the resource.

TimelogPermissions

Fields

NameTypeDescription
adminTimelog Boolean!Indicates the user can perform admin_timelog on this resource.

Todo

Representing a to-do entry.

Fields

NameTypeDescription
action TodoActionEnum!Action of the to-do item.
author UserCore!Author of this to-do item.
body String!Body of the to-do item.
createdAt Time!Timestamp this to-do item was created.
group GroupGroup this to-do item is associated with.
id ID!ID of the to-do item.
note NoteNote which created this to-do item.
project ProjectProject this to-do item is associated with.
state TodoStateEnum!State of the to-do item.
target Todoable!Target of the to-do item.
targetType TodoTargetEnum!Target type of the to-do item.

Topic

Fields

NameTypeDescription
avatarUrl StringURL to avatar image file of the topic.
description StringDescription of the topic.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
id ID!ID of the topic.
name String!Name of the topic.
title String!Title of the topic.

Tree

Fields

NameTypeDescription
blobs BlobConnection!Blobs of the tree. (see Connections)
lastCommit CommitLast commit for the tree.
submodules SubmoduleConnection!Sub-modules of the tree. (see Connections)
trees TreeEntryConnection!Trees of the tree. (see Connections)

TreeEntry

Represents a directory.

Fields

NameTypeDescription
flatPath String!Flat path of the entry.
id ID!ID of the entry.
name String!Name of the entry.
path String!Path of the entry.
sha String!Last commit SHA for the entry.
type EntryType!Type of tree entry.
webPath StringWeb path for the tree entry (directory).
webUrl StringWeb URL for the tree entry (directory).

UnprotectAccessLevel

Defines which user roles, users, or groups can unprotect a protected branch.

Fields

NameTypeDescription
accessLevel Int!GitLab::Access level.
accessLevelDescription String!Human readable representation for this access level.
group AccessLevelGroupGroup associated with this access level.
user AccessLevelUserUser associated with this access level.

UploadRegistry

Represents the Geo replication and verification state of an upload.

Fields

NameTypeDescription
createdAt TimeTimestamp when the UploadRegistry was created.
fileId ID!ID of the Upload.
id ID!ID of the UploadRegistry.
lastSyncFailure StringError message during sync of the UploadRegistry.
lastSyncedAt TimeTimestamp of the most recent successful sync of the UploadRegistry.
retryAt TimeTimestamp after which the UploadRegistry is resynced.
retryCount IntNumber of consecutive failed sync attempts of the UploadRegistry.
state RegistryStateSync state of the UploadRegistry.
verificationRetryAt TimeTimestamp after which the UploadRegistry is reverified.
verifiedAt TimeTimestamp of the most recent successful verification of the UploadRegistry.

UsageTrendsMeasurement

Represents a recorded measurement (object count) for the Admins.

Fields

NameTypeDescription
count Int!Object count.
identifier MeasurementIdentifier!Type of objects being measured.
recordedAt TimeTime the measurement was recorded.

UserAchievement

Fields

NameTypeDescription
achievement Achievement!Achievement awarded.
awardedByUser UserCore!Awarded by.
createdAt Time!Timestamp the achievement was created.
id AchievementsUserAchievementID!ID of the user achievement.
revokedAt TimeTimestamp the achievement was revoked.
revokedByUser UserCoreRevoked by.
updatedAt Time!Timestamp the achievement was last updated.
user UserCore!Achievement recipient.

UserCallout

Fields

NameTypeDescription
dismissedAt TimeDate when the callout was dismissed.
featureName UserCalloutFeatureNameEnumName of the feature that the callout is for.

UserCore

Core represention of a GitLab user.

Fields

NameTypeDescription
avatarUrl StringURL of the user’s avatar.
bio StringBio of the user.
bot Boolean!Indicates if the user is a bot.
callouts UserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmail StringUser’s default commit email.
createdAt TimeTimestamp of when the user was created.
discord StringDiscord ID of the user.
email String Deprecated in 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnectionUser’s email addresses. (see Connections)
gitpodEnabled BooleanWhether Gitpod is enabled at the user level.
groupCount IntGroup count for the user.
groupMemberships GroupMemberConnectionGroup memberships of the user. (see Connections)
id ID!ID of the user.
ide IdeIDE settings.
jobTitle StringJob title of the user.
linkedin StringLinkedIn profile name of the user.
location StringLocation of the user.
name String!Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace NamespacePersonal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organization StringWho the user represents or works for.
preferencesGitpodPath StringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPath StringWeb path to enable Gitpod for the user.
projectMemberships ProjectMemberConnectionProject memberships of the user. (see Connections)
pronouns StringPronouns of the user.
publicEmail StringUser’s public email.
savedReplies SavedReplyConnectionSaved replies authored by the user. Will not return saved replies if saved_replies feature flag is disabled. (see Connections)
state UserState!State of the user.
status UserStatusUser status.
twitter StringTwitter username of the user.
userAchievements UserAchievementConnection Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
userPermissions UserPermissions!Permissions for the current user on the resource.
username String!Username of the user. Unique within this instance of GitLab.
webPath String!Web path of the user.
webUrl String!Web URL of the user.

Fields with arguments

UserCore.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
UserCore.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
UserCore.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScope GroupPermissionFilter by permissions the user has on groups.
search StringSearch by group name or path.
UserCore.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
UserCore.savedReply

Saved reply authored by the user. Will not return saved reply if saved_replies feature flag is disabled.

Returns SavedReply.

Arguments
NameTypeDescription
id UsersSavedReplyID!ID of a saved reply.
UserCore.snippets

Snippets authored by the 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
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnumType of snippet.
visibility VisibilityScopesEnumVisibility of the snippet.
UserCore.starredProjects

Projects starred by the 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
search StringSearch query.
UserCore.timelogs

Time logged by the 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.
UserCore.todos

To-do items of the user.

Returns TodoConnection.

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

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.
state [TodoStateEnum!]State of the todo.
type [TodoTargetEnum!]Type of the todo.
UserCore.workspaces

Workspaces owned by the current user.

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.

UserMergeRequestInteraction

Information about a merge request given a specific user.

This object has two parts to its state: a User and a MergeRequest. All fields relate to interactions between the two entities.

Fields

NameTypeDescription
applicableApprovalRules [ApprovalRule!]Approval rules that apply to this user for this merge request.
approved Boolean!Whether this user has approved this merge request.
canMerge Boolean!Whether this user can merge this merge request.
canUpdate Boolean!Whether this user can update this merge request.
reviewState MergeRequestReviewStateState of the review by this user.
reviewed Boolean!Whether this user has provided a review for this merge request.

UserPermissions

Fields

NameTypeDescription
createSnippet Boolean!Indicates the user can perform create_snippet on this resource.

UserPreferences

Fields

NameTypeDescription
issuesSort IssueSortSort order for issue lists.
visibilityPipelineIdType VisibilityPipelineIdTypeDetermines whether the pipeline list shows ID or IID.

UserStatus

Fields

NameTypeDescription
availability AvailabilityEnum!User availability status.
emoji StringString representation of emoji.
message StringUser status message.
messageHtml StringHTML of the user status message.

ValueStreamAnalyticsMetric

Fields

NameTypeDescription
identifier String!Identifier for the metric.
links [ValueStreamMetricLinkType!]!Optional links for drilling down.
title String!Title for the metric.
unit StringUnit of measurement.
value FloatValue for the metric.

ValueStreamMetricLinkType

Fields

NameTypeDescription
docsLink BooleanLink to the metric documentation.
label String!Label for the link.
name String!Name of the link group.
url String!Drill-down URL.

VulnerabilitiesCountByDay

Represents the count of vulnerabilities by severity on a particular day. This data is retained for 365 days.

Fields

NameTypeDescription
critical Int!Total number of vulnerabilities on a particular day with critical severity.
date ISO8601Date!Date for the count.
high Int!Total number of vulnerabilities on a particular day with high severity.
info Int!Total number of vulnerabilities on a particular day with info severity.
low Int!Total number of vulnerabilities on a particular day with low severity.
medium Int!Total number of vulnerabilities on a particular day with medium severity.
total Int!Total number of vulnerabilities on a particular day.
unknown Int!Total number of vulnerabilities on a particular day with unknown severity.

Vulnerability

Represents a vulnerability.

Fields

NameTypeDescription
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
confirmedAt TimeTimestamp of when the vulnerability state was changed to confirmed.
confirmedBy UserCoreUser that confirmed the vulnerability.
description StringDescription of the vulnerability.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
details [VulnerabilityDetail!]!Details of the vulnerability.
detectedAt Time!Timestamp of when the vulnerability was first detected.
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
dismissalReason VulnerabilityDismissalReasonReason for dismissal. Returns null if expose_dismissal_reasonfeature flag is disabled.
dismissedAt TimeTimestamp of when the vulnerability state was changed to dismissed.
dismissedBy UserCoreUser that dismissed the vulnerability.
externalIssueLinks VulnerabilityExternalIssueLinkConnection!List of external issue links related to the vulnerability. (see Connections)
falsePositive BooleanIndicates whether the vulnerability is a false positive.
hasSolutions BooleanIndicates whether there is a solution available for this vulnerability.
id ID!GraphQL ID of the vulnerability.
identifiers [VulnerabilityIdentifier!]!Identifiers of the vulnerability.
links [VulnerabilityLink!]!List of links associated with the vulnerability.
location VulnerabilityLocationLocation metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability.
mergeRequest MergeRequestMerge request that fixes the vulnerability.
message String Deprecated in 16.1. message field has been removed from security reports schema.
notes NoteConnection!All notes on this noteable. (see Connections)
primaryIdentifier VulnerabilityIdentifierPrimary identifier of the vulnerability.
project ProjectProject on which the vulnerability was found.
reportType VulnerabilityReportTypeType of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING, CLUSTER_IMAGE_SCANNING, GENERIC). Scan Type in the UI.
resolvedAt TimeTimestamp of when the vulnerability state was changed to resolved.
resolvedBy UserCoreUser that resolved the vulnerability.
resolvedOnDefaultBranch Boolean!Indicates whether the vulnerability is fixed on the default branch or not.
scanner VulnerabilityScannerScanner metadata for the vulnerability.
severity VulnerabilitySeveritySeverity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL).
state VulnerabilityStateState of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED).
stateComment StringComment given for the vulnerability state change.
stateTransitions VulnerabilityStateTransitionTypeConnectionList of state transitions related to the vulnerability. (see Connections)
title StringTitle of the vulnerability.
updatedAt TimeTimestamp of when the vulnerability was last updated.
userNotesCount Int!Number of user notes attached to the vulnerability.
userPermissions VulnerabilityPermissions!Permissions for the current user on the resource.
vulnerabilityPath StringPath to the vulnerability’s details page.
webUrl StringURL to the vulnerability’s details page.

Fields with arguments

List of issue links related to the vulnerability.

Returns VulnerabilityIssueLinkConnection!.

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

Arguments
NameTypeDescription
linkType VulnerabilityIssueLinkTypeFilter issue links by link type.

VulnerabilityContainerImage

Represents a container image reported on the related vulnerability.

Fields

NameTypeDescription
name StringName of the container image.

VulnerabilityDetailBase

Represents the vulnerability details base.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.

VulnerabilityDetailBoolean

Represents the vulnerability details boolean value.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.
value Boolean!Value of the field.

VulnerabilityDetailCode

Represents the vulnerability details code field.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
lang StringLanguage of the code.
name StringName of the field.
value String!Source code.

VulnerabilityDetailCommit

Represents the vulnerability details commit field.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.
value String!Commit SHA value.

VulnerabilityDetailDiff

Represents the vulnerability details diff field.

Fields

NameTypeDescription
after String!Value of the field after the change.
before String!Value of the field before the change.
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.

VulnerabilityDetailFileLocation

Represents the vulnerability details location within a file in the project.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
fileName String!File name.
lineEnd Int!End line number of the file location.
lineStart Int!Start line number of the file location.
name StringName of the field.

VulnerabilityDetailInt

Represents the vulnerability details integer value.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.
value Int!Value of the field.

VulnerabilityDetailList

Represents the vulnerability details list value.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
items [VulnerabilityDetail!]!List of details.
name StringName of the field.

VulnerabilityDetailMarkdown

Represents the vulnerability details Markdown field.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.
value String!Value of the Markdown field.

VulnerabilityDetailModuleLocation

Represents the vulnerability details location within a file in the project.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
moduleName String!Module name.
name StringName of the field.
offset Int!Offset of the module location.

VulnerabilityDetailNamedList

Represents the vulnerability details named list.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
items [VulnerabilityDetailNamedListItem!]! Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Named list of details.
name StringName of the field.

VulnerabilityDetailNamedListItem

Represents the vulnerability details named list item.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.
value VulnerabilityDetail! Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Value of the field.

VulnerabilityDetailRow

Represents an individual row in a table.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.
row [VulnerabilityDetail!]!Value of the field.

VulnerabilityDetailTable

Represents the vulnerability details table value.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
headers [VulnerabilityDetail!]!Table headers.
name StringName of the field.
rows [VulnerabilityDetailRow!]!Table rows.

VulnerabilityDetailText

Represents the vulnerability details text field.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
name StringName of the field.
value String!Value of the text field.

VulnerabilityDetailUrl

Represents the vulnerability details URL field.

Fields

NameTypeDescription
description StringDescription of the field.
fieldName StringName of the field.
href String!Href of the URL.
name StringName of the field.
text StringText of the URL.

VulnerabilityEvidence

Represents a Vulnerability Evidence.

Fields

NameTypeDescription
request VulnerabilityRequestHTTP request of the Vulnerability Evidence.
response VulnerabilityResponseHTTP response of the Vulnerability Evidence.
source VulnerabilityEvidenceSourceSource of the Vulnerability Evidence.
summary StringSummary of the Vulnerability Evidence.
supportingMessages [VulnerabilityEvidenceSupportingMessage!]Supporting messages of the Vulnerability Evidence.

VulnerabilityEvidenceSource

Represents a vulnerability evidence.

Fields

NameTypeDescription
identifier String!ID of the Vulnerability Evidence Source.
name String!Name of the Vulnerability Evidence Source.
url StringURL of the Vulnerability Evidence Source.

VulnerabilityEvidenceSupportingMessage

Represents a vulnerability evidence supporting message.

Fields

NameTypeDescription
name String!Name of the vulnerability supporting message.
request VulnerabilityRequestHTTP request of the vulnerability evidence supporting message.
response VulnerabilityResponseHTTP response of the vulnerability evidence supporting message.

Represents an external issue link of a vulnerability.

Fields

NameTypeDescription
externalIssue ExternalIssueThe external issue attached to the issue link.
id VulnerabilitiesExternalIssueLinkID!GraphQL ID of the external issue link.
linkType VulnerabilityExternalIssueLinkType!Type of the external issue link.

VulnerabilityIdentifier

Represents a vulnerability identifier.

Fields

NameTypeDescription
externalId StringExternal ID of the vulnerability identifier.
externalType StringExternal type of the vulnerability identifier.
name StringName of the vulnerability identifier.
url StringURL of the vulnerability identifier.

Represents an issue link of a vulnerability.

Fields

NameTypeDescription
id ID!GraphQL ID of the vulnerability.
issue IssueIssue attached to issue link.
linkType VulnerabilityIssueLinkType!Type of the issue link.

Represents a link related to a vulnerability.

Fields

NameTypeDescription
name StringName of the link.
url String!URL of the link.

VulnerabilityLocationClusterImageScanning

Represents the location of a vulnerability found by a cluster image scan.

Fields

NameTypeDescription
dependency VulnerableDependencyDependency containing the vulnerability.
image StringName of the vulnerable container image.
kubernetesResource VulnerableKubernetesResourceKubernetes resource which uses the vulnerable container image.
operatingSystem StringOperating system that runs on the vulnerable container image.

VulnerabilityLocationContainerScanning

Represents the location of a vulnerability found by a container security scan.

Fields

NameTypeDescription
dependency VulnerableDependencyDependency containing the vulnerability.
image StringName of the vulnerable container image.
operatingSystem StringOperating system that runs on the vulnerable container image.

VulnerabilityLocationCoverageFuzzing

Represents the location of a vulnerability found by a Coverage Fuzzing scan.

Fields

NameTypeDescription
blobPath StringBlob path to the vulnerable file.
crashAddress StringRelative address in memory were the crash occurred.
crashType StringType of the crash.
endLine StringNumber of the last relevant line in the vulnerable file.
file StringPath to the vulnerable file.
stacktraceSnippet StringStack trace recorded during fuzzing resulting the crash.
startLine StringNumber of the first relevant line in the vulnerable file.
vulnerableClass StringClass containing the vulnerability.
vulnerableMethod StringMethod containing the vulnerability.

VulnerabilityLocationDast

Represents the location of a vulnerability found by a DAST scan.

Fields

NameTypeDescription
hostname StringDomain name of the vulnerable request.
param StringQuery parameter for the URL on which the vulnerability occurred.
path StringURL path and query string of the vulnerable request.
requestMethod StringHTTP method of the vulnerable request.

VulnerabilityLocationDependencyScanning

Represents the location of a vulnerability found by a dependency security scan.

Fields

NameTypeDescription
blobPath StringBlob path to the vulnerable file.
dependency VulnerableDependencyDependency containing the vulnerability.
file StringPath to the vulnerable file.

VulnerabilityLocationGeneric

Represents the location of a vulnerability found by a generic scanner.

Fields

NameTypeDescription
description StringFree-form description of where the vulnerability is located.

VulnerabilityLocationSast

Represents the location of a vulnerability found by a SAST scan.

Fields

NameTypeDescription
blobPath StringBlob path to the vulnerable file.
endLine StringNumber of the last relevant line in the vulnerable file.
file StringPath to the vulnerable file.
startLine StringNumber of the first relevant line in the vulnerable file.
vulnerableClass StringClass containing the vulnerability.
vulnerableMethod StringMethod containing the vulnerability.

VulnerabilityLocationSecretDetection

Represents the location of a vulnerability found by a secret detection scan.

Fields

NameTypeDescription
blobPath StringBlob path to the vulnerable file.
endLine StringNumber of the last relevant line in the vulnerable file.
file StringPath to the vulnerable file.
startLine StringNumber of the first relevant line in the vulnerable file.
vulnerableClass StringClass containing the vulnerability.
vulnerableMethod StringMethod containing the vulnerability.

VulnerabilityPermissions

Check permissions for the current user on a vulnerability.

Fields

NameTypeDescription
adminVulnerability Boolean!Indicates the user can perform admin_vulnerability on this resource.
adminVulnerabilityExternalIssueLink Boolean!Indicates the user can perform admin_vulnerability_external_issue_link on this resource.
adminVulnerabilityIssueLink Boolean!Indicates the user can perform admin_vulnerability_issue_link on this resource.
createVulnerabilityExport Boolean!Indicates the user can perform create_vulnerability_export on this resource.
createVulnerabilityFeedback Boolean!Indicates the user can perform create_vulnerability_feedback on this resource.
destroyVulnerabilityFeedback Boolean!Indicates the user can perform destroy_vulnerability_feedback on this resource.
readVulnerability Boolean!Indicates the user can perform read_vulnerability on this resource.
readVulnerabilityFeedback Boolean!Indicates the user can perform read_vulnerability_feedback on this resource.
updateVulnerabilityFeedback Boolean!Indicates the user can perform update_vulnerability_feedback on this resource.

VulnerabilityRemediationType

Represents a vulnerability remediation type.

Fields

NameTypeDescription
diff StringDiff of the remediation.
summary StringSummary of the remediation.

VulnerabilityRequest

Represents a Vulnerability Request.

Fields

NameTypeDescription
body StringBody of the Vulnerability Request.
headers [VulnerabilityRequestResponseHeader!]!HTTP headers of the Vulnerability Request.
method StringMethod of the Vulnerability Request.
url StringURL of the Vulnerability Request.

VulnerabilityRequestResponseHeader

Represents a Vulnerability Request/Response Header.

Fields

NameTypeDescription
name StringName of the Vulnerability Request/Response Header.
value StringValue of the Vulnerability Request/Response Header.

VulnerabilityResponse

Represents a Vulnerability Response.

Fields

NameTypeDescription
body StringBody of the Vulnerability Response.
headers [VulnerabilityRequestResponseHeader!]!HTTP headers of the Vulnerability Response.
reasonPhrase StringReason Phrase of the Vulnerability Response.
statusCode IntStatus Code of the Vulnerability Response.

VulnerabilityScanner

Represents a vulnerability scanner.

Fields

NameTypeDescription
externalId StringExternal ID of the vulnerability scanner.
id IDID of the scanner.
name StringName of the vulnerability scanner.
reportType VulnerabilityReportTypeType of the vulnerability report.
reportTypeHumanized StringHumanized type of the vulnerability report.
vendor StringVendor of the vulnerability scanner.

VulnerabilitySeveritiesCount

Represents vulnerability counts by severity.

Fields

NameTypeDescription
critical IntNumber of vulnerabilities of CRITICAL severity of the project.
high IntNumber of vulnerabilities of HIGH severity of the project.
info IntNumber of vulnerabilities of INFO severity of the project.
low IntNumber of vulnerabilities of LOW severity of the project.
medium IntNumber of vulnerabilities of MEDIUM severity of the project.
unknown IntNumber of vulnerabilities of UNKNOWN severity of the project.

VulnerabilityStateTransitionType

Represents a state transition of a vulnerability.

Fields

NameTypeDescription
author UserCoreUser who changed the state of the vulnerability.
comment StringComment for the state change.
createdAt Time!Time of the state change of the vulnerability.
dismissalReason VulnerabilityDismissalReasonReason for the dismissal.
fromState VulnerabilityState!State of the vulnerability before transition.
toState VulnerabilityState!State of the vulnerability after transition.

VulnerableDependency

Represents a vulnerable dependency. Used in vulnerability location data.

Fields

NameTypeDescription
package VulnerablePackagePackage associated with the vulnerable dependency.
version StringVersion of the vulnerable dependency.

VulnerableKubernetesResource

Represents a vulnerable Kubernetes resource. Used in vulnerability location data.

Fields

NameTypeDescription
agent ClusterAgentKubernetes Agent which performed the scan.
clusterId ClustersClusterIDID of the Cluster integration which was used to perform the scan.
containerName String!Name of the container that had its image scanned.
kind String!Kind of the Kubernetes resource.
name String!Name of the Kubernetes resource.
namespace String!Kubernetes namespace which the resource resides in.

VulnerablePackage

Represents a vulnerable package. Used in vulnerability dependency data.

Fields

NameTypeDescription
name StringName of the vulnerable package.

VulnerableProjectsByGrade

Represents vulnerability letter grades with associated projects.

Fields

NameTypeDescription
count Int!Number of projects within this grade.
grade VulnerabilityGrade!Grade based on the highest severity vulnerability present.
projects ProjectConnection!Projects within this grade. (see Connections)

WorkItem

Fields

NameTypeDescription
author UserCore Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. User that created the work item.
closedAt TimeTimestamp of when the work item was closed.
confidential Boolean!Indicates the work item is confidential.
createNoteEmail StringUser specific email address for the work item.
createdAt Time!Timestamp of when the work item was created.
description StringDescription of the work item.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
id WorkItemID!Global ID of the work item.
iid ID!Internal ID of the work item.
lockVersion Int!Lock version of the work item. Incremented each time the work item is updated.
namespace Namespace Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Namespace the work item belongs to.
project Project Introduced in 15.3. This feature is an Experiment. It can be changed or removed at any time. Project the work item belongs to.
state WorkItemState!State of the work item.
title String!Title of the work item.
titleHtml StringGitLab Flavored Markdown rendering of title.
updatedAt Time!Timestamp of when the work item was last updated.
userPermissions WorkItemPermissions!Permissions for the current user on the resource.
webUrl StringURL of this object.
widgets [WorkItemWidget!]Collection of widgets that belong to the work item.
workItemType WorkItemType!Type assigned to the work item.

Fields with arguments

WorkItem.reference

Internal reference of the work item. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
full BooleanBoolean option specifying whether the reference should be returned in full.

WorkItemPermissions

Check permissions for the current user on a work item.

Fields

NameTypeDescription
adminParentLink Boolean!Indicates the user can perform admin_parent_link on this resource.
adminWorkItem Boolean!Indicates the user can perform admin_work_item on this resource.
createNote Boolean!Indicates the user can perform create_note on this resource.
deleteWorkItem Boolean!Indicates the user can perform delete_work_item on this resource.
readWorkItem Boolean!Indicates the user can perform read_work_item on this resource.
setWorkItemMetadata Boolean!Indicates the user can perform set_work_item_metadata on this resource.
updateWorkItem Boolean!Indicates the user can perform update_work_item on this resource.

WorkItemType

Fields

NameTypeDescription
iconName StringIcon name of the work item type.
id WorkItemsTypeID!Global ID of the work item type.
name String!Name of the work item type.

WorkItemWidgetAssignees

Represents an assignees widget.

Fields

NameTypeDescription
allowsMultipleAssignees BooleanIndicates whether multiple assignees are allowed.
assignees UserCoreConnectionAssignees of the work item. (see Connections)
canInviteMembers Boolean!Indicates whether the current user can invite members to the work item’s project.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetAwardEmoji

Represents the award emoji widget.

Fields

NameTypeDescription
awardEmoji AwardEmojiConnectionAward emoji on the work item. (see Connections)
downvotes Int!Number of downvotes the work item has received.
type WorkItemWidgetTypeWidget type.
upvotes Int!Number of upvotes the work item has received.

WorkItemWidgetCurrentUserTodos

Represents a todos widget.

Fields

NameTypeDescription
type WorkItemWidgetTypeWidget type.

Fields with arguments

WorkItemWidgetCurrentUserTodos.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
state TodoStateEnumState of the to-do items.

WorkItemWidgetDescription

Represents a description widget.

Fields

NameTypeDescription
description StringDescription of the work item.
descriptionHtml StringGitLab Flavored Markdown rendering of description.
edited Boolean!Whether the description has been edited since the work item was created.
lastEditedAt TimeTimestamp of when the work item’s description was last edited.
lastEditedBy UserCoreUser that made the last edit to the work item’s description.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetHealthStatus

Represents a health status widget.

Fields

NameTypeDescription
healthStatus HealthStatusHealth status of the work item.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetHierarchy

Represents a hierarchy widget.

Fields

NameTypeDescription
children WorkItemConnectionChild work items. (see Connections)
hasChildren Boolean!Indicates if the work item has children.
parent WorkItemParent work item.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetIteration

Represents an iteration widget.

Fields

NameTypeDescription
iteration IterationIteration of the work item.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetLabels

Represents the labels widget.

Fields

NameTypeDescription
allowsScopedLabels BooleanIndicates whether a scoped label is allowed.
labels LabelConnectionLabels assigned to the work item. (see Connections)
type WorkItemWidgetTypeWidget type.

WorkItemWidgetMilestone

Represents a milestone widget.

Fields

NameTypeDescription
milestone MilestoneMilestone of the work item.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetNotes

Represents a notes widget.

Fields

NameTypeDescription
type WorkItemWidgetTypeWidget type.

Fields with arguments

WorkItemWidgetNotes.discussions

Notes on this work item.

Returns DiscussionConnection.

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

Arguments
NameTypeDescription
filter NotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.

WorkItemWidgetNotifications

Represents the notifications widget.

Fields

NameTypeDescription
subscribed Boolean!Whether the current user is subscribed to notifications on the work item.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetProgress

Represents a progress widget.

Fields

NameTypeDescription
progress IntProgress of the work item.
type WorkItemWidgetTypeWidget type.
updatedAt TimeTimestamp of last progress update.

WorkItemWidgetRequirementLegacy

Represents a legacy requirement widget.

Fields

NameTypeDescription
legacyIid Int Deprecated in 15.9. Use Work Item IID instead.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetStartAndDueDate

Represents a start and due date widget.

Fields

NameTypeDescription
dueDate DateDue date of the work item.
startDate DateStart date of the work item.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetStatus

Represents a status widget.

Fields

NameTypeDescription
status StringStatus of the work item.
type WorkItemWidgetTypeWidget type.

WorkItemWidgetTestReports

Represents a test reports widget.

Fields

NameTypeDescription
testReports TestReportConnectionTest reports of the work item. (see Connections)
type WorkItemWidgetTypeWidget type.

WorkItemWidgetWeight

Represents a weight widget.

Fields

NameTypeDescription
type WorkItemWidgetTypeWidget type.
weight IntWeight of the work item.

Workspace

Represents a remote development workspace.

Fields

NameTypeDescription
actualState String!Actual state of the workspace.
clusterAgent ClusterAgent!Kubernetes Agent associated with the workspace.
createdAt Time!Timestamp of workspace creation.
deploymentResourceVersion IntResourceVersion of the Deployment resource for the workspace.
desiredState String!Desired state of the workspace.
desiredStateUpdatedAt Time!Timestamp of last update to desired state.
devfile String!Source YAML of the devfile used to configure the workspace.
devfilePath String!Project repo git path containing the devfile used to configure the workspace.
devfileRef String!Project repo git ref containing the devfile used to configure the workspace.
editor String!Editor used to configure the workspace. Must match a configured template.
id RemoteDevelopmentWorkspaceID!Global ID of the workspace.
maxHoursBeforeTermination Int!Maximum hours the workspace can exist before it is automatically terminated.
name String!Name of the workspace in Kubernetes.
namespace String!Namespace of the workspace in Kubernetes.
processedDevfile String!Processed YAML of the devfile used to configure the workspace.
projectId ID!ID of the Project providing the Devfile for the workspace.
respondedToAgentAt TimeTimestamp of last response sent to GA4K for the workspace.
updatedAt Time!Timestamp of last update to any mutable workspace property.
url String!URL of the workspace.
user UserCore!Owner of the workspace.

X509Certificate

Represents an X.509 certificate.

Fields

NameTypeDescription
certificateStatus String!Indicates if the certificate is good or revoked.
createdAt Time!Timestamp of when the certificate was saved.
email String!Email associated with the cerificate.
id ID!ID of the certificate.
serialNumber String!Serial number of the certificate.
subject String!Subject of the certificate.
subjectKeyIdentifier String!Subject key identifier of the certificate.
updatedAt Time!Timestamp of when the certificate was last updated.
x509Issuer X509Issuer!Issuer of the certificate.

X509Issuer

Issuer of an X.509 certificate.

Fields

NameTypeDescription
createdAt TimeTimestamp of when the issuer was created.
crlUrl StringCertificate revokation list of the issuer.
id IDID of the issuer.
subject StringSubject of the issuer.
subjectKeyIdentifier StringSubject key identifier of the issuer.
updatedAt TimeTimestamp of when the issuer was last updated.

X509Signature

X.509 signature for a signed commit.

Fields

NameTypeDescription
commitSha StringSHA of the associated commit.
project ProjectProject of the associated commit.
user UserCoreUser associated with the key.
verificationStatus VerificationStatusIndicates verification status of the associated key or certificate.
x509Certificate X509CertificateCertificate used for the signature.

Enumeration types

Also called Enums, enumeration types are a special kind of scalar that is restricted to a particular set of allowed values.

For more information, see Enumeration Types on graphql.org.

AccessLevelEnum

Access level to a resource.

ValueDescription
ADMIN Admin access.
DEVELOPER Developer access.
GUEST Guest access.
MAINTAINER Maintainer access.
MINIMAL_ACCESS Minimal access.
NO_ACCESS No access.
OWNER Owner access.
REPORTER Reporter access.

AgentTokenStatus

Agent token statuses.

ValueDescription
ACTIVE Active agent token.
REVOKED Revoked agent token.

AiCachedMessageRole

Roles to filter in chat message.

ValueDescription
ASSISTANT Filter only assistant messages.
USER Filter only user messages.

AlertManagementAlertSort

Values for sorting alerts.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
CREATED_TIME_ASC Created time by ascending order.
CREATED_TIME_DESC Created time by descending order.
ENDED_AT_ASC End time by ascending order.
ENDED_AT_DESC End time by descending order.
EVENT_COUNT_ASC Events count by ascending order.
EVENT_COUNT_DESC Events count by descending order.
SEVERITY_ASC Severity from less critical to more critical.
SEVERITY_DESC Severity from more critical to less critical.
STARTED_AT_ASC Start time by ascending order.
STARTED_AT_DESC Start time by descending order.
STATUS_ASC Status by order: Ignored > Resolved > Acknowledged > Triggered.
STATUS_DESC Status by order: Triggered > Acknowledged > Resolved > Ignored.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
UPDATED_TIME_ASC Created time by ascending order.
UPDATED_TIME_DESC Created time by descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

AlertManagementDomainFilter

Filters the alerts based on given domain.

ValueDescription
operations Alerts for operations domain.
threat_monitoring Deprecated in 15.0. Network policies are deprecated and will be removed in GitLab 16.0.

AlertManagementIntegrationType

Values of types of integrations.

ValueDescription
HTTP Integration with any monitoring tool.
PROMETHEUS Prometheus integration.

AlertManagementPayloadAlertFieldName

Values for alert field names used in the custom mapping.

ValueDescription
DESCRIPTION A high-level summary of the problem.
END_TIME The resolved time of the incident.
FINGERPRINT The unique identifier of the alert. This can be used to group occurrences of the same alert.
GITLAB_ENVIRONMENT_NAME The name of the associated GitLab environment.
HOSTS One or more hosts, as to where this incident occurred.
MONITORING_TOOL The name of the associated monitoring tool.
SERVICE The affected service.
SEVERITY The severity of the alert.
START_TIME The time of the incident.
TITLE The title of the incident.

AlertManagementPayloadAlertFieldType

Values for alert field types used in the custom mapping.

ValueDescription
ARRAY Array field type.
DATETIME DateTime field type.
STRING String field type.

AlertManagementSeverity

Alert severity values.

ValueDescription
CRITICAL Critical severity.
HIGH High severity.
INFO Info severity.
LOW Low severity.
MEDIUM Medium severity.
UNKNOWN Unknown severity.

AlertManagementStatus

Alert status values.

ValueDescription
ACKNOWLEDGED Someone is actively investigating the problem.
IGNORED No action will be taken.
RESOLVED The problem has been addressed.
TRIGGERED Investigation has not started.

ApiFuzzingScanMode

All possible ways to specify the API surface for an API fuzzing scan.

ValueDescription
HAR The API surface is specified by a HAR file.
OPENAPI The API surface is specified by a OPENAPI file.
POSTMAN The API surface is specified by a POSTMAN file.

ApprovalRuleType

The kind of an approval rule.

ValueDescription
ANY_APPROVER A any_approver approval rule.
CODE_OWNER A code_owner approval rule.
REGULAR A regular approval rule.
REPORT_APPROVER A report_approver approval rule.

AssigneeWildcardId

Assignee ID wildcard values.

ValueDescription
ANY An assignee is assigned.
NONE No assignee is assigned.

AvailabilityEnum

User availability status.

ValueDescription
BUSY Busy.
NOT_SET Not Set.

AvailableExportFields

Available fields to be exported as CSV.

ValueDescription
AUTHOR Author name.
AUTHOR_USERNAME Author username.
CREATED_AT Date of creation.
DESCRIPTION Description.
ID Unique identifier.
TITLE Title.
TYPE Type of the work item.

BlobViewersType

Types of blob viewers.

ValueDescription
auxiliary Auxiliary blob viewers type.
rich Rich blob viewers type.
simple Simple blob viewers type.

CiCatalogResourceSort

Values for sorting catalog resources.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
NAME_ASC Name by ascending order.
NAME_DESC Name by descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

CiConfigIncludeType

Include type.

ValueDescription
component Component include.
file Project file include.
local Local include.
remote Remote include.
template Template include.

CiConfigStatus

Values for YAML processor result.

ValueDescription
INVALID Configuration file is not valid.
VALID Configuration file is valid.

CiFreezePeriodStatus

Deploy freeze period status.

ValueDescription
ACTIVE Freeze period is active.
INACTIVE Freeze period is inactive.

CiGroupVariablesSort

Values for sorting inherited variables.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
KEY_ASC Key by ascending order.
KEY_DESC Key by descending order.

CiJobKind

ValueDescription
BRIDGE Bridge CI job connecting a parent and child pipeline.
BUILD Standard CI job.

CiJobStatus

ValueDescription
CANCELED A job that is canceled.
CREATED A job that is created.
FAILED A job that is failed.
MANUAL A job that is manual.
PENDING A job that is pending.
PREPARING A job that is preparing.
RUNNING A job that is running.
SCHEDULED A job that is scheduled.
SKIPPED A job that is skipped.
SUCCESS A job that is success.
WAITING_FOR_RESOURCE A job that is waiting for resource.

CiJobTokenScopeDirection

Direction of access.

ValueDescription
INBOUND Target projects in the inbound allowlist can access the scope project through their job tokens.
OUTBOUND Job token scope project can access target project in the outbound allowlist.

CiRunnerAccessLevel

ValueDescription
NOT_PROTECTED A runner that is not protected.
REF_PROTECTED A runner that is ref protected.

CiRunnerJobExecutionStatus

ValueDescription
IDLE Introduced in 15.7. This feature is an Experiment. It can be changed or removed at any time. Runner is idle.
RUNNING Introduced in 15.7. This feature is an Experiment. It can be changed or removed at any time. Runner is executing jobs.

CiRunnerMembershipFilter

Values for filtering runners in namespaces. The previous type name RunnerMembershipFilter was deprecated in 15.4.

ValueDescription
ALL_AVAILABLE Introduced in 15.5. This feature is an Experiment. It can be changed or removed at any time. Include all runners. This list includes runners for all projects in the group and subgroups, as well as for the parent groups and instance.
DESCENDANTS Include runners that have either a direct or inherited relationship. These runners can be specific to a project or a group.
DIRECT Include runners that have a direct relationship.

CiRunnerSort

Values for sorting runners.

ValueDescription
CONTACTED_ASC Ordered by contacted_at in ascending order.
CONTACTED_DESC Ordered by contacted_at in descending order.
CREATED_ASC Ordered by created_at in ascending order.
CREATED_DESC Ordered by created_at in descending order.
MOST_ACTIVE_DESC Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Ordered by number of running jobs in descending order (only available on Ultimate plans).
TOKEN_EXPIRES_AT_ASC Ordered by token_expires_at in ascending order.
TOKEN_EXPIRES_AT_DESC Ordered by token_expires_at in descending order.

CiRunnerStatus

ValueDescription
ACTIVE Deprecated in 14.6. This was renamed. Use: CiRunner.paused.
NEVER_CONTACTED Runner that has never contacted this instance.
OFFLINE Runner that has not contacted this instance within the last 2 hours. Will be considered STALE if offline for more than 3 months.
ONLINE Runner that contacted this instance within the last 2 hours.
PAUSED Deprecated in 14.6. This was renamed. Use: CiRunner.paused.
STALE Runner that has not contacted this instance within the last 3 months.

CiRunnerType

ValueDescription
GROUP_TYPE A runner that is group type.
INSTANCE_TYPE A runner that is instance type.
PROJECT_TYPE A runner that is project type.

CiRunnerUpgradeStatus

ValueDescription
AVAILABLE Upgrade is available for the runner.
INVALID Runner version is not valid.
NOT_AVAILABLE Upgrade is not available for the runner.
RECOMMENDED Upgrade is available and recommended for the runner.

CiVariableSort

Values for sorting variables.

ValueDescription
KEY_ASC Sorted by key in ascending order.
KEY_DESC Sorted by key in descending order.

CiVariableType

ValueDescription
ENV_VAR Env var type.
FILE File type.

CodeQualityDegradationSeverity

ValueDescription
BLOCKER Code Quality degradation has a status of blocker.
CRITICAL Code Quality degradation has a status of critical.
INFO Code Quality degradation has a status of info.
MAJOR Code Quality degradation has a status of major.
MINOR Code Quality degradation has a status of minor.
UNKNOWN Code Quality degradation has a status of unknown.

CommitActionMode

Mode of a commit action.

ValueDescription
CHMOD Chmod command.
CREATE Create command.
DELETE Delete command.
MOVE Move command.
UPDATE Update command.

CommitEncoding

ValueDescription
BASE64 Base64 encoding.
TEXT Text encoding.

ComparableSecurityReportType

Comparable security report type.

ValueDescription
API_FUZZING API Fuzzing report.
CONTAINER_SCANNING Container Scanning report.
COVERAGE_FUZZING Coverage Fuzzing report.
DAST DAST report.
DEPENDENCY_SCANNING Dependency Scanning report.
SAST SAST report.
SECRET_DETECTION Secret Detection report.

ComplianceFrameworkPresenceFilter

ComplianceFramework of a project for filtering.

ValueDescription
ANY Any compliance framework is assigned.
NONE No compliance framework is assigned.

ComplianceStandardsAdherenceCheckName

Name of the check for the compliance standard.

ValueDescription
PREVENT_APPROVAL_BY_MERGE_REQUEST_AUTHOR Prevent approval by merge request author.

ComplianceStandardsAdherenceStandard

Name of the compliance standard.

ValueDescription
GITLAB Gitlab.

ComplianceStandardsAdherenceStatus

Status of the compliance standards adherence.

ValueDescription
FAIL Fail.
SUCCESS Success.

ComplianceViolationReason

Reason for the compliance violation.

ValueDescription
APPROVED_BY_COMMITTER Approved by committer.
APPROVED_BY_INSUFFICIENT_USERS Approved by insufficient users.
APPROVED_BY_MERGE_REQUEST_AUTHOR Approved by merge request author.

ComplianceViolationSeverity

Severity of the compliance violation.

ValueDescription
CRITICAL Critical severity.
HIGH High severity.
INFO Info severity.
LOW Low severity.
MEDIUM Medium severity.

ComplianceViolationSort

Compliance violation sort values.

ValueDescription
MERGED_AT_ASC Date merged in ascending order, further sorted by ID in ascending order.
MERGED_AT_DESC Date merged in descending order, further sorted by ID in descending order.
MERGE_REQUEST_TITLE_ASC Merge request title in ascending order, further sorted by ID in ascending order.
MERGE_REQUEST_TITLE_DESC Merge request title in descending order, further sorted by ID in descending order.
SEVERITY_LEVEL_ASC Severity in ascending order, further sorted by ID in ascending order.
SEVERITY_LEVEL_DESC Severity in descending order, further sorted by ID in descending order.
VIOLATION_REASON_ASC Violation reason in ascending order, further sorted by ID in ascending order.
VIOLATION_REASON_DESC Violation reason in descending order, further sorted by ID in descending order.

ConanMetadatumFileTypeEnum

Conan file types.

ValueDescription
PACKAGE_FILE A package file type.
RECIPE_FILE A recipe file type.

ContactSort

Values for sorting contacts.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
DESCRIPTION_ASC Description in ascending order.
DESCRIPTION_DESC Description in descending order.
EMAIL_ASC Email in ascending order.
EMAIL_DESC Email in descending order.
FIRST_NAME_ASC First name in ascending order.
FIRST_NAME_DESC First name in descending order.
LAST_NAME_ASC Last name in ascending order.
LAST_NAME_DESC Last name in descending order.
ORGANIZATION_ASC Organization in ascending order.
ORGANIZATION_DESC Organization in descending order.
PHONE_ASC Phone in ascending order.
PHONE_DESC Phone in descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

ContainerExpirationPolicyCadenceEnum

ValueDescription
EVERY_DAY Every day.
EVERY_MONTH Every month.
EVERY_THREE_MONTHS Every three months.
EVERY_TWO_WEEKS Every two weeks.
EVERY_WEEK Every week.

ContainerExpirationPolicyKeepEnum

ValueDescription
FIFTY_TAGS 50 tags per image name.
FIVE_TAGS 5 tags per image name.
ONE_HUNDRED_TAGS 100 tags per image name.
ONE_TAG 1 tag per image name.
TEN_TAGS 10 tags per image name.
TWENTY_FIVE_TAGS 25 tags per image name.

ContainerExpirationPolicyOlderThanEnum

ValueDescription
FOURTEEN_DAYS 14 days until tags are automatically removed.
NINETY_DAYS 90 days until tags are automatically removed.
SEVEN_DAYS 7 days until tags are automatically removed.
SIXTY_DAYS 60 days until tags are automatically removed.
THIRTY_DAYS 30 days until tags are automatically removed.

ContainerRepositoryCleanupStatus

Status of the tags cleanup of a container repository.

ValueDescription
ONGOING Tags cleanup is ongoing.
SCHEDULED Tags cleanup is scheduled and is going to be executed shortly.
UNFINISHED Tags cleanup has been partially executed. There are still remaining tags to delete.
UNSCHEDULED Tags cleanup is not scheduled. This is the default state.

ContainerRepositorySort

Values for sorting container repositories.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
NAME_ASC Name by ascending order.
NAME_DESC Name by descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

ContainerRepositoryStatus

Status of a container repository.

ValueDescription
DELETE_FAILED Delete Failed status.
DELETE_ONGOING Delete Ongoing status.
DELETE_SCHEDULED Delete Scheduled status.

ContainerRepositoryTagSort

Values for sorting tags.

ValueDescription
NAME_ASC Ordered by name in ascending order.
NAME_DESC Ordered by name in descending order.

CustomerRelationsContactState

ValueDescription
active Active contacts.
all All available contacts.
inactive Inactive contacts.

CustomerRelationsOrganizationState

ValueDescription
active Active organizations.
all All available organizations.
inactive Inactive organizations.

DastPreScanVerificationCheckType

Check type of the pre scan verification step.

ValueDescription
AUTHENTICATION Authentication check.
CONNECTION Connection check.
CRAWLING Crawling check.

DastPreScanVerificationStatus

Status of DAST pre scan verification.

ValueDescription
COMPLETE Pre Scan Verification complete without errors.
COMPLETE_WITH_ERRORS Pre Scan Verification finished with one or more errors.
FAILED Pre Scan Validation unable to finish.
RUNNING Pre Scan Verification in execution.

DastProfileCadenceUnit

Unit for the duration of Dast Profile Cadence.

ValueDescription
DAY DAST Profile Cadence duration in days.
MONTH DAST Profile Cadence duration in months.
WEEK DAST Profile Cadence duration in weeks.
YEAR DAST Profile Cadence duration in years.

DastScanMethodType

Scan method to be used by the scanner.

ValueDescription
GRAPHQL GraphQL scan method.
HAR HAR scan method.
OPENAPI OpenAPI scan method.
POSTMAN_COLLECTION Postman scan method.
WEBSITE Website scan method.

DastScanTypeEnum

ValueDescription
ACTIVE Active DAST scan. This scan will make active attacks against the target site.
PASSIVE Passive DAST scan. This scan will not make active attacks against the target site.

DastSiteProfileValidationStatusEnum

ValueDescription
FAILED_VALIDATION Site validation process finished but failed.
INPROGRESS_VALIDATION Site validation process is in progress.
NONE No site validation exists.
PASSED_VALIDATION Site validation process finished successfully.
PENDING_VALIDATION Site validation process has not started.

DastSiteValidationStatusEnum

ValueDescription
FAILED_VALIDATION Site validation process finished but failed.
INPROGRESS_VALIDATION Site validation process is in progress.
PASSED_VALIDATION Site validation process finished successfully.
PENDING_VALIDATION Site validation process has not started.

DastSiteValidationStrategyEnum

ValueDescription
HEADER Header validation.
META_TAG Meta tag validation.
TEXT_FILE Text file validation.

DastTargetTypeEnum

ValueDescription
API API target.
WEBSITE Website target.

DataVisualizationColorEnum

Color of the data visualization palette.

ValueDescription
AQUA Aqua color.
BLUE Blue color.
GREEN Green color.
MAGENTA Magenta color.
ORANGE Orange color.

DataVisualizationWeightEnum

Weight of the data visualization palette.

ValueDescription
WEIGHT_100 100 weight.
WEIGHT_200 200 weight.
WEIGHT_300 300 weight.
WEIGHT_400 400 weight.
WEIGHT_50 50 weight.
WEIGHT_500 500 weight.
WEIGHT_600 600 weight.
WEIGHT_700 700 weight.
WEIGHT_800 800 weight.
WEIGHT_900 900 weight.
WEIGHT_950 950 weight.

DependencyProxyManifestStatus

ValueDescription
DEFAULT Dependency proxy manifest has a status of default.
ERROR Dependency proxy manifest has a status of error.
PENDING_DESTRUCTION Dependency proxy manifest has a status of pending_destruction.
PROCESSING Dependency proxy manifest has a status of processing.

DependencySort

Values for sorting dependencies.

ValueDescription
NAME_ASC Name by ascending order.
NAME_DESC Name by descending order.
PACKAGER_ASC Packager by ascending order.
PACKAGER_DESC Packager by descending order.

DeploymentApprovalSummaryStatus

Status of the deployment approval summary.

ValueDescription
APPROVED Summarized deployment approval status that is approved.
PENDING_APPROVAL Summarized deployment approval status that is pending approval.
REJECTED Summarized deployment approval status that is rejected.

DeploymentStatus

All deployment statuses.

ValueDescription
BLOCKED A deployment that is blocked.
CANCELED A deployment that is canceled.
CREATED A deployment that is created.
FAILED A deployment that is failed.
RUNNING A deployment that is running.
SKIPPED A deployment that is skipped.
SUCCESS A deployment that is success.

DeploymentTier

All environment deployment tiers.

ValueDescription
DEVELOPMENT Development.
OTHER Other.
PRODUCTION Production.
STAGING Staging.
TESTING Testing.

DeploymentsApprovalStatus

Status of the deployment approval.

ValueDescription
APPROVED A deployment approval that is approved.
REJECTED A deployment approval that is rejected.

DesignCollectionCopyState

Copy state of a DesignCollection.

ValueDescription
ERROR The DesignCollection encountered an error during a copy.
IN_PROGRESS The DesignCollection is being copied.
READY The DesignCollection has no copy in progress.

DesignVersionEvent

Mutation event of a design within a version.

ValueDescription
CREATION A creation event.
DELETION A deletion event.
MODIFICATION A modification event.
NONE No change.

DetailedMergeStatus

Detailed representation of whether a GitLab merge request can be merged.

ValueDescription
BLOCKED_STATUS Merge request is blocked by another merge request.
BROKEN_STATUS Can not merge the source into the target branch, potential conflict.
CHECKING Currently checking for mergeability.
CI_MUST_PASS Pipeline must succeed before merging.
CI_STILL_RUNNING Pipeline is still running.
DISCUSSIONS_NOT_RESOLVED Discussions must be resolved before merging.
DRAFT_STATUS Merge request must not be draft before merging.
EXTERNAL_STATUS_CHECKS Status checks must pass.
MERGEABLE Branch can be merged.
NOT_APPROVED Merge request must be approved before merging.
NOT_OPEN Merge request must be open before merging.
POLICIES_DENIED There are denied policies for the merge request.
PREPARING Merge request diff is being created.
UNCHECKED Merge status has not been checked.

DiffPositionType

Type of file the position refers to.

ValueDescription
image An image.
text Text file.

DoraMetricBucketingInterval

All possible ways that DORA metrics can be aggregated.

ValueDescription
ALL All data points are combined into a single value.
DAILY Data points are combined into chunks by day.
MONTHLY Data points are combined into chunks by month.

DoraMetricType

All supported DORA metric types.

ValueDescription
CHANGE_FAILURE_RATE Change failure rate.
DEPLOYMENT_FREQUENCY Deployment frequency.
LEAD_TIME_FOR_CHANGES Lead time for changes.
TIME_TO_RESTORE_SERVICE Time to restore service.

EntryType

Type of a tree entry.

ValueDescription
blob File tree type.
commit Commit tree type.
tree Directory tree type.

EpicSort

Roadmap sort values.

ValueDescription
CREATED_AT_ASC Sort by created_at by ascending order.
CREATED_AT_DESC Sort by created_at by descending order.
END_DATE_ASC Sort by end date in ascending order.
END_DATE_DESC Sort by end date in descending order.
START_DATE_ASC Sort by start date in ascending order.
START_DATE_DESC Sort by start date in descending order.
TITLE_ASC Sort by title in ascending order.
TITLE_DESC Sort by title in descending order.
UPDATED_AT_ASC Sort by updated_at by ascending order.
UPDATED_AT_DESC Sort by updated_at by descending order.
end_date_asc Deprecated in 13.11. Use END_DATE_ASC.
end_date_desc Deprecated in 13.11. Use END_DATE_DESC.
start_date_asc Deprecated in 13.11. Use START_DATE_ASC.
start_date_desc Deprecated in 13.11. Use START_DATE_DESC.

EpicState

State of an epic.

ValueDescription
all All epics.
closed Closed epics.
opened Open epics.

EpicStateEvent

State event of an epic.

ValueDescription
CLOSE Close the epic.
REOPEN Reopen the epic.

EpicWildcardId

Epic ID wildcard values.

ValueDescription
ANY Any epic is assigned.
NONE No epic is assigned.

EscalationRuleStatus

Escalation rule statuses.

ValueDescription
ACKNOWLEDGED .
RESOLVED .

EventAction

Event action.

ValueDescription
APPROVED Approved action.
CLOSED Closed action.
COMMENTED Commented action.
CREATED Created action.
DESTROYED Destroyed action.
EXPIRED Expired action.
JOINED Joined action.
LEFT Left action.
MERGED Merged action.
PUSHED Pushed action.
REOPENED Reopened action.
UPDATED Updated action.

FindingReportsComparerStatus

Report comparison status.

ValueDescription
ERROR An error happened while generating the report.
PARSED Report was generated.
PARSING Report is being generated.

ForecastStatus

List of statuses for forecasting model.

ValueDescription
READY Forecast is ready.
UNAVAILABLE Forecast is unavailable.

GeoRegistryAction

Action to trigger on one or more Geo registries.

ValueDescription
RESYNC Resync a registry.
REVERIFY Reverify a registry.

GeoRegistryClass

Geo registry class.

ValueDescription
CI_SECURE_FILE_REGISTRY Geo::CiSecureFileRegistry registry class.
CONTAINER_REPOSITORY_REGISTRY Geo::ContainerRepositoryRegistry registry class.
DEPENDENCY_PROXY_BLOB_REGISTRY Geo::DependencyProxyBlobRegistry registry class.
DEPENDENCY_PROXY_MANIFEST_REGISTRY Geo::DependencyProxyManifestRegistry registry class.
DESIGN_MANAGEMENT_REPOSITORY_REGISTRY Geo::DesignManagementRepositoryRegistry registry class.
JOB_ARTIFACT_REGISTRY Geo::JobArtifactRegistry registry class.
LFS_OBJECT_REGISTRY Geo::LfsObjectRegistry registry class.
MERGE_REQUEST_DIFF_REGISTRY Geo::MergeRequestDiffRegistry registry class.
PACKAGE_FILE_REGISTRY Geo::PackageFileRegistry registry class.
PAGES_DEPLOYMENT_REGISTRY Geo::PagesDeploymentRegistry registry class.
PIPELINE_ARTIFACT_REGISTRY Geo::PipelineArtifactRegistry registry class.
PROJECT_REPOSITORY_REGISTRY Geo::ProjectRepositoryRegistry registry class.
PROJECT_WIKI_REPOSITORY_REGISTRY Geo::ProjectWikiRepositoryRegistry registry class.
SNIPPET_REPOSITORY_REGISTRY Geo::SnippetRepositoryRegistry registry class.
TERRAFORM_STATE_VERSION_REGISTRY Geo::TerraformStateVersionRegistry registry class.
UPLOAD_REGISTRY Geo::UploadRegistry registry class.

GitlabSubscriptionsUserRole

Role of User.

ValueDescription
DEVELOPER Developer.
GUEST Guest.
MAINTAINER Maintainer.
OWNER Owner.
REPORTER Reporter.

GroupMemberRelation

Group member relation.

ValueDescription
DESCENDANTS Members in the group’s subgroups.
DIRECT Members in the group itself.
INHERITED Members in the group’s ancestor groups.
SHARED_FROM_GROUPS Invited group’s members.

GroupPermission

User permission on groups.

ValueDescription
CREATE_PROJECTS Groups where the user can create projects.
IMPORT_PROJECTS Groups where the user can import projects to.
TRANSFER_PROJECTS Groups where the user can transfer projects to.

GroupReleaseSort

Values for sorting releases belonging to a group.

ValueDescription
RELEASED_AT_ASC Released at by ascending order.
RELEASED_AT_DESC Released at by descending order.

HealthStatus

Health status of an issue or epic.

ValueDescription
atRisk At risk.
needsAttention Needs attention.
onTrack On track.

HealthStatusFilter

Health status of an issue or epic for filtering.

ValueDescription
ANY Any health status is assigned.
NONE No health status is assigned.
atRisk At risk.
needsAttention Needs attention.
onTrack On track.

IssuableResourceLinkType

Issuable resource link type enum.

ValueDescription
general General link type.
pagerduty Pagerduty link type.
slack Slack link type.
zoom Zoom link type.

IssuableSearchableField

Fields to perform the search in.

ValueDescription
DESCRIPTION Search in description field.
TITLE Search in title field.

IssuableSeverity

Incident severity.

ValueDescription
CRITICAL Critical severity.
HIGH High severity.
LOW Low severity.
MEDIUM Medium severity.
UNKNOWN Unknown severity.

IssuableState

State of a GitLab issue or merge request.

ValueDescription
all All available.
closed In closed state.
locked Discussion has been locked.
opened In open state.

IssuableSubscriptionEvent

Values for subscribing and unsubscribing from issuables.

ValueDescription
SUBSCRIBE Subscribe to an issuable.
UNSUBSCRIBE Unsubscribe from an issuable.

IssueCreationIterationWildcardId

Iteration ID wildcard values for issue creation.

ValueDescription
CURRENT Current iteration.

IssueEscalationStatus

Issue escalation status values.

ValueDescription
ACKNOWLEDGED Someone is actively investigating the problem.
IGNORED No action will be taken.
RESOLVED The problem has been addressed.
TRIGGERED Investigation has not started.

IssueSort

Values for sorting issues.

ValueDescription
BLOCKING_ISSUES_ASC Blocking issues count by ascending order.
BLOCKING_ISSUES_DESC Blocking issues count by descending order.
CLOSED_AT_ASC Closed time by ascending order.
CLOSED_AT_DESC Closed time by descending order.
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
DUE_DATE_ASC Due date by ascending order.
DUE_DATE_DESC Due date by descending order.
ESCALATION_STATUS_ASC Status from triggered to resolved.
ESCALATION_STATUS_DESC Status from resolved to triggered.
HEALTH_STATUS_ASC Issues with healthy issues first.
HEALTH_STATUS_DESC Issues with unhealthy issues first.
LABEL_PRIORITY_ASC Label priority by ascending order.
LABEL_PRIORITY_DESC Label priority by descending order.
MILESTONE_DUE_ASC Milestone due date by ascending order.
MILESTONE_DUE_DESC Milestone due date by descending order.
POPULARITY_ASC Number of upvotes (awarded “thumbs up” emoji) by ascending order.
POPULARITY_DESC Number of upvotes (awarded “thumbs up” emoji) by descending order.
PRIORITY_ASC Priority by ascending order.
PRIORITY_DESC Priority by descending order.
PUBLISHED_ASC Published issues shown last.
PUBLISHED_DESC Published issues shown first.
RELATIVE_POSITION_ASC Relative position by ascending order.
SEVERITY_ASC Severity from less critical to more critical.
SEVERITY_DESC Severity from more critical to less critical.
SLA_DUE_AT_ASC Issues with earliest SLA due time shown first.
SLA_DUE_AT_DESC Issues with latest SLA due time shown first.
TITLE_ASC Title by ascending order.
TITLE_DESC Title by descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
WEIGHT_ASC Weight by ascending order.
WEIGHT_DESC Weight by descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

IssueState

State of a GitLab issue.

ValueDescription
all All available.
closed In closed state.
locked Discussion has been locked.
opened In open state.

IssueStateEvent

Values for issue state events.

ValueDescription
CLOSE Closes the issue.
REOPEN Reopens the issue.

IssueType

Issue type.

ValueDescription
INCIDENT Incident issue type.
ISSUE Issue issue type.
KEY_RESULT Introduced in 15.7. This feature is an Experiment. It can be changed or removed at any time. Key Result issue type. Available only when feature flag okrs_mvc is enabled.
OBJECTIVE Introduced in 15.6. This feature is an Experiment. It can be changed or removed at any time. Objective issue type. Available only when feature flag okrs_mvc is enabled.
REQUIREMENT Requirement issue type.
TASK Introduced in 15.2. This feature is an Experiment. It can be changed or removed at any time. Task issue type.
TEST_CASE Test Case issue type.

IterationSearchableField

Fields to perform the search in.

ValueDescription
CADENCE_TITLE Search in cadence_title field.
TITLE Search in title field.

IterationSort

Iteration sort values.

ValueDescription
CADENCE_AND_DUE_DATE_ASC Sort by cadence id in ascending and due date in ascending order.
CADENCE_AND_DUE_DATE_DESC Sort by cadence id in ascending and due date in descending order.

IterationState

State of a GitLab iteration.

ValueDescription
all Any iteration.
closed Closed iteration.
current Current iteration.
opened Open iteration.
upcoming Upcoming iteration.

IterationWildcardId

Iteration ID wildcard values.

ValueDescription
ANY An iteration is assigned.
CURRENT Current iteration.
NONE No iteration is assigned.

JobArtifactFileType

ValueDescription
ACCESSIBILITY ACCESSIBILITY job artifact file type.
API_FUZZING API FUZZING job artifact file type.
ARCHIVE ARCHIVE job artifact file type.
BROWSER_PERFORMANCE BROWSER PERFORMANCE job artifact file type.
CLUSTER_APPLICATIONS CLUSTER APPLICATIONS job artifact file type.
CLUSTER_IMAGE_SCANNING CLUSTER IMAGE SCANNING job artifact file type.
COBERTURA COBERTURA job artifact file type.
CODEQUALITY CODE QUALITY job artifact file type.
CONTAINER_SCANNING CONTAINER SCANNING job artifact file type.
COVERAGE_FUZZING COVERAGE FUZZING job artifact file type.
CYCLONEDX CYCLONEDX job artifact file type.
DAST DAST job artifact file type.
DEPENDENCY_SCANNING DEPENDENCY SCANNING job artifact file type.
DOTENV DOTENV job artifact file type.
JUNIT JUNIT job artifact file type.
LICENSE_SCANNING LICENSE SCANNING job artifact file type.
LOAD_PERFORMANCE LOAD PERFORMANCE job artifact file type.
LSIF LSIF job artifact file type.
METADATA METADATA job artifact file type.
METRICS METRICS job artifact file type.
METRICS_REFEREE METRICS REFEREE job artifact file type.
NETWORK_REFEREE NETWORK REFEREE job artifact file type.
PERFORMANCE PERFORMANCE job artifact file type.
REQUIREMENTS REQUIREMENTS job artifact file type.
REQUIREMENTS_V2 REQUIREMENTS V2 job artifact file type.
SAST SAST job artifact file type.
SECRET_DETECTION SECRET DETECTION job artifact file type.
TERRAFORM TERRAFORM job artifact file type.
TRACE TRACE job artifact file type.

ListLimitMetric

List limit metric setting.

ValueDescription
all_metrics Limit list by number and total weight of issues.
issue_count Limit list by number of issues.
issue_weights Limit list by total weight of issues.

MarkupFormat

List markup formats.

ValueDescription
HTML HTML format.
MARKDOWN Markdown format.
RAW Raw format.

MeasurementIdentifier

Possible identifier types for a measurement.

ValueDescription
GROUPS Group count.
ISSUES Issue count.
MERGE_REQUESTS Merge request count.
PIPELINES Pipeline count.
PIPELINES_CANCELED Pipeline count with canceled status.
PIPELINES_FAILED Pipeline count with failed status.
PIPELINES_SKIPPED Pipeline count with skipped status.
PIPELINES_SUCCEEDED Pipeline count with success status.
PROJECTS Project count.
USERS User count.

MemberAccessLevel

Access level of a group or project member.

ValueDescription
DEVELOPER Developer access.
GUEST Guest access.
MAINTAINER Maintainer access.
MINIMAL_ACCESS Minimal access.
OWNER Owner access.
REPORTER Reporter access.

MemberAccessLevelName

Name of access levels of a group or project member.

ValueDescription
DEVELOPER Developer access.
GUEST Guest access.
MAINTAINER Maintainer access.
OWNER Owner access.
REPORTER Reporter access.

MemberSort

Values for sorting members.

ValueDescription
ACCESS_LEVEL_ASC Access level ascending order.
ACCESS_LEVEL_DESC Access level descending order.
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
USER_FULL_NAME_ASC User’s full name ascending order.
USER_FULL_NAME_DESC User’s full name descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

MergeRequestNewState

New state to apply to a merge request.

ValueDescription
CLOSED Close the merge request if it is open.
OPEN Open the merge request if it is closed.

MergeRequestReviewState

State of a review of a GitLab merge request.

ValueDescription
REVIEWED The merge request is reviewed.
UNREVIEWED The merge request is unreviewed.

MergeRequestSort

Values for sorting merge requests.

ValueDescription
CLOSED_AT_ASC Closed time by ascending order.
CLOSED_AT_DESC Closed time by descending order.
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
LABEL_PRIORITY_ASC Label priority by ascending order.
LABEL_PRIORITY_DESC Label priority by descending order.
MERGED_AT_ASC Merge time by ascending order.
MERGED_AT_DESC Merge time by descending order.
MILESTONE_DUE_ASC Milestone due date by ascending order.
MILESTONE_DUE_DESC Milestone due date by descending order.
PRIORITY_ASC Priority by ascending order.
PRIORITY_DESC Priority by descending order.
TITLE_ASC Title by ascending order.
TITLE_DESC Title by descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

MergeRequestState

State of a GitLab merge request.

ValueDescription
all All available.
closed In closed state.
locked Discussion has been locked.
merged Merge request has been merged.
opened In open state.

MergeStatus

Representation of whether a GitLab merge request can be merged.

ValueDescription
CANNOT_BE_MERGED There are conflicts between the source and target branches.
CANNOT_BE_MERGED_RECHECK Currently unchecked. The previous state was CANNOT_BE_MERGED.
CAN_BE_MERGED There are no conflicts between the source and target branches.
CHECKING Currently checking for mergeability.
UNCHECKED Merge status has not been checked.

MergeStrategyEnum

ValueDescription
ADD_TO_MERGE_TRAIN_WHEN_PIPELINE_SUCCEEDS Use the add_to_merge_train_when_pipeline_succeeds merge strategy.
MERGE_TRAIN Use the merge_train merge strategy.
MERGE_WHEN_CHECKS_PASS Use the merge_when_checks_pass merge strategy.
MERGE_WHEN_PIPELINE_SUCCEEDS Use the merge_when_pipeline_succeeds merge strategy.

MilestoneSort

Values for sorting milestones.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
DUE_DATE_ASC Milestone due date by ascending order.
DUE_DATE_DESC Milestone due date by descending order.
EXPIRED_LAST_DUE_DATE_ASC Group milestones in this order: non-expired milestones with due dates, non-expired milestones without due dates and expired milestones then sort by due date in ascending order.
EXPIRED_LAST_DUE_DATE_DESC Group milestones in this order: non-expired milestones with due dates, non-expired milestones without due dates and expired milestones then sort by due date in descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

MilestoneStateEnum

Current state of milestone.

ValueDescription
active Milestone is currently active.
closed Milestone is closed.

MilestoneWildcardId

Milestone ID wildcard values.

ValueDescription
ANY Milestone is assigned.
NONE No milestone is assigned.
STARTED Milestone assigned is open and started (start date <= today).
UPCOMING Milestone assigned is due in the future (due date > today).

MoveType

The position to which the adjacent object should be moved.

ValueDescription
after Adjacent object is moved after the object that is being moved.
before Adjacent object is moved before the object that is being moved.

MutationOperationMode

Different toggles for changing mutator behavior.

ValueDescription
APPEND Performs an append operation.
REMOVE Performs a removal operation.
REPLACE Performs a replace operation.

NamespaceProjectSort

Values for sorting projects.

ValueDescription
ACTIVITY_DESC Sort by latest activity, descending order.
SIMILARITY Most similar to the search query.
STORAGE Sort by excess repository storage size, descending order.
STORAGE_SIZE_ASC Sort by total storage size, ascending order.
STORAGE_SIZE_DESC Sort by total storage size, descending order.

NegatedIterationWildcardId

Negated Iteration ID wildcard values.

ValueDescription
CURRENT Current iteration.

NegatedMilestoneWildcardId

Negated Milestone ID wildcard values.

ValueDescription
STARTED Milestone assigned is open and yet to be started (start date > today).
UPCOMING Milestone assigned is open but due in the past (due date <= today).

NetworkPolicyKind

Kind of the network policy.

ValueDescription
CiliumNetworkPolicy Policy kind of Cilium Network Policy.
NetworkPolicy Policy kind of Network Policy.

NotesFilterType

Work item notes collection type.

ValueDescription
ALL_NOTES Show all activity.
ONLY_ACTIVITY Show history only.
ONLY_COMMENTS Show comments only.

OncallRotationUnitEnum

Rotation length unit of an on-call rotation.

ValueDescription
DAYS Days.
HOURS Hours.
WEEKS Weeks.

OrganizationSort

Values for sorting organizations.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
DEFAULT_RATE_ASC Default Rate in ascending order.
DEFAULT_RATE_DESC Default Rate in descending order.
DESCRIPTION_ASC Description in ascending order.
DESCRIPTION_DESC Description in descending order.
NAME_ASC Name in ascending order.
NAME_DESC Name in descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

PackageDependencyType

ValueDescription
BUNDLE_DEPENDENCIES bundleDependencies dependency type.
DEPENDENCIES dependencies dependency type.
DEV_DEPENDENCIES devDependencies dependency type.
PEER_DEPENDENCIES peerDependencies dependency type.

PackageGroupSort

Values for sorting group packages.

ValueDescription
CREATED_ASC Ordered by created_at in ascending order.
CREATED_DESC Ordered by created_at in descending order.
NAME_ASC Ordered by name in ascending order.
NAME_DESC Ordered by name in descending order.
PROJECT_PATH_ASC Ordered by project path in ascending order.
PROJECT_PATH_DESC Ordered by project path in descending order.
TYPE_ASC Ordered by type in ascending order.
TYPE_DESC Ordered by type in descending order.
VERSION_ASC Ordered by version in ascending order.
VERSION_DESC Ordered by version in descending order.

PackageManager

Values for package manager.

ValueDescription
BUNDLER Package manager: bundler.
COMPOSER Package manager: composer.
CONAN Package manager: conan.
GO Package manager: go.
GRADLE Package manager: gradle.
MAVEN Package manager: maven.
NPM Package manager: npm.
NUGET Package manager: nuget.
PIP Package manager: pip.
PIPENV Package manager: pipenv.
PNPM Package manager: pnpm.
SBT Package manager: sbt.
SETUPTOOLS Package manager: setuptools.
YARN Package manager: yarn.

PackageSort

Values for sorting package.

ValueDescription
CREATED_ASC Ordered by created_at in ascending order.
CREATED_DESC Ordered by created_at in descending order.
NAME_ASC Ordered by name in ascending order.
NAME_DESC Ordered by name in descending order.
TYPE_ASC Ordered by type in ascending order.
TYPE_DESC Ordered by type in descending order.
VERSION_ASC Ordered by version in ascending order.
VERSION_DESC Ordered by version in descending order.

PackageStatus

ValueDescription
DEFAULT Packages with a default status.
ERROR Packages with a error status.
HIDDEN Packages with a hidden status.
PENDING_DESTRUCTION Packages with a pending_destruction status.
PROCESSING Packages with a processing status.

PackageTypeEnum

ValueDescription
COMPOSER Packages from the Composer package manager.
CONAN Packages from the Conan package manager.
DEBIAN Packages from the Debian package manager.
GENERIC Packages from the Generic package manager.
GOLANG Packages from the Golang package manager.
HELM Packages from the Helm package manager.
MAVEN Packages from the Maven package manager.
ML_MODEL Packages from the Ml_model package manager.
NPM Packages from the npm package manager.
NUGET Packages from the Nuget package manager.
PYPI Packages from the PyPI package manager.
RPM Packages from the Rpm package manager.
RUBYGEMS Packages from the Rubygems package manager.
TERRAFORM_MODULE Packages from the Terraform Module package manager.

PackagesCleanupKeepDuplicatedPackageFilesEnum

ValueDescription
ALL_PACKAGE_FILES Value to keep all package files.
FIFTY_PACKAGE_FILES Value to keep 50 package files.
FORTY_PACKAGE_FILES Value to keep 40 package files.
ONE_PACKAGE_FILE Value to keep 1 package files.
TEN_PACKAGE_FILES Value to keep 10 package files.
THIRTY_PACKAGE_FILES Value to keep 30 package files.
TWENTY_PACKAGE_FILES Value to keep 20 package files.

PipelineConfigSourceEnum

ValueDescription
AUTO_DEVOPS_SOURCE Auto DevOps source.
BRIDGE_SOURCE Bridge source.
COMPLIANCE_SOURCE Compliance source.
EXTERNAL_PROJECT_SOURCE External project source.
PARAMETER_SOURCE Parameter source.
REMOTE_SOURCE Remote source.
REPOSITORY_SOURCE Repository source.
SECURITY_POLICIES_DEFAULT_SOURCE Security policies default source.
UNKNOWN_SOURCE Unknown source.
WEBIDE_SOURCE Webide source.

PipelineMergeRequestEventType

Event type of the pipeline associated with a merge request.

ValueDescription
DETACHED Pipeline run on the changes in the merge request source branch.
MERGED_RESULT Pipeline run on the changes from the source branch combined with the target branch.
MERGE_TRAIN Pipeline ran as part of a merge train.

PipelineScheduleStatus

ValueDescription
ACTIVE Active pipeline schedules.
INACTIVE Inactive pipeline schedules.

PipelineScopeEnum

ValueDescription
BRANCHES Branches.
FINISHED Pipeline has completed.
PENDING Pipeline has not started running yet.
RUNNING Pipeline is running.
TAGS Tags.

PipelineStatusEnum

ValueDescription
CANCELED Pipeline was canceled before completion.
CREATED Pipeline has been created.
FAILED At least one stage of the pipeline failed.
MANUAL Pipeline needs to be manually started.
PENDING Pipeline has not started running yet.
PREPARING Pipeline is preparing to run.
RUNNING Pipeline is running.
SCHEDULED Pipeline is scheduled to run.
SKIPPED Pipeline was skipped.
SUCCESS Pipeline completed successfully.
WAITING_FOR_RESOURCE A resource (for example, a runner) that the pipeline requires to run is unavailable.

ProductAnalyticsState

Current state of the product analytics stack.

ValueDescription
COMPLETE Stack has been initialized and has data.
CREATE_INSTANCE Stack has not been created yet.
LOADING_INSTANCE Stack is currently initializing.
WAITING_FOR_EVENTS Stack is waiting for events from users.

ProjectMemberRelation

Project member relation.

ValueDescription
DESCENDANTS Descendants members.
DIRECT Direct members.
INHERITED Inherited members.
INVITED_GROUPS Invited Groups members.
SHARED_INTO_ANCESTORS Shared Into Ancestors members.

RefType

Type of ref.

ValueDescription
HEADS Ref type for branches.
TAGS Ref type for tags.

RegistryState

State of a Geo registry.

ValueDescription
FAILED Registry that failed to sync.
PENDING Registry waiting to be synced.
STARTED Registry currently syncing.
SYNCED Registry that is synced.

RelativePositionType

The position to which the object should be moved.

ValueDescription
AFTER Object is moved after an adjacent object.
BEFORE Object is moved before an adjacent object.

ReleaseAssetLinkType

Type of the link: other, runbook, image, package.

ValueDescription
IMAGE Image link type.
OTHER Other link type.
PACKAGE Package link type.
RUNBOOK Runbook link type.

ReleaseSort

Values for sorting releases.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
RELEASED_AT_ASC Released at by ascending order.
RELEASED_AT_DESC Released at by descending order.

ReleaseTagWildcardId

Release tag ID wildcard values.

ValueDescription
ANY Release tag is assigned.
NONE No release tag is assigned.

ReplicationStateEnum

ValueDescription
FAILED Replication process finished but failed.
PENDING Replication process has not started.
STARTED Replication process is in progress.
SYNCED Replication process finished successfully.

RequirementState

State of a requirement.

ValueDescription
ARCHIVED Archived requirement.
OPENED Open requirement.

RequirementStatusFilter

Status of a requirement based on last test report.

ValueDescription
FAILED Failed test report.
MISSING Requirements without any test report.
PASSED Passed test report.

SastUiComponentSize

Size of UI component in SAST configuration page.

ValueDescription
LARGE Size of UI component in SAST configuration page is large.
MEDIUM Size of UI component in SAST configuration page is medium.
SMALL Size of UI component in SAST configuration page is small.

ScanStatus

The status of the security scan.

ValueDescription
CREATED The scan has been created.
JOB_FAILED The related CI build failed.
PREPARATION_FAILED Report couldn’t be prepared.
PREPARING Preparing the report for the scan.
PURGED Report for the scan has been removed from the database.
REPORT_ERROR The report artifact provided by the CI build couldn’t be parsed.
SUCCEEDED The report has been successfully prepared.

SecurityPolicyRelationType

ValueDescription
DIRECT Policies defined for the project/group only.
INHERITED Policies defined for the project/group and ancestor groups.
INHERITED_ONLY Policies defined for the project/group’s ancestor groups only.

SecurityReportTypeEnum

ValueDescription
API_FUZZING API FUZZING scan report.
BREACH_AND_ATTACK_SIMULATION BREACH AND ATTACK SIMULATION scan report.
CLUSTER_IMAGE_SCANNING CLUSTER IMAGE SCANNING scan report.
CONTAINER_SCANNING CONTAINER SCANNING scan report.
COVERAGE_FUZZING COVERAGE FUZZING scan report.
DAST DAST scan report.
DEPENDENCY_SCANNING DEPENDENCY SCANNING scan report.
SAST SAST scan report.
SAST_IAC SAST IAC scan report.
SECRET_DETECTION SECRET DETECTION scan report.

SecurityScannerType

The type of the security scanner.

ValueDescription
API_FUZZING API Fuzzing scanner.
BREACH_AND_ATTACK_SIMULATION Breach And Attack Simulation scanner.
CLUSTER_IMAGE_SCANNING Cluster Image Scanning scanner.
CONTAINER_SCANNING Container Scanning scanner.
COVERAGE_FUZZING Coverage Fuzzing scanner.
DAST DAST scanner.
DEPENDENCY_SCANNING Dependency Scanning scanner.
SAST SAST scanner.
SAST_IAC Sast Iac scanner.
SECRET_DETECTION Secret Detection scanner.

SentryErrorStatus

State of a Sentry error.

ValueDescription
IGNORED Error has been ignored.
RESOLVED Error has been resolved.
RESOLVED_IN_NEXT_RELEASE Error has been ignored until next release.
UNRESOLVED Error is unresolved.

ServiceType

ValueDescription
APPLE_APP_STORE_SERVICE AppleAppStoreService type.
ASANA_SERVICE AsanaService type.
ASSEMBLA_SERVICE AssemblaService type.
BAMBOO_SERVICE BambooService type.
BUGZILLA_SERVICE BugzillaService type.
BUILDKITE_SERVICE BuildkiteService type.
CAMPFIRE_SERVICE CampfireService type.
CLICKUP_SERVICE ClickupService type.
CONFLUENCE_SERVICE ConfluenceService type.
CUSTOM_ISSUE_TRACKER_SERVICE CustomIssueTrackerService type.
DATADOG_SERVICE DatadogService type.
DISCORD_SERVICE DiscordService type.
DRONE_CI_SERVICE DroneCiService type.
EMAILS_ON_PUSH_SERVICE EmailsOnPushService type.
EWM_SERVICE EwmService type.
EXTERNAL_WIKI_SERVICE ExternalWikiService type.
GITHUB_SERVICE GithubService type.
GITLAB_SLACK_APPLICATION_SERVICE GitlabSlackApplicationService type.
GOOGLE_PLAY_SERVICE GooglePlayService type.
HANGOUTS_CHAT_SERVICE HangoutsChatService type.
HARBOR_SERVICE HarborService type.
IRKER_SERVICE IrkerService type.
JENKINS_SERVICE JenkinsService type.
JIRA_SERVICE JiraService type.
MATTERMOST_SERVICE MattermostService type.
MATTERMOST_SLASH_COMMANDS_SERVICE MattermostSlashCommandsService type.
MICROSOFT_TEAMS_SERVICE MicrosoftTeamsService type.
PACKAGIST_SERVICE PackagistService type.
PIPELINES_EMAIL_SERVICE PipelinesEmailService type.
PIVOTALTRACKER_SERVICE PivotaltrackerService type.
PROMETHEUS_SERVICE PrometheusService type.
PUMBLE_SERVICE PumbleService type.
PUSHOVER_SERVICE PushoverService type.
REDMINE_SERVICE RedmineService type.
SHIMO_SERVICE ShimoService type.
SLACK_SERVICE SlackService type.
SLACK_SLASH_COMMANDS_SERVICE SlackSlashCommandsService type.
SQUASH_TM_SERVICE SquashTmService type.
TEAMCITY_SERVICE TeamcityService type.
TELEGRAM_SERVICE TelegramService type.
UNIFY_CIRCUIT_SERVICE UnifyCircuitService type.
WEBEX_TEAMS_SERVICE WebexTeamsService type.
YOUTRACK_SERVICE YoutrackService type.
ZENTAO_SERVICE ZentaoService type.

ShaFormat

How to format SHA strings.

ValueDescription
LONG Unabbreviated format.
SHORT Abbreviated format. Short SHAs are typically eight characters long.

SharedRunnersSetting

ValueDescription
DISABLED_AND_OVERRIDABLE Sharing of runners is disabled and overridable.
DISABLED_AND_UNOVERRIDABLE Sharing of runners is disabled and unoverridable.
DISABLED_WITH_OVERRIDE Deprecated in 17.0. This was renamed. Use: disabled_and_overridable.
ENABLED Sharing of runners is enabled.

SnippetBlobActionEnum

Type of a snippet blob input action.

ValueDescription
create Create a snippet blob.
delete Delete a snippet blob.
move Move a snippet blob.
update Update a snippet blob.

Sort

Common sort values.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

SortDirectionEnum

Values for sort direction.

ValueDescription
ASC Ascending order.
DESC Descending order.

TestCaseStatus

ValueDescription
error Test case that has a status of error.
failed Test case that has a status of failed.
skipped Test case that has a status of skipped.
success Test case that has a status of success.

TestReportState

State of a test report.

ValueDescription
FAILED Failed test report.
PASSED Passed test report.

TimeboxReportErrorReason

Category of error.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
LABEL_PRIORITY_ASC Label priority by ascending order.
LABEL_PRIORITY_DESC Label priority by descending order.
MILESTONE_DUE_ASC Milestone due date by ascending order.
MILESTONE_DUE_DESC Milestone due date by descending order.
MISSING_DATES One or both of start_date and due_date is missing.
PRIORITY_ASC Priority by ascending order.
PRIORITY_DESC Priority by descending order.
TOO_MANY_EVENTS There are too many events.
UNSUPPORTED This type does not support timebox reports.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

TimelogSort

Values for sorting timelogs.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
SPENT_AT_ASC Spent at ascending order.
SPENT_AT_DESC Spent at descending order.
TIME_SPENT_ASC Time spent ascending order.
TIME_SPENT_DESC Time spent descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

TodoActionEnum

ValueDescription
approval_required User was set as an approver.
assigned User was assigned.
build_failed Build triggered by the user failed.
directly_addressed User was directly addressed.
marked User added a to-do item.
member_access_requested Group or project access requested from the user.
mentioned User was mentioned.
merge_train_removed Merge request authored by the user was removed from the merge train.
review_requested Review was requested from the user.
unmergeable Merge request authored by the user could not be merged.

TodoStateEnum

ValueDescription
done State of the todo is done.
pending State of the todo is pending.

TodoTargetEnum

ValueDescription
ALERT Alert.
COMMIT Commit.
DESIGN Design.
EPIC An Epic.
ISSUE Issue.
MERGEREQUEST Merge request.
WORKITEM Work item.

TrainingUrlRequestStatus

Status of the request to the training provider. The URL of a TrainingUrl is calculated asynchronously. When PENDING, the URL of the TrainingUrl will be null. When COMPLETED, the URL of the TrainingUrl will be available.

ValueDescription
COMPLETED Completed request.
PENDING Pending request.

TypeEnum

ValueDescription
personal Snippet created independent of any project.
project Snippet related to a specific project.

UserCalloutFeatureNameEnum

Name of the feature that the callout is for.

ValueDescription
ACTIVE_USER_COUNT_THRESHOLD Callout feature name for active_user_count_threshold.
ARTIFACTS_MANAGEMENT_PAGE_FEEDBACK_BANNER Callout feature name for artifacts_management_page_feedback_banner.
BRANCH_RULES_INFO_CALLOUT Callout feature name for branch_rules_info_callout.
BUY_PIPELINE_MINUTES_NOTIFICATION_DOT Callout feature name for buy_pipeline_minutes_notification_dot.
CANARY_DEPLOYMENT Callout feature name for canary_deployment.
CI_DEPRECATION_WARNING_FOR_TYPES_KEYWORD Callout feature name for ci_deprecation_warning_for_types_keyword.
CLOUD_LICENSING_SUBSCRIPTION_ACTIVATION_BANNER Callout feature name for cloud_licensing_subscription_activation_banner.
CLUSTER_SECURITY_WARNING Callout feature name for cluster_security_warning.
CODE_SUGGESTIONS_THIRD_PARTY_CALLOUT Callout feature name for code_suggestions_third_party_callout.
CREATE_RUNNER_WORKFLOW_BANNER Callout feature name for create_runner_workflow_banner.
EOA_BRONZE_PLAN_BANNER Callout feature name for eoa_bronze_plan_banner.
FEATURE_FLAGS_NEW_VERSION Callout feature name for feature_flags_new_version.
GCP_SIGNUP_OFFER Callout feature name for gcp_signup_offer.
GEO_ENABLE_HASHED_STORAGE Callout feature name for geo_enable_hashed_storage.
GEO_MIGRATE_HASHED_STORAGE Callout feature name for geo_migrate_hashed_storage.
GKE_CLUSTER_INTEGRATION Callout feature name for gke_cluster_integration.
GOLD_TRIAL_BILLINGS Callout feature name for gold_trial_billings.
MERGE_REQUEST_SETTINGS_MOVED_CALLOUT Callout feature name for merge_request_settings_moved_callout.
MR_EXPERIENCE_SURVEY Callout feature name for mr_experience_survey.
NAMESPACE_OVER_STORAGE_USERS_COMBINED_ALERT Callout feature name for namespace_over_storage_users_combined_alert.
NAMESPACE_STORAGE_LIMIT_ALERT_ALERT_THRESHOLD Callout feature name for namespace_storage_limit_alert_alert_threshold.
NAMESPACE_STORAGE_LIMIT_ALERT_ERROR_THRESHOLD Callout feature name for namespace_storage_limit_alert_error_threshold.
NAMESPACE_STORAGE_LIMIT_ALERT_WARNING_THRESHOLD Callout feature name for namespace_storage_limit_alert_warning_threshold.
NAMESPACE_STORAGE_PRE_ENFORCEMENT_BANNER Callout feature name for namespace_storage_pre_enforcement_banner.
NEW_NAVIGATION_CALLOUT Callout feature name for new_navigation_callout.
NEW_TOP_LEVEL_GROUP_ALERT Callout feature name for new_top_level_group_alert.
NEW_USER_SIGNUPS_CAP_REACHED Callout feature name for new_user_signups_cap_reached.
PERSONAL_ACCESS_TOKEN_EXPIRY Callout feature name for personal_access_token_expiry.
PERSONAL_PROJECT_LIMITATIONS_BANNER Callout feature name for personal_project_limitations_banner.
PIPELINE_NEEDS_BANNER Callout feature name for pipeline_needs_banner.
PIPELINE_NEEDS_HOVER_TIP Callout feature name for pipeline_needs_hover_tip.
PREVIEW_USER_OVER_LIMIT_FREE_PLAN_ALERT Callout feature name for preview_user_over_limit_free_plan_alert.
PROFILE_PERSONAL_ACCESS_TOKEN_EXPIRY Callout feature name for profile_personal_access_token_expiry.
PROJECT_QUALITY_SUMMARY_FEEDBACK Callout feature name for project_quality_summary_feedback.
PROJECT_REPOSITORY_LIMIT_ALERT_ALERT_THRESHOLD Callout feature name for project_repository_limit_alert_alert_threshold.
PROJECT_REPOSITORY_LIMIT_ALERT_ERROR_THRESHOLD Callout feature name for project_repository_limit_alert_error_threshold.
PROJECT_REPOSITORY_LIMIT_ALERT_WARNING_THRESHOLD Callout feature name for project_repository_limit_alert_warning_threshold.
REGISTRATION_ENABLED_CALLOUT Callout feature name for registration_enabled_callout.
RICH_TEXT_EDITOR Callout feature name for rich_text_editor.
SECURITY_CONFIGURATION_DEVOPS_ALERT Callout feature name for security_configuration_devops_alert.
SECURITY_CONFIGURATION_UPGRADE_BANNER Callout feature name for security_configuration_upgrade_banner.
SECURITY_NEWSLETTER_CALLOUT Callout feature name for security_newsletter_callout.
SECURITY_TRAINING_FEATURE_PROMOTION Callout feature name for security_training_feature_promotion.
SUBMIT_LICENSE_USAGE_DATA_BANNER Callout feature name for submit_license_usage_data_banner.
SUGGEST_PIPELINE Callout feature name for suggest_pipeline.
SUGGEST_POPOVER_DISMISSED Callout feature name for suggest_popover_dismissed.
TABS_POSITION_HIGHLIGHT Callout feature name for tabs_position_highlight.
TERRAFORM_NOTIFICATION_DISMISSED Callout feature name for terraform_notification_dismissed.
THREAT_MONITORING_INFO Callout feature name for threat_monitoring_info.
TRIAL_STATUS_REMINDER_D14 Callout feature name for trial_status_reminder_d14.
TRIAL_STATUS_REMINDER_D3 Callout feature name for trial_status_reminder_d3.
TWO_FACTOR_AUTH_RECOVERY_SETTINGS_CHECK Callout feature name for two_factor_auth_recovery_settings_check.
ULTIMATE_TRIAL Callout feature name for ultimate_trial.
UNFINISHED_TAG_CLEANUP_CALLOUT Callout feature name for unfinished_tag_cleanup_callout.
USER_REACHED_LIMIT_FREE_PLAN_ALERT Callout feature name for user_reached_limit_free_plan_alert.
VERIFICATION_REMINDER Callout feature name for verification_reminder.
WEB_IDE_ALERT_DISMISSED Callout feature name for web_ide_alert_dismissed.
WEB_IDE_CI_ENVIRONMENTS_GUIDANCE Callout feature name for web_ide_ci_environments_guidance.

UserState

Possible states of a user.

ValueDescription
active User is active and is able to use the system.
blocked User has been blocked and is prevented from using the system.
deactivated User is no longer active and is unable to use the system.

VerificationStateEnum

ValueDescription
DISABLED Verification process is disabled.
FAILED Verification process finished but failed.
PENDING Verification process has not started.
STARTED Verification process is in progress.
SUCCEEDED Verification process finished successfully.

VerificationStatus

Verification status of a GPG or X.509 signature for a commit.

ValueDescription
MULTIPLE_SIGNATURES multiple_signatures verification status.
OTHER_USER other_user verification status.
REVOKED_KEY revoked_key verification status.
SAME_USER_DIFFERENT_EMAIL same_user_different_email verification status.
UNKNOWN_KEY unknown_key verification status.
UNVERIFIED unverified verification status.
UNVERIFIED_KEY unverified_key verification status.
VERIFIED verified verification status.
VERIFIED_SYSTEM verified_system verification status.

VisibilityLevelsEnum

ValueDescription
internal Internal visibility level.
private Private visibility level.
public Public visibility level.

VisibilityPipelineIdType

Determines whether the pipeline list shows ID or IID.

ValueDescription
ID Display pipeline ID.
IID Display pipeline IID.

VisibilityScopesEnum

ValueDescription
internal Snippet is visible for any logged in user except external users.
private Snippet is visible only to the snippet creator.
public Snippet can be accessed without any authentication.

VulnerabilityConfidence

Confidence that a given vulnerability is present in the codebase.

ValueDescription
CONFIRMED Confirmed confidence.
EXPERIMENTAL Experimental confidence.
HIGH High confidence.
IGNORE Ignore confidence.
LOW Low confidence.
MEDIUM Medium confidence.
UNKNOWN Unknown confidence.

VulnerabilityDismissalReason

The dismissal reason of the Vulnerability.

ValueDescription
ACCEPTABLE_RISK The vulnerability is known, and has not been remediated or mitigated, but is considered to be an acceptable business risk.
FALSE_POSITIVE An error in reporting in which a test result incorrectly indicates the presence of a vulnerability in a system when the vulnerability is not present.
MITIGATING_CONTROL A management, operational, or technical control (that is, safeguard or countermeasure) employed by an organization that provides equivalent or comparable protection for an information system.
NOT_APPLICABLE The vulnerability is known, and has not been remediated or mitigated, but is considered to be in a part of the application that will not be updated.
USED_IN_TESTS The finding is not a vulnerability because it is part of a test or is test data.

VulnerabilityExternalIssueLinkExternalTracker

The external tracker of the external issue link related to a vulnerability.

ValueDescription
JIRA Jira external tracker.

VulnerabilityExternalIssueLinkType

The type of the external issue link related to a vulnerability.

ValueDescription
CREATED Created link type.

VulnerabilityGrade

The grade of the vulnerable project.

ValueDescription
A A grade.
B B grade.
C C grade.
D D grade.
F F grade.

VulnerabilityIssueLinkType

The type of the issue link related to a vulnerability.

ValueDescription
CREATED Issue is created for the vulnerability.
RELATED Has a related issue.

VulnerabilityReportType

The type of the security scan that found the vulnerability.

ValueDescription
API_FUZZING API Fuzzing report.
CLUSTER_IMAGE_SCANNING Cluster Image Scanning report.
CONTAINER_SCANNING Container Scanning report.
COVERAGE_FUZZING Coverage Fuzzing report.
DAST DAST report.
DEPENDENCY_SCANNING Dependency Scanning report.
GENERIC Generic report.
SAST SAST report.
SECRET_DETECTION Secret Detection report.

VulnerabilitySeverity

The severity of the vulnerability.

ValueDescription
CRITICAL Critical severity.
HIGH High severity.
INFO Info severity.
LOW Low severity.
MEDIUM Medium severity.
UNKNOWN Unknown severity.

VulnerabilitySort

Vulnerability sort values.

ValueDescription
detected_asc Detection timestamp in ascending order.
detected_desc Detection timestamp in descending order.
severity_asc Severity in ascending order.
severity_desc Severity in descending order.

VulnerabilityState

The state of the vulnerability.

ValueDescription
CONFIRMED For details, see vulnerability status values.
DETECTED For details, see vulnerability status values.
DISMISSED For details, see vulnerability status values.
RESOLVED For details, see vulnerability status values.

WeightWildcardId

Weight ID wildcard values.

ValueDescription
ANY Weight is assigned.
NONE No weight is assigned.

WorkItemAwardEmojiUpdateAction

Values for work item award emoji update enum.

ValueDescription
ADD Adds the emoji.
REMOVE Removes the emoji.

WorkItemSort

Values for sorting work items.

ValueDescription
CREATED_ASC Created at ascending order.
CREATED_DESC Created at descending order.
TITLE_ASC Title by ascending order.
TITLE_DESC Title by descending order.
UPDATED_ASC Updated at ascending order.
UPDATED_DESC Updated at descending order.
created_asc Deprecated in 13.5. This was renamed. Use: CREATED_ASC.
created_desc Deprecated in 13.5. This was renamed. Use: CREATED_DESC.
updated_asc Deprecated in 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc Deprecated in 13.5. This was renamed. Use: UPDATED_DESC.

WorkItemState

State of a GitLab work item.

ValueDescription
CLOSED In closed state.
OPEN In open state.

WorkItemStateEvent

Values for work item state events.

ValueDescription
CLOSE Closes the work item.
REOPEN Reopens the work item.

WorkItemTodoUpdateAction

Values for work item to-do update enum.

ValueDescription
ADD Adds the to-do.
MARK_AS_DONE Marks the to-do as done.

WorkItemWidgetType

Type of a work item widget.

ValueDescription
ASSIGNEES Assignees widget.
AWARD_EMOJI Award Emoji widget.
CURRENT_USER_TODOS Current User Todos widget.
DESCRIPTION Description widget.
HEALTH_STATUS Health Status widget.
HIERARCHY Hierarchy widget.
ITERATION Iteration widget.
LABELS Labels widget.
MILESTONE Milestone widget.
NOTES Notes widget.
NOTIFICATIONS Notifications widget.
PROGRESS Progress widget.
REQUIREMENT_LEGACY Requirement Legacy widget.
START_AND_DUE_DATE Start And Due Date widget.
STATUS Status widget.
TEST_REPORTS Test Reports widget.
WEIGHT Weight widget.

Scalar types

Scalar values are atomic values, and do not have fields of their own. Basic scalars include strings, boolean values, and numbers. This schema also defines various custom scalar values, such as types for times and dates.

This schema includes custom scalar types for identifiers, with a specific type for each kind of object.

For more information, read about Scalar Types on graphql.org.

AchievementsAchievementID

A AchievementsAchievementID is a global ID. It is encoded as a string.

An example AchievementsAchievementID is: "gid://gitlab/Achievements::Achievement/1".

AchievementsUserAchievementID

A AchievementsUserAchievementID is a global ID. It is encoded as a string.

An example AchievementsUserAchievementID is: "gid://gitlab/Achievements::UserAchievement/1".

AiModelID

A AiModelID is a global ID. It is encoded as a string.

An example AiModelID is: "gid://gitlab/Ai::Model/1".

AlertManagementAlertID

A AlertManagementAlertID is a global ID. It is encoded as a string.

An example AlertManagementAlertID is: "gid://gitlab/AlertManagement::Alert/1".

AlertManagementHttpIntegrationID

A AlertManagementHttpIntegrationID is a global ID. It is encoded as a string.

An example AlertManagementHttpIntegrationID is: "gid://gitlab/AlertManagement::HttpIntegration/1".

AnalyticsDevopsAdoptionEnabledNamespaceID

A AnalyticsDevopsAdoptionEnabledNamespaceID is a global ID. It is encoded as a string.

An example AnalyticsDevopsAdoptionEnabledNamespaceID is: "gid://gitlab/Analytics::DevopsAdoption::EnabledNamespace/1".

AppSecFuzzingCoverageCorpusID

A AppSecFuzzingCoverageCorpusID is a global ID. It is encoded as a string.

An example AppSecFuzzingCoverageCorpusID is: "gid://gitlab/AppSec::Fuzzing::Coverage::Corpus/1".

AuditEventsExternalAuditEventDestinationID

A AuditEventsExternalAuditEventDestinationID is a global ID. It is encoded as a string.

An example AuditEventsExternalAuditEventDestinationID is: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1".

AuditEventsGoogleCloudLoggingConfigurationID

A AuditEventsGoogleCloudLoggingConfigurationID is a global ID. It is encoded as a string.

An example AuditEventsGoogleCloudLoggingConfigurationID is: "gid://gitlab/AuditEvents::GoogleCloudLoggingConfiguration/1".

AuditEventsInstanceExternalAuditEventDestinationID

A AuditEventsInstanceExternalAuditEventDestinationID is a global ID. It is encoded as a string.

An example AuditEventsInstanceExternalAuditEventDestinationID is: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1".

AuditEventsStreamingHeaderID

A AuditEventsStreamingHeaderID is a global ID. It is encoded as a string.

An example AuditEventsStreamingHeaderID is: "gid://gitlab/AuditEvents::Streaming::Header/1".

AuditEventsStreamingInstanceHeaderID

A AuditEventsStreamingInstanceHeaderID is a global ID. It is encoded as a string.

An example AuditEventsStreamingInstanceHeaderID is: "gid://gitlab/AuditEvents::Streaming::InstanceHeader/1".

AwardableID

A AwardableID is a global ID. It is encoded as a string.

An example AwardableID is: "gid://gitlab/Awardable/1".

BigInt

Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it’s encoded as a string.

BoardID

A BoardID is a global ID. It is encoded as a string.

An example BoardID is: "gid://gitlab/Board/1".

BoardsEpicBoardID

A BoardsEpicBoardID is a global ID. It is encoded as a string.

An example BoardsEpicBoardID is: "gid://gitlab/Boards::EpicBoard/1".

BoardsEpicListID

A BoardsEpicListID is a global ID. It is encoded as a string.

An example BoardsEpicListID is: "gid://gitlab/Boards::EpicList/1".

Boolean

Represents true or false values.

CiBuildID

A CiBuildID is a global ID. It is encoded as a string.

An example CiBuildID is: "gid://gitlab/Ci::Build/1".

CiCatalogResourceID

A CiCatalogResourceID is a global ID. It is encoded as a string.

An example CiCatalogResourceID is: "gid://gitlab/Ci::Catalog::Resource/1".

CiJobArtifactID

A CiJobArtifactID is a global ID. It is encoded as a string.

An example CiJobArtifactID is: "gid://gitlab/Ci::JobArtifact/1".

CiPipelineID

A CiPipelineID is a global ID. It is encoded as a string.

An example CiPipelineID is: "gid://gitlab/Ci::Pipeline/1".

CiPipelineScheduleID

A CiPipelineScheduleID is a global ID. It is encoded as a string.

An example CiPipelineScheduleID is: "gid://gitlab/Ci::PipelineSchedule/1".

CiPipelineScheduleVariableID

A CiPipelineScheduleVariableID is a global ID. It is encoded as a string.

An example CiPipelineScheduleVariableID is: "gid://gitlab/Ci::PipelineScheduleVariable/1".

CiRunnerID

A CiRunnerID is a global ID. It is encoded as a string.

An example CiRunnerID is: "gid://gitlab/Ci::Runner/1".

CiRunnerManagerID

A CiRunnerManagerID is a global ID. It is encoded as a string.

An example CiRunnerManagerID is: "gid://gitlab/Ci::RunnerManager/1".

CiStageID

A CiStageID is a global ID. It is encoded as a string.

An example CiStageID is: "gid://gitlab/Ci::Stage/1".

ClustersAgentID

A ClustersAgentID is a global ID. It is encoded as a string.

An example ClustersAgentID is: "gid://gitlab/Clusters::Agent/1".

ClustersAgentTokenID

A ClustersAgentTokenID is a global ID. It is encoded as a string.

An example ClustersAgentTokenID is: "gid://gitlab/Clusters::AgentToken/1".

ClustersClusterID

A ClustersClusterID is a global ID. It is encoded as a string.

An example ClustersClusterID is: "gid://gitlab/Clusters::Cluster/1".

Color

Color represented as a hex code or named color.

For example: “#fefefe”.

ComplianceManagementFrameworkID

A ComplianceManagementFrameworkID is a global ID. It is encoded as a string.

An example ComplianceManagementFrameworkID is: "gid://gitlab/ComplianceManagement::Framework/1".

ContainerRepositoryID

A ContainerRepositoryID is a global ID. It is encoded as a string.

An example ContainerRepositoryID is: "gid://gitlab/ContainerRepository/1".

CustomEmojiID

A CustomEmojiID is a global ID. It is encoded as a string.

An example CustomEmojiID is: "gid://gitlab/CustomEmoji/1".

CustomerRelationsContactID

A CustomerRelationsContactID is a global ID. It is encoded as a string.

An example CustomerRelationsContactID is: "gid://gitlab/CustomerRelations::Contact/1".

CustomerRelationsOrganizationID

A CustomerRelationsOrganizationID is a global ID. It is encoded as a string.

An example CustomerRelationsOrganizationID is: "gid://gitlab/CustomerRelations::Organization/1".

DastProfileID

A DastProfileID is a global ID. It is encoded as a string.

An example DastProfileID is: "gid://gitlab/Dast::Profile/1".

DastProfileScheduleID

A DastProfileScheduleID is a global ID. It is encoded as a string.

An example DastProfileScheduleID is: "gid://gitlab/Dast::ProfileSchedule/1".

DastScannerProfileID

A DastScannerProfileID is a global ID. It is encoded as a string.

An example DastScannerProfileID is: "gid://gitlab/DastScannerProfile/1".

DastSiteProfileID

A DastSiteProfileID is a global ID. It is encoded as a string.

An example DastSiteProfileID is: "gid://gitlab/DastSiteProfile/1".

DastSiteTokenID

A DastSiteTokenID is a global ID. It is encoded as a string.

An example DastSiteTokenID is: "gid://gitlab/DastSiteToken/1".

DastSiteValidationID

A DastSiteValidationID is a global ID. It is encoded as a string.

An example DastSiteValidationID is: "gid://gitlab/DastSiteValidation/1".

Date

Date represented in ISO 8601.

DependencyProxyManifestID

A DependencyProxyManifestID is a global ID. It is encoded as a string.

An example DependencyProxyManifestID is: "gid://gitlab/DependencyProxy::Manifest/1".

DeploymentID

A DeploymentID is a global ID. It is encoded as a string.

An example DeploymentID is: "gid://gitlab/Deployment/1".

DescriptionVersionID

A DescriptionVersionID is a global ID. It is encoded as a string.

An example DescriptionVersionID is: "gid://gitlab/DescriptionVersion/1".

DesignManagementDesignAtVersionID

A DesignManagementDesignAtVersionID is a global ID. It is encoded as a string.

An example DesignManagementDesignAtVersionID is: "gid://gitlab/DesignManagement::DesignAtVersion/1".

DesignManagementDesignID

A DesignManagementDesignID is a global ID. It is encoded as a string.

An example DesignManagementDesignID is: "gid://gitlab/DesignManagement::Design/1".

DesignManagementVersionID

A DesignManagementVersionID is a global ID. It is encoded as a string.

An example DesignManagementVersionID is: "gid://gitlab/DesignManagement::Version/1".

DiffNoteID

A DiffNoteID is a global ID. It is encoded as a string.

An example DiffNoteID is: "gid://gitlab/DiffNote/1".

DiscussionID

A DiscussionID is a global ID. It is encoded as a string.

An example DiscussionID is: "gid://gitlab/Discussion/1".

Duration

Duration between two instants, represented as a fractional number of seconds.

For example: 12.3334.

EmailID

A EmailID is a global ID. It is encoded as a string.

An example EmailID is: "gid://gitlab/Email/1".

EnvironmentID

A EnvironmentID is a global ID. It is encoded as a string.

An example EnvironmentID is: "gid://gitlab/Environment/1".

EpicID

A EpicID is a global ID. It is encoded as a string.

An example EpicID is: "gid://gitlab/Epic/1".

EpicTreeSortingID

A EpicTreeSortingID is a global ID. It is encoded as a string.

An example EpicTreeSortingID is: "gid://gitlab/EpicTreeSorting/1".

Float

Represents signed double-precision fractional values as specified by IEEE 754.

GeoBaseRegistryID

A GeoBaseRegistryID is a global ID. It is encoded as a string.

An example GeoBaseRegistryID is: "gid://gitlab/Geo::BaseRegistry/1".

GitlabErrorTrackingDetailedErrorID

A GitlabErrorTrackingDetailedErrorID is a global ID. It is encoded as a string.

An example GitlabErrorTrackingDetailedErrorID is: "gid://gitlab/Gitlab::ErrorTracking::DetailedError/1".

GitlabSubscriptionsAddOnPurchaseID

A GitlabSubscriptionsAddOnPurchaseID is a global ID. It is encoded as a string.

An example GitlabSubscriptionsAddOnPurchaseID is: "gid://gitlab/GitlabSubscriptions::AddOnPurchase/1".

GlobalID

A global identifier.

A global identifier represents an object uniquely across the application. An example of a global identifier is "gid://gitlab/User/1".

gid://gitlab stands for the root name. User is the name of the ActiveRecord class of the record. 1 is the record id as per the id in the db table.

Global identifiers are encoded as strings.

GroupID

A GroupID is a global ID. It is encoded as a string.

An example GroupID is: "gid://gitlab/Group/1".

ID

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

ISO8601Date

An ISO 8601-encoded date.

IncidentManagementEscalationPolicyID

A IncidentManagementEscalationPolicyID is a global ID. It is encoded as a string.

An example IncidentManagementEscalationPolicyID is: "gid://gitlab/IncidentManagement::EscalationPolicy/1".

IncidentManagementEscalationRuleID

A IncidentManagementEscalationRuleID is a global ID. It is encoded as a string.

An example IncidentManagementEscalationRuleID is: "gid://gitlab/IncidentManagement::EscalationRule/1".

IncidentManagementIssuableResourceLinkID

A IncidentManagementIssuableResourceLinkID is a global ID. It is encoded as a string.

An example IncidentManagementIssuableResourceLinkID is: "gid://gitlab/IncidentManagement::IssuableResourceLink/1".

IncidentManagementOncallParticipantID

A IncidentManagementOncallParticipantID is a global ID. It is encoded as a string.

An example IncidentManagementOncallParticipantID is: "gid://gitlab/IncidentManagement::OncallParticipant/1".

IncidentManagementOncallRotationID

A IncidentManagementOncallRotationID is a global ID. It is encoded as a string.

An example IncidentManagementOncallRotationID is: "gid://gitlab/IncidentManagement::OncallRotation/1".

IncidentManagementTimelineEventID

A IncidentManagementTimelineEventID is a global ID. It is encoded as a string.

An example IncidentManagementTimelineEventID is: "gid://gitlab/IncidentManagement::TimelineEvent/1".

IncidentManagementTimelineEventTagID

A IncidentManagementTimelineEventTagID is a global ID. It is encoded as a string.

An example IncidentManagementTimelineEventTagID is: "gid://gitlab/IncidentManagement::TimelineEventTag/1".

Int

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

IntegrationsPrometheusID

A IntegrationsPrometheusID is a global ID. It is encoded as a string.

An example IntegrationsPrometheusID is: "gid://gitlab/Integrations::Prometheus/1". The older format "gid://gitlab/PrometheusService/1" was deprecated in 14.1.

IssuableID

A IssuableID is a global ID. It is encoded as a string.

An example IssuableID is: "gid://gitlab/Issuable/1".

IssueID

A IssueID is a global ID. It is encoded as a string.

An example IssueID is: "gid://gitlab/Issue/1".

IssueParentID

A IssueParentID is a global ID. It is encoded as a string.

An example IssueParentID is: "gid://gitlab/IssueParent/1".

IterationID

A IterationID is a global ID. It is encoded as a string.

An example IterationID is: "gid://gitlab/Iteration/1". The older format "gid://gitlab/EEIteration/1" was deprecated in 13.3.

IterationsCadenceID

A IterationsCadenceID is a global ID. It is encoded as a string.

An example IterationsCadenceID is: "gid://gitlab/Iterations::Cadence/1".

JSON

Represents untyped JSON.

JobID

A CommitStatusID is a global ID. It is encoded as a string.

An example CommitStatusID is: "gid://gitlab/CommitStatus/1".

JsonString

JSON object as raw string.

LabelID

A LabelID is a global ID. It is encoded as a string.

An example LabelID is: "gid://gitlab/Label/1".

ListID

A ListID is a global ID. It is encoded as a string.

An example ListID is: "gid://gitlab/List/1".

MergeRequestID

A MergeRequestID is a global ID. It is encoded as a string.

An example MergeRequestID is: "gid://gitlab/MergeRequest/1".

MetricsDashboardAnnotationID

A MetricsDashboardAnnotationID is a global ID. It is encoded as a string.

An example MetricsDashboardAnnotationID is: "gid://gitlab/Metrics::Dashboard::Annotation/1".

MilestoneID

A MilestoneID is a global ID. It is encoded as a string.

An example MilestoneID is: "gid://gitlab/Milestone/1".

NamespaceID

A NamespaceID is a global ID. It is encoded as a string.

An example NamespaceID is: "gid://gitlab/Namespace/1".

NamespacesNamespaceBanID

A NamespacesNamespaceBanID is a global ID. It is encoded as a string.

An example NamespacesNamespaceBanID is: "gid://gitlab/Namespaces::NamespaceBan/1".

NoteID

A NoteID is a global ID. It is encoded as a string.

An example NoteID is: "gid://gitlab/Note/1".

NoteableID

A NoteableID is a global ID. It is encoded as a string.

An example NoteableID is: "gid://gitlab/Noteable/1".

PackagesConanFileMetadatumID

A PackagesConanFileMetadatumID is a global ID. It is encoded as a string.

An example PackagesConanFileMetadatumID is: "gid://gitlab/Packages::Conan::FileMetadatum/1".

PackagesConanMetadatumID

A PackagesConanMetadatumID is a global ID. It is encoded as a string.

An example PackagesConanMetadatumID is: "gid://gitlab/Packages::Conan::Metadatum/1".

PackagesDependencyID

A PackagesDependencyID is a global ID. It is encoded as a string.

An example PackagesDependencyID is: "gid://gitlab/Packages::Dependency/1".

PackagesDependencyLinkID

A PackagesDependencyLinkID is a global ID. It is encoded as a string.

An example PackagesDependencyLinkID is: "gid://gitlab/Packages::DependencyLink/1".

PackagesMavenMetadatumID

A PackagesMavenMetadatumID is a global ID. It is encoded as a string.

An example PackagesMavenMetadatumID is: "gid://gitlab/Packages::Maven::Metadatum/1".

PackagesNugetDependencyLinkMetadatumID

A PackagesNugetDependencyLinkMetadatumID is a global ID. It is encoded as a string.

An example PackagesNugetDependencyLinkMetadatumID is: "gid://gitlab/Packages::Nuget::DependencyLinkMetadatum/1".

PackagesNugetMetadatumID

A PackagesNugetMetadatumID is a global ID. It is encoded as a string.

An example PackagesNugetMetadatumID is: "gid://gitlab/Packages::Nuget::Metadatum/1".

PackagesPackageFileID

A PackagesPackageFileID is a global ID. It is encoded as a string.

An example PackagesPackageFileID is: "gid://gitlab/Packages::PackageFile/1".

PackagesPackageID

A PackagesPackageID is a global ID. It is encoded as a string.

An example PackagesPackageID is: "gid://gitlab/Packages::Package/1".

PackagesPypiMetadatumID

A PackagesPypiMetadatumID is a global ID. It is encoded as a string.

An example PackagesPypiMetadatumID is: "gid://gitlab/Packages::Pypi::Metadatum/1".

PathLockID

A PathLockID is a global ID. It is encoded as a string.

An example PathLockID is: "gid://gitlab/PathLock/1".

PayloadAlertFieldPathSegment

String or integer.

ProjectID

A ProjectID is a global ID. It is encoded as a string.

An example ProjectID is: "gid://gitlab/Project/1".

ReleaseID

A ReleaseID is a global ID. It is encoded as a string.

An example ReleaseID is: "gid://gitlab/Release/1".

ReleasesLinkID

A ReleasesLinkID is a global ID. It is encoded as a string.

An example ReleasesLinkID is: "gid://gitlab/Releases::Link/1".

RemoteDevelopmentWorkspaceID

A RemoteDevelopmentWorkspaceID is a global ID. It is encoded as a string.

An example RemoteDevelopmentWorkspaceID is: "gid://gitlab/RemoteDevelopment::Workspace/1".

SecurityTrainingProviderID

A SecurityTrainingProviderID is a global ID. It is encoded as a string.

An example SecurityTrainingProviderID is: "gid://gitlab/Security::TrainingProvider/1".

SnippetID

A SnippetID is a global ID. It is encoded as a string.

An example SnippetID is: "gid://gitlab/Snippet/1".

String

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

SystemNoteMetadataID

A SystemNoteMetadataID is a global ID. It is encoded as a string.

An example SystemNoteMetadataID is: "gid://gitlab/SystemNoteMetadata/1".

TerraformStateID

A TerraformStateID is a global ID. It is encoded as a string.

An example TerraformStateID is: "gid://gitlab/Terraform::State/1".

Time

Time represented in ISO 8601.

For example: “2021-03-09T14:58:50+00:00”.

See https://www.iso.org/iso-8601-date-and-time-format.html.

TimelogID

A TimelogID is a global ID. It is encoded as a string.

An example TimelogID is: "gid://gitlab/Timelog/1".

TodoID

A TodoID is a global ID. It is encoded as a string.

An example TodoID is: "gid://gitlab/Todo/1".

TodoableID

A TodoableID is a global ID. It is encoded as a string.

An example TodoableID is: "gid://gitlab/Todoable/1".

UntrustedRegexp

A regexp containing patterns sourced from user input.

Upload

UploadID

A UploadID is a global ID. It is encoded as a string.

An example UploadID is: "gid://gitlab/Upload/1".

UserID

A UserID is a global ID. It is encoded as a string.

An example UserID is: "gid://gitlab/User/1".

UsersSavedReplyID

A UsersSavedReplyID is a global ID. It is encoded as a string.

An example UsersSavedReplyID is: "gid://gitlab/Users::SavedReply/1".

VulnerabilitiesExternalIssueLinkID

A VulnerabilitiesExternalIssueLinkID is a global ID. It is encoded as a string.

An example VulnerabilitiesExternalIssueLinkID is: "gid://gitlab/Vulnerabilities::ExternalIssueLink/1".

VulnerabilitiesScannerID

A VulnerabilitiesScannerID is a global ID. It is encoded as a string.

An example VulnerabilitiesScannerID is: "gid://gitlab/Vulnerabilities::Scanner/1".

VulnerabilityID

A VulnerabilityID is a global ID. It is encoded as a string.

An example VulnerabilityID is: "gid://gitlab/Vulnerability/1".

WorkItemID

A WorkItemID is a global ID. It is encoded as a string.

An example WorkItemID is: "gid://gitlab/WorkItem/1".

While we transition from Issues into Work Items this type will temporarily support IssueID like: "gid://gitlab/Issue/1". This behavior will be removed without notice in the future.

WorkItemsTypeID

A WorkItemsTypeID is a global ID. It is encoded as a string.

An example WorkItemsTypeID is: "gid://gitlab/WorkItems::Type/1".

Abstract types

Abstract types (unions and interfaces) are ways the schema can represent values that may be one of several concrete types.

  • A Union is a set of possible types. The types might not have any fields in common.
  • An Interface is a defined set of fields. Types may implement an interface, which guarantees that they have all the fields in the set. A type may implement more than one interface.

See the GraphQL documentation for more information on using abstract types.

Unions

DependencyLinkMetadata

Represents metadata associated with a dependency link.

One of:

Issuable

Represents an issuable.

One of:

JobNeedUnion

One of:

NoteableType

Represents an object that supports notes.

One of:

PackageMetadata

Represents metadata associated with a Package.

One of:

Registrable

One of:

SecurityPolicySource

Represents a policy source. Its fields depend on the source type.

One of:

VulnerabilityDetail

Represents a vulnerability detail field. The fields with data will depend on the vulnerability detail type.

One of:

VulnerabilityLocation

Represents a vulnerability location. The fields with data will depend on the vulnerability report type.

One of:

Interfaces

AlertManagementIntegration

Implementations:

Fields
NameTypeDescription
active BooleanWhether the endpoint is currently accepting alerts.
apiUrl StringURL at which Prometheus metrics can be queried to populate the metrics dashboard.
id ID!ID of the integration.
name StringName of the integration.
token StringToken used to authenticate alert notification requests.
type AlertManagementIntegrationType!Type of integration.
url StringEndpoint which accepts alert notifications.

BaseHeaderInterface

Implementations:

Fields
NameTypeDescription
id ID!ID of the header.
key String!Key of the header.
value String!Value of the header.

CiVariable

Implementations:

Fields
NameTypeDescription
id ID!ID of the variable.
key StringName of the variable.
raw BooleanIndicates whether the variable is raw.
value StringValue of the variable.
variableType CiVariableTypeType of the variable.

CommitSignature

Represents signing information for a commit.

Implementations:

Fields
NameTypeDescription
commitSha StringSHA of the associated commit.
project ProjectProject of the associated commit.
verificationStatus VerificationStatusIndicates verification status of the associated key or certificate.

CurrentUserTodos

Implementations:

Fields with arguments
CurrentUserTodos.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

# Arguments
NameTypeDescription
state TodoStateEnumState of the to-do items.

DesignFields

Implementations:

Fields
NameTypeDescription
diffRefs DiffRefs!Diff refs for this design.
event DesignVersionEvent!How this design was changed in the current version.
filename String!Filename of the design.
fullPath String!Full path to the design file.
id ID!ID of this design.
image String!URL of the full-sized image.
imageV432x230 StringThe URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
issue Issue!Issue the design belongs to.
notesCount Int!Total count of user-created notes for this design.
project Project!Project the design belongs to.

Entry

Implementations:

Fields
NameTypeDescription
flatPath String!Flat path of the entry.
id ID!ID of the entry.
name String!Name of the entry.
path String!Path of the entry.
sha String!Last commit SHA for the entry.
type EntryType!Type of tree entry.

Eventable

Implementations:

Fields
NameTypeDescription
events EventConnectionList of events associated with the object. (see Connections)

ExternalAuditEventDestinationInterface

Implementations:

Fields
NameTypeDescription
destinationUrl String!External destination to send audit events to.
eventTypeFilters [String!]!List of event type filters added for streaming.
id ID!ID of the destination.
name String!Name of the external destination to send audit events to.
verificationToken String!Verification token to validate source of event.

MemberInterface

Implementations:

Fields
NameTypeDescription
accessLevel AccessLevelGitLab::Access level.
createdAt TimeDate and time the membership was created.
createdBy UserCoreUser that authorized membership.
expiresAt TimeDate and time the membership expires.
id ID!ID of the member.
updatedAt TimeDate and time the membership was last updated.
user UserCoreUser that is associated with the member object.
Fields with arguments
MemberInterface.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

# Arguments
NameTypeDescription
id MergeRequestID!Global ID of the merge request.

NoteableInterface

Implementations:

Fields
NameTypeDescription
commenters UserCoreConnection!All commenters on this noteable. (see Connections)
discussions DiscussionConnection!All discussions on this noteable. (see Connections)
notes NoteConnection!All notes on this noteable. (see Connections)

OrchestrationPolicy

Implementations:

Fields
NameTypeDescription
description String!Description of the policy.
enabled Boolean!Indicates whether this policy is enabled.
name String!Name of the policy.
updatedAt Time!Timestamp of when the policy YAML was last updated.
yaml String!YAML definition of the policy.

PackageFileMetadata

Represents metadata associated with a Package file.

Implementations:

Fields
NameTypeDescription
createdAt Time!Date of creation.
updatedAt Time!Date of most recent update.

ResolvableInterface

Implementations:

Fields
NameTypeDescription
resolvable Boolean!Indicates if the object can be resolved.
resolved Boolean!Indicates if the object is resolved.
resolvedAt TimeTimestamp of when the object was resolved.
resolvedBy UserCoreUser who resolved the object.

Service

Implementations:

Fields
NameTypeDescription
active BooleanIndicates if the service is active.
serviceType ServiceTypeType of the service.
type StringClass name of the service.

TimeboxReportInterface

Implementations:

Fields with arguments
TimeboxReportInterface.report

Historically accurate report about the timebox.

Returns TimeboxReport.

# Arguments
NameTypeDescription
fullPath StringFull path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

Todoable

Implementations:

Fields
NameTypeDescription
webUrl StringURL of this object.

User

Representation of a GitLab user.

Implementations:

Fields
NameTypeDescription
avatarUrl StringURL of the user’s avatar.
bio StringBio of the user.
bot Boolean!Indicates if the user is a bot.
callouts UserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmail StringUser’s default commit email.
createdAt TimeTimestamp of when the user was created.
discord StringDiscord ID of the user.
email String Deprecated in 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnectionUser’s email addresses. (see Connections)
gitpodEnabled BooleanWhether Gitpod is enabled at the user level.
groupCount IntGroup count for the user.
groupMemberships GroupMemberConnectionGroup memberships of the user. (see Connections)
id ID!ID of the user.
ide IdeIDE settings.
jobTitle StringJob title of the user.
linkedin StringLinkedIn profile name of the user.
location StringLocation of the user.
name String!Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace NamespacePersonal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organization StringWho the user represents or works for.
preferencesGitpodPath StringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPath StringWeb path to enable Gitpod for the user.
projectMemberships ProjectMemberConnectionProject memberships of the user. (see Connections)
pronouns StringPronouns of the user.
publicEmail StringUser’s public email.
savedReplies SavedReplyConnectionSaved replies authored by the user. Will not return saved replies if saved_replies feature flag is disabled. (see Connections)
state UserState!State of the user.
status UserStatusUser status.
twitter StringTwitter username of the user.
userAchievements UserAchievementConnection Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
userPermissions UserPermissions!Permissions for the current user on the resource.
username String!Username of the user. Unique within this instance of GitLab.
webPath String!Web path of the user.
webUrl String!Web URL of the user.
Fields with arguments
User.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

# Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
User.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

# Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
reviewerUsername StringUsername of the reviewer.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
User.groups

Groups where the user has access.

Returns GroupConnection.

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

# Arguments
NameTypeDescription
permissionScope GroupPermissionFilter by permissions the user has on groups.
search StringSearch by group name or path.
User.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

# Arguments
NameTypeDescription
approved BooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
assigneeUsername StringUsername of the assignee.
authorUsername StringUsername of the author.
createdAfter TimeMerge requests created after this timestamp.
createdBefore TimeMerge requests created before this timestamp.
draft BooleanLimit result to draft merge requests.
groupId GroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids [String!]Array of IIDs of merge requests, for example [1, 2].
labels [String!]Array of label names. All resolved merge requests will have all of these labels.
mergedAfter TimeMerge requests merged after this date.
mergedBefore TimeMerge requests merged before this date.
milestoneTitle StringTitle of the milestone.
not MergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectId ProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath StringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
sort MergeRequestSortSort merge requests by this criteria.
sourceBranches [String!]Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestStateMerge request state. If provided, all resolved merge requests will have this state.
targetBranches [String!]Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter TimeMerge requests updated after this timestamp.
updatedBefore TimeMerge requests updated before this timestamp.
User.savedReply

Saved reply authored by the user. Will not return saved reply if saved_replies feature flag is disabled.

Returns SavedReply.

# Arguments
NameTypeDescription
id UsersSavedReplyID!ID of a saved reply.
User.snippets

Snippets authored by the 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
ids [SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnumType of snippet.
visibility VisibilityScopesEnumVisibility of the snippet.
User.starredProjects

Projects starred by the 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
search StringSearch query.
User.timelogs

Time logged by the 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.
User.todos

To-do items of the user.

Returns TodoConnection.

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

# 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.
state [TodoStateEnum!]State of the todo.
type [TodoTargetEnum!]Type of the todo.
User.workspaces

Workspaces owned by the current user.

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.

WorkItemWidget

Implementations:

Fields
NameTypeDescription
type WorkItemWidgetTypeWidget type.

Input types

Types that may be used as arguments (all scalar types may also be used as arguments).

Only general use input types are listed here. For mutation input types, see the associated mutation type above.

AiChatInput

Arguments

NameTypeDescription
content String!Content of the message.
namespaceId NamespaceIDGlobal ID of the namespace the user is acting on.
resourceId AiModelIDGlobal ID of the resource to mutate.

AiExplainCodeInput

Arguments

NameTypeDescription
messages [AiExplainCodeMessageInput!]!Code messages that is passed to be explained by AI.
resourceId AiModelID!Global ID of the resource to mutate.

AiExplainCodeMessageInput

Arguments

NameTypeDescription
content String!Content of the message.
role String!Role of the message (system, user, assistant).

AiExplainVulnerabilityInput

Arguments

NameTypeDescription
includeSourceCode BooleanInclude vulnerablility source code in the AI prompt.
resourceId AiModelID!Global ID of the resource to mutate.

AiFillInMergeRequestTemplateInput

Arguments

NameTypeDescription
content String!Template content to fill in.
resourceId AiModelID!Global ID of the resource to mutate.
sourceBranch String!Source branch of the changes.
sourceProjectId IDID of the project where the changes are from.
targetBranch String!Target branch of where the changes will be merged into.
title String!Title of the merge request to be created.

AiGenerateCommitMessageInput

Arguments

NameTypeDescription
resourceId AiModelID!Global ID of the resource to mutate.

AiGenerateDescriptionInput

Arguments

NameTypeDescription
content String!Content of the message.
descriptionTemplateName StringName of the description template to use to generate message off of.
resourceId AiModelID!Global ID of the resource to mutate.

AiSummarizeCommentsInput

Arguments

NameTypeDescription
resourceId AiModelID!Global ID of the resource to mutate.

AiSummarizeReviewInput

Arguments

NameTypeDescription
resourceId AiModelID!Global ID of the resource to mutate.

AiTanukiBotInput

Arguments

NameTypeDescription
question String!GitLab documentation question for AI to answer.
resourceId AiModelID!Global ID of the resource to mutate.

AlertManagementPayloadAlertFieldInput

Field that are available while modifying the custom mapping attributes for an HTTP integration.

Arguments

NameTypeDescription
fieldName AlertManagementPayloadAlertFieldName!GitLab alert field name.
label StringHuman-readable label of the payload path.
path [PayloadAlertFieldPathSegment!]!Path to value inside payload JSON.
type AlertManagementPayloadAlertFieldType!Type of the parsed value.

AnalyzeCiJobFailureInput

Arguments

NameTypeDescription
resourceId AiModelID!Global ID of the resource to mutate.

BoardIssueInput

Arguments

NameTypeDescription
assigneeUsername [String]Filter by assignee username.
assigneeWildcardId AssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername StringFilter by author username.
confidential BooleanFilter by confidentiality.
epicId EpicIDFilter by epic ID. Incompatible with epicWildcardId.
epicWildcardId EpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatusFilter HealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iids [String!]List of IIDs of issues. For example ["1", "2"].
iterationCadenceId [IterationsCadenceID!]Filter by a list of iteration cadence IDs.
iterationId [IterationID!]Filter by a list of iteration IDs. Incompatible with iterationWildcardId.
iterationTitle StringFilter by iteration title.
iterationWildcardId IterationWildcardIdFilter by iteration ID wildcard.
labelName [String]Filter by label name.
milestoneTitle StringFilter by milestone title.
milestoneWildcardId MilestoneWildcardIdFilter by milestone ID wildcard.
myReactionEmoji StringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedBoardIssueInputList of negated arguments.
or UnionedIssueFilterInputList of arguments with inclusive OR.
releaseTag StringFilter by release tag.
search StringSearch query for issue title or description.
types [IssueType!]Filter by the given issue types.
weight StringFilter by weight.
weightWildcardId WeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.

CiVariableInput

Attributes for defining a CI/CD variable.

Arguments

NameTypeDescription
key String!Name of the variable.
value String!Value of the variable.

CommitAction

Arguments

NameTypeDescription
action CommitActionMode!Action to perform: create, delete, move, update, or chmod.
content StringContent of the file.
encoding CommitEncodingEncoding of the file. Default is text.
executeFilemode BooleanEnables/disables the execute flag on the file.
filePath String!Full path to the file.
lastCommitId StringLast known file commit ID.
previousPath StringOriginal full path to the file being moved.

ComplianceFrameworkFilters

Arguments

NameTypeDescription
id ComplianceManagementFrameworkIDID of the compliance framework.
not NegatedComplianceFrameworkFiltersNegated compliance framework filter input.
presenceFilter ComplianceFrameworkPresenceFilterChecks presence of compliance framework of the project, “none” and “any” values are supported.

ComplianceFrameworkInput

Arguments

NameTypeDescription
color StringNew color representation of the compliance framework in hex format. e.g. #FCA121.
default BooleanSet this compliance framework as the default framework for the group.
description StringNew description for the compliance framework.
name StringNew name for the compliance framework.
pipelineConfigurationFullPath StringFull path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa .

ComplianceStandardsAdherenceInput

Arguments

NameTypeDescription
checkName ComplianceStandardsAdherenceCheckNameName of the check for the compliance standard.
projectIds [ProjectID!]Filter compliance standards adherence by project.
standard ComplianceStandardsAdherenceStandardName of the compliance standard.

ComplianceViolationInput

Arguments

NameTypeDescription
mergedAfter DateMerge requests merged after this date (inclusive).
mergedBefore DateMerge requests merged before this date (inclusive).
projectIds [ProjectID!]Filter compliance violations by project.
targetBranch StringFilter compliance violations by target branch.

DastProfileCadenceInput

Represents DAST Profile Cadence.

Arguments

NameTypeDescription
duration IntDuration of the DAST Profile Cadence.
unit DastProfileCadenceUnitUnit for the duration of DAST Profile Cadence.

DastProfileScheduleInput

Input type for DAST Profile Schedules.

Arguments

NameTypeDescription
active BooleanStatus of a Dast Profile Schedule.
cadence DastProfileCadenceInputCadence of a Dast Profile Schedule.
startsAt TimeStart time of a Dast Profile Schedule.
timezone StringTime Zone for the Start time of a Dast Profile Schedule.

DastSiteProfileAuthInput

Input type for DastSiteProfile authentication.

Arguments

NameTypeDescription
enabled BooleanIndicates whether authentication is enabled.
password StringPassword to authenticate with on the target.
passwordField StringName of password field at the sign-in HTML form.
submitField StringName or ID of sign-in submit button at the sign-in HTML form.
url StringThe URL of the page containing the sign-in HTML form on the target website.
username StringUsername to authenticate with on the target.
usernameField StringName of username field at the sign-in HTML form.

DeploymentsOrderByInput

Values for ordering deployments by a specific field.

Arguments

NameTypeDescription
createdAt SortDirectionEnumOrder by Created time.
finishedAt SortDirectionEnumOrder by Finished time.

DiffImagePositionInput

Arguments

NameTypeDescription
baseSha StringMerge base of the branch the comment was made on.
headSha String!SHA of the HEAD at the time the comment was made.
height Int!Total height of the image.
paths DiffPathsInput!The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required.
startSha String!SHA of the branch being compared against.
width Int!Total width of the image.
x Int!X position of the note.
y Int!Y position of the note.

DiffPathsInput

Arguments

NameTypeDescription
newPath StringPath of the file on the HEAD SHA.
oldPath StringPath of the file on the start SHA.

DiffPositionInput

Arguments

NameTypeDescription
baseSha StringMerge base of the branch the comment was made on.
headSha String!SHA of the HEAD at the time the comment was made.
newLine IntLine on HEAD SHA that was changed. Please see the REST API Documentation for more information on how to use this field.
oldLine IntLine on start SHA that was changed. Please see the REST API Documentation for more information on how to use this field.
paths DiffPathsInput!The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required.
startSha String!SHA of the branch being compared against.

EpicFilters

Arguments

NameTypeDescription
authorUsername StringFilter by author username.
confidential BooleanFilter by confidentiality.
labelName [String]Filter by label name.
myReactionEmoji StringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedEpicBoardIssueInputNegated epic arguments.
or UnionedEpicFilterInputList of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
search StringSearch query for epic title or description.

EpicTreeNodeFieldsInputType

A node of an epic tree.

Arguments

NameTypeDescription
adjacentReferenceId EpicTreeSortingIDID of the epic issue or issue the epic or issue is switched with.
id EpicTreeSortingID!ID of the epic issue or epic that is being moved.
newParentId EpicIDID of the new parent epic.
relativePosition MoveTypeType of switch. Valid values are after or before.

EscalationRuleInput

Represents an escalation rule.

Arguments

NameTypeDescription
elapsedTimeSeconds Int!Time in seconds before the rule is activated.
oncallScheduleIid IDOn-call schedule to notify.
status EscalationRuleStatus!Status required to prevent the rule from activating.
username StringUsername of the user to notify.

GenerateTestFileInput

Arguments

NameTypeDescription
filePath String!File path to generate test files for.
resourceId AiModelID!Global ID of the resource to mutate.

JiraUsersMappingInputType

Arguments

NameTypeDescription
gitlabId IntID of the GitLab user.
jiraAccountId String!Jira account ID of the user.

MergeRequestsResolverNegatedParams

Arguments

NameTypeDescription
labels [String!]Array of label names. All resolved merge requests will not have these labels.
milestoneTitle StringTitle of the milestone.

NegatedBoardIssueInput

Arguments

NameTypeDescription
assigneeUsername [String]Filter by assignee username.
authorUsername StringFilter by author username.
epicId EpicIDFilter by epic ID. Incompatible with epicWildcardId.
healthStatusFilter HealthStatusHealth status not applied to the issue. Includes issues where health status is not set.
iids [String!]List of IIDs of issues. For example ["1", "2"].
iterationId [IterationID!]Filter by a list of iteration IDs. Incompatible with iterationWildcardId.
iterationTitle StringFilter by iteration title.
iterationWildcardId NegatedIterationWildcardIdFilter by iteration ID wildcard.
labelName [String]Filter by label name.
milestoneTitle StringFilter by milestone title.
milestoneWildcardId MilestoneWildcardIdFilter by milestone ID wildcard.
myReactionEmoji StringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
releaseTag StringFilter by release tag.
types [IssueType!]Filter by the given issue types.
weight StringFilter by weight.

NegatedComplianceFrameworkFilters

Arguments

NameTypeDescription
id ComplianceManagementFrameworkIDID of the compliance framework.

NegatedEpicBoardIssueInput

Arguments

NameTypeDescription
authorUsername StringFilter by author username.
labelName [String]Filter by label name.
myReactionEmoji StringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.

NegatedEpicFilterInput

Arguments

NameTypeDescription
authorUsername StringFilter by author username.
labelName [String]Filter by label name.
myReactionEmoji StringFilter by reaction emoji applied by the current user.

NegatedIssueFilterInput

Arguments

NameTypeDescription
assigneeId StringID of a user not assigned to the issues.
assigneeUsernames [String!]Usernames of users not assigned to the issue.
authorUsername StringUsername of a user who didn’t author the issue.
epicId StringID of an epic not associated with the issues.
healthStatusFilter HealthStatusHealth status not applied to the issue. Includes issues where health status is not set.
iids [String!]List of IIDs of issues to exclude. For example, [1, 2].
iterationId [ID!]List of iteration Global IDs not applied to the issue.
iterationWildcardId IterationWildcardIdFilter by negated iteration ID wildcard.
labelName [String!]Labels not applied to this issue.
milestoneTitle [String!]Milestone not applied to this issue.
milestoneWildcardId NegatedMilestoneWildcardIdFilter by negated milestone wildcard values.
myReactionEmoji StringFilter by reaction emoji applied by the current user.
releaseTag [String!]Release tag not associated with the issue’s milestone. Ignored when parent is a group.
types [IssueType!]Filters out issues by the given issue types.
weight StringWeight not applied to the issue.

OncallRotationActivePeriodInputType

Active period time range for on-call rotation.

Arguments

NameTypeDescription
endTime String!End of the rotation active period in 24 hour format. For example, “18:30”.
startTime String!Start of the rotation active period in 24 hour format. For example, “18:30”.

OncallRotationDateInputType

Date input type for on-call rotation.

Arguments

NameTypeDescription
date String!Date component of the date in YYYY-MM-DD format.
time String!Time component of the date in 24hr HH:MM format.

OncallRotationLengthInputType

The rotation length of the on-call rotation.

Arguments

NameTypeDescription
length Int!Rotation length of the on-call rotation.
unit OncallRotationUnitEnum!Unit of the rotation length of the on-call rotation.

OncallUserInputType

The rotation user and color palette.

Arguments

NameTypeDescription
colorPalette DataVisualizationColorEnumValue of DataVisualizationColorEnum. The color from the palette to assign to the on-call user.
colorWeight DataVisualizationWeightEnumColor weight to assign to for the on-call user. To view on-call schedules in GitLab, do not provide a value below 500. A value between 500 and 950 ensures sufficient contrast.
username String!Username of the user to participate in the on-call rotation. For example, "user_one".

PipelineScheduleVariableInput

Attributes for the pipeline schedule variable.

Arguments

NameTypeDescription
destroy BooleanBoolean option to destroy the variable.
id CiPipelineScheduleVariableIDID of the variable to mutate.
key String!Name of the variable.
value String!Value of the variable.
variableType CiVariableType!Type of the variable.

ReleaseAssetLinkInput

Fields that are available when modifying a release asset link.

Arguments

NameTypeDescription
directAssetPath StringRelative path for a direct asset link.
linkType ReleaseAssetLinkTypeType of the asset link.
name String!Name of the asset link.
url String!URL of the asset link.

ReleaseAssetsInput

Fields that are available when modifying release assets.

Arguments

NameTypeDescription
links [ReleaseAssetLinkInput!]List of asset links to associate to the release.

RequirementLegacyFilterInput

Arguments

NameTypeDescription
legacyIids [String!]!List of legacy requirement IIDs of work items. or example ["1", "2"].

SastCiConfigurationAnalyzersEntityInput

Represents the analyzers entity in SAST CI configuration.

Arguments

NameTypeDescription
enabled Boolean!State of the analyzer.
name String!Name of analyzer.
variables [SastCiConfigurationEntityInput!]List of variables for the analyzer.

SastCiConfigurationEntityInput

Represents an entity in SAST CI configuration.

Arguments

NameTypeDescription
defaultValue String!Default value that is used if value is empty.
field String!CI keyword of entity.
value String!Current value of the entity.

SastCiConfigurationInput

Represents a CI configuration of SAST.

Arguments

NameTypeDescription
analyzers [SastCiConfigurationAnalyzersEntityInput!]List of analyzers and related variables for the SAST configuration.
global [SastCiConfigurationEntityInput!]List of global entities related to SAST configuration.
pipeline [SastCiConfigurationEntityInput!]List of pipeline entities related to SAST configuration.

SnippetBlobActionInputType

Represents an action to perform over a snippet file.

Arguments

NameTypeDescription
action SnippetBlobActionEnum!Type of input action.
content StringSnippet file content.
filePath String!Path of the snippet file.
previousPath StringPrevious path of the snippet file.

StatusFilterInput

Arguments

NameTypeDescription
status RequirementStatusFilter!Status of the work item.

StatusInput

Arguments

NameTypeDescription
status TestReportState!Status to assign to the work item.

Timeframe

A time-frame defined as a closed inclusive range of two dates.

Arguments

NameTypeDescription
end Date!End of the range.
start Date!Start of the range.

UnionedEpicFilterInput

Arguments

NameTypeDescription
authorUsername [String!]Filters epics that are authored by one of the given users.
labelName [String!]Filters epics that have at least one of the given labels.

UnionedIssueFilterInput

Arguments

NameTypeDescription
assigneeUsernames [String!]Filters issues that are assigned to at least one of the given users.
authorUsernames [String!]Filters issues that are authored by one of the given users.
labelNames [String!]Filters issues that have at least one of the given labels.

UpdateDiffImagePositionInput

Arguments

NameTypeDescription
height IntTotal height of the image.
width IntTotal width of the image.
x IntX position of the note.
y IntY position of the note.

VulnerabilityIdentifierInput

Arguments

NameTypeDescription
externalId StringExternal ID of the vulnerability identifier.
externalType StringExternal type of the vulnerability identifier.
name String!Name of the vulnerability identifier.
url String!URL of the vulnerability identifier.

VulnerabilityScannerInput

Arguments

NameTypeDescription
id String!Unique ID that identifies the scanner.
name String!Human readable value that identifies the analyzer, not required to be unique.
url String!Link to more information about the analyzer.
vendor VulnerabilityScannerVendorInputInformation about vendor/maintainer of the scanner.
version String!Version of the scanner.

VulnerabilityScannerVendorInput

Arguments

NameTypeDescription
name String!Name of the vendor/maintainer.

WorkItemConvertTaskInput

Arguments

NameTypeDescription
lineNumberEnd Int!Last line in the Markdown source that defines the list item task.
lineNumberStart Int!First line in the Markdown source that defines the list item task.
lockVersion Int!Current lock version of the work item containing the task in the description.
title String!Full string of the task to be replaced. New title for the created work item.
workItemTypeId WorkItemsTypeID!Global ID of the work item type used to create the new work item.

WorkItemDeletedTaskInput

Arguments

NameTypeDescription
id WorkItemID!Global ID of the task referenced in the work item’s description.
lineNumberEnd Int!Last line in the Markdown source that defines the list item task.
lineNumberStart Int!First line in the Markdown source that defines the list item task.

WorkItemUpdatedTaskInput

Arguments

NameTypeDescription
assigneesWidget WorkItemWidgetAssigneesInputInput for assignees widget.
awardEmojiWidget WorkItemWidgetAwardEmojiUpdateInputInput for award emoji widget.
confidential BooleanSets the work item confidentiality.
currentUserTodosWidget WorkItemWidgetCurrentUserTodosInputInput for to-dos widget.
descriptionWidget WorkItemWidgetDescriptionInputInput for description widget.
hierarchyWidget WorkItemWidgetHierarchyUpdateInputInput for hierarchy widget.
id WorkItemID!Global ID of the work item.
labelsWidget WorkItemWidgetLabelsUpdateInputInput for labels widget.
milestoneWidget WorkItemWidgetMilestoneInputInput for milestone widget.
notificationsWidget WorkItemWidgetNotificationsUpdateInputInput for notifications widget.
startAndDueDateWidget WorkItemWidgetStartAndDueDateUpdateInputInput for start and due date widget.
stateEvent WorkItemStateEventClose or reopen a work item.
title StringTitle of the work item.

WorkItemWidgetAssigneesInput

Arguments

NameTypeDescription
assigneeIds [UserID!]!Global IDs of assignees.

WorkItemWidgetAwardEmojiUpdateInput

Arguments

NameTypeDescription
action WorkItemAwardEmojiUpdateAction!Action for the update.
name String!Emoji name.

WorkItemWidgetCurrentUserTodosInput

Arguments

NameTypeDescription
action WorkItemTodoUpdateAction!Action for the update.
todoId TodoIDGlobal ID of the to-do. If not present, all to-dos of the work item will be updated.

WorkItemWidgetDescriptionInput

Arguments

NameTypeDescription
description String!Description of the work item.

WorkItemWidgetHealthStatusInput

Arguments

NameTypeDescription
healthStatus HealthStatusHealth status to be assigned to the work item.

WorkItemWidgetHierarchyCreateInput

Arguments

NameTypeDescription
parentId WorkItemIDGlobal ID of the parent work item.

WorkItemWidgetHierarchyUpdateInput

Arguments

NameTypeDescription
adjacentWorkItemId WorkItemIDID of the work item to be switched with.
childrenIds [WorkItemID!]Global IDs of children work items.
parentId WorkItemIDGlobal ID of the parent work item. Use null to remove the association.
relativePosition RelativePositionTypeType of switch. Valid values are BEFORE or AFTER.

WorkItemWidgetIterationInput

Arguments

NameTypeDescription
iterationId IterationIDIteration to assign to the work item.

WorkItemWidgetLabelsUpdateInput

Arguments

NameTypeDescription
addLabelIds [LabelID!]Global IDs of labels to be added to the work item.
removeLabelIds [LabelID!]Global IDs of labels to be removed from the work item.

WorkItemWidgetMilestoneInput

Arguments

NameTypeDescription
milestoneId MilestoneIDMilestone to assign to the work item.

WorkItemWidgetNotificationsUpdateInput

Arguments

NameTypeDescription
subscribed Boolean!Desired state of the subscription.

WorkItemWidgetProgressInput

Arguments

NameTypeDescription
currentValue Int!Current progress value of the work item.

WorkItemWidgetStartAndDueDateUpdateInput

Arguments

NameTypeDescription
dueDate DateDue date for the work item.
startDate DateStart date for the work item.

WorkItemWidgetWeightInput

Arguments

NameTypeDescription
weight IntWeight of the work item.