-
Query
typeQuery.ciApplicationSettings
-
Query.ciConfig
-
Query.containerRepository
Query.currentLicense
Query.currentUser
Query.designManagement
-
Query.devopsAdoptionEnabledNamespaces
-
Query.echo
-
Query.geoNode
-
Query.group
Query.instanceSecurityDashboard
-
Query.instanceStatisticsMeasurements
-
Query.issue
-
Query.iteration
Query.licenseHistoryEntries
-
Query.mergeRequest
Query.metadata
-
Query.milestone
-
Query.namespace
-
Query.package
-
Query.project
-
Query.projects
-
Query.runner
Query.runnerPlatforms
-
Query.runnerSetup
-
Query.runners
-
Query.snippets
-
Query.usageTrendsMeasurements
-
Query.user
-
Query.users
-
Query.vulnerabilities
-
Query.vulnerabilitiesCountByDay
-
Query.vulnerability
-
Mutation
type-
Mutation.addProjectToSecurityDashboard
-
Mutation.adminSidekiqQueuesDeleteJobs
-
Mutation.alertSetAssignees
-
Mutation.alertTodoCreate
-
Mutation.apiFuzzingCiConfigurationCreate
-
Mutation.awardEmojiAdd
-
Mutation.awardEmojiRemove
-
Mutation.awardEmojiToggle
-
Mutation.boardEpicCreate
-
Mutation.boardListCreate
-
Mutation.boardListUpdateLimitMetrics
-
Mutation.bulkEnableDevopsAdoptionNamespaces
-
Mutation.ciCdSettingsUpdate
-
Mutation.clusterAgentDelete
-
Mutation.clusterAgentTokenCreate
-
Mutation.clusterAgentTokenDelete
-
Mutation.commitCreate
-
Mutation.configureSast
-
Mutation.configureSecretDetection
-
Mutation.createAlertIssue
-
Mutation.createAnnotation
-
Mutation.createBoard
-
Mutation.createBranch
-
Mutation.createClusterAgent
-
Mutation.createComplianceFramework
-
Mutation.createCustomEmoji
-
Mutation.createDiffNote
-
Mutation.createEpic
-
Mutation.createImageDiffNote
-
Mutation.createIssue
-
Mutation.createIteration
-
Mutation.createNote
-
Mutation.createRequirement
-
Mutation.createSnippet
-
Mutation.createTestCase
-
Mutation.dastOnDemandScanCreate
-
Mutation.dastProfileCreate
-
Mutation.dastProfileDelete
-
Mutation.dastProfileRun
-
Mutation.dastProfileUpdate
-
Mutation.dastScannerProfileCreate
-
Mutation.dastScannerProfileDelete
-
Mutation.dastScannerProfileUpdate
-
Mutation.dastSiteProfileCreate
-
Mutation.dastSiteProfileDelete
-
Mutation.dastSiteProfileUpdate
-
Mutation.dastSiteTokenCreate
-
Mutation.dastSiteValidationCreate
-
Mutation.dastSiteValidationRevoke
-
Mutation.deleteAnnotation
-
Mutation.designManagementDelete
-
Mutation.designManagementMove
-
Mutation.designManagementUpload
-
Mutation.destroyBoard
-
Mutation.destroyBoardList
-
Mutation.destroyComplianceFramework
-
Mutation.destroyContainerRepository
-
Mutation.destroyContainerRepositoryTags
-
Mutation.destroyEpicBoard
-
Mutation.destroyNote
-
Mutation.destroySnippet
-
Mutation.disableDevopsAdoptionNamespace
-
Mutation.discussionToggleResolve
-
Mutation.enableDevopsAdoptionNamespace
-
Mutation.environmentsCanaryIngressUpdate
-
Mutation.epicAddIssue
-
Mutation.epicBoardCreate
-
Mutation.epicBoardListCreate
-
Mutation.epicBoardListDestroy
-
Mutation.epicBoardUpdate
-
Mutation.epicMoveList
-
Mutation.epicSetSubscription
-
Mutation.epicTreeReorder
-
Mutation.escalationPolicyCreate
-
Mutation.escalationPolicyDestroy
-
Mutation.escalationPolicyUpdate
-
Mutation.exportRequirements
-
Mutation.gitlabSubscriptionActivate
-
Mutation.httpIntegrationCreate
-
Mutation.httpIntegrationDestroy
-
Mutation.httpIntegrationResetToken
-
Mutation.httpIntegrationUpdate
-
Mutation.issueMove
-
Mutation.issueMoveList
-
Mutation.issueSetAssignees
-
Mutation.issueSetConfidential
-
Mutation.issueSetDueDate
-
Mutation.issueSetEpic
-
Mutation.issueSetIteration
-
Mutation.issueSetLocked
-
Mutation.issueSetSeverity
-
Mutation.issueSetSubscription
-
Mutation.issueSetWeight
-
Mutation.iterationCadenceCreate
-
Mutation.iterationCadenceDestroy
-
Mutation.iterationCadenceUpdate
-
Mutation.iterationCreate
-
Mutation.iterationDelete
-
Mutation.jiraImportStart
-
Mutation.jiraImportUsers
-
Mutation.jobPlay
-
Mutation.jobRetry
-
Mutation.labelCreate
-
Mutation.markAsSpamSnippet
-
Mutation.mergeRequestAccept
-
Mutation.mergeRequestCreate
-
Mutation.mergeRequestReviewerRereview
-
Mutation.mergeRequestSetAssignees
-
Mutation.mergeRequestSetDraft
-
Mutation.mergeRequestSetLabels
-
Mutation.mergeRequestSetLocked
-
Mutation.mergeRequestSetMilestone
-
Mutation.mergeRequestSetSubscription
-
Mutation.mergeRequestSetWip
-
Mutation.mergeRequestUpdate
-
Mutation.namespaceIncreaseStorageTemporarily
-
Mutation.oncallRotationCreate
-
Mutation.oncallRotationDestroy
-
Mutation.oncallRotationUpdate
-
Mutation.oncallScheduleCreate
-
Mutation.oncallScheduleDestroy
-
Mutation.oncallScheduleUpdate
-
Mutation.pipelineCancel
-
Mutation.pipelineDestroy
-
Mutation.pipelineRetry
-
Mutation.prometheusIntegrationCreate
-
Mutation.prometheusIntegrationResetToken
-
Mutation.prometheusIntegrationUpdate
-
Mutation.promoteToEpic
-
Mutation.releaseAssetLinkCreate
-
Mutation.releaseAssetLinkDelete
-
Mutation.releaseAssetLinkUpdate
-
Mutation.releaseCreate
-
Mutation.releaseDelete
-
Mutation.releaseUpdate
-
Mutation.removeProjectFromSecurityDashboard
-
Mutation.repositionImageDiffNote
-
Mutation.runnerDelete
-
Mutation.runnerUpdate
-
Mutation.runnersRegistrationTokenReset
-
Mutation.terraformStateDelete
-
Mutation.terraformStateLock
-
Mutation.terraformStateUnlock
-
Mutation.todoCreate
-
Mutation.todoMarkDone
-
Mutation.todoRestore
-
Mutation.todoRestoreMany
-
Mutation.todosMarkAllDone
-
Mutation.updateAlertStatus
-
Mutation.updateBoard
-
Mutation.updateBoardEpicUserPreferences
-
Mutation.updateBoardList
-
Mutation.updateComplianceFramework
-
Mutation.updateContainerExpirationPolicy
-
Mutation.updateEpic
-
Mutation.updateEpicBoardList
-
Mutation.updateImageDiffNote
-
Mutation.updateIssue
-
Mutation.updateIteration
-
Mutation.updateNamespacePackageSettings
-
Mutation.updateNote
-
Mutation.updateRequirement
-
Mutation.updateSnippet
-
Mutation.userCalloutCreate
-
Mutation.vulnerabilityConfirm
-
Mutation.vulnerabilityDismiss
-
Mutation.vulnerabilityExternalIssueLinkCreate
-
Mutation.vulnerabilityExternalIssueLinkDestroy
-
Mutation.vulnerabilityResolve
-
Mutation.vulnerabilityRevertToDetected
-
-
Connections
- Pagination arguments
- Connection fields
-
Connection types
-
AgentConfigurationConnection
-
AgentConfigurationEdge
-
AlertManagementAlertConnection
-
AlertManagementAlertEdge
-
AlertManagementHttpIntegrationConnection
-
AlertManagementHttpIntegrationEdge
-
AlertManagementIntegrationConnection
-
AlertManagementIntegrationEdge
-
AwardEmojiConnection
-
AwardEmojiEdge
-
BlobConnection
-
BlobEdge
-
BoardConnection
-
BoardEdge
-
BoardEpicConnection
-
BoardEpicEdge
-
BoardListConnection
-
BoardListEdge
-
CiBuildNeedConnection
-
CiBuildNeedEdge
-
CiConfigGroupConnection
-
CiConfigGroupEdge
-
CiConfigJobConnection
-
CiConfigJobEdge
-
CiConfigNeedConnection
-
CiConfigNeedEdge
-
CiConfigStageConnection
-
CiConfigStageEdge
-
CiGroupConnection
-
CiGroupEdge
-
CiJobArtifactConnection
-
CiJobArtifactEdge
-
CiJobConnection
-
CiJobEdge
-
CiRunnerConnection
-
CiRunnerEdge
-
CiStageConnection
-
CiStageEdge
-
ClusterAgentConnection
-
ClusterAgentEdge
-
ClusterAgentTokenConnection
-
ClusterAgentTokenEdge
-
CodeCoverageActivityConnection
-
CodeCoverageActivityEdge
-
CodeQualityDegradationConnection
-
CodeQualityDegradationEdge
-
CommitConnection
-
CommitEdge
-
ComplianceFrameworkConnection
-
ComplianceFrameworkEdge
-
ContainerRepositoryConnection
-
ContainerRepositoryEdge
-
ContainerRepositoryTagConnection
-
ContainerRepositoryTagEdge
-
CustomEmojiConnection
-
CustomEmojiEdge
-
DastProfileConnection
-
DastProfileEdge
-
DastScannerProfileConnection
-
DastScannerProfileEdge
-
DastSiteProfileConnection
-
DastSiteProfileEdge
-
DastSiteValidationConnection
-
DastSiteValidationEdge
-
DesignAtVersionConnection
-
DesignAtVersionEdge
-
DesignConnection
-
DesignEdge
-
DesignVersionConnection
-
DesignVersionEdge
-
DevopsAdoptionEnabledNamespaceConnection
-
DevopsAdoptionEnabledNamespaceEdge
-
DevopsAdoptionSnapshotConnection
-
DevopsAdoptionSnapshotEdge
-
DiscussionConnection
-
DiscussionEdge
-
EnvironmentConnection
-
EnvironmentEdge
-
EpicBoardConnection
-
EpicBoardEdge
-
EpicConnection
-
EpicEdge
-
EpicIssueConnection
-
EpicIssueEdge
-
EpicListConnection
-
EpicListEdge
-
EscalationPolicyTypeConnection
-
EscalationPolicyTypeEdge
-
EventConnection
-
EventEdge
-
GroupMemberConnection
-
GroupMemberEdge
-
GroupWikiRepositoryRegistryConnection
-
GroupWikiRepositoryRegistryEdge
-
IncidentManagementOncallRotationConnection
-
IncidentManagementOncallRotationEdge
-
IncidentManagementOncallScheduleConnection
-
IncidentManagementOncallScheduleEdge
-
IncidentManagementOncallShiftConnection
-
IncidentManagementOncallShiftEdge
-
IssueConnection
-
IssueEdge
-
IterationCadenceConnection
-
IterationCadenceEdge
-
IterationConnection
-
IterationEdge
-
JiraImportConnection
-
JiraImportEdge
-
JiraProjectConnection
-
JiraProjectEdge
-
LabelConnection
-
LabelEdge
-
LfsObjectRegistryConnection
-
LfsObjectRegistryEdge
-
LicenseHistoryEntryConnection
-
LicenseHistoryEntryEdge
-
MemberInterfaceConnection
-
MemberInterfaceEdge
-
MergeRequestAssigneeConnection
-
MergeRequestAssigneeEdge
-
MergeRequestConnection
-
MergeRequestDiffRegistryConnection
-
MergeRequestDiffRegistryEdge
-
MergeRequestEdge
-
MergeRequestReviewerConnection
-
MergeRequestReviewerEdge
-
MetricsDashboardAnnotationConnection
-
MetricsDashboardAnnotationEdge
-
MilestoneConnection
-
MilestoneEdge
-
NamespaceConnection
-
NamespaceEdge
-
NetworkPolicyConnection
-
NetworkPolicyEdge
-
NoteConnection
-
NoteEdge
-
OncallParticipantTypeConnection
-
OncallParticipantTypeEdge
-
PackageConnection
-
PackageEdge
-
PackageFileConnection
-
PackageFileEdge
-
PackageFileRegistryConnection
-
PackageFileRegistryEdge
-
PackageTagConnection
-
PackageTagEdge
-
PathLockConnection
-
PathLockEdge
-
PipelineArtifactRegistryConnection
-
PipelineArtifactRegistryEdge
-
PipelineConnection
-
PipelineEdge
-
PipelineSecurityReportFindingConnection
-
PipelineSecurityReportFindingEdge
-
ProjectConnection
-
ProjectEdge
-
ProjectMemberConnection
-
ProjectMemberEdge
-
ReleaseAssetLinkConnection
-
ReleaseAssetLinkEdge
-
ReleaseConnection
-
ReleaseEdge
-
ReleaseEvidenceConnection
-
ReleaseEvidenceEdge
-
ReleaseSourceConnection
-
ReleaseSourceEdge
-
RepositoryBlobConnection
-
RepositoryBlobEdge
-
RequirementConnection
-
RequirementEdge
-
RunnerArchitectureConnection
-
RunnerArchitectureEdge
-
RunnerPlatformConnection
-
RunnerPlatformEdge
-
SastCiConfigurationAnalyzersEntityConnection
-
SastCiConfigurationAnalyzersEntityEdge
-
SastCiConfigurationEntityConnection
-
SastCiConfigurationEntityEdge
-
SastCiConfigurationOptionsEntityConnection
-
SastCiConfigurationOptionsEntityEdge
-
ScanConnection
-
ScanEdge
-
ScanExecutionPolicyConnection
-
ScanExecutionPolicyEdge
-
ScannedResourceConnection
-
ScannedResourceEdge
-
SentryErrorConnection
-
SentryErrorEdge
-
ServiceConnection
-
ServiceEdge
-
SnippetBlobConnection
-
SnippetBlobEdge
-
SnippetConnection
-
SnippetEdge
-
SnippetRepositoryRegistryConnection
-
SnippetRepositoryRegistryEdge
-
SubmoduleConnection
-
SubmoduleEdge
-
TerraformStateConnection
-
TerraformStateEdge
-
TerraformStateVersionRegistryConnection
-
TerraformStateVersionRegistryEdge
-
TestCaseConnection
-
TestCaseEdge
-
TestReportConnection
-
TestReportEdge
-
TestSuiteSummaryConnection
-
TestSuiteSummaryEdge
-
TimelogConnection
-
TimelogEdge
-
TodoConnection
-
TodoEdge
-
TreeEntryConnection
-
TreeEntryEdge
-
UsageTrendsMeasurementConnection
-
UsageTrendsMeasurementEdge
-
UserCalloutConnection
-
UserCalloutEdge
-
UserCoreConnection
-
UserCoreEdge
-
VulnerabilitiesCountByDayConnection
-
VulnerabilitiesCountByDayEdge
-
VulnerabilityConnection
-
VulnerabilityEdge
-
VulnerabilityExternalIssueLinkConnection
-
VulnerabilityExternalIssueLinkEdge
-
VulnerabilityIssueLinkConnection
-
VulnerabilityIssueLinkEdge
-
VulnerabilityScannerConnection
-
VulnerabilityScannerEdge
-
-
Object types
-
AccessLevel
-
AgentConfiguration
-
AlertManagementAlert
-
AlertManagementAlertStatusCountsType
-
AlertManagementHttpIntegration
-
AlertManagementPayloadAlertField
-
AlertManagementPayloadAlertMappingField
-
AlertManagementPrometheusIntegration
-
ApiFuzzingCiConfiguration
-
ApiFuzzingScanProfile
-
ApprovalRule
-
AwardEmoji
-
BaseService
-
Blob
-
BlobViewer
-
Board
-
BoardEpic
-
BoardEpicUserPreferences
-
BoardList
-
Branch
-
BurnupChartDailyTotals
-
CiApplicationSettings
-
CiBuildNeed
-
CiConfig
-
CiConfigGroup
-
CiConfigJob
-
CiConfigJobRestriction
-
CiConfigNeed
-
CiConfigStage
-
CiGroup
-
CiJob
-
CiJobArtifact
-
CiJobTokenScopeType
-
CiRunner
-
CiStage
-
CiTemplate
-
ClusterAgent
-
ClusterAgentToken
-
CodeCoverageActivity
-
CodeCoverageSummary
-
CodeQualityDegradation
-
Commit
-
ComplianceFramework
-
ComposerMetadata
-
ConanFileMetadata
-
ConanMetadata
-
ContainerExpirationPolicy
-
ContainerRepository
-
ContainerRepositoryDetails
-
ContainerRepositoryTag
-
CurrentLicense
-
CustomEmoji
-
DastProfile
-
DastProfileBranch
-
DastScannerProfile
-
DastSiteProfile
-
DastSiteProfileAuth
-
DastSiteProfilePermissions
-
DastSiteValidation
-
DeleteJobsResponse
-
Design
-
DesignAtVersion
-
DesignCollection
-
DesignManagement
-
DesignVersion
-
DetailedStatus
-
DevopsAdoptionEnabledNamespace
-
DevopsAdoptionSnapshot
-
DiffPosition
-
DiffRefs
-
DiffStats
-
DiffStatsSummary
-
Discussion
-
Environment
-
Epic
-
EpicBoard
-
EpicDescendantCount
-
EpicDescendantWeights
-
EpicHealthStatus
-
EpicIssue
-
EpicList
-
EpicPermissions
-
EscalationPolicyType
-
EscalationRuleType
-
Event
-
ExternalIssue
-
GeoNode
-
GrafanaIntegration
-
Group
- Fields
-
Fields with arguments
Group.board
Group.boards
Group.codeCoverageActivities
Group.complianceFrameworks
Group.containerRepositories
Group.epic
Group.epicBoard
Group.epics
Group.groupMembers
Group.issues
Group.iterationCadences
Group.iterations
Group.label
Group.labels
Group.mergeRequests
Group.milestones
Group.packages
Group.projects
Group.timelogs
Group.vulnerabilities
Group.vulnerabilitiesCountByDay
Group.vulnerabilityGrades
Group.vulnerabilitySeveritiesCount
-
GroupMember
-
GroupPermissions
-
GroupReleaseStats
-
GroupStats
-
GroupWikiRepositoryRegistry
-
IncidentManagementOncallRotation
-
IncidentManagementOncallSchedule
-
IncidentManagementOncallShift
-
InstanceSecurityDashboard
-
Issue
-
IssuePermissions
-
IssueStatusCountsType
-
Iteration
-
IterationCadence
-
JiraImport
-
JiraProject
-
JiraService
-
JiraUser
-
JobPermissions
-
Kas
-
Label
-
LfsObjectRegistry
-
LicenseHistoryEntry
-
MavenMetadata
-
MergeRequest
-
MergeRequestAssignee
-
MergeRequestDiffRegistry
-
MergeRequestPermissions
-
MergeRequestReviewer
-
Metadata
-
MetricImage
-
MetricsDashboard
-
MetricsDashboardAnnotation
-
Milestone
-
MilestoneStats
-
Namespace
-
NetworkPolicy
-
Note
-
NotePermissions
-
NugetMetadata
-
OncallParticipantType
-
OncallRotationActivePeriodType
-
Package
-
PackageComposerJsonType
-
PackageDetailsType
-
PackageFile
-
PackageFileRegistry
-
PackageSettings
-
PackageTag
-
PageInfo
-
PathLock
-
Pipeline
-
PipelineAnalytics
-
PipelineArtifactRegistry
-
PipelinePermissions
-
PipelineSecurityReportFinding
-
Project
- Fields
-
Fields with arguments
Project.alertManagementAlert
Project.alertManagementAlertStatusCounts
Project.alertManagementAlerts
Project.alertManagementHttpIntegrations
Project.alertManagementIntegrations
Project.alertManagementPayloadFields
Project.board
Project.boards
Project.ciTemplate
Project.clusterAgent
Project.containerRepositories
Project.dastSiteProfile
Project.dastSiteValidations
Project.environment
Project.environments
Project.incidentManagementEscalationPolicy
Project.incidentManagementOncallSchedules
Project.issue
Project.issueStatusCounts
Project.issues
Project.iterationCadences
Project.iterations
Project.jobs
Project.label
Project.labels
Project.mergeRequest
Project.mergeRequests
Project.milestones
Project.networkPolicies
Project.packages
Project.pipeline
Project.pipelines
Project.projectMembers
Project.release
Project.releases
Project.requirement
Project.requirements
Project.sentryDetailedError
Project.services
Project.snippets
Project.terraformState
Project.vulnerabilities
Project.vulnerabilitiesCountByDay
Project.vulnerabilitySeveritiesCount
-
ProjectCiCdSetting
-
ProjectMember
-
ProjectPermissions
-
ProjectStatistics
-
PrometheusAlert
-
PushRules
-
PypiMetadata
-
RecentFailures
-
Release
-
ReleaseAssetLink
-
ReleaseAssets
-
ReleaseEvidence
-
ReleaseLinks
-
ReleaseSource
-
Repository
-
RepositoryBlob
-
Requirement
-
RequirementPermissions
-
RequirementStatesCount
-
RootStorageStatistics
-
RunnerArchitecture
-
RunnerPlatform
-
RunnerSetup
-
SastCiConfiguration
-
SastCiConfigurationAnalyzersEntity
-
SastCiConfigurationEntity
-
SastCiConfigurationOptionsEntity
-
Scan
-
ScanExecutionPolicy
-
ScannedResource
-
SecurityReportSummary
-
SecurityReportSummarySection
-
SecurityScanners
-
SentryDetailedError
-
SentryError
-
SentryErrorCollection
-
SentryErrorFrequency
-
SentryErrorStackTrace
-
SentryErrorStackTraceContext
-
SentryErrorStackTraceEntry
-
SentryErrorTags
-
Snippet
-
SnippetBlob
-
SnippetBlobViewer
-
SnippetPermissions
-
SnippetRepositoryRegistry
-
StatusAction
-
Submodule
-
TaskCompletionStatus
-
TerraformState
-
TerraformStateVersion
-
TerraformStateVersionRegistry
-
TestCase
-
TestReport
-
TestReportSummary
-
TestReportTotal
-
TestSuite
-
TestSuiteSummary
-
TimeReportStats
-
TimeboxMetrics
-
TimeboxReport
-
Timelog
-
Todo
-
Tree
-
TreeEntry
-
UsageTrendsMeasurement
-
UserCallout
-
UserCore
-
UserMergeRequestInteraction
-
UserPermissions
-
UserStatus
-
VulnerabilitiesCountByDay
-
Vulnerability
-
VulnerabilityDetailBase
-
VulnerabilityDetailBoolean
-
VulnerabilityDetailCode
-
VulnerabilityDetailCommit
-
VulnerabilityDetailDiff
-
VulnerabilityDetailFileLocation
-
VulnerabilityDetailInt
-
VulnerabilityDetailList
-
VulnerabilityDetailMarkdown
-
VulnerabilityDetailModuleLocation
-
VulnerabilityDetailTable
-
VulnerabilityDetailText
-
VulnerabilityDetailUrl
-
VulnerabilityExternalIssueLink
-
VulnerabilityIdentifier
-
VulnerabilityIssueLink
-
VulnerabilityLocationContainerScanning
-
VulnerabilityLocationCoverageFuzzing
-
VulnerabilityLocationDast
-
VulnerabilityLocationDependencyScanning
-
VulnerabilityLocationSast
-
VulnerabilityLocationSecretDetection
-
VulnerabilityPermissions
-
VulnerabilityScanner
-
VulnerabilitySeveritiesCount
-
VulnerableDependency
-
VulnerablePackage
-
VulnerableProjectsByGrade
-
-
Enumeration types
AccessLevelEnum
AlertManagementAlertSort
AlertManagementDomainFilter
AlertManagementIntegrationType
AlertManagementPayloadAlertFieldName
AlertManagementPayloadAlertFieldType
AlertManagementSeverity
AlertManagementStatus
ApiFuzzingScanMode
ApprovalRuleType
AssigneeWildcardId
AvailabilityEnum
BlobViewersType
CiConfigStatus
CiJobStatus
CiRunnerAccessLevel
CiRunnerSort
CiRunnerStatus
CiRunnerType
CodeQualityDegradationSeverity
CommitActionMode
CommitEncoding
ConanMetadatumFileTypeEnum
ContainerExpirationPolicyCadenceEnum
ContainerExpirationPolicyKeepEnum
ContainerExpirationPolicyOlderThanEnum
ContainerRepositoryCleanupStatus
ContainerRepositorySort
ContainerRepositoryStatus
DastScanTypeEnum
DastSiteProfileValidationStatusEnum
DastSiteValidationStrategyEnum
DastTargetTypeEnum
DataVisualizationColorEnum
DataVisualizationWeightEnum
DesignCollectionCopyState
DesignVersionEvent
DiffPositionType
EntryType
EpicSort
EpicState
EpicStateEvent
EpicWildcardId
EscalationRuleStatus
EventAction
GroupMemberRelation
HealthStatus
IssuableSeverity
IssuableState
IssueSort
IssueState
IssueStateEvent
IssueType
IterationState
IterationWildcardId
JobArtifactFileType
ListLimitMetric
MeasurementIdentifier
MergeRequestNewState
MergeRequestReviewState
MergeRequestSort
MergeRequestState
MergeStatus
MergeStrategyEnum
MilestoneStateEnum
MoveType
MutationOperationMode
NamespaceProjectSort
NegatedIterationWildcardId
OncallRotationUnitEnum
PackageGroupSort
PackageSort
PackageStatus
PackageTypeEnum
PipelineConfigSourceEnum
PipelineStatusEnum
ProjectMemberRelation
RegistryState
ReleaseAssetLinkType
ReleaseSort
RequirementState
RequirementStatusFilter
SastUiComponentSize
SecurityReportTypeEnum
SecurityScannerType
SentryErrorStatus
ServiceType
SnippetBlobActionEnum
Sort
TestCaseStatus
TestReportState
TodoActionEnum
TodoStateEnum
TodoTargetEnum
TypeEnum
UserCalloutFeatureNameEnum
UserState
VisibilityLevelsEnum
VisibilityScopesEnum
VulnerabilityDismissalReason
VulnerabilityExternalIssueLinkExternalTracker
VulnerabilityExternalIssueLinkType
VulnerabilityGrade
VulnerabilityIssueLinkType
VulnerabilityReportType
VulnerabilitySeverity
VulnerabilitySort
VulnerabilityState
WeightWildcardId
-
Scalar types
AlertManagementHttpIntegrationID
AnalyticsDevopsAdoptionEnabledNamespaceID
AwardableID
BigInt
BoardID
BoardsEpicBoardID
BoardsEpicListID
Boolean
CiBuildID
CiPipelineID
CiRunnerID
ClustersAgentID
ClustersAgentTokenID
ClustersClusterID
ComplianceManagementFrameworkID
ContainerRepositoryID
CustomEmojiID
DastProfileID
DastScannerProfileID
DastSiteProfileID
DastSiteTokenID
DastSiteValidationID
Date
DesignManagementDesignAtVersionID
DesignManagementDesignID
DesignManagementVersionID
DiffNoteID
DiscussionID
Duration
EnvironmentID
EpicID
EpicTreeSortingID
Float
GitlabErrorTrackingDetailedErrorID
GlobalID
GroupID
ID
ISO8601Date
IncidentManagementEscalationPolicyID
IncidentManagementEscalationRuleID
IncidentManagementOncallParticipantID
IncidentManagementOncallRotationID
Int
IntegrationsPrometheusID
IssuableID
IssueID
IterationID
IterationsCadenceID
JSON
JobID
JsonString
LabelID
ListID
MergeRequestID
MetricsDashboardAnnotationID
MilestoneID
NamespaceID
NoteID
NoteableID
PackagesConanFileMetadatumID
PackagesConanMetadatumID
PackagesMavenMetadatumID
PackagesNugetMetadatumID
PackagesPackageFileID
PackagesPackageID
PackagesPypiMetadatumID
PathLockID
PayloadAlertFieldPathSegment
ProjectID
ReleasesLinkID
SnippetID
String
TerraformStateID
Time
TodoID
TodoableID
UntrustedRegexp
Upload
UserID
VulnerabilitiesExternalIssueLinkID
VulnerabilitiesScannerID
VulnerabilityID
- Abstract types
-
Input types
-
AlertManagementPayloadAlertFieldInput
-
BoardIssueInput
-
CommitAction
-
ComplianceFrameworkInput
-
DastSiteProfileAuthInput
-
DiffImagePositionInput
-
DiffPathsInput
-
DiffPositionInput
-
EpicFilters
-
EpicTreeNodeFieldsInputType
-
EscalationRuleInput
-
JiraUsersMappingInputType
-
MergeRequestsResolverNegatedParams
-
NegatedBoardIssueInput
-
NegatedEpicBoardIssueInput
-
NegatedEpicFilterInput
-
NegatedIssueFilterInput
-
OncallRotationActivePeriodInputType
-
OncallRotationDateInputType
-
OncallRotationLengthInputType
-
OncallUserInputType
-
ReleaseAssetLinkInput
-
ReleaseAssetsInput
-
SastCiConfigurationAnalyzersEntityInput
-
SastCiConfigurationEntityInput
-
SastCiConfigurationInput
-
SnippetBlobActionInputType
-
Timeframe
-
UpdateDiffImagePositionInput
-
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.
Query
type
The Query
type contains the API’s top-level entry points for all executable queries.
Query.ciApplicationSettings
CI related settings that apply to the entire instance.
Returns CiApplicationSettings
.
Query.ciConfig
Linted and processed contents of a CI config. Should not be requested more than once per request.
Returns CiConfig
.
Arguments
Name | Type | Description |
---|---|---|
content
| String!
| Contents of .gitlab-ci.yml .
|
dryRun
| Boolean
| Run pipeline creation simulation, or only do static check. |
projectPath
| ID!
| The project of the CI config. |
Query.containerRepository
Find a container repository.
Returns ContainerRepositoryDetails
.
Arguments
Name | Type | Description |
---|---|---|
id
| ContainerRepositoryID!
| The global ID of the container repository. |
Query.currentLicense
Fields related to the current license.
Returns CurrentLicense
.
Query.currentUser
Get information about current user.
Returns UserCore
.
Query.designManagement
Fields related to design management.
Returns DesignManagement!
.
Query.devopsAdoptionEnabledNamespaces
Get configured DevOps adoption namespaces. BETA This endpoint is subject to change without notice.
Returns DevopsAdoptionEnabledNamespaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
displayNamespaceId
| NamespaceID
| Filter by display namespace. |
Query.echo
Testing endpoint to validate the API with.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
text
| String!
| Text to echo back. |
Query.geoNode
Find a Geo node.
Returns GeoNode
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| The name of the Geo node. Defaults to the current Geo node name. |
Query.group
Find a group.
Returns Group
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| ID!
| The full path of the project, group or namespace, e.g., gitlab-org/gitlab-foss .
|
Query.instanceSecurityDashboard
Fields related to Instance Security Dashboard.
Returns InstanceSecurityDashboard
.
Query.instanceStatisticsMeasurements
Get statistics on the instance.
Query.usageTrendsMeasurements
.Returns UsageTrendsMeasurementConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
identifier
| MeasurementIdentifier!
| The type of measurement/statistics to retrieve. |
recordedAfter
| Time
| Measurement recorded after this date. |
recordedBefore
| Time
| Measurement recorded before this date. |
Query.issue
Find an issue.
Returns Issue
.
Arguments
Name | Type | Description |
---|---|---|
id
| IssueID!
| The global ID of the issue. |
Query.iteration
Find an iteration.
Returns Iteration
.
Arguments
Name | Type | Description |
---|---|---|
id
| IterationID!
| Find an iteration by its ID. |
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
Name | Type | Description |
---|---|---|
id
| MergeRequestID!
| The global ID of the merge request. |
Query.metadata
Metadata about GitLab.
Returns Metadata
.
Query.milestone
Find a milestone.
Returns Milestone
.
Arguments
Name | Type | Description |
---|---|---|
id
| MilestoneID!
| Find a milestone by its ID. |
Query.namespace
Find a namespace.
Returns Namespace
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| ID!
| The full path of the project, group or namespace, e.g., gitlab-org/gitlab-foss .
|
Query.package
Find a package.
Returns PackageDetailsType
.
Arguments
Name | Type | Description |
---|---|---|
id
| PackagesPackageID!
| The global ID of the package. |
Query.project
Find a project.
Returns Project
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| ID!
| The full path of the project, group or namespace, e.g., gitlab-org/gitlab-foss .
|
Query.projects
Find projects visible to the current user.
Returns ProjectConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filter projects by IDs. |
membership
| Boolean
| Limit projects that the current user is a member of. |
search
| String
| Search query for project name, path, or description. |
searchNamespaces
| Boolean
| Include namespace in project search. |
sort
| String
| Sort order of results. |
topics
| [String!]
| Filters projects by topics. |
Query.runner
Find a runner. Available only when feature flag runner_graphql_query
is enabled.
Returns CiRunner
.
Arguments
Name | Type | Description |
---|---|---|
id
| CiRunnerID!
| Runner ID. |
Query.runnerPlatforms
Supported runner 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.
Returns RunnerSetup
.
Arguments
Name | Type | Description |
---|---|---|
architecture
| String!
| Architecture to generate the instructions for. |
groupId
| GroupID
| Deprecated in 13.11. No longer used. |
platform
| String!
| Platform to generate the instructions for. |
projectId
| ProjectID
| Deprecated in 13.11. No longer used. |
Query.runners
Find runners visible to the current user. Available only when feature flag runner_graphql_query
is enabled.
Returns CiRunnerConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Filter by full token or partial text in description field. |
sort
| CiRunnerSort
| Sort order of results. |
status
| CiRunnerStatus
| Filter runners by status. |
tagList
| [String!]
| Filter by tags associated with the runner (comma-separated or array). |
type
| CiRunnerType
| Filter runners by type. |
Query.snippets
Find Snippets visible to the current user.
Returns SnippetConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorId
| UserID
| The ID of an author. |
explore
| Boolean
| Explore personal snippets. |
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
projectId
| ProjectID
| The ID of a project. |
type
| TypeEnum
| The type of snippet. |
visibility
| VisibilityScopesEnum
| The visibility of the snippet. |
Query.usageTrendsMeasurements
Get statistics on the instance.
Returns UsageTrendsMeasurementConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
identifier
| MeasurementIdentifier!
| The type of measurement/statistics to retrieve. |
recordedAfter
| Time
| Measurement recorded after this date. |
recordedBefore
| Time
| Measurement recorded before this date. |
Query.user
Find a user.
Returns UserCore
.
Arguments
Name | Type | Description |
---|---|---|
id
| UserID
| ID of the User. |
username
| String
| Username of the User. |
Query.users
Find users.
Returns UserCoreConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
admins
| Boolean
| Return only admin users. |
ids
| [ID!]
| List of user Global IDs. |
search
| String
| Query to search users by name, username, or primary email. |
sort
| Sort
| Sort users by this criteria. |
usernames
| [String!]
| List of usernames. |
Query.vulnerabilities
Vulnerabilities reported on projects on the current user’s instance security dashboard.
Returns VulnerabilityConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
hasIssues
| Boolean
| Returns only the vulnerabilities which have linked issues. |
hasResolution
| Boolean
| Returns only the vulnerabilities which have been resolved on default branch. |
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by VulnerabilityScanner.externalId. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
sort
| VulnerabilitySort
| List vulnerabilities by sort order. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
Query.vulnerabilitiesCountByDay
Number of vulnerabilities per day for the projects on the current user’s instance security dashboard.
Returns VulnerabilitiesCountByDayConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| ISO8601Date!
| Last day for which to fetch vulnerability history. |
startDate
| ISO8601Date!
| First day for which to fetch vulnerability history. |
Query.vulnerability
Find a vulnerability.
Returns Vulnerability
.
Arguments
Name | Type | Description |
---|---|---|
id
| VulnerabilityID!
| The Global ID of the Vulnerability. |
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.addProjectToSecurityDashboard
Input type: AddProjectToSecurityDashboardInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ProjectID!
| ID of the project to be added to Instance Security Dashboard. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
project
| Project
| Project that was added to the Instance Security Dashboard. |
Mutation.adminSidekiqQueuesDeleteJobs
Input type: AdminSidekiqQueuesDeleteJobsInput
Arguments
Name | Type | Description |
---|---|---|
callerId
| String
| Delete jobs matching caller_id in the context metadata. |
clientId
| String
| Delete jobs matching client_id in the context metadata. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
featureCategory
| String
| Delete jobs matching feature_category in the context metadata. |
project
| String
| Delete jobs matching project in the context metadata. |
queueName
| String!
| The name of the queue to delete jobs from. |
relatedClass
| String
| Delete jobs matching related_class in the context metadata. |
remoteIp
| String
| Delete jobs matching remote_ip in the context metadata. |
rootNamespace
| String
| Delete jobs matching root_namespace in the context metadata. |
subscriptionPlan
| String
| Delete jobs matching subscription_plan in the context metadata. |
user
| String
| Delete jobs matching user in the context metadata. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
result
| DeleteJobsResponse
| Information about the status of the deletion request. |
Mutation.alertSetAssignees
Input type: AlertSetAssigneesInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]!
| The usernames to assign to the alert. Replaces existing assignees by default. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the alert to mutate. |
operationMode
| MutationOperationMode
| The operation to perform. Defaults to REPLACE. |
projectPath
| ID!
| The project the alert to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
alert
| AlertManagementAlert
| The alert after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue created after mutation. |
todo
| Todo
| The to-do item after mutation. |
Mutation.alertTodoCreate
Input type: AlertTodoCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the alert to mutate. |
projectPath
| ID!
| The project the alert to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
alert
| AlertManagementAlert
| The alert after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue created after mutation. |
todo
| Todo
| The to-do item after mutation. |
Mutation.apiFuzzingCiConfigurationCreate
Input type: ApiFuzzingCiConfigurationCreateInput
Arguments
Name | Type | Description |
---|---|---|
apiSpecificationFile
| String!
| File path or URL to the file that defines the API surface for scanning. Must be in the format specified by the scanMode argument.
|
authPassword
| String
| CI variable containing the password for authenticating with the target API. |
authUsername
| String
| CI variable containing the username for authenticating with the target API. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| Full path of the project. |
scanMode
| ApiFuzzingScanMode!
| The mode for API fuzzing scans. |
scanProfile
| String
| Name of a default profile to use for scanning. Ex: Quick-10. |
target
| String!
| URL for the target of API fuzzing scans. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
configurationYaml
| String
| A YAML snippet that can be inserted into the project’s .gitlab-ci.yml to set up API fuzzing scans.
|
errors
| [String!]!
| Errors encountered during execution of the mutation. |
gitlabCiYamlEditPath
| String
| The location at which the project’s .gitlab-ci.yml file can be edited in the browser.
|
Mutation.awardEmojiAdd
Input type: AwardEmojiAddInput
Arguments
Name | Type | Description |
---|---|---|
awardableId
| AwardableID!
| The global ID of the awardable resource. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| The emoji name. |
Fields
Name | Type | Description |
---|---|---|
awardEmoji
| AwardEmoji
| The award emoji after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.awardEmojiRemove
Input type: AwardEmojiRemoveInput
Arguments
Name | Type | Description |
---|---|---|
awardableId
| AwardableID!
| The global ID of the awardable resource. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| The emoji name. |
Fields
Name | Type | Description |
---|---|---|
awardEmoji
| AwardEmoji
| The award emoji after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.awardEmojiToggle
Input type: AwardEmojiToggleInput
Arguments
Name | Type | Description |
---|---|---|
awardableId
| AwardableID!
| The global ID of the awardable resource. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| The emoji name. |
Fields
Name | Type | Description |
---|---|---|
awardEmoji
| AwardEmoji
| The award emoji after mutation. |
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
boardId
| BoardsEpicBoardID!
| Global ID of the board that the epic is in. |
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| Epic after creation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.boardListCreate
Input type: BoardListCreateInput
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| UserID
| Global ID of an existing user. |
backlog
| Boolean
| Create the backlog list. |
boardId
| BoardID!
| Global ID of the issue board to mutate. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iterationId
| IterationID
| Global ID of an existing iteration. |
labelId
| LabelID
| Global ID of an existing label. |
milestoneId
| MilestoneID
| Global ID of an existing milestone. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
list
| BoardList
| Issue list in the issue board. |
Mutation.boardListUpdateLimitMetrics
Input type: BoardListUpdateLimitMetricsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
limitMetric
| ListLimitMetric
| The new limit metric type for the list. |
listId
| ListID!
| The global ID of the list. |
maxIssueCount
| Int
| The new maximum issue count limit. |
maxIssueWeight
| Int
| The new maximum issue weight limit. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
list
| BoardList
| The updated list. |
Mutation.bulkEnableDevopsAdoptionNamespaces
BETA This endpoint is subject to change without notice.
Input type: BulkEnableDevopsAdoptionNamespacesInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
displayNamespaceId
| NamespaceID
| Display namespace ID. |
namespaceIds
| [NamespaceID!]!
| List of Namespace IDs. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
enabledNamespaces
| [DevopsAdoptionEnabledNamespace!]
| Enabled namespaces after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.ciCdSettingsUpdate
Input type: CiCdSettingsUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| Full Path of the project the settings belong to. |
jobTokenScopeEnabled
| Boolean
| Indicates CI job tokens generated in this project have restricted access to resources. |
keepLatestArtifact
| Boolean
| Indicates if the latest artifact should be kept for this project. |
mergePipelinesEnabled
| Boolean
| Indicates if merge pipelines are enabled for the project. |
mergeTrainsEnabled
| Boolean
| Indicates if merge trains are enabled for the project. |
Fields
Name | Type | Description |
---|---|---|
ciCdSettings
| ProjectCiCdSetting!
| The CI/CD settings after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.clusterAgentDelete
Input type: ClusterAgentDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ClustersAgentID!
| Global ID of the cluster agent that will be deleted. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.clusterAgentTokenCreate
Input type: ClusterAgentTokenCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
| String
| Description of the token. |
name
| String!
| Name of the token. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
secret
| String
| Token secret value. Make sure you save it - you won’t be able to access it again. |
token
| ClusterAgentToken
| Token created after mutation. |
Mutation.clusterAgentTokenDelete
Input type: ClusterAgentTokenDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ClustersAgentTokenID!
| Global ID of the cluster agent token that will be deleted. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.commitCreate
Input type: CommitCreateInput
Arguments
Name | Type | Description |
---|---|---|
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
| String
| A unique identifier for the client performing the mutation. |
message
| String!
| Raw commit message. |
projectPath
| ID!
| Project full path the branch is associated with. |
startBranch
| String
| If on a new branch, name of the original branch. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
commit
| Commit
| The commit after mutation. |
commitPipelinePath
| String
| ETag path for the commit’s pipeline. |
content
| [String!]
| Contents of the commit. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
configuration
| SastCiConfigurationInput!
| SAST CI configuration for the project. |
projectPath
| ID!
| Full path of the project. |
Fields
Name | Type | Description |
---|---|---|
branch
| String
| Branch that has the new/modified .gitlab-ci.yml file.
|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
successPath
| String
| Redirect 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| Full path of the project. |
Fields
Name | Type | Description |
---|---|---|
branch
| String
| Branch that has the new/modified .gitlab-ci.yml file.
|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
successPath
| String
| Redirect path to use when the response is successful. |
Mutation.createAlertIssue
Input type: CreateAlertIssueInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the alert to mutate. |
projectPath
| ID!
| The project the alert to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
alert
| AlertManagementAlert
| The alert after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue created after mutation. |
todo
| Todo
| The to-do item after mutation. |
Mutation.createAnnotation
Input type: CreateAnnotationInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
clusterId
| ClustersClusterID
| The global ID of the cluster to add an annotation to. |
dashboardPath
| String!
| The path to a file defining the dashboard on which the annotation should be added. |
description
| String!
| The description of the annotation. |
endingAt
| Time
| Timestamp indicating ending moment to which the annotation relates. |
environmentId
| EnvironmentID
| The global ID of the environment to add an annotation to. |
startingAt
| Time!
| Timestamp indicating starting moment to which the annotation relates. |
Fields
Name | Type | Description |
---|---|---|
annotation
| MetricsDashboardAnnotation
| The created annotation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.createBoard
Input type: CreateBoardInput
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| UserID
| ID of user to be assigned to the board. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
groupPath
| ID
| Full path of the group with which the resource is associated. |
hideBacklogList
| Boolean
| Whether or not backlog list is hidden. |
hideClosedList
| Boolean
| Whether or not closed list is hidden. |
iterationId
| IterationID
| ID of iteration to be assigned to the board. |
labelIds
| [LabelID!]
| IDs of labels to be added to the board. |
labels
| [String!]
| Labels of the issue. |
milestoneId
| MilestoneID
| ID of milestone to be assigned to the board. |
name
| String
| The board name. |
projectPath
| ID
| Full path of the project with which the resource is associated. |
weight
| Int
| Weight value to be assigned to the board. |
Fields
Name | Type | Description |
---|---|---|
board
| Board
| The board after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.createBranch
Input type: CreateBranchInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
branch
| Branch
| Branch after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.createClusterAgent
Input type: CreateClusterAgentInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| Name of the cluster agent. |
projectPath
| ID!
| Full path of the associated project for this cluster agent. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
clusterAgent
| ClusterAgent
| Cluster agent created after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.createComplianceFramework
Input type: CreateComplianceFrameworkInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
framework
| ComplianceFramework
| The created compliance framework. |
Mutation.createCustomEmoji
Available only when feature flag custom_emoji
is enabled.
Input type: CreateCustomEmojiInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
customEmoji
| CustomEmoji
| The new custom emoji. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.createDiffNote
Input type: CreateDiffNoteInput
Arguments
Name | Type | Description |
---|---|---|
body
| String!
| Content of the note. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| The confidentiality flag of a note. Default is false. |
noteableId
| NoteableID!
| The global ID of the resource to add a note to. |
position
| DiffPositionInput!
| The position of this note on a diff. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
note
| Note
| The note after mutation. |
Mutation.createEpic
Input type: CreateEpicInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
| [ID!]
| The IDs of labels to be added to the epic. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| Indicates if the epic is confidential. |
description
| String
| The description of the epic. |
dueDateFixed
| String
| The end date of the epic. |
dueDateIsFixed
| Boolean
| Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
groupPath
| ID!
| The group the epic to mutate is in. |
removeLabelIds
| [ID!]
| The IDs of labels to be removed from the epic. |
startDateFixed
| String
| The start date of the epic. |
startDateIsFixed
| Boolean
| Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
title
| String
| The title of the epic. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| The created epic. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.createImageDiffNote
Input type: CreateImageDiffNoteInput
Arguments
Name | Type | Description |
---|---|---|
body
| String!
| Content of the note. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| The confidentiality flag of a note. Default is false. |
noteableId
| NoteableID!
| The global ID of the resource to add a note to. |
position
| DiffImagePositionInput!
| The position of this note on a diff. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
note
| Note
| The note after mutation. |
Mutation.createIssue
Input type: CreateIssueInput
Arguments
Name | Type | Description |
---|---|---|
assigneeIds
| [UserID!]
| The array of user IDs to assign to the issue. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| Indicates the issue is confidential. |
createdAt
| Time
| Timestamp when the issue was created. Available only for admins and project owners. |
description
| String
| Description of the issue. |
discussionToResolve
| String
| The ID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of .
|
dueDate
| ISO8601Date
| Due date of the issue. |
epicId
| EpicID
| The ID of an epic to associate the issue with. |
healthStatus
| HealthStatus
| The desired health status. |
iid
| Int
| The IID (internal ID) of a project issue. Only admins and project owners can modify. |
labelIds
| [LabelID!]
| The IDs of labels to be added to the issue. |
labels
| [String!]
| Labels of the issue. |
locked
| Boolean
| Indicates discussion is locked on the issue. |
mergeRequestToResolveDiscussionsOf
| MergeRequestID
| The IID of a merge request for which to resolve discussions. |
milestoneId
| MilestoneID
| The ID of the milestone to assign to the issue. On update milestone will be removed if set to null. |
projectPath
| ID!
| Project full path the issue is associated with. |
title
| String!
| Title of the issue. |
type
| IssueType
| Type of the issue. |
weight
| Int
| The weight of the issue. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.createIteration
Input type: CreateIterationInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| The description of the iteration. |
dueDate
| String
| The end date of the iteration. |
groupPath
| ID
| Full path of the group with which the resource is associated. |
iterationsCadenceId
| IterationsCadenceID
| Global ID of the iterations cadence to be assigned to newly created iteration. |
projectPath
| ID
| Full path of the project with which the resource is associated. |
startDate
| String
| The start date of the iteration. |
title
| String
| The title of the iteration. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
iteration
| Iteration
| The created iteration. |
Mutation.createNote
Input type: CreateNoteInput
Arguments
Name | Type | Description |
---|---|---|
body
| String!
| Content of the note. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| The confidentiality flag of a note. Default is false. |
discussionId
| DiscussionID
| The global ID of the discussion this note is in reply to. |
noteableId
| NoteableID!
| The global ID of the resource to add a note to. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
note
| Note
| The note after mutation. |
Mutation.createRequirement
Input type: CreateRequirementInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the requirement. |
projectPath
| ID!
| Full project path the requirement is associated with. |
title
| String
| Title of the requirement. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
requirement
| Requirement
| Requirement after mutation. |
Mutation.createSnippet
Input type: CreateSnippetInput
Arguments
Name | Type | Description |
---|---|---|
blobActions
| [SnippetBlobActionInputType!]
| Actions to perform over the snippet repository and blobs. |
captchaResponse
| String
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the snippet. |
projectPath
| ID
| The project full path the snippet is associated with. |
spamLogId
| Int
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
title
| String!
| Title of the snippet. |
uploadedFiles
| [String!]
| The paths to files uploaded in the snippet description. |
visibilityLevel
| VisibilityLevelsEnum!
| The visibility level of the snippet. |
Fields
Name | Type | Description |
---|---|---|
captchaSiteKey
| String
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
needsCaptchaResponse
| Boolean
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
snippet
| Snippet
| The snippet after mutation. |
spam
| Boolean
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
spamLogId
| Int
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
Mutation.createTestCase
Input type: CreateTestCaseInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| The test case description. |
labelIds
| [ID!]
| The IDs of labels to be added to the test case. |
projectPath
| ID!
| The project full path to create the test case. |
title
| String!
| The test case title. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
testCase
| Issue
| The test case created. |
Mutation.dastOnDemandScanCreate
Input type: DastOnDemandScanCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastScannerProfileId
| DastScannerProfileID
| ID of the scanner profile to be used for the scan. |
dastSiteProfileId
| DastSiteProfileID!
| ID of the site profile to be used for the scan. |
fullPath
| ID!
| The project the site profile belongs to. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
pipelineUrl
| String
| URL of the pipeline that was created. |
Mutation.dastProfileCreate
Input type: DastProfileCreateInput
Arguments
Name | Type | Description |
---|---|---|
branchName
| String
| The associated branch. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastScannerProfileId
| DastScannerProfileID!
| ID of the scanner profile to be associated. |
dastSiteProfileId
| DastSiteProfileID!
| ID of the site profile to be associated. |
description
| String
| The description of the profile. Defaults to an empty string. |
fullPath
| ID!
| The project the profile belongs to. |
name
| String!
| The name of the profile. |
runAfterCreate
| Boolean
| Run scan using profile after creation. Defaults to false. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastProfile
| DastProfile
| The created profile. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
pipelineUrl
| String
| The URL of the pipeline that was created. Requires runAfterCreate to be set to true .
|
Mutation.dastProfileDelete
Input type: DastProfileDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| DastProfileID!
| ID of the profile to be deleted. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.dastProfileRun
Input type: DastProfileRunInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| Full path for the project the scanner profile belongs to. |
id
| DastProfileID!
| ID of the profile to be used for the scan. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
pipelineUrl
| String
| URL of the pipeline that was created. |
Mutation.dastProfileUpdate
Input type: DastProfileUpdateInput
Arguments
Name | Type | Description |
---|---|---|
branchName
| String
| The associated branch. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastScannerProfileId
| DastScannerProfileID
| ID of the scanner profile to be associated. |
dastSiteProfileId
| DastSiteProfileID
| ID of the site profile to be associated. |
description
| String
| The description of the profile. Defaults to an empty string. |
fullPath
| ID!
| The project the profile belongs to. |
id
| DastProfileID!
| ID of the profile to be deleted. |
name
| String
| The name of the profile. |
runAfterUpdate
| Boolean
| Run scan using profile after update. Defaults to false. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastProfile
| DastProfile
| The updated profile. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
pipelineUrl
| String
| The URL of the pipeline that was created. Requires the input argument runAfterUpdate to be set to true when calling the mutation, otherwise no pipeline will be created.
|
Mutation.dastScannerProfileCreate
Input type: DastScannerProfileCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| The project the scanner profile belongs to. |
profileName
| String!
| The name of the scanner profile. |
scanType
| DastScanTypeEnum
| Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. |
showDebugMessages
| Boolean
| Indicates if debug messages should be included in DAST console output. True to include the debug messages. |
spiderTimeout
| Int
| The maximum number of minutes allowed for the spider to traverse the site. |
targetTimeout
| Int
| The maximum number of seconds allowed for the site under test to respond to a request. |
useAjaxSpider
| Boolean
| Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id
| DastScannerProfileID
| ID of the scanner profile. |
Mutation.dastScannerProfileDelete
Input type: DastScannerProfileDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| Full path for the project the scanner profile belongs to. |
id
| DastScannerProfileID!
| ID of the scanner profile to be deleted. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.dastScannerProfileUpdate
Input type: DastScannerProfileUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| The project the scanner profile belongs to. |
id
| DastScannerProfileID!
| ID of the scanner profile to be updated. |
profileName
| String!
| The name of the scanner profile. |
scanType
| DastScanTypeEnum
| Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. |
showDebugMessages
| Boolean
| Indicates if debug messages should be included in DAST console output. True to include the debug messages. |
spiderTimeout
| Int!
| The maximum number of minutes allowed for the spider to traverse the site. |
targetTimeout
| Int!
| The maximum number of seconds allowed for the site under test to respond to a request. |
useAjaxSpider
| Boolean
| Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id
| DastScannerProfileID
| ID of the scanner profile. |
Mutation.dastSiteProfileCreate
Input type: DastSiteProfileCreateInput
Arguments
Name | Type | Description |
---|---|---|
auth
| DastSiteProfileAuthInput
| Parameters for authentication. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
excludedUrls
| [String!]
| The URLs to skip during an authenticated scan. Defaults to [] .
|
fullPath
| ID!
| The project the site profile belongs to. |
profileName
| String!
| The name of the site profile. |
requestHeaders
| String
| Comma-separated list of request header names and values to be added to every request made by DAST. |
targetType
| DastTargetTypeEnum
| The type of target to be scanned. |
targetUrl
| String
| The URL of the target to be scanned. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id
| DastSiteProfileID
| ID of the site profile. |
Mutation.dastSiteProfileDelete
Input type: DastSiteProfileDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| The project the site profile belongs to. |
id
| DastSiteProfileID!
| ID of the site profile to be deleted. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.dastSiteProfileUpdate
Input type: DastSiteProfileUpdateInput
Arguments
Name | Type | Description |
---|---|---|
auth
| DastSiteProfileAuthInput
| Parameters for authentication. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
excludedUrls
| [String!]
| The URLs to skip during an authenticated scan. |
fullPath
| ID!
| The project the site profile belongs to. |
id
| DastSiteProfileID!
| ID of the site profile to be updated. |
profileName
| String!
| The name of the site profile. |
requestHeaders
| String
| Comma-separated list of request header names and values to be added to every request made by DAST. |
targetType
| DastTargetTypeEnum
| The type of target to be scanned. |
targetUrl
| String
| The URL of the target to be scanned. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id
| DastSiteProfileID
| ID of the site profile. |
Mutation.dastSiteTokenCreate
Input type: DastSiteTokenCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| The project the site token belongs to. |
targetUrl
| String
| The URL of the target to be validated. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id
| DastSiteTokenID
| ID of the site token. |
status
| DastSiteProfileValidationStatusEnum
| The current validation status of the target. |
token
| String
| Token string. |
Mutation.dastSiteValidationCreate
Input type: DastSiteValidationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastSiteTokenId
| DastSiteTokenID!
| ID of the site token. |
fullPath
| ID!
| The project the site profile belongs to. |
strategy
| DastSiteValidationStrategyEnum
| The validation strategy to be used. |
validationPath
| String!
| The path to be requested during validation. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id
| DastSiteValidationID
| ID of the site validation. |
status
| DastSiteProfileValidationStatusEnum
| The current validation status. |
Mutation.dastSiteValidationRevoke
Input type: DastSiteValidationRevokeInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| The project the site validation belongs to. |
normalizedTargetUrl
| String!
| Normalized URL of the target to be revoked. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.deleteAnnotation
Input type: DeleteAnnotationInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| MetricsDashboardAnnotationID!
| Global ID of the annotation to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.designManagementDelete
Input type: DesignManagementDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
filenames
| [String!]!
| The filenames of the designs to delete. |
iid
| ID!
| The IID of the issue to modify designs for. |
projectPath
| ID!
| The project where the issue is to upload designs for. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
version
| DesignVersion
| The new version in which the designs are deleted. |
Mutation.designManagementMove
Input type: DesignManagementMoveInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| DesignManagementDesignID!
| ID of the design to move. |
next
| DesignManagementDesignID
| ID of the immediately following design. |
previous
| DesignManagementDesignID
| ID of the immediately preceding design. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
designCollection
| DesignCollection
| The current state of the collection. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.designManagementUpload
Input type: DesignManagementUploadInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
files
| [Upload!]!
| The files to upload. |
iid
| ID!
| The IID of the issue to modify designs for. |
projectPath
| ID!
| The project where the issue is to upload designs for. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
designs
| [Design!]!
| The 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| BoardID!
| The global ID of the board to destroy. |
Fields
Name | Type | Description |
---|---|---|
board
| Board
| The board after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.destroyBoardList
Input type: DestroyBoardListInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
listId
| ListID!
| Global ID of the list to destroy. Only label lists are accepted. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
list
| BoardList
| The list after mutation. |
Mutation.destroyComplianceFramework
Input type: DestroyComplianceFrameworkInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ComplianceManagementFrameworkID!
| The global ID of the compliance framework to destroy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.destroyContainerRepository
Input type: DestroyContainerRepositoryInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ContainerRepositoryID!
| ID of the container repository. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
containerRepository
| ContainerRepository!
| The container repository policy after scheduling the deletion. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.destroyContainerRepositoryTags
Input type: DestroyContainerRepositoryTagsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
deletedTagNames
| [String!]!
| Deleted container repository tags. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.destroyEpicBoard
Input type: DestroyEpicBoardInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| BoardsEpicBoardID!
| Global ID of the board to destroy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicBoard
| EpicBoard
| Epic board after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.destroyNote
Input type: DestroyNoteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| NoteID!
| The global ID of the note to destroy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
note
| Note
| The note after mutation. |
Mutation.destroySnippet
Input type: DestroySnippetInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| SnippetID!
| The global ID of the snippet to destroy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
snippet
| Snippet
| The snippet after mutation. |
Mutation.disableDevopsAdoptionNamespace
BETA This endpoint is subject to change without notice.
Input type: DisableDevopsAdoptionNamespaceInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| [AnalyticsDevopsAdoptionEnabledNamespaceID!]!
| One or many IDs of the enabled namespaces to disable. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| DiscussionID!
| The global ID of the discussion. |
resolve
| Boolean!
| Will resolve the discussion when true, and unresolve the discussion when false. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
discussion
| Discussion
| The discussion after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.enableDevopsAdoptionNamespace
BETA This endpoint is subject to change without notice.
Input type: EnableDevopsAdoptionNamespaceInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
displayNamespaceId
| NamespaceID
| Display namespace ID. |
namespaceId
| NamespaceID!
| Namespace ID. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
enabledNamespace
| DevopsAdoptionEnabledNamespace
| Enabled namespace after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.environmentsCanaryIngressUpdate
Input type: EnvironmentsCanaryIngressUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| EnvironmentID!
| The global ID of the environment to update. |
weight
| Int!
| The weight of the Canary Ingress. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.epicAddIssue
Input type: EpicAddIssueInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
groupPath
| ID!
| The group the epic to mutate belongs to. |
iid
| ID!
| The IID of the epic to mutate. |
issueIid
| String!
| The IID of the issue to be added. |
projectPath
| ID!
| The full path of the project the issue belongs to. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| The epic after mutation. |
epicIssue
| EpicIssue
| The epic-issue relation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.epicBoardCreate
Input type: EpicBoardCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
groupPath
| ID
| Full path of the group with which the resource is associated. |
hideBacklogList
| Boolean
| Whether or not backlog list is hidden. |
hideClosedList
| Boolean
| Whether or not closed list is hidden. |
labelIds
| [LabelID!]
| IDs of labels to be added to the board. |
labels
| [String!]
| Labels of the issue. |
name
| String
| The board name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicBoard
| EpicBoard
| The created epic board. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.epicBoardListCreate
Input type: EpicBoardListCreateInput
Arguments
Name | Type | Description |
---|---|---|
backlog
| Boolean
| Create the backlog list. |
boardId
| BoardsEpicBoardID!
| Global ID of the issue board to mutate. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
labelId
| LabelID
| Global ID of an existing label. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
list
| EpicList
| Epic list in the epic board. |
Mutation.epicBoardListDestroy
Destroys an epic board list.
Input type: EpicBoardListDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
listId
| BoardsEpicListID!
| Global ID of the epic board list to destroy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
list
| EpicList
| The epic board list. null if the board was destroyed successfully.
|
Mutation.epicBoardUpdate
Input type: EpicBoardUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
hideBacklogList
| Boolean
| Whether or not backlog list is hidden. |
hideClosedList
| Boolean
| Whether or not closed list is hidden. |
id
| BoardsEpicBoardID!
| The epic board global ID. |
labelIds
| [LabelID!]
| IDs of labels to be added to the board. |
labels
| [String!]
| Labels of the issue. |
name
| String
| The board name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicBoard
| EpicBoard
| The updated epic board. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.epicMoveList
Input type: EpicMoveListInput
Arguments
Name | Type | Description |
---|---|---|
boardId
| BoardsEpicBoardID!
| Global ID of the board that the epic is in. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicId
| EpicID!
| ID of the epic to mutate. |
fromListId
| BoardsEpicListID
| ID of the board list that the epic will be moved from. Required if moving between lists. |
moveAfterId
| EpicID
| ID of epic that should be placed after the current epic. |
moveBeforeId
| EpicID
| ID of epic that should be placed before the current epic. |
toListId
| BoardsEpicListID!
| ID of the list the epic will be in after mutation. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| The epic after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.epicSetSubscription
Input type: EpicSetSubscriptionInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
groupPath
| ID!
| The group the epic to mutate belongs to. |
iid
| ID!
| The IID of the epic to mutate. |
subscribedState
| Boolean!
| The desired state of the subscription. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| The epic after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.epicTreeReorder
Input type: EpicTreeReorderInput
Arguments
Name | Type | Description |
---|---|---|
baseEpicId
| EpicID!
| The ID of the base epic of the tree. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
moved
| EpicTreeNodeFieldsInputType!
| Parameters for updating the tree positions. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.escalationPolicyCreate
Input type: EscalationPolicyCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| The description of the escalation policy. |
name
| String!
| The name of the escalation policy. |
projectPath
| ID!
| The project to create the escalation policy for. |
rules
| [EscalationRuleInput!]!
| The steps of the escalation policy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
escalationPolicy
| EscalationPolicyType
| The escalation policy. |
Mutation.escalationPolicyDestroy
Input type: EscalationPolicyDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IncidentManagementEscalationPolicyID!
| The escalation policy internal ID to remove. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
escalationPolicy
| EscalationPolicyType
| The escalation policy. |
Mutation.escalationPolicyUpdate
Input type: EscalationPolicyUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| The description of the escalation policy. |
id
| IncidentManagementEscalationPolicyID!
| The ID of the on-call schedule to create the on-call rotation in. |
name
| String
| The name of the escalation policy. |
rules
| [EscalationRuleInput!]
| The steps of the escalation policy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
escalationPolicy
| EscalationPolicyType
| The escalation policy. |
Mutation.exportRequirements
Input type: ExportRequirementsInput
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| [String!]
| Filter requirements by author username. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| Full project path the requirements are associated with. |
search
| String
| Search query for requirement title. |
selectedFields
| [String!]
| List of selected requirements fields to be exported. |
sort
| Sort
| List requirements by sort order. |
state
| RequirementState
| Filter requirements by state. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.gitlabSubscriptionActivate
Input type: GitlabSubscriptionActivateInput
Arguments
Name | Type | Description |
---|---|---|
activationCode
| String!
| Activation code received after purchasing a GitLab subscription. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
license
| CurrentLicense
| The current license. |
Mutation.httpIntegrationCreate
Input type: HttpIntegrationCreateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean!
| Whether the integration is receiving alerts. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| The name of the integration. |
payloadAttributeMappings
| [AlertManagementPayloadAlertFieldInput!]
| The custom mapping of GitLab alert attributes to fields from the payload_example. |
payloadExample
| JsonString
| The example of an alert payload. |
projectPath
| ID!
| The project to create the integration in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
integration
| AlertManagementHttpIntegration
| The HTTP integration. |
Mutation.httpIntegrationDestroy
Input type: HttpIntegrationDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AlertManagementHttpIntegrationID!
| The ID of the integration to remove. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
integration
| AlertManagementHttpIntegration
| The HTTP integration. |
Mutation.httpIntegrationResetToken
Input type: HttpIntegrationResetTokenInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AlertManagementHttpIntegrationID!
| The ID of the integration to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
integration
| AlertManagementHttpIntegration
| The HTTP integration. |
Mutation.httpIntegrationUpdate
Input type: HttpIntegrationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the integration is receiving alerts. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AlertManagementHttpIntegrationID!
| The ID of the integration to mutate. |
name
| String
| The name of the integration. |
payloadAttributeMappings
| [AlertManagementPayloadAlertFieldInput!]
| The custom mapping of GitLab alert attributes to fields from the payload_example. |
payloadExample
| JsonString
| The example of an alert payload. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
integration
| AlertManagementHttpIntegration
| The HTTP integration. |
Mutation.issueMove
Input type: IssueMoveInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the issue to mutate. |
projectPath
| ID!
| The project the issue to mutate is in. |
targetProjectPath
| ID!
| The project to move the issue to. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueMoveList
Input type: IssueMoveListInput
Arguments
Name | Type | Description |
---|---|---|
boardId
| BoardID!
| Global ID of the board that the issue is in. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicId
| EpicID
| The ID of the parent epic. NULL when removing the association. |
fromListId
| ID
| ID of the board list that the issue will be moved from. |
iid
| String!
| IID of the issue to mutate. |
moveAfterId
| ID
| ID of issue that should be placed after the current issue. |
moveBeforeId
| ID
| ID of issue that should be placed before the current issue. |
projectPath
| ID!
| Project the issue to mutate is in. |
toListId
| ID
| ID of the board list that the issue will be moved to. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetAssignees
Input type: IssueSetAssigneesInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]!
| The usernames to assign to the resource. Replaces existing assignees by default. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the issue to mutate. |
operationMode
| MutationOperationMode
| The operation to perform. Defaults to REPLACE. |
projectPath
| ID!
| The project the issue to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetConfidential
Input type: IssueSetConfidentialInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean!
| Whether or not to set the issue as a confidential. |
iid
| String!
| The IID of the issue to mutate. |
projectPath
| ID!
| The project the issue to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetDueDate
Input type: IssueSetDueDateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dueDate
| Time
| The desired due date for the issue, due date will be removed if absent or set to null. |
iid
| String!
| The IID of the issue to mutate. |
projectPath
| ID!
| The project the issue to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetEpic
Input type: IssueSetEpicInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicId
| EpicID
| Global ID of the epic to be assigned to the issue, epic will be removed if absent or set to null. |
iid
| String!
| The IID of the issue to mutate. |
projectPath
| ID!
| The project the issue to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetIteration
Input type: IssueSetIterationInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the issue to mutate. |
iterationId
| IterationID
| The iteration to assign to the issue. |
projectPath
| ID!
| The project the issue to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetLocked
Input type: IssueSetLockedInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the issue to mutate. |
locked
| Boolean!
| Whether or not to lock discussion on the issue. |
projectPath
| ID!
| The project the issue to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetSeverity
Input type: IssueSetSeverityInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the issue to mutate. |
projectPath
| ID!
| The project the issue to mutate is in. |
severity
| IssuableSeverity!
| Set the incident severity level. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetSubscription
Input type: IssueSetSubscriptionInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the issue to mutate. |
projectPath
| ID!
| The project the issue to mutate is in. |
subscribedState
| Boolean!
| The desired state of the subscription. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.issueSetWeight
Input type: IssueSetWeightInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the issue to mutate. |
projectPath
| ID!
| The project the issue to mutate is in. |
weight
| Int!
| The desired weight for the issue. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.iterationCadenceCreate
Input type: IterationCadenceCreateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean!
| Whether the iteration cadence is active. |
automatic
| Boolean!
| Whether the iteration cadence should automatically generate future iterations. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the iteration cadence. Maximum length is 5000 characters. |
durationInWeeks
| Int
| Duration in weeks of the iterations within this cadence. |
groupPath
| ID!
| The group where the iteration cadence is created. |
iterationsInAdvance
| Int
| Future 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
| Time
| Timestamp of the iteration cadence start date. |
title
| String
| Title of the iteration cadence. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
iterationCadence
| IterationCadence
| The created iteration cadence. |
Mutation.iterationCadenceDestroy
Input type: IterationCadenceDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IterationsCadenceID!
| Global ID of the iteration cadence. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the iteration cadence is active. |
automatic
| Boolean
| Whether the iteration cadence should automatically generate future iterations. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the iteration cadence. Maximum length is 5000 characters. |
durationInWeeks
| Int
| Duration in weeks of the iterations within this cadence. |
id
| IterationsCadenceID!
| Global ID of the iteration cadence. |
iterationsInAdvance
| Int
| Future 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
| Time
| Timestamp of the iteration cadence start date. |
title
| String
| Title of the iteration cadence. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
iterationCadence
| IterationCadence
| The updated iteration cadence. |
Mutation.iterationCreate
Input type: iterationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| The description of the iteration. |
dueDate
| String
| The end date of the iteration. |
groupPath
| ID
| Full path of the group with which the resource is associated. |
iterationsCadenceId
| IterationsCadenceID
| Global ID of the iterations cadence to be assigned to newly created iteration. |
projectPath
| ID
| Full path of the project with which the resource is associated. |
startDate
| String
| The start date of the iteration. |
title
| String
| The title of the iteration. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
iteration
| Iteration
| The created iteration. |
Mutation.iterationDelete
Input type: IterationDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IterationID!
| ID of the iteration. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
jiraProjectKey
| String!
| Project key of the importer Jira project. |
jiraProjectName
| String
| Project name of the importer Jira project. |
projectPath
| ID!
| The project to import the Jira project into. |
usersMapping
| [JiraUsersMappingInputType!]
| The mapping of Jira to GitLab users. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
jiraImport
| JiraImport
| The Jira import data after mutation. |
Mutation.jiraImportUsers
Input type: JiraImportUsersInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| The project to import the Jira users into. |
startAt
| Int
| The index of the record the import should started at, default 0 (50 records returned). |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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.jobPlay
Input type: JobPlayInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiBuildID!
| The ID of the job to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
job
| CiJob
| The job after the mutation. |
Mutation.jobRetry
Input type: JobRetryInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiBuildID!
| The ID of the job to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
job
| CiJob
| The job after the mutation. |
Mutation.labelCreate
Input type: LabelCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
color
| String
| The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB ) or one of the CSS color names.
|
description
| String
| Description of the label. |
groupPath
| ID
| Full path of the group with which the resource is associated. |
projectPath
| ID
| Full path of the project with which the resource is associated. |
title
| String!
| Title of the label. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
label
| Label
| The label after mutation. |
Mutation.markAsSpamSnippet
Input type: MarkAsSpamSnippetInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| SnippetID!
| The global ID of the snippet to update. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
snippet
| Snippet
| The snippet 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
commitMessage
| String
| Custom merge commit message. |
iid
| String!
| The IID of the merge request to mutate. |
projectPath
| ID!
| The project the merge request to mutate is in. |
sha
| String!
| The HEAD SHA at the time when this merge was requested. |
shouldRemoveSourceBranch
| Boolean
| Should the source branch be removed. |
squash
| Boolean
| Squash commits on the source branch before merge. |
squashCommitMessage
| String
| Custom squash commit message (if squash is true). |
strategy
| MergeStrategyEnum
| How to merge this merge request. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestCreate
Input type: MergeRequestCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestReviewerRereview
Input type: MergeRequestReviewerRereviewInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the merge request to mutate. |
projectPath
| ID!
| The project the merge request to mutate is in. |
userId
| UserID!
| The user ID for the user that has been requested for a new review. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestSetAssignees
Input type: MergeRequestSetAssigneesInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]!
| The usernames to assign to the resource. Replaces existing assignees by default. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the merge request to mutate. |
operationMode
| MutationOperationMode
| The operation to perform. Defaults to REPLACE. |
projectPath
| ID!
| The project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestSetDraft
Input type: MergeRequestSetDraftInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
draft
| Boolean!
| Whether or not to set the merge request as a draft. |
iid
| String!
| The IID of the merge request to mutate. |
projectPath
| ID!
| The project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestSetLabels
Input type: MergeRequestSetLabelsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the merge request to mutate. |
labelIds
| [LabelID!]!
| The Label IDs to set. Replaces existing labels by default. |
operationMode
| MutationOperationMode
| Changes the operation mode. Defaults to REPLACE. |
projectPath
| ID!
| The project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestSetLocked
Input type: MergeRequestSetLockedInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the merge request to mutate. |
locked
| Boolean!
| Whether or not to lock the merge request. |
projectPath
| ID!
| The project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestSetMilestone
Input type: MergeRequestSetMilestoneInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the merge request to mutate. |
milestoneId
| MilestoneID
| The milestone to assign to the merge request. |
projectPath
| ID!
| The project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestSetSubscription
Input type: MergeRequestSetSubscriptionInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the merge request to mutate. |
projectPath
| ID!
| The project the merge request to mutate is in. |
subscribedState
| Boolean!
| The desired state of the subscription. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestSetWip
Input type: MergeRequestSetWipInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the merge request to mutate. |
projectPath
| ID!
| The project the merge request to mutate is in. |
wip
| Boolean!
| Whether or not to set the merge request as a draft. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.mergeRequestUpdate
Update attributes of a merge request.
Input type: MergeRequestUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the merge request (Markdown rendered as HTML for caching). |
iid
| String!
| The IID of the merge request to mutate. |
projectPath
| ID!
| The project the merge request to mutate is in. |
state
| MergeRequestNewState
| The action to perform to change the state. |
targetBranch
| String
| Target branch of the merge request. |
title
| String
| Title of the merge request. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
mergeRequest
| MergeRequest
| The merge request after mutation. |
Mutation.namespaceIncreaseStorageTemporarily
Input type: NamespaceIncreaseStorageTemporarilyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| NamespaceID!
| The global ID of the namespace to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
namespace
| Namespace
| The namespace after mutation. |
Mutation.oncallRotationCreate
Input type: OncallRotationCreateInput
Arguments
Name | Type | Description |
---|---|---|
activePeriod
| OncallRotationActivePeriodInputType
| The active period of time that the on-call rotation should take place. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
endsAt
| OncallRotationDateInputType
| The end date and time of the on-call rotation, in the timezone of the on-call schedule. |
name
| String!
| The name of the on-call rotation. |
participants
| [OncallUserInputType!]!
| The usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. |
projectPath
| ID!
| The project to create the on-call schedule in. |
rotationLength
| OncallRotationLengthInputType!
| The rotation length of the on-call rotation. |
scheduleIid
| String!
| The IID of the on-call schedule to create the on-call rotation in. |
startsAt
| OncallRotationDateInputType!
| The start date and time of the on-call rotation, in the timezone of the on-call schedule. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
oncallRotation
| IncidentManagementOncallRotation
| The on-call rotation. |
Mutation.oncallRotationDestroy
Input type: OncallRotationDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IncidentManagementOncallRotationID!
| The ID of the on-call rotation to remove. |
projectPath
| ID!
| The project to remove the on-call schedule from. |
scheduleIid
| String!
| The IID of the on-call schedule to the on-call rotation belongs to. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
oncallRotation
| IncidentManagementOncallRotation
| The on-call rotation. |
Mutation.oncallRotationUpdate
Input type: OncallRotationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
activePeriod
| OncallRotationActivePeriodInputType
| The active period of time that the on-call rotation should take place. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
endsAt
| OncallRotationDateInputType
| The end date and time of the on-call rotation, in the timezone of the on-call schedule. |
id
| IncidentManagementOncallRotationID!
| The ID of the on-call schedule to create the on-call rotation in. |
name
| String
| The name of the on-call rotation. |
participants
| [OncallUserInputType!]
| The usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. |
rotationLength
| OncallRotationLengthInputType
| The rotation length of the on-call rotation. |
startsAt
| OncallRotationDateInputType
| The start date and time of the on-call rotation, in the timezone of the on-call schedule. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
oncallRotation
| IncidentManagementOncallRotation
| The on-call rotation. |
Mutation.oncallScheduleCreate
Input type: OncallScheduleCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| The description of the on-call schedule. |
name
| String!
| The name of the on-call schedule. |
projectPath
| ID!
| The project to create the on-call schedule in. |
timezone
| String!
| The timezone of the on-call schedule. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
oncallSchedule
| IncidentManagementOncallSchedule
| The on-call schedule. |
Mutation.oncallScheduleDestroy
Input type: OncallScheduleDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The on-call schedule internal ID to remove. |
projectPath
| ID!
| The project to remove the on-call schedule from. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
oncallSchedule
| IncidentManagementOncallSchedule
| The on-call schedule. |
Mutation.oncallScheduleUpdate
Input type: OncallScheduleUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| The description of the on-call schedule. |
iid
| String!
| The on-call schedule internal ID to update. |
name
| String
| The name of the on-call schedule. |
projectPath
| ID!
| The project to update the on-call schedule in. |
timezone
| String
| The timezone of the on-call schedule. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
oncallSchedule
| IncidentManagementOncallSchedule
| The on-call schedule. |
Mutation.pipelineCancel
Input type: PipelineCancelInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiPipelineID!
| The ID of the pipeline to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.pipelineDestroy
Input type: PipelineDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiPipelineID!
| The ID of the pipeline to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.pipelineRetry
Input type: PipelineRetryInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiPipelineID!
| The ID of the pipeline to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
pipeline
| Pipeline
| The pipeline after mutation. |
Mutation.prometheusIntegrationCreate
Input type: PrometheusIntegrationCreateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean!
| Whether the integration is receiving alerts. |
apiUrl
| String!
| Endpoint at which Prometheus can be queried. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| The project to create the integration in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
integration
| AlertManagementPrometheusIntegration
| The newly created integration. |
Mutation.prometheusIntegrationResetToken
Input type: PrometheusIntegrationResetTokenInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IntegrationsPrometheusID!
| The ID of the integration to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
integration
| AlertManagementPrometheusIntegration
| The newly created integration. |
Mutation.prometheusIntegrationUpdate
Input type: PrometheusIntegrationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the integration is receiving alerts. |
apiUrl
| String
| Endpoint at which Prometheus can be queried. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IntegrationsPrometheusID!
| The ID of the integration to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
integration
| AlertManagementPrometheusIntegration
| The newly created integration. |
Mutation.promoteToEpic
Input type: PromoteToEpicInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
groupPath
| ID
| The group the promoted epic will belong to. |
iid
| String!
| The IID of the issue to mutate. |
projectPath
| ID!
| The project the issue to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| The epic after issue promotion. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.releaseAssetLinkCreate
Input type: ReleaseAssetLinkCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
directAssetPath
| String
| Relative path for a direct asset link. |
linkType
| ReleaseAssetLinkType
| The type 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
link
| ReleaseAssetLink
| The asset link after mutation. |
Mutation.releaseAssetLinkDelete
Input type: ReleaseAssetLinkDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ReleasesLinkID!
| ID of the release asset link to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
link
| ReleaseAssetLink
| The deleted release asset link. |
Mutation.releaseAssetLinkUpdate
Input type: ReleaseAssetLinkUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
directAssetPath
| String
| Relative path for a direct asset link. |
id
| ReleasesLinkID!
| ID of the release asset link to update. |
linkType
| ReleaseAssetLinkType
| The type of the asset link. |
name
| String
| Name of the asset link. |
url
| String
| URL of the asset link. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
link
| ReleaseAssetLink
| The asset link after mutation. |
Mutation.releaseCreate
Input type: ReleaseCreateInput
Arguments
Name | Type | Description |
---|---|---|
assets
| ReleaseAssetsInput
| Assets associated to the release. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description (also known as “release notes”) of the release. |
milestones
| [String!]
| The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. |
name
| String
| Name of the release. |
projectPath
| ID!
| Full path of the project the release is associated with. |
ref
| String
| The commit SHA or branch name to use if creating a new tag. |
releasedAt
| Time
| The date when the release will be/was ready. Defaults to the current time. |
tagName
| String!
| Name of the tag to associate with the release. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
release
| Release
| The release after mutation. |
Mutation.releaseDelete
Input type: ReleaseDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
release
| Release
| The deleted release. |
Mutation.releaseUpdate
Input type: ReleaseUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description (release notes) of the release. |
milestones
| [String!]
| The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. |
name
| String
| Name of the release. |
projectPath
| ID!
| Full path of the project the release is associated with. |
releasedAt
| Time
| The release date. |
tagName
| String!
| Name of the tag associated with the release. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
release
| Release
| The release after mutation. |
Mutation.removeProjectFromSecurityDashboard
Input type: RemoveProjectFromSecurityDashboardInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ProjectID!
| ID of the project to remove from the Instance Security Dashboard. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.repositionImageDiffNote
Repositions a DiffNote on an image (a Note
where the position.positionType
is "image"
).
Input type: RepositionImageDiffNoteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| DiffNoteID!
| The global ID of the DiffNote to update. |
position
| UpdateDiffImagePositionInput!
| The position of this note on a diff. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
note
| Note
| The note after mutation. |
Mutation.runnerDelete
Available only when feature flag runner_graphql_query
is enabled.
Input type: RunnerDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiRunnerID!
| ID of the runner to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.runnerUpdate
Available only when feature flag runner_graphql_query
is enabled.
Input type: RunnerUpdateInput
Arguments
Name | Type | Description |
---|---|---|
accessLevel
| CiRunnerAccessLevel
| Access level of the runner. |
active
| Boolean
| Indicates the runner is allowed to receive jobs. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the runner. |
id
| CiRunnerID!
| ID of the runner to update. |
locked
| Boolean
| Indicates the runner is locked. |
maximumTimeout
| Int
| Maximum timeout (in seconds) for jobs processed by the runner. |
runUntagged
| Boolean
| Indicates the runner is able to run untagged jobs. |
tagList
| [String!]
| Tags associated with the runner. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
runner
| CiRunner
| The runner after mutation. |
Mutation.runnersRegistrationTokenReset
Available only when feature flag runner_graphql_query
is enabled.
Input type: RunnersRegistrationTokenResetInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ID
| ID of the project or group to reset the token for. Omit if resetting instance runner token. |
type
| CiRunnerType!
| Scope of the object to reset the token for. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
token
| String
| The runner token after mutation. |
Mutation.terraformStateDelete
Input type: TerraformStateDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| TerraformStateID!
| Global ID of the Terraform state. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.terraformStateLock
Input type: TerraformStateLockInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| TerraformStateID!
| Global ID of the Terraform state. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.terraformStateUnlock
Input type: TerraformStateUnlockInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| TerraformStateID!
| Global ID of the Terraform state. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.todoCreate
Input type: TodoCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
targetId
| TodoableID!
| The global ID of the to-do item’s parent. Issues, merge requests, designs and epics are supported. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
todo
| Todo
| The to-do item created. |
Mutation.todoMarkDone
Input type: TodoMarkDoneInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| TodoID!
| The global ID of the to-do item to mark as done. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
todo
| Todo!
| The requested to-do item. |
Mutation.todoRestore
Input type: TodoRestoreInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| TodoID!
| The global ID of the to-do item to restore. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
todo
| Todo!
| The requested to-do item. |
Mutation.todoRestoreMany
Input type: TodoRestoreManyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
ids
| [TodoID!]!
| The global IDs of the to-do items to restore (a maximum of 50 is supported at once). |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| The IID of the alert to mutate. |
projectPath
| ID!
| The project the alert to mutate is in. |
status
| AlertManagementStatus!
| The status to set the alert. |
Fields
Name | Type | Description |
---|---|---|
alert
| AlertManagementAlert
| The alert after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue created after mutation. |
todo
| Todo
| The to-do item after mutation. |
Mutation.updateBoard
Input type: UpdateBoardInput
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| UserID
| ID of user to be assigned to the board. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
hideBacklogList
| Boolean
| Whether or not backlog list is hidden. |
hideClosedList
| Boolean
| Whether or not closed list is hidden. |
id
| BoardID!
| The board global ID. |
iterationId
| IterationID
| ID of iteration to be assigned to the board. |
labelIds
| [LabelID!]
| IDs of labels to be added to the board. |
labels
| [String!]
| Labels of the issue. |
milestoneId
| MilestoneID
| ID of milestone to be assigned to the board. |
name
| String
| The board name. |
weight
| Int
| Weight value to be assigned to the board. |
Fields
Name | Type | Description |
---|---|---|
board
| Board
| The board after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateBoardEpicUserPreferences
Input type: UpdateBoardEpicUserPreferencesInput
Arguments
Name | Type | Description |
---|---|---|
boardId
| BoardID!
| The board global ID. |
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicUserPreferences
| BoardEpicUserPreferences
| User preferences for the epic in the board after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateBoardList
Input type: UpdateBoardListInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
collapsed
| Boolean
| Indicates if the list is collapsed for this user. |
listId
| ListID!
| Global ID of the list. |
position
| Int
| Position of list within the board. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
list
| BoardList
| Mutated list. |
Mutation.updateComplianceFramework
Input type: UpdateComplianceFrameworkInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ComplianceManagementFrameworkID!
| The global ID of the compliance framework to update. |
params
| ComplianceFrameworkInput!
| Parameters to update the compliance framework with. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
complianceFramework
| ComplianceFramework
| The compliance framework after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateContainerExpirationPolicy
Input type: UpdateContainerExpirationPolicyInput
Arguments
Name | Type | Description |
---|---|---|
cadence
| ContainerExpirationPolicyCadenceEnum
| This container expiration policy schedule. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
enabled
| Boolean
| Indicates whether this container expiration policy is enabled. |
keepN
| ContainerExpirationPolicyKeepEnum
| Number of tags to retain. |
nameRegex
| UntrustedRegexp
| Tags with names matching this regex pattern will expire. |
nameRegexKeep
| UntrustedRegexp
| Tags with names matching this regex pattern will be preserved. |
olderThan
| ContainerExpirationPolicyOlderThanEnum
| Tags older that this will expire. |
projectPath
| ID!
| The project path where the container expiration policy is located. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
containerExpirationPolicy
| ContainerExpirationPolicy
| The container expiration policy after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateEpic
Input type: UpdateEpicInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
| [ID!]
| The IDs of labels to be added to the epic. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| Indicates if the epic is confidential. |
description
| String
| The description of the epic. |
dueDateFixed
| String
| The end date of the epic. |
dueDateIsFixed
| Boolean
| Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
groupPath
| ID!
| The group the epic to mutate is in. |
iid
| ID!
| The IID of the epic to mutate. |
removeLabelIds
| [ID!]
| The IDs of labels to be removed from the epic. |
startDateFixed
| String
| The start date of the epic. |
startDateIsFixed
| Boolean
| Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
stateEvent
| EpicStateEvent
| State event for the epic. |
title
| String
| The title of the epic. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| The epic after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateEpicBoardList
Input type: UpdateEpicBoardListInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
collapsed
| Boolean
| Indicates if the list is collapsed for this user. |
listId
| BoardsEpicListID!
| Global ID of the epic list. |
position
| Int
| Position of list within the board. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
list
| EpicList
| Mutated 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 the update, and no Note will be
returned.
Input type: UpdateImageDiffNoteInput
Arguments
Name | Type | Description |
---|---|---|
body
| String
| Content of the note. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| NoteID!
| The global ID of the note to update. |
position
| UpdateDiffImagePositionInput
| The position of this note on a diff. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
note
| Note
| The note after mutation. |
Mutation.updateIssue
Input type: UpdateIssueInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
| [ID!]
| The IDs of labels to be added to the issue. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| Indicates the issue is confidential. |
description
| String
| Description of the issue. |
dueDate
| ISO8601Date
| Due date of the issue. |
epicId
| EpicID
| The ID of the parent epic. NULL when removing the association. |
healthStatus
| HealthStatus
| The desired health status. |
iid
| String!
| The IID of the issue to mutate. |
locked
| Boolean
| Indicates discussion is locked on the issue. |
milestoneId
| ID
| The ID of the milestone to assign to the issue. On update milestone will be removed if set to null. |
projectPath
| ID!
| The project the issue to mutate is in. |
removeLabelIds
| [ID!]
| The IDs of labels to be removed from the issue. |
stateEvent
| IssueStateEvent
| Close or reopen an issue. |
title
| String
| Title of the issue. |
type
| IssueType
| Type of the issue. |
weight
| Int
| The weight of the issue. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| The issue after mutation. |
Mutation.updateIteration
Input type: UpdateIterationInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the iteration. |
dueDate
| String
| End date of the iteration. |
groupPath
| ID!
| Group of the iteration. |
id
| ID!
| Global ID of the iteration. |
startDate
| String
| Start date of the iteration. |
title
| String
| Title of the iteration. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
iteration
| Iteration
| Updated iteration. |
Mutation.updateNamespacePackageSettings
Input type: UpdateNamespacePackageSettingsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
genericDuplicateExceptionRegex
| UntrustedRegexp
| When 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. |
mavenDuplicateExceptionRegex
| UntrustedRegexp
| When 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. |
namespacePath
| ID!
| The namespace path where the namespace package setting is located. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
packageSettings
| PackageSettings
| The namespace 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 the update, and no Note will be returned.
Input type: UpdateNoteInput
Arguments
Name | Type | Description |
---|---|---|
body
| String
| Content of the note. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| The confidentiality flag of a note. Default is false. |
id
| NoteID!
| The global ID of the note to update. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
note
| Note
| The note after mutation. |
Mutation.updateRequirement
Input type: UpdateRequirementInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the requirement. |
iid
| String!
| The IID of the requirement to update. |
lastTestReportState
| TestReportState
| Creates a test report for the requirement with the given state. |
projectPath
| ID!
| Full project path the requirement is associated with. |
state
| RequirementState
| State of the requirement. |
title
| String
| Title of the requirement. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
requirement
| Requirement
| Requirement after mutation. |
Mutation.updateSnippet
Input type: UpdateSnippetInput
Arguments
Name | Type | Description |
---|---|---|
blobActions
| [SnippetBlobActionInputType!]
| Actions to perform over the snippet repository and blobs. |
captchaResponse
| String
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the snippet. |
id
| SnippetID!
| The global ID of the snippet to update. |
spamLogId
| Int
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
title
| String
| Title of the snippet. |
visibilityLevel
| VisibilityLevelsEnum
| The visibility level of the snippet. |
Fields
Name | Type | Description |
---|---|---|
captchaSiteKey
| String
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
needsCaptchaResponse
| Boolean
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
snippet
| Snippet
| The snippet after mutation. |
spam
| Boolean
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
spamLogId
| Int
| Deprecated: Use spam protection with HTTP headers instead. Deprecated in 13.11. |
Mutation.userCalloutCreate
Input type: UserCalloutCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
featureName
| String!
| The feature name you want to dismiss the callout for. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
userCallout
| UserCallout!
| The user callout dismissed. |
Mutation.vulnerabilityConfirm
Input type: VulnerabilityConfirmInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| VulnerabilityID!
| ID of the vulnerability to be confirmed. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
vulnerability
| Vulnerability
| The vulnerability after state change. |
Mutation.vulnerabilityDismiss
Input type: VulnerabilityDismissInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
comment
| String
| Comment why vulnerability should be dismissed. |
dismissalReason
| VulnerabilityDismissalReason
| Reason why vulnerability should be dismissed. |
id
| VulnerabilityID!
| ID of the vulnerability to be dismissed. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
vulnerability
| Vulnerability
| The vulnerability after dismissal. |
Mutation.vulnerabilityExternalIssueLinkCreate
Input type: VulnerabilityExternalIssueLinkCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A 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
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
externalIssueLink
| VulnerabilityExternalIssueLink
| The created external issue link. |
Mutation.vulnerabilityExternalIssueLinkDestroy
Input type: VulnerabilityExternalIssueLinkDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| VulnerabilitiesExternalIssueLinkID!
| The global ID of the vulnerability external issue link. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.vulnerabilityResolve
Input type: VulnerabilityResolveInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| VulnerabilityID!
| ID of the vulnerability to be resolved. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
vulnerability
| Vulnerability
| The vulnerability after state change. |
Mutation.vulnerabilityRevertToDetected
Input type: VulnerabilityRevertToDetectedInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| VulnerabilityID!
| ID of the vulnerability to be reverted. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
vulnerability
| Vulnerability
| The vulnerability after revert. |
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:
Name | Type | Description |
---|---|---|
after
| String
| Returns the elements in the list that come after the specified cursor. |
before
| String
| Returns the elements in the list that come before the specified cursor. |
first
| Int
| Returns the first n elements from the list. |
last
| Int
| Returns 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:
Name | Type | Description |
---|---|---|
pageInfo
| PageInfo!
| 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.
AgentConfigurationConnection
The connection type for AgentConfiguration
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AgentConfiguration
| The item at the end of the edge. |
AlertManagementAlertConnection
The connection type for AlertManagementAlert
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AlertManagementAlert
| The item at the end of the edge. |
AlertManagementHttpIntegrationConnection
The connection type for AlertManagementHttpIntegration
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AlertManagementHttpIntegration
| The item at the end of the edge. |
AlertManagementIntegrationConnection
The connection type for AlertManagementIntegration
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AlertManagementIntegration
| The item at the end of the edge. |
AwardEmojiConnection
The connection type for AwardEmoji
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AwardEmoji
| The item at the end of the edge. |
BlobConnection
The connection type for Blob
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Blob
| The item at the end of the edge. |
BoardConnection
The connection type for Board
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Board
| The item at the end of the edge. |
BoardEpicConnection
The connection type for BoardEpic
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| BoardEpic
| The item at the end of the edge. |
BoardListConnection
The connection type for BoardList
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| BoardList
| The item at the end of the edge. |
CiBuildNeedConnection
The connection type for CiBuildNeed
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiBuildNeed
| The item at the end of the edge. |
CiConfigGroupConnection
The connection type for CiConfigGroup
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiConfigGroup
| The item at the end of the edge. |
CiConfigJobConnection
The connection type for CiConfigJob
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiConfigJob
| The item at the end of the edge. |
CiConfigNeedConnection
The connection type for CiConfigNeed
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiConfigNeed
| The item at the end of the edge. |
CiConfigStageConnection
The connection type for CiConfigStage
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiConfigStage
| The item at the end of the edge. |
CiGroupConnection
The connection type for CiGroup
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiGroup
| The item at the end of the edge. |
CiJobArtifactConnection
The connection type for CiJobArtifact
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiJobArtifact
| The item at the end of the edge. |
CiJobConnection
The connection type for CiJob
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [CiJobEdge]
| A list of edges. |
nodes
| [CiJob]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiJobEdge
The edge type for CiJob
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiJob
| The item at the end of the edge. |
CiRunnerConnection
The connection type for CiRunner
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiRunnerEdge]
| A list of edges. |
nodes
| [CiRunner]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiRunnerEdge
The edge type for CiRunner
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiRunner
| The item at the end of the edge. |
CiStageConnection
The connection type for CiStage
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiStage
| The item at the end of the edge. |
ClusterAgentConnection
The connection type for ClusterAgent
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ClusterAgent
| The item at the end of the edge. |
ClusterAgentTokenConnection
The connection type for ClusterAgentToken
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ClusterAgentToken
| The item at the end of the edge. |
CodeCoverageActivityConnection
The connection type for CodeCoverageActivity
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CodeCoverageActivity
| The item at the end of the edge. |
CodeQualityDegradationConnection
The connection type for CodeQualityDegradation
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CodeQualityDegradation
| The item at the end of the edge. |
CommitConnection
The connection type for Commit
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Commit
| The item at the end of the edge. |
ComplianceFrameworkConnection
The connection type for ComplianceFramework
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ComplianceFramework
| The item at the end of the edge. |
ContainerRepositoryConnection
The connection type for ContainerRepository
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ContainerRepository
| The item at the end of the edge. |
ContainerRepositoryTagConnection
The connection type for ContainerRepositoryTag
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ContainerRepositoryTag
| The item at the end of the edge. |
CustomEmojiConnection
The connection type for CustomEmoji
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CustomEmoji
| The item at the end of the edge. |
DastProfileConnection
The connection type for DastProfile
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DastProfile
| The item at the end of the edge. |
DastScannerProfileConnection
The connection type for DastScannerProfile
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DastScannerProfile
| The item at the end of the edge. |
DastSiteProfileConnection
The connection type for DastSiteProfile
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DastSiteProfile
| The item at the end of the edge. |
DastSiteValidationConnection
The connection type for DastSiteValidation
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DastSiteValidation
| The item at the end of the edge. |
DesignAtVersionConnection
The connection type for DesignAtVersion
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DesignAtVersion
| The item at the end of the edge. |
DesignConnection
The connection type for Design
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Design
| The item at the end of the edge. |
DesignVersionConnection
The connection type for DesignVersion
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DesignVersion
| The item at the end of the edge. |
DevopsAdoptionEnabledNamespaceConnection
The connection type for DevopsAdoptionEnabledNamespace
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DevopsAdoptionEnabledNamespace
| The item at the end of the edge. |
DevopsAdoptionSnapshotConnection
The connection type for DevopsAdoptionSnapshot
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DevopsAdoptionSnapshot
| The item at the end of the edge. |
DiscussionConnection
The connection type for Discussion
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Discussion
| The item at the end of the edge. |
EnvironmentConnection
The connection type for Environment
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Environment
| The item at the end of the edge. |
EpicBoardConnection
The connection type for EpicBoard
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| EpicBoard
| The item at the end of the edge. |
EpicConnection
The connection type for Epic
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Epic
| The item at the end of the edge. |
EpicIssueConnection
The connection type for EpicIssue
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| EpicIssue
| The item at the end of the edge. |
EpicListConnection
The connection type for EpicList
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| EpicList
| The item at the end of the edge. |
EscalationPolicyTypeConnection
The connection type for EscalationPolicyType
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| EscalationPolicyType
| The item at the end of the edge. |
EventConnection
The connection type for Event
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Event
| The item at the end of the edge. |
GroupMemberConnection
The connection type for GroupMember
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| GroupMember
| The item at the end of the edge. |
GroupWikiRepositoryRegistryConnection
The connection type for GroupWikiRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| GroupWikiRepositoryRegistry
| The item at the end of the edge. |
IncidentManagementOncallRotationConnection
The connection type for IncidentManagementOncallRotation
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| IncidentManagementOncallRotation
| The item at the end of the edge. |
IncidentManagementOncallScheduleConnection
The connection type for IncidentManagementOncallSchedule
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| IncidentManagementOncallSchedule
| The item at the end of the edge. |
IncidentManagementOncallShiftConnection
The connection type for IncidentManagementOncallShift
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| IncidentManagementOncallShift
| The item at the end of the edge. |
IssueConnection
The connection type for Issue
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Issue
| The item at the end of the edge. |
IterationCadenceConnection
The connection type for IterationCadence
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| IterationCadence
| The item at the end of the edge. |
IterationConnection
The connection type for Iteration
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Iteration
| The item at the end of the edge. |
JiraImportConnection
The connection type for JiraImport
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| JiraImport
| The item at the end of the edge. |
JiraProjectConnection
The connection type for JiraProject
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| JiraProject
| The item at the end of the edge. |
LabelConnection
The connection type for Label
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Label
| The item at the end of the edge. |
LfsObjectRegistryConnection
The connection type for LfsObjectRegistry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| LfsObjectRegistry
| The item at the end of the edge. |
LicenseHistoryEntryConnection
The connection type for LicenseHistoryEntry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| LicenseHistoryEntry
| The item at the end of the edge. |
MemberInterfaceConnection
The connection type for MemberInterface
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MemberInterface
| The item at the end of the edge. |
MergeRequestAssigneeConnection
The connection type for MergeRequestAssignee
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeRequestAssignee
| The item at the end of the edge. |
MergeRequestConnection
The connection type for MergeRequest
.
Fields
Name | Type | Description |
---|---|---|
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
| Float
| Total sum of time to merge, in seconds, for the collection of merge requests. |
MergeRequestDiffRegistryConnection
The connection type for MergeRequestDiffRegistry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeRequestDiffRegistry
| The item at the end of the edge. |
MergeRequestEdge
The edge type for MergeRequest
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeRequest
| The item at the end of the edge. |
MergeRequestReviewerConnection
The connection type for MergeRequestReviewer
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeRequestReviewer
| The item at the end of the edge. |
MetricsDashboardAnnotationConnection
The connection type for MetricsDashboardAnnotation
.
Fields
Name | Type | Description |
---|---|---|
edges
| [MetricsDashboardAnnotationEdge]
| A list of edges. |
nodes
| [MetricsDashboardAnnotation]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
MetricsDashboardAnnotationEdge
The edge type for MetricsDashboardAnnotation
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MetricsDashboardAnnotation
| The item at the end of the edge. |
MilestoneConnection
The connection type for Milestone
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Milestone
| The item at the end of the edge. |
NamespaceConnection
The connection type for Namespace
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Namespace
| The item at the end of the edge. |
NetworkPolicyConnection
The connection type for NetworkPolicy
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| NetworkPolicy
| The item at the end of the edge. |
NoteConnection
The connection type for Note
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Note
| The item at the end of the edge. |
OncallParticipantTypeConnection
The connection type for OncallParticipantType
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| OncallParticipantType
| The item at the end of the edge. |
PackageConnection
The connection type for Package
.
Fields
Name | Type | Description |
---|---|---|
edges
| [PackageEdge]
| A list of edges. |
nodes
| [Package]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PackageEdge
The edge type for Package
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Package
| The item at the end of the edge. |
PackageFileConnection
The connection type for PackageFile
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PackageFile
| The item at the end of the edge. |
PackageFileRegistryConnection
The connection type for PackageFileRegistry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PackageFileRegistry
| The item at the end of the edge. |
PackageTagConnection
The connection type for PackageTag
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PackageTag
| The item at the end of the edge. |
PathLockConnection
The connection type for PathLock
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PathLock
| The item at the end of the edge. |
PipelineArtifactRegistryConnection
The connection type for PipelineArtifactRegistry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PipelineArtifactRegistry
| The item at the end of the edge. |
PipelineConnection
The connection type for Pipeline
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Pipeline
| The item at the end of the edge. |
PipelineSecurityReportFindingConnection
The connection type for PipelineSecurityReportFinding
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PipelineSecurityReportFinding
| The item at the end of the edge. |
ProjectConnection
The connection type for Project
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Project
| The item at the end of the edge. |
ProjectMemberConnection
The connection type for ProjectMember
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ProjectMember
| The item at the end of the edge. |
ReleaseAssetLinkConnection
The connection type for ReleaseAssetLink
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ReleaseAssetLink
| The item at the end of the edge. |
ReleaseConnection
The connection type for Release
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Release
| The item at the end of the edge. |
ReleaseEvidenceConnection
The connection type for ReleaseEvidence
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ReleaseEvidence
| The item at the end of the edge. |
ReleaseSourceConnection
The connection type for ReleaseSource
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ReleaseSource
| The item at the end of the edge. |
RepositoryBlobConnection
The connection type for RepositoryBlob
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| RepositoryBlob
| The item at the end of the edge. |
RequirementConnection
The connection type for Requirement
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Requirement
| The item at the end of the edge. |
RunnerArchitectureConnection
The connection type for RunnerArchitecture
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| RunnerArchitecture
| The item at the end of the edge. |
RunnerPlatformConnection
The connection type for RunnerPlatform
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| RunnerPlatform
| The item at the end of the edge. |
SastCiConfigurationAnalyzersEntityConnection
The connection type for SastCiConfigurationAnalyzersEntity
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| SastCiConfigurationAnalyzersEntity
| The item at the end of the edge. |
SastCiConfigurationEntityConnection
The connection type for SastCiConfigurationEntity
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| SastCiConfigurationEntity
| The item at the end of the edge. |
SastCiConfigurationOptionsEntityConnection
The connection type for SastCiConfigurationOptionsEntity
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| SastCiConfigurationOptionsEntity
| The item at the end of the edge. |
ScanConnection
The connection type for Scan
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Scan
| The item at the end of the edge. |
ScanExecutionPolicyConnection
The connection type for ScanExecutionPolicy
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ScanExecutionPolicy
| The item at the end of the edge. |
ScannedResourceConnection
The connection type for ScannedResource
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ScannedResource
| The item at the end of the edge. |
SentryErrorConnection
The connection type for SentryError
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| SentryError
| The item at the end of the edge. |
ServiceConnection
The connection type for Service
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Service
| The item at the end of the edge. |
SnippetBlobConnection
The connection type for SnippetBlob
.
Fields
Name | Type | Description |
---|---|---|
edges
| [SnippetBlobEdge]
| A list of edges. |
nodes
| [SnippetBlob]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
SnippetBlobEdge
The edge type for SnippetBlob
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| SnippetBlob
| The item at the end of the edge. |
SnippetConnection
The connection type for Snippet
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Snippet
| The item at the end of the edge. |
SnippetRepositoryRegistryConnection
The connection type for SnippetRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| SnippetRepositoryRegistry
| The item at the end of the edge. |
SubmoduleConnection
The connection type for Submodule
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Submodule
| The item at the end of the edge. |
TerraformStateConnection
The connection type for TerraformState
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TerraformState
| The item at the end of the edge. |
TerraformStateVersionRegistryConnection
The connection type for TerraformStateVersionRegistry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TerraformStateVersionRegistry
| The item at the end of the edge. |
TestCaseConnection
The connection type for TestCase
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TestCase
| The item at the end of the edge. |
TestReportConnection
The connection type for TestReport
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TestReport
| The item at the end of the edge. |
TestSuiteSummaryConnection
The connection type for TestSuiteSummary
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TestSuiteSummary
| The item at the end of the edge. |
TimelogConnection
The connection type for Timelog
.
Fields
Name | Type | Description |
---|---|---|
edges
| [TimelogEdge]
| A list of edges. |
nodes
| [Timelog]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
TimelogEdge
The edge type for Timelog
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Timelog
| The item at the end of the edge. |
TodoConnection
The connection type for Todo
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Todo
| The item at the end of the edge. |
TreeEntryConnection
The connection type for TreeEntry
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TreeEntry
| The item at the end of the edge. |
UsageTrendsMeasurementConnection
The connection type for UsageTrendsMeasurement
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| UsageTrendsMeasurement
| The item at the end of the edge. |
UserCalloutConnection
The connection type for UserCallout
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| UserCallout
| The item at the end of the edge. |
UserCoreConnection
The connection type for UserCore
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| UserCore
| The item at the end of the edge. |
VulnerabilitiesCountByDayConnection
The connection type for VulnerabilitiesCountByDay
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| VulnerabilitiesCountByDay
| The item at the end of the edge. |
VulnerabilityConnection
The connection type for Vulnerability
.
Fields
Name | Type | Description |
---|---|---|
edges
| [VulnerabilityEdge]
| A list of edges. |
nodes
| [Vulnerability]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
VulnerabilityEdge
The edge type for Vulnerability
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Vulnerability
| The item at the end of the edge. |
VulnerabilityExternalIssueLinkConnection
The connection type for VulnerabilityExternalIssueLink
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| VulnerabilityExternalIssueLink
| The item at the end of the edge. |
VulnerabilityIssueLinkConnection
The connection type for VulnerabilityIssueLink
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| VulnerabilityIssueLink
| The item at the end of the edge. |
VulnerabilityScannerConnection
The connection type for VulnerabilityScanner
.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| VulnerabilityScanner
| The 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
Name | Type | Description |
---|---|---|
integerValue
| Int
| Integer representation of access level. |
stringValue
| AccessLevelEnum
| String representation of access level. |
AgentConfiguration
Configuration details for an Agent.
Fields
Name | Type | Description |
---|---|---|
agentName
| String
| Name of the agent. |
AlertManagementAlert
Describes an alert from the project’s Alert Management.
Fields
Name | Type | Description |
---|---|---|
assignees
| UserCoreConnection
| Assignees of the alert. (see Connections) |
createdAt
| Time
| Timestamp the alert was created. |
description
| String
| Description of the alert. |
details
| JSON
| Alert details. |
detailsUrl
| String!
| The URL of the alert detail page. |
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
endedAt
| Time
| Timestamp the alert ended. |
environment
| Environment
| Environment for the alert. |
eventCount
| Int
| Number of events of this alert. |
hosts
| [String!]
| List of hosts the alert came from. |
iid
| ID!
| Internal ID of the alert. |
issue
| Issue
| Issue attached to the alert. |
issueIid
| ID
| Deprecated in 13.10. Use issue field. |
metricsDashboardUrl
| String
| URL for metrics embed for the alert. |
monitoringTool
| String
| Monitoring tool the alert came from. |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
prometheusAlert
| PrometheusAlert
| The alert condition for Prometheus. |
runbook
| String
| Runbook for the alert as defined in alert details. |
service
| String
| Service the alert came from. |
severity
| AlertManagementSeverity
| Severity of the alert. |
startedAt
| Time
| Timestamp the alert was raised. |
status
| AlertManagementStatus
| Status of the alert. |
title
| String
| Title of the alert. |
updatedAt
| Time
| Timestamp the alert was last updated. |
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
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| The action to be filtered. |
authorId
| [ID!]
| The ID of an author. |
groupId
| [ID!]
| The ID of a group. |
projectId
| [ID!]
| The ID of a project. |
state
| [TodoStateEnum!]
| The state of the todo. |
type
| [TodoTargetEnum!]
| The type of the todo. |
AlertManagementAlertStatusCountsType
Represents total number of alerts for the represented categories.
Fields
Name | Type | Description |
---|---|---|
acknowledged
| Int
| Number of alerts with status ACKNOWLEDGED for the project. |
all
| Int
| Total number of alerts for the project. |
ignored
| Int
| Number of alerts with status IGNORED for the project. |
open
| Int
| Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project. |
resolved
| Int
| Number of alerts with status RESOLVED for the project. |
triggered
| Int
| Number of alerts with status TRIGGERED for the project. |
AlertManagementHttpIntegration
An endpoint and credentials used to accept alerts for a project.
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the endpoint is currently accepting alerts. |
apiUrl
| String
| URL at which Prometheus metrics can be queried to populate the metrics dashboard. |
id
| ID!
| ID of the integration. |
name
| String
| Name 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
| JsonString
| The example of an alert payload. |
token
| String
| Token used to authenticate alert notification requests. |
type
| AlertManagementIntegrationType!
| Type of integration. |
url
| String
| Endpoint which accepts alert notifications. |
AlertManagementPayloadAlertField
Parsed field from an alert used for custom mappings.
Fields
Name | Type | Description |
---|---|---|
label
| String
| Human-readable label of the payload path. |
path
| [PayloadAlertFieldPathSegment!]
| Path to value inside payload JSON. |
type
| AlertManagementPayloadAlertFieldType
| Type of the parsed value. |
AlertManagementPayloadAlertMappingField
Parsed field (with its name) from an alert used for custom mappings.
Fields
Name | Type | Description |
---|---|---|
fieldName
| AlertManagementPayloadAlertFieldName
| A GitLab alert field name. |
label
| String
| Human-readable label of the payload path. |
path
| [PayloadAlertFieldPathSegment!]
| Path to value inside payload JSON. |
type
| AlertManagementPayloadAlertFieldType
| Type of the parsed value. |
AlertManagementPrometheusIntegration
An endpoint and credentials used to accept Prometheus alerts for a project.
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the endpoint is currently accepting alerts. |
apiUrl
| String
| URL at which Prometheus metrics can be queried to populate the metrics dashboard. |
id
| ID!
| ID of the integration. |
name
| String
| Name of the integration. |
token
| String
| Token used to authenticate alert notification requests. |
type
| AlertManagementIntegrationType!
| Type of integration. |
url
| String
| Endpoint which accepts alert notifications. |
ApiFuzzingCiConfiguration
Data associated with configuring API fuzzing scans in GitLab CI.
Fields
Name | Type | Description |
---|---|---|
scanModes
| [ApiFuzzingScanMode!]
| All available scan modes. |
scanProfiles
| [ApiFuzzingScanProfile!]
| All default scan profiles. |
ApiFuzzingScanProfile
An API Fuzzing scan profile.
Fields
Name | Type | Description |
---|---|---|
description
| String
| A short description of the profile. |
name
| String
| The unique name of the profile. |
yaml
| String
| A syntax highlit HTML representation of the YAML. |
ApprovalRule
Describes a rule for who can approve merge requests.
Fields
Name | Type | Description |
---|---|---|
id
| GlobalID!
| ID of the rule. |
name
| String
| Name of the rule. |
type
| ApprovalRuleType
| Type of the rule. |
AwardEmoji
An emoji awarded by a user.
Fields
Name | Type | Description |
---|---|---|
description
| String!
| The emoji description. |
emoji
| String!
| The emoji as an icon. |
name
| String!
| The emoji name. |
unicode
| String!
| The emoji in Unicode. |
unicodeVersion
| String!
| The Unicode version for this emoji. |
user
| UserCore!
| The user who awarded the emoji. |
BaseService
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Indicates if the service is active. |
type
| String
| Class name of the service. |
Blob
Fields
Name | Type | Description |
---|---|---|
flatPath
| String!
| Flat path of the entry. |
id
| ID!
| ID of the entry. |
lfsOid
| String
| LFS ID of the blob. |
mode
| String
| Blob 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
| String
| Web path of the blob. |
webUrl
| String
| Web URL of the blob. |
BlobViewer
Represents how the blob content should be displayed.
Fields
Name | Type | Description |
---|---|---|
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
| String
| Error 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
Name | Type | Description |
---|---|---|
assignee
| UserCore
| The board assignee. |
createdAt
| Time!
| Timestamp of when the board was created. |
hideBacklogList
| Boolean
| Whether or not backlog list is hidden. |
hideClosedList
| Boolean
| Whether or not closed list is hidden. |
id
| ID!
| ID (global ID) of the board. |
iteration
| Iteration
| The board iteration. |
labels
| LabelConnection
| Labels of the board. (see Connections) |
milestone
| Milestone
| The board milestone. |
name
| String
| Name 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
| Int
| Weight 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
Name | Type | Description |
---|---|---|
issueFilters
| BoardIssueInput
| Filters 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
Name | Type | Description |
---|---|---|
id
| ListID
| Find a list by its global ID. |
issueFilters
| BoardIssueInput
| Filters applied when getting issue metadata in the board list. |
BoardEpic
Represents an epic on an issue board.
Fields
Name | Type | Description |
---|---|---|
author
| UserCore!
| Author of the epic. |
awardEmoji
| AwardEmojiConnection
| A list of award emojis associated with the epic. (see Connections) |
closedAt
| Time
| Timestamp of when the epic was closed. |
confidential
| Boolean
| Indicates if the epic is confidential. |
createdAt
| Time
| Timestamp of when the epic was created. |
descendantCounts
| EpicDescendantCount
| Number of open and closed descendant epics and issues. |
descendantWeightSum
| EpicDescendantWeights
| Total weight of open and closed issues in the epic and its descendants. |
description
| String
| Description of the epic. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
downvotes
| Int!
| Number of downvotes the epic has received. |
dueDate
| Time
| Due date of the epic. |
dueDateFixed
| Time
| Fixed due date of the epic. |
dueDateFromMilestones
| Time
| Inherited due date of the epic from milestones. |
dueDateIsFixed
| Boolean
| Indicates if the due date has been manually set. |
events
| EventConnection
| A list 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
| EpicHealthStatus
| Current health status of the epic. |
id
| ID!
| ID of the epic. |
iid
| ID!
| Internal ID of the epic. |
issues
| EpicIssueConnection
| A list of issues associated with the epic. (see Connections) |
labels
| LabelConnection
| Labels assigned to the epic. (see Connections) |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
parent
| Epic
| Parent epic of the epic. |
participants
| UserCoreConnection
| List of participants for the epic. (see Connections) |
relationPath
| String
| URI path of the epic-issue relationship. |
relativePosition
| Int
| The relative position of the epic in the epic tree. |
startDate
| Time
| Start date of the epic. |
startDateFixed
| Time
| Fixed start date of the epic. |
startDateFromMilestones
| Time
| Inherited start date of the epic from milestones. |
startDateIsFixed
| Boolean
| Indicates 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. |
title
| String
| Title of the epic. |
titleHtml
| String
| The GitLab Flavored Markdown rendering of title .
|
updatedAt
| Time
| Timestamp 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
| BoardEpicUserPreferences
| User 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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
iid
| ID
| IID of the epic, e.g., “1”. |
iidStartsWith
| String
| Filter epics by IID for autocomplete. |
iids
| [ID!]
| List of IIDs of epics, e.g., [1, 2] .
|
includeAncestorGroups
| Boolean
| Include epics from ancestor groups. |
includeDescendantGroups
| Boolean
| Include epics from descendant groups. |
labelName
| [String!]
| Filter epics by labels. |
milestoneTitle
| String
| Filter epics by milestone title, computed from epic’s issues. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedEpicFilterInput
| Negated epic arguments. |
search
| String
| Search query for epic title or description. |
sort
| EpicSort
| List epics by sort order. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
iid
| ID
| IID of the epic, e.g., “1”. |
iidStartsWith
| String
| Filter epics by IID for autocomplete. |
iids
| [ID!]
| List of IIDs of epics, e.g., [1, 2] .
|
includeAncestorGroups
| Boolean
| Include epics from ancestor groups. |
includeDescendantGroups
| Boolean
| Include epics from descendant groups. |
labelName
| [String!]
| Filter epics by labels. |
milestoneTitle
| String
| Filter epics by milestone title, computed from epic’s issues. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedEpicFilterInput
| Negated epic arguments. |
search
| String
| Search query for epic title or description. |
sort
| EpicSort
| List epics by sort order. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
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
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
BoardEpic.reference
Internal reference of the epic. Returned in shortened format by default.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
full
| Boolean
| Indicates if the reference should be returned in full. |
BoardEpicUserPreferences
Represents user preferences for a board epic.
Fields
Name | Type | Description |
---|---|---|
collapsed
| Boolean!
| Indicates epic should be displayed as collapsed. |
BoardList
Represents a list for an issue board.
Fields
Name | Type | Description |
---|---|---|
assignee
| UserCore
| Assignee in the list. |
collapsed
| Boolean
| Indicates if the list is collapsed for this user. |
id
| ID!
| ID (global ID) of the list. |
issuesCount
| Int
| Count of issues in the list. |
iteration
| Iteration
| Iteration of the list. |
label
| Label
| Label of the list. |
limitMetric
| ListLimitMetric
| The current limit metric for the list. |
listType
| String!
| Type of the list. |
maxIssueCount
| Int
| Maximum number of issues in the list. |
maxIssueWeight
| Int
| Maximum weight of issues in the list. |
milestone
| Milestone
| Milestone of the list. |
position
| Int
| Position of list within the board. |
title
| String!
| Title of the list. |
totalWeight
| Int
| Total weight of all issues in the list. |
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
Name | Type | Description |
---|---|---|
filters
| BoardIssueInput
| Filters applied when selecting issues in the board list. |
Branch
Fields
Name | Type | Description |
---|---|---|
commit
| Commit
| Commit for the branch. |
name
| String!
| Name of the branch. |
BurnupChartDailyTotals
Represents the total number of issues and their weights for a particular day.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
keepLatestArtifact
| Boolean
| Whether to keep the latest jobs artifacts. |
CiBuildNeed
Fields
Name | Type | Description |
---|---|---|
name
| String
| Name of the job we need to complete. |
CiConfig
Fields
Name | Type | Description |
---|---|---|
errors
| [String!]
| Linting errors. |
mergedYaml
| String
| Merged CI configuration YAML. |
stages
| CiConfigStageConnection
| Stages of the pipeline. (see Connections) |
status
| CiConfigStatus
| Status of linting, can be either valid or invalid. |
CiConfigGroup
Fields
Name | Type | Description |
---|---|---|
jobs
| CiConfigJobConnection
| Jobs in group. (see Connections) |
name
| String
| Name of the job group. |
size
| Int
| Size of the job group. |
CiConfigJob
Fields
Name | Type | Description |
---|---|---|
afterScript
| [String!]
| Override a set of commands that are executed after the job. |
allowFailure
| Boolean
| Allow job to fail. |
beforeScript
| [String!]
| Override a set of commands that are executed before the job. |
environment
| String
| Name of an environment to which the job deploys. |
except
| CiConfigJobRestriction
| Limit when jobs are not created. |
groupName
| String
| Name of the job group. |
name
| String
| Name of the job. |
needs
| CiConfigNeedConnection
| Builds that must complete before the jobs run. (see Connections) |
only
| CiConfigJobRestriction
| Jobs are created when these conditions do not apply. |
script
| [String!]
| Shell script that is executed by a runner. |
stage
| String
| Name of the job stage. |
tags
| [String!]
| List of tags that are used to select a runner. |
when
| String
| When to run the job. |
CiConfigJobRestriction
Fields
Name | Type | Description |
---|---|---|
refs
| [String!]
| The Git refs the job restriction applies to. |
CiConfigNeed
Fields
Name | Type | Description |
---|---|---|
name
| String
| Name of the need. |
CiConfigStage
Fields
Name | Type | Description |
---|---|---|
groups
| CiConfigGroupConnection
| Groups of jobs for the stage. (see Connections) |
name
| String
| Name of the stage. |
CiGroup
Fields
Name | Type | Description |
---|---|---|
detailedStatus
| DetailedStatus
| Detailed status of the group. |
jobs
| CiJobConnection
| Jobs in group. (see Connections) |
name
| String
| Name of the job group. |
size
| Int
| Size of the group. |
CiJob
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| Indicates the job is active. |
allowFailure
| Boolean!
| Whether the job is allowed to fail. |
artifacts
| CiJobArtifactConnection
| Artifacts generated by the job. (see Connections) |
cancelable
| Boolean!
| Indicates the job can be canceled. |
commitPath
| String
| Path to the commit that triggered the job. |
coverage
| Float
| Coverage level of the job. |
createdAt
| Time!
| When the job was created. |
createdByTag
| Boolean!
| Whether the job was created by a tag. |
detailedStatus
| DetailedStatus
| Detailed status of the job. |
duration
| Int
| Duration of the job in seconds. |
finishedAt
| Time
| When a job has finished running. |
id
| JobID
| ID of the job. |
manualJob
| Boolean
| Whether the job has a manual action. |
name
| String
| Name of the job. |
needs
| CiBuildNeedConnection
| References to builds that must complete before the jobs run. (see Connections) |
pipeline
| Pipeline
| Pipeline the job belongs to. |
playable
| Boolean!
| Indicates the job can be played. |
queuedAt
| Time
| When the job was enqueued and marked as pending. |
queuedDuration
| Duration
| How long the job was enqueued before starting. |
refName
| String
| Ref name of the job. |
refPath
| String
| Path to the ref. |
retryable
| Boolean!
| Indicates the job can be retried. |
scheduledAt
| Time
| Schedule for the build. |
schedulingType
| String
| Type of pipeline scheduling. Value is dag if the pipeline uses the needs keyword, and stage otherwise.
|
shortSha
| String!
| Short SHA1 ID of the commit. |
stage
| CiStage
| Stage of the job. |
startedAt
| Time
| When the job was started. |
status
| CiJobStatus
| Status of the job. |
stuck
| Boolean!
| Indicates the job is stuck. |
tags
| [String!]
| Tags for the current job. |
triggered
| Boolean
| Whether the job was triggered. |
userPermissions
| JobPermissions!
| Permissions for the current user on the resource. |
CiJobArtifact
Fields
Name | Type | Description |
---|---|---|
downloadPath
| String
| URL for downloading the artifact’s file. |
fileType
| JobArtifactFileType
| File type of the artifact. |
CiJobTokenScopeType
Fields
Name | Type | Description |
---|---|---|
projects
| ProjectConnection!
| Allow list of projects that can be accessed by CI Job tokens created by this project. (see Connections) |
CiRunner
Fields
Name | Type | Description |
---|---|---|
accessLevel
| CiRunnerAccessLevel!
| Access level of the runner. |
active
| Boolean!
| Indicates the runner is allowed to receive jobs. |
contactedAt
| Time
| Last contact from the runner. |
description
| String
| Description of the runner. |
id
| CiRunnerID!
| ID of the runner. |
ipAddress
| String!
| IP address of the runner. |
locked
| Boolean
| Indicates the runner is locked. |
maximumTimeout
| Int
| Maximum timeout (in seconds) for jobs processed by the runner. |
privateProjectsMinutesCostFactor
| Float
| Private projects’ “minutes cost factor” associated with the runner (GitLab.com only). |
publicProjectsMinutesCostFactor
| Float
| Public projects’ “minutes cost factor” associated with the runner (GitLab.com only). |
revision
| String!
| Revision of the runner. |
runUntagged
| Boolean!
| Indicates the runner is able to run untagged jobs. |
runnerType
| CiRunnerType!
| Type of the runner. |
shortSha
| String
| First eight characters of the runner’s token used to authenticate new job requests. Used as the runner’s unique ID. |
status
| CiRunnerStatus!
| Status of the runner. |
tagList
| [String!]
| Tags associated with the runner. |
version
| String!
| Version of the runner. |
CiStage
Fields
Name | Type | Description |
---|---|---|
detailedStatus
| DetailedStatus
| Detailed status of the stage. |
groups
| CiGroupConnection
| Group of jobs for the stage. (see Connections) |
jobs
| CiJobConnection
| Jobs for the stage. (see Connections) |
name
| String
| Name of the stage. |
status
| String
| Status of the pipeline stage. |
CiTemplate
GitLab CI/CD configuration template.
Fields
Name | Type | Description |
---|---|---|
content
| String!
| Contents of the CI template. |
name
| String!
| Name of the CI template. |
ClusterAgent
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp the cluster agent was created. |
createdByUser
| UserCore
| User object, containing information about the person who created the agent. |
id
| ID!
| ID of the cluster agent. |
name
| String
| Name of the cluster agent. |
project
| Project
| The project this cluster agent is associated with. |
tokens
| ClusterAgentTokenConnection
| Tokens associated with the cluster agent. (see Connections) |
updatedAt
| Time
| Timestamp the cluster agent was updated. |
webPath
| String
| Web path of the cluster agent. |
ClusterAgentToken
Fields
Name | Type | Description |
---|---|---|
clusterAgent
| ClusterAgent
| Cluster agent this token is associated with. |
createdAt
| Time
| Timestamp the token was created. |
createdByUser
| UserCore
| The user who created the token. |
description
| String
| Description of the token. |
id
| ClustersAgentTokenID!
| Global ID of the token. |
lastUsedAt
| Time
| Timestamp the token was last used. |
name
| String
| Name given to the token. |
CodeCoverageActivity
Represents the code coverage activity for a group.
Fields
Name | Type | Description |
---|---|---|
averageCoverage
| Float
| Average percentage of the different code coverage results available for the group. |
coverageCount
| Int
| Number of different code coverage results available for the group. |
date
| Date!
| Date when the code coverage was created. |
projectCount
| Int
| Number of projects with code coverage results for the group. |
CodeCoverageSummary
Represents the code coverage summary for a project.
Fields
Name | Type | Description |
---|---|---|
averageCoverage
| Float
| Average percentage of the different code coverage results available for the project. |
coverageCount
| Int
| Number of different code coverage results available. |
lastUpdatedOn
| Date
| Latest date when the code coverage was created for the project. |
CodeQualityDegradation
Represents a code quality degradation on the pipeline.
Fields
Name | Type | Description |
---|---|---|
description
| String!
| A description of the code quality degradation. |
fingerprint
| String!
| A unique fingerprint to identify the code quality degradation. For example, an MD5 hash. |
line
| Int!
| The line on which the code quality degradation occurred. |
path
| String!
| The relative path to the file containing the code quality degradation. |
severity
| CodeQualityDegradationSeverity!
| Status of the degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO). |
Commit
Fields
Name | Type | Description |
---|---|---|
author
| UserCore
| Author of the commit. |
authorGravatar
| String
| Commit authors gravatar. |
authorName
| String
| Commit authors name. |
authoredDate
| Time
| Timestamp of when the commit was authored. |
description
| String
| Description of the commit message. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
id
| ID!
| ID (global ID) of the commit. |
message
| String
| Raw commit message. |
sha
| String!
| SHA1 ID of the commit. |
shortId
| String!
| Short SHA1 ID of the commit. |
signatureHtml
| String
| Rendered HTML of the commit signature. |
title
| String
| Title of the commit message. |
titleHtml
| String
| The GitLab 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
Name | Type | Description |
---|---|---|
ref
| String
| Filter pipelines by the ref they are run for. |
sha
| String
| Filter pipelines by the sha of the commit they are run for. |
status
| PipelineStatusEnum
| Filter pipelines by their status. |
ComplianceFramework
Represents a ComplianceFramework associated with a Project.
Fields
Name | Type | Description |
---|---|---|
color
| String!
| Hexadecimal representation of compliance framework’s label color. |
description
| String!
| Description of the compliance framework. |
id
| ID!
| Compliance framework ID. |
name
| String!
| Name of the compliance framework. |
pipelineConfigurationFullPath
| String
| Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa .
|
ComposerMetadata
Composer metadata.
Fields
Name | Type | Description |
---|---|---|
composerJson
| PackageComposerJsonType!
| Data of the Composer JSON file. |
targetSha
| String!
| Target SHA of the package. |
ConanFileMetadata
Conan file metadata.
Fields
Name | Type | Description |
---|---|---|
conanFileType
| ConanMetadatumFileTypeEnum!
| Type of the Conan file. |
conanPackageReference
| String
| Reference of the Conan package. |
createdAt
| Time!
| Date of creation. |
id
| PackagesConanFileMetadatumID!
| ID of the metadatum. |
packageRevision
| String
| Revision of the package. |
recipeRevision
| String!
| Revision of the Conan recipe. |
updatedAt
| Time!
| Date of most recent update. |
ConanMetadata
Conan metadata.
Fields
Name | Type | Description |
---|---|---|
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. |
ContainerExpirationPolicy
A tag expiration policy designed to keep only the images that matter most.
Fields
Name | Type | Description |
---|---|---|
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
| ContainerExpirationPolicyKeepEnum
| Number of tags to retain. |
nameRegex
| UntrustedRegexp
| Tags with names matching this regex pattern will expire. |
nameRegexKeep
| UntrustedRegexp
| Tags with names matching this regex pattern will be preserved. |
nextRunAt
| Time
| Next time that this container expiration policy will get executed. |
olderThan
| ContainerExpirationPolicyOlderThanEnum
| Tags older that this will expire. |
updatedAt
| Time!
| Timestamp of when the container expiration policy was updated. |
ContainerRepository
A container repository.
Fields
Name | Type | Description |
---|---|---|
canDelete
| Boolean!
| Can the current user delete the container repository. |
createdAt
| Time!
| Timestamp when the container repository was created. |
expirationPolicyCleanupStatus
| ContainerRepositoryCleanupStatus
| The tags cleanup status for the container repository. |
expirationPolicyStartedAt
| Time
| Timestamp when the cleanup done by the expiration policy was started on the container repository. |
id
| ID!
| ID of the container repository. |
location
| String!
| URL 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
| ContainerRepositoryStatus
| Status 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
Name | Type | Description |
---|---|---|
canDelete
| Boolean!
| Can the current user delete the container repository. |
createdAt
| Time!
| Timestamp when the container repository was created. |
expirationPolicyCleanupStatus
| ContainerRepositoryCleanupStatus
| The tags cleanup status for the container repository. |
expirationPolicyStartedAt
| Time
| Timestamp when the cleanup done by the expiration policy was started on the container repository. |
id
| ID!
| ID of the container repository. |
location
| String!
| URL 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
| ContainerRepositoryStatus
| Status of the container repository. |
tags
| ContainerRepositoryTagConnection
| Tags of the container repository. (see Connections) |
tagsCount
| Int!
| Number of tags associated with this image. |
updatedAt
| Time!
| Timestamp when the container repository was updated. |
ContainerRepositoryTag
A tag from a container repository.
Fields
Name | Type | Description |
---|---|---|
canDelete
| Boolean!
| Can the current user delete this tag. |
createdAt
| Time
| Timestamp when the tag was created. |
digest
| String
| Digest of the tag. |
location
| String!
| URL of the tag. |
name
| String!
| Name of the tag. |
path
| String!
| Path of the tag. |
revision
| String
| Revision of the tag. |
shortRevision
| String
| Short revision of the tag. |
totalSize
| BigInt
| The size of the tag. |
CurrentLicense
Represents the current license.
Fields
Name | Type | Description |
---|---|---|
activatedAt
| Date
| Date when the license was activated. |
billableUsersCount
| Int
| Number of billable users on the system. |
blockChangesAt
| Date
| Date, including grace period, when licensed features will be blocked. |
company
| String
| Company of the licensee. |
email
| String
| Email of the licensee. |
expiresAt
| Date
| Date when the license expires. |
id
| ID!
| ID of the license. |
lastSync
| Time
| Date when the license was last synced. |
maximumUserCount
| Int
| Highest number of billable users on the system during the term of the current license. |
name
| String
| Name of the licensee. |
plan
| String!
| Name of the subscription plan. |
startsAt
| Date
| Date when the license started. |
type
| String!
| Type of the license. |
usersInLicenseCount
| Int
| Number of paid users in the license. |
usersOverLicenseCount
| Int
| Number of users over the paid users in the license. |
CustomEmoji
A custom emoji uploaded by user.
Fields
Name | Type | Description |
---|---|---|
external
| Boolean!
| Whether the emoji is an external link. |
id
| CustomEmojiID!
| The ID of the emoji. |
name
| String!
| The name of the emoji. |
url
| String!
| The link to file of the emoji. |
DastProfile
Represents a DAST Profile.
Fields
Name | Type | Description |
---|---|---|
branch
| DastProfileBranch
| The associated branch. |
dastScannerProfile
| DastScannerProfile
| The associated scanner profile. |
dastSiteProfile
| DastSiteProfile
| The associated site profile. |
description
| String
| The description of the scan. |
editPath
| String
| Relative web path to the edit page of a profile. |
id
| DastProfileID!
| ID of the profile. |
name
| String
| The name of the profile. |
DastProfileBranch
Represents a DAST Profile Branch.
Fields
Name | Type | Description |
---|---|---|
exists
| Boolean
| Indicates whether or not the branch exists. |
name
| String
| The name of the branch. |
DastScannerProfile
Represents a DAST scanner profile.
Fields
Name | Type | Description |
---|---|---|
editPath
| String
| Relative web path to the edit page of a scanner profile. |
id
| DastScannerProfileID!
| ID of the DAST scanner profile. |
profileName
| String
| Name of the DAST scanner profile. |
referencedInSecurityPolicies
| [String!]
| List of security policy names that are referencing given project. |
scanType
| DastScanTypeEnum
| Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. |
showDebugMessages
| Boolean!
| Indicates if debug messages should be included in DAST console output. True to include the debug messages. |
spiderTimeout
| Int
| The maximum number of minutes allowed for the spider to traverse the site. |
targetTimeout
| Int
| The maximum number of seconds allowed for the site under test to respond to a request. |
useAjaxSpider
| Boolean!
| Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. |
DastSiteProfile
Represents a DAST Site Profile.
Fields
Name | Type | Description |
---|---|---|
auth
| DastSiteProfileAuth
| Target authentication details. |
editPath
| String
| Relative web path to the edit page of a site profile. |
excludedUrls
| [String!]
| The URLs to skip during an authenticated scan. |
id
| DastSiteProfileID!
| ID of the site profile. |
normalizedTargetUrl
| String
| Normalized URL of the target to be scanned. |
profileName
| String
| The name of the site profile. |
referencedInSecurityPolicies
| [String!]
| List of security policy names that are referencing given project. |
requestHeaders
| String
| Comma-separated list of request header names and values to be added to every request made by DAST. |
targetType
| DastTargetTypeEnum
| The type of target to be scanned. |
targetUrl
| String
| The URL of the target to be scanned. |
userPermissions
| DastSiteProfilePermissions!
| Permissions for the current user on the resource. |
validationStatus
| DastSiteProfileValidationStatusEnum
| The current validation status of the site profile. |
DastSiteProfileAuth
Input type for DastSiteProfile authentication.
Fields
Name | Type | Description |
---|---|---|
enabled
| Boolean
| Indicates whether authentication is enabled. |
password
| String
| Redacted password to authenticate with on the target website. |
passwordField
| String
| The name of password field at the sign-in HTML form. |
url
| String
| The URL of the page containing the sign-in HTML form on the target website. |
username
| String
| The username to authenticate with on the target website. |
usernameField
| String
| The name of username field at the sign-in HTML form. |
DastSiteProfilePermissions
Check permissions for the current user on site profile.
Fields
Name | Type | Description |
---|---|---|
createOnDemandDastScan
| Boolean!
| Indicates the user can perform create_on_demand_dast_scan on this resource.
|
DastSiteValidation
Represents a DAST Site Validation.
Fields
Name | Type | Description |
---|---|---|
id
| DastSiteValidationID!
| Global ID of the site validation. |
normalizedTargetUrl
| String
| Normalized URL of the target to be validated. |
status
| DastSiteProfileValidationStatusEnum!
| Status of the site validation. |
DeleteJobsResponse
The response from the AdminSidekiqQueuesDeleteJobs mutation.
Fields
Name | Type | Description |
---|---|---|
completed
| Boolean
| Whether or not the entire queue was processed in time; if not, retrying the same request is safe. |
deletedJobs
| Int
| The number of matching jobs deleted. |
queueSize
| Int
| The queue size after processing. |
Design
A single design.
Fields
Name | Type | Description |
---|---|---|
diffRefs
| DiffRefs!
| The 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!
| The filename of the design. |
fullPath
| String!
| The full path to the design file. |
id
| ID!
| The ID of this design. |
image
| String!
| The URL of the full-sized image. |
imageV432x230
| String
| The 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!
| The issue the design belongs to. |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
notesCount
| Int!
| The total count of user-created notes for this design. |
project
| Project!
| The project the design belongs to. |
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
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State 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
Name | Type | Description |
---|---|---|
earlierOrEqualToId
| DesignManagementVersionID
| The Global ID of the most recent acceptable version. |
earlierOrEqualToSha
| String
| The SHA256 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
Name | Type | Description |
---|---|---|
design
| Design!
| The underlying design. |
diffRefs
| DiffRefs!
| The diff refs for this design. |
event
| DesignVersionEvent!
| How this design was changed in the current version. |
filename
| String!
| The filename of the design. |
fullPath
| String!
| The full path to the design file. |
id
| ID!
| The ID of this design. |
image
| String!
| The URL of the full-sized image. |
imageV432x230
| String
| The 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!
| The issue the design belongs to. |
notesCount
| Int!
| The total count of user-created notes for this design. |
project
| Project!
| The project the design belongs to. |
version
| DesignVersion!
| The version this design-at-versions is pinned to. |
DesignCollection
A collection of designs.
Fields
Name | Type | Description |
---|---|---|
copyState
| DesignCollectionCopyState
| Copy 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
Name | Type | Description |
---|---|---|
filename
| String
| Find a design by its filename. |
id
| DesignManagementDesignID
| Find a design by its ID. |
DesignCollection.designAtVersion
Find a design as of a version.
Returns DesignAtVersion
.
Arguments
Name | Type | Description |
---|---|---|
id
| DesignManagementDesignAtVersionID!
| The 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
Name | Type | Description |
---|---|---|
atVersion
| DesignManagementVersionID
| Filters 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
Name | Type | Description |
---|---|---|
id
| DesignManagementVersionID
| The Global ID of the version. |
sha
| String
| The SHA256 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
Name | Type | Description |
---|---|---|
earlierOrEqualToId
| DesignManagementVersionID
| The Global ID of the most recent acceptable version. |
earlierOrEqualToSha
| String
| The SHA256 of the most recent acceptable version. |
DesignManagement
Fields with arguments
DesignManagement.designAtVersion
Find a design as of a version.
Returns DesignAtVersion
.
Arguments
Name | Type | Description |
---|---|---|
id
| DesignManagementDesignAtVersionID!
| The Global ID of the design at this version. |
DesignManagement.version
Find a version.
Returns DesignVersion
.
Arguments
Name | Type | Description |
---|---|---|
id
| DesignManagementVersionID!
| The Global ID of the version. |
DesignVersion
A specific version in which designs were added, modified or deleted.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
designId
| DesignManagementDesignID
| The ID of a specific design. |
filename
| String
| The filename of a specific design. |
id
| DesignManagementDesignAtVersionID
| The ID 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
Name | Type | Description |
---|---|---|
filenames
| [String!]
| Filters designs by their filename. |
ids
| [DesignManagementDesignID!]
| Filters designs by their ID. |
DetailedStatus
Fields
Name | Type | Description |
---|---|---|
action
| StatusAction
| Action information for the status. This includes method, button title, icon, path, and title. |
detailsPath
| String
| Path of the details for the status. |
favicon
| String
| Favicon of the status. |
group
| String
| Group of the status. |
hasDetails
| Boolean
| Indicates if the status has further details. |
icon
| String
| Icon of the status. |
label
| String
| Label of the status. |
text
| String
| Text of the status. |
tooltip
| String
| Tooltip associated with the status. |
DevopsAdoptionEnabledNamespace
Enabled namespace for DevopsAdoption.
Fields
Name | Type | Description |
---|---|---|
displayNamespace
| Namespace
| Namespace where data should be displayed. |
id
| ID!
| ID of the enabled namespace. |
latestSnapshot
| DevopsAdoptionSnapshot
| Metrics snapshot for previous month for the enabled namespace. |
namespace
| Namespace
| Namespace 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
Name | Type | Description |
---|---|---|
endTimeAfter
| Time
| Filter to snapshots with month end after the provided date. |
endTimeBefore
| Time
| Filter to snapshots with month end before the provided date. |
DevopsAdoptionSnapshot
Snapshot.
Fields
Name | Type | Description |
---|---|---|
codeOwnersUsedCount
| Int
| Total number of projects with existing CODEOWNERS file. |
dastEnabledCount
| Int
| Total number of projects with enabled DAST. |
deploySucceeded
| Boolean!
| At least one deployment succeeded. |
endTime
| Time!
| The 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!
| The time the snapshot was recorded. |
runnerConfigured
| Boolean!
| At least one runner was used. |
sastEnabledCount
| Int
| Total number of projects with enabled SAST. |
securityScanSucceeded
| Boolean!
| At least one security scan succeeded. |
startTime
| Time!
| The start time for the snapshot where the data points were collected. |
totalProjectsCount
| Int
| Total number of projects. |
DiffPosition
Fields
Name | Type | Description |
---|---|---|
diffRefs
| DiffRefs!
| Information about the branch, HEAD, and base at the time of commenting. |
filePath
| String!
| Path of the file that was changed. |
height
| Int
| Total height of the image. |
newLine
| Int
| Line on HEAD SHA that was changed. |
newPath
| String
| Path of the file on the HEAD SHA. |
oldLine
| Int
| Line on start SHA that was changed. |
oldPath
| String
| Path of the file on the start SHA. |
positionType
| DiffPositionType!
| Type of file the position refers to. |
width
| Int
| Total width of the image. |
x
| Int
| X position of the note. |
y
| Int
| Y position of the note. |
DiffRefs
Fields
Name | Type | Description |
---|---|---|
baseSha
| String
| Merge 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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp of the discussion’s creation. |
id
| DiscussionID!
| ID of this discussion. |
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
| Time
| Timestamp of when the object was resolved. |
resolvedBy
| UserCore
| User who resolved the object. |
Environment
Describes where code is deployed for a project.
Fields
Name | Type | Description |
---|---|---|
id
| ID!
| ID of the environment. |
latestOpenedMostSevereAlert
| AlertManagementAlert
| The most 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!
| The path to the environment. |
state
| String!
| State of the environment, for example: available/stopped. |
Fields with arguments
Environment.metricsDashboard
Metrics dashboard schema for the environment.
Returns MetricsDashboard
.
Arguments
Name | Type | Description |
---|---|---|
path
| String!
| Path to a file which defines a metrics dashboard eg: "config/prometheus/common_metrics.yml" .
|
Epic
Represents an epic.
Fields
Name | Type | Description |
---|---|---|
author
| UserCore!
| Author of the epic. |
awardEmoji
| AwardEmojiConnection
| A list of award emojis associated with the epic. (see Connections) |
closedAt
| Time
| Timestamp of when the epic was closed. |
confidential
| Boolean
| Indicates if the epic is confidential. |
createdAt
| Time
| Timestamp of when the epic was created. |
descendantCounts
| EpicDescendantCount
| Number of open and closed descendant epics and issues. |
descendantWeightSum
| EpicDescendantWeights
| Total weight of open and closed issues in the epic and its descendants. |
description
| String
| Description of the epic. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
downvotes
| Int!
| Number of downvotes the epic has received. |
dueDate
| Time
| Due date of the epic. |
dueDateFixed
| Time
| Fixed due date of the epic. |
dueDateFromMilestones
| Time
| Inherited due date of the epic from milestones. |
dueDateIsFixed
| Boolean
| Indicates if the due date has been manually set. |
events
| EventConnection
| A list 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
| EpicHealthStatus
| Current health status of the epic. |
id
| ID!
| ID of the epic. |
iid
| ID!
| Internal ID of the epic. |
issues
| EpicIssueConnection
| A list of issues associated with the epic. (see Connections) |
labels
| LabelConnection
| Labels assigned to the epic. (see Connections) |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
parent
| Epic
| Parent epic of the epic. |
participants
| UserCoreConnection
| List of participants for the epic. (see Connections) |
relationPath
| String
| URI path of the epic-issue relationship. |
relativePosition
| Int
| The relative position of the epic in the epic tree. |
startDate
| Time
| Start date of the epic. |
startDateFixed
| Time
| Fixed start date of the epic. |
startDateFromMilestones
| Time
| Inherited start date of the epic from milestones. |
startDateIsFixed
| Boolean
| Indicates 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. |
title
| String
| Title of the epic. |
titleHtml
| String
| The GitLab Flavored Markdown rendering of title .
|
updatedAt
| Time
| Timestamp 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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
iid
| ID
| IID of the epic, e.g., “1”. |
iidStartsWith
| String
| Filter epics by IID for autocomplete. |
iids
| [ID!]
| List of IIDs of epics, e.g., [1, 2] .
|
includeAncestorGroups
| Boolean
| Include epics from ancestor groups. |
includeDescendantGroups
| Boolean
| Include epics from descendant groups. |
labelName
| [String!]
| Filter epics by labels. |
milestoneTitle
| String
| Filter epics by milestone title, computed from epic’s issues. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedEpicFilterInput
| Negated epic arguments. |
search
| String
| Search query for epic title or description. |
sort
| EpicSort
| List epics by sort order. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
iid
| ID
| IID of the epic, e.g., “1”. |
iidStartsWith
| String
| Filter epics by IID for autocomplete. |
iids
| [ID!]
| List of IIDs of epics, e.g., [1, 2] .
|
includeAncestorGroups
| Boolean
| Include epics from ancestor groups. |
includeDescendantGroups
| Boolean
| Include epics from descendant groups. |
labelName
| [String!]
| Filter epics by labels. |
milestoneTitle
| String
| Filter epics by milestone title, computed from epic’s issues. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedEpicFilterInput
| Negated epic arguments. |
search
| String
| Search query for epic title or description. |
sort
| EpicSort
| List epics by sort order. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
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
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
Epic.reference
Internal reference of the epic. Returned in shortened format by default.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
full
| Boolean
| Indicates if the reference should be returned in full. |
EpicBoard
Represents an epic board.
Fields
Name | Type | Description |
---|---|---|
hideBacklogList
| Boolean
| Whether or not backlog list is hidden. |
hideClosedList
| Boolean
| Whether or not closed list is hidden. |
id
| BoardsEpicBoardID!
| Global ID of the epic board. |
labels
| LabelConnection
| Labels of the board. (see Connections) |
name
| String
| Name 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
Name | Type | Description |
---|---|---|
epicFilters
| EpicFilters
| Filters applied when getting epic metadata in the epic board list. |
id
| BoardsEpicListID
| Find an epic board list by ID. |
EpicDescendantCount
Counts of descendent epics.
Fields
Name | Type | Description |
---|---|---|
closedEpics
| Int
| Number of closed child epics. |
closedIssues
| Int
| Number of closed epic issues. |
openedEpics
| Int
| Number of opened child epics. |
openedIssues
| Int
| Number of opened epic issues. |
EpicDescendantWeights
Total weight of open and closed descendant issues.
Fields
Name | Type | Description |
---|---|---|
closedIssues
| Int
| Total weight of completed (closed) issues in this epic, including epic descendants. |
openedIssues
| Int
| Total weight of opened issues in this epic, including epic descendants. |
EpicHealthStatus
Health status of child issues.
Fields
Name | Type | Description |
---|---|---|
issuesAtRisk
| Int
| Number of issues at risk. |
issuesNeedingAttention
| Int
| Number of issues that need attention. |
issuesOnTrack
| Int
| Number of issues on track. |
EpicIssue
Relationship between an epic and an issue.
Fields
Name | Type | Description |
---|---|---|
alertManagementAlert
| AlertManagementAlert
| Alert associated to this issue. |
assignees
| UserCoreConnection
| Assignees of the issue. (see Connections) |
author
| UserCore!
| User that created the issue. |
blocked
| Boolean!
| Indicates the issue is blocked. |
blockedByCount
| Int
| Count of issues blocking this issue. |
blockedByIssues
| IssueConnection
| Issues blocking this issue. (see Connections) |
closedAt
| Time
| Timestamp of when the issue was closed. |
confidential
| Boolean!
| Indicates the issue is confidential. |
createNoteEmail
| String
| User specific email address for the issue. |
createdAt
| Time!
| Timestamp of when the issue was created. |
description
| String
| Description of the issue. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
designCollection
| DesignCollection
| Collection 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
| Time
| Due date of the issue. |
emailsDisabled
| Boolean!
| Indicates if a project has email notifications disabled: true if email notifications are disabled.
|
epic
| Epic
| Epic to which this issue belongs. |
epicIssueId
| ID!
| ID of the epic-issue relation. |
healthStatus
| HealthStatus
| Current health status. |
humanTimeEstimate
| String
| Human-readable time estimate of the issue. |
humanTotalTimeSpent
| String
| Human-readable total time reported as spent on the issue. |
id
| ID
| Global ID of the epic-issue relation. |
iid
| ID!
| Internal ID of the issue. |
iteration
| Iteration
| Iteration of the issue. |
labels
| LabelConnection
| Labels of the issue. (see Connections) |
metricImages
| [MetricImage!]
| Metric images associated to the issue. |
milestone
| Milestone
| Milestone of the issue. |
moved
| Boolean
| Indicates if issue got moved from other project. |
movedTo
| Issue
| Updated Issue after it got moved to another project. |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
participants
| UserCoreConnection
| List of participants in the issue. (see Connections) |
relationPath
| String
| URI path of the epic-issue relation. |
relativePosition
| Int
| Relative position of the issue (used for positioning in epic tree and issue boards). |
severity
| IssuableSeverity
| Severity level of the incident. |
slaDueAt
| Time
| Timestamp of when the issue SLA expires. |
state
| IssueState!
| State of the issue. |
statusPagePublishedIncident
| Boolean
| Indicates 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
| String
| The GitLab Flavored Markdown rendering of title .
|
totalTimeSpent
| Int!
| Total time reported as spent on the issue. |
type
| IssueType
| Type of the issue. |
updatedAt
| Time!
| Timestamp of when the issue was last updated. |
updatedBy
| UserCore
| User 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
| Int
| Weight of the issue. |
Fields with arguments
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
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
EpicIssue.reference
Internal reference of the issue. Returned in shortened format by default.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
full
| Boolean
| Boolean option specifying whether the reference should be returned in full. |
EpicList
Represents an epic board list.
Fields
Name | Type | Description |
---|---|---|
collapsed
| Boolean
| Indicates if this list is collapsed for this user. |
epicsCount
| Int
| Count of epics in the list. |
id
| BoardsEpicListID!
| Global ID of the board list. |
label
| Label
| Label of the list. |
listType
| String!
| Type of the list. |
position
| Int
| Position 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
Name | Type | Description |
---|---|---|
filters
| EpicFilters
| Filters applied when selecting epics in the board list. |
EpicPermissions
Check permissions for the current user on an epic.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
description
| String
| The description of the escalation policy. |
id
| IncidentManagementEscalationPolicyID
| ID of the escalation policy. |
name
| String
| The name of the escalation policy. |
rules
| [EscalationRuleType!]
| Steps of the escalation policy. |
EscalationRuleType
Represents an escalation rule for an escalation policy.
Fields
Name | Type | Description |
---|---|---|
elapsedTimeSeconds
| Int
| The time in seconds before the rule is activated. |
id
| IncidentManagementEscalationRuleID
| ID of the escalation policy. |
oncallSchedule
| IncidentManagementOncallSchedule
| The on-call schedule to notify. |
status
| EscalationRuleStatus
| The status required to prevent the rule from activating. |
Event
Representing an event.
Fields
Name | Type | Description |
---|---|---|
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. |
ExternalIssue
Represents an external issue.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp of when the issue was created. |
externalTracker
| String
| Type of external tracker. |
relativeReference
| String
| Relative reference of the issue in the external tracker. |
status
| String
| Status of the issue in the external tracker. |
title
| String
| Title of the issue in the external tracker. |
updatedAt
| Time
| Timestamp of when the issue was updated. |
webUrl
| String
| URL to the issue in the external tracker. |
GeoNode
Fields
Name | Type | Description |
---|---|---|
containerRepositoriesMaxCapacity
| Int
| The maximum concurrency of container repository sync for this secondary node. |
enabled
| Boolean
| Indicates whether this Geo node is enabled. |
filesMaxCapacity
| Int
| The maximum concurrency of LFS/attachment backfill for this secondary node. |
id
| ID!
| ID of this GeoNode. |
internalUrl
| String
| The URL defined on the primary node that secondary nodes should use to contact it. |
minimumReverificationInterval
| Int
| The interval (in days) in which the repository verification is valid. Once expired, it will be reverified. |
name
| String
| The unique identifier for this Geo node. |
primary
| Boolean
| Indicates whether this Geo node is the primary. |
reposMaxCapacity
| Int
| The maximum concurrency of repository backfill for this secondary node. |
selectiveSyncNamespaces
| NamespaceConnection
| The namespaces that should be synced, if selective_sync_type == namespaces . (see Connections)
|
selectiveSyncShards
| [String!]
| The repository storages whose projects should be synced, if selective_sync_type == shards .
|
selectiveSyncType
| String
| Indicates if syncing is limited to only specific groups, or shards. |
syncObjectStorage
| Boolean
| Indicates if this secondary node will replicate blobs in Object Storage. |
url
| String
| The user-facing URL for this Geo node. |
verificationMaxCapacity
| Int
| The maximum concurrency of repository verification for this secondary node. |
Fields with arguments
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
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
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
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
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
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
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
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
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
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
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
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
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
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
GrafanaIntegration
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
actualRepositorySizeLimit
| Float
| Size limit for repositories in the namespace in bytes. |
additionalPurchasedStorageSize
| Float
| Additional storage purchased for the root namespace in bytes. |
autoDevopsEnabled
| Boolean
| Indicates whether Auto DevOps is enabled for all projects within this group. |
avatarUrl
| String
| Avatar URL of the group. |
billableMembersCount
| Int
| The number of billable users in 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. |
customEmoji
| CustomEmojiConnection
| Custom emoji within this namespace. Available only when feature flag custom_emoji is enabled. (see Connections)
|
description
| String
| Description of the namespace. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
emailsDisabled
| Boolean
| Indicates if a group has email notifications disabled. |
epicBoards
| EpicBoardConnection
| Find epic boards. (see Connections) |
epicsEnabled
| Boolean
| Indicates if Epics are enabled for namespace. |
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
| Boolean
| Indicates if Large File Storage (LFS) is enabled for namespace. |
mentionsDisabled
| Boolean
| Indicates if a group is disabled from getting mentioned. |
name
| String!
| Name of the namespace. |
packageSettings
| PackageSettings
| The package settings for the namespace. |
parent
| Group
| Parent group. |
path
| String!
| Path of the namespace. |
projectCreationLevel
| String
| The permission level required to create projects in the group. |
repositorySizeExcessProjectCount
| Int!
| Number of projects in the root namespace where the repository size exceeds the limit. |
requestAccessEnabled
| Boolean
| Indicates if users can request access to namespace. |
requireTwoFactorAuthentication
| Boolean
| Indicates if all users in this group are required to set up two-factor authentication. |
rootStorageStatistics
| RootStorageStatistics
| Aggregated storage statistics of the namespace. Only available for root namespaces. |
shareWithGroupLock
| Boolean
| Indicates if sharing a project with another group within this group is prevented. |
stats
| GroupStats
| Group statistics. |
storageSizeLimit
| Float
| Total storage limit of the root namespace in bytes. |
subgroupCreationLevel
| String
| The permission level required to create subgroups within the group. |
temporaryStorageIncreaseEndsOn
| Time
| Date until the temporary storage increase is active. |
totalRepositorySize
| Float
| Total repository size of all projects in the root namespace in bytes. |
totalRepositorySizeExcess
| Float
| Total excess repository size of all projects in the root namespace in bytes. |
twoFactorGracePeriod
| Int
| Time before two-factor authentication is enforced. |
userPermissions
| GroupPermissions!
| Permissions for the current user on the resource. |
visibility
| String
| Visibility of the namespace. |
vulnerabilityScanners
| VulnerabilityScannerConnection
| Vulnerability 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.board
A single board of the group.
Returns Board
.
Arguments
Name | Type | Description |
---|---|---|
id
| BoardID!
| The board’s ID. |
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
Name | Type | Description |
---|---|---|
id
| BoardID
| Find a board by its ID. |
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
id
| ComplianceManagementFrameworkID
| Global ID of a specific compliance framework to return. |
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
Name | Type | Description |
---|---|---|
name
| String
| Filter the container repositories by their name. |
sort
| ContainerRepositorySort
| Sort container repositories by this criteria. |
Group.epic
Find a single epic.
Returns Epic
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
iid
| ID
| IID of the epic, e.g., “1”. |
iidStartsWith
| String
| Filter epics by IID for autocomplete. |
iids
| [ID!]
| List of IIDs of epics, e.g., [1, 2] .
|
includeAncestorGroups
| Boolean
| Include epics from ancestor groups. |
includeDescendantGroups
| Boolean
| Include epics from descendant groups. |
labelName
| [String!]
| Filter epics by labels. |
milestoneTitle
| String
| Filter epics by milestone title, computed from epic’s issues. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedEpicFilterInput
| Negated epic arguments. |
search
| String
| Search query for epic title or description. |
sort
| EpicSort
| List epics by sort order. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
Group.epicBoard
Find a single epic board.
Returns EpicBoard
.
Arguments
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
iid
| ID
| IID of the epic, e.g., “1”. |
iidStartsWith
| String
| Filter epics by IID for autocomplete. |
iids
| [ID!]
| List of IIDs of epics, e.g., [1, 2] .
|
includeAncestorGroups
| Boolean
| Include epics from ancestor groups. |
includeDescendantGroups
| Boolean
| Include epics from descendant groups. |
labelName
| [String!]
| Filter epics by labels. |
milestoneTitle
| String
| Filter epics by milestone title, computed from epic’s issues. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedEpicFilterInput
| Negated epic arguments. |
search
| String
| Search query for epic title or description. |
sort
| EpicSort
| List epics by sort order. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
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
Name | Type | Description |
---|---|---|
relations
| [GroupMemberRelation!]
| Filter members by the given member relations. |
search
| String
| Search 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
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user assigned to the issues, “none” and “any” values are supported. |
assigneeUsername
| String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
epicId
| String
| ID of an epic associated with the issues, “none” and “any” values are supported. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
includeSubgroups
| Boolean
| Include issues belonging to subgroups. |
iterationId
| [ID]
| List of iteration Global IDs applied to the issue. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
not
| NegatedIssueFilterInput
| Negated arguments. |
search
| String
| Search query for issue title or description. |
sort
| IssueSort
| Sort issues by this criteria. |
state
| IssuableState
| Current state of this issue. |
types
| [IssueType!]
| Filter issues by the given issue types. |
updatedAfter
| Time
| Issues updated after this date. |
updatedBefore
| Time
| Issues updated before this date. |
weight
| String
| Weight applied to the issue, “none” and “any” values are supported. |
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
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the iteration cadence is active. |
automatic
| Boolean
| Whether the iteration cadence should automatically generate future iterations. |
durationInWeeks
| Int
| Duration in weeks of the iterations within this cadence. |
id
| IterationsCadenceID
| Global ID of the iteration cadence to look up. |
includeAncestorGroups
| Boolean
| Whether to include ancestor groups to search iterations cadences in. |
title
| String
| Fuzzy 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
Name | Type | Description |
---|---|---|
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
id
| ID
| Global ID of the Iteration to look up. |
iid
| ID
| Internal ID of the Iteration to look up. |
includeAncestors
| Boolean
| Whether to include ancestor iterations. Defaults to true. |
iterationCadenceIds
| [IterationsCadenceID!]
| Global iteration cadence IDs by which to look up the iterations. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| IterationState
| Filter iterations by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
title
| String
| Fuzzy search by title. |
Group.label
A label available on this group.
Returns Label
.
Arguments
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
includeAncestorGroups
| Boolean
| Include labels from ancestor groups. |
includeDescendantGroups
| Boolean
| Include labels from descendant groups. |
onlyGroupLabels
| Boolean
| Include only group level labels. |
searchTerm
| String
| A search term to find labels with. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
includeSubgroups
| Boolean
| Include merge requests belonging to subgroups. |
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
containingDate
| Time
| A date that the milestone contains. |
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
ids
| [ID!]
| Array of global milestone IDs, e.g., "gid://gitlab/Milestone/1" .
|
includeAncestors
| Boolean
| Include milestones from all parent groups. |
includeDescendants
| Boolean
| Include milestones from all subgroups and subprojects. |
searchTitle
| String
| A search string for the title. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| MilestoneStateEnum
| Filter milestones by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
title
| String
| The title of the milestone. |
Group.packages
Packages of the group.
Returns PackageConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
includeVersionless
| Boolean
| Include versionless packages. |
packageName
| String
| Search a package by name. |
packageType
| PackageTypeEnum
| Filter a package by type. |
sort
| PackageGroupSort
| Sort packages by this criteria. |
status
| PackageStatus
| Filter a package by status. |
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
Name | Type | Description |
---|---|---|
hasCodeCoverage
| Boolean
| Returns only the projects which have code coverage. |
hasVulnerabilities
| Boolean
| Returns only the projects which have vulnerabilities. |
ids
| [ID!]
| Filter projects by IDs. |
includeSubgroups
| Boolean
| Include also subgroup projects. |
search
| String
| Search project with most similar names or paths. |
sort
| NamespaceProjectSort
| Sort projects by this criteria. |
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
Name | Type | Description |
---|---|---|
endDate
| Time
| List time logs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List time-logs within a time range where the logged time is equal to or before endTime. |
startDate
| Time
| List time logs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List time-logs within a time range where the logged time is equal to or after startTime. |
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
Name | Type | Description |
---|---|---|
hasIssues
| Boolean
| Returns only the vulnerabilities which have linked issues. |
hasResolution
| Boolean
| Returns only the vulnerabilities which have been resolved on default branch. |
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by VulnerabilityScanner.externalId. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
sort
| VulnerabilitySort
| List vulnerabilities by sort order. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
Group.vulnerabilitiesCountByDay
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
includeSubgroups
| Boolean
| Include grades belonging to subgroups. |
Group.vulnerabilitySeveritiesCount
Counts for each vulnerability severity in the group and its subgroups.
Returns VulnerabilitySeveritiesCount
.
Arguments
Name | Type | Description |
---|---|---|
hasIssues
| Boolean
| Filter vulnerabilities that do or do not have issues. |
hasResolution
| Boolean
| Filter vulnerabilities that do or do not have a resolution. |
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. |
GroupMember
Represents a Group Membership.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| AccessLevel
| GitLab::Access level. |
createdAt
| Time
| Date and time the membership was created. |
createdBy
| UserCore
| User that authorized membership. |
expiresAt
| Time
| Date and time the membership expires. |
group
| Group
| Group that a User is a member of. |
id
| ID!
| ID of the member. |
updatedAt
| Time
| Date and time the membership was last updated. |
user
| UserCore
| User that is associated with the member object. |
userPermissions
| GroupPermissions!
| Permissions for the current user on the resource. |
GroupPermissions
Fields
Name | Type | Description |
---|---|---|
readGroup
| Boolean!
| Indicates the user can perform read_group on this resource.
|
GroupReleaseStats
Contains release-related statistics about a group.
Fields
Name | Type | Description |
---|---|---|
releasesCount
| Int
| Total number of releases in all descendant projects of the group. |
releasesPercentage
| Int
| Percentage of the group’s descendant projects that have at least one release. |
GroupStats
Contains statistics about a group.
Fields
Name | Type | Description |
---|---|---|
releaseStats
| GroupReleaseStats
| Statistics related to releases within the group. |
GroupWikiRepositoryRegistry
Represents the Geo sync and verification state of a group wiki repository.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the GroupWikiRepositoryRegistry was created. |
groupWikiRepositoryId
| ID!
| ID of the Group Wiki Repository. |
id
| ID!
| ID of the GroupWikiRepositoryRegistry. |
lastSyncFailure
| String
| Error message during sync of the GroupWikiRepositoryRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the GroupWikiRepositoryRegistry. |
retryAt
| Time
| Timestamp after which the GroupWikiRepositoryRegistry should be resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the GroupWikiRepositoryRegistry. |
state
| RegistryState
| Sync state of the GroupWikiRepositoryRegistry. |
IncidentManagementOncallRotation
Describes an incident management on-call rotation.
Fields
Name | Type | Description |
---|---|---|
activePeriod
| OncallRotationActivePeriodType
| Active period for the on-call rotation. |
endsAt
| Time
| End date and time of the on-call rotation. |
id
| IncidentManagementOncallRotationID!
| ID of the on-call rotation. |
length
| Int
| Length of the on-call schedule, in the units specified by lengthUnit. |
lengthUnit
| OncallRotationUnitEnum
| Unit of the on-call rotation length. |
name
| String!
| Name of the on-call rotation. |
participants
| OncallParticipantTypeConnection
| Participants of the on-call rotation. (see Connections) |
startsAt
| Time
| Start 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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
description
| String
| Description of the on-call schedule. |
iid
| ID!
| Internal ID of the on-call schedule. |
name
| String!
| Name of the on-call schedule. |
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
Name | Type | Description |
---|---|---|
id
| IncidentManagementOncallRotationID!
| ID of the on-call rotation. |
IncidentManagementOncallShift
A block of time for which a participant is on-call.
Fields
Name | Type | Description |
---|---|---|
endsAt
| Time
| End time of the on-call shift. |
participant
| OncallParticipantType
| Participant assigned to the on-call shift. |
startsAt
| Time
| Start time of the on-call shift. |
InstanceSecurityDashboard
Fields
Name | Type | Description |
---|---|---|
vulnerabilityGrades
| [VulnerableProjectsByGrade!]!
| Represents vulnerable project counts for each grade. |
vulnerabilityScanners
| VulnerabilityScannerConnection
| Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. (see Connections) |
Fields with arguments
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
Name | Type | Description |
---|---|---|
search
| String
| Search query for project name, path, or description. |
InstanceSecurityDashboard.vulnerabilitySeveritiesCount
Counts for each vulnerability severity from projects selected in Instance Security Dashboard.
Returns VulnerabilitySeveritiesCount
.
Arguments
Name | Type | Description |
---|---|---|
hasIssues
| Boolean
| Filter vulnerabilities that do or do not have issues. |
hasResolution
| Boolean
| Filter vulnerabilities that do or do not have a resolution. |
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. |
Issue
Fields
Name | Type | Description |
---|---|---|
alertManagementAlert
| AlertManagementAlert
| Alert associated to this issue. |
assignees
| UserCoreConnection
| Assignees of the issue. (see Connections) |
author
| UserCore!
| User that created the issue. |
blocked
| Boolean!
| Indicates the issue is blocked. |
blockedByCount
| Int
| Count of issues blocking this issue. |
blockedByIssues
| IssueConnection
| Issues blocking this issue. (see Connections) |
closedAt
| Time
| Timestamp of when the issue was closed. |
confidential
| Boolean!
| Indicates the issue is confidential. |
createNoteEmail
| String
| User specific email address for the issue. |
createdAt
| Time!
| Timestamp of when the issue was created. |
description
| String
| Description of the issue. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
designCollection
| DesignCollection
| Collection 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
| Time
| Due date of the issue. |
emailsDisabled
| Boolean!
| Indicates if a project has email notifications disabled: true if email notifications are disabled.
|
epic
| Epic
| Epic to which this issue belongs. |
healthStatus
| HealthStatus
| Current health status. |
humanTimeEstimate
| String
| Human-readable time estimate of the issue. |
humanTotalTimeSpent
| String
| Human-readable total time reported as spent on the issue. |
id
| ID!
| ID of the issue. |
iid
| ID!
| Internal ID of the issue. |
iteration
| Iteration
| Iteration of the issue. |
labels
| LabelConnection
| Labels of the issue. (see Connections) |
metricImages
| [MetricImage!]
| Metric images associated to the issue. |
milestone
| Milestone
| Milestone of the issue. |
moved
| Boolean
| Indicates if issue got moved from other project. |
movedTo
| Issue
| Updated Issue after it got moved to another project. |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
participants
| UserCoreConnection
| List of participants in the issue. (see Connections) |
relativePosition
| Int
| Relative position of the issue (used for positioning in epic tree and issue boards). |
severity
| IssuableSeverity
| Severity level of the incident. |
slaDueAt
| Time
| Timestamp of when the issue SLA expires. |
state
| IssueState!
| State of the issue. |
statusPagePublishedIncident
| Boolean
| Indicates 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
| String
| The GitLab Flavored Markdown rendering of title .
|
totalTimeSpent
| Int!
| Total time reported as spent on the issue. |
type
| IssueType
| Type of the issue. |
updatedAt
| Time!
| Timestamp of when the issue was last updated. |
updatedBy
| UserCore
| User 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
| Int
| Weight of the issue. |
Fields with arguments
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
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
Issue.reference
Internal reference of the issue. Returned in shortened format by default.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
full
| Boolean
| Boolean option specifying whether the reference should be returned in full. |
IssuePermissions
Check permissions for the current user on a issue.
Fields
Name | Type | Description |
---|---|---|
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.
|
updateIssue
| Boolean!
| Indicates the user can perform update_issue on this resource.
|
IssueStatusCountsType
Represents total number of issues for the represented statuses.
Fields
Name | Type | Description |
---|---|---|
all
| Int
| Number of issues with status ALL for the project. |
closed
| Int
| Number of issues with status CLOSED for the project. |
opened
| Int
| Number of issues with status OPENED for the project. |
Iteration
Represents an iteration object.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp of iteration creation. |
description
| String
| Description of the iteration. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
dueDate
| Time
| Timestamp of the iteration due date. |
id
| ID!
| ID of the iteration. |
iid
| ID!
| Internal ID of the iteration. |
iterationCadence
| IterationCadence!
| Cadence of the iteration. |
report
| TimeboxReport
| Historically accurate report about the timebox. |
scopedPath
| String
| Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. |
scopedUrl
| String
| Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. |
startDate
| Time
| Timestamp of the iteration start date. |
state
| IterationState!
| State of the iteration. |
title
| String!
| Title of the iteration. |
updatedAt
| Time!
| Timestamp of last iteration update. |
webPath
| String!
| Web path of the iteration. |
webUrl
| String!
| Web URL of the iteration. |
IterationCadence
Represents an iteration cadence.
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the iteration cadence is active. |
automatic
| Boolean
| Whether the iteration cadence should automatically generate future iterations. |
description
| String
| Description of the iteration cadence. Maximum length is 5000 characters. |
durationInWeeks
| Int
| Duration in weeks of the iterations within this cadence. |
id
| IterationsCadenceID!
| Global ID of the iteration cadence. |
iterationsInAdvance
| Int
| Future 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
| Time
| Timestamp of the iteration cadence start date. |
title
| String!
| Title of the iteration cadence. |
JiraImport
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp 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
| Time
| Timestamp of when the Jira import was scheduled. |
scheduledBy
| UserCore
| User that started the Jira import. |
totalIssueCount
| Int!
| Total count of issues that were attempted to import. |
JiraProject
Fields
Name | Type | Description |
---|---|---|
key
| String!
| Key of the Jira project. |
name
| String
| Name of the Jira project. |
projectId
| Int!
| ID of the Jira project. |
JiraService
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Indicates if the service is active. |
type
| String
| Class 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
Name | Type | Description |
---|---|---|
name
| String
| Project name or key. |
JiraUser
Fields
Name | Type | Description |
---|---|---|
gitlabId
| Int
| ID of the matched GitLab user. |
gitlabName
| String
| Name of the matched GitLab user. |
gitlabUsername
| String
| Username of the matched GitLab user. |
jiraAccountId
| String!
| Account ID of the Jira user. |
jiraDisplayName
| String!
| Display name of the Jira user. |
jiraEmail
| String
| Email of the Jira user, returned only for users with public emails. |
JobPermissions
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
enabled
| Boolean!
| Indicates whether the Kubernetes Agent Server is enabled. |
externalUrl
| String
| The URL used by the Agents to communicate with KAS. |
version
| String
| KAS version. |
Label
Fields
Name | Type | Description |
---|---|---|
color
| String!
| Background color of the label. |
createdAt
| Time!
| When this label was created. |
description
| String
| Description of the label (Markdown rendered as HTML for caching). |
descriptionHtml
| String
| The GitLab 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
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the LfsObjectRegistry was created. |
id
| ID!
| ID of the LfsObjectRegistry. |
lastSyncFailure
| String
| Error message during sync of the LfsObjectRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the LfsObjectRegistry. |
lfsObjectId
| ID!
| ID of the LFS object. |
retryAt
| Time
| Timestamp after which the LfsObjectRegistry should be resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the LfsObjectRegistry. |
state
| RegistryState
| Sync state of the LfsObjectRegistry. |
LicenseHistoryEntry
Represents an entry from the Cloud License history.
Fields
Name | Type | Description |
---|---|---|
activatedAt
| Date
| Date when the license was activated. |
blockChangesAt
| Date
| Date, including grace period, when licensed features will be blocked. |
company
| String
| Company of the licensee. |
email
| String
| Email of the licensee. |
expiresAt
| Date
| Date when the license expires. |
id
| ID!
| ID of the license. |
name
| String
| Name of the licensee. |
plan
| String!
| Name of the subscription plan. |
startsAt
| Date
| Date when the license started. |
type
| String!
| Type of the license. |
usersInLicenseCount
| Int
| Number of paid users in the license. |
MavenMetadata
Maven metadata.
Fields
Name | Type | Description |
---|---|---|
appGroup
| String!
| App group of the Maven package. |
appName
| String!
| App name of the Maven package. |
appVersion
| String
| App 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. |
MergeRequest
Fields
Name | Type | Description |
---|---|---|
allowCollaboration
| Boolean
| Indicates if members of the target project can push to the fork. |
approvalsLeft
| Int
| Number of approvals left. |
approvalsRequired
| Int
| Number of approvals required. |
approved
| Boolean!
| Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. |
approvedBy
| UserCoreConnection
| Users who approved the merge request. (see Connections) |
assignees
| MergeRequestAssigneeConnection
| Assignees of the merge request. (see Connections) |
author
| UserCore
| User who created this merge request. |
autoMergeEnabled
| Boolean!
| Indicates if auto merge is enabled for the merge request. |
autoMergeStrategy
| String
| Selected auto merge strategy. |
availableAutoMergeStrategies
| [String!]
| Array of available auto merge strategies. |
commitCount
| Int
| Number of commits in the merge request. |
commitsWithoutMergeCommits
| CommitConnection
| Merge request commits excluding merge commits. (see Connections) |
conflicts
| Boolean!
| Indicates if the merge request has conflicts. |
createdAt
| Time!
| Timestamp of when the merge request was created. |
defaultMergeCommitMessage
| String
| Default merge commit message of the merge request. |
defaultMergeCommitMessageWithDescription
| String
| Default merge commit message of the merge request with description. |
defaultSquashCommitMessage
| String
| Default squash commit message of the merge request. |
description
| String
| Description of the merge request (Markdown rendered as HTML for caching). |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
diffHeadSha
| String
| Diff head SHA of the merge request. |
diffRefs
| DiffRefs
| References of the base SHA, the head SHA, and the start SHA for this merge request. |
diffStatsSummary
| DiffStatsSummary
| Summary 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
| Boolean
| Indicates 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
| Pipeline
| The pipeline running on the branch HEAD of the merge request. |
humanTimeEstimate
| String
| Human-readable time estimate of the merge request. |
humanTotalTimeSpent
| String
| Human-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
| String
| Commit SHA of the merge request if merge is in progress. |
labels
| LabelConnection
| Labels of the merge request. (see Connections) |
mergeCommitSha
| String
| SHA of the merge request commit (set once merged). |
mergeError
| String
| Error message due to a merge error. |
mergeOngoing
| Boolean!
| Indicates if a merge is currently occurring. |
mergeStatus
| String
|
Deprecated in 14.0. This was renamed. Use: MergeRequest.mergeStatusEnum .
|
mergeStatusEnum
| MergeStatus
| Merge status of the merge request. |
mergeTrainsCount
| Int
| Number of merge requests in the merge train. |
mergeUser
| UserCore
| User who merged this merge request. |
mergeWhenPipelineSucceeds
| Boolean
| Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS). |
mergeable
| Boolean!
| Indicates if the merge request is mergeable. |
mergeableDiscussionsState
| Boolean
| Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged. |
mergedAt
| Time
| Timestamp of when the merge request was merged, null if not merged. |
milestone
| Milestone
| The milestone of the merge request. |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
participants
| UserCoreConnection
| Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. (see Connections) |
project
| Project!
| Alias for target_project. |
projectId
| Int!
| ID of the merge request project. |
rebaseCommitSha
| String
| Rebase commit SHA of the merge request. |
rebaseInProgress
| Boolean!
| Indicates if there is a rebase currently in progress for the merge request. |
reviewers
| MergeRequestReviewerConnection
| Users from whom a review has been requested. (see Connections) |
securityAutoFix
| Boolean
| Indicates 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
| Boolean
| Indicates 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
| Project
| Source project of the merge request. |
sourceProjectId
| Int
| ID of the merge request source project. |
squash
| Boolean!
| Indicates if squash on merge is enabled. |
squashOnMerge
| Boolean!
| Indicates if squash on merge is enabled. |
state
| MergeRequestState!
| State of the merge request. |
subscribed
| Boolean!
| Indicates if the currently logged in user is subscribed to this merge request. |
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
| String
| The GitLab 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
| Int
| Number of user discussions in the merge request. |
userNotesCount
| Int
| User notes count of the merge request. |
userPermissions
| MergeRequestPermissions!
| Permissions for the current user on the resource. |
webUrl
| String
| Web URL of the merge request. |
workInProgress
| Boolean!
|
Deprecated in 13.12. Use draft .
|
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
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
MergeRequest.diffStats
Details about which files were changed in this merge request.
Returns [DiffStats!]
.
Arguments
Name | Type | Description |
---|---|---|
path
| String
| A specific file-path. |
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
Name | Type | Description |
---|---|---|
ref
| String
| Filter pipelines by the ref they are run for. |
sha
| String
| Filter pipelines by the sha of the commit they are run for. |
status
| PipelineStatusEnum
| Filter pipelines by their status. |
MergeRequest.reference
Internal reference of the merge request. Returned in shortened format by default.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
full
| Boolean
| Boolean option specifying whether the reference should be returned in full. |
MergeRequestAssignee
A user assigned to a merge request.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
email
| String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
location
| String
| The location of the user. |
mergeRequestInteraction
| UserMergeRequestInteraction
| Details of this user’s interactions with the merge request. |
name
| String!
| Human-readable name of the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
publicEmail
| String
| User’s public email. |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| The type of snippet. |
visibility
| VisibilityScopesEnum
| The visibility 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
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
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
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| The action to be filtered. |
authorId
| [ID!]
| The ID of an author. |
groupId
| [ID!]
| The ID of a group. |
projectId
| [ID!]
| The ID of a project. |
state
| [TodoStateEnum!]
| The state of the todo. |
type
| [TodoTargetEnum!]
| The type of the todo. |
MergeRequestDiffRegistry
Represents the Geo sync and verification state of a Merge Request diff.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the MergeRequestDiffRegistry was created. |
id
| ID!
| ID of the MergeRequestDiffRegistry. |
lastSyncFailure
| String
| Error message during sync of the MergeRequestDiffRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the MergeRequestDiffRegistry. |
mergeRequestDiffId
| ID!
| ID of the Merge Request diff. |
retryAt
| Time
| Timestamp after which the MergeRequestDiffRegistry should be resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the MergeRequestDiffRegistry. |
state
| RegistryState
| Sync state of the MergeRequestDiffRegistry. |
MergeRequestPermissions
Check permissions for the current user on a merge request.
Fields
Name | Type | Description |
---|---|---|
adminMergeRequest
| Boolean!
| Indicates the user can perform admin_merge_request 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.
|
MergeRequestReviewer
A user assigned to a merge request as a reviewer.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
email
| String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
location
| String
| The location of the user. |
mergeRequestInteraction
| UserMergeRequestInteraction
| Details of this user’s interactions with the merge request. |
name
| String!
| Human-readable name of the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
publicEmail
| String
| User’s public email. |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| The type of snippet. |
visibility
| VisibilityScopesEnum
| The visibility 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
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
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
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| The action to be filtered. |
authorId
| [ID!]
| The ID of an author. |
groupId
| [ID!]
| The ID of a group. |
projectId
| [ID!]
| The ID of a project. |
state
| [TodoStateEnum!]
| The state of the todo. |
type
| [TodoTargetEnum!]
| The type of the todo. |
Metadata
Fields
Name | Type | Description |
---|---|---|
kas
| Kas!
| Metadata about KAS. |
revision
| String!
| Revision. |
version
| String!
| Version. |
MetricImage
Represents a metric image upload.
Fields
Name | Type | Description |
---|---|---|
fileName
| String
| File name of the metric image. |
filePath
| String
| File 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. |
MetricsDashboard
Fields
Name | Type | Description |
---|---|---|
path
| String
| Path to a file with the dashboard definition. |
schemaValidationWarnings
| [String!]
| Dashboard schema validation warnings. |
Fields with arguments
MetricsDashboard.annotations
Annotations added to the dashboard.
Returns MetricsDashboardAnnotationConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
from
| Time!
| Timestamp marking date and time from which annotations need to be fetched. |
to
| Time
| Timestamp marking date and time to which annotations need to be fetched. |
MetricsDashboardAnnotation
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the annotation. |
endingAt
| Time
| Timestamp marking end of annotated time span. |
id
| ID!
| ID of the annotation. |
panelId
| String
| ID of a dashboard panel to which the annotation should be scoped. |
startingAt
| Time
| Timestamp marking start of annotated time span. |
Milestone
Represents a milestone.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp of milestone creation. |
description
| String
| Description of the milestone. |
dueDate
| Time
| Timestamp of the milestone due date. |
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. |
report
| TimeboxReport
| Historically accurate report about the timebox. |
startDate
| Time
| Timestamp of the milestone start date. |
state
| MilestoneStateEnum!
| State of the milestone. |
stats
| MilestoneStats
| Milestone 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. |
MilestoneStats
Contains statistics about a milestone.
Fields
Name | Type | Description |
---|---|---|
closedIssuesCount
| Int
| Number of closed issues associated with the milestone. |
totalIssuesCount
| Int
| Total number of issues associated with the milestone. |
Namespace
Fields
Name | Type | Description |
---|---|---|
actualRepositorySizeLimit
| Float
| Size limit for repositories in the namespace in bytes. |
additionalPurchasedStorageSize
| Float
| Additional storage purchased for the root namespace in bytes. |
containsLockedProjects
| Boolean!
| Includes at least one project where the repository size exceeds the limit. |
description
| String
| Description of the namespace. |
descriptionHtml
| String
| The GitLab 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
| Boolean
| Indicates if Large File Storage (LFS) is enabled for namespace. |
name
| String!
| Name of the namespace. |
packageSettings
| PackageSettings
| The package 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. |
requestAccessEnabled
| Boolean
| Indicates if users can request access to namespace. |
rootStorageStatistics
| RootStorageStatistics
| Aggregated storage statistics of the namespace. Only available for root namespaces. |
storageSizeLimit
| Float
| Total storage limit of the root namespace in bytes. |
temporaryStorageIncreaseEndsOn
| Time
| Date until the temporary storage increase is active. |
totalRepositorySize
| Float
| Total repository size of all projects in the root namespace in bytes. |
totalRepositorySizeExcess
| Float
| Total excess repository size of all projects in the root namespace in bytes. |
visibility
| String
| Visibility of the namespace. |
Fields with arguments
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
Name | Type | Description |
---|---|---|
id
| ComplianceManagementFrameworkID
| Global 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
Name | Type | Description |
---|---|---|
hasCodeCoverage
| Boolean
| Returns only the projects which have code coverage. |
hasVulnerabilities
| Boolean
| Returns only the projects which have vulnerabilities. |
ids
| [ID!]
| Filter projects by IDs. |
includeSubgroups
| Boolean
| Include also subgroup projects. |
search
| String
| Search project with most similar names or paths. |
sort
| NamespaceProjectSort
| Sort projects by this criteria. |
NetworkPolicy
Represents the network policy.
Fields
Name | Type | Description |
---|---|---|
enabled
| Boolean!
| Indicates whether this policy is enabled. |
fromAutoDevops
| Boolean!
| Indicates whether this policy is created from AutoDevops. |
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
Name | Type | Description |
---|---|---|
author
| UserCore!
| User who wrote this note. |
body
| String!
| Content of the note. |
bodyHtml
| String
| The GitLab Flavored Markdown rendering of note .
|
confidential
| Boolean
| Indicates if this note is confidential. |
createdAt
| Time!
| Timestamp of the note creation. |
discussion
| Discussion
| The discussion this note is a part of. |
id
| NoteID!
| ID of the note. |
position
| DiffPosition
| The position of this note on a diff. |
project
| Project
| Project associated with the note. |
resolvable
| Boolean!
| Indicates if the object can be resolved. |
resolved
| Boolean!
| Indicates if the object is resolved. |
resolvedAt
| Time
| Timestamp of when the object was resolved. |
resolvedBy
| UserCore
| User who resolved the object. |
system
| Boolean!
| Indicates whether this note was created by the system or by a user. |
systemNoteIconName
| String
| Name of the icon corresponding to a system note. |
updatedAt
| Time!
| Timestamp of the note’s last activity. |
url
| String
| URL to view this Note in the Web UI. |
userPermissions
| NotePermissions!
| Permissions for the current user on the resource. |
NotePermissions
Fields
Name | Type | Description |
---|---|---|
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.
|
NugetMetadata
Nuget metadata.
Fields
Name | Type | Description |
---|---|---|
iconUrl
| String!
| Icon URL of the Nuget package. |
id
| PackagesNugetMetadatumID!
| ID of the metadatum. |
licenseUrl
| String!
| License URL of the Nuget package. |
projectUrl
| String!
| Project URL of the Nuget package. |
OncallParticipantType
The rotation participant and color palette.
Fields
Name | Type | Description |
---|---|---|
colorPalette
| String
| The color palette to assign to the on-call user. For example “blue”. |
colorWeight
| String
| The color 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!
| The user who is participating. |
OncallRotationActivePeriodType
Active period time range for on-call rotation.
Fields
Name | Type | Description |
---|---|---|
endTime
| String
| The end of the rotation active period. |
startTime
| String
| The start of the rotation active period. |
Package
Represents a package in the Package Registry. Note that this type is in beta and susceptible to changes.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Date of creation. |
id
| PackagesPackageID!
| ID of the package. |
metadata
| PackageMetadata
| Package metadata. |
name
| String!
| Name of the package. |
packageType
| PackageTypeEnum!
| Package type. |
pipelines
| PipelineConnection
| Pipelines that built the package. (see Connections) |
project
| Project!
| Project where the package is stored. |
status
| PackageStatus!
| Package status. |
tags
| PackageTagConnection
| Package tags. (see Connections) |
updatedAt
| Time!
| Date of most recent update. |
version
| String
| Version string. |
versions
| PackageConnection
| Deprecated in 13.11. This field is now only returned in the PackageDetailsType. |
PackageComposerJsonType
Represents a composer JSON file.
Fields
Name | Type | Description |
---|---|---|
license
| String
| The license set in the Composer JSON file. |
name
| String
| The name set in the Composer JSON file. |
type
| String
| The type set in the Composer JSON file. |
version
| String
| The version set in the Composer JSON file. |
PackageDetailsType
Represents a package details in the Package Registry. Note that this type is in beta and susceptible to changes.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Date of creation. |
id
| PackagesPackageID!
| ID of the package. |
metadata
| PackageMetadata
| Package metadata. |
name
| String!
| Name of the package. |
packageFiles
| PackageFileConnection
| Package files. (see Connections) |
packageType
| PackageTypeEnum!
| Package type. |
pipelines
| PipelineConnection
| Pipelines that built the package. (see Connections) |
project
| Project!
| Project where the package is stored. |
status
| PackageStatus!
| Package status. |
tags
| PackageTagConnection
| Package tags. (see Connections) |
updatedAt
| Time!
| Date of most recent update. |
version
| String
| Version string. |
versions
| PackageConnection
| The other versions of the package. (see Connections) |
PackageFile
Represents a package file.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| The created date. |
downloadPath
| String!
| Download path of the package file. |
fileMd5
| String
| Md5 of the package file. |
fileMetadata
| PackageFileMetadata
| File metadata. |
fileName
| String!
| Name of the package file. |
fileSha1
| String
| Sha1 of the package file. |
fileSha256
| String
| Sha256 of the package file. |
id
| PackagesPackageFileID!
| ID of the file. |
size
| String!
| Size of the package file. |
updatedAt
| Time!
| The updated date. |
PackageFileRegistry
Represents the Geo sync and verification state of a package file.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the PackageFileRegistry was created. |
id
| ID!
| ID of the PackageFileRegistry. |
lastSyncFailure
| String
| Error message during sync of the PackageFileRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the PackageFileRegistry. |
packageFileId
| ID!
| ID of the PackageFile. |
retryAt
| Time
| Timestamp after which the PackageFileRegistry should be resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the PackageFileRegistry. |
state
| RegistryState
| Sync state of the PackageFileRegistry. |
PackageSettings
Namespace-level Package Registry settings.
Fields
Name | Type | Description |
---|---|---|
genericDuplicateExceptionRegex
| UntrustedRegexp
| When 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. |
mavenDuplicateExceptionRegex
| UntrustedRegexp
| When 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. |
PackageTag
Represents a package tag.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| The created date. |
id
| ID!
| The ID of the tag. |
name
| String!
| The name of the tag. |
updatedAt
| Time!
| The updated date. |
PageInfo
Information about pagination in a connection.
Fields
Name | Type | Description |
---|---|---|
endCursor
| String
| When 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
| String
| When paginating backwards, the cursor to continue. |
PathLock
Represents a file or directory in the project repository that has been locked.
Fields
Name | Type | Description |
---|---|---|
id
| PathLockID!
| ID of the path lock. |
path
| String
| The locked path. |
user
| UserCore
| The user that has locked this path. |
Pipeline
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| Indicates if the pipeline is active. |
beforeSha
| String
| Base SHA of the source branch. |
cancelable
| Boolean!
| Specifies if a pipeline can be canceled. |
codeQualityReports
| CodeQualityDegradationConnection
| Code Quality degradations reported on the pipeline. (see Connections) |
commitPath
| String
| Path to the commit that triggered the pipeline. |
committedAt
| Time
| Timestamp of the pipeline’s commit. |
complete
| Boolean!
| Indicates if a pipeline is complete. |
configSource
| PipelineConfigSourceEnum
| Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE). |
coverage
| Float
| Coverage percentage. |
createdAt
| Time!
| Timestamp of the pipeline’s creation. |
detailedStatus
| DetailedStatus!
| Detailed status of the pipeline. |
downstream
| PipelineConnection
| Pipelines this pipeline will trigger. (see Connections) |
duration
| Int
| Duration of the pipeline in seconds. |
finishedAt
| Time
| Timestamp of the pipeline’s completion. |
id
| ID!
| ID of the pipeline. |
iid
| String!
| Internal ID of the pipeline. |
path
| String
| Relative path to the pipeline’s page. |
project
| Project
| Project the pipeline belongs to. |
queuedDuration
| Duration
| How long the pipeline was queued before starting. |
retryable
| Boolean!
| Specifies if a pipeline can be retried. |
securityReportSummary
| SecurityReportSummary
| Vulnerability and scanned resource counts for each security scanner of the pipeline. |
sha
| String!
| SHA of the pipeline’s commit. |
sourceJob
| CiJob
| Job where pipeline was triggered from. |
stages
| CiStageConnection
| Stages of the pipeline. (see Connections) |
startedAt
| Time
| Timestamp 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
| Pipeline
| Pipeline that triggered the pipeline. |
user
| UserCore
| Pipeline user. |
userPermissions
| PipelinePermissions!
| Permissions for the current user on the resource. |
usesNeeds
| Boolean
| Indicates if the pipeline has jobs with needs dependencies.
|
warnings
| Boolean!
| Indicates if a pipeline has warnings. |
Fields with arguments
Pipeline.job
A specific job in this pipeline, either by name or ID.
Returns CiJob
.
Arguments
Name | Type | Description |
---|---|---|
id
| JobID
| ID of the job. |
name
| String
| Name 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
Name | Type | Description |
---|---|---|
securityReportTypes
| [SecurityReportTypeEnum!]
| Filter jobs by the type of security report they produce. |
statuses
| [CiJobStatus!]
| Filter jobs by status. |
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
Name | Type | Description |
---|---|---|
reportType
| [String!]
| Filter vulnerability findings by report type. |
scanner
| [String!]
| Filter vulnerability findings by Scanner.externalId. |
severity
| [String!]
| Filter vulnerability findings by severity. |
Pipeline.testSuite
A specific test suite in a pipeline test report.
Returns TestSuite
.
Arguments
Name | Type | Description |
---|---|---|
buildIds
| [ID!]!
| IDs of the builds used to run the test suite. |
PipelineAnalytics
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the PipelineArtifactRegistry was created. |
id
| ID!
| ID of the PipelineArtifactRegistry. |
lastSyncFailure
| String
| Error message during sync of the PipelineArtifactRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the PipelineArtifactRegistry. |
pipelineArtifactId
| ID!
| ID of the pipeline artifact. |
retryAt
| Time
| Timestamp after which the PipelineArtifactRegistry should be resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the PipelineArtifactRegistry. |
state
| RegistryState
| Sync state of the PipelineArtifactRegistry. |
PipelinePermissions
Fields
Name | Type | Description |
---|---|---|
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.
|
PipelineSecurityReportFinding
Represents vulnerability finding of a security report on the pipeline.
Fields
Name | Type | Description |
---|---|---|
confidence
| String
| Type of the security report that found the vulnerability. |
description
| String
| Description of the vulnerability finding. |
identifiers
| [VulnerabilityIdentifier!]!
| Identifiers of the vulnerabilit finding. |
location
| VulnerabilityLocation
| Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. |
name
| String
| Name of the vulnerability finding. |
project
| Project
| The project on which the vulnerability finding was found. |
projectFingerprint
| String
| Name of the vulnerability finding. |
reportType
| VulnerabilityReportType
| Type of the security report that found the vulnerability finding. |
scanner
| VulnerabilityScanner
| Scanner metadata for the vulnerability. |
severity
| VulnerabilitySeverity
| Severity of the vulnerability finding. |
solution
| String
| URL to the vulnerability’s details page. |
state
| VulnerabilityState
| The finding status. |
uuid
| String
| Name of the vulnerability finding. |
Project
Fields
Name | Type | Description |
---|---|---|
actualRepositorySizeLimit
| Float
| Size limit for the repository in bytes. |
agentConfigurations
| AgentConfigurationConnection
| Agent configurations defined by the project. (see Connections) |
allowMergeOnSkippedPipeline
| Boolean
| If only_allow_merge_if_pipeline_succeeds is true, indicates if merge requests of the project can also be merged with skipped jobs.
|
apiFuzzingCiConfiguration
| ApiFuzzingCiConfiguration
| API fuzzing configuration for the project. |
archived
| Boolean
| Indicates the archived status of the project. |
autocloseReferencedIssues
| Boolean
| Indicates if issues referenced by merge requests and commits within the default branch are closed automatically. |
avatarUrl
| String
| URL to avatar image file of the project. |
ciCdSettings
| ProjectCiCdSetting
| CI/CD settings for the project. |
ciJobTokenScope
| CiJobTokenScopeType
| The CI Job Tokens scope of access. |
clusterAgents
| ClusterAgentConnection
| Cluster agents associated with the project. (see Connections) |
codeCoverageSummary
| CodeCoverageSummary
| Code coverage summary associated with the project. |
complianceFrameworks
| ComplianceFrameworkConnection
| Compliance frameworks associated with the project. (see Connections) |
containerExpirationPolicy
| ContainerExpirationPolicy
| The container expiration policy of the project. |
containerRegistryEnabled
| Boolean
| Indicates if the project stores Docker container images in a container registry. |
containerRepositoriesCount
| Int!
| Number of container repositories in the project. |
createdAt
| Time
| Timestamp of the project creation. |
dastProfiles
| DastProfileConnection
| DAST Profiles associated with the project. (see Connections) |
dastScannerProfiles
| DastScannerProfileConnection
| The DAST scanner profiles associated with the project. (see Connections) |
dastSiteProfiles
| DastSiteProfileConnection
| DAST Site Profiles associated with the project. (see Connections) |
description
| String
| Short description of the project. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
forksCount
| Int!
| Number of times the project has been forked. |
fullPath
| ID!
| Full path of the project. |
grafanaIntegration
| GrafanaIntegration
| Grafana integration details for the project. |
group
| Group
| Group of the project. |
httpUrlToRepo
| String
| URL to connect to the project via HTTPS. |
id
| ID!
| ID of the project. |
importStatus
| String
| Status of import background job of the project. |
incidentManagementEscalationPolicies
| EscalationPolicyTypeConnection
| Incident Management escalation policies of the project. (see Connections) |
issuesEnabled
| Boolean
| Indicates if Issues are enabled for the current user. |
jiraImportStatus
| String
| Status of Jira import background job of the project. |
jiraImports
| JiraImportConnection
| Jira imports into the project. (see Connections) |
jobsEnabled
| Boolean
| Indicates if CI/CD pipeline jobs are enabled for the current user. |
lastActivityAt
| Time
| Timestamp of the project last activity. |
lfsEnabled
| Boolean
| Indicates if the project has Large File Storage (LFS) enabled. |
mergeRequestsEnabled
| Boolean
| Indicates if Merge Requests are enabled for the current user. |
mergeRequestsFfOnlyEnabled
| Boolean
| Indicates 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
| Namespace
| Namespace of the project. |
onlyAllowMergeIfAllDiscussionsAreResolved
| Boolean
| Indicates if merge requests of the project can only be merged when all the discussions are resolved. |
onlyAllowMergeIfPipelineSucceeds
| Boolean
| Indicates if merge requests of the project can only be merged with successful jobs. |
openIssuesCount
| Int
| Number of open issues for the project. |
path
| String!
| Path of the project. |
pathLocks
| PathLockConnection
| The project’s path locks. (see Connections) |
pipelineAnalytics
| PipelineAnalytics
| Pipeline analytics. |
printingMergeRequestLinkEnabled
| Boolean
| Indicates 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. |
publicJobs
| Boolean
| Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. |
pushRules
| PushRules
| The project’s push rules settings. |
removeSourceBranchAfterMerge
| Boolean
| Indicates if Delete source branch option should be enabled by default for all new merge requests of the project.
|
repository
| Repository
| Git repository of the project. |
repositorySizeExcess
| Float
| Size of repository that exceeds the limit in bytes. |
requestAccessEnabled
| Boolean
| Indicates if users can request member access to the project. |
requirementStatesCount
| RequirementStatesCount
| Number of requirements for the project by their state. |
sastCiConfiguration
| SastCiConfiguration
| SAST CI configuration for the project. |
scanExecutionPolicies
| ScanExecutionPolicyConnection
| Scan Execution Policies of the project. (see Connections) |
securityDashboardPath
| String
| Path to project’s security dashboard. |
securityScanners
| SecurityScanners
| Information about security analyzers used in the project. |
sentryErrors
| SentryErrorCollection
| Paginated collection of Sentry errors on the project. |
serviceDeskAddress
| String
| E-mail address of the service desk. |
serviceDeskEnabled
| Boolean
| Indicates if the project has service desk enabled. |
sharedRunnersEnabled
| Boolean
| Indicates if shared runners are enabled for the project. |
snippetsEnabled
| Boolean
| Indicates if Snippets are enabled for the current user. |
squashReadOnly
| Boolean!
| Indicates if squashReadOnly is enabled.
|
sshUrlToRepo
| String
| URL to connect to the project via SSH. |
starCount
| Int!
| Number of times the project has been starred. |
statistics
| ProjectStatistics
| Statistics of the project. |
suggestionCommitMessage
| String
| The commit message used to apply merge request suggestions. |
tagList
| String
|
Deprecated in 13.12. Use topics .
|
terraformStates
| TerraformStateConnection
| Terraform states associated with the project. (see Connections) |
topics
| [String!]
| List of project topics. |
userPermissions
| ProjectPermissions!
| Permissions for the current user on the resource. |
visibility
| String
| Visibility of the project. |
vulnerabilityScanners
| VulnerabilityScannerConnection
| Vulnerability scanners reported on the project vulnerabilities. (see Connections) |
webUrl
| String
| Web URL of the project. |
wikiEnabled
| Boolean
| Indicates if Wikis are enabled for the current user. |
Fields with arguments
Project.alertManagementAlert
A single Alert Management alert of the project.
Returns AlertManagementAlert
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of a user assigned to the issue. |
domain
| AlertManagementDomainFilter!
| Filter query for given domain. |
iid
| String
| IID of the alert. For example, “1”. |
search
| String
| Search query for title, description, service, or monitoring_tool. |
sort
| AlertManagementAlertSort
| Sort 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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of a user assigned to the issue. |
search
| String
| Search 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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of a user assigned to the issue. |
domain
| AlertManagementDomainFilter!
| Filter query for given domain. |
iid
| String
| IID of the alert. For example, “1”. |
search
| String
| Search query for title, description, service, or monitoring_tool. |
sort
| AlertManagementAlertSort
| Sort 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
Name | Type | Description |
---|---|---|
id
| AlertManagementHttpIntegrationID
| ID 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
Name | Type | Description |
---|---|---|
id
| GlobalID
| ID of the integration. |
Project.alertManagementPayloadFields
Extract alert fields from payload for custom mapping.
Returns [AlertManagementPayloadAlertField!]
.
Arguments
Name | Type | Description |
---|---|---|
payloadExample
| String!
| Sample payload for extracting alert fields for custom mappings. |
Project.board
A single board of the project.
Returns Board
.
Arguments
Name | Type | Description |
---|---|---|
id
| BoardID!
| The board’s ID. |
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
Name | Type | Description |
---|---|---|
id
| BoardID
| Find a board by its ID. |
Project.ciTemplate
Find a single CI/CD template by name.
Returns CiTemplate
.
Arguments
Name | Type | Description |
---|---|---|
name
| String!
| Name of the CI/CD template to search for. |
Project.clusterAgent
Find a single cluster agent by name.
Returns ClusterAgent
.
Arguments
Name | Type | Description |
---|---|---|
name
| String!
| Name of the cluster agent. |
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
Name | Type | Description |
---|---|---|
name
| String
| Filter the container repositories by their name. |
sort
| ContainerRepositorySort
| Sort container repositories by this criteria. |
Project.dastSiteProfile
DAST Site Profile associated with the project.
Returns DastSiteProfile
.
Arguments
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
normalizedTargetUrls
| [String!]
| Normalized URL of the target to be scanned. |
Project.environment
A single environment of the project.
Returns Environment
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| Name of the environment. |
search
| String
| Search query for environment name. |
states
| [String!]
| States of environments that should be included in result. |
Project.environments
Environments of the project.
Returns EnvironmentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| Name of the environment. |
search
| String
| Search query for environment name. |
states
| [String!]
| States of environments that should be included in result. |
Project.incidentManagementEscalationPolicy
Incident Management escalation policy of the project.
Returns EscalationPolicyType
.
Arguments
Name | Type | Description |
---|---|---|
id
| IncidentManagementEscalationPolicyID!
| ID of the escalation policy. |
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
Name | Type | Description |
---|---|---|
iids
| [ID!]
| IIDs of on-call schedules. |
Project.issue
A single issue of the project.
Returns Issue
.
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user assigned to the issues, “none” and “any” values are supported. |
assigneeUsername
| String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
epicId
| String
| ID of an epic associated with the issues, “none” and “any” values are supported. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
iterationId
| [ID]
| List of iteration Global IDs applied to the issue. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
not
| NegatedIssueFilterInput
| Negated arguments. |
search
| String
| Search query for issue title or description. |
sort
| IssueSort
| Sort issues by this criteria. |
state
| IssuableState
| Current state of this issue. |
types
| [IssueType!]
| Filter issues by the given issue types. |
updatedAfter
| Time
| Issues updated after this date. |
updatedBefore
| Time
| Issues updated before this date. |
weight
| String
| Weight applied to the issue, “none” and “any” values are supported. |
Project.issueStatusCounts
Counts of issues by status for the project.
Returns IssueStatusCountsType
.
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user assigned to the issues, “none” and “any” values are supported. |
assigneeUsername
| String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
not
| NegatedIssueFilterInput
| Negated arguments. |
search
| String
| Search query for issue title or description. |
types
| [IssueType!]
| Filter issues by the given issue types. |
updatedAfter
| Time
| Issues updated after this date. |
updatedBefore
| Time
| Issues updated before this date. |
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
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user assigned to the issues, “none” and “any” values are supported. |
assigneeUsername
| String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
epicId
| String
| ID of an epic associated with the issues, “none” and “any” values are supported. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
iterationId
| [ID]
| List of iteration Global IDs applied to the issue. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
not
| NegatedIssueFilterInput
| Negated arguments. |
search
| String
| Search query for issue title or description. |
sort
| IssueSort
| Sort issues by this criteria. |
state
| IssuableState
| Current state of this issue. |
types
| [IssueType!]
| Filter issues by the given issue types. |
updatedAfter
| Time
| Issues updated after this date. |
updatedBefore
| Time
| Issues updated before this date. |
weight
| String
| Weight applied to the issue, “none” and “any” values are supported. |
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
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the iteration cadence is active. |
automatic
| Boolean
| Whether the iteration cadence should automatically generate future iterations. |
durationInWeeks
| Int
| Duration in weeks of the iterations within this cadence. |
id
| IterationsCadenceID
| Global ID of the iteration cadence to look up. |
includeAncestorGroups
| Boolean
| Whether to include ancestor groups to search iterations cadences in. |
title
| String
| Fuzzy 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
Name | Type | Description |
---|---|---|
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
id
| ID
| Global ID of the Iteration to look up. |
iid
| ID
| Internal ID of the Iteration to look up. |
includeAncestors
| Boolean
| Whether to include ancestor iterations. Defaults to true. |
iterationCadenceIds
| [IterationsCadenceID!]
| Global iteration cadence IDs by which to look up the iterations. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| IterationState
| Filter iterations by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
title
| String
| Fuzzy search by title. |
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
Name | Type | Description |
---|---|---|
statuses
| [CiJobStatus!]
| Filter jobs by status. |
Project.label
A label available on this project.
Returns Label
.
Arguments
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
includeAncestorGroups
| Boolean
| Include labels from ancestor groups. |
searchTerm
| String
| A search term to find labels with. |
Project.mergeRequest
A single merge request of the project.
Returns MergeRequest
.
Arguments
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
containingDate
| Time
| A date that the milestone contains. |
endDate
| Time
| Deprecated in 13.5. Use timeframe.end. |
ids
| [ID!]
| Array of global milestone IDs, e.g., "gid://gitlab/Milestone/1" .
|
includeAncestors
| Boolean
| Also return milestones in the project’s parent group and its ancestors. |
searchTitle
| String
| A search string for the title. |
startDate
| Time
| Deprecated in 13.5. Use timeframe.start. |
state
| MilestoneStateEnum
| Filter milestones by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
title
| String
| The title of the milestone. |
Project.networkPolicies
Network Policies of the project.
Returns NetworkPolicyConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
environmentId
| EnvironmentID
| The global 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
Name | Type | Description |
---|---|---|
includeVersionless
| Boolean
| Include versionless packages. |
packageName
| String
| Search a package by name. |
packageType
| PackageTypeEnum
| Filter a package by type. |
sort
| PackageSort
| Sort packages by this criteria. |
status
| PackageStatus
| Filter a package by status. |
Project.pipeline
Build pipeline of the project.
Returns Pipeline
.
Arguments
Name | Type | Description |
---|---|---|
iid
| ID
| IID of the Pipeline. For example, “1”. |
sha
| String
| SHA of the Pipeline. For example, “dyd0f15ay83993f5ab66k927w28673882x99100b”. |
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
Name | Type | Description |
---|---|---|
ref
| String
| Filter pipelines by the ref they are run for. |
sha
| String
| Filter pipelines by the sha of the commit they are run for. |
status
| PipelineStatusEnum
| Filter pipelines by their status. |
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
Name | Type | Description |
---|---|---|
relations
| [ProjectMemberRelation!]
| Filter members by the given member relations. |
search
| String
| Search query. |
Project.release
A single release of the project.
Returns Release
.
Arguments
Name | Type | Description |
---|---|---|
tagName
| String!
| The 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
Name | Type | Description |
---|---|---|
sort
| ReleaseSort
| Sort releases by this criteria. |
Project.requirement
Find a single requirement.
Returns Requirement
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| [String!]
| Filter requirements by author username. |
iid
| ID
| IID of the requirement, e.g., “1”. |
iids
| [ID!]
| List of IIDs of requirements, e.g., [1, 2] .
|
lastTestReportState
| RequirementStatusFilter
| The state of latest requirement test report. |
search
| String
| Search query for requirement title. |
sort
| Sort
| List requirements by sort order. |
state
| RequirementState
| Filter requirements by state. |
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
Name | Type | Description |
---|---|---|
authorUsername
| [String!]
| Filter requirements by author username. |
iid
| ID
| IID of the requirement, e.g., “1”. |
iids
| [ID!]
| List of IIDs of requirements, e.g., [1, 2] .
|
lastTestReportState
| RequirementStatusFilter
| The state of latest requirement test report. |
search
| String
| Search query for requirement title. |
sort
| Sort
| List requirements by sort order. |
state
| RequirementState
| Filter requirements by state. |
Project.sentryDetailedError
Detailed version of a Sentry error on the project.
Returns SentryDetailedError
.
Arguments
Name | Type | Description |
---|---|---|
id
| GitlabErrorTrackingDetailedErrorID!
| ID of the Sentry issue. |
Project.services
Project services.
Returns ServiceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Indicates if the integration is active. |
type
| ServiceType
| Type 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
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
visibility
| VisibilityScopesEnum
| The visibility of the snippet. |
Project.terraformState
Find a single Terraform state by name.
Returns TerraformState
.
Arguments
Name | Type | Description |
---|---|---|
name
| String!
| Name of the Terraform state. |
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
Name | Type | Description |
---|---|---|
hasIssues
| Boolean
| Returns only the vulnerabilities which have linked issues. |
hasResolution
| Boolean
| Returns only the vulnerabilities which have been resolved on default branch. |
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by VulnerabilityScanner.externalId. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
sort
| VulnerabilitySort
| List vulnerabilities by sort order. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
Project.vulnerabilitiesCountByDay
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
hasIssues
| Boolean
| Filter vulnerabilities that do or do not have issues. |
hasResolution
| Boolean
| Filter vulnerabilities that do or do not have a resolution. |
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. |
ProjectCiCdSetting
Fields
Name | Type | Description |
---|---|---|
jobTokenScopeEnabled
| Boolean
| Indicates CI job tokens generated in this project have restricted access to resources. |
keepLatestArtifact
| Boolean
| Whether to keep the latest builds artifacts. |
mergePipelinesEnabled
| Boolean
| Whether merge pipelines are enabled. |
mergeTrainsEnabled
| Boolean
| Whether merge trains are enabled. |
project
| Project
| Project the CI/CD settings belong to. |
ProjectMember
Represents a Project Membership.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| AccessLevel
| GitLab::Access level. |
createdAt
| Time
| Date and time the membership was created. |
createdBy
| UserCore
| User that authorized membership. |
expiresAt
| Time
| Date and time the membership expires. |
id
| ID!
| ID of the member. |
project
| Project
| Project that User is a member of. |
updatedAt
| Time
| Date and time the membership was last updated. |
user
| UserCore
| User that is associated with the member object. |
userPermissions
| ProjectPermissions!
| Permissions for the current user on the resource. |
ProjectPermissions
Fields
Name | Type | Description |
---|---|---|
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.
|
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.
|
ProjectStatistics
Fields
Name | Type | Description |
---|---|---|
buildArtifactsSize
| Float!
| Build artifacts size of the project in bytes. |
commitCount
| Float!
| Commit count of the project. |
lfsObjectsSize
| Float!
| Large File Storage (LFS) object size of the project in bytes. |
packagesSize
| Float!
| Packages size of the project in bytes. |
repositorySize
| Float!
| Repository size of the project in bytes. |
snippetsSize
| Float
| Snippets size of the project in bytes. |
storageSize
| Float!
| Storage size of the project in bytes. |
uploadsSize
| Float
| Uploads size of the project in bytes. |
wikiSize
| Float
| Wiki size of the project in bytes. |
PrometheusAlert
The alert condition for Prometheus.
Fields
Name | Type | Description |
---|---|---|
humanizedText
| String!
| The human-readable text of the alert condition. |
id
| ID!
| ID of the alert condition. |
PushRules
Represents rules that commit pushes must follow.
Fields
Name | Type | Description |
---|---|---|
rejectUnsignedCommits
| Boolean!
| Indicates whether commits not signed through GPG will be rejected. |
PypiMetadata
Pypi metadata.
Fields
Name | Type | Description |
---|---|---|
id
| PackagesPypiMetadatumID!
| ID of the metadatum. |
requiredPython
| String
| Required Python version of the Pypi package. |
RecentFailures
Recent failure history of a test case.
Fields
Name | Type | Description |
---|---|---|
baseBranch
| String
| Name of the base branch of the project. |
count
| Int
| Number of times the test case has failed in the past 14 days. |
Release
Represents a release.
Fields
Name | Type | Description |
---|---|---|
assets
| ReleaseAssets
| Assets of the release. |
author
| UserCore
| User that created the release. |
commit
| Commit
| The commit associated with the release. |
createdAt
| Time
| Timestamp of when the release was created. |
description
| String
| Description (also known as “release notes”) of the release. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
evidences
| ReleaseEvidenceConnection
| Evidence for the release. (see Connections) |
links
| ReleaseLinks
| Links of the release. |
milestones
| MilestoneConnection
| Milestones associated to the release. (see Connections) |
name
| String
| Name of the release. |
releasedAt
| Time
| Timestamp of when the release was released. |
tagName
| String
| Name of the tag associated with the release. |
tagPath
| String
| Relative web path to the tag associated with the release. |
upcomingRelease
| Boolean
| Indicates the release is an upcoming release. |
ReleaseAssetLink
Represents an asset link associated with a release.
Fields
Name | Type | Description |
---|---|---|
directAssetUrl
| String
| Direct asset URL of the link. |
external
| Boolean
| Indicates the link points to an external resource. |
id
| ID!
| ID of the link. |
linkType
| ReleaseAssetLinkType
| Type of the link: other , runbook , image , package ; defaults to other .
|
name
| String
| Name of the link. |
url
| String
| URL of the link. |
ReleaseAssets
A container for all assets associated with a release.
Fields
Name | Type | Description |
---|---|---|
count
| Int
| Number of assets of the release. |
links
| ReleaseAssetLinkConnection
| Asset links of the release. (see Connections) |
sources
| ReleaseSourceConnection
| Sources of the release. (see Connections) |
ReleaseEvidence
Evidence for a release.
Fields
Name | Type | Description |
---|---|---|
collectedAt
| Time
| Timestamp when the evidence was collected. |
filepath
| String
| URL from where the evidence can be downloaded. |
id
| ID!
| ID of the evidence. |
sha
| String
| SHA1 ID of the evidence hash. |
ReleaseLinks
Fields
Name | Type | Description |
---|---|---|
closedIssuesUrl
| String
| HTTP URL of the issues page, filtered by this release and state=closed .
|
closedMergeRequestsUrl
| String
| HTTP URL of the merge request page , filtered by this release and state=closed .
|
editUrl
| String
| HTTP URL of the release’s edit page. |
mergedMergeRequestsUrl
| String
| HTTP URL of the merge request page , filtered by this release and state=merged .
|
openedIssuesUrl
| String
| HTTP URL of the issues page, filtered by this release and state=open .
|
openedMergeRequestsUrl
| String
| HTTP URL of the merge request page, filtered by this release and state=open .
|
selfUrl
| String
| HTTP URL of the release. |
ReleaseSource
Represents the source code attached to a release in a particular format.
Fields
Name | Type | Description |
---|---|---|
format
| String
| Format of the source. |
url
| String
| Download URL of the source. |
Repository
Fields
Name | Type | Description |
---|---|---|
diskPath
| String
| Shows 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
| String
| Default 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
Name | Type | Description |
---|---|---|
paths
| [String!]!
| Array of desired blob paths. |
ref
| String
| The commit ref to get the blobs from. Default value is HEAD. |
Repository.branchNames
Names of branches available in this repository that match the search pattern.
Returns [String!]
.
Arguments
Name | Type | Description |
---|---|---|
limit
| Int!
| The number of branch names to return. |
offset
| Int!
| The number of branch names to skip. |
searchPattern
| String!
| The pattern to search for branch names by. |
Repository.tree
Tree of the repository.
Returns Tree
.
Arguments
Name | Type | Description |
---|---|---|
path
| String
| The path to get the tree for. Default value is the root of the repository. |
recursive
| Boolean
| Used to get a recursive tree. Default is false. |
ref
| String
| The commit ref to get the tree for. Default value is HEAD. |
RepositoryBlob
Fields
Name | Type | Description |
---|---|---|
canModifyBlob
| Boolean
| Whether the current user can modify the blob. |
editBlobPath
| String
| Web path to edit the blob in the old-style editor. |
externalStorageUrl
| String
| Web path to download the raw blob via external storage, if enabled. |
fileType
| String
| The expected format of the blob based on the extension. |
forkAndEditPath
| String
| Web path to edit this blob using a forked project. |
id
| ID!
| ID of the blob. |
ideEditPath
| String
| Web path to edit this blob in the Web IDE. |
ideForkAndEditPath
| String
| Web path to edit this blob in the Web IDE using a forked project. |
lfsOid
| String
| LFS OID of the blob. |
mode
| String
| Blob mode. |
name
| String
| Blob name. |
oid
| String!
| OID of the blob. |
path
| String!
| Path of the blob. |
plainData
| String
| Blob plain highlighted data. |
rawBlob
| String
| The raw content of the blob. |
rawPath
| String
| Web path to download the raw blob. |
rawSize
| Int
| Size (in bytes) of the blob, or the blob target if stored externally. |
rawTextBlob
| String
| The raw content of the blob, if the blob is text data. |
replacePath
| String
| Web path to replace the blob content. |
richViewer
| BlobViewer
| Blob content rich viewer. |
simpleViewer
| BlobViewer!
| Blob content simple viewer. |
size
| Int
| Size (in bytes) of the blob. |
storedExternally
| Boolean
| Whether the blob’s content is stored externally (for instance, in LFS). |
webPath
| String
| Web path of the blob. |
Requirement
Represents a requirement.
Fields
Name | Type | Description |
---|---|---|
author
| UserCore!
| Author of the requirement. |
createdAt
| Time!
| Timestamp of when the requirement was created. |
description
| String
| Description of the requirement. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
id
| ID!
| ID of the requirement. |
iid
| ID!
| Internal ID of the requirement. |
lastTestReportManuallyCreated
| Boolean
| Indicates if latest test report was created by user. |
lastTestReportState
| TestReportState
| Latest requirement test report state. |
project
| Project!
| Project to which the requirement belongs. |
state
| RequirementState!
| State of the requirement. |
title
| String
| Title of the requirement. |
titleHtml
| String
| The GitLab 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. |
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
Name | Type | Description |
---|---|---|
sort
| Sort
| List test reports by sort order. |
RequirementPermissions
Check permissions for the current user on a requirement.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
archived
| Int
| Number of archived requirements. |
opened
| Int
| Number of opened requirements. |
RootStorageStatistics
Fields
Name | Type | Description |
---|---|---|
buildArtifactsSize
| Float!
| The CI artifacts size in bytes. |
lfsObjectsSize
| Float!
| The LFS objects size in bytes. |
packagesSize
| Float!
| The packages size in bytes. |
pipelineArtifactsSize
| Float!
| The CI pipeline artifacts size in bytes. |
repositorySize
| Float!
| The Git repository size in bytes. |
snippetsSize
| Float!
| The snippets size in bytes. |
storageSize
| Float!
| The total storage in bytes. |
uploadsSize
| Float!
| The uploads size in bytes. |
wikiSize
| Float!
| The wiki size in bytes. |
RunnerArchitecture
Fields
Name | Type | Description |
---|---|---|
downloadLocation
| String!
| Download location for the runner for the platform architecture. |
name
| String!
| Name of the runner platform architecture. |
RunnerPlatform
Fields
Name | Type | Description |
---|---|---|
architectures
| RunnerArchitectureConnection
| Runner 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
Name | Type | Description |
---|---|---|
installInstructions
| String!
| Instructions for installing the runner on the specified architecture. |
registerInstructions
| String
| Instructions for registering the runner. |
SastCiConfiguration
Represents a CI configuration of SAST.
Fields
Name | Type | Description |
---|---|---|
analyzers
| SastCiConfigurationAnalyzersEntityConnection
| List of analyzers entities attached to SAST configuration. (see Connections) |
global
| SastCiConfigurationEntityConnection
| List of global entities related to SAST configuration. (see Connections) |
pipeline
| SastCiConfigurationEntityConnection
| List of pipeline entities related to SAST configuration. (see Connections) |
SastCiConfigurationAnalyzersEntity
Represents an analyzer entity in SAST CI configuration.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Analyzer description that is displayed on the form. |
enabled
| Boolean
| Indicates whether an analyzer is enabled. |
label
| String
| Analyzer label used in the config UI. |
name
| String
| Name of the analyzer. |
variables
| SastCiConfigurationEntityConnection
| List of supported variables. (see Connections) |
SastCiConfigurationEntity
Represents an entity in SAST CI configuration.
Fields
Name | Type | Description |
---|---|---|
defaultValue
| String
| Default value that is used if value is empty. |
description
| String
| Entity description that is displayed on the form. |
field
| String
| CI keyword of entity. |
label
| String
| Label for entity used in the form. |
options
| SastCiConfigurationOptionsEntityConnection
| Different possible values of the field. (see Connections) |
size
| SastUiComponentSize
| Size of the UI component. |
type
| String
| Type of the field value. |
value
| String
| Current value of the entity. |
SastCiConfigurationOptionsEntity
Represents an entity for options in SAST CI configuration.
Fields
Name | Type | Description |
---|---|---|
label
| String
| Label of option entity. |
value
| String
| Value of option entity. |
Scan
Represents the security scan information.
Fields
Name | Type | Description |
---|---|---|
errors
| [String!]!
| List of errors. |
name
| String!
| Name of the scan. |
ScanExecutionPolicy
Represents the scan execution policy.
Fields
Name | Type | Description |
---|---|---|
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. |
ScannedResource
Represents a resource scanned by a security scan.
Fields
Name | Type | Description |
---|---|---|
requestMethod
| String
| The HTTP request method used to access the URL. |
url
| String
| The URL scanned by the scanner. |
SecurityReportSummary
Represents summary of a security report.
Fields
Name | Type | Description |
---|---|---|
apiFuzzing
| SecurityReportSummarySection
| Aggregated counts for the api_fuzzing scan.
|
containerScanning
| SecurityReportSummarySection
| Aggregated counts for the container_scanning scan.
|
coverageFuzzing
| SecurityReportSummarySection
| Aggregated counts for the coverage_fuzzing scan.
|
dast
| SecurityReportSummarySection
| Aggregated counts for the dast scan.
|
dependencyScanning
| SecurityReportSummarySection
| Aggregated counts for the dependency_scanning scan.
|
sast
| SecurityReportSummarySection
| Aggregated counts for the sast scan.
|
secretDetection
| SecurityReportSummarySection
| Aggregated counts for the secret_detection scan.
|
SecurityReportSummarySection
Represents a section of a summary of a security report.
Fields
Name | Type | Description |
---|---|---|
scannedResources
| ScannedResourceConnection
| A list of the first 20 scanned resources. (see Connections) |
scannedResourcesCount
| Int
| Total number of scanned resources. |
scannedResourcesCsvPath
| String
| Path to download all the scanned resources in CSV format. |
scans
| ScanConnection!
| List of security scans ran for the type. (see Connections) |
vulnerabilitiesCount
| Int
| Total number of vulnerabilities. |
SecurityScanners
Represents a list of security scanners.
Fields
Name | Type | Description |
---|---|---|
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. |
SentryDetailedError
A Sentry error.
Fields
Name | Type | Description |
---|---|---|
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
| String
| Commit the error was first seen. |
firstReleaseShortVersion
| String
| Release short version the error was first seen. |
firstReleaseVersion
| String
| Release version the error was first seen. |
firstSeen
| Time!
| Timestamp when the error was first seen. |
frequency
| [SentryErrorFrequency!]!
| Last 24hr stats of the error. |
gitlabCommit
| String
| GitLab commit SHA attributed to the Error based on the release version. |
gitlabCommitPath
| String
| Path to the GitLab page for the GitLab commit attributed to the error. |
gitlabIssuePath
| String
| URL of GitLab Issue. |
id
| ID!
| ID (global ID) of the error. |
lastReleaseLastCommit
| String
| Commit the error was last seen. |
lastReleaseShortVersion
| String
| Release short version the error was last seen. |
lastReleaseVersion
| String
| Release version the error was last seen. |
lastSeen
| Time!
| Timestamp when the error was last seen. |
message
| String
| Sentry 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
Name | Type | Description |
---|---|---|
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
| String
| Sentry 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
Name | Type | Description |
---|---|---|
externalUrl
| String
| External URL for Sentry. |
Fields with arguments
SentryErrorCollection.detailedError
Detailed version of a Sentry error on the project.
Returns SentryDetailedError
.
Arguments
Name | Type | Description |
---|---|---|
id
| GitlabErrorTrackingDetailedErrorID!
| ID of the Sentry issue. |
SentryErrorCollection.errorStackTrace
Stack Trace of Sentry Error.
Returns SentryErrorStackTrace
.
Arguments
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
searchTerm
| String
| Search query for the Sentry error details. |
sort
| String
| Attribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default. |
SentryErrorFrequency
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
col
| String
| Function in which the Sentry error occurred. |
fileName
| String
| File in which the Sentry error occurred. |
function
| String
| Function in which the Sentry error occurred. |
line
| String
| Function in which the Sentry error occurred. |
traceContext
| [SentryErrorStackTraceContext!]
| Context of the Sentry error. |
SentryErrorTags
State of a Sentry error.
Fields
Name | Type | Description |
---|---|---|
level
| String
| Severity level of the Sentry Error. |
logger
| String
| Logger of the Sentry Error. |
Snippet
Represents a snippet entry.
Fields
Name | Type | Description |
---|---|---|
author
| UserCore
| The owner of the snippet. |
createdAt
| Time!
| Timestamp this snippet was created. |
description
| String
| Description of the snippet. |
descriptionHtml
| String
| The GitLab Flavored Markdown rendering of description .
|
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
fileName
| String
| File Name of the snippet. |
httpUrlToRepo
| String
| HTTP URL to the snippet repository. |
id
| SnippetID!
| ID of the snippet. |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
project
| Project
| The project the snippet is associated with. |
rawUrl
| String!
| Raw URL of the snippet. |
sshUrlToRepo
| String
| SSH 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
Name | Type | Description |
---|---|---|
paths
| [String!]
| Paths of the blobs. |
SnippetBlob
Represents the snippet blob.
Fields
Name | Type | Description |
---|---|---|
binary
| Boolean!
| Shows whether the blob is binary. |
externalStorage
| String
| Blob external storage. |
mode
| String
| Blob mode. |
name
| String
| Blob name. |
path
| String
| Blob path. |
plainData
| String
| Blob plain highlighted data. |
rawPath
| String!
| Blob raw content endpoint path. |
renderedAsText
| Boolean!
| Shows whether the blob is rendered as text. |
richData
| String
| Blob highlighted data. |
richViewer
| SnippetBlobViewer
| Blob content rich viewer. |
simpleViewer
| SnippetBlobViewer!
| Blob content simple viewer. |
size
| Int!
| Blob size. |
SnippetBlobViewer
Represents how the blob content should be displayed.
Fields
Name | Type | Description |
---|---|---|
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
| String
| Error rendering the blob content. |
tooLarge
| Boolean!
| Shows whether the blob is too large to be displayed. |
type
| BlobViewersType!
| Type of blob viewer. |
SnippetPermissions
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the SnippetRepositoryRegistry was created. |
id
| ID!
| ID of the SnippetRepositoryRegistry. |
lastSyncFailure
| String
| Error message during sync of the SnippetRepositoryRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the SnippetRepositoryRegistry. |
retryAt
| Time
| Timestamp after which the SnippetRepositoryRegistry should be resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the SnippetRepositoryRegistry. |
snippetRepositoryId
| ID!
| ID of the Snippet Repository. |
state
| RegistryState
| Sync state of the SnippetRepositoryRegistry. |
StatusAction
Fields
Name | Type | Description |
---|---|---|
buttonTitle
| String
| Title for the button, for example: Retry this job. |
icon
| String
| Icon used in the action button. |
method
| String
| Method for the action, for example: :post. |
path
| String
| Path for the action. |
title
| String
| Title for the action, for example: Retry. |
Submodule
Fields
Name | Type | Description |
---|---|---|
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
| String
| Tree URL for the sub-module. |
type
| EntryType!
| Type of tree entry. |
webUrl
| String
| Web URL for the sub-module. |
TaskCompletionStatus
Completion status of tasks.
Fields
Name | Type | Description |
---|---|---|
completedCount
| Int!
| Number of completed tasks. |
count
| Int!
| Number of total tasks. |
TerraformState
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp the Terraform state was created. |
id
| ID!
| ID of the Terraform state. |
latestVersion
| TerraformStateVersion
| The latest version of the Terraform state. |
lockedAt
| Time
| Timestamp the Terraform state was locked. |
lockedByUser
| UserCore
| The user 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
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp the version was created. |
createdByUser
| UserCore
| The user that created this version. |
downloadPath
| String
| URL for downloading the version’s JSON file. |
id
| ID!
| ID of the Terraform state version. |
job
| CiJob
| The job that created this version. |
serial
| Int
| Serial 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
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the TerraformStateVersionRegistry was created. |
id
| ID!
| ID of the TerraformStateVersionRegistry. |
lastSyncFailure
| String
| Error message during sync of the TerraformStateVersionRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the TerraformStateVersionRegistry. |
retryAt
| Time
| Timestamp after which the TerraformStateVersionRegistry should be resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the TerraformStateVersionRegistry. |
state
| RegistryState
| Sync state of the TerraformStateVersionRegistry. |
terraformStateVersionId
| ID!
| ID of the terraform state version. |
TestCase
Test case in pipeline test report.
Fields
Name | Type | Description |
---|---|---|
attachmentUrl
| String
| URL of the test case attachment file. |
classname
| String
| Classname of the test case. |
executionTime
| Float
| Test case execution time in seconds. |
file
| String
| Path to the file of the test case. |
name
| String
| Name of the test case. |
recentFailures
| RecentFailures
| Recent failure history of the test case on the base branch. |
stackTrace
| String
| Stack trace of the test case. |
status
| TestCaseStatus
| Status of the test case (error, failed, success, skipped). |
systemOutput
| String
| System output of the test case. |
TestReport
Represents a requirement test report.
Fields
Name | Type | Description |
---|---|---|
author
| UserCore
| Author 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. |
TestReportSummary
Test report for a pipeline.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
count
| Int
| Total number of the test cases. |
error
| Int
| Total number of test cases that had an error. |
failed
| Int
| Total number of test cases that failed. |
skipped
| Int
| Total number of test cases that were skipped. |
success
| Int
| Total number of test cases that succeeded. |
suiteError
| String
| Test suite error message. |
time
| Float
| Total duration of the tests. |
TestSuite
Test suite in a pipeline test report.
Fields
Name | Type | Description |
---|---|---|
errorCount
| Int
| Total number of test cases that had an error. |
failedCount
| Int
| Total number of test cases that failed in the test suite. |
name
| String
| Name of the test suite. |
skippedCount
| Int
| Total number of test cases that were skipped in the test suite. |
successCount
| Int
| Total number of test cases that succeeded in the test suite. |
suiteError
| String
| Test suite error message. |
testCases
| TestCaseConnection
| Test cases in the test suite. (see Connections) |
totalCount
| Int
| Total number of the test cases in the test suite. |
totalTime
| Float
| Total duration of the tests in the test suite. |
TestSuiteSummary
Test suite summary in a pipeline test report.
Fields
Name | Type | Description |
---|---|---|
buildIds
| [ID!]
| IDs of the builds used to run the test suite. |
errorCount
| Int
| Total number of test cases that had an error. |
failedCount
| Int
| Total number of test cases that failed in the test suite. |
name
| String
| Name of the test suite. |
skippedCount
| Int
| Total number of test cases that were skipped in the test suite. |
successCount
| Int
| Total number of test cases that succeeded in the test suite. |
suiteError
| String
| Test suite error message. |
totalCount
| Int
| Total number of the test cases in the test suite. |
totalTime
| Float
| Total duration of the tests in the test suite. |
TimeReportStats
Represents the time report stats for timeboxes.
Fields
Name | Type | Description |
---|---|---|
complete
| TimeboxMetrics
| Completed issues metrics. |
incomplete
| TimeboxMetrics
| Incomplete issues metrics. |
total
| TimeboxMetrics
| Total issues metrics. |
TimeboxMetrics
Represents measured stats metrics for timeboxes.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| The count metric. |
weight
| Int!
| The weight metric. |
TimeboxReport
Represents a historically accurate report about the timebox.
Fields
Name | Type | Description |
---|---|---|
burnupTimeSeries
| [BurnupChartDailyTotals!]
| Daily scope and completed totals for burnup charts. |
stats
| TimeReportStats
| Represents the time report stats for the timebox. |
Timelog
Fields
Name | Type | Description |
---|---|---|
issue
| Issue
| The issue that logged time was added to. |
mergeRequest
| MergeRequest
| The merge request that logged time was added to. |
note
| Note
| The note where the quick action to add the logged time was executed. |
spentAt
| Time
| Timestamp of when the time tracked was spent at. |
timeSpent
| Int!
| The time spent displayed in seconds. |
user
| UserCore!
| The user that logged the time. |
Todo
Representing a to-do entry.
Fields
Name | Type | Description |
---|---|---|
action
| TodoActionEnum!
| Action of the to-do item. |
author
| UserCore!
| The author of this to-do item. |
body
| String!
| Body of the to-do item. |
createdAt
| Time!
| Timestamp this to-do item was created. |
group
| Group
| Group this to-do item is associated with. |
id
| ID!
| ID of the to-do item. |
project
| Project
| The project this to-do item is associated with. |
state
| TodoStateEnum!
| State of the to-do item. |
targetType
| TodoTargetEnum!
| Target type of the to-do item. |
Tree
Fields
Name | Type | Description |
---|---|---|
blobs
| BlobConnection!
| Blobs of the tree. (see Connections) |
lastCommit
| Commit
| Last 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
Name | Type | Description |
---|---|---|
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
| String
| Web path for the tree entry (directory). |
webUrl
| String
| Web URL for the tree entry (directory). |
UsageTrendsMeasurement
Represents a recorded measurement (object count) for the Admins.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Object count. |
identifier
| MeasurementIdentifier!
| The type of objects being measured. |
recordedAt
| Time
| The time the measurement was recorded. |
UserCallout
Fields
Name | Type | Description |
---|---|---|
dismissedAt
| Time
| Date when the callout was dismissed. |
featureName
| UserCalloutFeatureNameEnum!
| Name of the feature that the callout is for. |
UserCore
Core represention of a GitLab user.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
email
| String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
location
| String
| The location of the user. |
name
| String!
| Human-readable name of the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
publicEmail
| String
| User’s public email. |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| The type of snippet. |
visibility
| VisibilityScopesEnum
| The visibility 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
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
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
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| The action to be filtered. |
authorId
| [ID!]
| The ID of an author. |
groupId
| [ID!]
| The ID of a group. |
projectId
| [ID!]
| The ID of a project. |
state
| [TodoStateEnum!]
| The state of the todo. |
type
| [TodoTargetEnum!]
| The type of the todo. |
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
Name | Type | Description |
---|---|---|
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
| MergeRequestReviewState
| The state of the review by this user. |
reviewed
| Boolean!
| Whether this user has provided a review for this merge request. |
UserPermissions
Fields
Name | Type | Description |
---|---|---|
createSnippet
| Boolean!
| Indicates the user can perform create_snippet on this resource.
|
UserStatus
Fields
Name | Type | Description |
---|---|---|
availability
| AvailabilityEnum!
| User availability status. |
emoji
| String
| String representation of emoji. |
message
| String
| User status message. |
messageHtml
| String
| HTML of the user status message. |
VulnerabilitiesCountByDay
Represents the count of vulnerabilities by severity on a particular day. This data is retained for 365 days.
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
confirmedAt
| Time
| Timestamp of when the vulnerability state was changed to confirmed. |
confirmedBy
| UserCore
| The user that confirmed the vulnerability. |
description
| String
| Description of the vulnerability. |
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) |
dismissedAt
| Time
| Timestamp of when the vulnerability state was changed to dismissed. |
dismissedBy
| UserCore
| The user that dismissed the vulnerability. |
externalIssueLinks
| VulnerabilityExternalIssueLinkConnection!
| List of external issue links related to the vulnerability. (see Connections) |
hasSolutions
| Boolean
| Indicates whether there is a solution available for this vulnerability. |
id
| ID!
| GraphQL ID of the vulnerability. |
identifiers
| [VulnerabilityIdentifier!]!
| Identifiers of the vulnerability. |
location
| VulnerabilityLocation
| Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. |
mergeRequest
| MergeRequest
| Merge request that fixes the vulnerability. |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
primaryIdentifier
| VulnerabilityIdentifier
| Primary identifier of the vulnerability. |
project
| Project
| The project on which the vulnerability was found. |
reportType
| VulnerabilityReportType
| Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING). Scan Type in the UI.
|
resolvedAt
| Time
| Timestamp of when the vulnerability state was changed to resolved. |
resolvedBy
| UserCore
| The user that resolved the vulnerability. |
resolvedOnDefaultBranch
| Boolean!
| Indicates whether the vulnerability is fixed on the default branch or not. |
scanner
| VulnerabilityScanner
| Scanner metadata for the vulnerability. |
severity
| VulnerabilitySeverity
| Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL). |
state
| VulnerabilityState
| State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED). |
title
| String
| Title of the vulnerability. |
userNotesCount
| Int!
| Number of user notes attached to the vulnerability. |
userPermissions
| VulnerabilityPermissions!
| Permissions for the current user on the resource. |
vulnerabilityPath
| String
| URL to the vulnerability’s details page. |
Fields with arguments
Vulnerability.issueLinks
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
Name | Type | Description |
---|---|---|
linkType
| VulnerabilityIssueLinkType
| Filter issue links by link type. |
VulnerabilityDetailBase
Represents the vulnerability details base.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
VulnerabilityDetailBoolean
Represents the vulnerability details boolean value.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
value
| Boolean!
| Value of the field. |
VulnerabilityDetailCode
Represents the vulnerability details code field.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
lang
| String
| Language of the code. |
name
| String
| Name of the field. |
value
| String!
| Source code. |
VulnerabilityDetailCommit
Represents the vulnerability details commit field.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
value
| String!
| The commit SHA value. |
VulnerabilityDetailDiff
Represents the vulnerability details diff field.
Fields
Name | Type | Description |
---|---|---|
after
| String!
| Value of the field after the change. |
before
| String!
| Value of the field before the change. |
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
VulnerabilityDetailFileLocation
Represents the vulnerability details location within a file in the project.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name 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
| String
| Name of the field. |
VulnerabilityDetailInt
Represents the vulnerability details integer value.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
value
| Int!
| Value of the field. |
VulnerabilityDetailList
Represents the vulnerability details list value.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
items
| [VulnerabilityDetail!]!
| List of details. |
name
| String
| Name of the field. |
VulnerabilityDetailMarkdown
Represents the vulnerability details Markdown field.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
value
| String!
| Value of the Markdown field. |
VulnerabilityDetailModuleLocation
Represents the vulnerability details location within a file in the project.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
moduleName
| String!
| Module name. |
name
| String
| Name of the field. |
offset
| Int!
| Offset of the module location. |
VulnerabilityDetailTable
Represents the vulnerability details table value.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
headers
| [VulnerabilityDetail!]!
| Table headers. |
name
| String
| Name of the field. |
rows
| [VulnerabilityDetail!]!
| Table rows. |
VulnerabilityDetailText
Represents the vulnerability details text field.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
value
| String!
| Value of the text field. |
VulnerabilityDetailUrl
Represents the vulnerability details URL field.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
href
| String!
| Href of the URL. |
name
| String
| Name of the field. |
text
| String
| Text of the URL. |
VulnerabilityExternalIssueLink
Represents an external issue link of a vulnerability.
Fields
Name | Type | Description |
---|---|---|
externalIssue
| ExternalIssue
| The 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
Name | Type | Description |
---|---|---|
externalId
| String
| External ID of the vulnerability identifier. |
externalType
| String
| External type of the vulnerability identifier. |
name
| String
| Name of the vulnerability identifier. |
url
| String
| URL of the vulnerability identifier. |
VulnerabilityIssueLink
Represents an issue link of a vulnerability.
Fields
Name | Type | Description |
---|---|---|
id
| ID!
| GraphQL ID of the vulnerability. |
issue
| Issue!
| The issue attached to issue link. |
linkType
| VulnerabilityIssueLinkType!
| Type of the issue link. |
VulnerabilityLocationContainerScanning
Represents the location of a vulnerability found by a container security scan.
Fields
Name | Type | Description |
---|---|---|
dependency
| VulnerableDependency
| Dependency containing the vulnerability. |
image
| String
| Name of the vulnerable container image. |
operatingSystem
| String
| Operating system that runs on the vulnerable container image. |
VulnerabilityLocationCoverageFuzzing
Represents the location of a vulnerability found by a Coverage Fuzzing scan.
Fields
Name | Type | Description |
---|---|---|
blobPath
| String
| Blob path to the vulnerable file. |
endLine
| String
| Number of the last relevant line in the vulnerable file. |
file
| String
| Path to the vulnerable file. |
startLine
| String
| Number of the first relevant line in the vulnerable file. |
vulnerableClass
| String
| Class containing the vulnerability. |
vulnerableMethod
| String
| Method containing the vulnerability. |
VulnerabilityLocationDast
Represents the location of a vulnerability found by a DAST scan.
Fields
Name | Type | Description |
---|---|---|
hostname
| String
| Domain name of the vulnerable request. |
param
| String
| Query parameter for the URL on which the vulnerability occurred. |
path
| String
| URL path and query string of the vulnerable request. |
requestMethod
| String
| HTTP method of the vulnerable request. |
VulnerabilityLocationDependencyScanning
Represents the location of a vulnerability found by a dependency security scan.
Fields
Name | Type | Description |
---|---|---|
blobPath
| String
| Blob path to the vulnerable file. |
dependency
| VulnerableDependency
| Dependency containing the vulnerability. |
file
| String
| Path to the vulnerable file. |
VulnerabilityLocationSast
Represents the location of a vulnerability found by a SAST scan.
Fields
Name | Type | Description |
---|---|---|
blobPath
| String
| Blob path to the vulnerable file. |
endLine
| String
| Number of the last relevant line in the vulnerable file. |
file
| String
| Path to the vulnerable file. |
startLine
| String
| Number of the first relevant line in the vulnerable file. |
vulnerableClass
| String
| Class containing the vulnerability. |
vulnerableMethod
| String
| Method containing the vulnerability. |
VulnerabilityLocationSecretDetection
Represents the location of a vulnerability found by a secret detection scan.
Fields
Name | Type | Description |
---|---|---|
blobPath
| String
| Blob path to the vulnerable file. |
endLine
| String
| Number of the last relevant line in the vulnerable file. |
file
| String
| Path to the vulnerable file. |
startLine
| String
| Number of the first relevant line in the vulnerable file. |
vulnerableClass
| String
| Class containing the vulnerability. |
vulnerableMethod
| String
| Method containing the vulnerability. |
VulnerabilityPermissions
Check permissions for the current user on a vulnerability.
Fields
Name | Type | Description |
---|---|---|
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.
|
createVulnerability
| Boolean!
| Indicates the user can perform create_vulnerability 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.
|
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.
|
VulnerabilityScanner
Represents a vulnerability scanner.
Fields
Name | Type | Description |
---|---|---|
externalId
| String
| External ID of the vulnerability scanner. |
id
| ID
| ID of the scanner. |
name
| String
| Name of the vulnerability scanner. |
reportType
| VulnerabilityReportType
| Type of the vulnerability report. |
vendor
| String
| Vendor of the vulnerability scanner. |
VulnerabilitySeveritiesCount
Represents vulnerability counts by severity.
Fields
Name | Type | Description |
---|---|---|
critical
| Int
| Number of vulnerabilities of CRITICAL severity of the project. |
high
| Int
| Number of vulnerabilities of HIGH severity of the project. |
info
| Int
| Number of vulnerabilities of INFO severity of the project. |
low
| Int
| Number of vulnerabilities of LOW severity of the project. |
medium
| Int
| Number of vulnerabilities of MEDIUM severity of the project. |
unknown
| Int
| Number of vulnerabilities of UNKNOWN severity of the project. |
VulnerableDependency
Represents a vulnerable dependency. Used in vulnerability location data.
Fields
Name | Type | Description |
---|---|---|
package
| VulnerablePackage
| The package associated with the vulnerable dependency. |
version
| String
| The version of the vulnerable dependency. |
VulnerablePackage
Represents a vulnerable package. Used in vulnerability dependency data.
Fields
Name | Type | Description |
---|---|---|
name
| String
| The name of the vulnerable package. |
VulnerableProjectsByGrade
Represents vulnerability letter grades with associated projects.
Fields
Name | Type | Description |
---|---|---|
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) |
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.
Value | Description |
---|---|
DEVELOPER
| Developer access. |
GUEST
| Guest access. |
MAINTAINER
| Maintainer access. |
MINIMAL_ACCESS
| Minimal access. |
NO_ACCESS
| No access. |
OWNER
| Owner access. |
REPORTER
| Reporter access. |
AlertManagementAlertSort
Values for sorting alerts.
AlertManagementDomainFilter
Filters the alerts based on given domain.
Value | Description |
---|---|
operations
| Alerts for operations domain. |
threat_monitoring
| Alerts for threat monitoring domain. |
AlertManagementIntegrationType
Values of types of integrations.
Value | Description |
---|---|
HTTP
| Integration with any monitoring tool. |
PROMETHEUS
| Prometheus integration. |
AlertManagementPayloadAlertFieldName
Values for alert field names used in the custom mapping.
AlertManagementPayloadAlertFieldType
Values for alert field types used in the custom mapping.
Value | Description |
---|---|
ARRAY
| Array field type. |
DATETIME
| DateTime field type. |
STRING
| String field type. |
AlertManagementSeverity
Alert severity values.
Value | Description |
---|---|
CRITICAL
| Critical severity. |
HIGH
| High severity. |
INFO
| Info severity. |
LOW
| Low severity. |
MEDIUM
| Medium severity. |
UNKNOWN
| Unknown severity. |
AlertManagementStatus
Alert status values.
ApiFuzzingScanMode
All possible ways to specify the API surface for an API fuzzing scan.
Value | Description |
---|---|
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.
Value | Description |
---|---|
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.
Value | Description |
---|---|
ANY
| An assignee is assigned. |
NONE
| No assignee is assigned. |
AvailabilityEnum
User availability status.
Value | Description |
---|---|
BUSY
| Busy. |
NOT_SET
| Not Set. |
BlobViewersType
Types of blob viewers.
Value | Description |
---|---|
auxiliary
| Auxiliary blob viewers type. |
rich
| Rich blob viewers type. |
simple
| Simple blob viewers type. |
CiConfigStatus
Values for YAML processor result.
Value | Description |
---|---|
INVALID
| The configuration file is not valid. |
VALID
| The configuration file is valid. |
CiJobStatus
CiRunnerAccessLevel
Value | Description |
---|---|
NOT_PROTECTED
| A runner that is not protected. |
REF_PROTECTED
| A runner that is ref protected. |
CiRunnerSort
Values for sorting runners.
CiRunnerStatus
Value | Description |
---|---|
ACTIVE
| A runner that is active. |
NOT_CONNECTED
| A runner that is not connected. |
OFFLINE
| A runner that is offline. |
ONLINE
| A runner that is online. |
PAUSED
| A runner that is paused. |
CiRunnerType
Value | Description |
---|---|
GROUP_TYPE
| A runner that is group type. |
INSTANCE_TYPE
| A runner that is instance type. |
PROJECT_TYPE
| A runner that is project type. |
CodeQualityDegradationSeverity
CommitActionMode
Mode of a commit action.
Value | Description |
---|---|
CHMOD
| Chmod command. |
CREATE
| Create command. |
DELETE
| Delete command. |
MOVE
| Move command. |
UPDATE
| Update command. |
CommitEncoding
Value | Description |
---|---|
BASE64
| Base64 encoding. |
TEXT
| Text encoding. |
ConanMetadatumFileTypeEnum
Conan file types.
Value | Description |
---|---|
PACKAGE_FILE
| A package file type. |
RECIPE_FILE
| A recipe file type. |
ContainerExpirationPolicyCadenceEnum
Value | Description |
---|---|
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
ContainerExpirationPolicyOlderThanEnum
ContainerRepositoryCleanupStatus
Status of the tags cleanup of a container repository.
ContainerRepositorySort
Values for sorting container repositories.
ContainerRepositoryStatus
Status of a container repository.
Value | Description |
---|---|
DELETE_FAILED
| Delete Failed status. |
DELETE_SCHEDULED
| Delete Scheduled status. |
DastScanTypeEnum
Value | Description |
---|---|
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
DastSiteValidationStrategyEnum
Value | Description |
---|---|
HEADER
| Header validation. |
TEXT_FILE
| Text file validation. |
DastTargetTypeEnum
Value | Description |
---|---|
API
| API target. |
WEBSITE
| Website target. |
DataVisualizationColorEnum
Color of the data visualization palette.
Value | Description |
---|---|
AQUA
| Aqua color. |
BLUE
| Blue color. |
GREEN
| Green color. |
MAGENTA
| Magenta color. |
ORANGE
| Orange color. |
DataVisualizationWeightEnum
Weight of the data visualization palette.
DesignCollectionCopyState
Copy state of a DesignCollection.
Value | Description |
---|---|
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.
Value | Description |
---|---|
CREATION
| A creation event. |
DELETION
| A deletion event. |
MODIFICATION
| A modification event. |
NONE
| No change. |
DiffPositionType
Type of file the position refers to.
Value | Description |
---|---|
image
| An image. |
text
| A text file. |
EntryType
Type of a tree entry.
Value | Description |
---|---|
blob
| File tree type. |
commit
| Commit tree type. |
tree
| Directory tree type. |
EpicSort
Roadmap sort values.
EpicState
State of an epic.
Value | Description |
---|---|
all
| All epics. |
closed
| Closed epics. |
opened
| Open epics. |
EpicStateEvent
State event of an epic.
Value | Description |
---|---|
CLOSE
| Close the epic. |
REOPEN
| Reopen the epic. |
EpicWildcardId
Epic ID wildcard values.
Value | Description |
---|---|
ANY
| Any epic is assigned. |
NONE
| No epic is assigned. |
EscalationRuleStatus
Escalation rule statuses.
Value | Description |
---|---|
ACKNOWLEDGED
| . |
RESOLVED
| . |
EventAction
Event action.
GroupMemberRelation
Group member relation.
Value | Description |
---|---|
DESCENDANTS
| Members in the group’s subgroups. |
DIRECT
| Members in the group itself. |
INHERITED
| Members in the group’s ancestor groups. |
HealthStatus
Health status of an issue or epic.
Value | Description |
---|---|
atRisk
| |
needsAttention
| |
onTrack
|
IssuableSeverity
Incident severity.
Value | Description |
---|---|
CRITICAL
| Critical severity. |
HIGH
| High severity. |
LOW
| Low severity. |
MEDIUM
| Medium severity. |
UNKNOWN
| Unknown severity. |
IssuableState
State of a GitLab issue or merge request.
Value | Description |
---|---|
all
| All available. |
closed
| In closed state. |
locked
| Discussion has been locked. |
opened
| In open state. |
IssueSort
Values for sorting issues.
IssueState
State of a GitLab issue.
Value | Description |
---|---|
all
| All available. |
closed
| In closed state. |
locked
| Discussion has been locked. |
opened
| In open state. |
IssueStateEvent
Values for issue state events.
Value | Description |
---|---|
CLOSE
| Closes the issue. |
REOPEN
| Reopens the issue. |
IssueType
Issue type.
Value | Description |
---|---|
INCIDENT
| Incident issue type. |
ISSUE
| Issue issue type. |
REQUIREMENT
| Requirement issue type. |
TEST_CASE
| Test Case issue type. |
IterationState
State of a GitLab iteration.
Value | Description |
---|---|
all
| |
closed
| |
current
| |
opened
| |
started
| Deprecated in 14.1. Use current instead. |
upcoming
|
IterationWildcardId
Iteration ID wildcard values.
Value | Description |
---|---|
ANY
| An iteration is assigned. |
CURRENT
| Current iteration. |
NONE
| No iteration is assigned. |
JobArtifactFileType
ListLimitMetric
List limit metric setting.
Value | Description |
---|---|
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. |
MeasurementIdentifier
Possible identifier types for a measurement.
MergeRequestNewState
New state to apply to a merge request.
Value | Description |
---|---|
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.
Value | Description |
---|---|
REVIEWED
| The merge request is reviewed. |
UNREVIEWED
| The merge request is unreviewed. |
MergeRequestSort
Values for sorting merge requests.
MergeRequestState
State of a GitLab merge request.
Value | Description |
---|---|
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.
MergeStrategyEnum
MilestoneStateEnum
Current state of milestone.
Value | Description |
---|---|
active
| Milestone is currently active. |
closed
| Milestone is closed. |
MoveType
The position to which the adjacent object should be moved.
Value | Description |
---|---|
after
| The adjacent object will be moved after the object that is being moved. |
before
| The adjacent object will be moved before the object that is being moved. |
MutationOperationMode
Different toggles for changing mutator behavior.
Value | Description |
---|---|
APPEND
| Performs an append operation. |
REMOVE
| Performs a removal operation. |
REPLACE
| Performs a replace operation. |
NamespaceProjectSort
Values for sorting projects.
Value | Description |
---|---|
SIMILARITY
| Most similar to the search query. |
STORAGE
| Sort by storage size. |
NegatedIterationWildcardId
Negated Iteration ID wildcard values.
Value | Description |
---|---|
CURRENT
| Current iteration. |
OncallRotationUnitEnum
Rotation length unit of an on-call rotation.
Value | Description |
---|---|
DAYS
| Days. |
HOURS
| Hours. |
WEEKS
| Weeks. |
PackageGroupSort
Values for sorting group packages.
PackageSort
Values for sorting package.
PackageStatus
Value | Description |
---|---|
DEFAULT
| Packages with a default status. |
ERROR
| Packages with a error status. |
HIDDEN
| Packages with a hidden status. |
PROCESSING
| Packages with a processing status. |
PackageTypeEnum
PipelineConfigSourceEnum
PipelineStatusEnum
ProjectMemberRelation
Project member relation.
Value | Description |
---|---|
DESCENDANTS
| Descendants members. |
DIRECT
| Direct members. |
INHERITED
| Inherited members. |
INVITED_GROUPS
| Invited Groups members. |
RegistryState
State of a Geo registry.
Value | Description |
---|---|
FAILED
| Registry that failed to sync. |
PENDING
| Registry waiting to be synced. |
STARTED
| Registry currently syncing. |
SYNCED
| Registry that is synced. |
ReleaseAssetLinkType
Type of the link: other
, runbook
, image
, package
.
Value | Description |
---|---|
IMAGE
| Image link type. |
OTHER
| Other link type. |
PACKAGE
| Package link type. |
RUNBOOK
| Runbook link type. |
ReleaseSort
Values for sorting releases.
Value | Description |
---|---|
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. |
RequirementState
State of a requirement.
Value | Description |
---|---|
ARCHIVED
| |
OPENED
|
RequirementStatusFilter
Status of a requirement based on last test report.
Value | Description |
---|---|
FAILED
| |
MISSING
| Requirements without any test report. |
PASSED
|
SastUiComponentSize
Size of UI component in SAST configuration page.
SecurityReportTypeEnum
SecurityScannerType
The type of the security scanner.
Value | Description |
---|---|
API_FUZZING
| |
CONTAINER_SCANNING
| |
COVERAGE_FUZZING
| |
DAST
| |
DEPENDENCY_SCANNING
| |
SAST
| |
SECRET_DETECTION
|
SentryErrorStatus
State of a Sentry error.
Value | Description |
---|---|
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
SnippetBlobActionEnum
Type of a snippet blob input action.
Value | Description |
---|---|
create
| Create a snippet blob. |
delete
| Delete a snippet blob. |
move
| Move a snippet blob. |
update
| Update a snippet blob. |
Sort
Common sort values.
TestCaseStatus
TestReportState
State of a test report.
Value | Description |
---|---|
FAILED
| |
PASSED
|
TodoActionEnum
TodoStateEnum
Value | Description |
---|---|
done
| The state of the todo is done. |
pending
| The state of the todo is pending. |
TodoTargetEnum
Value | Description |
---|---|
ALERT
| An Alert. |
COMMIT
| A Commit. |
DESIGN
| A Design. |
EPIC
| An Epic. |
ISSUE
| An Issue. |
MERGEREQUEST
| A MergeRequest. |
TypeEnum
Value | Description |
---|---|
personal
| Snippet created independent of any project. |
project
| Snippet related to a specific project. |
UserCalloutFeatureNameEnum
Name of the feature that the callout is for.
UserState
Possible states of a user.
VisibilityLevelsEnum
Value | Description |
---|---|
internal
| Internal visibility level. |
private
| Private visibility level. |
public
| Public visibility level. |
VisibilityScopesEnum
VulnerabilityDismissalReason
The dismissal reason of the Vulnerability.
VulnerabilityExternalIssueLinkExternalTracker
The external tracker of the external issue link related to a vulnerability.
Value | Description |
---|---|
JIRA
| Jira external tracker. |
VulnerabilityExternalIssueLinkType
The type of the external issue link related to a vulnerability.
Value | Description |
---|---|
CREATED
| Created link type. |
VulnerabilityGrade
The grade of the vulnerable project.
Value | Description |
---|---|
A
| |
B
| |
C
| |
D
| |
F
|
VulnerabilityIssueLinkType
The type of the issue link related to a vulnerability.
Value | Description |
---|---|
CREATED
| |
RELATED
|
VulnerabilityReportType
The type of the security scan that found the vulnerability.
Value | Description |
---|---|
API_FUZZING
| |
CONTAINER_SCANNING
| |
COVERAGE_FUZZING
| |
DAST
| |
DEPENDENCY_SCANNING
| |
SAST
| |
SECRET_DETECTION
|
VulnerabilitySeverity
The severity of the vulnerability.
Value | Description |
---|---|
CRITICAL
| |
HIGH
| |
INFO
| |
LOW
| |
MEDIUM
| |
UNKNOWN
|
VulnerabilitySort
Vulnerability sort values.
VulnerabilityState
The state of the vulnerability.
Value | Description |
---|---|
CONFIRMED
| |
DETECTED
| |
DISMISSED
| |
RESOLVED
|
WeightWildcardId
Weight ID wildcard values.
Value | Description |
---|---|
ANY
| Weight is assigned. |
NONE
| No weight is assigned. |
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
.
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"
.
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"
.
CiPipelineID
A CiPipelineID
is a global ID. It is encoded as a string.
An example CiPipelineID
is: "gid://gitlab/Ci::Pipeline/1"
.
CiRunnerID
A CiRunnerID
is a global ID. It is encoded as a string.
An example CiRunnerID
is: "gid://gitlab/Ci::Runner/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"
.
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"
.
DastProfileID
A DastProfileID
is a global ID. It is encoded as a string.
An example DastProfileID
is: "gid://gitlab/Dast::Profile/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.
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.
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.
GitlabErrorTrackingDetailedErrorID
A GitlabErrorTrackingDetailedErrorID
is a global ID. It is encoded as a string.
An example GitlabErrorTrackingDetailedErrorID
is: "gid://gitlab/Gitlab::ErrorTracking::DetailedError/1"
.
GlobalID
A global identifier.
A global identifier represents an object uniquely across the application.
An example of such an identifier is "gid://gitlab/User/1"
.
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"
.
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"
.
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"
.
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"
.
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"
.
PackagesMavenMetadatumID
A PackagesMavenMetadatumID
is a global ID. It is encoded as a string.
An example PackagesMavenMetadatumID
is: "gid://gitlab/Packages::Maven::Metadatum/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"
.
ReleasesLinkID
A ReleasesLinkID
is a global ID. It is encoded as a string.
An example ReleasesLinkID
is: "gid://gitlab/Releases::Link/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.
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
.
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
UserID
A UserID
is a global ID. It is encoded as a string.
An example UserID
is: "gid://gitlab/User/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"
.
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 mayimplement
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
Issuable
Represents an issuable.
One of:
PackageMetadata
Represents metadata associated with a Package.
One of:
VulnerabilityDetail
Represents a vulnerability detail field. The fields with data will depend on the vulnerability detail type.
One of:
VulnerabilityDetailBase
VulnerabilityDetailBoolean
VulnerabilityDetailCode
VulnerabilityDetailCommit
VulnerabilityDetailDiff
VulnerabilityDetailFileLocation
VulnerabilityDetailInt
VulnerabilityDetailList
VulnerabilityDetailMarkdown
VulnerabilityDetailModuleLocation
VulnerabilityDetailTable
VulnerabilityDetailText
VulnerabilityDetailUrl
VulnerabilityLocation
Represents a vulnerability location. The fields with data will depend on the vulnerability report type.
One of:
VulnerabilityLocationContainerScanning
VulnerabilityLocationCoverageFuzzing
VulnerabilityLocationDast
VulnerabilityLocationDependencyScanning
VulnerabilityLocationSast
VulnerabilityLocationSecretDetection
Interfaces
AlertManagementIntegration
Implementations:
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the endpoint is currently accepting alerts. |
apiUrl
| String
| URL at which Prometheus metrics can be queried to populate the metrics dashboard. |
id
| ID!
| ID of the integration. |
name
| String
| Name of the integration. |
token
| String
| Token used to authenticate alert notification requests. |
type
| AlertManagementIntegrationType!
| Type of integration. |
url
| String
| Endpoint which accepts alert notifications. |
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
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
DesignFields
Implementations:
Fields
Name | Type | Description |
---|---|---|
diffRefs
| DiffRefs!
| The diff refs for this design. |
event
| DesignVersionEvent!
| How this design was changed in the current version. |
filename
| String!
| The filename of the design. |
fullPath
| String!
| The full path to the design file. |
id
| ID!
| The ID of this design. |
image
| String!
| The URL of the full-sized image. |
imageV432x230
| String
| The 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!
| The issue the design belongs to. |
notesCount
| Int!
| The total count of user-created notes for this design. |
project
| Project!
| The project the design belongs to. |
Entry
Implementations:
Fields
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
events
| EventConnection
| A list of events associated with the object. (see Connections) |
MemberInterface
Implementations:
Fields
Name | Type | Description |
---|---|---|
accessLevel
| AccessLevel
| GitLab::Access level. |
createdAt
| Time
| Date and time the membership was created. |
createdBy
| UserCore
| User that authorized membership. |
expiresAt
| Time
| Date and time the membership expires. |
id
| ID!
| ID of the member. |
updatedAt
| Time
| Date and time the membership was last updated. |
user
| UserCore
| User that is associated with the member object. |
Noteable
Implementations:
Fields
Name | Type | Description |
---|---|---|
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
notes
| NoteConnection!
| All notes on this noteable. (see Connections) |
PackageFileMetadata
Represents metadata associated with a Package file.
Implementations:
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Date of creation. |
updatedAt
| Time!
| Date of most recent update. |
ResolvableInterface
Implementations:
Fields
Name | Type | Description |
---|---|---|
resolvable
| Boolean!
| Indicates if the object can be resolved. |
resolved
| Boolean!
| Indicates if the object is resolved. |
resolvedAt
| Time
| Timestamp of when the object was resolved. |
resolvedBy
| UserCore
| User who resolved the object. |
Service
Implementations:
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Indicates if the service is active. |
type
| String
| Class name of the service. |
TimeboxReportInterface
Implementations:
Fields
Name | Type | Description |
---|---|---|
report
| TimeboxReport
| Historically accurate report about the timebox. |
User
Representation of a GitLab user.
Implementations:
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
email
| String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
location
| String
| The location of the user. |
name
| String!
| Human-readable name of the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
publicEmail
| String
| User’s public email. |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
reviewerUsername
| String
| Username of the reviewer. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
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
| Time
| Merge requests merged after this date. |
mergedBefore
| Time
| Merge requests merged before this date. |
milestoneTitle
| String
| Title of the milestone. |
not
| MergeRequestsResolverNegatedParams
| List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
projectId
| ProjectID
| The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
projectPath
| String
| The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
sort
| MergeRequestSort
| Sort 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
| MergeRequestState
| A merge 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. |
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
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| The type of snippet. |
visibility
| VisibilityScopesEnum
| The visibility 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
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
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
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| The action to be filtered. |
authorId
| [ID!]
| The ID of an author. |
groupId
| [ID!]
| The ID of a group. |
projectId
| [ID!]
| The ID of a project. |
state
| [TodoStateEnum!]
| The state of the todo. |
type
| [TodoTargetEnum!]
| The type of the todo. |
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.
AlertManagementPayloadAlertFieldInput
Field that are available while modifying the custom mapping attributes for an HTTP integration.
Arguments
Name | Type | Description |
---|---|---|
fieldName
| AlertManagementPayloadAlertFieldName!
| A GitLab alert field name. |
label
| String
| Human-readable label of the payload path. |
path
| [PayloadAlertFieldPathSegment!]!
| Path to value inside payload JSON. |
type
| AlertManagementPayloadAlertFieldType!
| Type of the parsed value. |
BoardIssueInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsername
| [String]
| Filter by assignee username. |
assigneeWildcardId
| AssigneeWildcardId
| Filter by assignee wildcard. Incompatible with assigneeUsername. |
authorUsername
| String
| Filter by author username. |
epicId
| EpicID
| Filter by epic ID. Incompatible with epicWildcardId. |
epicWildcardId
| EpicWildcardId
| Filter by epic ID wildcard. Incompatible with epicId. |
iids
| [String!]
| List of IIDs of issues. For example ["1", "2"] .
|
iterationId
| [IterationID!]
| Filter by a list of iteration IDs. Incompatible with iterationWildcardId. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Filter by label name. |
milestoneTitle
| String
| Filter by milestone title. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedBoardIssueInput
| List of negated arguments. |
releaseTag
| String
| Filter by release tag. |
search
| String
| Search query for issue title or description. |
weight
| String
| Filter by weight. |
weightWildcardId
| WeightWildcardId
| Filter by weight ID wildcard. Incompatible with weight. |
CommitAction
Arguments
Name | Type | Description |
---|---|---|
action
| CommitActionMode!
| The action to perform, create, delete, move, update, chmod. |
content
| String
| Content of the file. |
encoding
| CommitEncoding
| Encoding of the file. Default is text. |
executeFilemode
| Boolean
| Enables/disables the execute flag on the file. |
filePath
| String!
| Full path to the file. |
lastCommitId
| String
| Last known file commit ID. |
previousPath
| String
| Original full path to the file being moved. |
ComplianceFrameworkInput
Arguments
Name | Type | Description |
---|---|---|
color
| String
| New color representation of the compliance framework in hex format. e.g. #FCA121. |
description
| String
| New description for the compliance framework. |
name
| String
| New name for the compliance framework. |
pipelineConfigurationFullPath
| String
| Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa .
|
DastSiteProfileAuthInput
Input type for DastSiteProfile authentication.
Arguments
Name | Type | Description |
---|---|---|
enabled
| Boolean
| Indicates whether authentication is enabled. |
password
| String
| The password to authenticate with on the target website. |
passwordField
| String
| The name of password field at the sign-in HTML form. |
url
| String
| The URL of the page containing the sign-in HTML form on the target website. |
username
| String
| The username to authenticate with on the target website. |
usernameField
| String
| The name of username field at the sign-in HTML form. |
DiffImagePositionInput
Arguments
Name | Type | Description |
---|---|---|
baseSha
| String
| Merge 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
Name | Type | Description |
---|---|---|
newPath
| String
| The path of the file on the head sha. |
oldPath
| String
| The path of the file on the start sha. |
DiffPositionInput
Arguments
Name | Type | Description |
---|---|---|
baseSha
| String
| Merge base of the branch the comment was made on. |
headSha
| String!
| SHA of the HEAD at the time the comment was made. |
newLine
| Int
| Line on HEAD SHA that was changed. |
oldLine
| Int
| Line on start SHA that was changed. |
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
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter by author username. |
labelName
| [String]
| Filter by label name. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedEpicBoardIssueInput
| Negated epic arguments. |
search
| String
| Search query for epic title or description. |
EpicTreeNodeFieldsInputType
A node of an epic tree.
Arguments
Name | Type | Description |
---|---|---|
adjacentReferenceId
| EpicTreeSortingID
| The ID of the epic_issue or issue that the actual epic or issue is switched with. |
id
| EpicTreeSortingID!
| The ID of the epic_issue or epic that is being moved. |
newParentId
| EpicID
| ID of the new parent epic. |
relativePosition
| MoveType
| The type of the switch, after or before allowed. |
EscalationRuleInput
Represents an escalation rule.
Arguments
Name | Type | Description |
---|---|---|
elapsedTimeSeconds
| Int!
| The time in seconds before the rule is activated. |
oncallScheduleIid
| ID!
| The on-call schedule to notify. |
status
| EscalationRuleStatus!
| The status required to prevent the rule from activating. |
JiraUsersMappingInputType
Arguments
Name | Type | Description |
---|---|---|
gitlabId
| Int
| ID of the GitLab user. |
jiraAccountId
| String!
| Jira account ID of the user. |
MergeRequestsResolverNegatedParams
Arguments
Name | Type | Description |
---|---|---|
labels
| [String!]
| Array of label names. All resolved merge requests will not have these labels. |
milestoneTitle
| String
| Title of the milestone. |
NegatedBoardIssueInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsername
| [String]
| Filter by assignee username. |
authorUsername
| String
| Filter by author username. |
epicId
| EpicID
| Filter by epic ID. Incompatible with epicWildcardId. |
iids
| [String!]
| List of IIDs of issues. For example ["1", "2"] .
|
iterationId
| [IterationID!]
| Filter by a list of iteration IDs. Incompatible with iterationWildcardId. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| NegatedIterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Filter by label name. |
milestoneTitle
| String
| Filter by milestone title. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
releaseTag
| String
| Filter by release tag. |
weight
| String
| Filter by weight. |
NegatedEpicBoardIssueInput
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter by author username. |
labelName
| [String]
| Filter by label name. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
NegatedEpicFilterInput
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter by author username. |
labelName
| [String]
| Filter by label name. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
NegatedIssueFilterInput
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user not assigned to the issues. |
assigneeUsernames
| [String!]
| Usernames of users not assigned to the issue. |
epicId
| String
| ID of an epic not associated with the issues. |
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
| IterationWildcardId
| Filter by negated iteration ID wildcard. |
labelName
| [String!]
| Labels not applied to this issue. |
milestoneTitle
| [String!]
| Milestone not applied to this issue. |
weight
| String
| Weight not applied to the issue. |
OncallRotationActivePeriodInputType
Active period time range for on-call rotation.
Arguments
Name | Type | Description |
---|---|---|
endTime
| String!
| The end of the rotation active period in 24 hour format, for example “18:30”. |
startTime
| String!
| The start of the rotation active period in 24 hour format, for example “18:30”. |
OncallRotationDateInputType
Date input type for on-call rotation.
Arguments
Name | Type | Description |
---|---|---|
date
| String!
| The date component of the date in YYYY-MM-DD format. |
time
| String!
| The time component of the date in 24hr HH:MM format. |
OncallRotationLengthInputType
The rotation length of the on-call rotation.
Arguments
Name | Type | Description |
---|---|---|
length
| Int!
| The rotation length of the on-call rotation. |
unit
| OncallRotationUnitEnum!
| The unit of the rotation length of the on-call rotation. |
OncallUserInputType
The rotation user and color palette.
Arguments
Name | Type | Description |
---|---|---|
colorPalette
| DataVisualizationColorEnum
| A value of DataVisualizationColorEnum. The color from the palette to assign to the on-call user. |
colorWeight
| DataVisualizationWeightEnum
| A value of DataVisualizationWeightEnum. The color weight to assign to for the on-call user. Note: 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!
| The username of the user to participate in the on-call rotation, such as user_one .
|
ReleaseAssetLinkInput
Fields that are available when modifying a release asset link.
Arguments
Name | Type | Description |
---|---|---|
directAssetPath
| String
| Relative path for a direct asset link. |
linkType
| ReleaseAssetLinkType
| The type 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
Name | Type | Description |
---|---|---|
links
| [ReleaseAssetLinkInput!]
| A list of asset links to associate to the release. |
SastCiConfigurationAnalyzersEntityInput
Represents the analyzers entity in SAST CI configuration.
Arguments
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
action
| SnippetBlobActionEnum!
| Type of input action. |
content
| String
| Snippet file content. |
filePath
| String!
| Path of the snippet file. |
previousPath
| String
| Previous path of the snippet file. |
Timeframe
A time-frame defined as a closed inclusive range of two dates.
Arguments
Name | Type | Description |
---|---|---|
end
| Date!
| The end of the range. |
start
| Date!
| The start of the range. |
UpdateDiffImagePositionInput
Arguments
Name | Type | Description |
---|---|---|
height
| Int
| Total height of the image. |
width
| Int
| Total width of the image. |
x
| Int
| X position of the note. |
y
| Int
| Y position of the note. |