GraphQL API resources
This documentation is self-generated based on GitLab current GraphQL schema.
The API can be explored using the interactive GraphQL explorer.
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.abuseReport
Find an abuse report.
Returns AbuseReport
.
Arguments
Name | Type | Description |
---|---|---|
id
| AbuseReportID!
| ID of the abuse report. |
Query.abuseReportLabels
Abuse report labels.
Returns LabelConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
searchTerm
| String
| Search term to find labels with. |
Query.addOnPurchase
Retrieve the active add-on purchase. This query can be used in GitLab SaaS and self-managed environments.
Returns AddOnPurchase
.
Arguments
Name | Type | Description |
---|---|---|
addOnType
| GitlabSubscriptionsAddOnType!
| Type of add-on for the add-on purchase. |
namespaceId
| NamespaceID
| ID of namespace that the add-on was purchased for. |
Query.aiMessages
Find GitLab Duo Chat messages.
Returns AiMessageConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
requestIds
| [ID!]
| Array of request IDs to fetch. |
roles
| [AiMessageRole!]
| Array of roles to fetch. |
Query.auditEventDefinitions
Definitions for all audit events available on the instance.
Returns AuditEventDefinitionConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.auditEventsInstanceAmazonS3Configurations
Instance-level Amazon S3 configurations for audit events.
Returns InstanceAmazonS3ConfigurationTypeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.boardList
Find an issue board list.
Returns BoardList
.
Arguments
Name | Type | Description |
---|---|---|
id
| ListID!
| Global ID of the list. |
issueFilters
| BoardIssueInput
| Filters applied when getting issue metadata in the board list. |
Query.ciApplicationSettings
CI related settings that apply to the entire instance.
Returns CiApplicationSettings
.
Query.ciCatalogResource
A single CI/CD Catalog resource visible to an authorized user.
Returns CiCatalogResource
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| ID
| CI/CD Catalog resource full path. |
id
| CiCatalogResourceID
| CI/CD Catalog resource global ID. |
Query.ciCatalogResources
All CI/CD Catalog resources under a common namespace, visible to an authorized user.
Returns CiCatalogResourceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
projectPath
| ID
| Project with the namespace catalog. |
scope
| CiCatalogResourceScope
| Scope of the returned catalog resources. |
search
| String
| Search term to filter the catalog resources by name or description. |
sort
| CiCatalogResourceSort
| Sort catalog resources by given criteria. |
Query.ciConfig
Linted and processed contents of a CI config. Should not be requested more than once per request.
Returns CiConfig
.
Arguments
Name | Type | Description |
---|---|---|
content
| String!
| Contents of .gitlab-ci.yml .
|
dryRun
| Boolean
| Run pipeline creation simulation, or only do static check. |
projectPath
| ID!
| Project of the CI config. |
sha
| String
| Sha for the pipeline. |
skipVerifyProjectSha | Boolean
|
Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. If the provided sha is found in the project’s repository but is not associated with a Git reference (a detached commit), the verification fails and a validation error is returned. Otherwise, verification passes, even if the sha is invalid. Set to true to skip this verification process.
|
Query.ciMinutesUsage
Compute usage data for a namespace.
Returns CiMinutesNamespaceMonthlyUsageConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
date
| Date
| Date for which to retrieve the usage data, should be the first day of a month. |
namespaceId
| NamespaceID
| Global ID of the Namespace for the monthly compute usage. |
Query.ciPipelineStage
Stage belonging to a CI pipeline.
Returns CiStage
.
Arguments
Name | Type | Description |
---|---|---|
id
| CiStageID!
| Global ID of the CI stage. |
Query.ciQueueingHistory
Time it took for ci job to be picked up by runner in percentiles.
Returns QueueingDelayHistory
.
Arguments
Name | Type | Description |
---|---|---|
fromTime
| Time
| Start of the requested time frame. Defaults to 3 hours ago. |
runnerType
| CiRunnerType
| Filter jobs by the type of runner that executed them. |
toTime
| Time
| End of the requested time frame. Defaults to current time. |
Query.ciVariables
List of the instance’s CI/CD variables.
Returns CiInstanceVariableConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
sort
| CiVariableSort
| Sort order of results. |
Query.containerRepository
Find a container repository.
Returns ContainerRepositoryDetails
.
Arguments
Name | Type | Description |
---|---|---|
id
| ContainerRepositoryID!
| Global ID of the container repository. |
Query.currentLicense
Fields related to the current license.
Returns CurrentLicense
.
Query.currentUser
Get information about current user.
Returns CurrentUser
.
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
displayNamespaceId
| NamespaceID
| Filter by display namespace. |
Query.echo
Testing endpoint to validate the API with.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
text
| String!
| Text to echo back. |
Query.epicBoardList
Returns EpicList
.
Arguments
Name | Type | Description |
---|---|---|
epicFilters
| EpicFilters
| Filters applied when getting epic metadata in the epic board list. |
id
| BoardsEpicListID!
| Global ID of the list. |
Query.explainVulnerabilityPrompt
GitLab Duo Vulnerability summary prompt for a specified vulnerability.
Returns ExplainVulnerabilityPrompt
.
Arguments
Name | Type | Description |
---|---|---|
vulnerabilityId
| VulnerabilityID!
| Vulnerability to generate a prompt for. |
Query.frecentGroups
A user’s frecently visited groups.
Returns [Group!]
.
Query.frecentProjects
A user’s frecently visited projects.
Returns [Project!]
.
Query.geoNode
Find a Geo node.
Returns GeoNode
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| Name of the Geo node. Defaults to the current Geo node name. |
Query.gitpodEnabled
Whether Gitpod is enabled in application settings.
Returns Boolean
.
Query.group
Find a group.
Returns Group
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| ID!
| Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss .
|
Query.groups
Find groups.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query for group name or group full path. |
Query.instanceExternalAuditEventDestinations
Instance level external audit event destinations.
Returns InstanceExternalAuditEventDestinationConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.instanceGoogleCloudLoggingConfigurations
Instance level google cloud logging configurations.
Returns InstanceGoogleCloudLoggingConfigurationTypeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.instanceSecurityDashboard
Fields related to Instance Security Dashboard.
Returns InstanceSecurityDashboard
.
Query.issue
Find an issue.
Returns Issue
.
Arguments
Name | Type | Description |
---|---|---|
id
| IssueID!
| Global ID of the issue. |
Query.issues
Find issues visible to the current user. At least one filter must be provided.
Returns IssueConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported. |
assigneeUsername | String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
assigneeWildcardId
| AssigneeWildcardId
| Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
confidential
| Boolean
| Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
crmContactId
| String
| ID of a contact assigned to the issues. |
crmOrganizationId
| String
| ID of an organization assigned to the issues. |
epicId
| String
| ID of an epic associated with the issues, “none” and “any” values are supported. |
epicWildcardId
| EpicWildcardId
| Filter by epic ID wildcard. Incompatible with epicId. |
healthStatusFilter
| HealthStatusFilter
| Health status of the issue, “none” and “any” values are supported. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
includeArchived
| Boolean
| Whether to include issues from archived projects. Defaults to false .
|
includeSubepics
| Boolean
| Whether to include subepics when filtering issues by epicId. |
iterationCadenceId
| [IterationsCadenceID!]
| Filter by a list of iteration cadence IDs. |
iterationId
| [ID]
| List of iteration Global IDs applied to the issue. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
milestoneWildcardId
| MilestoneWildcardId
| Filter issues by milestone ID wildcard. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported. |
not
| NegatedIssueFilterInput
| Negated arguments. |
or
| UnionedIssueFilterInput
| List of arguments with inclusive OR. |
search
| String
| Search query for title or description. |
sort
| IssueSort
| Sort issues by this criteria. |
state
| IssuableState
| Current state of this issue. |
types
| [IssueType!]
| Filter issues by the given issue types. |
updatedAfter
| Time
| Issues updated after this date. |
updatedBefore
| Time
| Issues updated before this date. |
weight
| String
| Weight applied to the issue, “none” and “any” values are supported. |
weightWildcardId
| WeightWildcardId
| Filter by weight ID wildcard. Incompatible with weight. |
Query.iteration
Find an iteration.
Returns Iteration
.
Arguments
Name | Type | Description |
---|---|---|
id
| IterationID!
| Find an iteration by its ID. |
Query.jobs
All jobs on this GitLab instance.
Returns CiJobConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
failureReason | CiJobFailureReason
|
Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Filter jobs by failure reason. Currently only RUNNER_SYSTEM_FAILURE together with runnerTypes: INSTANCE_TYPE is supported.
|
runnerTypes | [CiRunnerType!]
|
Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Filter jobs by runner type if feature flag :admin_jobs_filter_runner_type is enabled.
|
statuses
| [CiJobStatus!]
| Filter jobs by status. |
Query.licenseHistoryEntries
Fields related to entries in the license history.
Returns LicenseHistoryEntryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.memberRole
Finds a single custom role.
Returns MemberRole
.
Arguments
Name | Type | Description |
---|---|---|
id
| MemberRoleID
| Global ID of the member role to look up. |
Query.memberRolePermissions
List of all customizable permissions.
Returns CustomizablePermissionConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.mergeRequest
Find a merge request.
Returns MergeRequest
.
Arguments
Name | Type | Description |
---|---|---|
id
| MergeRequestID!
| Global ID of the merge request. |
Query.metadata
Metadata about GitLab.
Returns Metadata
.
Query.milestone
Find a milestone.
Returns Milestone
.
Arguments
Name | Type | Description |
---|---|---|
id
| MilestoneID!
| Find a milestone by its ID. |
Query.mlModel
Find machine learning models.
Returns MlModel
.
Arguments
Name | Type | Description |
---|---|---|
id
| MlModelID!
| ID of the model. |
Query.namespace
Find a namespace.
Returns Namespace
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| ID!
| Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss .
|
Query.note
Find a note.
Returns Note
.
Arguments
Name | Type | Description |
---|---|---|
id
| NoteID!
| Global ID of the note. |
Query.organization
Find an organization.
Returns Organization
.
Arguments
Name | Type | Description |
---|---|---|
id
| OrganizationsOrganizationID!
| ID of the organization. |
Query.package
Find a package. This field can only be resolved for one query in any single request. Returns null
if a package has no default
status.
Returns PackageDetailsType
.
Arguments
Name | Type | Description |
---|---|---|
id
| PackagesPackageID!
| Global ID of the package. |
Query.project
Find a project.
Returns Project
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| ID!
| Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss .
|
Query.projects
Find projects visible to the current user.
Returns ProjectConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
fullPaths
| [String!]
| Filter projects by full paths. You cannot provide more than 50 full paths. |
ids
| [ID!]
| Filter projects by IDs. |
membership
| Boolean
| Return only projects that the current user is a member of. |
search
| String
| Search query, which can be for the project name, a path, or a description. |
searchNamespaces
| Boolean
| Include namespace in project search. |
sort
| String
| Sort order of results. Format: <field_name>_<sort_direction> , for example: id_desc or name_asc .
|
topics
| [String!]
| Filter projects by topics. |
withIssuesEnabled
| Boolean
| Return only projects with issues enabled. |
withMergeRequestsEnabled
| Boolean
| Return only projects with merge requests enabled. |
Query.queryComplexity
Information about the complexity of the GraphQL query.
Returns QueryComplexity
.
Query.runner
Find a runner.
Returns CiRunner
.
Arguments
Name | Type | Description |
---|---|---|
id
| CiRunnerID!
| Runner ID. |
Query.runnerPlatforms
Supported runner platforms.
Returns RunnerPlatformConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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
Get all runners in the GitLab instance (project and shared). Access is restricted to users with administrator access.
Returns CiRunnerConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
active | Boolean
|
Deprecated in 14.8. This was renamed. Use: paused .
|
creatorId
| UserID
| Filter runners by creator ID. |
paused
| Boolean
| Filter runners by paused (true) or active (false) status.
|
search
| String
| Filter by full token or partial text in description field. |
sort
| CiRunnerSort
| Sort order of results. |
status
| CiRunnerStatus
| Filter runners by status. |
tagList
| [String!]
| Filter by tags associated with the runner (comma-separated or array). |
type
| CiRunnerType
| Filter runners by type. |
upgradeStatus
| CiRunnerUpgradeStatus
| Filter by upgrade status. |
versionPrefix | String
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term ‘14.’ returns runner managers with versions ‘14.11.1’ and ‘14.2.3’. |
Query.selfManagedAddOnEligibleUsers
Users within the self-managed instance who are eligible for add-ons.
Returns AddOnUserConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
addOnType
| GitlabSubscriptionsAddOnType!
| Type of add on to filter the eligible users by. |
search
| String
| Search the user list. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorId
| UserID
| ID of an author. |
explore
| Boolean
| Explore personal snippets. |
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
projectId
| ProjectID
| ID of a project. |
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| Visibility of the snippet. |
Query.subscriptionFutureEntries
Fields related to entries in future subscriptions.
Returns SubscriptionFutureEntryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.syntheticNote
Find a synthetic note.
Returns Note
.
Arguments
Name | Type | Description |
---|---|---|
noteableId
| NoteableID!
| Global ID of the resource to search synthetic note on. |
sha
| String!
| Global ID of the note. |
Query.timelogs
Find timelogs visible to the current user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
Query.todo
Retrieve a single to-do item.
Returns Todo
.
Arguments
Name | Type | Description |
---|---|---|
id
| TodoID!
| ID of the to-do item. |
Query.topics
Find project topics.
Returns TopicConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query for topic name. |
Query.usageTrendsMeasurements
Get statistics on the instance.
Returns UsageTrendsMeasurementConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
identifier
| MeasurementIdentifier!
| Type of measurement or statistics to retrieve. |
recordedAfter
| Time
| Measurement recorded after this date. |
recordedBefore
| Time
| Measurement recorded before this date. |
Query.user
Find a user.
Returns UserCore
.
Arguments
Name | Type | Description |
---|---|---|
id
| UserID
| ID of the User. |
username
| String
| Username of the User. |
Query.users
Find users.
Returns UserCoreConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
clusterAgentId
| [ClustersAgentID!]
| Filter vulnerabilities by cluster_agent_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
clusterId
| [ClustersClusterID!]
| Filter vulnerabilities by cluster_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
dismissalReason
| [VulnerabilityDismissalReason!]
| Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter. |
hasIssues
| Boolean
| Returns only the vulnerabilities which have linked issues. |
hasMergeRequest
| Boolean
| Returns only the vulnerabilities which have linked merge requests. |
hasRemediations
| Boolean
| Returns only the vulnerabilities which have remediations. |
hasResolution
| Boolean
| Returns only the vulnerabilities which have been resolved on default branch. |
image
| [String!]
| Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning , cluster_image_scanning .
|
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by VulnerabilityScanner.externalId. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
sort
| VulnerabilitySort
| List vulnerabilities by sort order. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
Query.vulnerabilitiesCountByDay
The historical number of vulnerabilities per day for the projects on the current user’s instance security dashboard.
Returns VulnerabilitiesCountByDayConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| ISO8601Date!
| Last day for which to fetch vulnerability history. |
startDate
| ISO8601Date!
| First day for which to fetch vulnerability history. |
Query.vulnerability
Find a vulnerability.
Returns Vulnerability
.
Arguments
Name | Type | Description |
---|---|---|
id
| VulnerabilityID!
| Global ID of the Vulnerability. |
Query.workItem
Find a work item.
Returns WorkItem
.
Arguments
Name | Type | Description |
---|---|---|
id
| WorkItemID!
| Global ID of the work item. |
Query.workItemsByReference
Find work items by their reference.
Returns WorkItemConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
contextNamespacePath
| ID
| Full path of the context namespace (project or group). |
refs
| [String!]!
| Work item references. Can be either a short reference or URL. |
Query.workspace
Find a workspace.
Returns Workspace
.
Arguments
Name | Type | Description |
---|---|---|
id
| RemoteDevelopmentWorkspaceID!
| Find a workspace by its ID. |
Query.workspaces
Find workspaces across the entire instance. This field is only available to instance admins, it will return an empty result for all non-admins.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
userIds
| [ProjectID!]
| Filter workspaces by user GlobalIDs. |
Mutation
type
The Mutation
type contains all the mutations you can execute.
All mutations receive their arguments in a single input object named input
, and all mutations
support at least a return field errors
containing a list of error messages.
All input objects may have a clientMutationId: String
field, identifying the mutation.
For example:
mutation($id: NoteableID!, $body: String!) {
createNote(input: { noteableId: $id, body: $body }) {
errors
}
}
Mutation.abuseReportLabelCreate
Input type: AbuseReportLabelCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
color
| String
| The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB ) or one of the CSS color names.
|
title
| String!
| Title of the label. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
label
| Label
| Label after mutation. |
Mutation.achievementsAward
Input type: AchievementsAwardInput
Arguments
Name | Type | Description |
---|---|---|
achievementId
| AchievementsAchievementID!
| Global ID of the achievement being awarded. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
userId
| UserID!
| Global ID of the user being awarded the achievement. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
userAchievement
| UserAchievement
| Achievement award. |
Mutation.achievementsCreate
Input type: AchievementsCreateInput
Arguments
Name | Type | Description |
---|---|---|
avatar
| Upload
| Avatar for the achievement. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of or notes for the achievement. |
name
| String!
| Name for the achievement. |
namespaceId
| NamespaceID!
| Namespace for the achievement. |
Fields
Name | Type | Description |
---|---|---|
achievement
| Achievement
| Achievement created. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.achievementsDelete
Input type: AchievementsDeleteInput
Arguments
Name | Type | Description |
---|---|---|
achievementId
| AchievementsAchievementID!
| Global ID of the achievement being deleted. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
Fields
Name | Type | Description |
---|---|---|
achievement
| Achievement
| Achievement. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.achievementsRevoke
Input type: AchievementsRevokeInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
userAchievementId
| AchievementsUserAchievementID!
| Global ID of the user achievement being revoked. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
userAchievement
| UserAchievement
| Achievement award. |
Mutation.achievementsUpdate
Input type: AchievementsUpdateInput
Arguments
Name | Type | Description |
---|---|---|
achievementId
| AchievementsAchievementID!
| Global ID of the achievement being updated. |
avatar
| Upload
| Avatar for the achievement. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of or notes for the achievement. |
name
| String
| Name for the achievement. |
Fields
Name | Type | Description |
---|---|---|
achievement
| Achievement
| Achievement. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.addProjectToSecurityDashboard
Input type: AddProjectToSecurityDashboardInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ProjectID!
| ID of the project to be added to Instance Security Dashboard. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
project
| Project
| Project that was added to the Instance Security Dashboard. |
Mutation.adminSidekiqQueuesDeleteJobs
Input type: AdminSidekiqQueuesDeleteJobsInput
Arguments
Name | Type | Description |
---|---|---|
aiResource
| String
| Delete jobs matching ai_resource in the context metadata. |
artifactSize
| String
| Delete jobs matching artifact_size in the context metadata. |
artifactUsedCdn
| String
| Delete jobs matching artifact_used_cdn in the context metadata. |
artifactsDependenciesCount
| String
| Delete jobs matching artifacts_dependencies_count in the context metadata. |
artifactsDependenciesSize
| String
| Delete jobs matching artifacts_dependencies_size in the context metadata. |
bulkImportEntityId
| String
| Delete jobs matching bulk_import_entity_id in the context metadata. |
callerId
| String
| Delete jobs matching caller_id in the context metadata. |
clientId
| String
| Delete jobs matching client_id in the context metadata. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
featureCategory
| String
| Delete jobs matching feature_category in the context metadata. |
jobId
| String
| Delete jobs matching job_id in the context metadata. |
mergeActionStatus
| String
| Delete jobs matching merge_action_status in the context metadata. |
pipelineId
| String
| Delete jobs matching pipeline_id in the context metadata. |
project
| String
| Delete jobs matching project in the context metadata. |
queueName
| String!
| Name of the queue to delete jobs from. |
relatedClass
| String
| Delete jobs matching related_class in the context metadata. |
remoteIp
| String
| Delete jobs matching remote_ip in the context metadata. |
rootCallerId
| String
| Delete jobs matching root_caller_id in the context metadata. |
rootNamespace
| String
| Delete jobs matching root_namespace in the context metadata. |
subscriptionPlan
| String
| Delete jobs matching subscription_plan in the context metadata. |
user
| String
| Delete jobs matching user in the context metadata. |
userId
| String
| Delete jobs matching user_id in the context metadata. |
workerClass
| String
| Delete jobs with the given worker class. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
result
| DeleteJobsResponse
| Information about the status of the deletion request. |
Mutation.aiAction
Input type: AiActionInput
Arguments
Name | Type | Description |
---|---|---|
analyzeCiJobFailure
| AnalyzeCiJobFailureInput
| Input for analyze_ci_job_failure AI action. |
chat
| AiChatInput
| Input for chat AI action. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
clientSubscriptionId
| String
| Client generated ID that can be subscribed to, to receive a response for the mutation. |
explainCode
| AiExplainCodeInput
| Input for explain_code AI action. |
explainVulnerability
| AiExplainVulnerabilityInput
| Input for explain_vulnerability AI action. |
fillInMergeRequestTemplate
| AiFillInMergeRequestTemplateInput
| Input for fill_in_merge_request_template AI action. |
generateCommitMessage
| AiGenerateCommitMessageInput
| Input for generate_commit_message AI action. |
generateDescription
| AiGenerateDescriptionInput
| Input for generate_description AI action. |
generateTestFile
| GenerateTestFileInput
| Input for generate_test_file AI action. |
resolveVulnerability
| AiResolveVulnerabilityInput
| Input for resolve_vulnerability AI action. |
summarizeComments
| AiSummarizeCommentsInput
| Input for summarize_comments AI action. |
summarizeReview
| AiSummarizeReviewInput
| Input for summarize_review AI action. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
requestId
| String
| ID of the request. |
Mutation.alertSetAssignees
Input type: AlertSetAssigneesInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]!
| Usernames to assign to the alert. Replaces existing assignees by default. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the alert to mutate. |
operationMode
| MutationOperationMode
| Operation to perform. Defaults to REPLACE. |
projectPath
| ID!
| Project the alert to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
alert
| AlertManagementAlert
| Alert after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| Issue created after mutation. |
todo
| Todo
| To-do item after mutation. |
Mutation.alertTodoCreate
Input type: AlertTodoCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the alert to mutate. |
projectPath
| ID!
| Project the alert to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
alert
| AlertManagementAlert
| Alert after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| Issue created after mutation. |
todo
| Todo
| To-do item after mutation. |
Mutation.approveDeployment
Input type: ApproveDeploymentInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
comment
| String
| Comment to go with the approval. |
id
| DeploymentID!
| ID of the deployment. |
representedAs
| String
| Name of the User/Group/Role to use for the approval, when the user belongs to multiple approval rules. |
status
| DeploymentsApprovalStatus!
| Status of the approval (either APPROVED or REJECTED ).
|
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
deploymentApproval
| DeploymentApproval!
| DeploymentApproval after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.artifactDestroy
Input type: ArtifactDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiJobArtifactID!
| ID of the artifact to delete. |
Fields
Name | Type | Description |
---|---|---|
artifact
| CiJobArtifact
| Deleted artifact. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.auditEventsAmazonS3ConfigurationCreate
Input type: AuditEventsAmazonS3ConfigurationCreateInput
Arguments
Name | Type | Description |
---|---|---|
accessKeyXid
| String!
| Access key ID of the Amazon S3 account. |
awsRegion
| String!
| AWS region where the bucket is created. |
bucketName
| String!
| Name of the bucket where the audit events would be logged. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
groupPath
| ID!
| Group path. |
name
| String
| Destination name. |
secretAccessKey
| String!
| Secret access key of the Amazon S3 account. |
Fields
Name | Type | Description |
---|---|---|
amazonS3Configuration
| AmazonS3ConfigurationType
| configuration created. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.auditEventsAmazonS3ConfigurationDelete
Input type: AuditEventsAmazonS3ConfigurationDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AuditEventsAmazonS3ConfigurationID!
| ID of the Amazon S3 configuration 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.auditEventsAmazonS3ConfigurationUpdate
Input type: AuditEventsAmazonS3ConfigurationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
accessKeyXid
| String
| Access key ID of the Amazon S3 account. |
awsRegion
| String
| AWS region where the bucket is created. |
bucketName
| String
| Name of the bucket where the audit events would be logged. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AuditEventsAmazonS3ConfigurationID!
| ID of the Amazon S3 configuration to update. |
name
| String
| Destination name. |
secretAccessKey
| String
| Secret access key of the Amazon S3 account. |
Fields
Name | Type | Description |
---|---|---|
amazonS3Configuration
| AmazonS3ConfigurationType
| Updated Amazon S3 configuration. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.auditEventsInstanceAmazonS3ConfigurationCreate
Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput
Arguments
Name | Type | Description |
---|---|---|
accessKeyXid
| String!
| Access key ID of the Amazon S3 account. |
awsRegion
| String!
| AWS region where the bucket is created. |
bucketName
| String!
| Name of the bucket where the audit events would be logged. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String
| Destination name. |
secretAccessKey
| String!
| Secret access key of the Amazon S3 account. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
instanceAmazonS3Configuration
| InstanceAmazonS3ConfigurationType
| Created instance Amazon S3 configuration. |
Mutation.auditEventsInstanceAmazonS3ConfigurationDelete
Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AuditEventsInstanceAmazonS3ConfigurationID!
| ID of the instance-level Amazon S3 configuration 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.auditEventsInstanceAmazonS3ConfigurationUpdate
Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
accessKeyXid
| String
| Access key ID of the Amazon S3 account. |
awsRegion
| String
| AWS region where the bucket is created. |
bucketName
| String
| Name of the bucket where the audit events would be logged. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AuditEventsInstanceAmazonS3ConfigurationID!
| ID of the instance-level Amazon S3 configuration to update. |
name
| String
| Destination name. |
secretAccessKey
| String
| Secret access key of the Amazon S3 account. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
instanceAmazonS3Configuration
| InstanceAmazonS3ConfigurationType
| Updated instance-level Amazon S3 configuration. |
Mutation.auditEventsStreamingDestinationEventsAdd
Input type: AuditEventsStreamingDestinationEventsAddInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationId
| AuditEventsExternalAuditEventDestinationID!
| Destination id. |
eventTypeFilters
| [String!]!
| List of event type filters to add for streaming. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
eventTypeFilters
| [String!]
| List of event type filters for the audit event external destination. |
Mutation.auditEventsStreamingDestinationEventsRemove
Input type: AuditEventsStreamingDestinationEventsRemoveInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationId
| AuditEventsExternalAuditEventDestinationID!
| Destination id. |
eventTypeFilters
| [String!]!
| List of event type filters to remove from streaming. |
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.auditEventsStreamingDestinationInstanceEventsAdd
Input type: AuditEventsStreamingDestinationInstanceEventsAddInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationId
| AuditEventsInstanceExternalAuditEventDestinationID!
| Destination id. |
eventTypeFilters
| [String!]!
| List of event type filters to add for streaming. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
eventTypeFilters
| [String!]
| List of event type filters for the audit event external destination. |
Mutation.auditEventsStreamingDestinationInstanceEventsRemove
Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationId
| AuditEventsInstanceExternalAuditEventDestinationID!
| Destination id. |
eventTypeFilters
| [String!]!
| List of event type filters to remove from streaming. |
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.auditEventsStreamingHeadersCreate
Input type: AuditEventsStreamingHeadersCreateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Boolean option determining whether header is active or not. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationId
| AuditEventsExternalAuditEventDestinationID!
| Destination to associate header with. |
key
| String!
| Header key. |
value
| String!
| Header value. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
header
| AuditEventStreamingHeader
| Created header. |
Mutation.auditEventsStreamingHeadersDestroy
Input type: AuditEventsStreamingHeadersDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
headerId
| AuditEventsStreamingHeaderID!
| Header 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.auditEventsStreamingHeadersUpdate
Input type: AuditEventsStreamingHeadersUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Boolean option determining whether header is active or not. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
headerId
| AuditEventsStreamingHeaderID!
| Header to update. |
key
| String
| Header key. |
value
| String
| Header value. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
header
| AuditEventStreamingHeader
| Updates header. |
Mutation.auditEventsStreamingHttpNamespaceFiltersAdd
Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationId
| AuditEventsExternalAuditEventDestinationID!
| Destination ID. |
groupPath
| ID
| Full path of the group. |
projectPath
| ID
| Full path of the project. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
namespaceFilter
| AuditEventStreamingHTTPNamespaceFilter
| Namespace filter created. |
Mutation.auditEventsStreamingHttpNamespaceFiltersDelete
Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
namespaceFilterId
| AuditEventsStreamingHTTPNamespaceFilterID!
| Namespace filter ID. |
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.auditEventsStreamingInstanceHeadersCreate
Input type: AuditEventsStreamingInstanceHeadersCreateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Boolean option determining whether header is active or not. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationId
| AuditEventsInstanceExternalAuditEventDestinationID!
| Instance level external destination to associate header with. |
key
| String!
| Header key. |
value
| String!
| Header value. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
header
| AuditEventsStreamingInstanceHeader
| Created header. |
Mutation.auditEventsStreamingInstanceHeadersDestroy
Input type: AuditEventsStreamingInstanceHeadersDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
headerId
| AuditEventsStreamingInstanceHeaderID!
| Header 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.auditEventsStreamingInstanceHeadersUpdate
Input type: AuditEventsStreamingInstanceHeadersUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Boolean option determining whether header is active or not. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
headerId
| AuditEventsStreamingInstanceHeaderID!
| Header to update. |
key
| String
| Header key. |
value
| String
| Header value. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
header
| AuditEventsStreamingInstanceHeader
| Updates header. |
Mutation.awardEmojiAdd
Input type: AwardEmojiAddInput
Arguments
Name | Type | Description |
---|---|---|
awardableId
| AwardableID!
| Global ID of the awardable resource. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| Emoji name. |
Fields
Name | Type | Description |
---|---|---|
awardEmoji
| AwardEmoji
| Emoji reactions 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!
| Global ID of the awardable resource. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| Emoji name. |
Fields
Name | Type | Description |
---|---|---|
awardEmoji
| AwardEmoji
| Emoji reactions 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!
| Global ID of the awardable resource. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| Emoji name. |
Fields
Name | Type | Description |
---|---|---|
awardEmoji
| AwardEmoji
| Emoji reactions 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
| New limit metric type for the list. |
listId
| ListID!
| Global ID of the list. |
maxIssueCount
| Int
| New maximum issue count limit. |
maxIssueWeight
| Int
| 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
| Updated list. |
Mutation.branchRuleUpdate
Input type: BranchRuleUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ProtectedBranchID!
| Global ID of the protected branch. |
name
| String!
| Branch name, with wildcards, for the branch rules. |
projectPath
| ID!
| Full path to the project that the branch is associated with. |
Fields
Name | Type | Description |
---|---|---|
branchRule
| BranchRule
| Branch rule after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.buildForecast
Input type: BuildForecastInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
contextId
| GlobalID!
| Global ID of the context for the forecast to pick an appropriate model. |
horizon
| Int!
| Number of data points to forecast. |
type
| String!
| Type of the forecast. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
forecast
| Forecast!
| Created forecast. |
Mutation.bulkDestroyJobArtifacts
Input type: BulkDestroyJobArtifactsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
ids
| [CiJobArtifactID!]!
| Global IDs of the job artifacts to destroy. |
projectId
| ProjectID!
| Global Project ID of the job artifacts to destroy. Incompatible with projectPath. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destroyedCount
| Int
| Number of job artifacts deleted. |
destroyedIds
| [CiJobArtifactID!]
| IDs of job artifacts that were deleted. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.bulkEnableDevopsAdoptionNamespaces
BETA This endpoint is subject to change without notice.
Input type: BulkEnableDevopsAdoptionNamespacesInput
Arguments
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.bulkRunnerDelete
Input type: BulkRunnerDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
ids
| [CiRunnerID!]
| IDs of the runners to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
deletedCount
| Int
| Number of records effectively deleted. Only present if operation was performed synchronously. |
deletedIds
| [CiRunnerID!]
| IDs of records effectively deleted. Only present if operation was performed synchronously. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.catalogResourcesCreate
Input type: CatalogResourcesCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| Project path belonging to the catalog resource. |
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.catalogResourcesDestroy
Input type: CatalogResourcesDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| Project path belonging to the catalog resource. |
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.ciJobTokenScopeAddProject
Input type: CiJobTokenScopeAddProjectInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
direction | CiJobTokenScopeDirection
| Deprecated: Outbound job token scope is being removed. This field can now only be set to INBOUND. Deprecated in 16.0. |
projectPath
| ID!
| Project that the CI job token scope belongs to. |
targetProjectPath
| ID!
| Project to be added to the CI job token scope. |
Fields
Name | Type | Description |
---|---|---|
ciJobTokenScope
| CiJobTokenScopeType
| CI job token’s access scope. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.ciJobTokenScopeRemoveProject
Input type: CiJobTokenScopeRemoveProjectInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
direction
| CiJobTokenScopeDirection
| Direction of access, which defaults to outbound. |
projectPath
| ID!
| Project that the CI job token scope belongs to. |
targetProjectPath
| ID!
| Project to be removed from the CI job token scope. |
Fields
Name | Type | Description |
---|---|---|
ciJobTokenScope
| CiJobTokenScopeType
| CI job token’s scope of access. |
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.clusterAgentTokenRevoke
Input type: ClusterAgentTokenRevokeInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ClustersAgentTokenID!
| Global ID of the agent token that will 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.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
| 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.configureContainerScanning
Configure Container Scanning for a project by enabling Container Scanning in a new or modified
.gitlab-ci.yml
file in a new branch. The new branch and a URL to
create a merge request are part of the response.
Input type: ConfigureContainerScanningInput
Arguments
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.configureDependencyScanning
Configure Dependency Scanning for a project by enabling Dependency Scanning in a new or modified
.gitlab-ci.yml
file in a new branch. The new branch and a URL to
create a Merge Request are a part of the response.
Input type: ConfigureDependencyScanningInput
Arguments
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.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.configureSastIac
Enable SAST IaC for a project in a new or
modified .gitlab-ci.yml
file in a new branch. The new
branch and a URL to create a merge request are a part of the
response.
Input type: ConfigureSastIacInput
Arguments
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.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.corpusCreate
Input type: CorpusCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| Project the corpus belongs to. |
packageId
| PackagesPackageID!
| ID of the corpus package. |
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.createAlertIssue
Input type: CreateAlertIssueInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the alert to mutate. |
projectPath
| ID!
| Project the alert to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
alert
| AlertManagementAlert
| Alert after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| Issue created after mutation. |
todo
| Todo
| To-do item after mutation. |
Mutation.createAnnotation
Input type: CreateAnnotationInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
clusterId
| ClustersClusterID
| Global ID of the cluster to add an annotation to. |
dashboardPath
| String!
| Path to a file defining the dashboard on which the annotation should be added. |
description
| String!
| Description of the annotation. |
endingAt
| Time
| Timestamp indicating ending moment to which the annotation relates. |
environmentId
| EnvironmentID
| 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
| 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. |
iterationCadenceId
| IterationsCadenceID
| ID of iteration cadence to be assigned to the board. |
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
| 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
| 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 the 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
| Created compliance framework. |
Mutation.createContainerRegistryProtectionRule
Creates a protection rule to restrict access to a project’s container registry. Available only when feature flag container_registry_protected_containers
is enabled.
Input type: CreateContainerRegistryProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
deleteProtectedUpToAccessLevel
| ContainerRegistryProtectionRuleAccessLevel!
| Max GitLab access level to prevent from deleting container images in the container registry. For example DEVELOPER , MAINTAINER , OWNER .
|
projectPath
| ID!
| Full path of the project where a protection rule is located. |
pushProtectedUpToAccessLevel
| ContainerRegistryProtectionRuleAccessLevel!
| Max GitLab access level to prevent from pushing container images to the container registry. For example DEVELOPER , MAINTAINER , OWNER .
|
repositoryPathPattern
| String!
| Container repository path pattern protected by the protection rule. For example my-project/my-container-* . Wildcard character * allowed.
|
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
containerRegistryProtectionRule
| ContainerRegistryProtectionRule
| Container registry protection rule after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.createCustomEmoji
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
| 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
|
Deprecated: This was renamed. Please use internal . Deprecated in 15.3.
|
internal
| Boolean
| Internal flag for a note. Default is false. |
noteableId
| NoteableID!
| Global ID of the resource to add a note to. |
position
| DiffPositionInput!
| Position of this note on a diff. |
Fields
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
| Note after mutation. |
Mutation.createEpic
Input type: CreateEpicInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
| [ID!]
| IDs of labels to be added to the epic. |
addLabels
| [String!]
| Array of labels to be added to the epic. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
color
| Color
| Color of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
|
confidential
| Boolean
| Indicates if the epic is confidential. |
description
| String
| Description of the epic. |
dueDateFixed
| String
| End date of the epic. |
dueDateIsFixed
| Boolean
| Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
groupPath
| ID!
| Group the epic to mutate is in. |
removeLabelIds
| [ID!]
| IDs of labels to be removed from the epic. |
startDateFixed
| String
| Start date of the epic. |
startDateIsFixed
| Boolean
| Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
title
| String
| Title of the epic. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| 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
|
Deprecated: This was renamed. Please use internal . Deprecated in 15.3.
|
internal
| Boolean
| Internal flag for a note. Default is false. |
noteableId
| NoteableID!
| Global ID of the resource to add a note to. |
position
| DiffImagePositionInput!
| Position of this note on a diff. |
Fields
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
| Note after mutation. |
Mutation.createIssue
Input type: CreateIssueInput
Arguments
Name | Type | Description |
---|---|---|
assigneeIds
| [UserID!]
| 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
| ID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of .
|
dueDate
| ISO8601Date
| Due date of the issue. |
epicId
| EpicID
| ID of an epic to associate the issue with. |
healthStatus
| HealthStatus
| Desired health status. |
iid
| Int
| IID (internal ID) of a project issue. Only admins and project owners can modify. |
iterationCadenceId
| IterationsCadenceID
| Global iteration cadence ID. Required when iterationWildcardId is provided.
|
iterationId
| IterationID
| Global iteration ID. Mutually exlusive argument with iterationWildcardId .
|
iterationWildcardId
| IssueCreationIterationWildcardId
| Iteration wildcard ID. Supported values are: CURRENT . Mutually exclusive argument with iterationId . iterationCadenceId also required when this argument is provided.
|
labelIds
| [LabelID!]
| IDs of labels to be added to the issue. |
labels
| [String!]
| Labels of the issue. |
locked
| Boolean
| Indicates discussion is locked on the issue. |
mergeRequestToResolveDiscussionsOf
| MergeRequestID
| IID of a merge request for which to resolve discussions. |
milestoneId
| MilestoneID
| ID of the milestone to assign to the issue. On update milestone will be removed if set to null. |
moveAfterId
| IssueID
| Global ID of issue that should be placed after the current issue. |
moveBeforeId
| IssueID
| Global ID of issue that should be placed before the current issue. |
projectPath
| ID!
| Project full path the issue is associated with. |
title
| String!
| Title of the issue. |
type
| IssueType
| Type of the issue. |
weight
| Int
| 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
| 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
| Description of the iteration. |
dueDate
| String
| End date of the iteration. |
groupPath
| ID
| Full path of the group with which the resource is associated. |
iterationsCadenceId
| IterationsCadenceID
| Global ID of the iteration cadence to be assigned to the new iteration. |
projectPath
| ID
| Full path of the project with which the resource is associated. |
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
| Created iteration. |
Mutation.createNote
Creates a Note. If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.
Input type: CreateNoteInput
Arguments
Name | Type | Description |
---|---|---|
body
| String!
| Content of the note. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential | Boolean
|
Deprecated: This was renamed. Please use internal . Deprecated in 15.3.
|
discussionId
| DiscussionID
| Global ID of the discussion the note is in reply to. |
internal
| Boolean
| Internal flag for a note. Default is false. |
mergeRequestDiffHeadSha
| String
| SHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent. |
noteableId
| NoteableID!
| Global ID of the resource to add a note to. |
Fields
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
| Note after mutation. |
Mutation.createPackagesProtectionRule
Creates a protection rule to restrict access to project packages. Available only when feature flag packages_protected_packages
is enabled.
Input type: CreatePackagesProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
packageNamePattern
| String!
| Package name protected by the protection rule. For example @my-scope/my-package-* . Wildcard character * allowed.
|
packageType
| PackagesProtectionRulePackageType!
| Package type protected by the protection rule. For example NPM .
|
projectPath
| ID!
| Full path of the project where a protection rule is located. |
pushProtectedUpToAccessLevel
| PackagesProtectionRuleAccessLevel!
| Max GitLab access level unable to push a package. For example DEVELOPER , MAINTAINER , OWNER .
|
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
packageProtectionRule
| PackagesProtectionRule
| Packages protection rule 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. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the snippet. |
projectPath
| ID
| Full path of the project the snippet is associated with. |
title
| String!
| Title of the snippet. |
uploadedFiles
| [String!]
| Paths to files uploaded in the snippet description. |
visibilityLevel
| VisibilityLevelsEnum!
| Visibility level of the snippet. |
Fields
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
| Snippet after mutation. |
Mutation.createTestCase
Input type: CreateTestCaseInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| Sets the test case confidentiality. |
description
| String
| Test case description. |
labelIds
| [ID!]
| IDs of labels to be added to the test case. |
projectPath
| ID!
| Project full path to create the test case in. |
title
| String!
| Test case title. |
Fields
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
| Test case created. |
Mutation.customerRelationsContactCreate
Input type: CustomerRelationsContactCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of or notes for the contact. |
email
| String
| Email address of the contact. |
firstName
| String!
| First name of the contact. |
groupId
| GroupID!
| Group for the contact. |
lastName
| String!
| Last name of the contact. |
organizationId
| CustomerRelationsOrganizationID
| Organization for the contact. |
phone
| String
| Phone number of the contact. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
contact
| CustomerRelationsContact
| Contact after the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.customerRelationsContactUpdate
Input type: CustomerRelationsContactUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| State of the contact. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of or notes for the contact. |
email
| String
| Email address of the contact. |
firstName
| String
| First name of the contact. |
id
| CustomerRelationsContactID!
| Global ID of the contact. |
lastName
| String
| Last name of the contact. |
organizationId
| CustomerRelationsOrganizationID
| Organization of the contact. |
phone
| String
| Phone number of the contact. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
contact
| CustomerRelationsContact
| Contact after the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.customerRelationsOrganizationCreate
Input type: CustomerRelationsOrganizationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
defaultRate
| Float
| Standard billing rate for the organization. |
description
| String
| Description of or notes for the organization. |
groupId
| GroupID!
| Group for the organization. |
name
| String!
| Name of the organization. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
organization
| CustomerRelationsOrganization
| Organization after the mutation. |
Mutation.customerRelationsOrganizationUpdate
Input type: CustomerRelationsOrganizationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| State of the organization. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
defaultRate
| Float
| Standard billing rate for the organization. |
description
| String
| Description of or notes for the organization. |
id
| CustomerRelationsOrganizationID!
| Global ID of the organization. |
name
| String
| Name of the organization. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
organization
| CustomerRelationsOrganization!
| Organization after the mutation. |
Mutation.dastOnDemandScanCreate
Input type: DastOnDemandScanCreateInput
Arguments
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!
| 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
| Associated branch. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastProfileSchedule
| DastProfileScheduleInput
| Represents a DAST Profile Schedule. |
dastScannerProfileId
| DastScannerProfileID!
| ID of the scanner profile to be associated. |
dastSiteProfileId
| DastSiteProfileID!
| ID of the site profile to be associated. |
description
| String
| Description of the profile. Defaults to an empty string. |
fullPath
| ID!
| Project the profile belongs to. |
name
| String!
| Name of the profile. |
runAfterCreate
| Boolean
| Run scan using profile after creation. Defaults to false. |
tagList
| [String!]
| Indicates the runner tags associated with the profile. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastProfile
| DastProfile
| Created profile. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
pipelineUrl
| String
| 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
| Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5. |
id
| DastProfileID!
| ID of the profile to be used for the scan. |
Fields
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
| Associated branch. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastProfileSchedule
| DastProfileScheduleInput
| Represents a DAST profile schedule. |
dastScannerProfileId
| DastScannerProfileID
| ID of the scanner profile to be associated. |
dastSiteProfileId
| DastSiteProfileID
| ID of the site profile to be associated. |
description
| String
| Description of the profile. Defaults to an empty string. |
fullPath | ID
| Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5. |
id
| DastProfileID!
| ID of the profile to be deleted. |
name
| String
| Name of the profile. |
runAfterUpdate
| Boolean
| Run scan using profile after update. Defaults to false. |
tagList
| [String!]
| Indicates the runner tags associated with the profile. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastProfile
| DastProfile
| 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!
| Project the scanner profile belongs to. |
profileName
| String!
| 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
| Maximum number of minutes allowed for the spider to traverse the site. |
tagList | [String!]
| Deprecated: Moved to DastProfile. Deprecated in 15.8. |
targetTimeout
| Int
| Maximum number of seconds allowed for the site under test to respond to a request. |
useAjaxSpider
| 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. |
dastScannerProfile
| DastScannerProfile
| Created scanner profile. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id | DastScannerProfileID
|
Deprecated: use dastScannerProfile field. Deprecated in 14.10.
|
Mutation.dastScannerProfileDelete
Input type: DastScannerProfileDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath | ID
| Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5. |
id
| DastScannerProfileID!
| ID of the scanner profile to be deleted. |
Fields
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
| Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5. |
id
| DastScannerProfileID!
| ID of the scanner profile to be updated. |
profileName
| String!
| Name of the scanner profile. |
scanType
| 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!
| Maximum number of minutes allowed for the spider to traverse the site. |
tagList | [String!]
| Deprecated: Moved to DastProfile. Deprecated in 15.8. |
targetTimeout
| Int!
| Maximum number of seconds allowed for the site under test to respond to a request. |
useAjaxSpider
| 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. |
dastScannerProfile
| DastScannerProfile
| Updated scanner profile. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id | DastScannerProfileID
|
Deprecated: use dastScannerProfile field. Deprecated in 14.10.
|
Mutation.dastSiteProfileCreate
Input type: DastSiteProfileCreateInput
Arguments
Name | Type | Description |
---|---|---|
auth
| DastSiteProfileAuthInput
| Parameters for authentication. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
excludedUrls
| [String!]
| URLs to skip during an authenticated scan. Defaults to [] .
|
fullPath
| ID!
| Project the site profile belongs to. |
profileName
| String!
| Name of the site profile. |
requestHeaders
| String
| Comma-separated list of request header names and values to be added to every request made by DAST. |
scanFilePath
| String
| File Path or URL used as input for the scan method. |
scanMethod
| DastScanMethodType
| Scan method by the scanner. |
targetType
| DastTargetTypeEnum
| Type of target to be scanned. |
targetUrl
| String
| URL of the target to be scanned. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastSiteProfile
| DastSiteProfile
| Site Profile object. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id | DastSiteProfileID
|
Deprecated: use dastSiteProfile.id field. Deprecated in 14.10.
|
Mutation.dastSiteProfileDelete
Input type: DastSiteProfileDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath | ID
| Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5. |
id
| DastSiteProfileID!
| ID of the site profile to be deleted. |
Fields
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!]
| URLs to skip during an authenticated scan. |
fullPath | ID
| Deprecated: Full path not required to qualify Global ID. Deprecated in 14.5. |
id
| DastSiteProfileID!
| ID of the site profile to be updated. |
profileName
| String!
| Name of the site profile. |
requestHeaders
| String
| Comma-separated list of request header names and values to be added to every request made by DAST. |
scanFilePath
| String
| File Path or URL used as input for the scan method. |
scanMethod
| DastScanMethodType
| Scan method by the scanner. |
targetType
| DastTargetTypeEnum
| Type of target to be scanned. |
targetUrl
| String
| URL of the target to be scanned. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dastSiteProfile
| DastSiteProfile
| Site profile object. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
id | DastSiteProfileID
|
Deprecated: use dastSiteProfile.id field. Deprecated in 14.10.
|
Mutation.dastSiteTokenCreate
Input type: DastSiteTokenCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| Project the site token belongs to. |
targetUrl
| String
| 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
| 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!
| Project the site profile belongs to. |
strategy
| DastSiteValidationStrategyEnum
| Validation strategy to be used. |
validationPath
| String!
| 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
| 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!
| 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
| String!
| 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.deleteContainerRegistryProtectionRule
Deletes a container registry protection rule. Available only when feature flag container_registry_protected_containers
is enabled.
Input type: DeleteContainerRegistryProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| ContainerRegistryProtectionRuleID!
| Global ID of the container registry protection rule to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
containerRegistryProtectionRule
| ContainerRegistryProtectionRule
| Container registry protection rule that was deleted successfully. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.deletePackagesProtectionRule
Deletes a protection rule for packages. Available only when feature flag packages_protected_packages
is enabled.
Input type: DeletePackagesProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| PackagesProtectionRuleID!
| Global ID of the package protection rule 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. |
packageProtectionRule
| PackagesProtectionRule
| Packages protection rule that was deleted successfully. |
Mutation.designManagementDelete
Input type: DesignManagementDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
filenames
| [String!]!
| Filenames of the designs to delete. |
iid
| ID!
| IID of the issue to modify designs for. |
projectPath
| ID!
| Project where the issue is to upload designs for. |
Fields
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
| 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
| Current state of the collection. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.designManagementUpdate
Input type: DesignManagementUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the design. |
id
| DesignManagementDesignID!
| ID of the design to update. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
design
| Design!
| Updated design. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.designManagementUpload
Input type: DesignManagementUploadInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
files
| [Upload!]!
| Files to upload. |
iid
| ID!
| IID of the issue to modify designs for. |
projectPath
| ID!
| Project where the issue is to upload designs for. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
designs
| [Design!]!
| Designs that were uploaded by the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
skippedDesigns
| [Design!]!
| Any designs that were skipped from the upload due to there being no change to their content since their last version. |
Mutation.destroyBoard
Input type: DestroyBoardInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| BoardID!
| Global ID of the board to destroy. |
Fields
Name | Type | Description |
---|---|---|
board
| Board
| 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
| 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!
| 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!
| 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.destroyCustomEmoji
Input type: DestroyCustomEmojiInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CustomEmojiID!
| Global ID of the custom emoji to destroy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
customEmoji
| CustomEmoji
| Deleted custom emoji. |
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!
| 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
| Note after mutation. |
Mutation.destroyPackage
Input type: DestroyPackageInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| PackagesPackageID!
| ID of the Package. |
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.destroyPackageFile
Input type: DestroyPackageFileInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| PackagesPackageFileID!
| ID of the Package file. |
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.destroyPackageFiles
Input type: DestroyPackageFilesInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
ids
| [PackagesPackageFileID!]!
| IDs of the Package file. |
projectPath
| ID!
| Project path where the packages cleanup policy is located. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.destroyPackages
Input type: DestroyPackagesInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
ids
| [PackagesPackageID!]!
| Global IDs of the Packages. Max 20. |
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.destroySnippet
Input type: DestroySnippetInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| SnippetID!
| 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
| 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!
| 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
| Discussion after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.echoCreate
A mutation that does not perform any changes.
This is expected to be used for testing of endpoints, to verify that a user has mutation access.
Input type: EchoCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]
| Errors to return to the user. |
messages
| [String!]
| Messages to return to the user. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
echoes
| [String!]
| Messages returned to the user. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.enableDevopsAdoptionNamespace
BETA This endpoint is subject to change without notice.
Input type: EnableDevopsAdoptionNamespaceInput
Arguments
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.environmentCreate
Create an environment.
Input type: EnvironmentCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
clusterAgentId
| ClustersAgentID
| Cluster agent of the environment. |
externalUrl
| String
| External URL of the environment. |
fluxResourcePath
| String
| Flux resource path of the environment. |
kubernetesNamespace
| String
| Kubernetes namespace of the environment. |
name
| String!
| Name of the environment. |
projectPath
| ID!
| Full path of the project. |
tier
| DeploymentTier
| Tier of the environment. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
environment
| Environment
| Created environment. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.environmentDelete
Delete an environment.
Input type: EnvironmentDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| EnvironmentID!
| Global ID of the environment 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.environmentStop
Stop an environment.
Input type: EnvironmentStopInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
force
| Boolean
| Force environment to stop without executing on_stop actions. |
id
| EnvironmentID!
| Global ID of the environment to stop. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
environment
| Environment
| Environment after attempt to stop. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.environmentUpdate
Update an environment.
Input type: EnvironmentUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
clusterAgentId
| ClustersAgentID
| Cluster agent of the environment. |
externalUrl
| String
| External URL of the environment. |
fluxResourcePath
| String
| Flux resource path of the environment. |
id
| EnvironmentID!
| Global ID of the environment to update. |
kubernetesNamespace
| String
| Kubernetes namespace of the environment. |
tier
| DeploymentTier
| Tier of the environment. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
environment
| Environment
| Environment after attempt to update. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.environmentsCanaryIngressUpdate
Deprecated This endpoint is planned to be removed along with certificate-based clusters. See this epic for more information.
Input type: EnvironmentsCanaryIngressUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| EnvironmentID!
| Global ID of the environment to update. |
weight
| Int!
| Weight of the Canary Ingress. |
Fields
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!
| Group the epic to mutate belongs to. |
iid
| ID!
| IID of the epic to mutate. |
issueIid
| String!
| IID of the issue to be added. |
projectPath
| ID!
| Full path of the project the issue belongs to. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| Epic after mutation. |
epicIssue
| EpicIssue
| Epic-issue relationship. |
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. |
displayColors
| Boolean
| Whether or not display epic colors. Ignored unless epic_color_highlight flag is enabled.
|
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
| Board name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicBoard
| EpicBoard
| 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
| 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. |
displayColors
| Boolean
| Whether or not display epic colors. Ignored unless epic_color_highlight flag is enabled.
|
hideBacklogList
| Boolean
| Whether or not backlog list is hidden. |
hideClosedList
| Boolean
| Whether or not closed list is hidden. |
id
| BoardsEpicBoardID!
| Epic board global ID. |
labelIds
| [LabelID!]
| IDs of labels to be added to the board. |
labels
| [String!]
| Labels of the issue. |
name
| String
| Board name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicBoard
| EpicBoard
| 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. |
positionInList
| Int
| Position of epics within the board list. Positions start at 0. Use -1 to move to the end of the list. |
toListId
| BoardsEpicListID!
| ID of the list the epic will be in after mutation. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| 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!
| Group the epic to mutate belongs to. |
iid
| ID!
| IID of the epic to mutate. |
subscribedState
| Boolean!
| Desired state of the subscription. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| Epic after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.epicTreeReorder
Input type: EpicTreeReorderInput
Arguments
Name | Type | Description |
---|---|---|
baseEpicId
| EpicID!
| 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
| Description of the escalation policy. |
name
| String!
| Name of the escalation policy. |
projectPath
| ID!
| Project to create the escalation policy for. |
rules
| [EscalationRuleInput!]!
| Steps of the escalation policy. |
Fields
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
| Escalation policy. |
Mutation.escalationPolicyDestroy
Input type: EscalationPolicyDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IncidentManagementEscalationPolicyID!
| 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
| Escalation policy. |
Mutation.escalationPolicyUpdate
Input type: EscalationPolicyUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the escalation policy. |
id
| IncidentManagementEscalationPolicyID!
| ID of the on-call schedule to create the on-call rotation in. |
name
| String
| Name of the escalation policy. |
rules
| [EscalationRuleInput!]
| 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
| 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.externalAuditEventDestinationCreate
Input type: ExternalAuditEventDestinationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationUrl
| String!
| Destination URL. |
groupPath
| ID!
| Group path. |
name
| String
| Destination name. |
verificationToken
| String
| Verification 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. |
externalAuditEventDestination
| ExternalAuditEventDestination
| Destination created. |
Mutation.externalAuditEventDestinationDestroy
Input type: ExternalAuditEventDestinationDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AuditEventsExternalAuditEventDestinationID!
| ID of external audit event destination 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.externalAuditEventDestinationUpdate
Input type: ExternalAuditEventDestinationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationUrl
| String
| Destination URL to change. |
id
| AuditEventsExternalAuditEventDestinationID!
| ID of external audit event destination to update. |
name
| String
| Destination name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
externalAuditEventDestination
| ExternalAuditEventDestination
| Updated destination. |
Mutation.geoRegistriesBulkUpdate
Mutates multiple Geo registries for a given registry class.
Input type: GeoRegistriesBulkUpdateInput
Arguments
Name | Type | Description |
---|---|---|
action
| GeoRegistriesBulkAction!
| Action to be executed on Geo registries. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
registryClass
| GeoRegistryClass!
| Class of the Geo registries to be updated. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
registryClass
| GeoRegistryClass
| Updated Geo registry class. |
Mutation.geoRegistriesUpdate
Mutates a Geo registry.
Input type: GeoRegistriesUpdateInput
Arguments
Name | Type | Description |
---|---|---|
action
| GeoRegistryAction!
| Action to be executed on a Geo registry. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
registryClass
| GeoRegistryClass
| Class of the Geo registry to be updated. |
registryId
| GeoBaseRegistryID!
| ID of the Geo registry entry to be updated. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
registry
| Registrable
| Updated Geo registry entry. |
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. |
futureSubscriptions
| [SubscriptionFutureEntry!]
| Array of future subscriptions. |
license
| CurrentLicense
| Current license. |
Mutation.googleCloudLoggingConfigurationCreate
Input type: GoogleCloudLoggingConfigurationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientEmail
| String!
| Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
googleProjectIdName
| String!
| Unique identifier of the Google Cloud project to which the logging configuration belongs. |
groupPath
| ID!
| Group path. |
logIdName
| String
| Unique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events ).
|
name
| String
| Destination name. |
privateKey
| String!
| Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
googleCloudLoggingConfiguration
| GoogleCloudLoggingConfigurationType
| configuration created. |
Mutation.googleCloudLoggingConfigurationDestroy
Input type: GoogleCloudLoggingConfigurationDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AuditEventsGoogleCloudLoggingConfigurationID!
| ID of the Google Cloud logging configuration 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.googleCloudLoggingConfigurationUpdate
Input type: GoogleCloudLoggingConfigurationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientEmail
| String
| Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
googleProjectIdName
| String
| Unique identifier of the Google Cloud project to which the logging configuration belongs. |
id
| AuditEventsGoogleCloudLoggingConfigurationID!
| ID of the google Cloud configuration to update. |
logIdName
| String
| Unique identifier used to distinguish and manage different logs within the same Google Cloud project. |
name
| String
| Destination name. |
privateKey
| String
| Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
googleCloudLoggingConfiguration
| GoogleCloudLoggingConfigurationType
| configuration updated. |
Mutation.groupMemberBulkUpdate
Input type: GroupMemberBulkUpdateInput
Arguments
Name | Type | Description |
---|---|---|
accessLevel
| MemberAccessLevel!
| Access level to update the members to. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
expiresAt
| Time
| Date and time the membership expires. |
groupId
| GroupID!
| Global ID of the group. |
userIds
| [UserID!]!
| Global IDs of the members. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
groupMembers
| [GroupMember!]
| Group members after mutation. |
Mutation.groupUpdate
Input type: GroupUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| Full path of the group that will be updated. |
sharedRunnersSetting
| SharedRunnersSetting!
| Shared runners availability for the namespace and its descendants. |
Fields
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 after update. |
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!
| Name of the integration. |
payloadAttributeMappings
| [AlertManagementPayloadAlertFieldInput!]
| Custom mapping of GitLab alert attributes to fields from the payload example. |
payloadExample
| JsonString
| Example of an alert payload. |
projectPath
| ID!
| 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
| HTTP integration. |
Mutation.httpIntegrationDestroy
Input type: HttpIntegrationDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AlertManagementHttpIntegrationID!
| 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
| HTTP integration. |
Mutation.httpIntegrationResetToken
Input type: HttpIntegrationResetTokenInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AlertManagementHttpIntegrationID!
| 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
| 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!
| ID of the integration to mutate. |
name
| String
| Name of the integration. |
payloadAttributeMappings
| [AlertManagementPayloadAlertFieldInput!]
| Custom mapping of GitLab alert attributes to fields from the payload example. |
payloadExample
| JsonString
| 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
| HTTP integration. |
Mutation.instanceExternalAuditEventDestinationCreate
Input type: InstanceExternalAuditEventDestinationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationUrl
| String!
| Destination URL. |
name
| String
| Destination name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
instanceExternalAuditEventDestination
| InstanceExternalAuditEventDestination
| Destination created. |
Mutation.instanceExternalAuditEventDestinationDestroy
Input type: InstanceExternalAuditEventDestinationDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AuditEventsInstanceExternalAuditEventDestinationID!
| ID of the external instance audit event destination 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.instanceExternalAuditEventDestinationUpdate
Input type: InstanceExternalAuditEventDestinationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destinationUrl
| String
| Destination URL to change. |
id
| AuditEventsInstanceExternalAuditEventDestinationID!
| ID of the external instance audit event destination to update. |
name
| String
| Destination name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
instanceExternalAuditEventDestination
| InstanceExternalAuditEventDestination
| Updated destination. |
Mutation.instanceGoogleCloudLoggingConfigurationCreate
Input type: InstanceGoogleCloudLoggingConfigurationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientEmail
| String!
| Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
googleProjectIdName
| String!
| Unique identifier of the Google Cloud project to which the logging configuration belongs. |
logIdName
| String
| Unique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events ).
|
name
| String
| Destination name. |
privateKey
| String!
| Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
instanceGoogleCloudLoggingConfiguration
| InstanceGoogleCloudLoggingConfigurationType
| configuration created. |
Mutation.instanceGoogleCloudLoggingConfigurationDestroy
Input type: InstanceGoogleCloudLoggingConfigurationDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AuditEventsInstanceGoogleCloudLoggingConfigurationID!
| ID of the Google Cloud logging configuration 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.instanceGoogleCloudLoggingConfigurationUpdate
Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientEmail
| String
| Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
googleProjectIdName
| String
| Unique identifier of the Google Cloud project to which the logging configuration belongs. |
id
| AuditEventsInstanceGoogleCloudLoggingConfigurationID!
| ID of the instance google Cloud configuration to update. |
logIdName
| String
| Unique identifier used to distinguish and manage different logs within the same Google Cloud project. |
name
| String
| Destination name. |
privateKey
| String
| Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
instanceGoogleCloudLoggingConfiguration
| InstanceGoogleCloudLoggingConfigurationType
| configuration updated. |
Mutation.issuableResourceLinkCreate
Input type: IssuableResourceLinkCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IssueID!
| Incident id to associate the resource link with. |
link
| String!
| Link of the resource. |
linkText
| String
| Link text of the resource. |
linkType
| IssuableResourceLinkType
| Link type of the resource. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issuableResourceLink
| IssuableResourceLink
| Issuable resource link. |
Mutation.issuableResourceLinkDestroy
Input type: IssuableResourceLinkDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IncidentManagementIssuableResourceLinkID!
| Issuable resource link 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. |
issuableResourceLink
| IssuableResourceLink
| Issuable resource link. |
Mutation.issueLinkAlerts
Input type: IssueLinkAlertsInput
Arguments
Name | Type | Description |
---|---|---|
alertReferences
| [String!]!
| Alerts references to be linked to the incident. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
Fields
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
| Issue after mutation. |
Mutation.issueMove
Input type: IssueMoveInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
targetProjectPath
| ID!
| Project to move the issue to. |
Fields
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
| 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
| 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. |
positionInList
| Int
| Position of issue within the board list. Positions start at 0. Use -1 to move to the end of the list. |
projectPath
| ID!
| Project the issue to mutate is in. |
toListId
| 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
| Issue after mutation. |
Mutation.issueSetAssignees
Input type: IssueSetAssigneesInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]!
| Usernames to assign to the resource. Replaces existing assignees by default. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the issue to mutate. |
operationMode
| MutationOperationMode
| Operation to perform. Defaults to REPLACE. |
projectPath
| ID!
| 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
| 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!
| IID of the issue to mutate. |
projectPath
| ID!
| 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
| Issue after mutation. |
Mutation.issueSetCrmContacts
Input type: IssueSetCrmContactsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
contactIds
| [CustomerRelationsContactID!]!
| Customer relations contact IDs to set. Replaces existing contacts by default. |
iid
| String!
| IID of the issue to mutate. |
operationMode
| MutationOperationMode
| Changes the operation mode. Defaults to REPLACE. |
projectPath
| ID!
| 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
| 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
| Desired due date for the issue. Due date is removed if null. |
iid
| String!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
Fields
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
| 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!
| IID of the issue to mutate. |
projectPath
| ID!
| 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
| Issue after mutation. |
Mutation.issueSetEscalationPolicy
Input type: IssueSetEscalationPolicyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
escalationPolicyId
| IncidentManagementEscalationPolicyID
| Global ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null. |
iid
| String!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
Fields
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
| Issue after mutation. |
Mutation.issueSetEscalationStatus
Input type: IssueSetEscalationStatusInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
status
| IssueEscalationStatus!
| Set the escalation status. |
Fields
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
| 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!
| IID of the issue to mutate. |
iterationId
| IterationID
| Iteration to assign to the issue. |
projectPath
| ID!
| 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
| 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!
| IID of the issue to mutate. |
locked
| Boolean!
| Whether or not to lock discussion on the issue. |
projectPath
| ID!
| Project the issue to mutate is in. |
Fields
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
| 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!
| IID of the issue to mutate. |
projectPath
| ID!
| 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
| 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!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
subscribedState
| Boolean!
| 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
| 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!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
weight
| Int
| The desired weight for the issue. If set to null, weight is removed. |
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
| Issue after mutation. |
Mutation.issueUnlinkAlert
Input type: IssueUnlinkAlertInput
Arguments
Name | Type | Description |
---|---|---|
alertId
| AlertManagementAlertID!
| Global ID of the alert to unlink from the incident. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
Fields
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
| Issue after mutation. |
Mutation.issuesBulkUpdate
Allows updating several properties for a set of issues. Does nothing if the bulk_update_issues_mutation
feature flag is disabled.
Input type: IssuesBulkUpdateInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
| [LabelID!]
| Global ID array of the labels that will be added to the issues. |
assigneeIds
| [UserID!]
| Global ID array of the users that will be assigned to the given issues. Existing assignees will be replaced with the ones on this list. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epicId
| EpicID
| Global ID of the epic that will be assigned to the issues. |
healthStatus
| HealthStatus
| Health status that will be assigned to the issues. |
ids
| [IssueID!]!
| Global ID array of the issues that will be updated. IDs that the user can’t update will be ignored. A max of 100 can be provided. |
iterationId
| IterationID
| Global ID of the iteration that will be assigned to the issues. |
milestoneId
| MilestoneID
| Global ID of the milestone that will be assigned to the issues. |
parentId
| IssueParentID!
| Global ID of the parent to which the bulk update will be scoped. The parent can be a project All tiers All offerings or a group Premium All offerings . Example IssueParentID are "gid://gitlab/Project/1" and "gid://gitlab/Group/1" .
|
removeLabelIds
| [LabelID!]
| Global ID array of the labels that will be removed from the issues. |
stateEvent
| IssueStateEvent
| Close or reopen an issue. |
subscriptionEvent
| IssuableSubscriptionEvent
| Subscribe to or unsubscribe from issue notifications. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
updatedIssueCount
| Int
| Number of issues that were successfully updated. |
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 upcoming 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!
| Group where the iteration cadence is created. |
iterationsInAdvance
| Int
| Upcoming 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 automation 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
| 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 upcoming 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
| Upcoming 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 automation 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
| 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
| Description of the iteration. |
dueDate
| String
| End date of the iteration. |
groupPath
| ID
| Full path of the group with which the resource is associated. |
iterationsCadenceId
| IterationsCadenceID
| Global ID of the iteration cadence to be assigned to the new iteration. |
projectPath
| ID
| Full path of the project with which the resource is associated. |
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
| 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!
| Project to import the Jira project into. |
usersMapping
| [JiraUsersMappingInputType!]
| 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
| 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!
| Project to import the Jira users into. |
startAt
| Int
| 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.jobArtifactsDestroy
Input type: JobArtifactsDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiBuildID!
| ID of the job to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
destroyedArtifactsCount
| Int!
| Number of artifacts deleted. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
job
| CiJob
| Job with artifacts to be deleted. |
Mutation.jobCancel
Input type: JobCancelInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiBuildID!
| 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
| Job after the mutation. |
Mutation.jobPlay
Input type: JobPlayInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiBuildID!
| ID of the job to mutate. |
variables
| [CiVariableInput!]
| Variables to use when playing a manual job. |
Fields
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
| 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
| CiProcessableID!
| ID of the job to mutate. |
variables
| [CiVariableInput!]
| Variables to use when retrying a manual job. |
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
| Job after the mutation. |
Mutation.jobUnschedule
Input type: JobUnscheduleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiBuildID!
| 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
| 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
| 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!
| 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
| Snippet after mutation. |
Mutation.memberRoleCreate
Input type: MemberRoleCreateInput
Arguments
Name | Type | Description |
---|---|---|
adminGroupMember
| Boolean
| Permission to admin group members. |
adminMergeRequest
| Boolean
| Permission to admin merge requests. |
adminVulnerability
| Boolean
| Permission to admin vulnerability. |
archiveProject
| Boolean
| Permission to archive projects. |
baseAccessLevel
| MemberAccessLevel!
| Base access level for the custom role. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the member role. |
groupPath
| ID
| Group the member role to mutate is in. Required for SaaS. |
manageProjectAccessTokens
| Boolean
| Permission to admin project access tokens. |
name
| String
| Name of the member role. |
permissions
| [MemberRolePermission!]
| List of all customizable permissions. |
readCode
| Boolean
| Permission to read code. |
readDependency
| Boolean
| Permission to read dependency. |
readVulnerability
| Boolean
| Permission to read vulnerability. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
memberRole
| MemberRole
| Updated member role. |
Mutation.memberRoleDelete
Input type: MemberRoleDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| MemberRoleID!
| ID of the member role 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. |
memberRole
| MemberRole
| Deleted member role. |
Mutation.memberRoleUpdate
Input type: MemberRoleUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the member role. |
id
| MemberRoleID!
| ID of the member role to mutate. |
name
| String
| Name of the member role. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
memberRole
| MemberRole
| Updated member role. |
Mutation.mergeRequestAccept
Accepts a merge request. When accepted, the source branch will be scheduled to merge into the target branch, either immediately if possible, or using one of the automatic merge strategies.
In GitLab 16.5, the merging happens asynchronously.
This results in mergeRequest
and state
not updating after a mutation request,
because the merging may not have happened yet.
Input type: MergeRequestAcceptInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
commitMessage
| String
| Custom merge commit message. |
iid
| String!
| IID of the merge request to mutate. |
projectPath
| ID!
| Project the merge request to mutate is in. |
sha
| String!
| HEAD SHA at the time when the merge was requested. |
shouldRemoveSourceBranch
| 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 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
| 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
| 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!
| IID of the merge request to mutate. |
projectPath
| ID!
| Project the merge request to mutate is in. |
userId
| UserID!
| User ID for the user that has been requested for a new review. |
Fields
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
| Merge request after mutation. |
Mutation.mergeRequestSetAssignees
Input type: MergeRequestSetAssigneesInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]!
| Usernames to assign to the resource. Replaces existing assignees by default. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the merge request to mutate. |
operationMode
| MutationOperationMode
| Operation to perform. Defaults to REPLACE. |
projectPath
| ID!
| 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
| 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!
| IID of the merge request to mutate. |
projectPath
| ID!
| 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
| 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!
| IID of the merge request to mutate. |
labelIds
| [LabelID!]!
| Label IDs to set. Replaces existing labels by default. |
operationMode
| MutationOperationMode
| Changes the operation mode. Defaults to REPLACE. |
projectPath
| ID!
| 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
| 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!
| IID of the merge request to mutate. |
locked
| Boolean!
| Whether or not to lock the merge request. |
projectPath
| ID!
| Project the merge request to mutate is in. |
Fields
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
| 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!
| IID of the merge request to mutate. |
milestoneId
| MilestoneID
| Milestone to assign to the merge request. |
projectPath
| ID!
| 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
| Merge request after mutation. |
Mutation.mergeRequestSetReviewers
Input type: MergeRequestSetReviewersInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iid
| String!
| IID of the merge request to mutate. |
operationMode
| MutationOperationMode
| Operation to perform. Defaults to REPLACE. |
projectPath
| ID!
| Project the merge request to mutate is in. |
reviewerUsernames
| [String!]!
| Usernames of reviewers to assign. Replaces existing reviewers by default. |
Fields
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
| 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!
| IID of the merge request to mutate. |
projectPath
| ID!
| Project the merge request to mutate is in. |
subscribedState
| Boolean!
| Desired state of the subscription. |
Fields
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
| 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!
| IID of the merge request to mutate. |
projectPath
| ID!
| Project the merge request to mutate is in. |
state
| MergeRequestNewState
| Action to perform to change the state. |
targetBranch
| String
| Target branch of the merge request. |
timeEstimate
| String
| Estimated time to complete the merge request. Use null or 0 to remove the current estimate.
|
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
| Merge request after mutation. |
Mutation.mergeRequestUpdateApprovalRule
Input type: MergeRequestUpdateApprovalRuleInput
Arguments
Name | Type | Description |
---|---|---|
approvalRuleId
| Int!
| ID of an approval rule. |
approvalsRequired
| Int!
| Number of required approvals for a given rule. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
groupIds
| [String!]
| IDs of groups as approvers. |
iid
| String!
| IID of the merge request to mutate. |
name
| String!
| Name of the approval rule. |
projectPath
| ID!
| Project the merge request to mutate is in. |
removeHiddenGroups
| Boolean
| Whether hidden groups should be removed. |
userIds
| [String!]
| IDs of users as approvers. |
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
| Merge request after mutation. |
Mutation.namespaceBanDestroy
Input type: NamespaceBanDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| NamespacesNamespaceBanID!
| Global ID of the namespace ban 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. |
namespaceBan
| NamespaceBan
| Namespace Ban. |
Mutation.namespaceCiCdSettingsUpdate
Input type: NamespaceCiCdSettingsUpdateInput
Arguments
Name | Type | Description |
---|---|---|
allowStaleRunnerPruning
| Boolean
| Indicates if stale runners directly belonging to this namespace should be periodically pruned. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| ID!
| Full path of the namespace the settings belong to. |
Fields
Name | Type | Description |
---|---|---|
ciCdSettings
| NamespaceCiCdSetting!
| 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.namespaceIncreaseStorageTemporarily
Input type: NamespaceIncreaseStorageTemporarilyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| NamespaceID!
| 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
| Namespace after mutation. |
Mutation.oncallRotationCreate
Input type: OncallRotationCreateInput
Arguments
Name | Type | Description |
---|---|---|
activePeriod
| OncallRotationActivePeriodInputType
| 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
| End date and time of the on-call rotation, in the timezone of the on-call schedule. |
name
| String!
| Name of the on-call rotation. |
participants
| [OncallUserInputType!]!
| Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. |
projectPath
| ID!
| Project to create the on-call schedule in. |
rotationLength
| OncallRotationLengthInputType!
| Rotation length of the on-call rotation. |
scheduleIid
| String!
| IID of the on-call schedule to create the on-call rotation in. |
startsAt
| OncallRotationDateInputType!
| Start date and time of the on-call rotation, in the timezone of the on-call schedule. |
Fields
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
| 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!
| ID of the on-call rotation to remove. |
projectPath
| ID!
| Project to remove the on-call schedule from. |
scheduleIid
| String!
| IID of the on-call schedule to the on-call rotation belongs to. |
Fields
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
| On-call rotation. |
Mutation.oncallRotationUpdate
Input type: OncallRotationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
activePeriod
| OncallRotationActivePeriodInputType
| 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
| End date and time of the on-call rotation, in the timezone of the on-call schedule. |
id
| IncidentManagementOncallRotationID!
| ID of the on-call schedule to create the on-call rotation in. |
name
| String
| Name of the on-call rotation. |
participants
| [OncallUserInputType!]
| Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. |
rotationLength
| OncallRotationLengthInputType
| Rotation length of the on-call rotation. |
startsAt
| OncallRotationDateInputType
| 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
| 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
| Description of the on-call schedule. |
name
| String!
| Name of the on-call schedule. |
projectPath
| ID!
| Project to create the on-call schedule in. |
timezone
| String!
| Timezone of the on-call schedule. |
Fields
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
| 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!
| On-call schedule internal ID to remove. |
projectPath
| ID!
| 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
| 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
| Description of the on-call schedule. |
iid
| String!
| On-call schedule internal ID to update. |
name
| String
| Name of the on-call schedule. |
projectPath
| ID!
| Project to update the on-call schedule in. |
timezone
| String
| 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
| On-call schedule. |
Mutation.organizationCreate
Input type: OrganizationCreateInput
Arguments
Name | Type | Description |
---|---|---|
avatar
| Upload
| Avatar for the organization. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the organization. |
name
| String!
| Name for the organization. |
path
| String!
| Path for the organization. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
organization
| Organization
| Organization after mutation. |
Mutation.organizationUpdate
Input type: OrganizationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
avatar
| Upload
| Avatar for the organization. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the organization. |
id
| OrganizationsOrganizationID!
| ID of the organization to mutate. |
name
| String
| Name for the organization. |
path
| String
| Path for the organization. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
organization
| Organization
| Organization after mutation. |
Mutation.pagesMarkOnboardingComplete
Input type: PagesMarkOnboardingCompleteInput
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 |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
onboardingComplete
| Boolean!
| Indicates the new onboarding_complete state of the project’s Pages metadata. |
Mutation.pipelineCancel
Input type: PipelineCancelInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiPipelineID!
| 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!
| 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!
| 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
| Pipeline after mutation. |
Mutation.pipelineScheduleCreate
Input type: PipelineScheduleCreateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Indicates if the pipeline schedule should be active or not. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
cron
| String!
| Cron expression of the pipeline schedule. |
cronTimezone
| String
| Cron time zone supported by ActiveSupport::TimeZone. For example: “Pacific Time (US & Canada)” (default: “UTC”). |
description
| String!
| Description of the pipeline schedule. |
projectPath
| ID!
| Full path of the project the pipeline schedule is associated with. |
ref
| String!
| Ref of the pipeline schedule. |
variables
| [PipelineScheduleVariableInput!]
| Variables for the pipeline schedule. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
pipelineSchedule
| PipelineSchedule
| Created pipeline schedule. |
Mutation.pipelineScheduleDelete
Input type: PipelineScheduleDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiPipelineScheduleID!
| ID of the pipeline schedule 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.pipelineSchedulePlay
Input type: PipelineSchedulePlayInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiPipelineScheduleID!
| ID of the pipeline schedule 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. |
pipelineSchedule
| PipelineSchedule
| Pipeline schedule after mutation. |
Mutation.pipelineScheduleTakeOwnership
Input type: PipelineScheduleTakeOwnershipInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiPipelineScheduleID!
| ID of the pipeline schedule 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. |
pipelineSchedule
| PipelineSchedule
| Updated pipeline schedule ownership. |
Mutation.pipelineScheduleUpdate
Input type: PipelineScheduleUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Indicates if the pipeline schedule should be active or not. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
cron
| String
| Cron expression of the pipeline schedule. |
cronTimezone
| String
| Cron time zone supported by ActiveSupport::TimeZone. For example: “Pacific Time (US & Canada)” (default: “UTC”). |
description
| String
| Description of the pipeline schedule. |
id
| CiPipelineScheduleID!
| ID of the pipeline schedule to mutate. |
ref
| String
| Ref of the pipeline schedule. |
variables
| [PipelineScheduleVariableInput!]
| Variables for the pipeline 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. |
pipelineSchedule
| PipelineSchedule
| Updated pipeline schedule. |
Mutation.pipelineTriggerCreate
Input type: PipelineTriggerCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String!
| Description of the pipeline trigger token. |
projectPath
| ID!
| Full path of the project that the pipeline trigger token 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. |
pipelineTrigger
| PipelineTrigger
| Mutated pipeline trigger token. |
Mutation.pipelineTriggerDelete
Input type: PipelineTriggerDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| CiTriggerID!
| ID of the pipeline trigger token 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.pipelineTriggerUpdate
Input type: PipelineTriggerUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String!
| Description of the pipeline trigger token. |
id
| CiTriggerID!
| ID of the pipeline trigger token 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. |
pipelineTrigger
| PipelineTrigger
| Mutated pipeline trigger token. |
Mutation.projectCiCdSettingsUpdate
Input type: ProjectCiCdSettingsUpdateInput
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. |
inboundJobTokenScopeEnabled
| Boolean
| Indicates CI/CD job tokens generated in other projects have restricted access to this project. |
jobTokenScopeEnabled | Boolean
| Deprecated: Outbound job token scope is being removed. This field can now only be set to false. Deprecated in 16.0. |
keepLatestArtifact
| Boolean
| Indicates if the latest artifact should be kept for the project. |
mergePipelinesEnabled
| Boolean
| Indicates if merge pipelines are enabled for the project. |
mergeTrainsEnabled
| Boolean
| Indicates if merge trains are enabled for the project. |
mergeTrainsSkipTrainAllowed
| Boolean
| Indicates whether an option is allowed to merge without refreshing the merge train. Ignored unless the merge_trains_skip_train feature flag is also enabled.
|
Fields
Name | Type | Description |
---|---|---|
ciCdSettings
| ProjectCiCdSetting!
| 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.projectInitializeProductAnalytics
Input type: ProjectInitializeProductAnalyticsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| Full path of the project to initialize. |
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 on which the initialization took place. |
Mutation.projectMemberBulkUpdate
Updates multiple members of a project. To use this mutation, you must have at least the Maintainer role.
Input type: ProjectMemberBulkUpdateInput
Arguments
Name | Type | Description |
---|---|---|
accessLevel
| MemberAccessLevel!
| Access level to update the members to. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
expiresAt
| Time
| Date and time the membership expires. |
projectId
| ProjectID!
| Global ID of the project. |
userIds
| [UserID!]!
| Global IDs of the members. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
projectMembers
| [ProjectMember!]
| Project members after mutation. |
Mutation.projectSetComplianceFramework
Assign (or unset) a compliance framework to a project.
Input type: ProjectSetComplianceFrameworkInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
complianceFrameworkId
| ComplianceManagementFrameworkID
| ID of the compliance framework to assign to the project. Set to null to unset.
|
projectId
| ProjectID!
| ID of the project to change the compliance framework of. |
Fields
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 after mutation. |
Mutation.projectSetContinuousVulnerabilityScanning
Enable/disable Continuous Vulnerability Scanning for the given project.
Input type: ProjectSetContinuousVulnerabilityScanningInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
enable
| Boolean!
| Desired status for Continuous Vulnerability Scanning feature. |
projectPath
| ID!
| Full path of the project. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
continuousVulnerabilityScanningEnabled
| Boolean!
| Whether feature is enabled. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.projectSetLocked
Input type: ProjectSetLockedInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
filePath
| String!
| Full path to the file. |
lock
| Boolean!
| Whether or not to lock the file path. |
projectPath
| ID!
| Full path of the project to mutate. |
Fields
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 after mutation. |
Mutation.projectSubscriptionCreate
Input type: ProjectSubscriptionCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| String!
| Full path of the downstream project of the Project Subscription. |
upstreamPath
| String!
| Full path of the upstream project of the Project 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. |
subscription
| CiSubscriptionsProject
| Project Subscription created by the mutation. |
Mutation.projectSubscriptionDelete
Input type: ProjectSubscriptionDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
subscriptionId
| CiSubscriptionsProjectID!
| ID of the subscription 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. |
project
| Project
| Project after mutation. |
Mutation.projectSyncFork
Input type: ProjectSyncForkInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectPath
| ID!
| Full path of the project to initialize. |
targetBranch
| String!
| Ref of the fork to fetch into. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
details
| ForkDetails
| Updated fork details. |
errors
| [String!]!
| Errors encountered during execution of the 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!
| 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
| 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!
| 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
| 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!
| 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
| 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
| Group the promoted epic will belong to. |
iid
| String!
| IID of the issue to mutate. |
projectPath
| ID!
| Project the issue to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| Epic after issue promotion. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| 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
| 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
| 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
| 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
| 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
| 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!]
| 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
| Commit SHA or branch name to use if creating a new tag. |
releasedAt
| Time
| Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z ). Only provide this field if creating an upcoming or historical release.
|
tagMessage
| String
| Message to use if creating a new annotated tag. |
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
| 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
| 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!]
| 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
| 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
| 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!
| Global ID of the DiffNote to update. |
position
| UpdateDiffImagePositionInput!
| 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
| Note after mutation. |
Mutation.runnerCreate
Input type: RunnerCreateInput
Arguments
Name | Type | Description |
---|---|---|
accessLevel
| CiRunnerAccessLevel
| Access level of the runner. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the runner. |
groupId
| GroupID
| Global ID of the group that the runner is created in (valid only for group runner). |
locked
| Boolean
| Indicates the runner is locked. |
maintenanceNote
| String
| Runner’s maintenance notes. |
maximumTimeout
| Int
| Maximum timeout (in seconds) for jobs processed by the runner. |
paused
| Boolean
| Indicates the runner is not allowed to receive jobs. |
projectId
| ProjectID
| Global ID of the project that the runner is created in (valid only for project runner). |
runUntagged
| Boolean
| Indicates the runner is able to run untagged jobs. |
runnerType
| CiRunnerType!
| Type of the runner to create. |
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
| Runner after mutation. |
Mutation.runnerDelete
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
Input type: RunnerUpdateInput
Arguments
Name | Type | Description |
---|---|---|
accessLevel
| CiRunnerAccessLevel
| Access level of the runner. |
active | Boolean
|
Deprecated: This was renamed. Please use paused . Deprecated in 14.8.
|
associatedProjects
| [ProjectID!]
| Projects associated with the runner. Available only for project runners. |
clientMutationId
| 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. |
maintenanceNote
| String
| Runner’s maintenance notes. |
maximumTimeout
| Int
| Maximum timeout (in seconds) for jobs processed by the runner. |
paused
| Boolean
| Indicates the runner is not allowed to receive jobs. |
privateProjectsMinutesCostFactor
| Float
| Private projects’ “compute cost factor” associated with the runner (GitLab.com only). |
publicProjectsMinutesCostFactor
| Float
| Public projects’ “compute cost factor” associated with the runner (GitLab.com only). |
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
| Runner after mutation. |
Mutation.runnersExportUsage
Input type: RunnersExportUsageInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
type
| CiRunnerType
| Scope of the runners to include in the report. |
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.runnersRegistrationTokenReset
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
| Runner token after mutation. |
Mutation.savedReplyCreate
Input type: SavedReplyCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
content
| String!
| Content of the saved reply. |
name
| String!
| Name of the saved reply. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
savedReply
| SavedReply
| Saved reply after mutation. |
Mutation.savedReplyDestroy
Input type: SavedReplyDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| UsersSavedReplyID!
| Global ID of the saved reply. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
savedReply
| SavedReply
| Saved reply after mutation. |
Mutation.savedReplyUpdate
Input type: SavedReplyUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
content
| String!
| Content of the saved reply. |
id
| UsersSavedReplyID!
| Global ID of the saved reply. |
name
| String!
| Name of the saved reply. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
savedReply
| SavedReply
| Saved reply after mutation. |
Mutation.scanExecutionPolicyCommit
Commits the policy_yaml
content to the assigned security policy project for the given project (full_path
).
Input type: ScanExecutionPolicyCommitInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| String
| Full path of the project. |
name
| String!
| Name of the policy. If the name is null, the name field from policy_yaml is used.
|
operationMode
| MutationOperationMode!
| Changes the operation mode. |
policyYaml
| String!
| YAML snippet of the policy. |
projectPath | ID
|
Deprecated: Use fullPath . Deprecated in 14.10.
|
Fields
Name | Type | Description |
---|---|---|
branch
| String
| Name of the branch to which the policy changes are committed. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
validationErrors
| [SecurityPolicyValidationError!]
| Validation errors encountered during execution of the mutation. |
Mutation.securityFindingCreateIssue
Input type: SecurityFindingCreateIssueInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
project
| ProjectID!
| ID of the project to attach the issue to. |
uuid
| String!
| UUID of the security finding to be used to create an issue. |
Fields
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
| Issue created after mutation. |
Mutation.securityFindingCreateMergeRequest
Input type: SecurityFindingCreateMergeRequestInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
uuid
| String!
| UUID of the security finding to be used to create a 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
| Merge Request created after mutation. |
Mutation.securityFindingDismiss
Input type: SecurityFindingDismissInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
comment
| String
| Comment why finding should be dismissed. |
dismissalReason
| VulnerabilityDismissalReason
| Reason why finding should be dismissed. |
uuid
| String!
| UUID of the finding 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. |
securityFinding
| PipelineSecurityReportFinding
| Dismissed finding. |
uuid
| String
| UUID of dismissed finding. |
Mutation.securityFindingRevertToDetected
Input type: SecurityFindingRevertToDetectedInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
comment
| String
| Comment that explains why finding was reverted to detected status. |
uuid
| String!
| UUID of the finding 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. |
securityFinding
| PipelineSecurityReportFinding
| Finding reverted to detected. |
Mutation.securityPolicyProjectAssign
Assigns the specified project(security_policy_project_id
) as security policy project for the given project(full_path
). If the project already has a security policy project, this reassigns the project’s security policy project with the given security_policy_project_id
.
Input type: SecurityPolicyProjectAssignInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| String
| Full path of the project or group. |
projectPath | ID
|
Deprecated: Use fullPath . Deprecated in 14.10.
|
securityPolicyProjectId
| ProjectID!
| ID of the security policy project. |
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.securityPolicyProjectCreate
Creates and assigns a security policy project for the given project or group (full_path
).
Input type: SecurityPolicyProjectCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| String
| Full path of the project or group. |
projectPath | ID
|
Deprecated: Use fullPath . Deprecated in 14.10.
|
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
| Security Policy Project that was created. |
Mutation.securityPolicyProjectUnassign
Unassigns the security policy project for the given project (full_path
).
Input type: SecurityPolicyProjectUnassignInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
fullPath
| String
| Full path of the project or group. |
projectPath | ID
|
Deprecated: Use fullPath . Deprecated in 14.10.
|
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.securityTrainingUpdate
Input type: SecurityTrainingUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
isEnabled
| Boolean!
| Sets the training provider as enabled for the project. |
isPrimary
| Boolean
| Sets the training provider as primary for the project. |
projectPath
| ID!
| Full path of the project. |
providerId
| SecurityTrainingProviderID!
| ID of the provider. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
training
| ProjectSecurityTraining
| Represents the training entity subject to mutation. |
Mutation.starProject
Input type: StarProjectInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectId
| ProjectID!
| Full path of the project to star or unstar. |
starred
| Boolean!
| Indicates whether to star or unstar the project. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
count
| String!
| Number of stars for the project. |
errors
| [String!]!
| Errors encountered during execution of the 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.timelineEventCreate
Input type: TimelineEventCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
incidentId
| IssueID!
| Incident ID of the timeline event. |
note
| String!
| Text note of the timeline event. |
occurredAt
| Time!
| Timestamp of when the event occurred. |
timelineEventTagNames
| [String!]
| Tags for the incident timeline event. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
timelineEvent
| TimelineEventType
| Timeline event. |
Mutation.timelineEventDestroy
Input type: TimelineEventDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IncidentManagementTimelineEventID!
| Timeline event 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. |
timelineEvent
| TimelineEventType
| Timeline event. |
Mutation.timelineEventPromoteFromNote
Input type: TimelineEventPromoteFromNoteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
noteId
| NoteID!
| Note ID from which the timeline event promoted. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
timelineEvent
| TimelineEventType
| Timeline event. |
Mutation.timelineEventTagCreate
Input type: TimelineEventTagCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| Name of the tag. |
projectPath
| ID!
| Project to create the timeline event tag in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
timelineEventTag
| TimelineEventTagType
| Timeline event tag. |
Mutation.timelineEventUpdate
Input type: TimelineEventUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| IncidentManagementTimelineEventID!
| ID of the timeline event to update. |
note
| String
| Text note of the timeline event. |
occurredAt
| Time
| Timestamp when the event occurred. |
timelineEventTagNames
| [String!]
| Tags for the incident timeline event. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
timelineEvent
| TimelineEventType
| Timeline event. |
Mutation.timelogCreate
Input type: TimelogCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
issuableId
| IssuableID!
| Global ID of the issuable (Issue, WorkItem or MergeRequest). |
spentAt
| Time!
| When the time was spent. |
summary
| String!
| Summary of time spent. |
timeSpent
| String!
| Amount of time spent. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
timelog
| Timelog
| Timelog. |
Mutation.timelogDelete
Input type: TimelogDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| TimelogID!
| Global ID of the timelog. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
timelog
| Timelog
| Timelog. |
Mutation.todoCreate
Input type: TodoCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
targetId
| TodoableID!
| Global ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported. |
Fields
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
| 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!
| 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!
| 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!
| 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!
| 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!]!
| 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. |
targetId
| TodoableID
| Global ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported. If argument is omitted, all pending to-do items of the current user are marked as done. |
Fields
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!
| IID of the alert to mutate. |
projectPath
| ID!
| Project the alert to mutate is in. |
status
| AlertManagementStatus!
| Status to set the alert. |
Fields
Name | Type | Description |
---|---|---|
alert
| AlertManagementAlert
| Alert after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issue
| Issue
| Issue created after mutation. |
todo
| Todo
| To-do item after mutation. |
Mutation.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!
| Board global ID. |
iterationCadenceId
| IterationsCadenceID
| ID of iteration cadence to be assigned to the board. |
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
| Board name. |
weight
| Int
| Weight value to be assigned to the board. |
Fields
Name | Type | Description |
---|---|---|
board
| Board
| 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!
| 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 the 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!
| 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
| 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!
| 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
| Container expiration policy after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateContainerRegistryProtectionRule
Updates a container registry protection rule to restrict access to project containers. You can prevent users without certain roles from altering containers. Available only when feature flag container_registry_protected_containers
is enabled.
Input type: UpdateContainerRegistryProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
deleteProtectedUpToAccessLevel
| ContainerRegistryProtectionRuleAccessLevel
| Maximum GitLab access level prevented from deleting a container. For example, DEVELOPER , MAINTAINER , OWNER .
|
id
| ContainerRegistryProtectionRuleID!
| Global ID of the container registry protection rule to be updated. |
pushProtectedUpToAccessLevel
| ContainerRegistryProtectionRuleAccessLevel
| Maximum GitLab access level prevented from pushing a container. For example, DEVELOPER , MAINTAINER , OWNER .
|
repositoryPathPattern
| String
| Container’s repository path pattern of the protection rule. For example, my-scope/my-project/container-dev-* . Wildcard character * allowed.
|
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
containerRegistryProtectionRule
| ContainerRegistryProtectionRule
| Container registry protection rule after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateDependencyProxyImageTtlGroupPolicy
These settings can be adjusted by the group Owner or Maintainer. Issue 370471 proposes limiting this to Owners only to match the permissions level in the user interface.
Input type: UpdateDependencyProxyImageTtlGroupPolicyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
enabled
| Boolean
| Indicates whether the policy is enabled or disabled. |
groupPath
| ID!
| Group path for the group dependency proxy image TTL policy. |
ttl
| Int
| Number of days to retain a cached image file. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dependencyProxyImageTtlPolicy
| DependencyProxyImageTtlGroupPolicy
| Group image TTL policy after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateDependencyProxyPackagesSettings
Updates or creates dependency proxy for packages settings.
Requires the packages and dependency proxy to be enabled in the config.
Requires the packages feature to be enabled at the project level.
Error is raised if packages_dependency_proxy_maven
feature flag is disabled.
Input type: UpdateDependencyProxyPackagesSettingsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
enabled
| Boolean
| Indicates whether the dependency proxy for packages is enabled for the project. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time. |
mavenExternalRegistryPassword
| String
| Password for the external Maven packages registry. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time. |
mavenExternalRegistryUrl
| String
| URL for the external Maven packages registry. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time. |
mavenExternalRegistryUsername
| String
| Username for the external Maven packages registry. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time. |
projectPath
| ID!
| Project path for the dependency proxy for packages settings. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dependencyProxyPackagesSetting
| DependencyProxyPackagesSetting
| Dependency proxy for packages settings after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateDependencyProxySettings
These settings can be adjusted by the group Owner or Maintainer. Issue 370471 proposes limiting this to Owners only to match the permissions level in the user interface.
Input type: UpdateDependencyProxySettingsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
enabled
| Boolean
| Indicates whether the policy is enabled or disabled. |
groupPath
| ID!
| Group path for the group dependency proxy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
dependencyProxySetting
| DependencyProxySetting
| Group dependency proxy settings after mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
Mutation.updateEpic
Input type: UpdateEpicInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
| [ID!]
| IDs of labels to be added to the epic. |
addLabels
| [String!]
| Array of labels to be added to the epic. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
color
| Color
| Color of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
|
confidential
| Boolean
| Indicates if the epic is confidential. |
description
| String
| Description of the epic. |
dueDateFixed
| String
| End date of the epic. |
dueDateIsFixed
| Boolean
| Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
groupPath
| ID!
| Group the epic to mutate is in. |
iid
| ID!
| IID of the epic to mutate. |
removeLabelIds
| [ID!]
| IDs of labels to be removed from the epic. |
removeLabels
| [String!]
| Array of labels to be removed from the epic. |
startDateFixed
| String
| 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
| Title of the epic. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
epic
| Epic
| 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 the 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 an 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!
| Global ID of the note to update. |
position
| UpdateDiffImagePositionInput
| 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
| Note after mutation. |
Mutation.updateIssue
Input type: UpdateIssueInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
| [ID!]
| 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
| ID of the parent epic. NULL when removing the association. |
healthStatus
| HealthStatus
| Desired health status. |
iid
| String!
| IID of the issue to mutate. |
labelIds
| [ID!]
| IDs of labels to be set. Replaces existing issue labels. |
locked
| Boolean
| Indicates discussion is locked on the issue. |
milestoneId
| ID
| ID of the milestone to assign to the issue. On update milestone will be removed if set to null. |
projectPath
| ID!
| Project the issue to mutate is in. |
removeLabelIds
| [ID!]
| IDs of labels to be removed from the issue. |
stateEvent
| IssueStateEvent
| Close or reopen an issue. |
timeEstimate
| String
| Estimated time to complete the issue. Use null or 0 to remove the current estimate.
|
title
| String
| Title of the issue. |
type
| IssueType
| Type of the issue. |
weight
| Int
| 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
| 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
These settings can be adjusted by the group Owner or Maintainer. Issue 370471 proposes limiting this to Owners only to match the permissions level in the user interface.
Input type: UpdateNamespacePackageSettingsInput
Arguments
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. |
lockMavenPackageRequestsForwarding
| Boolean
| Indicates whether Maven package forwarding is locked for all descendent namespaces. |
lockNpmPackageRequestsForwarding
| Boolean
| Indicates whether npm package forwarding is locked for all descendent namespaces. |
lockPypiPackageRequestsForwarding
| Boolean
| Indicates whether PyPI package forwarding is locked for all descendent namespaces. |
mavenDuplicateExceptionRegex
| 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. |
mavenPackageRequestsForwarding
| Boolean
| Indicates whether Maven package forwarding is allowed for this namespace. |
namespacePath
| ID!
| Namespace path where the namespace package setting is located. |
npmPackageRequestsForwarding
| Boolean
| Indicates whether npm package forwarding is allowed for this namespace. |
nugetDuplicateExceptionRegex
| UntrustedRegexp
| When nuget_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
nugetDuplicatesAllowed
| Boolean
| Indicates whether duplicate NuGet packages are allowed for this namespace. |
nugetSymbolServerEnabled
| Boolean
| Indicates wheather the NuGet symbol server is enabled for this namespace. |
pypiPackageRequestsForwarding
| Boolean
| Indicates whether PyPI package forwarding is allowed for this namespace. |
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
| 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 an 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
| Deprecated: No longer allowed to update confidentiality of notes. Deprecated in 14.10. |
id
| NoteID!
| 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
| Note after mutation. |
Mutation.updatePackagesCleanupPolicy
Input type: UpdatePackagesCleanupPolicyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
keepNDuplicatedPackageFiles
| PackagesCleanupKeepDuplicatedPackageFilesEnum
| Number of duplicated package files to retain. |
projectPath
| ID!
| Project path where the packages cleanup policy 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. |
packagesCleanupPolicy
| PackagesCleanupPolicy
| Packages cleanup policy after mutation. |
Mutation.updatePackagesProtectionRule
Updates a package protection rule to restrict access to project packages. You can prevent users without certain permissions from altering packages. Available only when feature flag packages_protected_packages
is enabled.
Input type: UpdatePackagesProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| PackagesProtectionRuleID!
| Global ID of the package protection rule to be updated. |
packageNamePattern
| String
| Package name protected by the protection rule. For example, @my-scope/my-package-* . Wildcard character * allowed.
|
packageType
| PackagesProtectionRulePackageType
| Package type protected by the protection rule. For example, NPM .
|
pushProtectedUpToAccessLevel
| PackagesProtectionRuleAccessLevel
| Maximum GitLab access level unable to push a package. For example, DEVELOPER , MAINTAINER , OWNER .
|
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
packageProtectionRule
| PackagesProtectionRule
| Packages protection rule 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
| Deprecated: Use work_item_iid instead. Deprecated in 15.8. |
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. |
workItemIid
| String
| IID of the requirement work item 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. |
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. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
description
| String
| Description of the snippet. |
id
| SnippetID!
| Global ID of the snippet to update. |
title
| String
| Title of the snippet. |
visibilityLevel
| VisibilityLevelsEnum
| Visibility level of the snippet. |
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
| Snippet after mutation. |
Mutation.uploadDelete
Deletes an upload.
Input type: UploadDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
filename
| String!
| Upload filename. |
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. |
secret
| String!
| Secret part of upload path. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
upload
| FileUpload
| Deleted upload. |
Mutation.userAchievementPrioritiesUpdate
Input type: UserAchievementPrioritiesUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
userAchievementIds
| [AchievementsUserAchievementID!]!
| Global IDs of the user achievements being prioritized, ordered from highest to lowest priority. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
userAchievements
| [UserAchievement!]!
| Updated user achievements. |
Mutation.userAchievementsDelete
Input type: UserAchievementsDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
userAchievementId
| AchievementsUserAchievementID!
| Global ID of the user achievement being 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. |
userAchievement
| UserAchievement
| Deleted user achievement. |
Mutation.userAddOnAssignmentCreate
Input type: UserAddOnAssignmentCreateInput
Arguments
Name | Type | Description |
---|---|---|
addOnPurchaseId
| GitlabSubscriptionsAddOnPurchaseID!
| Global ID of AddOnPurchase to be assigned to. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
userId
| UserID!
| Global ID of user to be assigned. |
Fields
Name | Type | Description |
---|---|---|
addOnPurchase
| AddOnPurchase
| AddOnPurchase state after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
user
| AddOnUser
| User who the add-on purchase was assigned to. |
Mutation.userAddOnAssignmentRemove
Input type: UserAddOnAssignmentRemoveInput
Arguments
Name | Type | Description |
---|---|---|
addOnPurchaseId
| GitlabSubscriptionsAddOnPurchaseID!
| Global ID of AddOnPurchase assignment belongs to. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
userId
| UserID!
| Global ID of user whose assignment will be removed. |
Fields
Name | Type | Description |
---|---|---|
addOnPurchase
| AddOnPurchase
| AddOnPurchase state after mutation. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
user
| AddOnUser
| User that the add-on was removed from. |
Mutation.userCalloutCreate
Input type: UserCalloutCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
featureName
| String!
| 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!
| User callout dismissed. |
Mutation.userPreferencesUpdate
Input type: UserPreferencesUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
issuesSort
| IssueSort
| Sort order for issue lists. |
useWebIdeExtensionMarketplace
| Boolean
| Whether Web IDE Extension Marketplace is enabled for the user. |
visibilityPipelineIdType
| VisibilityPipelineIdType
| Determines whether the pipeline list shows ID or IID. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
userPreferences
| UserPreferences
| User preferences after mutation. |
Mutation.userSetNamespaceCommitEmail
Input type: UserSetNamespaceCommitEmailInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
emailId
| EmailID
| ID of the email to set. |
namespaceId
| NamespaceID!
| ID of the namespace to set the namespace commit email 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. |
namespaceCommitEmail
| NamespaceCommitEmail
| User namespace commit email after mutation. |
Mutation.valueStreamCreate
Creates a value stream.
Input type: ValueStreamCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
name
| String!
| Value stream name. |
namespacePath
| ID!
| Full path of the namespace(project or group) the value stream is created in. |
setting
| ValueStreamSettingInput
| Value stream configuration. |
stages
| [ValueStreamStageInput!]
| Value stream custom stages. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
valueStream
| ValueStream
| Created value stream. |
Mutation.valueStreamDestroy
Destroy a value stream.
Input type: ValueStreamDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AnalyticsCycleAnalyticsValueStreamID!
| Global ID of the value stream 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. |
valueStream
| ValueStream
| Value stream deleted after mutation. |
Mutation.valueStreamUpdate
Updates a value stream.
Input type: ValueStreamUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| AnalyticsCycleAnalyticsValueStreamID!
| Global ID of the value stream to update. |
name
| String
| Value stream name. |
setting
| ValueStreamSettingInput
| Value stream configuration. |
stages
| [ValueStreamStageInput!]
| Value stream custom stages. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
valueStream
| ValueStream
| Updated value stream. |
Mutation.vulnerabilitiesDismiss
Input type: VulnerabilitiesDismissInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
comment
| String
| Comment why vulnerability was dismissed (maximum 50,000 characters). |
dismissalReason
| VulnerabilityDismissalReason
| Reason why vulnerability should be dismissed. |
vulnerabilityIds
| [VulnerabilityID!]!
| IDs of the vulnerabilities to be dismissed (maximum 100 entries). |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
vulnerabilities
| [Vulnerability!]!
| Vulnerabilities after state change. |
Mutation.vulnerabilitiesRemoveAllFromProject
Input type: VulnerabilitiesRemoveAllFromProjectInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
projectIds
| [ProjectID!]!
| IDs of project for which all Vulnerabilities should be removed. The deletion will happen in the background so the changes will not be visible immediately. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
projects
| [Project!]!
| Projects for which the deletion was scheduled. |
Mutation.vulnerabilityConfirm
Input type: VulnerabilityConfirmInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
comment
| String
| Comment why vulnerability was confirmed (maximum 50,000 characters). |
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
| Vulnerability after state change. |
Mutation.vulnerabilityCreate
Input type: VulnerabilityCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidence | VulnerabilityConfidence
| Deprecated: This field will be removed from the Vulnerability domain model. Deprecated in 15.4. |
confirmedAt
| Time
| Timestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is confirmed ).
|
description
| String!
| Long text section that describes the vulnerability in more detail. |
detectedAt
| Time
| Timestamp of when the vulnerability was first detected (defaults to creation time). |
dismissedAt
| Time
| Timestamp of when the vulnerability state changed to dismissed (defaults to creation time if status is dismissed ).
|
identifiers
| [VulnerabilityIdentifierInput!]!
| Array of CVE or CWE identifiers for the vulnerability. |
message | String
| Deprecated: message field has been removed from security reports schema. Deprecated in 16.1. |
name
| String!
| Name of the vulnerability. |
project
| ProjectID!
| ID of the project to attach the vulnerability to. |
resolvedAt
| Time
| Timestamp of when the vulnerability state changed to resolved (defaults to creation time if status is resolved ).
|
scanner
| VulnerabilityScannerInput!
| Information about the scanner used to discover the vulnerability. |
severity
| VulnerabilitySeverity
| Severity of the vulnerability (defaults to unknown ).
|
solution
| String
| Instructions for how to fix the vulnerability. |
state
| VulnerabilityState
| State of the vulnerability (defaults to detected ).
|
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
| Vulnerability created. |
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 was dismissed (maximum 50,000 characters). |
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
| Vulnerability after state change. |
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
| 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!
| 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.vulnerabilityIssueLinkCreate
Input type: VulnerabilityIssueLinkCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
issueId
| IssueID!
| ID of the issue to link to. |
vulnerabilityIds
| [VulnerabilityID!]!
| IDs of vulnerabilities to link to the given issue. Up to 100 can be provided. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
issueLinks
| [VulnerabilityIssueLink!]
| Created issue links. |
Mutation.vulnerabilityResolve
Input type: VulnerabilityResolveInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
comment
| String
| Comment why vulnerability was resolved (maximum 50,000 characters). |
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
| Vulnerability after state change. |
Mutation.vulnerabilityRevertToDetected
Input type: VulnerabilityRevertToDetectedInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
comment
| String
| Comment why vulnerability was reverted to detected (maximum 50,000 characters). |
id
| VulnerabilityID!
| ID of the vulnerability to be reverted to detected. |
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
| Vulnerability after state change. |
Mutation.workItemAddLinkedItems
Add linked items to the work item.
Input type: WorkItemAddLinkedItemsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| WorkItemID!
| Global ID of the work item. |
linkType
| WorkItemRelatedLinkType
| Type of link. Defaults to RELATED .
|
workItemsIds
| [WorkItemID!]!
| Global IDs of the items to link. Maximum number of IDs you can provide: 10. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
message
| String
| Linked items update result message. |
workItem
| WorkItem
| Updated work item. |
Mutation.workItemConvert
Converts the work item to a new type.
Input type: WorkItemConvertInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| WorkItemID!
| Global ID of the work item. |
workItemTypeId
| WorkItemsTypeID!
| Global ID of the new work item type. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
workItem
| WorkItem
| Updated work item. |
Mutation.workItemCreate
Creates a work item.
Input type: WorkItemCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| Sets the work item confidentiality. |
description
| String
| Description of the work item. |
hierarchyWidget
| WorkItemWidgetHierarchyCreateInput
| Input for hierarchy widget. |
iterationWidget
| WorkItemWidgetIterationInput
| Iteration widget of the work item. |
milestoneWidget
| WorkItemWidgetMilestoneInput
| Input for milestone widget. |
namespacePath
| ID
| Full path of the namespace(project or group) the work item is created in. |
projectPath | ID
| Deprecated: Please use namespace_path instead. That will cover for both projects and groups. Deprecated in 15.10. |
title
| String!
| Title of the work item. |
workItemTypeId
| WorkItemsTypeID!
| Global ID of a work item type. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
workItem
| WorkItem
| Created work item. |
Mutation.workItemCreateFromTask
Creates a work item from a task in another work item’s description.
Input type: WorkItemCreateFromTaskInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| WorkItemID!
| Global ID of the work item. |
workItemData
| WorkItemConvertTaskInput!
| Arguments necessary to convert a task into a work item. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
newWorkItem
| WorkItem
| New work item created from task. |
workItem
| WorkItem
| Updated work item. |
Mutation.workItemDelete
Deletes a work item.
Input type: WorkItemDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| WorkItemID!
| Global ID of the work item. |
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 the deleted work item belonged to. |
Mutation.workItemExport
Input type: WorkItemExportInput
Arguments
Name | Type | Description |
---|---|---|
authorUsername | String
| Deprecated: This feature is an Experiment. It can be changed or removed at any time. Introduced in 15.9. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
iids
| [String!]
| List of IIDs of work items. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
projectPath
| ID!
| Full project path. |
search
| String
| Search query for title or description. |
selectedFields
| [AvailableExportFields!]
| List of selected fields to be exported. Omit to export all available fields. |
state
| IssuableState
| Current state of the work item. |
types
| [IssueType!]
| Filter work items by the given work item types. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
message
| String
| Export request result message. |
Mutation.workItemRemoveLinkedItems
Remove items linked to the work item.
Input type: WorkItemRemoveLinkedItemsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| WorkItemID!
| Global ID of the work item. |
workItemsIds
| [WorkItemID!]!
| Global IDs of the items to unlink. Maximum number of IDs you can provide: 10. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
message
| String
| Linked items update result message. |
workItem
| WorkItem
| Updated work item. |
Mutation.workItemSubscribe
Input type: WorkItemSubscribeInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| WorkItemID!
| Global ID of the work item. |
subscribed
| Boolean!
| 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. |
workItem
| WorkItem
| Work item after mutation. |
Mutation.workItemUpdate
Updates a work item by Global ID.
Input type: WorkItemUpdateInput
Arguments
Name | Type | Description |
---|---|---|
assigneesWidget
| WorkItemWidgetAssigneesInput
| Input for assignees widget. |
awardEmojiWidget
| WorkItemWidgetAwardEmojiUpdateInput
| Input for emoji reactions widget. |
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
confidential
| Boolean
| Sets the work item confidentiality. |
currentUserTodosWidget
| WorkItemWidgetCurrentUserTodosInput
| Input for to-dos widget. |
descriptionWidget
| WorkItemWidgetDescriptionInput
| Input for description widget. |
healthStatusWidget
| WorkItemWidgetHealthStatusInput
| Input for health status widget. |
hierarchyWidget
| WorkItemWidgetHierarchyUpdateInput
| Input for hierarchy widget. |
id
| WorkItemID!
| Global ID of the work item. |
iterationWidget
| WorkItemWidgetIterationInput
| Input for iteration widget. |
labelsWidget
| WorkItemWidgetLabelsUpdateInput
| Input for labels widget. |
milestoneWidget
| WorkItemWidgetMilestoneInput
| Input for milestone widget. |
notificationsWidget
| WorkItemWidgetNotificationsUpdateInput
| Input for notifications widget. |
progressWidget
| WorkItemWidgetProgressInput
| Input for progress widget. |
startAndDueDateWidget
| WorkItemWidgetStartAndDueDateUpdateInput
| Input for start and due date widget. |
stateEvent
| WorkItemStateEvent
| Close or reopen a work item. |
statusWidget
| StatusInput
| Input for status widget. |
title
| String
| Title of the work item. |
weightWidget
| WorkItemWidgetWeightInput
| Input for weight widget. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
workItem
| WorkItem
| Updated work item. |
Mutation.workItemUpdateTask
Updates a work item’s task by Global ID.
Input type: WorkItemUpdateTaskInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
id
| WorkItemID!
| Global ID of the work item. |
taskData
| WorkItemUpdatedTaskInput!
| Arguments necessary to update a task. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
task
| WorkItem
| Updated task. |
workItem
| WorkItem
| Updated work item. |
Mutation.workspaceCreate
Input type: WorkspaceCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
clusterAgentId
| ClustersAgentID!
| GlobalID of the cluster agent the created workspace will be associated with. |
desiredState
| String!
| Desired state of the created workspace. |
devfilePath
| String!
| Project repo git path containing the devfile used to configure the workspace. |
devfileRef
| String!
| Project repo git ref containing the devfile used to configure the workspace. |
editor
| String!
| Editor to inject into the created workspace. Must match a configured template. |
maxHoursBeforeTermination
| Int!
| Maximum hours the workspace can exist before it is automatically terminated. |
projectId
| ProjectID!
| ID of the project that will provide the Devfile for the created workspace. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
workspace
| Workspace
| Created workspace. |
Mutation.workspaceUpdate
Input type: WorkspaceUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
desiredState
| String!
| Desired state of the created workspace. |
id
| RemoteDevelopmentWorkspaceID!
| Global ID of the workspace. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
workspace
| Workspace
| Created workspace. |
Connections
Some types in our schema are Connection
types - they represent a paginated
collection of edges between two nodes in the graph. These follow the
Relay cursor connections specification.
Pagination arguments
All connection fields support the following pagination arguments:
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.
AchievementConnection
The connection type for Achievement
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [AchievementEdge]
| A list of edges. |
nodes
| [Achievement]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
AchievementEdge
The edge type for Achievement
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Achievement
| The item at the end of the edge. |
AddOnUserConnection
The connection type for AddOnUser
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [AddOnUserEdge]
| A list of edges. |
nodes
| [AddOnUser]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
AddOnUserEdge
The edge type for AddOnUser
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AddOnUser
| The item at the end of the edge. |
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. |
AiMessageConnection
The connection type for AiMessage
.
Fields
Name | Type | Description |
---|---|---|
edges
| [AiMessageEdge]
| A list of edges. |
nodes
| [AiMessage]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
AiMessageEdge
The edge type for AiMessage
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AiMessage
| 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. |
AmazonS3ConfigurationTypeConnection
The connection type for AmazonS3ConfigurationType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [AmazonS3ConfigurationTypeEdge]
| A list of edges. |
nodes
| [AmazonS3ConfigurationType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
AmazonS3ConfigurationTypeEdge
The edge type for AmazonS3ConfigurationType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AmazonS3ConfigurationType
| The item at the end of the edge. |
ApprovalProjectRuleConnection
The connection type for ApprovalProjectRule
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ApprovalProjectRuleEdge]
| A list of edges. |
nodes
| [ApprovalProjectRule]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ApprovalProjectRuleEdge
The edge type for ApprovalProjectRule
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ApprovalProjectRule
| The item at the end of the edge. |
AuditEventDefinitionConnection
The connection type for AuditEventDefinition
.
Fields
Name | Type | Description |
---|---|---|
edges
| [AuditEventDefinitionEdge]
| A list of edges. |
nodes
| [AuditEventDefinition]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
AuditEventDefinitionEdge
The edge type for AuditEventDefinition
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AuditEventDefinition
| The item at the end of the edge. |
AuditEventStreamingHeaderConnection
The connection type for AuditEventStreamingHeader
.
Fields
Name | Type | Description |
---|---|---|
edges
| [AuditEventStreamingHeaderEdge]
| A list of edges. |
nodes
| [AuditEventStreamingHeader]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
AuditEventStreamingHeaderEdge
The edge type for AuditEventStreamingHeader
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AuditEventStreamingHeader
| The item at the end of the edge. |
AuditEventsStreamingInstanceHeaderConnection
The connection type for AuditEventsStreamingInstanceHeader
.
Fields
Name | Type | Description |
---|---|---|
edges
| [AuditEventsStreamingInstanceHeaderEdge]
| A list of edges. |
nodes
| [AuditEventsStreamingInstanceHeader]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
AuditEventsStreamingInstanceHeaderEdge
The edge type for AuditEventsStreamingInstanceHeader
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| AuditEventsStreamingInstanceHeader
| 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 |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [BoardEpicEdge]
| A list of edges. |
nodes
| [BoardEpic]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
BoardEpicEdge
The edge type for BoardEpic
.
Fields
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. |
BranchRuleConnection
The connection type for BranchRule
.
Fields
Name | Type | Description |
---|---|---|
edges
| [BranchRuleEdge]
| A list of edges. |
nodes
| [BranchRule]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
BranchRuleEdge
The edge type for BranchRule
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| BranchRule
| 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. |
CiCatalogResourceComponentConnection
The connection type for CiCatalogResourceComponent
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiCatalogResourceComponentEdge]
| A list of edges. |
nodes
| [CiCatalogResourceComponent]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiCatalogResourceComponentEdge
The edge type for CiCatalogResourceComponent
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiCatalogResourceComponent
| The item at the end of the edge. |
CiCatalogResourceConnection
The connection type for CiCatalogResource
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [CiCatalogResourceEdge]
| A list of edges. |
nodes
| [CiCatalogResource]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiCatalogResourceEdge
The edge type for CiCatalogResource
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiCatalogResource
| The item at the end of the edge. |
CiCatalogResourceVersionConnection
The connection type for CiCatalogResourceVersion
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [CiCatalogResourceVersionEdge]
| A list of edges. |
nodes
| [CiCatalogResourceVersion]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiCatalogResourceVersionEdge
The edge type for CiCatalogResourceVersion
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiCatalogResourceVersion
| 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. |
CiGroupEnvironmentScopeConnection
The connection type for CiGroupEnvironmentScope
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiGroupEnvironmentScopeEdge]
| A list of edges. |
nodes
| [CiGroupEnvironmentScope]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiGroupEnvironmentScopeEdge
The edge type for CiGroupEnvironmentScope
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiGroupEnvironmentScope
| The item at the end of the edge. |
CiGroupVariableConnection
The connection type for CiGroupVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiGroupVariableEdge]
| A list of edges. |
limit
| Int!
| Maximum amount of group CI/CD variables. |
nodes
| [CiGroupVariable]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiGroupVariableEdge
The edge type for CiGroupVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiGroupVariable
| The item at the end of the edge. |
CiInstanceVariableConnection
The connection type for CiInstanceVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiInstanceVariableEdge]
| A list of edges. |
nodes
| [CiInstanceVariable]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiInstanceVariableEdge
The edge type for CiInstanceVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiInstanceVariable
| 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 |
---|---|---|
edges
| [CiJobEdge]
| A list of edges. |
nodes
| [CiJob]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
Fields with arguments
CiJobConnection.count
Limited count of collection. Returns limit + 1 for counts greater than the limit.
Returns Int!
.
# Arguments
Name | Type | Description |
---|---|---|
limit
| Int
| Limit value to be applied to the count query. Default is 1000. |
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. |
CiManualVariableConnection
The connection type for CiManualVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiManualVariableEdge]
| A list of edges. |
nodes
| [CiManualVariable]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiManualVariableEdge
The edge type for CiManualVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiManualVariable
| The item at the end of the edge. |
CiMinutesNamespaceMonthlyUsageConnection
The connection type for CiMinutesNamespaceMonthlyUsage
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiMinutesNamespaceMonthlyUsageEdge]
| A list of edges. |
nodes
| [CiMinutesNamespaceMonthlyUsage]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiMinutesNamespaceMonthlyUsageEdge
The edge type for CiMinutesNamespaceMonthlyUsage
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiMinutesNamespaceMonthlyUsage
| The item at the end of the edge. |
CiMinutesProjectMonthlyUsageConnection
The connection type for CiMinutesProjectMonthlyUsage
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiMinutesProjectMonthlyUsageEdge]
| A list of edges. |
nodes
| [CiMinutesProjectMonthlyUsage]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiMinutesProjectMonthlyUsageEdge
The edge type for CiMinutesProjectMonthlyUsage
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiMinutesProjectMonthlyUsage
| The item at the end of the edge. |
CiProjectVariableConnection
The connection type for CiProjectVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiProjectVariableEdge]
| A list of edges. |
limit
| Int!
| Maximum amount of project CI/CD variables. |
nodes
| [CiProjectVariable]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiProjectVariableEdge
The edge type for CiProjectVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiProjectVariable
| The item at the end of the edge. |
CiRunnerConnection
The connection type for CiRunner
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [CiRunnerEdge]
| A list of edges. |
jobsStatistics
| CiJobsStatistics
| Jobs statistics for jobs executed by a collection of runners. Available only to admins. |
nodes
| [CiRunner]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiRunnerEdge
The edge type for CiRunner
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
editUrl
| String
| Web URL of the runner edit page. The value depends on where you put this field in the query. You can use it for projects or groups. |
node
| CiRunner
| The item at the end of the edge. |
webUrl
| String
| Web URL of the runner. The value depends on where you put this field in the query. You can use it for projects or groups. |
CiRunnerManagerConnection
The connection type for CiRunnerManager
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [CiRunnerManagerEdge]
| A list of edges. |
nodes
| [CiRunnerManager]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiRunnerManagerEdge
The edge type for CiRunnerManager
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiRunnerManager
| The item at the end of the edge. |
CiSecureFileRegistryConnection
The connection type for CiSecureFileRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CiSecureFileRegistryEdge]
| A list of edges. |
nodes
| [CiSecureFileRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiSecureFileRegistryEdge
The edge type for CiSecureFileRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiSecureFileRegistry
| 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. |
CiSubscriptionsProjectConnection
The connection type for CiSubscriptionsProject
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [CiSubscriptionsProjectEdge]
| A list of edges. |
nodes
| [CiSubscriptionsProject]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CiSubscriptionsProjectEdge
The edge type for CiSubscriptionsProject
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CiSubscriptionsProject
| The item at the end of the edge. |
ClusterAgentActivityEventConnection
The connection type for ClusterAgentActivityEvent
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [ClusterAgentActivityEventEdge]
| A list of edges. |
nodes
| [ClusterAgentActivityEvent]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ClusterAgentActivityEventEdge
The edge type for ClusterAgentActivityEvent
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ClusterAgentActivityEvent
| The item at the end of the edge. |
ClusterAgentAuthorizationCiAccessConnection
The connection type for ClusterAgentAuthorizationCiAccess
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ClusterAgentAuthorizationCiAccessEdge]
| A list of edges. |
nodes
| [ClusterAgentAuthorizationCiAccess]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ClusterAgentAuthorizationCiAccessEdge
The edge type for ClusterAgentAuthorizationCiAccess
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ClusterAgentAuthorizationCiAccess
| The item at the end of the edge. |
ClusterAgentAuthorizationUserAccessConnection
The connection type for ClusterAgentAuthorizationUserAccess
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ClusterAgentAuthorizationUserAccessEdge]
| A list of edges. |
nodes
| [ClusterAgentAuthorizationUserAccess]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ClusterAgentAuthorizationUserAccessEdge
The edge type for ClusterAgentAuthorizationUserAccess
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ClusterAgentAuthorizationUserAccess
| 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. |
ComplianceStandardsAdherenceConnection
The connection type for ComplianceStandardsAdherence
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ComplianceStandardsAdherenceEdge]
| A list of edges. |
nodes
| [ComplianceStandardsAdherence]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ComplianceStandardsAdherenceEdge
The edge type for ComplianceStandardsAdherence
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ComplianceStandardsAdherence
| The item at the end of the edge. |
ComplianceViolationConnection
The connection type for ComplianceViolation
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ComplianceViolationEdge]
| A list of edges. |
nodes
| [ComplianceViolation]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ComplianceViolationEdge
The edge type for ComplianceViolation
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ComplianceViolation
| The item at the end of the edge. |
ConnectedAgentConnection
The connection type for ConnectedAgent
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ConnectedAgentEdge]
| A list of edges. |
nodes
| [ConnectedAgent]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ConnectedAgentEdge
The edge type for ConnectedAgent
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ConnectedAgent
| 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. |
ContainerRepositoryRegistryConnection
The connection type for ContainerRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ContainerRepositoryRegistryEdge]
| A list of edges. |
nodes
| [ContainerRepositoryRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ContainerRepositoryRegistryEdge
The edge type for ContainerRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ContainerRepositoryRegistry
| 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. |
ContributionAnalyticsContributionConnection
The connection type for ContributionAnalyticsContribution
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ContributionAnalyticsContributionEdge]
| A list of edges. |
nodes
| [ContributionAnalyticsContribution]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ContributionAnalyticsContributionEdge
The edge type for ContributionAnalyticsContribution
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ContributionAnalyticsContribution
| The item at the end of the edge. |
CoverageFuzzingCorpusConnection
The connection type for CoverageFuzzingCorpus
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CoverageFuzzingCorpusEdge]
| A list of edges. |
nodes
| [CoverageFuzzingCorpus]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CoverageFuzzingCorpusEdge
The edge type for CoverageFuzzingCorpus
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CoverageFuzzingCorpus
| The item at the end of the edge. |
CustomEmojiConnection
The connection type for CustomEmoji
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
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. |
CustomerRelationsContactConnection
The connection type for CustomerRelationsContact
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CustomerRelationsContactEdge]
| A list of edges. |
nodes
| [CustomerRelationsContact]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CustomerRelationsContactEdge
The edge type for CustomerRelationsContact
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CustomerRelationsContact
| The item at the end of the edge. |
CustomerRelationsOrganizationConnection
The connection type for CustomerRelationsOrganization
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CustomerRelationsOrganizationEdge]
| A list of edges. |
nodes
| [CustomerRelationsOrganization]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CustomerRelationsOrganizationEdge
The edge type for CustomerRelationsOrganization
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CustomerRelationsOrganization
| The item at the end of the edge. |
CustomizableDashboardConnection
The connection type for CustomizableDashboard
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CustomizableDashboardEdge]
| A list of edges. |
nodes
| [CustomizableDashboard]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CustomizableDashboardEdge
The edge type for CustomizableDashboard
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CustomizableDashboard
| The item at the end of the edge. |
CustomizableDashboardPanelConnection
The connection type for CustomizableDashboardPanel
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CustomizableDashboardPanelEdge]
| A list of edges. |
nodes
| [CustomizableDashboardPanel]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CustomizableDashboardPanelEdge
The edge type for CustomizableDashboardPanel
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CustomizableDashboardPanel
| The item at the end of the edge. |
CustomizableDashboardVisualizationConnection
The connection type for CustomizableDashboardVisualization
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CustomizableDashboardVisualizationEdge]
| A list of edges. |
nodes
| [CustomizableDashboardVisualization]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CustomizableDashboardVisualizationEdge
The edge type for CustomizableDashboardVisualization
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CustomizableDashboardVisualization
| The item at the end of the edge. |
CustomizablePermissionConnection
The connection type for CustomizablePermission
.
Fields
Name | Type | Description |
---|---|---|
edges
| [CustomizablePermissionEdge]
| A list of edges. |
nodes
| [CustomizablePermission]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
CustomizablePermissionEdge
The edge type for CustomizablePermission
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| CustomizablePermission
| The item at the end of the edge. |
DastProfileConnection
The connection type for DastProfile
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [DastProfileEdge]
| A list of edges. |
nodes
| [DastProfile]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
DastProfileEdge
The edge type for DastProfile
.
Fields
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. |
DependencyConnection
The connection type for Dependency
.
Fields
Name | Type | Description |
---|---|---|
edges
| [DependencyEdge]
| A list of edges. |
nodes
| [Dependency]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
DependencyEdge
The edge type for Dependency
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Dependency
| The item at the end of the edge. |
DependencyProxyBlobConnection
The connection type for DependencyProxyBlob
.
Fields
Name | Type | Description |
---|---|---|
edges
| [DependencyProxyBlobEdge]
| A list of edges. |
nodes
| [DependencyProxyBlob]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
DependencyProxyBlobEdge
The edge type for DependencyProxyBlob
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DependencyProxyBlob
| The item at the end of the edge. |
DependencyProxyBlobRegistryConnection
The connection type for DependencyProxyBlobRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [DependencyProxyBlobRegistryEdge]
| A list of edges. |
nodes
| [DependencyProxyBlobRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
DependencyProxyBlobRegistryEdge
The edge type for DependencyProxyBlobRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DependencyProxyBlobRegistry
| The item at the end of the edge. |
DependencyProxyManifestConnection
The connection type for DependencyProxyManifest
.
Fields
Name | Type | Description |
---|---|---|
edges
| [DependencyProxyManifestEdge]
| A list of edges. |
nodes
| [DependencyProxyManifest]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
DependencyProxyManifestEdge
The edge type for DependencyProxyManifest
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DependencyProxyManifest
| The item at the end of the edge. |
DependencyProxyManifestRegistryConnection
The connection type for DependencyProxyManifestRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [DependencyProxyManifestRegistryEdge]
| A list of edges. |
nodes
| [DependencyProxyManifestRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
DependencyProxyManifestRegistryEdge
The edge type for DependencyProxyManifestRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DependencyProxyManifestRegistry
| The item at the end of the edge. |
DeploymentConnection
The connection type for Deployment
.
Fields
Name | Type | Description |
---|---|---|
edges
| [DeploymentEdge]
| A list of edges. |
nodes
| [Deployment]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
DeploymentEdge
The edge type for Deployment
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Deployment
| 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. |
DesignManagementRepositoryRegistryConnection
The connection type for DesignManagementRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [DesignManagementRepositoryRegistryEdge]
| A list of edges. |
nodes
| [DesignManagementRepositoryRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
DesignManagementRepositoryRegistryEdge
The edge type for DesignManagementRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DesignManagementRepositoryRegistry
| 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. |
DoraPerformanceScoreCountConnection
The connection type for DoraPerformanceScoreCount
.
Fields
Name | Type | Description |
---|---|---|
edges
| [DoraPerformanceScoreCountEdge]
| A list of edges. |
noDoraDataProjectsCount
| Int!
| Count of projects without any DORA scores within the scope. |
nodes
| [DoraPerformanceScoreCount]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
totalProjectsCount
| Int!
| Count of total projects. |
DoraPerformanceScoreCountEdge
The edge type for DoraPerformanceScoreCount
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| DoraPerformanceScoreCount
| The item at the end of the edge. |
EgressNodeConnection
The connection type for EgressNode
.
Fields
Name | Type | Description |
---|---|---|
edges
| [EgressNodeEdge]
| A list of edges. |
nodes
| [EgressNode]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
EgressNodeEdge
The edge type for EgressNode
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| EgressNode
| The item at the end of the edge. |
EmailConnection
The connection type for Email
.
Fields
Name | Type | Description |
---|---|---|
edges
| [EmailEdge]
| A list of edges. |
nodes
| [Email]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
EmailEdge
The edge type for Email
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Email
| 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 |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [EpicEdge]
| A list of edges. |
nodes
| [Epic]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
EpicEdge
The edge type for Epic
.
Fields
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. |
ExternalAuditEventDestinationConnection
The connection type for ExternalAuditEventDestination
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ExternalAuditEventDestinationEdge]
| A list of edges. |
nodes
| [ExternalAuditEventDestination]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ExternalAuditEventDestinationEdge
The edge type for ExternalAuditEventDestination
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ExternalAuditEventDestination
| The item at the end of the edge. |
ExternalStatusCheckConnection
The connection type for ExternalStatusCheck
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ExternalStatusCheckEdge]
| A list of edges. |
nodes
| [ExternalStatusCheck]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ExternalStatusCheckEdge
The edge type for ExternalStatusCheck
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ExternalStatusCheck
| The item at the end of the edge. |
ForecastDatapointConnection
The connection type for ForecastDatapoint
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ForecastDatapointEdge]
| A list of edges. |
nodes
| [ForecastDatapoint]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ForecastDatapointEdge
The edge type for ForecastDatapoint
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ForecastDatapoint
| The item at the end of the edge. |
GoogleCloudLoggingConfigurationTypeConnection
The connection type for GoogleCloudLoggingConfigurationType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [GoogleCloudLoggingConfigurationTypeEdge]
| A list of edges. |
nodes
| [GoogleCloudLoggingConfigurationType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
GoogleCloudLoggingConfigurationTypeEdge
The edge type for GoogleCloudLoggingConfigurationType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| GoogleCloudLoggingConfigurationType
| The item at the end of the edge. |
GroupConnection
The connection type for Group
.
Fields
Name | Type | Description |
---|---|---|
edges
| [GroupEdge]
| A list of edges. |
nodes
| [Group]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
GroupEdge
The edge type for Group
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Group
| 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. |
InheritedCiVariableConnection
The connection type for InheritedCiVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
| [InheritedCiVariableEdge]
| A list of edges. |
nodes
| [InheritedCiVariable]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
InheritedCiVariableEdge
The edge type for InheritedCiVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| InheritedCiVariable
| The item at the end of the edge. |
InstanceAmazonS3ConfigurationTypeConnection
The connection type for InstanceAmazonS3ConfigurationType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [InstanceAmazonS3ConfigurationTypeEdge]
| A list of edges. |
nodes
| [InstanceAmazonS3ConfigurationType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
InstanceAmazonS3ConfigurationTypeEdge
The edge type for InstanceAmazonS3ConfigurationType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| InstanceAmazonS3ConfigurationType
| The item at the end of the edge. |
InstanceExternalAuditEventDestinationConnection
The connection type for InstanceExternalAuditEventDestination
.
Fields
Name | Type | Description |
---|---|---|
edges
| [InstanceExternalAuditEventDestinationEdge]
| A list of edges. |
nodes
| [InstanceExternalAuditEventDestination]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
InstanceExternalAuditEventDestinationEdge
The edge type for InstanceExternalAuditEventDestination
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| InstanceExternalAuditEventDestination
| The item at the end of the edge. |
InstanceGoogleCloudLoggingConfigurationTypeConnection
The connection type for InstanceGoogleCloudLoggingConfigurationType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [InstanceGoogleCloudLoggingConfigurationTypeEdge]
| A list of edges. |
nodes
| [InstanceGoogleCloudLoggingConfigurationType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
InstanceGoogleCloudLoggingConfigurationTypeEdge
The edge type for InstanceGoogleCloudLoggingConfigurationType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| InstanceGoogleCloudLoggingConfigurationType
| The item at the end of the edge. |
IssuableResourceLinkConnection
The connection type for IssuableResourceLink
.
Fields
Name | Type | Description |
---|---|---|
edges
| [IssuableResourceLinkEdge]
| A list of edges. |
nodes
| [IssuableResourceLink]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
IssuableResourceLinkEdge
The edge type for IssuableResourceLink
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| IssuableResourceLink
| 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. |
JobArtifactRegistryConnection
The connection type for JobArtifactRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [JobArtifactRegistryEdge]
| A list of edges. |
nodes
| [JobArtifactRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
JobArtifactRegistryEdge
The edge type for JobArtifactRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| JobArtifactRegistry
| The item at the end of the edge. |
JobNeedUnionConnection
The connection type for JobNeedUnion
.
Fields
Name | Type | Description |
---|---|---|
edges
| [JobNeedUnionEdge]
| A list of edges. |
nodes
| [JobNeedUnion]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
JobNeedUnionEdge
The edge type for JobNeedUnion
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| JobNeedUnion
| 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. |
LinkedWorkItemTypeConnection
The connection type for LinkedWorkItemType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [LinkedWorkItemTypeEdge]
| A list of edges. |
nodes
| [LinkedWorkItemType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
LinkedWorkItemTypeEdge
The edge type for LinkedWorkItemType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| LinkedWorkItemType
| 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. |
MemberRoleConnection
The connection type for MemberRole
.
Fields
Name | Type | Description |
---|---|---|
edges
| [MemberRoleEdge]
| A list of edges. |
nodes
| [MemberRole]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
MemberRoleEdge
The edge type for MemberRole
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MemberRole
| The item at the end of the edge. |
MergeAccessLevelConnection
The connection type for MergeAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
edges
| [MergeAccessLevelEdge]
| A list of edges. |
nodes
| [MergeAccessLevel]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
MergeAccessLevelEdge
The edge type for MergeAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeAccessLevel
| The item at the end of the edge. |
MergeRequestAssigneeConnection
The connection type for MergeRequestAssignee
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
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. |
MergeRequestDiffConnection
The connection type for MergeRequestDiff
.
Fields
Name | Type | Description |
---|---|---|
edges
| [MergeRequestDiffEdge]
| A list of edges. |
nodes
| [MergeRequestDiff]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
MergeRequestDiffEdge
The edge type for MergeRequestDiff
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeRequestDiff
| The item at the end of the edge. |
MergeRequestDiffLlmSummaryConnection
The connection type for MergeRequestDiffLlmSummary
.
Fields
Name | Type | Description |
---|---|---|
edges
| [MergeRequestDiffLlmSummaryEdge]
| A list of edges. |
nodes
| [MergeRequestDiffLlmSummary]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
MergeRequestDiffLlmSummaryEdge
The edge type for MergeRequestDiffLlmSummary
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeRequestDiffLlmSummary
| The item at the end of the edge. |
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. |
MergeRequestParticipantConnection
The connection type for MergeRequestParticipant
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [MergeRequestParticipantEdge]
| A list of edges. |
nodes
| [MergeRequestParticipant]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
MergeRequestParticipantEdge
The edge type for MergeRequestParticipant
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeRequestParticipant
| The item at the end of the edge. |
MergeRequestReviewLlmSummaryConnection
The connection type for MergeRequestReviewLlmSummary
.
Fields
Name | Type | Description |
---|---|---|
edges
| [MergeRequestReviewLlmSummaryEdge]
| A list of edges. |
nodes
| [MergeRequestReviewLlmSummary]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
MergeRequestReviewLlmSummaryEdge
The edge type for MergeRequestReviewLlmSummary
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MergeRequestReviewLlmSummary
| The item at the end of the edge. |
MergeRequestReviewerConnection
The connection type for MergeRequestReviewer
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
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. |
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. |
MlCandidateConnection
The connection type for MlCandidate
.
Fields
Name | Type | Description |
---|---|---|
edges
| [MlCandidateEdge]
| A list of edges. |
nodes
| [MlCandidate]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
Fields with arguments
MlCandidateConnection.count
Limited count of collection. Returns limit + 1 for counts greater than the limit.
Returns Int!
.
# Arguments
Name | Type | Description |
---|---|---|
limit
| Int
| Limit value to be applied to the count query. Default is 1000. |
MlCandidateEdge
The edge type for MlCandidate
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MlCandidate
| The item at the end of the edge. |
MlModelVersionConnection
The connection type for MlModelVersion
.
Fields
Name | Type | Description |
---|---|---|
edges
| [MlModelVersionEdge]
| A list of edges. |
nodes
| [MlModelVersion]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
Fields with arguments
MlModelVersionConnection.count
Limited count of collection. Returns limit + 1 for counts greater than the limit.
Returns Int!
.
# Arguments
Name | Type | Description |
---|---|---|
limit
| Int
| Limit value to be applied to the count query. Default is 1000. |
MlModelVersionEdge
The edge type for MlModelVersion
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| MlModelVersion
| The item at the end of the edge. |
NamespaceCommitEmailConnection
The connection type for NamespaceCommitEmail
.
Fields
Name | Type | Description |
---|---|---|
edges
| [NamespaceCommitEmailEdge]
| A list of edges. |
nodes
| [NamespaceCommitEmail]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
NamespaceCommitEmailEdge
The edge type for NamespaceCommitEmail
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| NamespaceCommitEmail
| 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. |
NestedEnvironmentConnection
The connection type for NestedEnvironment
.
Fields
Name | Type | Description |
---|---|---|
edges
| [NestedEnvironmentEdge]
| A list of edges. |
nodes
| [NestedEnvironment]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
NestedEnvironmentEdge
The edge type for NestedEnvironment
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| NestedEnvironment
| 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 |
---|---|---|
count
| Int!
| Total count of collection. |
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. |
OrganizationConnection
The connection type for Organization
.
Fields
Name | Type | Description |
---|---|---|
edges
| [OrganizationEdge]
| A list of edges. |
nodes
| [Organization]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
OrganizationEdge
The edge type for Organization
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Organization
| The item at the end of the edge. |
OrganizationUserConnection
The connection type for OrganizationUser
.
Fields
Name | Type | Description |
---|---|---|
edges
| [OrganizationUserEdge]
| A list of edges. |
nodes
| [OrganizationUser]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
OrganizationUserEdge
The edge type for OrganizationUser
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| OrganizationUser
| The item at the end of the edge. |
PackageBaseConnection
The connection type for PackageBase
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [PackageBaseEdge]
| A list of edges. |
nodes
| [PackageBase]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PackageBaseEdge
The edge type for PackageBase
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PackageBase
| The item at the end of the edge. |
PackageConnection
The connection type for Package
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [PackageEdge]
| A list of edges. |
nodes
| [Package]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PackageDependencyLinkConnection
The connection type for PackageDependencyLink
.
Fields
Name | Type | Description |
---|---|---|
edges
| [PackageDependencyLinkEdge]
| A list of edges. |
nodes
| [PackageDependencyLink]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PackageDependencyLinkEdge
The edge type for PackageDependencyLink
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PackageDependencyLink
| The item at the end of the edge. |
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. |
PackagesProtectionRuleConnection
The connection type for PackagesProtectionRule
.
Fields
Name | Type | Description |
---|---|---|
edges
| [PackagesProtectionRuleEdge]
| A list of edges. |
nodes
| [PackagesProtectionRule]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PackagesProtectionRuleEdge
The edge type for PackagesProtectionRule
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PackagesProtectionRule
| The item at the end of the edge. |
PagesDeploymentRegistryConnection
The connection type for PagesDeploymentRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [PagesDeploymentRegistryEdge]
| A list of edges. |
nodes
| [PagesDeploymentRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PagesDeploymentRegistryEdge
The edge type for PagesDeploymentRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PagesDeploymentRegistry
| 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. |
PendingGroupMemberConnection
The connection type for PendingGroupMember
.
Fields
Name | Type | Description |
---|---|---|
edges
| [PendingGroupMemberEdge]
| A list of edges. |
nodes
| [PendingGroupMember]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PendingGroupMemberEdge
The edge type for PendingGroupMember
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PendingGroupMember
| 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. |
PipelineScheduleConnection
The connection type for PipelineSchedule
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [PipelineScheduleEdge]
| A list of edges. |
nodes
| [PipelineSchedule]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PipelineScheduleEdge
The edge type for PipelineSchedule
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PipelineSchedule
| The item at the end of the edge. |
PipelineScheduleVariableConnection
The connection type for PipelineScheduleVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
| [PipelineScheduleVariableEdge]
| A list of edges. |
nodes
| [PipelineScheduleVariable]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PipelineScheduleVariableEdge
The edge type for PipelineScheduleVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PipelineScheduleVariable
| 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. |
PipelineTriggerConnection
The connection type for PipelineTrigger
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [PipelineTriggerEdge]
| A list of edges. |
nodes
| [PipelineTrigger]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PipelineTriggerEdge
The edge type for PipelineTrigger
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PipelineTrigger
| The item at the end of the edge. |
ProjectConnection
The connection type for Project
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [ProjectEdge]
| A list of edges. |
nodes
| [Project]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ProjectEdge
The edge type for Project
.
Fields
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. |
ProjectRepositoryRegistryConnection
The connection type for ProjectRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ProjectRepositoryRegistryEdge]
| A list of edges. |
nodes
| [ProjectRepositoryRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ProjectRepositoryRegistryEdge
The edge type for ProjectRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ProjectRepositoryRegistry
| The item at the end of the edge. |
ProjectWikiRepositoryRegistryConnection
The connection type for ProjectWikiRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ProjectWikiRepositoryRegistryEdge]
| A list of edges. |
nodes
| [ProjectWikiRepositoryRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ProjectWikiRepositoryRegistryEdge
The edge type for ProjectWikiRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ProjectWikiRepositoryRegistry
| The item at the end of the edge. |
ProtectedEnvironmentApprovalRuleConnection
The connection type for ProtectedEnvironmentApprovalRule
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ProtectedEnvironmentApprovalRuleEdge]
| A list of edges. |
nodes
| [ProtectedEnvironmentApprovalRule]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ProtectedEnvironmentApprovalRuleEdge
The edge type for ProtectedEnvironmentApprovalRule
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ProtectedEnvironmentApprovalRule
| The item at the end of the edge. |
ProtectedEnvironmentConnection
The connection type for ProtectedEnvironment
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ProtectedEnvironmentEdge]
| A list of edges. |
nodes
| [ProtectedEnvironment]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ProtectedEnvironmentDeployAccessLevelConnection
The connection type for ProtectedEnvironmentDeployAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ProtectedEnvironmentDeployAccessLevelEdge]
| A list of edges. |
nodes
| [ProtectedEnvironmentDeployAccessLevel]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ProtectedEnvironmentDeployAccessLevelEdge
The edge type for ProtectedEnvironmentDeployAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ProtectedEnvironmentDeployAccessLevel
| The item at the end of the edge. |
ProtectedEnvironmentEdge
The edge type for ProtectedEnvironment
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ProtectedEnvironment
| The item at the end of the edge. |
PushAccessLevelConnection
The connection type for PushAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
edges
| [PushAccessLevelEdge]
| A list of edges. |
nodes
| [PushAccessLevel]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
PushAccessLevelEdge
The edge type for PushAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| PushAccessLevel
| 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. |
SavedReplyConnection
The connection type for SavedReply
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [SavedReplyEdge]
| A list of edges. |
nodes
| [SavedReply]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
SavedReplyEdge
The edge type for SavedReply
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| SavedReply
| 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. |
ScanResultPolicyConnection
The connection type for ScanResultPolicy
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ScanResultPolicyEdge]
| A list of edges. |
nodes
| [ScanResultPolicy]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ScanResultPolicyEdge
The edge type for ScanResultPolicy
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ScanResultPolicy
| 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. |
hasUnretrievableBlobs
| Boolean!
| Indicates if the snippet has unretrievable blobs. |
nodes
| [SnippetBlob]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
SnippetBlobEdge
The edge type for SnippetBlob
.
Fields
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. |
SubscriptionFutureEntryConnection
The connection type for SubscriptionFutureEntry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [SubscriptionFutureEntryEdge]
| A list of edges. |
nodes
| [SubscriptionFutureEntry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
SubscriptionFutureEntryEdge
The edge type for SubscriptionFutureEntry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| SubscriptionFutureEntry
| 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. |
TimeTrackingTimelogCategoryConnection
The connection type for TimeTrackingTimelogCategory
.
Fields
Name | Type | Description |
---|---|---|
edges
| [TimeTrackingTimelogCategoryEdge]
| A list of edges. |
nodes
| [TimeTrackingTimelogCategory]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
TimeTrackingTimelogCategoryEdge
The edge type for TimeTrackingTimelogCategory
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TimeTrackingTimelogCategory
| The item at the end of the edge. |
TimelineEventTagTypeConnection
The connection type for TimelineEventTagType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [TimelineEventTagTypeEdge]
| A list of edges. |
nodes
| [TimelineEventTagType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
TimelineEventTagTypeEdge
The edge type for TimelineEventTagType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TimelineEventTagType
| The item at the end of the edge. |
TimelineEventTypeConnection
The connection type for TimelineEventType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [TimelineEventTypeEdge]
| A list of edges. |
nodes
| [TimelineEventType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
TimelineEventTypeEdge
The edge type for TimelineEventType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| TimelineEventType
| The item at the end of the edge. |
TimelogConnection
The connection type for Timelog
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [TimelogEdge]
| A list of edges. |
nodes
| [Timelog]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
totalSpentTime
| BigInt!
| Total time spent in seconds. |
TimelogEdge
The edge type for Timelog
.
Fields
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. |
TopicConnection
The connection type for Topic
.
Fields
Name | Type | Description |
---|---|---|
edges
| [TopicEdge]
| A list of edges. |
nodes
| [Topic]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
TopicEdge
The edge type for Topic
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Topic
| The item at the end of the edge. |
TreeConnection
The connection type for Tree
.
Fields
Name | Type | Description |
---|---|---|
edges
| [TreeEdge]
| A list of edges. |
nodes
| [Tree]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
TreeEdge
The edge type for Tree
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Tree
| 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. |
UnprotectAccessLevelConnection
The connection type for UnprotectAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
edges
| [UnprotectAccessLevelEdge]
| A list of edges. |
nodes
| [UnprotectAccessLevel]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
UnprotectAccessLevelEdge
The edge type for UnprotectAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| UnprotectAccessLevel
| The item at the end of the edge. |
UploadRegistryConnection
The connection type for UploadRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
| [UploadRegistryEdge]
| A list of edges. |
nodes
| [UploadRegistry]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
UploadRegistryEdge
The edge type for UploadRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| UploadRegistry
| 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. |
UserAchievementConnection
The connection type for UserAchievement
.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Total count of collection. |
edges
| [UserAchievementEdge]
| A list of edges. |
nodes
| [UserAchievement]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
UserAchievementEdge
The edge type for UserAchievement
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| UserAchievement
| The item at the end of the edge. |
UserAddOnAssignmentConnection
The connection type for UserAddOnAssignment
.
Fields
Name | Type | Description |
---|---|---|
edges
| [UserAddOnAssignmentEdge]
| A list of edges. |
nodes
| [UserAddOnAssignment]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
UserAddOnAssignmentEdge
The edge type for UserAddOnAssignment
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| UserAddOnAssignment
| 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 |
---|---|---|
count
| Int!
| Total count of collection. |
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. |
ValueStreamConnection
The connection type for ValueStream
.
Fields
Name | Type | Description |
---|---|---|
edges
| [ValueStreamEdge]
| A list of edges. |
nodes
| [ValueStream]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
ValueStreamEdge
The edge type for ValueStream
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| ValueStream
| 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. |
VulnerabilityContainerImageConnection
The connection type for VulnerabilityContainerImage
.
Fields
Name | Type | Description |
---|---|---|
edges
| [VulnerabilityContainerImageEdge]
| A list of edges. |
nodes
| [VulnerabilityContainerImage]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
VulnerabilityContainerImageEdge
The edge type for VulnerabilityContainerImage
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| VulnerabilityContainerImage
| The item at the end of the edge. |
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. |
VulnerabilityStateTransitionTypeConnection
The connection type for VulnerabilityStateTransitionType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [VulnerabilityStateTransitionTypeEdge]
| A list of edges. |
nodes
| [VulnerabilityStateTransitionType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
VulnerabilityStateTransitionTypeEdge
The edge type for VulnerabilityStateTransitionType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| VulnerabilityStateTransitionType
| The item at the end of the edge. |
WorkItemConnection
The connection type for WorkItem
.
Fields
Name | Type | Description |
---|---|---|
edges
| [WorkItemEdge]
| A list of edges. |
nodes
| [WorkItem]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
WorkItemEdge
The edge type for WorkItem
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| WorkItem
| The item at the end of the edge. |
WorkItemTypeConnection
The connection type for WorkItemType
.
Fields
Name | Type | Description |
---|---|---|
edges
| [WorkItemTypeEdge]
| A list of edges. |
nodes
| [WorkItemType]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
WorkItemTypeEdge
The edge type for WorkItemType
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| WorkItemType
| The item at the end of the edge. |
WorkspaceConnection
The connection type for Workspace
.
Fields
Name | Type | Description |
---|---|---|
edges
| [WorkspaceEdge]
| A list of edges. |
nodes
| [Workspace]
| A list of nodes. |
pageInfo
| PageInfo!
| Information to aid in pagination. |
WorkspaceEdge
The edge type for Workspace
.
Fields
Name | Type | Description |
---|---|---|
cursor
| String!
| A cursor for use in pagination. |
node
| Workspace
| 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
.
AbuseReport
An abuse report.
Fields
Name | Type | Description |
---|---|---|
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
id
| AbuseReportID!
| Global ID of the abuse report. |
labels
| LabelConnection
| Labels of the abuse report. (see Connections) |
Fields with arguments
AbuseReport.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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. |
AccessLevelDeployKey
Representation of a GitLab deploy key.
Fields
Name | Type | Description |
---|---|---|
expiresAt
| Date
| Expiration date of the deploy key. |
id
| ID!
| ID of the deploy key. |
title
| String!
| Title of the deploy key. |
user
| AccessLevelUser!
| User assigned to the deploy key. |
AccessLevelGroup
Representation of a GitLab group.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| Avatar URL of the group. |
id
| ID!
| ID of the group. |
name
| String!
| Name of the group. |
parent
| AccessLevelGroup
| Parent group. |
webUrl
| String!
| Web URL of the group. |
AccessLevelUser
Representation of a GitLab user.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
id
| ID!
| ID of the user. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
publicEmail
| String
| User’s public email. |
username
| String!
| Username of the user. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Achievement
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL to avatar of the achievement. |
createdAt
| Time!
| Timestamp the achievement was created. |
description
| String
| Description or notes for the achievement. |
id
| AchievementsAchievementID!
| ID of the achievement. |
name
| String!
| Name of the achievement. |
namespace
| Namespace
| Namespace of the achievement. |
updatedAt
| Time!
| Timestamp the achievement was last updated. |
userAchievements | UserAchievementConnection
| Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Recipients for the achievement. |
AddOnPurchase
Represents AddOn purchase for Namespace.
Fields
Name | Type | Description |
---|---|---|
assignedQuantity
| Int!
| Number of seats assigned. |
id
| GitlabSubscriptionsAddOnPurchaseID!
| ID of AddOnPurchase. |
name
| String!
| Name of AddOn. |
purchasedQuantity
| Int!
| Number of seats purchased. |
AddOnUser
A user with add-on data.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
lastLoginAt
| Time
| Timestamp of the last sign in. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
AddOnUser.addOnAssignments
Add-on purchase assignments for the user.
Returns UserAddOnAssignmentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
addOnPurchaseIds
| [GitlabSubscriptionsAddOnPurchaseID!]!
| Global IDs of the add on purchases to find assignments for. |
AddOnUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
AddOnUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
AddOnUser.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
AddOnUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
AddOnUser.savedReply
Saved reply authored by the user.
Returns SavedReply
.
Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
AddOnUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| Visibility of the snippet. |
AddOnUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
AddOnUser.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
AddOnUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
AddOnUser.workspaces
Workspaces owned by the current user.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
AgentConfiguration
Configuration details for an Agent.
Fields
Name | Type | Description |
---|---|---|
agentName
| String
| Name of the agent. |
AgentMetadata
Information about a connected Agent.
Fields
Name | Type | Description |
---|---|---|
commit
| String
| Agent version commit. |
podName
| String
| Name of the pod running the Agent. |
podNamespace
| String
| Namespace of the pod running the Agent. |
version
| String
| Agent version tag. |
AiMessage
AI features communication message.
Fields
Name | Type | Description |
---|---|---|
chunkId
| Int
| Incremental ID for a chunk from a streamed message. Null when it is not a streamed message. |
content
| String
| Raw response content. |
contentHtml
| String
| Response content as HTML. |
errors
| [String!]
| Message errors. |
extras
| AiMessageExtras
| Extra message metadata. |
id
| ID
| UUID of the message. |
requestId
| String
| UUID of the original request. Shared between chat prompt and response. |
role
| AiMessageRole!
| Message owner role. |
timestamp
| Time!
| Message creation timestamp. |
type
| AiMessageType
| Message type. |
AiMessageExtras
Extra metadata for AI message.
Fields
Name | Type | Description |
---|---|---|
sources
| [JSON!]
| Sources used to form the message. |
AlertManagementAlert
Describes an alert from the project’s Alert Management.
Fields
Name | Type | Description |
---|---|---|
assignees
| UserCoreConnection
| Assignees of the alert. (see Connections) |
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
createdAt
| Time
| Timestamp the alert was created. |
description
| String
| Description of the alert. |
details
| JSON
| Alert details. |
detailsUrl
| String!
| 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. |
id
| ID!
| ID of the alert. |
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
| Deprecated in 16.0. Returns no data. Underlying feature was removed in 16.0. |
monitoringTool
| String
| Monitoring tool the alert came from. |
prometheusAlert
| PrometheusAlert
| 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. |
webUrl
| String!
| URL of the alert. |
Fields with arguments
AlertManagementAlert.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
AlertManagementAlertStatusCountsType
Represents total number of alerts for the represented categories.
Fields
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
| 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
| 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. |
AmazonS3ConfigurationType
Stores Amazon S3 configurations for audit event streaming.
Fields
Name | Type | Description |
---|---|---|
accessKeyXid
| String!
| Access key ID of the Amazon S3 account. |
awsRegion
| String!
| AWS region where the bucket is created. |
bucketName
| String!
| Name of the bucket where the audit events would be logged. |
group
| Group!
| Group the configuration belongs to. |
id
| ID!
| ID of the configuration. |
name
| String!
| Name of the external destination to send audit events to. |
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
| Short description of the profile. |
name
| String
| Unique name of the profile. |
yaml
| String
| Syntax highlighted HTML representation of the YAML. |
ApprovalProjectRule
Describes a project approval rule regarding who can approve merge requests.
Fields
Name | Type | Description |
---|---|---|
approvalsRequired
| Int
| Number of required approvals. |
eligibleApprovers
| UserCoreConnection
| List of users eligible to approve merge requests for this approval rule. (see Connections) |
id
| GlobalID!
| ID of the rule. |
name
| String
| Name of the rule. |
type
| ApprovalRuleType
| Type of the rule. |
ApprovalRule
Describes a rule for who can approve merge requests.
Fields
Name | Type | Description |
---|---|---|
allowMergeWhenInvalid
| Boolean
| Indicates if the rule can be ignored if it is invalid. |
approvalsRequired
| Int
| Number of required approvals. |
approved
| Boolean
| Indicates if the rule is satisfied. |
approvedBy
| UserCoreConnection
| List of users defined in the rule that approved the merge request. (see Connections) |
commentedBy
| UserCoreConnection
| List of users, defined in the rule, who commented on the merge request. (see Connections) |
containsHiddenGroups
| Boolean
| Indicates if the rule contains approvers from a hidden group. |
eligibleApprovers
| [UserCore!]
| List of all users eligible to approve the merge request (defined explicitly and from associated groups). |
groups
| GroupConnection
| List of groups added as approvers for the rule. (see Connections) |
id
| GlobalID!
| ID of the rule. |
invalid
| Boolean
| Indicates if the rule is invalid and cannot be approved. |
name
| String
| Name of the rule. |
overridden
| Boolean
| Indicates if the rule was overridden for the merge request. |
scanResultPolicies
| [ApprovalScanResultPolicy!]
| List of scan result policies associated with the rule. |
section
| String
| Named section of the Code Owners file that the rule applies to. |
sourceRule
| ApprovalRule
| Source rule used to create the rule. |
type
| ApprovalRuleType
| Type of the rule. |
users
| UserCoreConnection
| List of users added as approvers for the rule. (see Connections) |
ApprovalScanResultPolicy
Represents the scan result policy.
Fields
Name | Type | Description |
---|---|---|
approvalsRequired
| Int!
| Represents the required approvals defined in the policy. |
name
| String!
| Represents the name of the policy. |
reportType
| ApprovalReportType!
| Represents the report_type of the approval rule. |
AssetType
Represents a vulnerability asset type.
Fields
Name | Type | Description |
---|---|---|
name
| String!
| Name of the asset. |
type
| String!
| Type of the asset. |
url
| String!
| URL of the asset. |
AuditEventDefinition
Represents the YAML definitions for audit events defined in ee/config/audit_events/types/<event-type-name>.yml
and config/audit_events/types/<event-type-name>.yml
.
Fields
Name | Type | Description |
---|---|---|
description
| String!
| Description of what action the audit event tracks. |
featureCategory
| String!
| Feature category associated with the event. |
introducedByIssue
| String
| Link to the issue introducing the event. For olderaudit events, it can be a commit URL rather than amerge request URL. |
introducedByMr
| String
| Link to the merge request introducing the event. Forolder audit events, it can be a commit URL rather thana merge request URL. |
milestone
| String!
| Milestone the event was introduced in. |
name
| String!
| Key name of the audit event. |
savedToDatabase
| Boolean!
| Indicates if the event is saved to PostgreSQL database. |
streamed
| Boolean!
| Indicates if the event is streamed to an external destination. |
AuditEventStreamingHTTPNamespaceFilter
Represents a subgroup or project filter that belongs to an external audit event streaming destination.
Fields
Name | Type | Description |
---|---|---|
externalAuditEventDestination
| ExternalAuditEventDestination!
| Destination to which the filter belongs. |
id
| ID!
| ID of the filter. |
namespace
| Namespace!
| Group or project namespace the filter belongs to. |
AuditEventStreamingHeader
Represents a HTTP header key/value that belongs to an audit streaming destination.
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| Header is active or not. |
id
| ID!
| ID of the header. |
key
| String!
| Key of the header. |
value
| String!
| Value of the header. |
AuditEventsStreamingHTTPNamespaceFiltersAddPayload
Autogenerated return type of AuditEventsStreamingHTTPNamespaceFiltersAdd.
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
namespaceFilter
| AuditEventStreamingHTTPNamespaceFilter
| Namespace filter created. |
AuditEventsStreamingHTTPNamespaceFiltersDeletePayload
Autogenerated return type of AuditEventsStreamingHTTPNamespaceFiltersDelete.
Fields
Name | Type | Description |
---|---|---|
clientMutationId
| String
| A unique identifier for the client performing the mutation. |
errors
| [String!]!
| Errors encountered during execution of the mutation. |
AuditEventsStreamingInstanceHeader
Represents a HTTP header key/value that belongs to an instance level audit streaming destination.
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| Header is active or not. |
id
| ID!
| ID of the header. |
key
| String!
| Key of the header. |
value
| String!
| Value of the header. |
AutocompletedUser
Core representation of a GitLab user.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
AutocompletedUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
AutocompletedUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
AutocompletedUser.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
AutocompletedUser.mergeRequestInteraction
Merge request state related to the user.
Returns UserMergeRequestInteraction
.
Arguments
Name | Type | Description |
---|---|---|
id
| MergeRequestID!
| Global ID of the merge request. |
AutocompletedUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
AutocompletedUser.savedReply
Saved reply authored by the user.
Returns SavedReply
.
Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
AutocompletedUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| Visibility of the snippet. |
AutocompletedUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
AutocompletedUser.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
AutocompletedUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
AutocompletedUser.workspaces
Workspaces owned by the current user.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
AwardEmoji
An emoji awarded by a user.
Fields
Name | Type | Description |
---|---|---|
description
| String!
| Emoji description. |
emoji
| String!
| Emoji as an icon. |
name
| String!
| Emoji name. |
unicode
| String!
| Emoji in Unicode. |
unicodeVersion
| String!
| Unicode version for this emoji. |
user
| UserCore!
| User who awarded the emoji. |
BaseService
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Indicates if the service is active. |
serviceType
| ServiceType
| Type of the service. |
type
| String
| Class name of the service. |
Blame
Fields
Name | Type | Description |
---|---|---|
firstLine
| String
| First line of Git Blame for given range. |
groups
| [Groups!]
| Git Blame grouped by contiguous lines for commit. |
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. |
BlockingMergeRequests
Information about the rules that must be satisfied to merge this merge request.
Fields
Name | Type | Description |
---|---|---|
hiddenCount
| Int!
| Blocking merge requests not visible to the user. |
totalCount
| Int!
| Total number of blocking merge requests. |
visibleMergeRequests
| [MergeRequest!]
| Blocking merge requests visible to the user. |
Board
Represents a project or group issue board.
Fields
Name | Type | Description |
---|---|---|
assignee
| UserCore
| 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
| Board iteration. |
iterationCadence
| IterationCadence
| Board iteration cadence. |
labels
| LabelConnection
| Labels of the board. (see Connections) |
milestone
| Milestone
| 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
, and 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
, and 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
| List of emoji reactions associated with the epic. (see Connections) |
blocked
| Boolean
| Indicates the epic is blocked. |
blockedByCount
| Int
| Count of epics blocking this epic. |
blockedByEpics
| EpicConnection
| Epics blocking this epic. (see Connections) |
blockingCount
| Int
| Count of epics that this epic is blocking. |
closedAt
| Time
| Timestamp of when the epic was closed. |
color
| String
| Color of the epic. Returns null if epic_color_highlight feature flag is disabled.
|
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
confidential
| Boolean
| Indicates if the epic is confidential. |
createdAt
| Time
| Timestamp of when the epic was created. |
defaultProjectForIssueCreation
| Project
| Default Project for issue creation. Based on the project the user created the last issue in. |
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
| 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. |
dueDateFromInheritedSource
| Time
| Inherited due date of the epic from child epics or milestones. |
dueDateFromMilestones
| Time
| Inherited due date of the epic from milestones. |
dueDateIsFixed
| Boolean
| Indicates if the due date has been manually set. |
events
| EventConnection
| 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) |
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
| Relative position of the epic in the epic tree. |
startDate
| Time
| Start date of the epic. |
startDateFixed
| Time
| Fixed start date of the epic. |
startDateFromInheritedSource
| Time
| Inherited start date of the epic from child epics or milestones. |
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. |
textColor
| String
| Text color generated for the epic. Returns null if epic_color_highlight feature flag is disabled.
|
title
| String
| Title of the epic. |
titleHtml
| String
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
createdAfter
| Time
| Epics created after this date. |
createdBefore
| Time
| Epics created before this date. |
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] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
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. |
or | UnionedEpicFilterInput
|
Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
|
search
| String
| Search query for title or description. |
sort
| EpicSort
| List epics by sort order. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
topLevelHierarchyOnly
| Boolean
| Filter epics with a top-level hierarchy. |
updatedAfter
| Time
| Epics updated after this date. |
updatedBefore
| Time
| Epics updated before this date. |
BoardEpic.children
Children (sub-epics) of the epic.
Returns EpicConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
createdAfter
| Time
| Epics created after this date. |
createdBefore
| Time
| Epics created before this date. |
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] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
includeAncestorGroups
| Boolean
| Include child 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. |
or | UnionedEpicFilterInput
|
Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
|
search
| String
| Search query for title or description. |
sort
| EpicSort
| List epics by sort order. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
topLevelHierarchyOnly
| Boolean
| Filter epics with a top-level hierarchy. |
updatedAfter
| Time
| Epics updated after this date. |
updatedBefore
| Time
| Epics updated before this date. |
BoardEpic.currentUserTodos
To-do items for the current user.
Returns TodoConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
BoardEpic.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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
| 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. |
totalIssueWeight
| BigInt
| Total weight of all issues in the list, encoded as a string. |
totalWeight | Int
|
Deprecated in 16.2. Use totalIssueWeight .
|
Fields with arguments
BoardList.issues
Board issues.
Returns IssueConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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. |
BranchProtection
Branch protection details for a branch rule.
Fields
Name | Type | Description |
---|---|---|
allowForcePush
| Boolean!
| Toggle force push to the branch for users with write access. |
codeOwnerApprovalRequired
| Boolean!
| Enforce code owner approvals before allowing a merge. |
mergeAccessLevels
| MergeAccessLevelConnection
| Details about who can merge when this branch is the source branch. (see Connections) |
pushAccessLevels
| PushAccessLevelConnection
| Details about who can push when this branch is the source branch. (see Connections) |
unprotectAccessLevels
| UnprotectAccessLevelConnection
| Details about who can unprotect this branch. (see Connections) |
BranchRule
List of branch rules for a project, grouped by branch name.
Fields
Name | Type | Description |
---|---|---|
approvalRules
| ApprovalProjectRuleConnection
| Merge request approval rules configured for this branch rule. (see Connections) |
branchProtection
| BranchProtection
| Branch protections configured for this branch rule. |
createdAt
| Time!
| Timestamp of when the branch rule was created. |
externalStatusChecks
| ExternalStatusCheckConnection
| External status checks configured for this branch rule. (see Connections) |
isDefault
| Boolean!
| Check if this branch rule protects the project’s default branch. |
isProtected
| Boolean!
| Check if this branch rule protects access for the branch. |
matchingBranchesCount
| Int!
| Number of existing branches that match this branch rule. |
name
| String!
| Branch name, with wildcards, for the branch rules. |
updatedAt
| Time!
| Timestamp of when the branch rule was last updated. |
BurnupChartDailyTotals
Represents the total number of issues and their weights for a particular day.
Fields
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 |
---|---|---|
id
| ID!
| ID of the BuildNeed. |
name
| String
| Name of the job we need to complete. |
CiCatalogResource
Fields
Name | Type | Description |
---|---|---|
description | String
| Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Description of the catalog resource. |
icon | String
| Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Icon for the catalog resource. |
id | ID!
| Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. ID of the catalog resource. |
latestReleasedAt | Time
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Release date of the catalog resource’s latest version. |
latestVersion | CiCatalogResourceVersion
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Latest version of the catalog resource. |
name | String
| Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Name of the catalog resource. |
openIssuesCount | Int!
| Introduced in 16.3. This feature is an Experiment. It can be changed or removed at any time. Count of open issues that belong to the the catalog resource. |
openMergeRequestsCount | Int!
| Introduced in 16.3. This feature is an Experiment. It can be changed or removed at any time. Count of open merge requests that belong to the the catalog resource. |
readmeHtml | String!
|
Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. GitLab Flavored Markdown rendering of readme .
|
starCount | Int!
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Number of times the catalog resource has been starred. |
webPath | String
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Web path of the catalog resource. |
Fields with arguments
CiCatalogResource.versions
Versions of the catalog resource. This field can only be resolved for one catalog resource in any single request.
Returns CiCatalogResourceVersionConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
sort
| CiCatalogResourceVersionSort
| Sort versions by given criteria. |
CiCatalogResourceComponent
Fields
Name | Type | Description |
---|---|---|
id | CiCatalogResourcesComponentID!
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. ID of the component. |
inputs | [CiCatalogResourceComponentInput!]
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Inputs for the component. |
name | String
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Name of the component. |
path | String
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Path used to include the component. |
CiCatalogResourceComponentInput
Fields
Name | Type | Description |
---|---|---|
default | String
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Default value for the input. |
name | String
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Name of the input. |
required | Boolean
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Indicates if an input is required. |
CiCatalogResourceVersion
Fields
Name | Type | Description |
---|---|---|
author | UserCore
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. User that created the version. |
commit | Commit
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Commit associated with the version. |
components | CiCatalogResourceComponentConnection
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Components belonging to the catalog resource. |
createdAt | Time
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Timestamp of when the version was created. |
id | CiCatalogResourcesVersionID!
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Global ID of the version. |
releasedAt | Time
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Timestamp of when the version was released. |
tagName | String
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Name of the tag associated with the version. |
tagPath | String
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Relative web path to the tag associated with the version. |
CiConfig
Fields
Name | Type | Description |
---|---|---|
errors
| [String!]
| Linting errors. |
includes
| [CiConfigInclude!]
| List of included files. |
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. |
warnings
| [String!]
| Linting warnings. |
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. |
CiConfigInclude
Fields
Name | Type | Description |
---|---|---|
blob
| String
| File blob location. It can be masked if it contains masked variables. For example, "https://gitlab.com/gitlab-org/gitlab/-/blob/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml" .
|
contextProject
| String
| Current project scope, e.g., “gitlab-org/gitlab”. |
contextSha
| String
| Current sha scope. |
extra
| JSON
| Extra information for the include , which can contain job_name , project , and ref . Values can be masked if they contain masked variables.
|
location
| String
| File location. It can be masked if it contains masked variables. For example, ".gitlab/ci/build-images.gitlab-ci.yml" .
|
raw
| String
| File raw location. It can be masked if it contains masked variables. For example, "https://gitlab.com/gitlab-org/gitlab/-/raw/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml" .
|
type
| CiConfigIncludeType
| Include type. |
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!]
| 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. |
CiConfigVariable
CI/CD config variables.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description for the CI/CD config variable. |
key
| String
| Name of the variable. |
value
| String
| Value of the variable. |
valueOptions
| [String!]
| Value options for the variable. |
CiFreezePeriod
Represents a deployment freeze window of a project.
Fields
Name | Type | Description |
---|---|---|
cronTimezone
| String
| Time zone for the cron fields, defaults to UTC if not provided. |
endCron
| String!
| End of the freeze period in cron format. |
endTime
| Time
| Timestamp (UTC) of when the current/next active period ends. |
startCron
| String!
| Start of the freeze period in cron format. |
startTime
| Time
| Timestamp (UTC) of when the current/next active period starts. |
status
| CiFreezePeriodStatus!
| Freeze period status. |
CiGroup
Fields
Name | Type | Description |
---|---|---|
detailedStatus
| DetailedStatus
| Detailed status of the group. |
id
| String!
| ID for a group. |
jobs
| CiJobConnection
| Jobs in group. (see Connections) |
name
| String
| Name of the job group. |
size
| Int
| Size of the group. |
CiGroupEnvironmentScope
Ci/CD environment scope for a group.
Fields
Name | Type | Description |
---|---|---|
name
| String
| Scope name defininig the enviromnments that can use the variable. |
CiGroupVariable
CI/CD variables for a group.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the variable. |
environmentScope
| String
| Scope defining the environments that can use the variable. |
id
| ID!
| ID of the variable. |
key
| String
| Name of the variable. |
masked
| Boolean
| Indicates whether the variable is masked. |
protected
| Boolean
| Indicates whether the variable is protected. |
raw
| Boolean
| Indicates whether the variable is raw. |
value
| String
| Value of the variable. |
variableType
| CiVariableType
| Type of the variable. |
CiInstanceVariable
CI/CD variables for a GitLab instance.
Fields
Name | Type | Description |
---|---|---|
environmentScope | String
| Deprecated in 15.3. No longer used, only available for GroupVariableType and ProjectVariableType. |
id
| ID!
| ID of the variable. |
key
| String
| Name of the variable. |
masked
| Boolean
| Indicates whether the variable is masked. |
protected
| Boolean
| Indicates whether the variable is protected. |
raw
| Boolean
| Indicates whether the variable is raw. |
value
| String
| Value of the variable. |
variableType
| CiVariableType
| Type of the variable. |
CiJob
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| Indicates the job is active. |
aiFailureAnalysis | String
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Ai generated analysis of the root cause of failure. |
allowFailure
| Boolean!
| Whether the job is allowed to fail. |
artifacts
| CiJobArtifactConnection
| Artifacts generated by the job. (see Connections) |
browseArtifactsPath
| String
| URL for browsing the artifact’s archive. |
canPlayJob
| Boolean!
| Indicates whether the current user can play the job. |
cancelable
| Boolean!
| Indicates the job can be canceled. |
commitPath
| 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. |
downstreamPipeline
| Pipeline
| Downstream pipeline for a bridge. |
duration
| Int
| Duration of the job in seconds. |
erasedAt
| Time
| When the job was erased. |
failureMessage
| String
| Message on why the job failed. |
finishedAt
| Time
| When a job has finished running. |
id
| JobID
| ID of the job. |
kind
| CiJobKind!
| Indicates the type of job. |
manualJob
| Boolean
| Whether the job has a manual action. |
manualVariables
| CiManualVariableConnection
| Variables added to a manual job when the job is triggered. (see Connections) |
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. |
playPath
| String
| Play path of the job. |
playable
| Boolean!
| Indicates the job can be played. |
previousStageJobs
| CiJobConnection
| Jobs from the previous stage. (see Connections) |
previousStageJobsOrNeeds | JobNeedUnionConnection
| Deprecated in 16.4. Replaced by previousStageJobs and needs fields. |
project
| Project
| Project that the job belongs to. |
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. |
retried
| Boolean
| Indicates that the job has been retried. |
retryable
| Boolean!
| Indicates the job can be retried. |
runner
| CiRunner
| Runner assigned to execute the job. |
runnerManager | CiRunnerManager
| Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Runner manager assigned to the job. |
scheduled
| Boolean!
| Indicates the job is scheduled. |
scheduledAt
| Time
| Schedule for the build. |
schedulingType
| String
| Type of job scheduling. Value is dag if the job uses the needs keyword, and stage otherwise.
|
shortSha
| String!
| Short SHA1 ID of the commit. |
stage
| 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. |
trace
| CiJobTrace
| Trace generated by the job. |
triggered
| Boolean
| Whether the job was triggered. |
userPermissions
| JobPermissions!
| Permissions for the current user on the resource. |
webPath
| String
| Web path of the job. |
CiJobArtifact
Fields
Name | Type | Description |
---|---|---|
downloadPath
| String
| URL for downloading the artifact’s file. |
expireAt
| Time
| Expiry date of the artifact. |
fileType
| JobArtifactFileType
| File type of the artifact. |
id
| CiJobArtifactID!
| ID of the artifact. |
name
| String
| File name of the artifact. |
size
| BigInt!
| Size of the artifact in bytes. |
CiJobTokenScopeType
Fields
Name | Type | Description |
---|---|---|
inboundAllowlist
| ProjectConnection!
| Allow list of projects that can access the current project through its CI Job tokens. (see Connections) |
outboundAllowlist
| ProjectConnection!
| Allow list of projects that are accessible using the current project’s CI Job tokens. (see Connections) |
projects | ProjectConnection!
|
Deprecated in 15.9. The projects attribute is being deprecated. Use outbound_allowlist .
|
CiJobTrace
Fields with arguments
CiJobTrace.htmlSummary
HTML summary that contains the tail lines of the trace. Returns at most 16KB of raw bytes from the trace. The returned string might start with an unexpected invalid UTF-8 code point due to truncation.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
lastLines
| Int
| Number of tail lines to return, up to a maximum of 100 lines. |
CiJobsDurationStatistics
Representation of duration statistics for a group of CI jobs.
Fields
Name | Type | Description |
---|---|---|
p50 | Duration
| Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 50th percentile. 50% of the durations are lower than this value. |
p75 | Duration
| Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 75th percentile. 75% of the durations are lower than this value. |
p90 | Duration
| Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 90th percentile. 90% of the durations are lower than this value. |
p95 | Duration
| Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 95th percentile. 95% of the durations are lower than this value. |
p99 | Duration
| Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. 99th percentile. 99% of the durations are lower than this value. |
CiJobsStatistics
Statistics for a group of CI jobs.
Fields
Name | Type | Description |
---|---|---|
queuedDuration | CiJobsDurationStatistics
| Introduced in 15.8. This feature is an Experiment. It can be changed or removed at any time. Statistics for amount of time that jobs were waiting to be picked up. The calculation is performed based on the most recent 100 jobs executed by the 5000 most recently created runners in context. If no filter is applied to runners, the calculation is performed based on the most recent 100 jobs globally. |
CiManualVariable
CI/CD variables given to a manual job.
Fields
Name | Type | Description |
---|---|---|
environmentScope | String
| Deprecated in 15.3. No longer used, only available for GroupVariableType and ProjectVariableType. |
id
| ID!
| ID of the variable. |
key
| String
| Name of the variable. |
raw
| Boolean
| Indicates whether the variable is raw. |
value
| String
| Value of the variable. |
variableType
| CiVariableType
| Type of the variable. |
CiMinutesNamespaceMonthlyUsage
Fields
Name | Type | Description |
---|---|---|
minutes
| Int
| Total number of compute minutes used by all projects in the namespace. |
month
| String
| Month related to the usage data. |
monthIso8601
| ISO8601Date
| Month related to the usage data in ISO 8601 date format. |
projects
| CiMinutesProjectMonthlyUsageConnection
| Compute usage data for projects in the namespace. (see Connections) |
sharedRunnersDuration
| Int
| Total duration (in seconds) of shared runners use by the namespace for the month. |
CiMinutesProjectMonthlyUsage
Fields
Name | Type | Description |
---|---|---|
minutes
| Int
| Number of compute minutes used by the project in the month. |
name | String
|
Deprecated in 15.6. Use project.name .
|
project
| Project
| Project having the recorded usage. |
sharedRunnersDuration
| Int
| Total duration (in seconds) of shared runners use by the project for the month. |
CiProjectVariable
CI/CD variables for a project.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the variable. |
environmentScope
| String
| Scope defining the environments that can use the variable. |
id
| ID!
| ID of the variable. |
key
| String
| Name of the variable. |
masked
| Boolean
| Indicates whether the variable is masked. |
protected
| Boolean
| Indicates whether the variable is protected. |
raw
| Boolean
| Indicates whether the variable is raw. |
value
| String
| Value of the variable. |
variableType
| CiVariableType
| Type of the variable. |
CiRunner
Fields
Name | Type | Description |
---|---|---|
accessLevel
| CiRunnerAccessLevel!
| Access level of the runner. |
active | Boolean!
| Deprecated in 14.8. Use paused. |
adminUrl
| String
| Admin URL of the runner. Only available for administrators. |
architectureName | String
|
Deprecated in 16.2. Use field in manager object instead.
|
contactedAt
| Time
| Timestamp of last contact from this runner. |
createdAt
| Time
| Timestamp of creation of this runner. |
createdBy
| UserCore
| User that created this runner. |
description
| String
| Description of the runner. |
editAdminUrl
| String
| Admin form URL of the runner. Only available for administrators. |
ephemeralAuthenticationToken | String
| Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. Ephemeral authentication token used for runner manager registration. Only available for the creator of the runner for a limited time during registration. |
ephemeralRegisterUrl | String
| Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. URL of the registration page of the runner manager. Only available for the creator of the runner for a limited time during registration. |
executorName | String
|
Deprecated in 16.2. Use field in manager object instead.
|
groups
| GroupConnection
| Groups the runner is associated with. For group runners only. (see Connections) |
id
| CiRunnerID!
| ID of the runner. |
ipAddress | String
|
Deprecated in 16.2. Use field in manager object instead.
|
jobExecutionStatus | CiRunnerJobExecutionStatus
| Introduced in 15.7. This feature is an Experiment. It can be changed or removed at any time. Job execution status of the runner. |
locked
| Boolean
| Indicates the runner is locked. |
maintenanceNote
| String
| Runner’s maintenance notes. |
maintenanceNoteHtml
| String
| GitLab Flavored Markdown rendering of maintenance_note .
|
managers | CiRunnerManagerConnection
| Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Machines associated with the runner configuration. |
maximumTimeout
| Int
| Maximum timeout (in seconds) for jobs processed by the runner. |
ownerProject
| Project
| Project that owns the runner. For project runners only. |
paused
| Boolean!
| Indicates the runner is paused and not available to run jobs. |
platformName | String
|
Deprecated in 16.2. Use field in manager object instead.
|
privateProjectsMinutesCostFactor
| Float
| Private projects’ “compute cost factor” associated with the runner (GitLab.com only). |
projectCount
| Int
| Number of projects that the runner is associated with. |
publicProjectsMinutesCostFactor
| Float
| Public projects’ “compute cost factor” associated with the runner (GitLab.com only). |
registerAdminUrl
| String
| URL of the temporary registration page of the runner. Only available before the runner is registered. Only available for administrators. |
revision | String
|
Deprecated in 16.2. Use field in manager object instead.
|
runUntagged
| Boolean!
| Indicates the runner is able to run untagged jobs. |
runnerType
| CiRunnerType!
| Type of the runner. |
shortSha
| String
| First eight characters of the runner’s token used to authenticate new job requests. Used as the runner’s unique ID. |
tagList
| [String!]
| Tags associated with the runner. |
tokenExpiresAt
| Time
| Runner token expiration time. |
upgradeStatus | CiRunnerUpgradeStatus
| Introduced in 14.10. This feature is an Experiment. It can be changed or removed at any time. Availability of upgrades for the runner. |
userPermissions
| RunnerPermissions!
| Permissions for the current user on the resource. |
version | String
|
Deprecated in 16.2. Use field in manager object instead.
|
Fields with arguments
CiRunner.jobCount
Number of jobs processed by the runner (limited to 1000, plus one to indicate that more items exist).
jobCount
is an optimized version of jobs { count }
, and can be requested for multiple runners on the same request.
Returns Int
.
Arguments
Name | Type | Description |
---|---|---|
statuses | [CiJobStatus!]
| Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Filter jobs by status. |
CiRunner.jobs
Jobs assigned to the runner. This field can only be resolved for one runner in any single request.
Returns CiJobConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
statuses
| [CiJobStatus!]
| Filter jobs by status. |
CiRunner.projects
Find projects the runner is associated with. For project runners only.
Returns ProjectConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
membership
| Boolean
| Return only projects that the current user is a member of. |
search
| String
| Search query, which can be for the project name, a path, or a description. |
searchNamespaces
| Boolean
| Include namespace in project search. |
sort | String
|
Deprecated in 15.4. Default sort order will change in GitLab 17.0. Specify "id_asc" if you require the query results to be ordered by ascending IDs.
|
topics
| [String!]
| Filter projects by topics. |
CiRunner.status
Status of the runner.
Returns CiRunnerStatus!
.
Arguments
Name | Type | Description |
---|---|---|
legacyMode | String
| Deprecated in 15.0. Will be removed in 17.0. |
CiRunnerManager
Fields
Name | Type | Description |
---|---|---|
architectureName
| String
| Architecture provided by the runner manager. |
contactedAt
| Time
| Timestamp of last contact from the runner manager. |
createdAt
| Time
| Timestamp of creation of the runner manager. |
executorName
| String
| Executor last advertised by the runner. |
id
| CiRunnerManagerID!
| ID of the runner manager. |
ipAddress
| String
| IP address of the runner manager. |
jobExecutionStatus | CiRunnerJobExecutionStatus
| Introduced in 16.3. This feature is an Experiment. It can be changed or removed at any time. Job execution status of the runner manager. |
platformName
| String
| Platform provided by the runner manager. |
revision
| String
| Revision of the runner. |
runner
| CiRunner
| Runner configuration for the runner manager. |
status
| CiRunnerStatus!
| Status of the runner manager. |
systemId
| String!
| System ID associated with the runner manager. |
upgradeStatus | CiRunnerUpgradeStatus
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Availability of upgrades for the runner manager. |
version
| String
| Version of the runner. |
CiSecureFileRegistry
Represents the Geo replication and verification state of a ci_secure_file.
Fields
Name | Type | Description |
---|---|---|
ciSecureFileId
| ID!
| ID of the Ci Secure File. |
createdAt
| Time
| Timestamp when the CiSecureFileRegistry was created. |
id
| ID!
| ID of the CiSecureFileRegistry. |
lastSyncFailure
| String
| Error message during sync of the CiSecureFileRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the CiSecureFileRegistry. |
retryAt
| Time
| Timestamp after which the CiSecureFileRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the CiSecureFileRegistry. |
state
| RegistryState
| Sync state of the CiSecureFileRegistry. |
verificationChecksum
| String
| The local checksum of the CiSecureFileRegistry. |
verificationFailure
| String
| Error message during verification of the CiSecureFileRegistry. |
verificationRetryAt
| Time
| Timestamp after which the CiSecureFileRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the CiSecureFileRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of CiSecureFileRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the CiSecureFileRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the CiSecureFileRegistry. |
CiStage
Fields
Name | Type | Description |
---|---|---|
detailedStatus
| DetailedStatus
| Detailed status of the stage. |
groups
| CiGroupConnection
| Group of jobs for the stage. (see Connections) |
id
| ID!
| ID of the stage. |
jobs
| CiJobConnection
| Jobs for the stage. (see Connections) |
name
| String
| Name of the stage. |
status
| String
| Status of the pipeline stage. |
CiSubscriptionsProject
Fields
Name | Type | Description |
---|---|---|
author
| UserCore
| Author of the subscription. |
downstreamProject
| Project
| Downstream project of the subscription. |
id
| CiSubscriptionsProjectID
| Global ID of the subscription. |
upstreamProject
| Project
| Upstream project of the subscription. |
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 |
---|---|---|
activityEvents
| ClusterAgentActivityEventConnection
| Recent activity for the cluster agent. (see Connections) |
connections
| ConnectedAgentConnection
| Active connections for the cluster agent. (see Connections) |
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
| 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. |
vulnerabilityImages
| VulnerabilityContainerImageConnection
| Container images reported on the agent vulnerabilities. (see Connections) |
webPath
| String
| Web path of the cluster agent. |
Fields with arguments
ClusterAgent.workspaces
Workspaces associated with the agent.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalID. |
ClusterAgentActivityEvent
Fields
Name | Type | Description |
---|---|---|
agentToken
| ClusterAgentToken
| Agent token associated with the event. |
kind
| String
| Type of event. |
level
| String
| Severity of the event. |
recordedAt
| Time
| Timestamp the event was recorded. |
user
| UserCore
| User associated with the event. |
ClusterAgentAuthorizationCiAccess
Fields
Name | Type | Description |
---|---|---|
agent
| ClusterAgent
| Authorized cluster agent. |
config
| JSON
| Configuration for the authorized project. |
ClusterAgentAuthorizationUserAccess
Fields
Name | Type | Description |
---|---|---|
agent
| ClusterAgent
| Authorized cluster agent. |
config
| JSON
| Configuration for the authorized project. |
ClusterAgentToken
Fields
Name | Type | Description |
---|---|---|
clusterAgent
| ClusterAgent
| Cluster agent this token is associated with. |
createdAt
| Time
| Timestamp the token was created. |
createdByUser
| UserCore
| 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. |
status
| AgentTokenStatus
| Current status of 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!
| Description of the code quality degradation. |
engineName
| String!
| Code Quality plugin that reported the finding. |
fingerprint
| String!
| Unique fingerprint to identify the code quality degradation. For example, an MD5 hash. |
line
| Int!
| Line on which the code quality degradation occurred. |
path
| String!
| Relative path to the file containing the code quality degradation. |
severity
| CodeQualityDegradationSeverity!
| Status of the degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO, UNKNOWN). |
webUrl
| String
| URL to the file along with line number. |
CodeQualityReportSummary
Code Quality report for a pipeline.
Fields
Name | Type | Description |
---|---|---|
blocker
| Int
| Total number of blocker status. |
count
| Int
| Total number of Code Quality reports. |
critical
| Int
| Total number of critical status. |
info
| Int
| Total number of info status. |
major
| Int
| Total number of major status. |
minor
| Int
| Total number of minor status. |
unknown
| Int
| Total number of unknown status. |
CodequalityReportsComparer
Represents reports comparison for code quality.
Fields
Name | Type | Description |
---|---|---|
report
| CodequalityReportsComparerReport
| Compared codequality report. |
status
| CodequalityReportsComparerReportGenerationStatus
| Compared codequality report generation status. |
CodequalityReportsComparerReport
Represents compared code quality report.
Fields
Name | Type | Description |
---|---|---|
existingErrors
| [CodequalityReportsComparerReportDegradation!]
| All code quality degradations. |
newErrors
| [CodequalityReportsComparerReportDegradation!]!
| New code quality degradations. |
resolvedErrors
| [CodequalityReportsComparerReportDegradation!]
| Resolved code quality degradations. |
status
| CodequalityReportsComparerStatus!
| Status of report. |
summary
| CodequalityReportsComparerReportSummary!
| Codequality report summary. |
CodequalityReportsComparerReportDegradation
Represents a degradation on the compared codequality report.
Fields
Name | Type | Description |
---|---|---|
description
| String!
| Description of the code quality degradation. |
engineName
| String
| Code quality plugin that reported the degradation. |
filePath
| String!
| Relative path to the file containing the code quality degradation. |
fingerprint
| String!
| Unique fingerprint to identify the code quality degradation. For example, an MD5 hash. |
line
| Int!
| Line on which the code quality degradation occurred. |
severity
| CodeQualityDegradationSeverity!
| Severity of the code quality degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO, UNKNOWN). |
webUrl
| String
| URL to the file along with line number. |
CodequalityReportsComparerReportSummary
Represents a summary of the compared codequality report.
Fields
Name | Type | Description |
---|---|---|
errored
| Int
| Count of code quality errors. |
resolved
| Int
| Count of resolved code quality degradations. |
total
| Int
| Total count of code quality degradations. |
Commit
Fields
Name | Type | Description |
---|---|---|
author
| UserCore
| Author of the commit. |
authorEmail
| String
| Commit author’s email. |
authorGravatar
| String
| Commit authors gravatar. |
authorName
| String
| Commit authors name. |
authoredDate
| Time
| Timestamp of when the commit was authored. |
committedDate
| Time
| Timestamp of when the commit was committed. |
committerEmail
| String
| Email of the committer. |
committerName
| String
| Name of the committer. |
description
| String
| Description of the commit message. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
diffs
| [Diff!]
| Diffs contained within the commit. This field can only be resolved for 10 diffs in any single request. |
fullTitle
| String
| Full title of the commit message. |
fullTitleHtml
| String
| GitLab Flavored Markdown rendering of full_title .
|
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. |
signature
| CommitSignature
| Signature of the commit. |
signatureHtml
| String
| Rendered HTML of the commit signature. |
title
| String
| Title of the commit message. |
titleHtml
| String
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ref
| String
| Filter pipelines by the ref they are run for. |
scope
| PipelineScopeEnum
| Filter pipelines by scope. |
sha
| String
| Filter pipelines by the sha of the commit they are run for. |
source
| String
| Filter pipelines by their source. |
status
| PipelineStatusEnum
| Filter pipelines by their status. |
updatedAfter
| Time
| Pipelines updated after this date. |
updatedBefore
| Time
| Pipelines updated before this date. |
username
| String
| Filter pipelines by the user that triggered the pipeline. |
CommitData
Fields
Name | Type | Description |
---|---|---|
ageMapClass
| String!
| CSS class for age of commit. |
authorAvatar
| String!
| Link to author avatar. |
commitAuthorLink
| String!
| Link to the commit author. |
commitLink
| String!
| Link to the commit. |
projectBlameLink
| String
| Link to blame prior to the change. |
timeAgoTooltip
| String!
| Time of commit. |
CommitParentNames
Fields
Name | Type | Description |
---|---|---|
names
| [String!]
| Names of the commit parent (branch or tag). |
CommitReferences
Fields with arguments
CommitReferences.containingBranches
Get branch names containing a given commit.
Returns CommitParentNames
.
Arguments
Name | Type | Description |
---|---|---|
excludeTipped
| Boolean!
| Exclude tipping refs. WARNING: This argument can be confusing, if there is a limit. for example set the limit to 5 and in the 5 out a total of 25 refs there is 2 tipped refs, then the method will only 3 refs, even though there is more. |
limit
| Int!
| Number of ref names to return. |
CommitReferences.containingTags
Get tag names containing a given commit.
Returns CommitParentNames
.
Arguments
Name | Type | Description |
---|---|---|
excludeTipped
| Boolean!
| Exclude tipping refs. WARNING: This argument can be confusing, if there is a limit. for example set the limit to 5 and in the 5 out a total of 25 refs there is 2 tipped refs, then the method will only 3 refs, even though there is more. |
limit
| Int!
| Number of ref names to return. |
CommitReferences.tippingBranches
Get branch names tipping at a given commit.
Returns CommitParentNames
.
Arguments
Name | Type | Description |
---|---|---|
limit
| Int!
| Number of ref names to return. |
CommitReferences.tippingTags
Get tag names tipping at a given commit.
Returns CommitParentNames
.
Arguments
Name | Type | Description |
---|---|---|
limit
| Int!
| Number of ref names to return. |
ComparedSecurityReport
Represents compared security report.
Fields
Name | Type | Description |
---|---|---|
added | [ComparedSecurityReportFinding!]
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. New vulnerability findings. |
baseReportCreatedAt
| Time
| Time of the base report creation. |
baseReportOutOfDate
| Boolean
| Indicates whether the base report out of date. |
fixed | [ComparedSecurityReportFinding!]
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Fixed vulnerability findings. |
headReportCreatedAt
| Time
| Time of the base report creation. |
ComparedSecurityReportFinding
Represents finding.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the vulnerability finding. |
foundByPipelineIid
| String
| IID of the pipeline. |
identifiers | [VulnerabilityIdentifier!]
|
Introduced in 16.3. This feature is an Experiment. It can be changed or removed at any time. Identifiers of the vulnerability finding. Returns null if sast_reports_in_inline_diff feature flag is disabled.
|
location | VulnerabilityLocation
|
Introduced in 16.3. This feature is an Experiment. It can be changed or removed at any time. Location of the vulnerability finding. Returns null if sast_reports_in_inline_diff feature flag is disabled.
|
scanner
| ComparedSecurityReportScanner
| Compared report vulnerability scanner. |
severity
| VulnerabilitySeverity
| Severity of the vulnerability finding. |
state
| VulnerabilityState
| Finding status. |
title
| String
| Title of the vulnerability finding. |
uuid
| String
| UUIDv5 digest based on the vulnerability’s report type, primary identifier, location, fingerprint, project identifier. |
ComparedSecurityReportScanner
Represents a compared report vulnerability scanner.
Fields
Name | Type | Description |
---|---|---|
externalId
| String
| External ID of the vulnerability scanner. |
name
| String
| Name of the vulnerability scanner. |
vendor
| String
| Vendor of the vulnerability scanner. |
ComplianceFramework
Represents a ComplianceFramework associated with a Project.
Fields
Name | Type | Description |
---|---|---|
color
| String!
| Hexadecimal representation of compliance framework’s label color. |
default
| Boolean
| Default compliance framework for the group. |
description
| String!
| Description of the compliance framework. |
id
| ID!
| Compliance framework ID. |
name
| String!
| Name of the compliance framework. |
pipelineConfigurationFullPath
| String
| Full path of the compliance pipeline configuration stored in a project repository, such as .gitlab/.compliance-gitlab-ci.yml@compliance/hipaa Ultimate All offerings .
|
projects
| ProjectConnection
| Projects associated with the compliance framework. (see Connections) |
ComplianceStandardsAdherence
Compliance standards adherence for a project.
Fields
Name | Type | Description |
---|---|---|
checkName
| ComplianceStandardsAdherenceCheckName!
| Name of the check for the compliance standard. |
id
| ID!
| Compliance standards adherence ID. |
project
| Project!
| Project adhering to the compliance standard. |
standard
| ComplianceStandardsAdherenceStandard!
| Name of the compliance standard. |
status
| ComplianceStandardsAdherenceStatus!
| Status of the compliance standards adherence. |
updatedAt
| Time!
| Timestamp when the adherence was updated. |
ComplianceViolation
Compliance violation associated with a merged merge request.
Fields
Name | Type | Description |
---|---|---|
id
| ID!
| Compliance violation ID. |
mergeRequest
| MergeRequest!
| Merge request the compliance violation occurred in. |
reason
| ComplianceViolationReason!
| Reason the compliance violation occurred. |
severityLevel
| ComplianceViolationSeverity!
| Severity of the compliance violation. |
violatingUser
| UserCore!
| User suspected of causing the compliance violation. |
ComposerMetadata
Composer metadata.
Fields
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. |
ConnectedAgent
Connection details for an Agent.
Fields
Name | Type | Description |
---|---|---|
connectedAt
| Time
| When the connection was established. |
connectionId
| BigInt
| ID of the connection. |
metadata
| AgentMetadata
| Information about the Agent. |
ContactStateCounts
Represents the total number of contacts for the represented states.
Fields
Name | Type | Description |
---|---|---|
active
| Int
| Number of contacts with state ACTIVE .
|
all
| Int
| Number of contacts with state ALL .
|
inactive
| Int
| Number of contacts with state INACTIVE .
|
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. |
ContainerRegistryProtectionRule
A container registry protection rule designed to prevent users with a certain access level or lower from altering the container registry.
Fields
Name | Type | Description |
---|---|---|
deleteProtectedUpToAccessLevel
| ContainerRegistryProtectionRuleAccessLevel!
| Max GitLab access level to prevent from pushing container images to the container registry. For example DEVELOPER , MAINTAINER , OWNER .
|
id
| ContainerRegistryProtectionRuleID!
| ID of the container registry protection rule. |
pushProtectedUpToAccessLevel
| ContainerRegistryProtectionRuleAccessLevel!
| Max GitLab access level to prevent from pushing container images to the container registry. For example DEVELOPER , MAINTAINER , OWNER .
|
repositoryPathPattern
| String!
| Container repository path pattern protected by the protection rule. For example my-project/my-container-* . Wildcard character * allowed.
|
ContainerRepository
A container repository.
Fields
Name | Type | Description |
---|---|---|
canDelete | Boolean!
|
Deprecated in 16.7. Use userPermissions field. See ContainerRepositoryPermissions type.
|
createdAt
| Time!
| Timestamp when the container repository was created. |
expirationPolicyCleanupStatus
| ContainerRepositoryCleanupStatus
| 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. |
lastCleanupDeletedTagsCount
| Int
| Number of deleted tags from the last cleanup. |
location
| String!
| URL of the container repository. |
migrationState
| String!
| Migration state of the container repository. |
name
| String!
| Name of the container repository. |
path
| String!
| Path of the container repository. |
project
| Project!
| Project of the container registry. |
status
| ContainerRepositoryStatus
| Status of the container repository. |
tagsCount
| Int!
| Number of tags associated with this image. |
updatedAt
| Time!
| Timestamp when the container repository was updated. |
userPermissions
| ContainerRepositoryPermissions!
| Permissions for the current user on the resource. |
ContainerRepositoryDetails
Details of a container repository.
Fields
Name | Type | Description |
---|---|---|
canDelete | Boolean!
|
Deprecated in 16.7. Use userPermissions field. See ContainerRepositoryPermissions type.
|
createdAt
| Time!
| Timestamp when the container repository was created. |
expirationPolicyCleanupStatus
| ContainerRepositoryCleanupStatus
| 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. |
lastCleanupDeletedTagsCount
| Int
| Number of deleted tags from the last cleanup. |
location
| String!
| URL of the container repository. |
migrationState
| String!
| Migration state of the container repository. |
name
| String!
| Name of the container repository. |
path
| String!
| Path of the container repository. |
project
| Project!
| Project of the container registry. |
size
| Float
| Deduplicated size of the image repository in bytes. This is only available on GitLab.com for repositories created after 2021-11-04 .
|
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. |
userPermissions
| ContainerRepositoryPermissions!
| Permissions for the current user on the resource. |
Fields with arguments
ContainerRepositoryDetails.tags
Tags of the container repository.
Returns ContainerRepositoryTagConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| Search by tag name. |
sort
| ContainerRepositoryTagSort
| Sort tags by these criteria. |
ContainerRepositoryPermissions
Fields
Name | Type | Description |
---|---|---|
destroyContainerRepository
| Boolean!
| If true , the user can perform destroy_container_image on this resource.
|
ContainerRepositoryRegistry
Represents the Geo replication and verification state of an Container Repository.
Fields
Name | Type | Description |
---|---|---|
containerRepositoryId
| ID!
| ID of the ContainerRepository. |
createdAt
| Time
| Timestamp when the ContainerRepositoryRegistry was created. |
id
| ID!
| ID of the ContainerRepositoryRegistry. |
lastSyncFailure
| String
| Error message during sync of the ContainerRepositoryRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the ContainerRepositoryRegistry. |
retryAt
| Time
| Timestamp after which the ContainerRepositoryRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the ContainerRepositoryRegistry. |
state
| RegistryState
| Sync state of the ContainerRepositoryRegistry. |
verificationChecksum
| String
| The local checksum of the ContainerRepositoryRegistry. |
verificationFailure
| String
| Error message during verification of the ContainerRepositoryRegistry. |
verificationRetryAt
| Time
| Timestamp after which the ContainerRepositoryRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the ContainerRepositoryRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of ContainerRepositoryRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the ContainerRepositoryRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the ContainerRepositoryRegistry. |
ContainerRepositoryTag
A tag from a container repository.
Fields
Name | Type | Description |
---|---|---|
canDelete | Boolean!
|
Deprecated in 16.7. Use userPermissions field. See ContainerRepositoryTagPermissions type.
|
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
| Size of the tag. |
userPermissions
| ContainerRepositoryTagPermissions!
| Permissions for the current user on the resource. |
ContainerRepositoryTagPermissions
Fields
Name | Type | Description |
---|---|---|
destroyContainerRepositoryTag
| Boolean!
| If true , the user can perform destroy_container_image on this resource.
|
ContributionAnalyticsContribution
Represents the contributions of a user.
Fields
Name | Type | Description |
---|---|---|
issuesClosed
| Int
| Number of issues closed by the user. |
issuesCreated
| Int
| Number of issues created by the user. |
mergeRequestsApproved
| Int
| Number of merge requests approved by the user. |
mergeRequestsClosed
| Int
| Number of merge requests closed by the user. |
mergeRequestsCreated
| Int
| Number of merge requests created by the user. |
mergeRequestsMerged
| Int
| Number of merge requests merged by the user. |
repoPushed
| Int
| Number of repository pushes the user made. |
totalEvents
| Int
| Total number of events contributed by the user. |
user
| UserCore
| Contributor User object. |
CoverageFuzzingCorpus
Corpus for a coverage fuzzing job.
Fields
Name | Type | Description |
---|---|---|
id
| AppSecFuzzingCoverageCorpusID!
| ID of the corpus. |
package
| PackageDetailsType!
| Package of the corpus. |
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. |
createdAt
| Date
| Date when the license was added. |
email
| String
| Email of the licensee. |
expiresAt
| Date
| Date when the license expires. |
id
| ID!
| ID of the license extracted from the license data. |
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. |
CurrentUser
The currently authenticated GitLab user.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
CurrentUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
CurrentUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
CurrentUser.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
CurrentUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
CurrentUser.savedReply
Saved reply authored by the user.
Returns SavedReply
.
Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
CurrentUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| Visibility of the snippet. |
CurrentUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
CurrentUser.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
CurrentUser.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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
CurrentUser.workspaces
Workspaces owned by the current user.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
CustomEmoji
A custom emoji uploaded by user.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp of when the custom emoji was created. |
external
| Boolean!
| Whether the emoji is an external link. |
id
| CustomEmojiID!
| ID of the emoji. |
name
| String!
| Name of the emoji. |
url
| String!
| Link to file of the emoji. |
userPermissions
| CustomEmojiPermissions!
| Permissions for the current user on the resource. |
CustomEmojiPermissions
Fields
Name | Type | Description |
---|---|---|
createCustomEmoji
| Boolean!
| If true , the user can perform create_custom_emoji on this resource.
|
deleteCustomEmoji
| Boolean!
| If true , the user can perform delete_custom_emoji on this resource.
|
readCustomEmoji
| Boolean!
| If true , the user can perform read_custom_emoji on this resource.
|
CustomerRelationsContact
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| State of the contact. |
createdAt
| Time!
| Timestamp the contact was created. |
description
| String
| Description of or notes for the contact. |
email
| String
| Email address of the contact. |
firstName
| String!
| First name of the contact. |
id
| ID!
| Internal ID of the contact. |
lastName
| String!
| Last name of the contact. |
organization
| CustomerRelationsOrganization
| Organization of the contact. |
phone
| String
| Phone number of the contact. |
updatedAt
| Time!
| Timestamp the contact was last updated. |
CustomerRelationsOrganization
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| State of the organization. |
createdAt
| Time!
| Timestamp the organization was created. |
defaultRate
| Float
| Standard billing rate for the organization. |
description
| String
| Description of or notes for the organization. |
id
| ID!
| Internal ID of the organization. |
name
| String!
| Name of the organization. |
updatedAt
| Time!
| Timestamp the organization was last updated. |
CustomizableDashboard
Represents a product analytics dashboard.
Fields
Name | Type | Description |
---|---|---|
category
| CustomizableDashboardCategory!
| Category of dashboard. |
configurationProject
| Project
| Project which contains the dashboard definition. |
description
| String
| Description of the dashboard. |
panels
| CustomizableDashboardPanelConnection!
| Panels shown on the dashboard. (see Connections) |
slug
| String!
| Slug of the dashboard. |
title
| String!
| Title of the dashboard. |
userDefined
| Boolean!
| Indicates whether the dashboard is user-defined or provided by GitLab. |
CustomizableDashboardPanel
Represents a product analytics dashboard panel.
Fields
Name | Type | Description |
---|---|---|
gridAttributes
| JSON
| Description of the position and size of the panel. |
queryOverrides
| JSON
| Overrides for the visualization query object. |
title
| String!
| Title of the panel. |
visualization
| CustomizableDashboardVisualization!
| Visualization of the panel. |
CustomizableDashboardVisualization
Represents a product analytics dashboard visualization.
Fields
Name | Type | Description |
---|---|---|
data
| JSON!
| Data of the visualization. |
errors
| [String!]
| Validation errors in the visualization. |
options
| JSON!
| Options of the visualization. |
slug
| String!
| Slug of the visualization. |
type
| String!
| Type of the visualization. |
CustomizablePermission
Fields
Name | Type | Description |
---|---|---|
availableFor
| [String!]!
| Objects the permission is available for. |
description
| String
| Description of the permission. |
name
| String!
| Localized name of the permission. |
requirement
| String
| Requirement of the permission. |
value
| String!
| Value of the permission. |
DastPreScanVerification
Represents a DAST Pre Scan Verification.
Fields
Name | Type | Description |
---|---|---|
preScanVerificationSteps
| [DastPreScanVerificationStep!]
| Pre Scan Verifications Steps. |
status
| DastPreScanVerificationStatus
| Status of the pre scan verification. |
valid
| Boolean!
| Whether or not the configuration has changed after the last pre scan run. |
DastPreScanVerificationStep
Represents a DAST Pre Scan Verification Step.
Fields
Name | Type | Description |
---|---|---|
checkType
| DastPreScanVerificationCheckType
| Type of the pre scan verification check. |
errors
| [String!]
| Errors that occurred in the pre scan verification step. |
name | String
|
Deprecated in 15.10. This was renamed. Use: DastPreScanVerificationStep.checkType .
|
success
| Boolean!
| Whether or not the pre scan verification step has errors. |
DastProfile
Represents a DAST Profile.
Fields
Name | Type | Description |
---|---|---|
branch
| DastProfileBranch
| Associated branch. |
dastPreScanVerification
| DastPreScanVerification
| DAST Pre Scan Verification associated with the site profile. Will always return null if dast_on_demand_scans_scheduler feature flag is disabled.
|
dastProfileSchedule
| DastProfileSchedule
| Associated profile schedule. |
dastScannerProfile
| DastScannerProfile
| Associated scanner profile. |
dastSiteProfile
| DastSiteProfile
| Associated site profile. |
description
| String
| Description of the scan. |
editPath
| String
| Relative web path to the edit page of a profile. |
id
| DastProfileID!
| ID of the profile. |
name
| String
| Name of the profile. |
tagList
| [String!]
| Runner tags associated with the profile. |
DastProfileBranch
Represents a DAST Profile Branch.
Fields
Name | Type | Description |
---|---|---|
exists
| Boolean
| Indicates whether or not the branch exists. |
name
| String
| Name of the branch. |
DastProfileCadence
Represents DAST Profile Cadence.
Fields
Name | Type | Description |
---|---|---|
duration
| Int
| Duration of the DAST profile cadence. |
unit
| DastProfileCadenceUnit
| Unit for the duration of DAST profile cadence. |
DastProfileSchedule
Represents a DAST profile schedule.
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Status of the DAST profile schedule. |
cadence
| DastProfileCadence
| Cadence of the DAST profile schedule. |
id
| DastProfileScheduleID!
| ID of the DAST profile schedule. |
nextRunAt
| Time
| Next run time of the DAST profile schedule in the given timezone. |
ownerValid
| Boolean
| Status of the current owner of the DAST profile schedule. |
startsAt
| Time
| Start time of the DAST profile schedule in the given timezone. |
timezone
| String
| Time zone of the start time of the DAST profile schedule. |
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
| Maximum number of minutes allowed for the spider to traverse the site. |
tagList | [String!]
| Deprecated in 15.8. Moved to DastProfile. |
targetTimeout
| Int
| 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!]
| 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
| 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. |
scanFilePath
| String
| Scan File Path used as input for the scanner. |
scanMethod
| DastScanMethodType
| Scan method used by the scanner. |
targetType
| DastTargetTypeEnum
| Type of target to be scanned. |
targetUrl
| String
| URL of the target to be scanned. |
userPermissions
| DastSiteProfilePermissions!
| Permissions for the current user on the resource. |
validationStartedAt
| Time
| Site profile validation start time. |
validationStatus
| DastSiteProfileValidationStatusEnum
| Current validation status of the site profile. |
DastSiteProfileAuth
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
| Name of password field at the sign-in HTML form. |
submitField
| String
| Name or ID of sign-in submit button 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
| Username to authenticate with on the target website. |
usernameField
| String
| 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!
| If true , 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. |
validationStartedAt
| Time
| Timestamp of when the validation started. |
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
| Number of matching jobs deleted. |
queueSize
| Int
| Queue size after processing. |
DeletedNote
Fields
Name | Type | Description |
---|---|---|
discussionId
| DiscussionID
| ID of the discussion for the deleted note. |
id
| NoteID!
| ID of the deleted note. |
lastDiscussionNote
| Boolean
| Whether deleted note is the last note in the discussion. |
Dependency
A software dependency used by a project.
Fields
Name | Type | Description |
---|---|---|
id
| GlobalID!
| ID of the dependency. |
licenses
| [License!]
| Licenses associated to the dependency. |
location
| Location
| Information about where the dependency is located. |
name
| String!
| Name of the dependency. |
packager
| PackageManager
| Description of the tool used to manage the dependency. |
version
| String
| Version of the dependency. |
DependencyProxyBlob
Dependency proxy blob.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Date of creation. |
fileName
| String!
| Name of the blob. |
size
| String!
| Size of the blob file. |
updatedAt
| Time!
| Date of most recent update. |
DependencyProxyBlobRegistry
Represents the Geo replication and verification state of a dependency_proxy_blob.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the DependencyProxyBlobRegistry was created. |
dependencyProxyBlobId
| ID!
| ID of the Dependency Proxy Blob. |
id
| ID!
| ID of the DependencyProxyBlobRegistry. |
lastSyncFailure
| String
| Error message during sync of the DependencyProxyBlobRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the DependencyProxyBlobRegistry. |
retryAt
| Time
| Timestamp after which the DependencyProxyBlobRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the DependencyProxyBlobRegistry. |
state
| RegistryState
| Sync state of the DependencyProxyBlobRegistry. |
verificationChecksum
| String
| The local checksum of the DependencyProxyBlobRegistry. |
verificationFailure
| String
| Error message during verification of the DependencyProxyBlobRegistry. |
verificationRetryAt
| Time
| Timestamp after which the DependencyProxyBlobRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the DependencyProxyBlobRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of DependencyProxyBlobRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the DependencyProxyBlobRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the DependencyProxyBlobRegistry. |
DependencyProxyImageTtlGroupPolicy
Group-level Dependency Proxy TTL policy settings.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp of creation. |
enabled
| Boolean!
| Indicates whether the policy is enabled or disabled. |
ttl
| Int
| Number of days to retain a cached image file. |
updatedAt
| Time
| Timestamp of the most recent update. |
DependencyProxyManifest
Dependency proxy manifest.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Date of creation. |
digest
| String!
| Digest of the manifest. |
fileName
| String!
| Name of the manifest. |
id
| DependencyProxyManifestID!
| ID of the manifest. |
imageName
| String!
| Name of the image. |
size
| String!
| Size of the manifest file. |
status
| DependencyProxyManifestStatus!
| Status of the manifest (default, pending_destruction, processing, error). |
updatedAt
| Time!
| Date of most recent update. |
DependencyProxyManifestRegistry
Represents the Geo replication and verification state of a dependency_proxy_manifest.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the DependencyProxyManifestRegistry was created. |
dependencyProxyManifestId
| ID!
| ID of the Dependency Proxy Manifest. |
id
| ID!
| ID of the DependencyProxyManifestRegistry. |
lastSyncFailure
| String
| Error message during sync of the DependencyProxyManifestRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the DependencyProxyManifestRegistry. |
retryAt
| Time
| Timestamp after which the DependencyProxyManifestRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the DependencyProxyManifestRegistry. |
state
| RegistryState
| Sync state of the DependencyProxyManifestRegistry. |
verificationChecksum
| String
| The local checksum of the DependencyProxyManifestRegistry. |
verificationFailure
| String
| Error message during verification of the DependencyProxyManifestRegistry. |
verificationRetryAt
| Time
| Timestamp after which the DependencyProxyManifestRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the DependencyProxyManifestRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of DependencyProxyManifestRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the DependencyProxyManifestRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the DependencyProxyManifestRegistry. |
DependencyProxyPackagesSetting
Project-level Dependency Proxy for packages settings.
Fields
Name | Type | Description |
---|---|---|
enabled | Boolean!
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Indicates whether the dependency proxy for packages is enabled for the project. |
mavenExternalRegistryUrl | String
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. URL for the external Maven packages registry. |
mavenExternalRegistryUsername | String
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Username for the external Maven packages registry. |
DependencyProxySetting
Group-level Dependency Proxy settings.
Fields
Name | Type | Description |
---|---|---|
enabled
| Boolean!
| Indicates whether the dependency proxy is enabled for the group. |
Deployment
The deployment of an environment.
Fields
Name | Type | Description |
---|---|---|
approvalSummary
| DeploymentApprovalSummary
| Approval summary of the deployment.This field can only be resolved for one deployment in any single request. |
approvals
| [DeploymentApproval!]
| Current approvals of the deployment. |
commit
| Commit
| Commit details of the deployment. |
createdAt
| Time
| When the deployment record was created. |
finishedAt
| Time
| When the deployment finished. |
id
| ID
| Global ID of the deployment. |
iid
| ID
| Project-level internal ID of the deployment. |
job
| CiJob
| Pipeline job of the deployment. |
pendingApprovalCount
| Int
| Number of pending unified approvals on the deployment. |
ref
| String
| Git-Ref that the deployment ran on. |
sha
| String
| Git-SHA that the deployment ran on. |
status
| DeploymentStatus
| Status of the deployment. |
tag
| Boolean
| True or false if the deployment ran on a Git-tag. |
tags
| [DeploymentTag!]
| Git tags that contain this deployment. This field can only be resolved for two deployments in any single request. |
triggerer
| UserCore
| User who executed the deployment. |
updatedAt
| Time
| When the deployment record was updated. |
userPermissions
| DeploymentPermissions!
| Permissions for the current user on the resource. |
DeploymentApproval
Approval of the deployment.
Fields
Name | Type | Description |
---|---|---|
comment
| String
| Additional comment. |
createdAt
| Time
| When the user approved/rejected first time. |
status
| DeploymentsApprovalStatus
| Whether the deployment was approved/rejected. |
updatedAt
| Time
| When the user updated the approval. |
user
| UserCore
| User who approved or rejected the deployment. |
DeploymentApprovalSummary
Approval summary of the deployment.
Fields
Name | Type | Description |
---|---|---|
rules
| [ProtectedEnvironmentApprovalRuleForSummary!]
| Approval Rules for the deployment. |
status
| DeploymentApprovalSummaryStatus
| Status of the approvals. |
totalPendingApprovalCount
| Int
| Total pending approval count. |
totalRequiredApprovals
| Int
| Total number of required approvals. |
DeploymentPermissions
Fields
Name | Type | Description |
---|---|---|
approveDeployment
| Boolean!
| Indicates the user can perform approve_deployment on this resource. This field can only be resolved for one environment in any single request.
|
destroyDeployment
| Boolean!
| If true , the user can perform destroy_deployment on this resource.
|
updateDeployment
| Boolean!
| If true , the user can perform update_deployment on this resource.
|
DeploymentTag
Tags for a given deployment.
Fields
Name | Type | Description |
---|---|---|
name
| String
| Name of this git tag. |
path
| String
| Path for this tag. |
DescriptionVersion
Fields
Name | Type | Description |
---|---|---|
canDelete | Boolean
| Deprecated in 15.7. For backwards compatibility with REST API version and to be removed in a next iteration. |
deletePath | String
| Deprecated in 15.7. For backwards compatibility with REST API version and to be removed in a next iteration. |
deleted | Boolean
| Deprecated in 15.7. For backwards compatibility with REST API version and to be removed in a next iteration. |
description
| String
| Content of the given description version. |
diffPath | String
| Deprecated in 15.7. For backwards compatibility with REST API version and to be removed in a next iteration. |
id
| DescriptionVersionID!
| ID of the description version. |
Fields with arguments
DescriptionVersion.diff
Description diff between versions.
Returns String
.
Arguments
Name | Type | Description |
---|---|---|
versionId
| DescriptionVersionID
| ID of a previous version to compare. If not specified first previous version is used. |
Design
A single design.
Fields
Name | Type | Description |
---|---|---|
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
description
| String
| Description of the design. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
diffRefs
| DiffRefs!
| Diff refs for this design. |
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
event
| DesignVersionEvent!
| How this design was changed in the current version. |
filename
| String!
| Filename of the design. |
fullPath
| String!
| Full path to the design file. |
id
| ID!
| ID of this design. |
image
| String!
| URL of the full-sized image. |
imageV432x230
| 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!
| Issue the design belongs to. |
notesCount
| Int!
| Total count of user-created notes for this design. |
project
| Project!
| Project the design belongs to. |
webUrl
| String!
| URL of the design. |
Fields with arguments
Design.currentUserTodos
To-do items for the current user.
Returns TodoConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
Design.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
earlierOrEqualToId
| DesignManagementVersionID
| Global ID of the most recent acceptable version. |
earlierOrEqualToSha
| String
| 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!
| Underlying design. |
diffRefs
| DiffRefs!
| Diff refs for this design. |
event
| DesignVersionEvent!
| How this design was changed in the current version. |
filename
| String!
| Filename of the design. |
fullPath
| String!
| Full path to the design file. |
id
| ID!
| ID of this design. |
image
| String!
| URL of the full-sized image. |
imageV432x230
| 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!
| Issue the design belongs to. |
notesCount
| Int!
| Total count of user-created notes for this design. |
project
| Project!
| Project the design belongs to. |
version
| DesignVersion!
| Version this design-at-versions is pinned to. |
DesignCollection
A collection of designs.
Fields
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!
| 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
, and 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
| Global ID of the version. |
sha
| String
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
earlierOrEqualToId
| DesignManagementVersionID
| Global ID of the most recent acceptable version. |
earlierOrEqualToSha
| String
| 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!
| Global ID of the design at this version. |
DesignManagement.version
Find a version.
Returns DesignVersion
.
Arguments
Name | Type | Description |
---|---|---|
id
| DesignManagementVersionID!
| Global ID of the version. |
DesignManagementRepositoryRegistry
Represents the Geo replication and verification state of a Design Management Repository.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the DesignManagementRepositoryRegistry was created. |
designManagementRepositoryId
| ID!
| ID of the Design Management Repository. |
id
| ID!
| ID of the DesignManagementRepositoryRegistry. |
lastSyncFailure
| String
| Error message during sync of the DesignManagementRepositoryRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the DesignManagementRepositoryRegistry. |
retryAt
| Time
| Timestamp after which the DesignManagementRepositoryRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the DesignManagementRepositoryRegistry. |
state
| RegistryState
| Sync state of the DesignManagementRepositoryRegistry. |
verificationChecksum
| String
| The local checksum of the DesignManagementRepositoryRegistry. |
verificationFailure
| String
| Error message during verification of the DesignManagementRepositoryRegistry. |
verificationRetryAt
| Time
| Timestamp after which the DesignManagementRepositoryRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the DesignManagementRepositoryRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of DesignManagementRepositoryRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the DesignManagementRepositoryRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the DesignManagementRepositoryRegistry. |
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
| ID of a specific design. |
filename
| String
| Filename of a specific design. |
id
| DesignManagementDesignAtVersionID
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filenames
| [String!]
| Filters designs by their filename. |
ids
| [DesignManagementDesignID!]
| Filters designs by their ID. |
DetailedImportStatus
Details of the import status of a project.
Fields
Name | Type | Description |
---|---|---|
id
| ProjectImportStateID
| ID of the import state. |
lastError
| String
| Last error of the import. |
lastSuccessfulUpdateAt
| Time
| Time of the last successful update. |
lastUpdateAt
| Time
| Time of the last update. |
lastUpdateStartedAt
| Time
| Time of the start of the last update. |
status
| String
| Current status of the import. |
url
| String
| Import url. |
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
|
Deprecated in 16.4. The group attribute is deprecated. Use name instead.
|
hasDetails
| Boolean
| Indicates if the status has further details. |
icon | String
|
Deprecated in 16.4. The icon attribute is deprecated. Use name to identify the status to display instead.
|
id
| String!
| ID for a detailed status. |
label
| String
| Human-readable label of the status (e.g. success). |
name
| String
| Machine-readable status name (e.g. SUCCESS). |
text | String
|
Deprecated in 16.4. The text attribute is being deprecated. Use label instead.
|
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
, and 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. |
coverageFuzzingEnabledCount
| Int
| Total number of projects with enabled coverage fuzzing. |
dastEnabledCount
| Int
| Total number of projects with enabled DAST. |
dependencyScanningEnabledCount
| Int
| Total number of projects with enabled dependency scanning. |
deploySucceeded
| Boolean!
| At least one deployment succeeded. |
endTime
| Time!
| End time for the snapshot where the data points were collected. |
issueOpened
| Boolean!
| At least one issue was opened. |
mergeRequestApproved
| Boolean!
| At least one merge request was approved. |
mergeRequestOpened
| Boolean!
| At least one merge request was opened. |
pipelineSucceeded
| Boolean!
| At least one pipeline succeeded. |
recordedAt
| Time!
| Time the snapshot was recorded. |
runnerConfigured
| Boolean!
| At least one runner was used. |
sastEnabledCount
| Int
| Total number of projects with enabled SAST. |
startTime
| Time!
| Start time for the snapshot where the data points were collected. |
totalProjectsCount
| Int
| Total number of projects. |
vulnerabilityManagementUsedCount
| Int
| Total number of projects with vulnerability management used at least once. |
Diff
Fields
Name | Type | Description |
---|---|---|
aMode
| String
| Old file mode of the file. |
bMode
| String
| New file mode of the file. |
deletedFile
| String
| Indicates if the file has been removed. |
diff
| String
| Diff representation of the changes made to the file. |
newFile
| String
| Indicates if the file has just been added. |
newPath
| String
| New path of the file. |
oldPath
| String
| Old path of the file. |
renamedFile
| String
| Indicates if the file has been renamed. |
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. |
noteable
| NoteableType
| Object which the discussion belongs to. |
notes
| NoteConnection!
| All notes in the discussion. (see Connections) |
replyId
| DiscussionID!
| ID used to reply to this discussion. |
resolvable
| Boolean!
| Indicates if the object can be resolved. |
resolved
| Boolean!
| Indicates if the object is resolved. |
resolvedAt
| Time
| Timestamp of when the object was resolved. |
resolvedBy
| UserCore
| User who resolved the object. |
Dora
All information related to DORA metrics.
Fields with arguments
Dora.metrics
DORA metrics for the current group or project.
Returns [DoraMetric!]
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Date
| Date range to end at. Default is the current date. |
environmentTiers
| [DeploymentTier!]
| Deployment tiers of the environments to return. Defaults to [PRODUCTION] .
|
interval
| DoraMetricBucketingInterval
| How the metric should be aggregated. Defaults to DAILY . In the case of ALL , the date field in the response will be null .
|
metric | DoraMetricType
|
Deprecated in 15.10. Superseded by metrics fields. See DoraMetric type.
|
startDate
| Date
| Date range to start from. Default is 3 months ago. |
DoraMetric
Fields
Name | Type | Description |
---|---|---|
changeFailureRate
| Float
| Percentage of deployments that caused incidents in production. |
date
| String
| Date of the data point. |
deploymentFrequency
| Float
| Number of deployments per day. |
leadTimeForChanges
| Float
| Median time to deploy a merged merge request. |
timeToRestoreService
| Float
| Median time to close an incident. |
value | Float
| Deprecated in 15.10. Moved to corresponding metric field. |
DoraPerformanceScoreCount
Aggregated DORA score counts for projects for the last complete month.
Fields
Name | Type | Description |
---|---|---|
highProjectsCount
| Int
| Number of projects that score “high” on the metric. |
lowProjectsCount
| Int
| Number of projects that score “low” on the metric. |
mediumProjectsCount
| Int
| Number of projects that score “medium” on the metric. |
metricName
| String!
| Name of the DORA metric. |
noDataProjectsCount
| Int
| Number of projects with no data for the metric. |
EgressNode
Fields
Name | Type | Description |
---|---|---|
artifactsEgress
| BigInt!
| Artifacts egress for that project in that period of time. |
date
| String!
| First day of the node range. There is one node per month. |
packagesEgress
| BigInt!
| Packages egress for that project in that period of time. |
registryEgress
| BigInt!
| Registry egress for that project in that period of time. |
repositoryEgress
| BigInt!
| Repository egress for that project in that period of time. |
totalEgress
| BigInt!
| Total egress for that project in that period of time. |
Email
Fields
Name | Type | Description |
---|---|---|
confirmedAt
| Time
| Timestamp the email was confirmed. |
createdAt
| Time!
| Timestamp the email was created. |
email
| String!
| Email address. |
id
| ID!
| Internal ID of the email. |
updatedAt
| Time!
| Timestamp the email was last updated. |
Environment
Describes where code is deployed for a project.
Fields
Name | Type | Description |
---|---|---|
autoDeleteAt
| Time
| When the environment is going to be deleted automatically. |
autoStopAt
| Time
| When the environment is going to be stopped automatically. |
clusterAgent
| ClusterAgent
| Cluster agent of the environment. |
createdAt
| Time
| When the environment was created. |
deployFreezes
| [CiFreezePeriod!]
| Deployment freeze periods of the environment. |
environmentType
| String
| Folder name of the environment. |
externalUrl
| String
| External URL of the environment. |
fluxResourcePath
| String
| Flux resource path of the environment. |
id
| ID!
| ID of the environment. |
kubernetesNamespace
| String
| Kubernetes namespace of the environment. |
latestOpenedMostSevereAlert
| AlertManagementAlert
| 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!
| Path to the environment. |
protectedEnvironments
| ProtectedEnvironmentConnection
| Protected Environments for the environment. (see Connections) |
slug
| String
| Slug of the environment. |
state
| String!
| State of the environment, for example: available/stopped. |
tier
| DeploymentTier
| Deployment tier of the environment. |
updatedAt
| Time
| When the environment was updated. |
userPermissions
| EnvironmentPermissions!
| Permissions for the current user on the resource. This field can only be resolved for one environment in any single request. |
Fields with arguments
Environment.deployments
Deployments of the environment. This field can only be resolved for one environment in any single request.
Returns DeploymentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
orderBy
| DeploymentsOrderByInput
| Order by a specified field. |
statuses
| [DeploymentStatus!]
| Statuses of the deployments. |
Environment.lastDeployment
Last deployment of the environment.
Returns Deployment
.
Arguments
Name | Type | Description |
---|---|---|
status
| DeploymentStatus!
| Status of the Deployment. |
EnvironmentPermissions
Fields
Name | Type | Description |
---|---|---|
destroyEnvironment
| Boolean!
| If true , the user can perform destroy_environment on this resource.
|
stopEnvironment
| Boolean!
| If true , the user can perform stop_environment on this resource.
|
updateEnvironment
| Boolean!
| If true , the user can perform update_environment on this resource.
|
Epic
Represents an epic.
Fields
Name | Type | Description |
---|---|---|
author
| UserCore!
| Author of the epic. |
awardEmoji
| AwardEmojiConnection
| List of emoji reactions associated with the epic. (see Connections) |
blocked
| Boolean
| Indicates the epic is blocked. |
blockedByCount
| Int
| Count of epics blocking this epic. |
blockedByEpics
| EpicConnection
| Epics blocking this epic. (see Connections) |
blockingCount
| Int
| Count of epics that this epic is blocking. |
closedAt
| Time
| Timestamp of when the epic was closed. |
color
| String
| Color of the epic. Returns null if epic_color_highlight feature flag is disabled.
|
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
confidential
| Boolean
| Indicates if the epic is confidential. |
createdAt
| Time
| Timestamp of when the epic was created. |
defaultProjectForIssueCreation
| Project
| Default Project for issue creation. Based on the project the user created the last issue in. |
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
| 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. |
dueDateFromInheritedSource
| Time
| Inherited due date of the epic from child epics or milestones. |
dueDateFromMilestones
| Time
| Inherited due date of the epic from milestones. |
dueDateIsFixed
| Boolean
| Indicates if the due date has been manually set. |
events
| EventConnection
| 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) |
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
| Relative position of the epic in the epic tree. |
startDate
| Time
| Start date of the epic. |
startDateFixed
| Time
| Fixed start date of the epic. |
startDateFromInheritedSource
| Time
| Inherited start date of the epic from child epics or milestones. |
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. |
textColor
| String
| Text color generated for the epic. Returns null if epic_color_highlight feature flag is disabled.
|
title
| String
| Title of the epic. |
titleHtml
| String
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
createdAfter
| Time
| Epics created after this date. |
createdBefore
| Time
| Epics created before this date. |
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] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
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. |
or | UnionedEpicFilterInput
|
Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
|
search
| String
| Search query for title or description. |
sort
| EpicSort
| List epics by sort order. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
topLevelHierarchyOnly
| Boolean
| Filter epics with a top-level hierarchy. |
updatedAfter
| Time
| Epics updated after this date. |
updatedBefore
| Time
| Epics updated before this date. |
Epic.children
Children (sub-epics) of the epic.
Returns EpicConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
createdAfter
| Time
| Epics created after this date. |
createdBefore
| Time
| Epics created before this date. |
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] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
includeAncestorGroups
| Boolean
| Include child 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. |
or | UnionedEpicFilterInput
|
Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
|
search
| String
| Search query for title or description. |
sort
| EpicSort
| List epics by sort order. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
topLevelHierarchyOnly
| Boolean
| Filter epics with a top-level hierarchy. |
updatedAfter
| Time
| Epics updated after this date. |
updatedBefore
| Time
| Epics updated before this date. |
Epic.currentUserTodos
To-do items for the current user.
Returns TodoConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
Epic.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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 |
---|---|---|
displayColors
| Boolean
| Whether or not display epic colors. |
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
, and 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
|
Deprecated in 16.6. Use closedIssuesTotal .
|
closedIssuesTotal
| BigInt
| Total weight of completed (closed) issues in this epic, including epic descendants, encoded as a string. |
openedIssues | Int
|
Deprecated in 16.6. Use OpenedIssuesTotal .
|
openedIssuesTotal
| BigInt
| Total weight of opened issues in this epic, including epic descendants, encoded as a string. |
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
|
Deprecated in 15.6. Use alert_management_alerts .
|
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) |
blockingCount
| Int!
| Count of issues this issue is blocking. |
closedAsDuplicateOf
| Issue
| Issue this issue was closed as a duplicate of. |
closedAt
| Time
| Timestamp of when the issue was closed. |
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
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. |
customerRelationsContacts
| CustomerRelationsContactConnection
| Customer relations contacts of the issue. (see Connections) |
description
| String
| Description of the issue. |
descriptionHtml
| String
| 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!
|
Deprecated in 16.3. Use emails_enabled .
|
emailsEnabled
| Boolean!
| Indicates if the parent project or group has email notifications disabled: false if email notifications are disabled.
|
epic
| Epic
| Epic to which this issue belongs. |
epicIssueId
| ID!
| ID of the epic-issue relation. |
escalationPolicy
| EscalationPolicyType
| Escalation policy associated with the issue. Available for issues which support escalation. |
escalationStatus
| IssueEscalationStatus
| Escalation status of the issue. |
externalAuthor
| String
| Email address of non-GitLab user reporting the issue. For guests, the email address is obfuscated. |
hasEpic
| Boolean!
| Indicates if the issue belongs to an epic. Can return true and not show an associated epic when the user has no access to the epic. |
hasParent | Boolean!
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Indicates if the issue has a parent work item. |
healthStatus
| HealthStatus
| Current health status. |
hidden
| Boolean
| Indicates the issue is hidden because the author has been banned. |
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) |
mergeRequestsCount
| Int!
| Number of merge requests that close the issue on merge. |
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. |
participants
| UserCoreConnection
| List of participants in the issue. (see Connections) |
projectId
| Int
| ID of the issue project. |
relatedMergeRequests
| MergeRequestConnection
| Merge requests related to the issue. This field can only be resolved for one issue in any single request. (see Connections) |
relatedVulnerabilities
| VulnerabilityConnection
| Related vulnerabilities of 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
| GitLab Flavored Markdown rendering of title .
|
totalTimeSpent
| Int!
| Total time (in seconds) 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.alertManagementAlerts
Alert Management alerts associated to this issue.
Returns AlertManagementAlertConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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] .
|
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
EpicIssue.issuableResourceLinks
Issuable resource links of the incident issue.
Returns IssuableResourceLinkConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
incidentId
| IssueID!
| ID of the incident. |
EpicIssue.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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
|
Deprecated in 14.9. This was renamed. Use: metadata .
|
id
| BoardsEpicListID!
| Global ID of the board list. |
label
| Label
| Label of the list. |
listType
| String!
| Type of the list. |
metadata
| EpicListMetadata
| Epic list metatada. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filters
| EpicFilters
| Filters applied when selecting epics in the board list. |
EpicListMetadata
Represents epic board list metadata.
Fields
Name | Type | Description |
---|---|---|
epicsCount
| Int
| Count of epics in the list. |
totalWeight | Int
| Introduced in 14.7. This feature is an Experiment. It can be changed or removed at any time. Total weight of all issues in the list. |
EpicPermissions
Check permissions for the current user on an epic.
Fields
Name | Type | Description |
---|---|---|
adminEpic
| Boolean!
| If true , the user can perform admin_epic on this resource.
|
awardEmoji
| Boolean!
| If true , the user can perform award_emoji on this resource.
|
createEpic
| Boolean!
| If true , the user can perform create_epic on this resource.
|
createNote
| Boolean!
| If true , the user can perform create_note on this resource.
|
destroyEpic
| Boolean!
| If true , the user can perform destroy_epic on this resource.
|
readEpic
| Boolean!
| If true , the user can perform read_epic on this resource.
|
readEpicIid
| Boolean!
| If true , the user can perform read_epic_iid on this resource.
|
updateEpic
| Boolean!
| If true , the user can perform update_epic on this resource.
|
EscalationPolicyType
Represents an escalation policy.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the escalation policy. |
id
| IncidentManagementEscalationPolicyID
| ID of the escalation policy. |
name
| String
| 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
| Time in seconds before the rule is activated. |
id
| IncidentManagementEscalationRuleID
| ID of the escalation policy. |
oncallSchedule
| IncidentManagementOncallSchedule
| On-call schedule to notify. |
status
| EscalationRuleStatus
| Status required to prevent the rule from activating. |
user
| UserCore
| User to notify. |
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. |
ExplainVulnerabilityPresubmissionCheckResults
Fields
Name | Type | Description |
---|---|---|
potentialSecretsInCode
| Boolean!
| This flag is true if we think there might be a secret in the code that would be sent in the LLM prompt. |
secretDetectionResult
| Boolean!
| This flag is true if the vulnerability being explained is specifically a secret detection vulnerability. |
ExplainVulnerabilityPrompt
Fields
Name | Type | Description |
---|---|---|
presubmissionChecks
| ExplainVulnerabilityPresubmissionCheckResults!
| An object containing booleans. Each booolean indicates the result of a presubmission check: true for passed, and false for failed.
|
promptWithCode
| String
| AI text prompt generated using the vulnerability’s information, including the vulnerable code. |
promptWithoutCode
| String
| AI text prompt generated using the vulnerability’s information, excluding the vulnerable code. |
ExternalAuditEventDestination
Represents an external resource to send audit events to.
Fields
Name | Type | Description |
---|---|---|
destinationUrl
| String!
| External destination to send audit events to. |
eventTypeFilters
| [String!]!
| List of event type filters added for streaming. |
group
| Group!
| Group the destination belongs to. |
headers
| AuditEventStreamingHeaderConnection!
| List of additional HTTP headers sent with each event. (see Connections) |
id
| ID!
| ID of the destination. |
name
| String!
| Name of the external destination to send audit events to. |
namespaceFilter
| AuditEventStreamingHTTPNamespaceFilter
| List of subgroup or project filters for the destination. |
verificationToken
| String!
| Verification token to validate source of event. |
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. |
ExternalStatusCheck
Describes an external status check.
Fields
Name | Type | Description |
---|---|---|
externalUrl
| String!
| External URL for the status check. |
id
| GlobalID!
| ID of the rule. |
name
| String!
| Name of the rule. |
FileUpload
Fields
Name | Type | Description |
---|---|---|
id
| UploadID!
| Global ID of the upload. |
path
| String!
| Path of the upload. |
size
| Int!
| Size of the upload in bytes. |
FindingReportsComparer
Represents security reports comparison for vulnerability findings.
Fields
Name | Type | Description |
---|---|---|
report | ComparedSecurityReport
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Compared security report. |
status
| FindingReportsComparerStatus
| Comparison status. |
statusReason
| String
| Text explaining the status. |
Forecast
Information about specific forecast created.
Fields
Name | Type | Description |
---|---|---|
status
| ForecastStatus!
| Status of the forecast. |
values
| ForecastDatapointConnection
| Actual forecast values. (see Connections) |
ForecastDatapoint
Information about specific forecast datapoint.
Fields
Name | Type | Description |
---|---|---|
datapoint
| String!
| Datapoint of the forecast. Usually a date. |
value
| Float
| Value of the given datapoint. |
ForkDetails
Details of the fork project compared to its upstream project.
Fields
Name | Type | Description |
---|---|---|
ahead
| Int
| Number of commits ahead of upstream. |
behind
| Int
| Number of commits behind upstream. |
hasConflicts
| Boolean
| Indicates if the fork conflicts with its upstream project. |
isSyncing
| Boolean
| Indicates if there is a synchronization in progress. |
GeoNode
Fields
Name | Type | Description |
---|---|---|
containerRepositoriesMaxCapacity
| Int
| Maximum concurrency of container repository sync for this secondary node. |
enabled
| Boolean
| Indicates whether this Geo node is enabled. |
filesMaxCapacity
| Int
| Maximum concurrency of LFS/attachment backfill for this secondary node. |
id
| ID!
| ID of this GeoNode. |
internalUrl
| String
| URL defined on the primary node secondary nodes should use to contact it. |
minimumReverificationInterval
| Int
| Interval (in days) in which the repository verification is valid. After expiry, it is reverted. |
name
| String
| Unique identifier for this Geo node. |
primary
| Boolean
| Indicates whether this Geo node is the primary. |
reposMaxCapacity
| Int
| Maximum concurrency of repository backfill for this secondary node. |
selectiveSyncNamespaces
| NamespaceConnection
| Namespaces that should be synced, if selective_sync_type == namespaces . (see Connections)
|
selectiveSyncShards
| [String!]
| Repository storages whose projects should be synced, if selective_sync_type == shards .
|
selectiveSyncType
| 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
| User-facing URL for this Geo node. |
verificationMaxCapacity
| Int
| Maximum concurrency of repository verification for this secondary node. |
Fields with arguments
GeoNode.ciSecureFileRegistries
Find Ci Secure File registries on this Geo node.
Returns CiSecureFileRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.containerRepositoryRegistries
Find Container Repository registries on this Geo node.
Returns ContainerRepositoryRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.dependencyProxyBlobRegistries
Find Dependency Proxy Blob registries on this Geo node.
Returns DependencyProxyBlobRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.dependencyProxyManifestRegistries
Find Dependency Proxy Manifest registries on this Geo node.
Returns DependencyProxyManifestRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.designManagementRepositoryRegistries
Find Design Management Repository registries on this Geo node.
Returns DesignManagementRepositoryRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.groupWikiRepositoryRegistries
Find group wiki repository registries on this Geo node.
Returns GroupWikiRepositoryRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.jobArtifactRegistries
Find Job Artifact registries on this Geo node.
Returns JobArtifactRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.lfsObjectRegistries
Find LFS object registries on this Geo node.
Returns LfsObjectRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.mergeRequestDiffRegistries
Find merge request diff registries on this Geo node.
Returns MergeRequestDiffRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.packageFileRegistries
Package file registries of the GeoNode.
Returns PackageFileRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.pagesDeploymentRegistries
Find Pages Deployment registries on this Geo node.
Returns PagesDeploymentRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.pipelineArtifactRegistries
Find pipeline artifact registries on this Geo node.
Returns PipelineArtifactRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.projectRepositoryRegistries
Find Project registries on this Geo node. Ignored if geo_project_repository_replication
feature flag is disabled.
Returns ProjectRepositoryRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.projectWikiRepositoryRegistries
Find Project Wiki Repository registries on this Geo node. Ignored if geo_project_wiki_repository_replication
feature flag is disabled.
Returns ProjectWikiRepositoryRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.snippetRepositoryRegistries
Find snippet repository registries on this Geo node.
Returns SnippetRepositoryRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.terraformStateVersionRegistries
Find terraform state version registries on this Geo node.
Returns TerraformStateVersionRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GeoNode.uploadRegistries
Find Upload registries on this Geo node.
Returns UploadRegistryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filters registries by their ID. |
keyword
| String
| Filters registries by their attributes using a keyword. |
replicationState
| ReplicationStateEnum
| Filters registries by their replication state. |
verificationState
| VerificationStateEnum
| Filters registries by their verification state. |
GoogleCloudLoggingConfigurationType
Stores Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.
Fields
Name | Type | Description |
---|---|---|
clientEmail
| String!
| Client email. |
googleProjectIdName
| String!
| Google project ID. |
group
| Group!
| Group the configuration belongs to. |
id
| ID!
| ID of the configuration. |
logIdName
| String!
| Log ID. |
name
| String!
| Name of the external destination to send audit events to. |
GpgSignature
GPG signature for a signed commit.
Fields
Name | Type | Description |
---|---|---|
commitSha
| String
| SHA of the associated commit. |
gpgKeyPrimaryKeyid
| String
| ID of the GPG key. |
gpgKeyUserEmail
| String
| User email associated with the GPG key. |
gpgKeyUserName
| String
| User name associated with the GPG key. |
project
| Project
| Project of the associated commit. |
user
| UserCore
| User associated with the key. |
verificationStatus
| VerificationStatus
| Indicates verification status of the associated key or certificate. |
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. This limit only applies to namespaces under Project limit enforcement. |
actualSizeLimit
| Float
| The actual storage size limit (in bytes) based on the enforcement type of either repository or namespace. This limit is agnostic of enforcement type. |
additionalPurchasedStorageSize
| Float
| Additional storage purchased for the root namespace in bytes. |
allowStaleRunnerPruning
| Boolean!
| Indicates whether to regularly prune stale group runners. Defaults to false. |
amazonS3Configurations
| AmazonS3ConfigurationTypeConnection
| Amazon S3 configurations that receive audit events belonging to the group. (see Connections) |
autoDevopsEnabled
| Boolean
| Indicates whether Auto DevOps is enabled for all projects within this group. |
avatarUrl
| String
| Avatar URL of the group. |
containerRepositoriesCount
| Int!
| Number of container repositories in the group. |
containsLockedProjects
| Boolean!
| Includes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement. |
crossProjectPipelineAvailable
| Boolean!
| Indicates if the cross_project_pipeline feature is available for the namespace. |
dependencyProxyBlobCount
| Int!
| Number of dependency proxy blobs cached in the group. |
dependencyProxyBlobs
| DependencyProxyBlobConnection
| Dependency Proxy blobs. (see Connections) |
dependencyProxyImageCount
| Int!
| Number of dependency proxy images cached in the group. |
dependencyProxyImagePrefix
| String!
| Prefix for pulling images when using the dependency proxy. |
dependencyProxyImageTtlPolicy
| DependencyProxyImageTtlGroupPolicy
| Dependency proxy TTL policy for the group. |
dependencyProxyManifests
| DependencyProxyManifestConnection
| Dependency Proxy manifests. (see Connections) |
dependencyProxySetting
| DependencyProxySetting
| Dependency Proxy settings for the group. |
dependencyProxyTotalSize
| String!
| Total size of the dependency proxy cached images. |
dependencyProxyTotalSizeBytes
| BigInt!
| Total size of the dependency proxy cached images in bytes, encoded as a string. |
dependencyProxyTotalSizeInBytes | Int!
|
Deprecated in 16.1. Use dependencyProxyTotalSizeBytes .
|
description
| String
| Description of the namespace. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
dora
| Dora
| Group’s DORA metrics. |
emailsDisabled
| Boolean
| Indicates if a group has email notifications disabled. |
enforceFreeUserCap
| Boolean
| Indicates whether the group has limited users for a free plan. |
epicBoards
| EpicBoardConnection
| Find epic boards. (see Connections) |
epicsEnabled
| Boolean
| Indicates if Epics are enabled for namespace. |
externalAuditEventDestinations
| ExternalAuditEventDestinationConnection
| External locations that receive audit events belonging to the group. (see Connections) |
flowMetrics | GroupValueStreamAnalyticsFlowMetrics
| Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Flow metrics for value stream analytics. |
fullName
| String!
| Full name of the namespace. |
fullPath
| ID!
| Full path of the namespace. |
googleCloudLoggingConfigurations
| GoogleCloudLoggingConfigurationTypeConnection
| Google Cloud logging configurations that receive audit events belonging to the group. (see Connections) |
id
| ID!
| ID of the namespace. |
isTemporaryStorageIncreaseEnabled | Boolean!
| Deprecated in 16.7. Feature removal, will be completely removed in 17.0. |
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
| Package settings for the namespace. |
parent
| Group
| Parent group. |
path
| String!
| Path of the namespace. |
pendingMembers | PendingGroupMemberConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. A pending membership of a user within this group. |
projectCreationLevel
| String
| Permission level required to create projects in the group. |
recentIssueBoards
| BoardConnection
| List of recently visited boards of the group. Maximum size is 4. (see Connections) |
repositorySizeExcessProjectCount
| Int!
| Number of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement. |
requestAccessEnabled
| 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. |
sharedRunnersSetting
| SharedRunnersSetting
| Shared runners availability for the namespace and its descendants. |
stats
| GroupStats
| Group statistics. |
storageSizeLimit
| Float
| The storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement. |
subgroupCreationLevel
| String
| Permission level required to create subgroups within the group. |
temporaryStorageIncreaseEndsOn | Time
| Deprecated in 16.7. Feature removal, will be completely removed in 17.0. |
timelogCategories | TimeTrackingTimelogCategoryConnection
| Introduced in 15.3. This feature is an Experiment. It can be changed or removed at any time. Timelog categories for the namespace. |
totalRepositorySize
| 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. This only applies to namespaces under Project limit enforcement. |
twoFactorGracePeriod
| Int
| Time before two-factor authentication is enforced. |
userPermissions
| GroupPermissions!
| Permissions for the current user on the resource. |
valueStreams
| ValueStreamConnection
| Value streams available to the group. (see Connections) |
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.achievements
Achievements for the namespace. Returns null
if the achievements
feature flag is disabled.
Returns AchievementConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [AchievementsAchievementID!]
| Filter achievements by IDs. |
Group.addOnEligibleUsers
Users in the namespace hierarchy that add ons are applicable for. This only applies to root namespaces.
Returns AddOnUserConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
addOnType
| GitlabSubscriptionsAddOnType!
| Type of add on to filter the eligible users by. |
search
| String
| Search the user list. |
Group.addOnPurchase
AddOnPurchase associated with the namespace.
Returns AddOnPurchase
.
Arguments
Name | Type | Description |
---|---|---|
addOnName
| String!
| AddOn name. |
Group.autocompleteUsers
Search users for autocompletion.
Returns [AutocompletedUser!]
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Query to search users by name, username, or public email. |
Group.billableMembersCount
Number of billable users in the group.
Returns Int
.
Arguments
Name | Type | Description |
---|---|---|
requestedHostedPlan
| String
| Plan from which to get billable members. |
Group.board
A single board of the group.
Returns Board
.
Arguments
Name | Type | Description |
---|---|---|
id
| BoardID!
| ID of the board. |
Group.boards
Boards of the group.
Returns BoardConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
| BoardID
| Find a board by its ID. |
Group.ciVariables
List of the group’s CI/CD variables.
Returns CiGroupVariableConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
sort
| CiVariableSort
| Sort order of results. |
Group.clusterAgents
Cluster agents associated with projects in the group and its subgroups.
Returns ClusterAgentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
hasRemoteDevelopmentAgentConfig
| Boolean
| Returns only cluster agents which have an associated remote development agent config. |
hasRemoteDevelopmentEnabled
| Boolean
| Returns only cluster agents which have been enabled with the remote development feature. |
hasVulnerabilities
| Boolean
| Returns only cluster agents which have vulnerabilities. |
Group.codeCoverageActivities
Represents the code coverage activity for this group.
Returns CodeCoverageActivityConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
| ComplianceManagementFrameworkID
| Global ID of a specific compliance framework to return. |
ids
| [ComplianceManagementFrameworkID!]
| List of Global IDs of compliance frameworks to return. |
search
| String
| Search framework with most similar names. |
Group.contactStateCounts
Counts of contacts by state for the group.
Returns ContactStateCounts
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search term to find contacts with. |
state
| CustomerRelationsContactState
| State of the contacts to search for. |
Group.contacts
Find contacts of this group.
Returns CustomerRelationsContactConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [CustomerRelationsContactID!]
| Filter contacts by IDs. |
search
| String
| Search term to find contacts with. |
sort
| ContactSort
| Criteria to sort contacts by. |
state
| CustomerRelationsContactState
| State of the contacts to search for. |
Group.containerRepositories
Container repositories of the group.
Returns ContainerRepositoryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| Filter the container repositories by their name. |
sort
| ContainerRepositorySort
| Sort container repositories by this criteria. |
Group.contributions
Provides the aggregated contributions by users within the group and its subgroups.
Returns ContributionAnalyticsContributionConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
from
| ISO8601Date!
| Start date of the reporting time range. |
to
| ISO8601Date!
| End date of the reporting time range. The end date must be within 93 days after the start date. |
Group.customEmoji
Custom emoji in this namespace.
Returns CustomEmojiConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
includeAncestorGroups
| Boolean
| Includes custom emoji from parent groups. |
Group.customizableDashboardVisualizations
Visualizations of the group or associated configuration project.
Returns CustomizableDashboardVisualizationConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
slug
| String
| Slug of the visualization to return. |
Group.customizableDashboards
Customizable dashboards for the group.
Returns CustomizableDashboardConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
category
| CustomizableDashboardCategory
| Find by dashboard type. |
slug
| String
| Find by dashboard slug. |
Group.dataTransfer
Data transfer data point for a specific period. This is mocked data under a development feature flag.
Returns GroupDataTransfer
.
Arguments
Name | Type | Description |
---|---|---|
from
| Date
| Retain egress data for one year. Data for the current month will increase dynamically as egress occurs. |
to
| Date
| End date for the data. |
Group.descendantGroups
List of descendant groups of this group.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
includeParentDescendants
| Boolean
| List of descendant groups of the parent group. |
owned
| Boolean
| Limit result to groups owned by authenticated user. |
search
| String
| Search query for group name or group full path. |
Group.doraPerformanceScoreCounts
Group’s DORA scores for all projects by DORA key metric for the last complete month.
Returns DoraPerformanceScoreCountConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
projectFilters
| DoraProjectFilterInput
| Filter DORA metric results by project attributes. |
Group.environmentScopes
Environment scopes of the group.
Returns CiGroupEnvironmentScopeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| Name of the environment scope. |
search
| String
| Search query for environment scope name. |
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. |
createdAfter
| Time
| Epics created after this date. |
createdBefore
| Time
| Epics created before this date. |
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] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
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. |
or | UnionedEpicFilterInput
|
Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
|
search
| String
| Search query for title or description. |
sort
| EpicSort
| List epics by sort order. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
topLevelHierarchyOnly
| Boolean
| Filter epics with a top-level hierarchy. |
updatedAfter
| Time
| Epics updated after this date. |
updatedBefore
| Time
| Epics updated before this date. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter epics by author. |
confidential
| Boolean
| Filter epics by given confidentiality. |
createdAfter
| Time
| Epics created after this date. |
createdBefore
| Time
| Epics created before this date. |
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] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
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. |
or | UnionedEpicFilterInput
|
Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
|
search
| String
| Search query for title or description. |
sort
| EpicSort
| List epics by sort order. |
state
| EpicState
| Filter epics by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
topLevelHierarchyOnly
| Boolean
| Filter epics with a top-level hierarchy. |
updatedAfter
| Time
| Epics updated after this date. |
updatedBefore
| Time
| Epics updated before this date. |
Group.gitlabSubscriptionsPreviewBillableUserChange
Preview Billable User Changes.
Returns PreviewBillableUserChange
.
Arguments
Name | Type | Description |
---|---|---|
addGroupId
| Int
| Group ID to add. |
addUserEmails
| [String!]
| User emails to add. |
addUserIds
| [Int!]
| User IDs to add. |
memberRoleId
| Int
| Custom role assigned to the users. |
role
| GitlabSubscriptionsUserRole!
| Role of users being added to group. |
Group.groupMembers
A membership of a user within this group.
Returns GroupMemberConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
accessLevels
| [AccessLevelEnum!]
| Filter members by the given access levels. |
relations
| [GroupMemberRelation!]
| Filter members by the given member relations. |
search
| String
| Search query. |
sort
| MemberSort
| sort 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported. |
assigneeUsername | String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
assigneeWildcardId
| AssigneeWildcardId
| Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
confidential
| Boolean
| Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
crmContactId
| String
| ID of a contact assigned to the issues. |
crmOrganizationId
| String
| ID of an organization assigned to the issues. |
epicId
| String
| ID of an epic associated with the issues, “none” and “any” values are supported. |
epicWildcardId
| EpicWildcardId
| Filter by epic ID wildcard. Incompatible with epicId. |
healthStatus | HealthStatus
|
Deprecated in 15.4. Use healthStatusFilter .
|
healthStatusFilter
| HealthStatusFilter
| Health status of the issue, “none” and “any” values are supported. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
includeArchived
| Boolean
| Return issues from archived projects. |
includeSubepics
| Boolean
| Whether to include subepics when filtering issues by epicId. |
includeSubgroups
| Boolean
| Include issues belonging to subgroups. |
iterationCadenceId
| [IterationsCadenceID!]
| Filter by a list of iteration cadence IDs. |
iterationId
| [ID]
| List of iteration Global IDs applied to the issue. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
milestoneWildcardId
| MilestoneWildcardId
| Filter issues by milestone ID wildcard. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported. |
not
| NegatedIssueFilterInput
| Negated arguments. |
or
| UnionedIssueFilterInput
| List of arguments with inclusive OR. |
search
| String
| Search query for title or description. |
sort
| IssueSort
| Sort issues by this criteria. |
state
| IssuableState
| Current state of this issue. |
types
| [IssueType!]
| Filter issues by the given issue types. |
updatedAfter
| Time
| Issues updated after this date. |
updatedBefore
| Time
| Issues updated before this date. |
weight
| String
| Weight applied to the issue, “none” and “any” values are supported. |
weightWildcardId
| WeightWildcardId
| Filter by weight ID wildcard. Incompatible with weight. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the iteration cadence is active. |
automatic
| Boolean
| Whether the iteration cadence should automatically generate upcoming 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
| ID
| Global ID of the Iteration to look up. |
iid
| ID
| Internal ID of the Iteration to look up. |
in
| [IterationSearchableField!]
| Fields in which the fuzzy-search should be performed with the query given in the argument search . Defaults to [title] .
|
includeAncestors
| Boolean
| Whether to include ancestor iterations. Defaults to true. |
includeDescendants
| Boolean
| Whether to include descendant iterations. |
iterationCadenceIds
| [IterationsCadenceID!]
| Global iteration cadence IDs by which to look up the iterations. |
search
| String
| Query used for fuzzy-searching in the fields selected in the argument in . Returns all iterations if empty.
|
sort
| IterationSort
| List iterations by sort order. If unspecified, an arbitrary order (subject to change) is used. |
state
| IterationState
| Filter iterations by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
title | String
|
Deprecated in 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
|
Group.label
Label available on this group.
Returns Label
.
Arguments
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
, and 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
| Search term to find labels with. |
Group.memberRoles
Member roles available for the group.
Returns MemberRoleConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
| MemberRoleID
| Global ID of the member role to look up. |
Group.mergeRequestViolations
Compliance violations reported on merge requests merged within the group.
Returns ComplianceViolationConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filters
| ComplianceViolationInput
| Filters applied when retrieving compliance violations. |
sort
| ComplianceViolationSort
| List compliance violations by sort order. |
Group.mergeRequests
Merge requests for projects in this group.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
includeArchived
| Boolean
| Return merge requests from archived projects. |
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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
Group.milestones
Milestones of the group.
Returns MilestoneConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
containingDate
| Time
| Date the milestone contains. |
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
| Search string for the title. |
sort
| MilestoneSort
| Sort milestones by this criteria. |
state
| MilestoneStateEnum
| Filter milestones by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
title
| String
| Title of the milestone. |
Group.organizationStateCounts
Counts of organizations by status for the group.
Returns OrganizationStateCounts
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search term to find organizations with. |
state
| CustomerRelationsOrganizationState
| State of the organizations to search for. |
Group.organizations
Find organizations of this group.
Returns CustomerRelationsOrganizationConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [CustomerRelationsOrganizationID!]
| Filter organizations by IDs. |
search
| String
| Search term used to find organizations with. |
sort
| OrganizationSort
| Criteria to sort organizations by. |
state
| CustomerRelationsOrganizationState
| State of the organization to search for. |
Group.packages
Packages of the group. This field can only be resolved for one group in any single request.
Returns PackageConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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. |
packageVersion
| String
| Filter a package by version. If used in combination with include_versionless , then no versionless packages are returned.
|
sort
| PackageGroupSort
| Sort packages by this criteria. |
status
| PackageStatus
| Filter a package by status. |
Group.projectComplianceStandardsAdherence
Compliance standards adherence for the projects in a group and its subgroups.
Returns ComplianceStandardsAdherenceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filters
| ComplianceStandardsAdherenceInput
| Filters applied when retrieving compliance standards adherence. |
Group.projects
Projects within this namespace.
Returns ProjectConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
complianceFrameworkFilters
| ComplianceFrameworkFilters
| Filters applied when selecting a compliance framework. |
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. |
notAimedForDeletion
| Boolean
| Include projects that are not aimed for deletion. |
sbomComponentId
| ID
| Return only the projects related to the specified SBOM component. |
search
| String
| Search project with most similar names or paths. |
sort
| NamespaceProjectSort
| Sort projects by this criteria. |
withIssuesEnabled
| Boolean
| Return only projects with issues enabled. |
withMergeRequestsEnabled
| Boolean
| Return only projects with merge requests enabled. |
Group.releases
Releases belonging to projects in the group.
Returns ReleaseConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
sort
| GroupReleaseSort
| Sort group releases by given criteria. |
Group.runners
Find runners visible to the current user.
Returns CiRunnerConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
active | Boolean
|
Deprecated in 14.8. This was renamed. Use: paused .
|
creatorId
| UserID
| Filter runners by creator ID. |
membership
| CiRunnerMembershipFilter
| Control which runners to include in the results. |
paused
| Boolean
| Filter runners by paused (true) or active (false) status.
|
search
| String
| Filter by full token or partial text in description field. |
sort
| CiRunnerSort
| Sort order of results. |
status
| CiRunnerStatus
| Filter runners by status. |
tagList
| [String!]
| Filter by tags associated with the runner (comma-separated or array). |
type
| CiRunnerType
| Filter runners by type. |
upgradeStatus
| CiRunnerUpgradeStatus
| Filter by upgrade status. |
versionPrefix | String
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term ‘14.’ returns runner managers with versions ‘14.11.1’ and ‘14.2.3’. |
Group.scanExecutionPolicies
Scan Execution Policies of the namespace.
Returns ScanExecutionPolicyConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actionScanTypes
| [SecurityReportTypeEnum!]
| Filters policies by the action scan type. Only these scan types are supported: dast , secret_detection , cluster_image_scanning , container_scanning , sast , sast_iac , dependency_scanning .
|
relationship
| SecurityPolicyRelationType
| Filter policies by the given policy relationship. |
Group.scanResultPolicies
Scan Result Policies of the project.
Returns ScanResultPolicyConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
relationship
| SecurityPolicyRelationType
| Filter policies by the given policy relationship. |
Group.timelogs
Time logged on issues and merge requests in the group and its subgroups.
Returns TimelogConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
Group.valueStreamDashboardUsageOverview
Aggregated usage counts within the group.
Returns ValueStreamDashboardCount
.
Arguments
Name | Type | Description |
---|---|---|
identifier
| ValueStreamDashboardMetric!
| Type of counts to retrieve. |
timeframe
| Timeframe!
| Counts recorded during this time frame, usually from beginning of the month until the end of the month (the system runs monthly aggregations). |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
clusterAgentId
| [ClustersAgentID!]
| Filter vulnerabilities by cluster_agent_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
clusterId
| [ClustersClusterID!]
| Filter vulnerabilities by cluster_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
dismissalReason
| [VulnerabilityDismissalReason!]
| Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter. |
hasIssues
| Boolean
| Returns only the vulnerabilities which have linked issues. |
hasMergeRequest
| Boolean
| Returns only the vulnerabilities which have linked merge requests. |
hasRemediations
| Boolean
| Returns only the vulnerabilities which have remediations. |
hasResolution
| Boolean
| Returns only the vulnerabilities which have been resolved on default branch. |
image
| [String!]
| Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning , cluster_image_scanning .
|
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by VulnerabilityScanner.externalId. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
sort
| VulnerabilitySort
| List vulnerabilities by sort order. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
Group.vulnerabilitiesCountByDay
The historical number of vulnerabilities per day for the projects in the group and its subgroups.
Returns VulnerabilitiesCountByDayConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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. |
letterGrade
| VulnerabilityGrade
| Filter the response by given letter grade. |
Group.vulnerabilitySeveritiesCount
Counts for each vulnerability severity in the group and its subgroups.
Returns VulnerabilitySeveritiesCount
.
Arguments
Name | Type | Description |
---|---|---|
clusterAgentId
| [ClustersAgentID!]
| Filter vulnerabilities by cluster_agent_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
dismissalReason
| [VulnerabilityDismissalReason!]
| Filter by dismissal reason. |
hasIssues
| Boolean
| Filter vulnerabilities that do or do not have issues. |
hasMergeRequest
| Boolean
| Filter vulnerabilities that do or do not have a merge request. |
hasRemediations
| Boolean
| Filter vulnerabilities that do or do not have remediations. |
hasResolution
| Boolean
| Filter vulnerabilities that do or do not have a resolution. |
image
| [String!]
| Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning , cluster_image_scanning .
|
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by scanner. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
Group.workItem
Find a work item by IID directly associated with the group. Returns null
if the namespace_level_work_items
feature flag is disabled.
Returns WorkItem
.
Arguments
Name | Type | Description |
---|---|---|
iid
| String!
| IID of the work item. |
Group.workItemStateCounts
Counts of work items by state for the namespace. Returns null
if the namespace_level_work_items
feature flag is disabled.
Returns WorkItemStateCountsType
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername | String
| Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. Filter work items by author username. |
iid
| String
| IID of the work item. For example, “1”. |
iids
| [String!]
| List of IIDs of work items. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
requirementLegacyWidget | RequirementLegacyFilterInput
| Deprecated in 15.9. Use work item IID filter instead. |
search
| String
| Search query for title or description. |
sort
| WorkItemSort
| Sort work items by criteria. |
state
| IssuableState
| Current state of the work item. |
statusWidget
| StatusFilterInput
| Input for status widget filter. Ignored if work_items_mvc_2 is disabled.
|
types
| [IssueType!]
| Filter work items by the given work item types. |
Group.workItemTypes
Work item types available to the group.
Returns WorkItemTypeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
taskable
| Boolean
| If true , only taskable work item types will be returned. Argument is experimental and can be removed in the future without notice.
|
Group.workItems
Work items that belong to the namespace.
Returns WorkItemConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername | String
| Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. Filter work items by author username. |
iid
| String
| IID of the work item. For example, “1”. |
iids
| [String!]
| List of IIDs of work items. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
requirementLegacyWidget | RequirementLegacyFilterInput
| Deprecated in 15.9. Use work item IID filter instead. |
search
| String
| Search query for title or description. |
sort
| WorkItemSort
| Sort work items by criteria. |
state
| IssuableState
| Current state of the work item. |
statusWidget
| StatusFilterInput
| Input for status widget filter. Ignored if work_items_mvc_2 is disabled.
|
types
| [IssueType!]
| Filter work items by the given work item types. |
GroupDataTransfer
Fields
Name | Type | Description |
---|---|---|
egressNodes
| EgressNodeConnection
| Data nodes. (see Connections) |
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. |
notificationEmail
| String
| Group notification email for user. Only available for admins. |
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. |
Fields with arguments
GroupMember.mergeRequestInteraction
Find a merge request.
Returns UserMergeRequestInteraction
.
Arguments
Name | Type | Description |
---|---|---|
id
| MergeRequestID!
| Global ID of the merge request. |
GroupPermissions
Fields
Name | Type | Description |
---|---|---|
createCustomEmoji
| Boolean!
| If true , the user can perform create_custom_emoji on this resource.
|
createProjects
| Boolean!
| If true , the user can perform create_projects on this resource.
|
readGroup
| Boolean!
| If true , 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. |
GroupSecurityPolicySource
Represents the source of a security policy belonging to a group.
Fields
Name | Type | Description |
---|---|---|
inherited
| Boolean!
| Indicates whether this policy is inherited from parent group. |
namespace
| Namespace
| Project the policy is associated with. |
GroupStats
Contains statistics about a group.
Fields
Name | Type | Description |
---|---|---|
releaseStats
| GroupReleaseStats
| Statistics related to releases within the group. |
GroupValueStreamAnalyticsFlowMetrics
Exposes aggregated value stream flow metrics.
Fields with arguments
GroupValueStreamAnalyticsFlowMetrics.cycleTime
Median time from first commit to issue closed.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
epicId
| ID
| ID of an epic associated with the issues. |
from
| Time!
| Timestamp marking the start date and time. |
iterationId
| ID
| ID of an iteration associated with the issues. |
labelNames
| [String!]
| Labels applied to the issue. |
milestoneTitle
| String
| Milestone applied to the issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedValueStreamAnalyticsIssueFilterInput
| Argument used for adding negated filters. |
projectIds
| [ID!]
| Project IDs within the group hierarchy. |
to
| Time!
| Timestamp marking the end date and time. |
weight
| Int
| Weight applied to the issue. |
GroupValueStreamAnalyticsFlowMetrics.deploymentCount
Number of production deployments in the given period.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
from
| Time!
| Timestamp marking the start date and time. |
projectIds
| [ID!]
| Project IDs within the group hierarchy. |
to
| Time!
| Timestamp marking the end date and time. |
GroupValueStreamAnalyticsFlowMetrics.issueCount
Number of issues opened in the given period.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
epicId
| ID
| ID of an epic associated with the issues. |
from
| Time!
| Timestamp marking the start date and time. |
iterationId
| ID
| ID of an iteration associated with the issues. |
labelNames
| [String!]
| Labels applied to the issue. |
milestoneTitle
| String
| Milestone applied to the issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedValueStreamAnalyticsIssueFilterInput
| Argument used for adding negated filters. |
projectIds
| [ID!]
| Project IDs within the group hierarchy. |
to
| Time!
| Timestamp marking the end date and time. |
weight
| Int
| Weight applied to the issue. |
GroupValueStreamAnalyticsFlowMetrics.issuesCompletedCount
Number of open issues closed (completed) in the given period. Maximum value is 10,001.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
epicId
| ID
| ID of an epic associated with the issues. |
from
| Time!
| Timestamp marking the start date and time. |
iterationId
| ID
| ID of an iteration associated with the issues. |
labelNames
| [String!]
| Labels applied to the issue. |
milestoneTitle
| String
| Milestone applied to the issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedValueStreamAnalyticsIssueFilterInput
| Argument used for adding negated filters. |
projectIds
| [ID!]
| Project IDs within the group hierarchy. |
to
| Time!
| Timestamp marking the end date and time. |
weight
| Int
| Weight applied to the issue. |
GroupValueStreamAnalyticsFlowMetrics.leadTime
Median time from when the issue was created to when it was closed.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
epicId
| ID
| ID of an epic associated with the issues. |
from
| Time!
| Timestamp marking the start date and time. |
iterationId
| ID
| ID of an iteration associated with the issues. |
labelNames
| [String!]
| Labels applied to the issue. |
milestoneTitle
| String
| Milestone applied to the issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedValueStreamAnalyticsIssueFilterInput
| Argument used for adding negated filters. |
projectIds
| [ID!]
| Project IDs within the group hierarchy. |
to
| Time!
| Timestamp marking the end date and time. |
weight
| Int
| Weight applied to the issue. |
GroupValueStreamAnalyticsFlowMetrics.timeToMerge
Median time from merge request creation to merge request merged.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the merge request. |
authorUsername
| String
| Username of the author of the merge request. |
from
| Time!
| Timestamp marking the start date and time. |
labelNames
| [String!]
| Labels applied to the merge request. |
milestoneTitle
| String
| Milestone applied to the merge request. |
projectIds
| [ID!]
| Project IDs within the group hierarchy. |
to
| Time!
| Timestamp marking the end date and time. |
GroupWikiRepositoryRegistry
Represents the Geo sync and verification state of a group wiki repository.
Fields
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 is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the GroupWikiRepositoryRegistry. |
state
| RegistryState
| Sync state of the GroupWikiRepositoryRegistry. |
verificationChecksum
| String
| The local checksum of the GroupWikiRepositoryRegistry. |
verificationFailure
| String
| Error message during verification of the GroupWikiRepositoryRegistry. |
verificationRetryAt
| Time
| Timestamp after which the GroupWikiRepositoryRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the GroupWikiRepositoryRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of GroupWikiRepositoryRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the GroupWikiRepositoryRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the GroupWikiRepositoryRegistry. |
Groups
Fields
Name | Type | Description |
---|---|---|
commit
| Commit!
| Commit responsible for specified group. |
commitData
| CommitData
| HTML data derived from commit needed to present blame. |
lineno
| Int!
| Starting line number for the commit group. |
lines
| [String!]!
| Array of lines added for the commit group. |
span
| Int!
| Number of contiguous lines which the blame spans for the commit group. |
HelmFileMetadata
Helm file metadata.
Fields
Name | Type | Description |
---|---|---|
channel
| String!
| Channel of the Helm chart. |
createdAt
| Time!
| Date of creation. |
metadata
| PackageHelmMetadataType!
| Metadata of the Helm chart. |
updatedAt
| Time!
| Date of most recent update. |
Ide
IDE settings and feature flags.
Fields
Name | Type | Description |
---|---|---|
codeSuggestionsEnabled
| Boolean!
| Indicates whether AI assisted code suggestions are enabled. |
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
, and 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. |
oncallUsers
| [UserCore!]
| |
rotations
| IncidentManagementOncallRotationConnection!
| On-call rotations for the on-call schedule. (see Connections) |
timezone
| String!
| Time zone of the on-call schedule. |
Fields with arguments
IncidentManagementOncallSchedule.rotation
On-call rotation for the on-call schedule.
Returns IncidentManagementOncallRotation
.
Arguments
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. |
InheritedCiVariable
CI/CD variables a project inherites from its parent group and ancestors.
Fields
Name | Type | Description |
---|---|---|
environmentScope
| String
| Scope defining the environments that can use the variable. |
groupCiCdSettingsPath
| String
| Indicates the path to the CI/CD settings of the group the variable belongs to. |
groupName
| String
| Indicates group the variable belongs to. |
id
| ID!
| ID of the variable. |
key
| String
| Name of the variable. |
masked
| Boolean
| Indicates whether the variable is masked. |
protected
| Boolean
| Indicates whether the variable is protected. |
raw
| Boolean
| Indicates whether the variable is raw. |
variableType
| CiVariableType
| Type of the variable. |
InstanceAmazonS3ConfigurationType
Stores instance level Amazon S3 configurations for audit event streaming.
Fields
Name | Type | Description |
---|---|---|
accessKeyXid
| String!
| Access key ID of the Amazon S3 account. |
awsRegion
| String!
| AWS region where the bucket is created. |
bucketName
| String!
| Name of the bucket where the audit events would be logged. |
id
| ID!
| ID of the configuration. |
name
| String!
| Name of the external destination to send audit events to. |
InstanceExternalAuditEventDestination
Represents an external resource to send instance audit events to.
Fields
Name | Type | Description |
---|---|---|
destinationUrl
| String!
| External destination to send audit events to. |
eventTypeFilters
| [String!]!
| List of event type filters added for streaming. |
headers
| AuditEventsStreamingInstanceHeaderConnection!
| List of additional HTTP headers sent with each event. (see Connections) |
id
| ID!
| ID of the destination. |
name
| String!
| Name of the external destination to send audit events to. |
verificationToken
| String!
| Verification token to validate source of event. |
InstanceGoogleCloudLoggingConfigurationType
Stores instance level Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.
Fields
Name | Type | Description |
---|---|---|
clientEmail
| String!
| Client email. |
googleProjectIdName
| String!
| Google project ID. |
id
| ID!
| ID of the configuration. |
logIdName
| String!
| Log ID. |
name
| String!
| Name of the external destination to send audit events to. |
InstanceSecurityDashboard
Fields
Name | Type | Description |
---|---|---|
vulnerabilityScanners
| VulnerabilityScannerConnection
| Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. (see Connections) |
Fields with arguments
InstanceSecurityDashboard.clusterAgents
Cluster agents associated with projects selected in the Instance Security Dashboard.
Returns ClusterAgentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
hasRemoteDevelopmentAgentConfig
| Boolean
| Returns only cluster agents which have an associated remote development agent config. |
hasRemoteDevelopmentEnabled
| Boolean
| Returns only cluster agents which have been enabled with the remote development feature. |
hasVulnerabilities
| Boolean
| Returns only cluster agents which have vulnerabilities. |
InstanceSecurityDashboard.projects
Projects selected in Instance Security Dashboard.
Returns ProjectConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query, which can be for the project name, a path, or a description. |
InstanceSecurityDashboard.vulnerabilityGrades
Represents vulnerable project counts for each grade.
Returns [VulnerableProjectsByGrade!]!
.
Arguments
Name | Type | Description |
---|---|---|
letterGrade
| VulnerabilityGrade
| Filter the response by given letter grade. |
InstanceSecurityDashboard.vulnerabilitySeveritiesCount
Counts for each vulnerability severity from projects selected in Instance Security Dashboard.
Returns VulnerabilitySeveritiesCount
.
Arguments
Name | Type | Description |
---|---|---|
clusterAgentId
| [ClustersAgentID!]
| Filter vulnerabilities by cluster_agent_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
dismissalReason
| [VulnerabilityDismissalReason!]
| Filter by dismissal reason. |
hasIssues
| Boolean
| Filter vulnerabilities that do or do not have issues. |
hasMergeRequest
| Boolean
| Filter vulnerabilities that do or do not have a merge request. |
hasRemediations
| Boolean
| Filter vulnerabilities that do or do not have remediations. |
hasResolution
| Boolean
| Filter vulnerabilities that do or do not have a resolution. |
image
| [String!]
| Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning , cluster_image_scanning .
|
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by scanner. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
IssuableResourceLink
Describes an issuable resource link for incident issues.
Fields
Name | Type | Description |
---|---|---|
id
| IncidentManagementIssuableResourceLinkID!
| ID of the Issuable resource link. |
issue
| Issue!
| Incident of the resource link. |
link
| String!
| Web Link to the resource. |
linkText
| String
| Optional text for the link. |
linkType
| IssuableResourceLinkType!
| Type of the resource link. |
Issue
Fields
Name | Type | Description |
---|---|---|
alertManagementAlert | AlertManagementAlert
|
Deprecated in 15.6. Use alert_management_alerts .
|
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) |
blockingCount
| Int!
| Count of issues this issue is blocking. |
closedAsDuplicateOf
| Issue
| Issue this issue was closed as a duplicate of. |
closedAt
| Time
| Timestamp of when the issue was closed. |
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
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. |
customerRelationsContacts
| CustomerRelationsContactConnection
| Customer relations contacts of the issue. (see Connections) |
description
| String
| Description of the issue. |
descriptionHtml
| String
| 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!
|
Deprecated in 16.3. Use emails_enabled .
|
emailsEnabled
| Boolean!
| Indicates if the parent project or group has email notifications disabled: false if email notifications are disabled.
|
epic
| Epic
| Epic to which this issue belongs. |
escalationPolicy
| EscalationPolicyType
| Escalation policy associated with the issue. Available for issues which support escalation. |
escalationStatus
| IssueEscalationStatus
| Escalation status of the issue. |
externalAuthor
| String
| Email address of non-GitLab user reporting the issue. For guests, the email address is obfuscated. |
hasEpic
| Boolean!
| Indicates if the issue belongs to an epic. Can return true and not show an associated epic when the user has no access to the epic. |
hasParent | Boolean!
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Indicates if the issue has a parent work item. |
healthStatus
| HealthStatus
| Current health status. |
hidden
| Boolean
| Indicates the issue is hidden because the author has been banned. |
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) |
mergeRequestsCount
| Int!
| Number of merge requests that close the issue on merge. |
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. |
participants
| UserCoreConnection
| List of participants in the issue. (see Connections) |
projectId
| Int
| ID of the issue project. |
relatedMergeRequests
| MergeRequestConnection
| Merge requests related to the issue. This field can only be resolved for one issue in any single request. (see Connections) |
relatedVulnerabilities
| VulnerabilityConnection
| Related vulnerabilities of 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
| GitLab Flavored Markdown rendering of title .
|
totalTimeSpent
| Int!
| Total time (in seconds) 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.alertManagementAlerts
Alert Management alerts associated to this issue.
Returns AlertManagementAlertConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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] .
|
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
Issue.issuableResourceLinks
Issuable resource links of the incident issue.
Returns IssuableResourceLinkConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
incidentId
| IssueID!
| ID of the incident. |
Issue.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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!
| If true , the user can perform admin_issue on this resource.
|
createDesign
| Boolean!
| If true , the user can perform create_design on this resource.
|
createNote
| Boolean!
| If true , the user can perform create_note on this resource.
|
destroyDesign
| Boolean!
| If true , the user can perform destroy_design on this resource.
|
readDesign
| Boolean!
| If true , the user can perform read_design on this resource.
|
readIssue
| Boolean!
| If true , the user can perform read_issue on this resource.
|
reopenIssue
| Boolean!
| If true , the user can perform reopen_issue on this resource.
|
updateDesign
| Boolean!
| If true , the user can perform update_design on this resource.
|
updateIssue
| Boolean!
| If true , 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
| 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. |
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. |
sequence
| Int!
| Sequence number for the iteration when you sort the containing cadence’s iterations by the start and end date. The earliest starting and ending iteration is assigned 1. |
startDate
| 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. |
Fields with arguments
Iteration.report
Historically accurate report about the timebox.
Returns TimeboxReport
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| String
| Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab .
|
IterationCadence
Represents an iteration cadence.
Fields
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the iteration cadence is active. |
automatic
| Boolean
| Whether the iteration cadence should automatically generate upcoming 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
| Upcoming 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 automation 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. |
serviceType
| ServiceType
| Type of the service. |
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
, and 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. |
JobArtifactRegistry
Represents the Geo replication and verification state of a job_artifact.
Fields
Name | Type | Description |
---|---|---|
artifactId
| ID!
| ID of the Job Artifact. |
createdAt
| Time
| Timestamp when the JobArtifactRegistry was created. |
id
| ID!
| ID of the JobArtifactRegistry. |
lastSyncFailure
| String
| Error message during sync of the JobArtifactRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the JobArtifactRegistry. |
retryAt
| Time
| Timestamp after which the JobArtifactRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the JobArtifactRegistry. |
state
| RegistryState
| Sync state of the JobArtifactRegistry. |
verificationChecksum
| String
| The local checksum of the JobArtifactRegistry. |
verificationFailure
| String
| Error message during verification of the JobArtifactRegistry. |
verificationRetryAt
| Time
| Timestamp after which the JobArtifactRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the JobArtifactRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of JobArtifactRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the JobArtifactRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the JobArtifactRegistry. |
JobPermissions
Fields
Name | Type | Description |
---|---|---|
cancelBuild
| Boolean!
| If true , the user can perform cancel_build on this resource.
|
readBuild
| Boolean!
| If true , the user can perform read_build on this resource.
|
readJobArtifacts
| Boolean!
| If true , the user can perform read_job_artifacts on this resource.
|
updateBuild
| Boolean!
| If true , 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
| URL used by the Agents to communicate with KAS. |
version
| String
| KAS version. |
Key
Represents an SSH key.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp of when the key was created. |
expiresAt
| Time!
| Timestamp of when the key expires. It’s null if it never expires. |
id
| ID!
| ID of the key. |
key
| String!
| Public key of the key pair. |
title
| String!
| Title of the key. |
Label
Fields
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
| GitLab Flavored Markdown rendering of description .
|
id
| ID!
| Label ID. |
lockOnMerge
| Boolean!
| Indicates this label is locked for merge requests that have been merged. |
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 is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the LfsObjectRegistry. |
state
| RegistryState
| Sync state of the LfsObjectRegistry. |
verificationChecksum
| String
| The local checksum of the LfsObjectRegistry. |
verificationFailure
| String
| Error message during verification of the LfsObjectRegistry. |
verificationRetryAt
| Time
| Timestamp after which the LfsObjectRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the LfsObjectRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of LfsObjectRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the LfsObjectRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the LfsObjectRegistry. |
License
Fields
Name | Type | Description |
---|---|---|
name
| String!
| Name of the license. |
url
| String!
| License URL in relation to SPDX. |
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. |
createdAt
| Date
| Date when the license was added. |
email
| String
| Email of the licensee. |
expiresAt
| Date
| Date when the license expires. |
id
| ID!
| ID of the license extracted from the license data. |
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. |
LinkedWorkItemType
Fields
Name | Type | Description |
---|---|---|
linkCreatedAt
| Time!
| Timestamp the link was created. |
linkId
| WorkItemsRelatedWorkItemLinkID!
| Global ID of the link. |
linkType
| String!
| Type of link. |
linkUpdatedAt
| Time!
| Timestamp the link was updated. |
workItem
| WorkItem
| Linked work item. |
Location
Fields
Name | Type | Description |
---|---|---|
blobPath
| String
| HTTP URI path to view the input file in GitLab. |
path
| String
| Path, relative to the root of the repository, of the filewhich was analyzed to detect the dependency. |
MLCandidateLinks
Represents links to perform actions on the candidate.
Fields
Name | Type | Description |
---|---|---|
artifactPath
| String
| Path to the artifact. |
showPath
| String
| Path to the details page of the candidate. |
MLModelVersionLinks
Represents links to perform actions on the model version.
Fields
Name | Type | Description |
---|---|---|
showPath
| String
| Path to the details page of the model version. |
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. |
MemberRole
Represents a member role.
Fields
Name | Type | Description |
---|---|---|
adminGroupMember | Boolean
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Permission to admin group members. |
adminMergeRequest | Boolean
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Permission to admin merge requests. |
adminVulnerability | Boolean
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Permission to admin vulnerability. |
archiveProject | Boolean
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Permission to archive projects. |
baseAccessLevel | AccessLevel!
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Base access level for the custom role. |
description
| String
| Description of the member role. |
enabledPermissions | [MemberRolePermission!]
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Array of all permissions enabled for the custom role. |
id
| MemberRoleID!
| ID of the member role. |
manageProjectAccessTokens | Boolean
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Permission to admin project access tokens. |
membersCount | Int!
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Total number of members with the custom role. |
name
| String!
| Name of the member role. |
readCode | Boolean
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Permission to read code. |
readDependency | Boolean
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Permission to read dependency. |
readVulnerability | Boolean
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Permission to read vulnerability. |
MergeAccessLevel
Defines which user roles, users, or groups can merge into a protected branch.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| Int!
| GitLab::Access level. |
accessLevelDescription
| String!
| Human readable representation for this access level. |
group
| AccessLevelGroup
| Group associated with this access level. |
user
| AccessLevelUser
| User associated with this access level. |
MergeRequest
Fields
Name | Type | Description |
---|---|---|
allowCollaboration
| Boolean
| Indicates if members of the target project can push to the fork. |
approvalState
| MergeRequestApprovalState!
| Information relating to rules that must be satisfied to merge this merge request. |
approvalsLeft
| Int
| Number of approvals left. |
approvalsRequired
| Int
| Number of approvals required. |
approved
| Boolean!
| Indicates if the merge request has all the required approvals. |
approvedBy
| UserCoreConnection
| Users who approved the merge request. (see Connections) |
assignees
| MergeRequestAssigneeConnection
| Assignees of the merge request. (see Connections) |
author
| MergeRequestAuthor
| 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. |
awardEmoji
| AwardEmojiConnection
| List of emoji reactions associated with the merge request. (see Connections) |
blockingMergeRequests | BlockingMergeRequests
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Merge requests that block another merge request from merging. |
codequalityReportsComparer | CodequalityReportsComparer
|
Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Code quality reports comparison reported on the merge request. Returns null if sast_reports_in_inline_diff feature flag is disabled.
|
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
commitCount
| Int
| Number of commits in the merge request. |
commits
| CommitConnection
| Merge request commits. (see Connections) |
commitsWithoutMergeCommits
| CommitConnection
| Merge request commits excluding merge commits. (see Connections) |
committers
| UserCoreConnection
| Users who have added commits to the merge request. (see Connections) |
conflicts
| Boolean!
| Indicates if the merge request has conflicts. |
createdAt
| Time!
| Timestamp of when the merge request was created. |
defaultMergeCommitMessage
| String
| Default merge commit message of the merge request. |
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
| GitLab Flavored Markdown rendering of description .
|
detailedMergeStatus
| DetailedMergeStatus
| Detailed merge status of the merge request. |
diffHeadSha
| String
| Diff head SHA of the merge request. |
diffLlmSummaries | MergeRequestDiffLlmSummaryConnection
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Diff summaries generated by AI. |
diffRefs
| 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
| 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. |
mergeRequestDiffs | MergeRequestDiffConnection
| Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Diff versions of a merge request. |
mergeStatus | String
|
Deprecated in 14.0. This was renamed. Use: MergeRequest.mergeStatusEnum .
|
mergeStatusEnum
| 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 or set it to auto-merge. |
mergeWhenPipelineSucceeds
| Boolean
| Indicates if the merge has been set to auto-merge. |
mergeabilityChecks | [MergeRequestMergeabilityCheck!]!
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Status of all mergeability checks of the merge request. |
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
| Milestone of the merge request. |
participants
| MergeRequestParticipantConnection
| Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. (see Connections) |
preparedAt
| Time
| Timestamp of when the merge request was prepared. |
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 the merge request is set to be squashed when merged. Project settings may override this value. Use squash_on_merge instead to take project squash options into account.
|
squashOnMerge
| Boolean!
| Indicates if the merge request will be squashed when merged. |
state
| MergeRequestState!
| State of the merge request. |
subscribed
| Boolean!
| Indicates if the currently logged in user is subscribed to this merge request. |
suggestedReviewers | SuggestedReviewersType
|
Introduced in 15.4. This feature is an Experiment. It can be changed or removed at any time. Suggested reviewers for merge request. Returns null if suggested_reviewers feature flag is disabled. This flag is disabled by default and only available on GitLab.com because the feature is experimental and is subject to change without notice.
|
supportsLockOnMerge
| Boolean!
| Indicates if the merge request supports locked labels. |
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
| GitLab Flavored Markdown rendering of title .
|
totalTimeSpent
| Int!
| Total time (in seconds) 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. |
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
, and 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
| Specific file path. |
MergeRequest.findingReportsComparer
Vulnerability finding reports comparison reported on the merge request.
Returns FindingReportsComparer
.
Arguments
Name | Type | Description |
---|---|---|
reportType
| ComparableSecurityReportType!
| Filter vulnerability findings by report type. |
MergeRequest.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ref
| String
| Filter pipelines by the ref they are run for. |
scope
| PipelineScopeEnum
| Filter pipelines by scope. |
sha
| String
| Filter pipelines by the sha of the commit they are run for. |
source
| String
| Filter pipelines by their source. |
status
| PipelineStatusEnum
| Filter pipelines by their status. |
updatedAfter
| Time
| Pipelines updated after this date. |
updatedBefore
| Time
| Pipelines updated before this date. |
username
| String
| Filter pipelines by the user that triggered the pipeline. |
MergeRequest.reference
Internal reference of the merge request. Returned in shortened format by default.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
full
| Boolean
| Boolean option specifying whether the reference should be returned in full. |
MergeRequestApprovalState
Information relating to rules that must be satisfied to merge this merge request.
Fields
Name | Type | Description |
---|---|---|
approvalRulesOverwritten
| Boolean
| Indicates if the merge request approval rules are overwritten for the merge request. |
invalidApproversRules
| [ApprovalRule!]
| List of approval rules that are associated with the merge request, but invalid. |
rules
| [ApprovalRule!]
| List of approval rules associated with the merge request. |
suggestedApprovers
| UserCoreConnection
| List of suggested approvers. (see Connections) |
MergeRequestAssignee
A user assigned to a merge request.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
mergeRequestInteraction
| UserMergeRequestInteraction
| Details of this user’s interactions with the merge request. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
MergeRequestAssignee.assignedMergeRequests
Merge requests assigned to the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestAssignee.authoredMergeRequests
Merge requests authored by the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestAssignee.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
MergeRequestAssignee.reviewRequestedMergeRequests
Merge requests assigned to the user for review.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestAssignee.savedReply
Saved reply authored by the user.
Returns SavedReply
.
Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
MergeRequestAssignee.snippets
Snippets authored by the user.
Returns SnippetConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
MergeRequestAssignee.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
MergeRequestAssignee.workspaces
Workspaces owned by the current user.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
MergeRequestAuthor
The author of the merge request.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
mergeRequestInteraction
| UserMergeRequestInteraction
| Details of this user’s interactions with the merge request. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
MergeRequestAuthor.assignedMergeRequests
Merge requests assigned to the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestAuthor.authoredMergeRequests
Merge requests authored by the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestAuthor.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
MergeRequestAuthor.reviewRequestedMergeRequests
Merge requests assigned to the user for review.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestAuthor.savedReply
Saved reply authored by the user.
Returns SavedReply
.
Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
MergeRequestAuthor.snippets
Snippets authored by the user.
Returns SnippetConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| Visibility of the snippet. |
MergeRequestAuthor.starredProjects
Projects starred by the user.
Returns ProjectConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
MergeRequestAuthor.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
MergeRequestAuthor.todos
To-do items of the user.
Returns TodoConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
MergeRequestAuthor.workspaces
Workspaces owned by the current user.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
MergeRequestDiff
A diff version of a merge request.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp of when the diff was created. |
diffLlmSummary
| MergeRequestDiffLlmSummary
| Diff summary generated by AI. |
reviewLlmSummaries
| MergeRequestReviewLlmSummaryConnection
| Review summaries generated by AI. (see Connections) |
updatedAt
| Time!
| Timestamp of when the diff was updated. |
MergeRequestDiffLlmSummary
A diff summary generated by AI.
Fields
Name | Type | Description |
---|---|---|
content
| String!
| Content of the diff summary. |
createdAt
| Time!
| Timestamp of when the diff summary was created. |
mergeRequestDiffId
| ID!
| ID of the Merge Request diff associated with the diff summary. |
provider
| String!
| AI provider that generated the summary. |
updatedAt
| Time!
| Timestamp of when the diff summary was updated. |
user
| UserCore
| User associated with the diff summary. |
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 is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the MergeRequestDiffRegistry. |
state
| RegistryState
| Sync state of the MergeRequestDiffRegistry. |
verificationChecksum
| String
| The local checksum of the MergeRequestDiffRegistry. |
verificationFailure
| String
| Error message during verification of the MergeRequestDiffRegistry. |
verificationRetryAt
| Time
| Timestamp after which the MergeRequestDiffRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the MergeRequestDiffRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of MergeRequestDiffRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the MergeRequestDiffRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the MergeRequestDiffRegistry. |
MergeRequestMergeabilityCheck
Mergeability check of the merge request.
Fields
Name | Type | Description |
---|---|---|
identifier
| MergeabilityCheckIdentifier!
| Identifier of the mergeability check. |
status
| MergeabilityCheckStatus!
| Status of the mergeability check. |
MergeRequestParticipant
A user participating in a merge request.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
mergeRequestInteraction
| UserMergeRequestInteraction
| Details of this user’s interactions with the merge request. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
MergeRequestParticipant.assignedMergeRequests
Merge requests assigned to the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestParticipant.authoredMergeRequests
Merge requests authored by the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestParticipant.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
MergeRequestParticipant.reviewRequestedMergeRequests
Merge requests assigned to the user for review.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestParticipant.savedReply
Saved reply authored by the user.
Returns SavedReply
.
Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
MergeRequestParticipant.snippets
Snippets authored by the user.
Returns SnippetConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| Visibility of the snippet. |
MergeRequestParticipant.starredProjects
Projects starred by the user.
Returns ProjectConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
MergeRequestParticipant.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
MergeRequestParticipant.todos
To-do items of the user.
Returns TodoConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
MergeRequestParticipant.workspaces
Workspaces owned by the current user.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
MergeRequestPermissions
Check permissions for the current user on a merge request.
Fields
Name | Type | Description |
---|---|---|
adminMergeRequest
| Boolean!
| If true , the user can perform admin_merge_request on this resource.
|
canApprove
| Boolean!
| If true , the user can perform can_approve on this resource.
|
canMerge
| Boolean!
| If true , the user can perform can_merge on this resource.
|
cherryPickOnCurrentMergeRequest
| Boolean!
| If true , the user can perform cherry_pick_on_current_merge_request on this resource.
|
createNote
| Boolean!
| If true , the user can perform create_note on this resource.
|
pushToSourceBranch
| Boolean!
| If true , the user can perform push_to_source_branch on this resource.
|
readMergeRequest
| Boolean!
| If true , the user can perform read_merge_request on this resource.
|
removeSourceBranch
| Boolean!
| If true , the user can perform remove_source_branch on this resource.
|
revertOnCurrentMergeRequest
| Boolean!
| If true , the user can perform revert_on_current_merge_request on this resource.
|
updateMergeRequest
| Boolean!
| If true , the user can perform update_merge_request on this resource.
|
MergeRequestReviewLlmSummary
A review summary generated by AI.
Fields
Name | Type | Description |
---|---|---|
content
| String!
| Content of the review summary. |
contentHtml
| String!
| HTML content of the review summary, converted from Markdown. |
createdAt
| Time!
| Timestamp of when the review summary was created. |
mergeRequestDiffId
| ID!
| ID of the Merge Request diff associated with the review summary. |
provider
| String!
| AI provider that generated the summary. |
reviewer
| UserCore
| User who authored the review associated with the review summary. |
updatedAt
| Time!
| Timestamp of when the review summary was updated. |
user
| UserCore
| User associated with the review summary. |
MergeRequestReviewer
A user assigned to a merge request as a reviewer.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
mergeRequestInteraction
| UserMergeRequestInteraction
| Details of this user’s interactions with the merge request. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
MergeRequestReviewer.assignedMergeRequests
Merge requests assigned to the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestReviewer.authoredMergeRequests
Merge requests authored by the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestReviewer.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
MergeRequestReviewer.reviewRequestedMergeRequests
Merge requests assigned to the user for review.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
MergeRequestReviewer.savedReply
Saved reply authored by the user.
Returns SavedReply
.
Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
MergeRequestReviewer.snippets
Snippets authored by the user.
Returns SnippetConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
MergeRequestReviewer.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
MergeRequestReviewer.workspaces
Workspaces owned by the current user.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
Metadata
Fields
Name | Type | Description |
---|---|---|
enterprise
| Boolean!
| Enterprise edition. |
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. |
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. |
expired
| Boolean!
| Expired state of the milestone (a milestone is expired when the due date is past the current date). Defaults to false when due date has not been set.
|
groupMilestone
| Boolean!
| Indicates if milestone is at group level. |
id
| ID!
| ID of the milestone. |
iid
| ID!
| Internal ID of the milestone. |
projectMilestone
| Boolean!
| Indicates if milestone is at project level. |
releases
| ReleaseConnection
| Releases associated with this milestone. (see Connections) |
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. |
Fields with arguments
Milestone.report
Historically accurate report about the timebox.
Returns TimeboxReport
.
Arguments
Name | Type | Description |
---|---|---|
fullPath
| String
| Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab .
|
MilestoneStats
Contains statistics about a milestone.
Fields
Name | Type | Description |
---|---|---|
closedIssuesCount
| Int
| Number of closed issues associated with the milestone. |
totalIssuesCount
| Int
| Total number of issues associated with the milestone. |
MlCandidate
Candidate for a model version in the model registry.
Fields
Name | Type | Description |
---|---|---|
_links
| MLCandidateLinks!
| Map of links to perform actions on the candidate. |
createdAt
| Time!
| Date of creation. |
id
| MlCandidateID!
| ID of the candidate. |
name
| String!
| Name of the candidate. |
MlModel
Machine learning model in the model registry.
Fields
Name | Type | Description |
---|---|---|
candidates
| MlCandidateConnection
| Version candidates of the model. (see Connections) |
id
| MlModelID!
| ID of the model. |
name
| String!
| Name of the model. |
versions
| MlModelVersionConnection
| Versions of the model. (see Connections) |
MlModelVersion
Version of a machine learning model.
Fields
Name | Type | Description |
---|---|---|
_links
| MLModelVersionLinks!
| Map of links to perform actions on the model version. |
createdAt
| Time!
| Date of creation. |
id
| MlModelVersionID!
| ID of the model version. |
version
| String!
| Name of the version. |
MonthlyUsage
Product analytics events for a specific month and year.
Fields
Name | Type | Description |
---|---|---|
count
| Int
| Count of product analytics events. |
month
| Int!
| Month of the data. |
year
| Int!
| Year of the data. |
Namespace
Fields
Name | Type | Description |
---|---|---|
actualRepositorySizeLimit
| Float
| Size limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement. |
actualSizeLimit
| Float
| The actual storage size limit (in bytes) based on the enforcement type of either repository or namespace. This limit is agnostic of enforcement type. |
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. This only applies to namespaces under Project limit enforcement. |
crossProjectPipelineAvailable
| Boolean!
| Indicates if the cross_project_pipeline feature is available for the namespace. |
description
| String
| Description of the namespace. |
descriptionHtml
| String
| 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!
| Deprecated in 16.7. Feature removal, will be completely removed in 17.0. |
lfsEnabled
| Boolean
| Indicates if Large File Storage (LFS) is enabled for namespace. |
name
| String!
| Name of the namespace. |
packageSettings
| PackageSettings
| 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. This only applies to namespaces under Project limit enforcement. |
requestAccessEnabled
| Boolean
| Indicates if users can request access to namespace. |
rootStorageStatistics
| RootStorageStatistics
| Aggregated storage statistics of the namespace. Only available for root namespaces. |
sharedRunnersSetting
| SharedRunnersSetting
| Shared runners availability for the namespace and its descendants. |
storageSizeLimit
| Float
| The storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement. |
temporaryStorageIncreaseEndsOn | Time
| Deprecated in 16.7. Feature removal, will be completely removed in 17.0. |
timelogCategories | TimeTrackingTimelogCategoryConnection
| Introduced in 15.3. This feature is an Experiment. It can be changed or removed at any time. Timelog categories for the namespace. |
totalRepositorySize
| 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. This only applies to namespaces under Project limit enforcement. |
visibility
| String
| Visibility of the namespace. |
Fields with arguments
Namespace.achievements
Achievements for the namespace. Returns null
if the achievements
feature flag is disabled.
Returns AchievementConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [AchievementsAchievementID!]
| Filter achievements by IDs. |
Namespace.addOnEligibleUsers
Users in the namespace hierarchy that add ons are applicable for. This only applies to root namespaces.
Returns AddOnUserConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
addOnType
| GitlabSubscriptionsAddOnType!
| Type of add on to filter the eligible users by. |
search
| String
| Search the user list. |
Namespace.addOnPurchase
AddOnPurchase associated with the namespace.
Returns AddOnPurchase
.
Arguments
Name | Type | Description |
---|---|---|
addOnName
| String!
| AddOn name. |
Namespace.complianceFrameworks
Compliance frameworks available to projects in this namespace.
Returns ComplianceFrameworkConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
| ComplianceManagementFrameworkID
| Global ID of a specific compliance framework to return. |
ids
| [ComplianceManagementFrameworkID!]
| List of Global IDs of compliance frameworks to return. |
search
| String
| Search framework with most similar names. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
complianceFrameworkFilters
| ComplianceFrameworkFilters
| Filters applied when selecting a compliance framework. |
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. |
notAimedForDeletion
| Boolean
| Include projects that are not aimed for deletion. |
sbomComponentId
| ID
| Return only the projects related to the specified SBOM component. |
search
| String
| Search project with most similar names or paths. |
sort
| NamespaceProjectSort
| Sort projects by this criteria. |
withIssuesEnabled
| Boolean
| Return only projects with issues enabled. |
withMergeRequestsEnabled
| Boolean
| Return only projects with merge requests enabled. |
Namespace.scanExecutionPolicies
Scan Execution Policies of the namespace.
Returns ScanExecutionPolicyConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actionScanTypes
| [SecurityReportTypeEnum!]
| Filters policies by the action scan type. Only these scan types are supported: dast , secret_detection , cluster_image_scanning , container_scanning , sast , sast_iac , dependency_scanning .
|
relationship
| SecurityPolicyRelationType
| Filter policies by the given policy relationship. |
Namespace.scanResultPolicies
Scan Result Policies of the project.
Returns ScanResultPolicyConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
relationship
| SecurityPolicyRelationType
| Filter policies by the given policy relationship. |
NamespaceBan
Fields
Name | Type | Description |
---|---|---|
id
| GlobalID!
| Global ID of the namespace ban. |
namespace
| Namespace!
| Root namespace to which the ban applies. |
user
| UserCore!
| User to which the namespace ban applies. |
NamespaceCiCdSetting
Fields
Name | Type | Description |
---|---|---|
allowStaleRunnerPruning
| Boolean
| Indicates if stale runners directly belonging to this namespace should be periodically pruned. |
namespace
| Namespace
| Namespace the CI/CD settings belong to. |
NamespaceCommitEmail
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Timestamp the namespace commit email was created. |
email
| Email!
| Email. |
id
| ID!
| Internal ID of the namespace commit email. |
namespace
| Namespace!
| Namespace. |
updatedAt
| Time!
| Timestamp the namespace commit email was last updated. |
NestedEnvironment
Describes where code is deployed for a project organized by folder.
Fields
Name | Type | Description |
---|---|---|
environment
| Environment
| Latest environment in the folder. |
name
| String!
| Human-readable name of the environment. |
size
| Int!
| Number of environments nested in the folder. |
NetworkPolicy
Represents the network policy.
Fields
Name | Type | Description |
---|---|---|
enabled
| Boolean!
| Indicates whether this policy is enabled. |
environments
| EnvironmentConnection
| Environments where this policy is applied. (see Connections) |
fromAutoDevops
| Boolean!
| Indicates whether this policy is created from AutoDevops. |
kind
| NetworkPolicyKind!
| Kind of the policy. |
name
| String!
| Name of the policy. |
namespace
| String!
| Namespace of the policy. |
updatedAt
| Time!
| Timestamp of when the policy YAML was last updated. |
yaml
| String!
| YAML definition of the policy. |
Note
Fields
Name | Type | Description |
---|---|---|
author
| UserCore!
| User who wrote this note. |
authorIsContributor
| Boolean
| Indicates whether the note author is a contributor. |
awardEmoji
| AwardEmojiConnection
| List of emoji reactions associated with the note. (see Connections) |
body
| String!
| Content of the note. |
bodyHtml
| String
| GitLab Flavored Markdown rendering of note .
|
confidential | Boolean
|
Deprecated in 15.5. This was renamed. Use: internal .
|
createdAt
| Time!
| Timestamp of the note creation. |
discussion
| Discussion
| Discussion this note is a part of. |
id
| NoteID!
| ID of the note. |
internal
| Boolean
| Indicates if this note is internal. |
lastEditedAt
| Time
| Timestamp when note was last edited. |
lastEditedBy
| UserCore
| User who last edited the note. |
maxAccessLevelOfAuthor
| String
| Max access level of the note author in the project. |
position
| DiffPosition
| 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. |
systemNoteMetadata
| SystemNoteMetadata
| Metadata for the given note if it is 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!
| If true , the user can perform admin_note on this resource.
|
awardEmoji
| Boolean!
| If true , the user can perform award_emoji on this resource.
|
createNote
| Boolean!
| If true , the user can perform create_note on this resource.
|
readNote
| Boolean!
| If true , the user can perform read_note on this resource.
|
repositionNote
| Boolean!
| If true , the user can perform reposition_note on this resource.
|
resolveNote
| Boolean!
| If true , the user can perform resolve_note on this resource.
|
NugetDependencyLinkMetadata
Nuget dependency link metadata.
Fields
Name | Type | Description |
---|---|---|
id
| PackagesNugetDependencyLinkMetadatumID!
| ID of the metadatum. |
targetFramework
| String!
| Target framework of the dependency link package. |
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
| Color palette to assign to the on-call user. For example “blue”. |
colorWeight
| String
| 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!
| User who is participating. |
OncallRotationActivePeriodType
Active period time range for on-call rotation.
Fields
Name | Type | Description |
---|---|---|
endTime
| String
| End of the rotation active period. |
startTime
| String
| Start of the rotation active period. |
Organization
Fields
Name | Type | Description |
---|---|---|
avatarUrl | String
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Avatar URL of the organization. |
description | String
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Description of the organization. |
descriptionHtml | String
|
Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. GitLab Flavored Markdown rendering of description .
|
id | ID!
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. ID of the organization. |
name | String!
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Name of the organization. |
organizationUsers | OrganizationUserConnection!
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Users with access to the organization. |
path | String!
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Path of the organization. |
webUrl | String!
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Web URL of the organization. |
Fields with arguments
Organization.groups
Groups within this organization that the user has access to.
Returns GroupConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search | String
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Search query for group name or full path. |
sort | OrganizationGroupSort
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Criteria to sort organization groups by. |
OrganizationStateCounts
Represents the total number of organizations for the represented states.
Fields
Name | Type | Description |
---|---|---|
active
| Int
| Number of organizations with state ACTIVE .
|
all
| Int
| Number of organizations with state ALL .
|
inactive
| Int
| Number of organizations with state INACTIVE .
|
OrganizationUser
A user with access to the organization.
Fields
Name | Type | Description |
---|---|---|
badges | [OrganizationUserBadge!]
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. Badges describing the user within the organization. |
id | ID!
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. ID of the organization user. |
user | UserCore!
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. User that is associated with the organization. |
OrganizationUserBadge
An organization user badge.
Fields
Name | Type | Description |
---|---|---|
text
| String!
| Badge text. |
variant
| String!
| Badge variant. |
Package
Represents a package with pipelines in the Package Registry.
Fields
Name | Type | Description |
---|---|---|
_links
| PackageLinks!
| Map of links to perform actions on the package. |
canDestroy | Boolean!
|
Deprecated in 16.6. Superseded by user_permissions field. See Types::PermissionTypes::Package type.
|
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. Max page size 20. (see Connections) |
project
| Project!
| Project where the package is stored. |
status
| PackageStatus!
| Package status. |
statusMessage
| String
| Status message. |
tags
| PackageTagConnection
| Package tags. (see Connections) |
updatedAt
| Time!
| Date of most recent update. |
userPermissions
| PackagePermissions!
| Permissions for the current user on the resource. |
version
| String
| Version string. |
PackageBase
Represents a package in the Package Registry.
Fields
Name | Type | Description |
---|---|---|
_links
| PackageLinks!
| Map of links to perform actions on the package. |
canDestroy | Boolean!
|
Deprecated in 16.6. Superseded by user_permissions field. See Types::PermissionTypes::Package type.
|
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. |
project
| Project!
| Project where the package is stored. |
status
| PackageStatus!
| Package status. |
statusMessage
| String
| Status message. |
tags
| PackageTagConnection
| Package tags. (see Connections) |
updatedAt
| Time!
| Date of most recent update. |
userPermissions
| PackagePermissions!
| Permissions for the current user on the resource. |
version
| String
| Version string. |
PackageComposerJsonType
Represents a composer JSON file.
Fields
Name | Type | Description |
---|---|---|
license
| String
| License set in the Composer JSON file. |
name
| String
| Name set in the Composer JSON file. |
type
| String
| Type set in the Composer JSON file. |
version
| String
| Version set in the Composer JSON file. |
PackageDependency
Represents a package dependency.
Fields
Name | Type | Description |
---|---|---|
id
| PackagesDependencyID!
| ID of the dependency. |
name
| String!
| Name of the dependency. |
versionPattern
| String!
| Version pattern of the dependency. |
PackageDependencyLink
Represents a package dependency link.
Fields
Name | Type | Description |
---|---|---|
dependency
| PackageDependency
| Dependency. |
dependencyType
| PackageDependencyType!
| Dependency type. |
id
| PackagesDependencyLinkID!
| ID of the dependency link. |
metadata
| DependencyLinkMetadata
| Dependency link metadata. |
PackageDetailsType
Represents a package details in the Package Registry.
Fields
Name | Type | Description |
---|---|---|
_links
| PackageLinks!
| Map of links to perform actions on the package. |
canDestroy | Boolean!
|
Deprecated in 16.6. Superseded by user_permissions field. See Types::PermissionTypes::Package type.
|
composerConfigRepositoryUrl
| String
| Url of the Composer setup endpoint. |
composerUrl
| String
| Url of the Composer endpoint. |
conanUrl
| String
| Url of the Conan project endpoint. |
createdAt
| Time!
| Date of creation. |
dependencyLinks
| PackageDependencyLinkConnection
| Dependency link. (see Connections) |
id
| PackagesPackageID!
| ID of the package. |
lastDownloadedAt
| Time
| Last time that a file of this package was downloaded. |
mavenUrl
| String
| Url of the Maven project endpoint. |
metadata
| PackageMetadata
| Package metadata. |
name
| String!
| Name of the package. |
npmUrl
| String
| Url of the NPM project endpoint. |
nugetUrl
| String
| Url of the Nuget project endpoint. |
packageFiles
| PackageFileConnection
| Package files. (see Connections) |
packageType
| PackageTypeEnum!
| Package type. |
pipelines
| PipelineConnection
| Pipelines that built the package. Max page size 20. (see Connections) |
project
| Project!
| Project where the package is stored. |
publicPackage
| Boolean
| Indicates if there is public access to the package. |
pypiSetupUrl
| String
| Url of the PyPi project setup endpoint. |
pypiUrl
| String
| Url of the PyPi project endpoint. |
status
| PackageStatus!
| Package status. |
statusMessage
| String
| Status message. |
tags
| PackageTagConnection
| Package tags. (see Connections) |
updatedAt
| Time!
| Date of most recent update. |
userPermissions
| PackagePermissions!
| Permissions for the current user on the resource. |
version
| String
| Version string. |
versions
| PackageBaseConnection
| Other versions of the package. (see Connections) |
PackageFile
Represents a package file.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| 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!
| 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 is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the PackageFileRegistry. |
state
| RegistryState
| Sync state of the PackageFileRegistry. |
verificationChecksum
| String
| The local checksum of the PackageFileRegistry. |
verificationFailure
| String
| Error message during verification of the PackageFileRegistry. |
verificationRetryAt
| Time
| Timestamp after which the PackageFileRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the PackageFileRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of PackageFileRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the PackageFileRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the PackageFileRegistry. |
PackageHelmDependencyType
Represents a Helm dependency.
Fields
Name | Type | Description |
---|---|---|
alias
| String
| Alias of the dependency. |
condition
| String
| Condition of the dependency. |
enabled
| Boolean
| Indicates the dependency is enabled. |
importValues
| [JSON!]
| Import-values of the dependency. |
name
| String
| Name of the dependency. |
repository
| String
| Repository of the dependency. |
tags
| [String!]
| Tags of the dependency. |
version
| String
| Version of the dependency. |
PackageHelmMaintainerType
Represents a Helm maintainer.
Fields
Name | Type | Description |
---|---|---|
email
| String
| Email of the maintainer. |
name
| String
| Name of the maintainer. |
url
| String
| URL of the maintainer. |
PackageHelmMetadataType
Represents the contents of a Helm Chart.yml file.
Fields
Name | Type | Description |
---|---|---|
annotations
| JSON
| Annotations for the chart. |
apiVersion
| String!
| API version of the chart. |
appVersion
| String
| App version of the chart. |
condition
| String
| Condition for the chart. |
dependencies
| [PackageHelmDependencyType!]
| Dependencies of the chart. |
deprecated
| Boolean
| Indicates if the chart is deprecated. |
description
| String
| Description of the chart. |
home
| String
| URL of the home page. |
icon
| String
| URL to an SVG or PNG image for the chart. |
keywords
| [String!]
| Keywords for the chart. |
kubeVersion
| String
| Kubernetes versions for the chart. |
maintainers
| [PackageHelmMaintainerType!]
| Maintainers of the chart. |
name
| String!
| Name of the chart. |
sources
| [String!]
| URLs of the source code for the chart. |
tags
| String
| Tags for the chart. |
type
| String
| Type of the chart. |
version
| String!
| Version of the chart. |
PackageLinks
Represents links to perform actions on the package.
Fields
Name | Type | Description |
---|---|---|
webPath
| String
| Path to the package details page. |
PackagePermissions
Fields
Name | Type | Description |
---|---|---|
destroyPackage
| Boolean!
| If true , the user can perform destroy_package on this resource.
|
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. |
lockMavenPackageRequestsForwarding
| Boolean!
| Indicates whether Maven package forwarding is locked for all descendent namespaces. |
lockNpmPackageRequestsForwarding
| Boolean!
| Indicates whether npm package forwarding is locked for all descendent namespaces. |
lockPypiPackageRequestsForwarding
| Boolean!
| Indicates whether PyPI package forwarding is locked for all descendent namespaces. |
mavenDuplicateExceptionRegex
| 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. |
mavenPackageRequestsForwarding
| Boolean
| Indicates whether Maven package forwarding is allowed for this namespace. |
mavenPackageRequestsForwardingLocked
| Boolean!
| Indicates whether Maven package forwarding settings are locked by a parent namespace. |
npmPackageRequestsForwarding
| Boolean
| Indicates whether npm package forwarding is allowed for this namespace. |
npmPackageRequestsForwardingLocked
| Boolean!
| Indicates whether npm package forwarding settings are locked by a parent namespace. |
nugetDuplicateExceptionRegex
| UntrustedRegexp
| When nuget_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
nugetDuplicatesAllowed
| Boolean!
| Indicates whether duplicate NuGet packages are allowed for this namespace. |
nugetSymbolServerEnabled
| Boolean!
| Indicates wheather the NuGet symbol server is enabled for this namespace. |
pypiPackageRequestsForwarding
| Boolean
| Indicates whether PyPI package forwarding is allowed for this namespace. |
pypiPackageRequestsForwardingLocked
| Boolean!
| Indicates whether PyPI package forwarding settings are locked by a parent namespace. |
PackageTag
Represents a package tag.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time!
| Created date. |
id
| ID!
| ID of the tag. |
name
| String!
| Name of the tag. |
updatedAt
| Time!
| Updated date. |
PackagesCleanupPolicy
A packages cleanup policy designed to keep only packages and packages assets that matter most.
Fields
Name | Type | Description |
---|---|---|
keepNDuplicatedPackageFiles
| PackagesCleanupKeepDuplicatedPackageFilesEnum!
| Number of duplicated package files to retain. |
nextRunAt
| Time
| Next time that this packages cleanup policy will be executed. |
PackagesProtectionRule
A packages protection rule designed to protect packages from being pushed by users with a certain access level.
Fields
Name | Type | Description |
---|---|---|
id
| PackagesProtectionRuleID!
| ID of the package protection rule. |
packageNamePattern
| String!
| Package name protected by the protection rule. For example @my-scope/my-package-* . Wildcard character * allowed.
|
packageType
| PackagesProtectionRulePackageType!
| Package type protected by the protection rule. For example NPM .
|
pushProtectedUpToAccessLevel
| PackagesProtectionRuleAccessLevel!
| Max GitLab access level unable to push a package. For example DEVELOPER , MAINTAINER , OWNER .
|
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. |
PagesDeploymentRegistry
Represents the Geo replication and verification state of a pages_deployment.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the PagesDeploymentRegistry was created. |
id
| ID!
| ID of the PagesDeploymentRegistry. |
lastSyncFailure
| String
| Error message during sync of the PagesDeploymentRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the PagesDeploymentRegistry. |
pagesDeploymentId
| ID!
| ID of the Pages Deployment. |
retryAt
| Time
| Timestamp after which the PagesDeploymentRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the PagesDeploymentRegistry. |
state
| RegistryState
| Sync state of the PagesDeploymentRegistry. |
verificationChecksum
| String
| The local checksum of the PagesDeploymentRegistry. |
verificationFailure
| String
| Error message during verification of the PagesDeploymentRegistry. |
verificationRetryAt
| Time
| Timestamp after which the PagesDeploymentRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the PagesDeploymentRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of PagesDeploymentRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the PagesDeploymentRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the PagesDeploymentRegistry. |
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
| Locked path. |
user
| UserCore
| User that has locked this path. |
PendingGroupMember
Represents a Pending Group Membership.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| AccessLevel
| GitLab::Access level. |
approved
| Boolean
| Whether the pending group member has been approved. |
avatarUrl
| String
| URL to avatar image file of the pending group member. |
createdAt
| Time
| Date and time the membership was created. |
createdBy
| UserCore
| User that authorized membership. |
email
| String
| Public email of the pending group member. |
expiresAt
| Time
| Date and time the membership expires. |
group
| Group
| Group that a user is a member of. |
id
| ID!
| ID of the member. |
invited
| Boolean
| Whether the pending group member has been invited. |
name
| String
| Name of the pending group member. |
notificationEmail
| String
| Group notification email for user. Only available for admins. |
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. |
username
| String
| Username of the pending group member. |
webUrl
| String
| Web URL of the pending group member. |
Fields with arguments
PendingGroupMember.mergeRequestInteraction
Find a merge request.
Returns UserMergeRequestInteraction
.
Arguments
Name | Type | Description |
---|---|---|
id
| MergeRequestID!
| Global ID of the merge request. |
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. |
child
| Boolean!
| If the pipeline is a child or not. |
codeQualityReportSummary
| CodeQualityReportSummary
| Code Quality report summary for a pipeline. |
codeQualityReports
| CodeQualityDegradationConnection
| Code Quality degradations reported on the pipeline. (see Connections) |
commit
| Commit
| Git commit of the pipeline. |
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. |
computeMinutes
| Float
| Total minutes consumed by the pipeline. |
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, SECURITY_POLICIES_DEFAULT_SOURCE). |
coverage
| Float
| Coverage percentage. |
createdAt
| Time!
| Timestamp of the pipeline’s creation. |
dastProfile
| DastProfile
| DAST profile associated with the pipeline. |
detailedStatus
| DetailedStatus!
| Detailed status of the pipeline. |
downstream
| PipelineConnection
| Pipelines this pipeline will trigger. (see Connections) |
duration
| Int
| Duration of the pipeline in seconds. |
failureReason
| String
| The reason why the pipeline failed. |
finishedAt
| Time
| Timestamp of the pipeline’s completion. |
id
| ID!
| ID of the pipeline. |
iid
| String!
| Internal ID of the pipeline. |
jobArtifacts
| [CiJobArtifact!]
| Job artifacts of the pipeline. |
latest
| Boolean!
| If the pipeline is the latest one or not. |
mergeRequest
| MergeRequest
| The MR which the Pipeline is attached to. |
mergeRequestEventType
| PipelineMergeRequestEventType
| Event type of the pipeline associated with a merge request. |
name
| String
| Name 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. |
ref
| String
| Reference to the branch from which the pipeline was triggered. |
refPath
| String
| Reference path to the branch from which the pipeline was triggered. |
refText
| String!
| The reference text from the presenter. |
retryable
| Boolean!
| Specifies if a pipeline can be retried. |
securityReportSummary
| SecurityReportSummary
| Vulnerability and scanned resource counts for each security scanner of the pipeline. |
source
| String
| The source of the pipeline. |
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, WAITING_FOR_CALLBACK, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED). |
stuck
| Boolean!
| If the pipeline is stuck. |
testReportSummary
| TestReportSummary!
| Summary of the test report generated by the pipeline. |
totalJobs
| Int!
| The total number of jobs in the pipeline. |
triggeredByPath
| String
| The path that triggered this 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.
|
warningMessages
| [PipelineMessage!]
| Pipeline warning messages. |
warnings
| Boolean!
| Indicates if a pipeline has warnings. |
Fields with arguments
Pipeline.job
Specific job in this pipeline, either by name or ID.
Returns CiJob
.
Arguments
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
jobKind
| CiJobKind
| Filter jobs by kind. |
retried
| Boolean
| Filter jobs by retry-status. |
securityReportTypes
| [SecurityReportTypeEnum!]
| Filter jobs by the type of security report they produce. |
statuses
| [CiJobStatus!]
| Filter jobs by status. |
whenExecuted
| [String!]
| Filter jobs by when they are executed. |
Pipeline.securityReportFinding
Vulnerability finding reported on the pipeline.
Returns PipelineSecurityReportFinding
.
Arguments
Name | Type | Description |
---|---|---|
uuid
| String!
| UUID of the security report finding. |
Pipeline.securityReportFindings
Vulnerability findings reported on the pipeline.
Returns PipelineSecurityReportFindingConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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. |
state
| [VulnerabilityState!]
| Filter vulnerability findings by state. |
Pipeline.sha
SHA of the pipeline’s commit.
Returns String
.
Arguments
Name | Type | Description |
---|---|---|
format
| ShaFormat
| Format of the SHA. |
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 is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the PipelineArtifactRegistry. |
state
| RegistryState
| Sync state of the PipelineArtifactRegistry. |
verificationChecksum
| String
| The local checksum of the PipelineArtifactRegistry. |
verificationFailure
| String
| Error message during verification of the PipelineArtifactRegistry. |
verificationRetryAt
| Time
| Timestamp after which the PipelineArtifactRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the PipelineArtifactRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of PipelineArtifactRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the PipelineArtifactRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the PipelineArtifactRegistry. |
PipelineCounts
Represents pipeline counts for the project.
Fields
Name | Type | Description |
---|---|---|
all
| Int
| Total number of pipelines for the project. |
finished
| Int
| Number of pipelines with scope FINISHED for the project. |
pending
| Int
| Number of pipelines with scope PENDING for the project. |
running
| Int
| Number of pipelines with scope RUNNING for the project. |
PipelineMessage
Fields
Name | Type | Description |
---|---|---|
content
| String!
| Content of the pipeline message. |
id
| ID!
| ID of the pipeline message. |
PipelinePermissions
Fields
Name | Type | Description |
---|---|---|
adminPipeline
| Boolean!
| If true , the user can perform admin_pipeline on this resource.
|
cancelPipeline
| Boolean!
| If true , the user can perform cancel_pipeline on this resource.
|
destroyPipeline
| Boolean!
| If true , the user can perform destroy_pipeline on this resource.
|
updatePipeline
| Boolean!
| If true , the user can perform update_pipeline on this resource.
|
PipelineSchedule
Represents a pipeline schedule.
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| Indicates if the pipeline schedule is active. |
createdAt
| Time!
| Timestamp of when the pipeline schedule was created. |
cron
| String!
| Cron notation for the schedule. |
cronTimezone
| String!
| Timezone for the pipeline schedule. |
description
| String
| Description of the pipeline schedule. |
editPath
| String
| Edit path of the pipeline schedule. |
forTag
| Boolean!
| Indicates if a pipelines schedule belongs to a tag. |
id
| ID!
| ID of the pipeline schedule. |
lastPipeline
| Pipeline
| Last pipeline object. |
nextRunAt
| Time!
| Time when the next pipeline will run. |
owner
| UserCore
| Owner of the pipeline schedule. |
project
| Project
| Project of the pipeline schedule. |
realNextRun
| Time!
| Time when the next pipeline will run. |
ref
| String
| Ref of the pipeline schedule. |
refForDisplay
| String
| Git ref for the pipeline schedule. |
refPath
| String
| Path to the ref that triggered the pipeline. |
updatedAt
| Time!
| Timestamp of when the pipeline schedule was last updated. |
userPermissions
| PipelineSchedulePermissions!
| Permissions for the current user on the resource. |
variables
| PipelineScheduleVariableConnection
| Pipeline schedule variables. (see Connections) |
PipelineSchedulePermissions
Fields
Name | Type | Description |
---|---|---|
adminPipelineSchedule
| Boolean!
| If true , the user can perform admin_pipeline_schedule on this resource.
|
playPipelineSchedule
| Boolean!
| If true , the user can perform play_pipeline_schedule on this resource.
|
takeOwnershipPipelineSchedule | Boolean!
| Deprecated in 15.9. Use admin_pipeline_schedule permission to determine if the user can take ownership of a pipeline schedule. |
updatePipelineSchedule
| Boolean!
| If true , the user can perform update_pipeline_schedule on this resource.
|
PipelineScheduleVariable
Fields
Name | Type | Description |
---|---|---|
id
| ID!
| ID of the variable. |
key
| String
| Name of the variable. |
raw
| Boolean
| Indicates whether the variable is raw. |
value
| String
| Value of the variable. |
variableType
| CiVariableType
| Type of the variable. |
PipelineSecurityReportFinding
Represents vulnerability finding of a security report on the pipeline.
Fields
Name | Type | Description |
---|---|---|
assets
| [AssetType!]
| List of assets associated with the vulnerability. |
description
| String
| Description of the vulnerability finding. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
details
| [VulnerabilityDetail!]!
| Details of the security finding. |
dismissalReason
| VulnerabilityDismissalReason
| Reason for the dismissal of the security report finding. |
dismissedAt
| Time
| Time of the dismissal of the security report finding. |
dismissedBy
| UserCore
| User who dismissed the security report finding. |
evidence
| VulnerabilityEvidence
| Evidence for the vulnerability. |
falsePositive
| Boolean
| Indicates whether the vulnerability is a false positive. |
identifiers
| [VulnerabilityIdentifier!]!
| Identifiers of the vulnerability finding. |
issueLinks
| VulnerabilityIssueLinkConnection
| List of issue links related to the vulnerability. (see Connections) |
links
| [VulnerabilityLink!]
| List of links associated with 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. |
project
| Project
| Project on which the vulnerability finding was found. |
projectFingerprint | String
| Deprecated in 16.1. Use uuid instead. |
remediations
| [VulnerabilityRemediationType!]
| Remediations of the security report finding. |
reportType
| 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
| Solution for resolving the security report finding. |
state
| VulnerabilityState
| Finding status. |
stateComment
| String
| Comment for the state of the security report finding. |
title
| String
| Title of the vulnerability finding. |
uuid
| String
| UUIDv5 digest based on the vulnerability’s report type, primary identifier, location, fingerprint, project identifier. |
vulnerability
| Vulnerability
| Vulnerability related to the security report finding. |
PipelineTrigger
Fields
Name | Type | Description |
---|---|---|
canAccessProject
| Boolean!
| Indicates if the pipeline trigger token has access to the project. |
description
| String
| Description of the pipeline trigger token. |
hasTokenExposed
| Boolean!
| Indicates if the token is exposed. |
id
| ID!
| ID of the pipeline trigger token. |
lastUsed
| Time
| Timestamp of the last usage of the pipeline trigger token. |
owner
| UserCore!
| Owner of the pipeline trigger token. |
token
| String!
| Value of the pipeline trigger token. |
PolicyApprovalGroup
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| Avatar URL of the group. |
fullPath
| ID!
| Full path of the namespace. |
id
| ID!
| ID of the namespace. |
webUrl
| String!
| Web URL of the group. |
PreviewBillableUserChange
Fields
Name | Type | Description |
---|---|---|
newBillableUserCount
| Int
| Total number of billable users after change. |
seatsInSubscription
| Int
| Number of seats in subscription. |
willIncreaseOverage
| Boolean
| If the group will have an increased overage after change. |
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. |
branchRules
| BranchRuleConnection
| Branch rules configured for the project. (see Connections) |
ciAccessAuthorizedAgents
| ClusterAgentAuthorizationCiAccessConnection
| Authorized cluster agents for the project through ci_access keyword. (see Connections) |
ciCdSettings
| ProjectCiCdSetting
| CI/CD settings for the project. |
ciConfigPathOrDefault
| String!
| Path of the CI configuration file. |
ciJobTokenScope
| CiJobTokenScopeType
| The CI Job Tokens scope of access. |
ciSubscribedProjects
| CiSubscriptionsProjectConnection
| Triggers a new pipeline in the downstream project when a pipeline successfullycompletes on the(upstream) project. (see Connections) |
ciSubscriptionsProjects
| CiSubscriptionsProjectConnection
| Triggers a new pipeline in the(downstream) project when a pipeline successfullycompletes on the upstream project. (see Connections) |
codeCoverageSummary
| CodeCoverageSummary
| Code coverage summary associated with the project. |
complianceFrameworks
| ComplianceFrameworkConnection
| Compliance frameworks associated with the project. (see Connections) |
containerExpirationPolicy
| ContainerExpirationPolicy
| Container expiration policy of the project. |
containerRegistryEnabled
| Boolean
| Indicates if Container Registry is enabled for the current user. |
containerRepositoriesCount
| Int!
| Number of container repositories in the project. |
corpuses
| CoverageFuzzingCorpusConnection
| Find corpuses of the project. (see Connections) |
createdAt
| Time
| Timestamp of the project creation. |
dastScannerProfiles
| DastScannerProfileConnection
| DAST scanner profiles associated with the project. (see Connections) |
dastSiteProfiles
| DastSiteProfileConnection
| DAST Site Profiles associated with the project. (see Connections) |
dependencyProxyPackagesSetting | DependencyProxyPackagesSetting
|
Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Packages Dependency Proxy settings for the project. Requires the packages and dependency proxy to be enabled in the config. Requires the packages feature to be enabled at the project level. Returns null if packages_dependency_proxy_maven feature flag is disabled.
|
description
| String
| Short description of the project. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
detailedImportStatus
| DetailedImportStatus
| Detailed import status of the project. |
dora
| Dora
| Project’s DORA metrics. |
flowMetrics | ProjectValueStreamAnalyticsFlowMetrics
| Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Flow metrics for value stream analytics. |
forkingAccessLevel
| ProjectFeatureAccess
| Access level required for forking access. |
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. |
hasJiraVulnerabilityIssueCreationEnabled
| Boolean!
| Indicates whether Jira issue creation from vulnerabilities is enabled. |
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. |
incidentManagementTimelineEventTags
| [TimelineEventTagType!]
| Timeline event tags for the project. |
isCatalogResource | Boolean
| Introduced in 15.11. This feature is an Experiment. It can be changed or removed at any time. Indicates if a project is a catalog resource. |
issuesAccessLevel
| ProjectFeatureAccess
| Access level required for issues access. |
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. |
languages
| [RepositoryLanguage!]
| Programming languages used in the project. |
lastActivityAt
| Time
| Timestamp of the project last activity. |
lfsEnabled
| Boolean
| Indicates if the project has Large File Storage (LFS) enabled. |
mergeCommitTemplate
| String
| Template used to create merge commit message in merge requests. |
mergeRequestsAccessLevel
| ProjectFeatureAccess
| Access level required for merge requests access. |
mergeRequestsDisableCommittersApproval
| Boolean!
| Indicates that committers of the given merge request cannot approve. |
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. |
onlyAllowMergeIfAllStatusChecksPassed
| Boolean
| Indicates that merges of merge requests should be blocked unless all status checks have passed. |
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. |
openMergeRequestsCount
| Int
| Number of open merge requests for the project. |
packagesCleanupPolicy
| PackagesCleanupPolicy
| Packages cleanup policy for the project. |
packagesProtectionRules
| PackagesProtectionRuleConnection
| Packages protection rules for the project. (see Connections) |
path
| String!
| Path of the project. |
pathLocks
| PathLockConnection
| The project’s path locks. (see Connections) |
pipelineAnalytics
| PipelineAnalytics
| Pipeline analytics. |
pipelineTriggers | PipelineTriggerConnection
| Introduced in 16.3. This feature is an Experiment. It can be changed or removed at any time. List of pipeline trigger tokens. |
preventMergeWithoutJiraIssueEnabled
| Boolean!
| Indicates if an associated issue from Jira is required. |
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. |
productAnalyticsInstrumentationKey | String
| Introduced in 16.0. This feature is an Experiment. It can be changed or removed at any time. Product Analytics instrumentation key assigned to the project. |
productAnalyticsState | ProductAnalyticsState
| Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Current state of the product analytics stack for this project.Can only be called for one project in a single request. |
publicJobs
| Boolean
| Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. |
pushRules
| PushRules
| Project’s push rules settings. |
recentIssueBoards
| BoardConnection
| List of recently visited boards of the project. Maximum size is 4. (see Connections) |
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. |
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. |
squashCommitTemplate
| String
| Template used to create squash commit message in merge requests. |
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. |
statisticsDetailsPaths
| ProjectStatisticsRedirect
| Redirects for Statistics of the project. |
suggestionCommitMessage
| String
| 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) |
timelogCategories | TimeTrackingTimelogCategoryConnection
| Introduced in 15.3. This feature is an Experiment. It can be changed or removed at any time. Timelog categories for the project. |
topics
| [String!]
| List of project topics. |
trackingKey | String
| Introduced in 16.0. This feature is an Experiment. It can be changed or removed at any time. Tracking key assigned to the project. |
userAccessAuthorizedAgents
| ClusterAgentAuthorizationUserAccessConnection
| Authorized cluster agents for the project through user_access keyword. (see Connections) |
userPermissions
| ProjectPermissions!
| Permissions for the current user on the resource. |
valueStreams
| ValueStreamConnection
| Value streams available to the project. (see Connections) |
visibility
| String
| Visibility of the project. |
vulnerabilityImages
| VulnerabilityContainerImageConnection
| Container images reported on the project vulnerabilities. (see Connections) |
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
, and 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
, and 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
, and 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.autocompleteUsers
Search users for autocompletion.
Returns [AutocompletedUser!]
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Query to search users by name, username, or public email. |
Project.board
A single board of the project.
Returns Board
.
Arguments
Name | Type | Description |
---|---|---|
id
| BoardID!
| ID of the board. |
Project.boards
Boards of the project.
Returns BoardConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
| BoardID
| Find a board by its ID. |
Project.ciConfigVariables
CI/CD config variable.
Returns [CiConfigVariable!]
.
Arguments
Name | Type | Description |
---|---|---|
ref
| String!
| Ref. |
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. Template must be formatted as Name.gitlab-ci.yml .
|
Project.ciVariables
List of the project’s CI/CD variables.
Returns CiProjectVariableConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
sort
| CiVariableSort
| Sort order of results. |
Project.clusterAgent
Find a single cluster agent by name.
Returns ClusterAgent
.
Arguments
Name | Type | Description |
---|---|---|
hasRemoteDevelopmentAgentConfig
| Boolean
| Returns only cluster agents which have an associated remote development agent config. |
hasRemoteDevelopmentEnabled
| Boolean
| Returns only cluster agents which have been enabled with the remote development feature. |
hasVulnerabilities
| Boolean
| Returns only cluster agents which have vulnerabilities. |
name
| String!
| Name of the cluster agent. |
Project.clusterAgents
Cluster agents associated with the project.
Returns ClusterAgentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
hasRemoteDevelopmentAgentConfig
| Boolean
| Returns only cluster agents which have an associated remote development agent config. |
hasRemoteDevelopmentEnabled
| Boolean
| Returns only cluster agents which have been enabled with the remote development feature. |
hasVulnerabilities
| Boolean
| Returns only cluster agents which have vulnerabilities. |
Project.commitReferences
Get tag names containing a given commit.
Returns CommitReferences
.
Arguments
Name | Type | Description |
---|---|---|
commitSha
| String!
| Project commit SHA identifier. For example, 287774414568010855642518513f085491644061 .
|
Project.containerRepositories
Container repositories of the project.
Returns ContainerRepositoryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| Filter the container repositories by their name. |
sort
| ContainerRepositorySort
| Sort container repositories by this criteria. |
Project.customizableDashboardVisualizations
Visualizations of the project or associated configuration project.
Returns CustomizableDashboardVisualizationConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
slug
| String
| Slug of the visualization to return. |
Project.customizableDashboards
Customizable dashboards for the project.
Returns CustomizableDashboardConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
category
| CustomizableDashboardCategory
| Find by dashboard type. |
slug
| String
| Find by dashboard slug. |
Project.dastProfile
DAST Profile associated with the project.
Returns DastProfile
.
Arguments
Name | Type | Description |
---|---|---|
hasDastProfileSchedule
| Boolean
| Filter DAST Profiles by whether or not they have a schedule. |
id
| DastProfileID!
| ID of the DAST Profile. |
Project.dastProfiles
DAST Profiles associated with the project.
Returns DastProfileConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
hasDastProfileSchedule
| Boolean
| Filter DAST Profiles by whether or not they have a schedule. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
normalizedTargetUrls
| [String!]
| Normalized URL of the target to be scanned. |
status
| DastSiteValidationStatusEnum
| Status of the site validation. |
Project.dataTransfer
Data transfer data point for a specific period. This is mocked data under a development feature flag.
Returns ProjectDataTransfer
.
Arguments
Name | Type | Description |
---|---|---|
from
| Date
| Retain egress data for one year. Data for the current month will increase dynamically as egress occurs. |
to
| Date
| End date for the data. |
Project.dependencies
Software dependencies used by the project.
Returns DependencyConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
componentNames
| [String!]
| Filter dependencies by component names. |
packageManagers
| [PackageManager!]
| Filter dependencies by package managers. |
sort
| DependencySort
| Sort dependencies by given criteria. |
Project.deployment
Details of the deployment of the project.
Returns Deployment
.
Arguments
Name | Type | Description |
---|---|---|
iid
| ID!
| Project-level internal ID of the Deployment. |
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. |
type
| String
| Search query for environment type. |
Project.environments
Environments of the project. This field can only be resolved for one project in any single request.
Returns EnvironmentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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. |
type
| String
| Search query for environment type. |
Project.forkDetails
Details of the fork project compared to its upstream project.
Returns ForkDetails
.
Arguments
Name | Type | Description |
---|---|---|
ref
| String
| Ref of the fork. Default value is HEAD. |
Project.forkTargets
Namespaces in which the current user can fork the project into.
Returns NamespaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query for path or name. |
Project.gitlabSubscriptionsPreviewBillableUserChange
Preview Billable User Changes.
Returns PreviewBillableUserChange
.
Arguments
Name | Type | Description |
---|---|---|
addGroupId
| Int
| Group ID to add. |
addUserEmails
| [String!]
| User emails to add. |
addUserIds
| [Int!]
| User IDs to add. |
memberRoleId
| Int
| Custom role assigned to the users. |
role
| GitlabSubscriptionsUserRole!
| Role of users being added to group. |
Project.incidentManagementEscalationPolicies
Incident Management escalation policies of the project.
Returns EscalationPolicyTypeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
name
| String
| Fuzzy search by escalation policy name. |
Project.incidentManagementEscalationPolicy
Incident Management escalation policy of the project.
Returns EscalationPolicyType
.
Arguments
Name | Type | Description |
---|---|---|
id
| IncidentManagementEscalationPolicyID!
| ID of the escalation policy. |
name
| String
| Fuzzy search by escalation policy name. |
Project.incidentManagementOncallSchedules
Incident Management On-call schedules of the project.
Returns IncidentManagementOncallScheduleConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
iids
| [ID!]
| IIDs of on-call schedules. |
Project.incidentManagementTimelineEvent
Incident Management Timeline event associated with the incident.
Returns TimelineEventType
.
Arguments
Name | Type | Description |
---|---|---|
id
| IncidentManagementTimelineEventID!
| ID of the timeline event. |
incidentId
| IssueID!
| ID of the incident. |
Project.incidentManagementTimelineEvents
Incident Management Timeline events associated with the incident.
Returns TimelineEventTypeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
incidentId
| IssueID!
| ID of the incident. |
Project.inheritedCiVariables
List of CI/CD variables the project inherited from its parent group and ancestors.
Returns InheritedCiVariableConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
sort
| CiGroupVariablesSort
| Sort variables by the criteria. |
Project.issue
A single issue of the project.
Returns Issue
.
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported. |
assigneeUsername | String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
assigneeWildcardId
| AssigneeWildcardId
| Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
confidential
| Boolean
| Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
crmContactId
| String
| ID of a contact assigned to the issues. |
crmOrganizationId
| String
| ID of an organization assigned to the issues. |
epicId
| String
| ID of an epic associated with the issues, “none” and “any” values are supported. |
epicWildcardId
| EpicWildcardId
| Filter by epic ID wildcard. Incompatible with epicId. |
healthStatus | HealthStatus
|
Deprecated in 15.4. Use healthStatusFilter .
|
healthStatusFilter
| HealthStatusFilter
| Health status of the issue, “none” and “any” values are supported. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
includeSubepics
| Boolean
| Whether to include subepics when filtering issues by epicId. |
iterationCadenceId
| [IterationsCadenceID!]
| Filter by a list of iteration cadence IDs. |
iterationId
| [ID]
| List of iteration Global IDs applied to the issue. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
milestoneWildcardId
| MilestoneWildcardId
| Filter issues by milestone ID wildcard. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported. |
not
| NegatedIssueFilterInput
| Negated arguments. |
or
| UnionedIssueFilterInput
| List of arguments with inclusive OR. |
releaseTag
| [String!]
| Release tag associated with the issue’s milestone. |
releaseTagWildcardId
| ReleaseTagWildcardId
| Filter issues by release tag ID wildcard. |
search
| String
| Search query for title or description. |
sort
| IssueSort
| Sort issues by this criteria. |
state
| IssuableState
| Current state of this issue. |
types
| [IssueType!]
| Filter issues by the given issue types. |
updatedAfter
| Time
| Issues updated after this date. |
updatedBefore
| Time
| Issues updated before this date. |
weight
| String
| Weight applied to the issue, “none” and “any” values are supported. |
weightWildcardId
| WeightWildcardId
| Filter by weight ID wildcard. Incompatible with weight. |
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. Wildcard values “NONE” and “ANY” are supported. |
assigneeUsername | String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
assigneeWildcardId
| AssigneeWildcardId
| Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
confidential
| Boolean
| Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
crmContactId
| String
| ID of a contact assigned to the issues. |
crmOrganizationId
| String
| ID of an organization assigned to the issues. |
epicId
| String
| ID of an epic associated with the issues, “none” and “any” values are supported. |
epicWildcardId
| EpicWildcardId
| Filter by epic ID wildcard. Incompatible with epicId. |
healthStatusFilter
| HealthStatusFilter
| Health status of the issue, “none” and “any” values are supported. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
includeSubepics
| Boolean
| Whether to include subepics when filtering issues by epicId. |
iterationCadenceId
| [IterationsCadenceID!]
| Filter by a list of iteration cadence IDs. |
iterationId
| [ID]
| List of iteration Global IDs applied to the issue. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
milestoneWildcardId
| MilestoneWildcardId
| Filter issues by milestone ID wildcard. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported. |
not
| NegatedIssueFilterInput
| Negated arguments. |
or
| UnionedIssueFilterInput
| List of arguments with inclusive OR. |
releaseTag
| [String!]
| Release tag associated with the issue’s milestone. |
releaseTagWildcardId
| ReleaseTagWildcardId
| Filter issues by release tag ID wildcard. |
search
| String
| Search query for 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. |
weight
| String
| Weight applied to the issue, “none” and “any” values are supported. |
weightWildcardId
| WeightWildcardId
| Filter by weight ID wildcard. Incompatible with weight. |
Project.issues
Issues of the project.
Returns IssueConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
assigneeId
| String
| ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported. |
assigneeUsername | String
|
Deprecated in 13.11. Use assigneeUsernames .
|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
assigneeWildcardId
| AssigneeWildcardId
| Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames. |
authorUsername
| String
| Username of the author of the issue. |
closedAfter
| Time
| Issues closed after this date. |
closedBefore
| Time
| Issues closed before this date. |
confidential
| Boolean
| Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues. |
createdAfter
| Time
| Issues created after this date. |
createdBefore
| Time
| Issues created before this date. |
crmContactId
| String
| ID of a contact assigned to the issues. |
crmOrganizationId
| String
| ID of an organization assigned to the issues. |
epicId
| String
| ID of an epic associated with the issues, “none” and “any” values are supported. |
epicWildcardId
| EpicWildcardId
| Filter by epic ID wildcard. Incompatible with epicId. |
healthStatus | HealthStatus
|
Deprecated in 15.4. Use healthStatusFilter .
|
healthStatusFilter
| HealthStatusFilter
| Health status of the issue, “none” and “any” values are supported. |
iid
| String
| IID of the issue. For example, “1”. |
iids
| [String!]
| List of IIDs of issues. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
includeSubepics
| Boolean
| Whether to include subepics when filtering issues by epicId. |
iterationCadenceId
| [IterationsCadenceID!]
| Filter by a list of iteration cadence IDs. |
iterationId
| [ID]
| List of iteration Global IDs applied to the issue. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Labels applied to this issue. |
milestoneTitle
| [String]
| Milestone applied to this issue. |
milestoneWildcardId
| MilestoneWildcardId
| Filter issues by milestone ID wildcard. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported. |
not
| NegatedIssueFilterInput
| Negated arguments. |
or
| UnionedIssueFilterInput
| List of arguments with inclusive OR. |
releaseTag
| [String!]
| Release tag associated with the issue’s milestone. |
releaseTagWildcardId
| ReleaseTagWildcardId
| Filter issues by release tag ID wildcard. |
search
| String
| Search query for title or description. |
sort
| IssueSort
| Sort issues by this criteria. |
state
| IssuableState
| Current state of this issue. |
types
| [IssueType!]
| Filter issues by the given issue types. |
updatedAfter
| Time
| Issues updated after this date. |
updatedBefore
| Time
| Issues updated before this date. |
weight
| String
| Weight applied to the issue, “none” and “any” values are supported. |
weightWildcardId
| WeightWildcardId
| Filter by weight ID wildcard. Incompatible with weight. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Whether the iteration cadence is active. |
automatic
| Boolean
| Whether the iteration cadence should automatically generate upcoming 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
| ID
| Global ID of the Iteration to look up. |
iid
| ID
| Internal ID of the Iteration to look up. |
in
| [IterationSearchableField!]
| Fields in which the fuzzy-search should be performed with the query given in the argument search . Defaults to [title] .
|
includeAncestors
| Boolean
| Whether to include ancestor iterations. Defaults to true. |
includeDescendants
| Boolean
| Whether to include descendant iterations. |
iterationCadenceIds
| [IterationsCadenceID!]
| Global iteration cadence IDs by which to look up the iterations. |
search
| String
| Query used for fuzzy-searching in the fields selected in the argument in . Returns all iterations if empty.
|
sort
| IterationSort
| List iterations by sort order. If unspecified, an arbitrary order (subject to change) is used. |
state
| IterationState
| Filter iterations by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
title | String
|
Deprecated in 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
|
Project.job
One job belonging to the project, selected by ID.
Returns CiJob
.
Arguments
Name | Type | Description |
---|---|---|
id
| JobID!
| ID of the job. |
Project.jobs
Jobs of a project. This field can only be resolved for one project in any single request.
Returns CiJobConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
statuses
| [CiJobStatus!]
| Filter jobs by status. |
withArtifacts
| Boolean
| Filter by artifacts presence. |
Project.label
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
includeAncestorGroups
| Boolean
| Include labels from ancestor groups. |
searchTerm
| String
| Search term to find labels with. |
Project.memberRoles
Member roles available for the group.
Returns MemberRoleConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
| MemberRoleID
| Global ID of the member role to look up. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
Project.milestones
Milestones of the project.
Returns MilestoneConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
containingDate
| Time
| Date the milestone contains. |
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
| Search string for the title. |
sort
| MilestoneSort
| Sort milestones by this criteria. |
state
| MilestoneStateEnum
| Filter milestones by state. |
timeframe
| Timeframe
| List items overlapping the given timeframe. |
title
| String
| Title of the milestone. |
Project.nestedEnvironments
Environments for this project with nested folders, can only be resolved for one project in any single request.
Returns NestedEnvironmentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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. |
type
| String
| Search query for environment type. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
environmentId
| EnvironmentID
| 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
, and 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. |
packageVersion
| String
| Filter a package by version. If used in combination with include_versionless , then no versionless packages are returned.
|
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.pipelineCounts
Build pipeline counts of the project.
Returns PipelineCounts
.
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. |
source
| String
| Filter pipelines by their source. |
Project.pipelineSchedules
Pipeline schedules of the project. This field can only be resolved for one project per request.
Returns PipelineScheduleConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [ID!]
| Filter pipeline schedules by IDs. |
status
| PipelineScheduleStatus
| Filter pipeline schedules by active status. |
Project.pipelines
Build pipelines of the project.
Returns PipelineConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ref
| String
| Filter pipelines by the ref they are run for. |
scope
| PipelineScopeEnum
| Filter pipelines by scope. |
sha
| String
| Filter pipelines by the sha of the commit they are run for. |
source
| String
| Filter pipelines by their source. |
status
| PipelineStatusEnum
| Filter pipelines by their status. |
updatedAfter
| Time
| Pipelines updated after this date. |
updatedBefore
| Time
| Pipelines updated before this date. |
username
| String
| Filter pipelines by the user that triggered the pipeline. |
Project.productAnalyticsEventsStored
Count of all events used, broken down by month.
Returns [MonthlyUsage!]
.
Arguments
Name | Type | Description |
---|---|---|
monthSelection
| [MonthSelectionInput!]!
| Selection for the period to return. |
Project.projectMembers
Members of the project.
Returns MemberInterfaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
relations
| [ProjectMemberRelation!]
| Filter members by the given member relations. |
search
| String
| Search query. |
sort
| MemberSort
| sort query. |
Project.release
A single release of the project.
Returns Release
.
Arguments
Name | Type | Description |
---|---|---|
tagName
| String!
| Name of the tag associated to the release. |
Project.releases
Releases of the project.
Returns ReleaseConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
sort
| ReleaseSort
| Sort releases by given criteria. |
Project.requirement
Find a single requirement.
Returns Requirement
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| [String!]
| Filter requirements by author username. |
iid | ID
| Deprecated in 15.8. Use work_item_iid instead. |
iids | [ID!]
| Deprecated in 15.8. Use work_item_iids instead. |
lastTestReportState
| RequirementStatusFilter
| 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. |
workItemIid
| ID
| IID of the requirement work item, for example, “1”. |
workItemIids
| [ID!]
| List of IIDs of requirement work items, for example, [1, 2] .
|
Project.requirements
Find requirements.
Returns RequirementConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| [String!]
| Filter requirements by author username. |
iid | ID
| Deprecated in 15.8. Use work_item_iid instead. |
iids | [ID!]
| Deprecated in 15.8. Use work_item_iids instead. |
lastTestReportState
| RequirementStatusFilter
| 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. |
workItemIid
| ID
| IID of the requirement work item, for example, “1”. |
workItemIids
| [ID!]
| List of IIDs of requirement work items, for example, [1, 2] .
|
Project.runners
Find runners visible to the current user.
Returns CiRunnerConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
active | Boolean
|
Deprecated in 14.8. This was renamed. Use: paused .
|
creatorId
| UserID
| Filter runners by creator ID. |
paused
| Boolean
| Filter runners by paused (true) or active (false) status.
|
search
| String
| Filter by full token or partial text in description field. |
sort
| CiRunnerSort
| Sort order of results. |
status
| CiRunnerStatus
| Filter runners by status. |
tagList
| [String!]
| Filter by tags associated with the runner (comma-separated or array). |
type
| CiRunnerType
| Filter runners by type. |
upgradeStatus
| CiRunnerUpgradeStatus
| Filter by upgrade status. |
versionPrefix | String
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term ‘14.’ returns runner managers with versions ‘14.11.1’ and ‘14.2.3’. |
Project.scanExecutionPolicies
Scan Execution Policies of the project.
Returns ScanExecutionPolicyConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actionScanTypes
| [SecurityReportTypeEnum!]
| Filters policies by the action scan type. Only these scan types are supported: dast , secret_detection , cluster_image_scanning , container_scanning , sast , sast_iac , dependency_scanning .
|
relationship
| SecurityPolicyRelationType
| Filter policies by the given policy relationship. |
Project.scanResultPolicies
Scan Result Policies of the project.
Returns ScanResultPolicyConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
relationship
| SecurityPolicyRelationType
| Filter policies by the given policy relationship. |
Project.securityTrainingProviders
List of security training providers for the project.
Returns [ProjectSecurityTraining!]
.
Arguments
Name | Type | Description |
---|---|---|
onlyEnabled
| Boolean
| Filter the list by only enabled security trainings. |
Project.securityTrainingUrls
Security training URLs for the enabled training providers of the project.
Returns [SecurityTrainingUrl!]
.
Arguments
Name | Type | Description |
---|---|---|
filename
| String
| Filename to filter security training URLs by programming language. |
identifierExternalIds
| [String!]!
| List of external IDs of vulnerability identifiers. |
Project.sentryDetailedError
Detailed version of a Sentry error on the project.
Returns SentryDetailedError
.
Arguments
Name | Type | Description |
---|---|---|
id
| GitlabErrorTrackingDetailedErrorID!
| ID of the Sentry issue. |
Project.services
Project services.
Project.integrations
.Returns ServiceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
visibility
| VisibilityScopesEnum
| 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.timelogs
Time logged on issues and merge requests in the project.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
Project.visibleForks
Visible forks of the project.
Returns ProjectConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
minimumAccessLevel
| AccessLevelEnum
| Minimum access level. |
Project.vulnerabilities
Vulnerabilities reported on the project.
Returns VulnerabilityConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
clusterAgentId
| [ClustersAgentID!]
| Filter vulnerabilities by cluster_agent_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
clusterId
| [ClustersClusterID!]
| Filter vulnerabilities by cluster_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
dismissalReason
| [VulnerabilityDismissalReason!]
| Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter. |
hasIssues
| Boolean
| Returns only the vulnerabilities which have linked issues. |
hasMergeRequest
| Boolean
| Returns only the vulnerabilities which have linked merge requests. |
hasRemediations
| Boolean
| Returns only the vulnerabilities which have remediations. |
hasResolution
| Boolean
| Returns only the vulnerabilities which have been resolved on default branch. |
image
| [String!]
| Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning , cluster_image_scanning .
|
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by VulnerabilityScanner.externalId. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
sort
| VulnerabilitySort
| List vulnerabilities by sort order. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
Project.vulnerabilitiesCountByDay
The historical number of vulnerabilities per day for the project.
Returns VulnerabilitiesCountByDayConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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 |
---|---|---|
clusterAgentId
| [ClustersAgentID!]
| Filter vulnerabilities by cluster_agent_id . Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
|
dismissalReason
| [VulnerabilityDismissalReason!]
| Filter by dismissal reason. |
hasIssues
| Boolean
| Filter vulnerabilities that do or do not have issues. |
hasMergeRequest
| Boolean
| Filter vulnerabilities that do or do not have a merge request. |
hasRemediations
| Boolean
| Filter vulnerabilities that do or do not have remediations. |
hasResolution
| Boolean
| Filter vulnerabilities that do or do not have a resolution. |
image
| [String!]
| Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning , cluster_image_scanning .
|
projectId
| [ID!]
| Filter vulnerabilities by project. |
reportType
| [VulnerabilityReportType!]
| Filter vulnerabilities by report type. |
scanner
| [String!]
| Filter vulnerabilities by scanner. |
scannerId
| [VulnerabilitiesScannerID!]
| Filter vulnerabilities by scanner ID. |
severity
| [VulnerabilitySeverity!]
| Filter vulnerabilities by severity. |
state
| [VulnerabilityState!]
| Filter vulnerabilities by state. |
Project.workItemStateCounts
Counts of work items by state for the project.
Returns WorkItemStateCountsType
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername | String
| Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. Filter work items by author username. |
iid
| String
| IID of the work item. For example, “1”. |
iids
| [String!]
| List of IIDs of work items. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
requirementLegacyWidget | RequirementLegacyFilterInput
| Deprecated in 15.9. Use work item IID filter instead. |
search
| String
| Search query for title or description. |
sort
| WorkItemSort
| Sort work items by criteria. |
state
| IssuableState
| Current state of the work item. |
statusWidget
| StatusFilterInput
| Input for status widget filter. Ignored if work_items_mvc_2 is disabled.
|
types
| [IssueType!]
| Filter work items by the given work item types. |
Project.workItemTypes
Work item types available to the project.
Returns WorkItemTypeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
taskable
| Boolean
| If true , only taskable work item types will be returned. Argument is experimental and can be removed in the future without notice.
|
Project.workItems
Work items of the project.
Returns WorkItemConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
authorUsername | String
| Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. Filter work items by author username. |
iid
| String
| IID of the work item. For example, “1”. |
iids
| [String!]
| List of IIDs of work items. For example, ["1", "2"] .
|
in
| [IssuableSearchableField!]
| Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION] . Requires the search argument.’.
|
requirementLegacyWidget | RequirementLegacyFilterInput
| Deprecated in 15.9. Use work item IID filter instead. |
search
| String
| Search query for title or description. |
sort
| WorkItemSort
| Sort work items by criteria. |
state
| IssuableState
| Current state of the work item. |
statusWidget
| StatusFilterInput
| Input for status widget filter. Ignored if work_items_mvc_2 is disabled.
|
types
| [IssueType!]
| Filter work items by the given work item types. |
ProjectCiCdSetting
Fields
Name | Type | Description |
---|---|---|
inboundJobTokenScopeEnabled
| Boolean
| Indicates CI/CD job tokens generated in other projects have restricted access to this project. |
jobTokenScopeEnabled
| Boolean
| Indicates CI/CD job tokens generated in this project have restricted access to other projects. |
keepLatestArtifact
| Boolean
| Whether to keep the latest builds artifacts. |
mergePipelinesEnabled
| Boolean
| Whether merge pipelines are enabled. |
mergeTrainsEnabled
| Boolean
| Whether merge trains are enabled. |
mergeTrainsSkipTrainAllowed
| Boolean!
| Whether merge immediately is allowed for merge trains. |
project
| Project
| Project the CI/CD settings belong to. |
ProjectDataTransfer
Fields
Name | Type | Description |
---|---|---|
egressNodes
| EgressNodeConnection
| Data nodes. (see Connections) |
totalEgress
| BigInt
| Total egress for that project in that period of time. |
ProjectFeatureAccess
Represents the access level required by the user to access a project feature.
Fields
Name | Type | Description |
---|---|---|
integerValue
| Int
| Integer representation of access level. |
stringValue
| ProjectFeatureAccessLevel
| String representation of access level. |
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. |
Fields with arguments
ProjectMember.mergeRequestInteraction
Find a merge request.
Returns UserMergeRequestInteraction
.
Arguments
Name | Type | Description |
---|---|---|
id
| MergeRequestID!
| Global ID of the merge request. |
ProjectPermissions
Fields
Name | Type | Description |
---|---|---|
adminOperations
| Boolean!
| If true , the user can perform admin_operations on this resource.
|
adminPathLocks
| Boolean!
| If true , the user can perform admin_path_locks on this resource.
|
adminProject
| Boolean!
| If true , the user can perform admin_project on this resource.
|
adminRemoteMirror
| Boolean!
| If true , the user can perform admin_remote_mirror on this resource.
|
adminWiki
| Boolean!
| If true , the user can perform admin_wiki on this resource.
|
archiveProject
| Boolean!
| If true , the user can perform archive_project on this resource.
|
changeNamespace
| Boolean!
| If true , the user can perform change_namespace on this resource.
|
changeVisibilityLevel
| Boolean!
| If true , the user can perform change_visibility_level on this resource.
|
createDeployment
| Boolean!
| If true , the user can perform create_deployment on this resource.
|
createDesign
| Boolean!
| If true , the user can perform create_design on this resource.
|
createIssue
| Boolean!
| If true , the user can perform create_issue on this resource.
|
createLabel
| Boolean!
| If true , the user can perform create_label on this resource.
|
createMergeRequestFrom
| Boolean!
| If true , the user can perform create_merge_request_from on this resource.
|
createMergeRequestIn
| Boolean!
| If true , the user can perform create_merge_request_in on this resource.
|
createPages
| Boolean!
| If true , the user can perform create_pages on this resource.
|
createPipeline
| Boolean!
| If true , the user can perform create_pipeline on this resource.
|
createPipelineSchedule
| Boolean!
| If true , the user can perform create_pipeline_schedule on this resource.
|
createSnippet
| Boolean!
| If true , the user can perform create_snippet on this resource.
|
createWiki
| Boolean!
| If true , the user can perform create_wiki on this resource.
|
destroyDesign
| Boolean!
| If true , the user can perform destroy_design on this resource.
|
destroyPages
| Boolean!
| If true , the user can perform destroy_pages on this resource.
|
destroyWiki
| Boolean!
| If true , the user can perform destroy_wiki on this resource.
|
downloadCode
| Boolean!
| If true , the user can perform download_code on this resource.
|
downloadWikiCode
| Boolean!
| If true , the user can perform download_wiki_code on this resource.
|
forkProject
| Boolean!
| If true , the user can perform fork_project on this resource.
|
pushCode
| Boolean!
| If true , the user can perform push_code on this resource.
|
pushToDeleteProtectedBranch
| Boolean!
| If true , the user can perform push_to_delete_protected_branch on this resource.
|
readCommitStatus
| Boolean!
| If true , the user can perform read_commit_status on this resource.
|
readCycleAnalytics
| Boolean!
| If true , the user can perform read_cycle_analytics on this resource.
|
readDesign
| Boolean!
| If true , the user can perform read_design on this resource.
|
readEnvironment
| Boolean!
| If true , the user can perform read_environment on this resource.
|
readMergeRequest
| Boolean!
| If true , the user can perform read_merge_request on this resource.
|
readPagesContent
| Boolean!
| If true , the user can perform read_pages_content on this resource.
|
readProject
| Boolean!
| If true , the user can perform read_project on this resource.
|
readProjectMember
| Boolean!
| If true , the user can perform read_project_member on this resource.
|
readWiki
| Boolean!
| If true , the user can perform read_wiki on this resource.
|
removeForkProject
| Boolean!
| If true , the user can perform remove_fork_project on this resource.
|
removePages
| Boolean!
| If true , the user can perform remove_pages on this resource.
|
removeProject
| Boolean!
| If true , the user can perform remove_project on this resource.
|
renameProject
| Boolean!
| If true , the user can perform rename_project on this resource.
|
requestAccess
| Boolean!
| If true , the user can perform request_access on this resource.
|
updatePages
| Boolean!
| If true , the user can perform update_pages on this resource.
|
updateWiki
| Boolean!
| If true , the user can perform update_wiki on this resource.
|
uploadFile
| Boolean!
| If true , the user can perform upload_file on this resource.
|
ProjectRepositoryRegistry
Represents the Geo replication and verification state of a project repository.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the ProjectRepositoryRegistry was created. |
id
| ID!
| ID of the ProjectRepositoryRegistry. |
lastSyncFailure
| String
| Error message during sync of the ProjectRepositoryRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the ProjectRepositoryRegistry. |
projectId
| ID!
| ID of the Project. |
retryAt
| Time
| Timestamp after which the ProjectRepositoryRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the ProjectRepositoryRegistry. |
state
| RegistryState
| Sync state of the ProjectRepositoryRegistry. |
verificationChecksum
| String
| The local checksum of the ProjectRepositoryRegistry. |
verificationFailure
| String
| Error message during verification of the ProjectRepositoryRegistry. |
verificationRetryAt
| Time
| Timestamp after which the ProjectRepositoryRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the ProjectRepositoryRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of ProjectRepositoryRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the ProjectRepositoryRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the ProjectRepositoryRegistry. |
ProjectSecurityPolicySource
Represents the source of a security policy belonging to a project.
Fields
Name | Type | Description |
---|---|---|
project
| Project
| Project the policy is associated with. |
ProjectSecurityTraining
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the training provider. |
id
| GlobalID!
| ID of the training provider. |
isEnabled
| Boolean!
| Represents whether the provider is enabled or not. |
isPrimary
| Boolean!
| Represents whether the provider is set as primary or not. |
logoUrl
| String
| Logo URL of the provider. |
name
| String!
| Name of the training provider. |
url
| String!
| URL of the provider. |
ProjectStatistics
Fields
Name | Type | Description |
---|---|---|
buildArtifactsSize
| Float!
| Build artifacts size of the project in bytes. |
commitCount
| Float!
| Commit count of the project. |
containerRegistrySize
| Float
| Container Registry size of the project in bytes. |
costFactoredBuildArtifactsSize | Float!
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Build artifacts size in bytes with any applicable cost factor for forks applied. This will equal build_artifacts_size if there is no applicable cost factor. |
costFactoredLfsObjectsSize | Float!
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. LFS objects size in bytes with any applicable cost factor for forks applied. This will equal lfs_objects_size if there is no applicable cost factor. |
costFactoredPackagesSize | Float!
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Packages size in bytes with any applicable cost factor for forks applied. This will equal packages_size if there is no applicable cost factor. |
costFactoredRepositorySize | Float!
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Repository size in bytes with any applicable cost factor for forks applied. This will equal repository_size if there is no applicable cost factor. |
costFactoredSnippetsSize | Float!
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Snippets size in bytes with any applicable cost factor for forks applied. This will equal snippets_size if there is no applicable cost factor. |
costFactoredStorageSize | Float!
| Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Storage size in bytes with any applicable cost factor for forks applied. This will equal storage_size if there is no applicable cost factor. |
costFactoredWikiSize | Float!
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Wiki size in bytes with any applicable cost factor for forks applied. This will equal wiki_size if there is no applicable cost factor. |
lfsObjectsSize
| Float!
| Large File Storage (LFS) object size of the project in bytes. |
packagesSize
| Float!
| Packages size of the project in bytes. |
pipelineArtifactsSize
| Float
| CI Pipeline artifacts size 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. |
ProjectStatisticsRedirect
Fields
Name | Type | Description |
---|---|---|
buildArtifacts
| String!
| Redirection Route for job_artifacts. |
containerRegistry
| String!
| Redirection Route for container_registry. |
packages
| String!
| Redirection Route for packages. |
repository
| String!
| Redirection Route for repository. |
snippets
| String!
| Redirection Route for snippets. |
wiki
| String!
| Redirection Route for wiki. |
ProjectValueStreamAnalyticsFlowMetrics
Exposes aggregated value stream flow metrics.
Fields with arguments
ProjectValueStreamAnalyticsFlowMetrics.cycleTime
Median time from first commit to issue closed.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
epicId
| ID
| ID of an epic associated with the issues. |
from
| Time!
| Timestamp marking the start date and time. |
iterationId
| ID
| ID of an iteration associated with the issues. |
labelNames
| [String!]
| Labels applied to the issue. |
milestoneTitle
| String
| Milestone applied to the issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedValueStreamAnalyticsIssueFilterInput
| Argument used for adding negated filters. |
to
| Time!
| Timestamp marking the end date and time. |
weight
| Int
| Weight applied to the issue. |
ProjectValueStreamAnalyticsFlowMetrics.deploymentCount
Number of production deployments in the given period.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
from
| Time!
| Timestamp marking the start date and time. |
to
| Time!
| Timestamp marking the end date and time. |
ProjectValueStreamAnalyticsFlowMetrics.issueCount
Number of issues opened in the given period.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
epicId
| ID
| ID of an epic associated with the issues. |
from
| Time!
| Timestamp marking the start date and time. |
iterationId
| ID
| ID of an iteration associated with the issues. |
labelNames
| [String!]
| Labels applied to the issue. |
milestoneTitle
| String
| Milestone applied to the issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedValueStreamAnalyticsIssueFilterInput
| Argument used for adding negated filters. |
to
| Time!
| Timestamp marking the end date and time. |
weight
| Int
| Weight applied to the issue. |
ProjectValueStreamAnalyticsFlowMetrics.issuesCompletedCount
Number of open issues closed (completed) in the given period. Maximum value is 10,001.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
epicId
| ID
| ID of an epic associated with the issues. |
from
| Time!
| Timestamp marking the start date and time. |
iterationId
| ID
| ID of an iteration associated with the issues. |
labelNames
| [String!]
| Labels applied to the issue. |
milestoneTitle
| String
| Milestone applied to the issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedValueStreamAnalyticsIssueFilterInput
| Argument used for adding negated filters. |
to
| Time!
| Timestamp marking the end date and time. |
weight
| Int
| Weight applied to the issue. |
ProjectValueStreamAnalyticsFlowMetrics.leadTime
Median time from when the issue was created to when it was closed.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the issue. |
authorUsername
| String
| Username of the author of the issue. |
epicId
| ID
| ID of an epic associated with the issues. |
from
| Time!
| Timestamp marking the start date and time. |
iterationId
| ID
| ID of an iteration associated with the issues. |
labelNames
| [String!]
| Labels applied to the issue. |
milestoneTitle
| String
| Milestone applied to the issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
not
| NegatedValueStreamAnalyticsIssueFilterInput
| Argument used for adding negated filters. |
to
| Time!
| Timestamp marking the end date and time. |
weight
| Int
| Weight applied to the issue. |
ProjectValueStreamAnalyticsFlowMetrics.timeToMerge
Median time from merge request creation to merge request merged.
Returns ValueStreamAnalyticsMetric
.
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users assigned to the merge request. |
authorUsername
| String
| Username of the author of the merge request. |
from
| Time!
| Timestamp marking the start date and time. |
labelNames
| [String!]
| Labels applied to the merge request. |
milestoneTitle
| String
| Milestone applied to the merge request. |
to
| Time!
| Timestamp marking the end date and time. |
ProjectWikiRepositoryRegistry
Represents the Geo replication and verification state of a project_wiki_repository.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the ProjectWikiRepositoryRegistry was created. |
id
| ID!
| ID of the ProjectWikiRepositoryRegistry. |
lastSyncFailure
| String
| Error message during sync of the ProjectWikiRepositoryRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the ProjectWikiRepositoryRegistry. |
projectWikiRepositoryId
| ID!
| ID of the Project Wiki Repository. |
retryAt
| Time
| Timestamp after which the ProjectWikiRepositoryRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the ProjectWikiRepositoryRegistry. |
state
| RegistryState
| Sync state of the ProjectWikiRepositoryRegistry. |
verificationChecksum
| String
| The local checksum of the ProjectWikiRepositoryRegistry. |
verificationFailure
| String
| Error message during verification of the ProjectWikiRepositoryRegistry. |
verificationRetryAt
| Time
| Timestamp after which the ProjectWikiRepositoryRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the ProjectWikiRepositoryRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of ProjectWikiRepositoryRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the ProjectWikiRepositoryRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the ProjectWikiRepositoryRegistry. |
PrometheusAlert
The alert condition for Prometheus.
Fields
Name | Type | Description |
---|---|---|
humanizedText
| String!
| Human-readable text of the alert condition. |
id
| ID!
| ID of the alert condition. |
ProtectedEnvironment
Protected Environments of the environment.
Fields
Name | Type | Description |
---|---|---|
approvalRules
| ProtectedEnvironmentApprovalRuleConnection
| Which group, user or role is allowed to approve deployments to the environment. (see Connections) |
deployAccessLevels
| ProtectedEnvironmentDeployAccessLevelConnection
| Which group, user or role is allowed to execute deployments to the environment. (see Connections) |
group
| Group
| Group details. Present if it’s group-level protected environment. |
name
| String
| Name of the environment if it’s a project-level protected environment. Tier of the environment if it’s a group-level protected environment. |
project
| Project
| Project details. Present if it’s project-level protected environment. |
requiredApprovalCount
| Int
| Required approval count for Unified Approval Setting. |
ProtectedEnvironmentApprovalRule
Which group, user or role is allowed to approve deployments to the environment.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| AccessLevel
| Role details. Present if it’s role specific access control. |
group
| Group
| Group details. Present if it’s group specific access control. |
requiredApprovals
| Int
| Number of required approvals. |
user
| UserCore
| User details. Present if it’s user specific access control. |
ProtectedEnvironmentApprovalRuleForSummary
Which group, user or role is allowed to approve deployments to the environment.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| AccessLevel
| Role details. Present if it’s role specific access control. |
approvals
| [DeploymentApproval!]
| Current approvals of the deployment. |
approvedCount
| Int
| Approved count. |
group
| Group
| Group details. Present if it’s group specific access control. |
pendingApprovalCount
| Int
| Pending approval count. |
requiredApprovals
| Int
| Number of required approvals. |
status
| DeploymentApprovalSummaryStatus
| Status of the approval summary. |
user
| UserCore
| User details. Present if it’s user specific access control. |
ProtectedEnvironmentDeployAccessLevel
Which group, user or role is allowed to execute deployments to the environment.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| AccessLevel
| Role details. Present if it’s role specific access control. |
group
| Group
| Group details. Present if it’s group specific access control. |
user
| UserCore
| User details. Present if it’s user specific access control. |
PushAccessLevel
Defines which user roles, users, or groups can push to a protected branch.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| Int!
| GitLab::Access level. |
accessLevelDescription
| String!
| Human readable representation for this access level. |
deployKey
| AccessLevelDeployKey
| Deploy key assigned to the access level. |
group
| AccessLevelGroup
| Group associated with this access level. |
user
| AccessLevelUser
| User associated with this access level. |
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 |
---|---|---|
authorEmail
| String
| Author email address(es) in RFC-822 format. |
description
| String
| Longer description that can run to several paragraphs. |
descriptionContentType
| String
| Markup syntax used in the description field. |
id
| PackagesPypiMetadatumID!
| ID of the metadatum. |
keywords
| String
| List of keywords, separated by commas. |
metadataVersion
| String
| Metadata version. |
requiredPython
| String
| Required Python version of the Pypi package. |
summary
| String
| One-line summary of the description. |
QueryComplexity
Fields
Name | Type | Description |
---|---|---|
limit
| Int
| GraphQL query complexity limit. See GitLab documentation on this limit. |
score
| Int
| GraphQL query complexity score. |
QueueingDelayHistory
Aggregated statistics about queueing times for CI jobs.
Fields
Name | Type | Description |
---|---|---|
timeSeries
| [QueueingHistoryTimeSeries!]
| Time series. |
QueueingHistoryTimeSeries
The amount of time for a job to be picked up by a runner, in percentiles.
Fields
Name | Type | Description |
---|---|---|
p50 | Duration
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. 50th percentile. 50% of the durations are lower than this value. |
p75 | Duration
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. 75th percentile. 75% of the durations are lower than this value. |
p90 | Duration
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. 90th percentile. 90% of the durations are lower than this value. |
p95 | Duration
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. 95th percentile. 95% of the durations are lower than this value. |
p99 | Duration
| Introduced in 16.4. This feature is an Experiment. It can be changed or removed at any time. 99th percentile. 99% of the durations are lower than this value. |
time
| Time!
| Start of the time interval. |
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
| 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
| GitLab Flavored Markdown rendering of description .
|
evidences
| ReleaseEvidenceConnection
| Evidence for the release. (see Connections) |
historicalRelease
| Boolean
| Indicates the release is an historical release. |
id
| ReleaseID!
| Global ID of the release. |
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 |
---|---|---|
directAssetPath
| String
| Relative path for the direct asset link. |
directAssetUrl
| String
| Direct asset URL of the link. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
paths
| [String!]!
| Array of desired blob paths. |
ref
| String
| Commit ref to get the blobs from. Default value is HEAD. |
refType
| RefType
| Type of ref. |
Repository.branchNames
Names of branches available in this repository that match the search pattern.
Returns [String!]
.
Arguments
Name | Type | Description |
---|---|---|
limit
| Int!
| Number of branch names to return. |
offset
| Int!
| Number of branch names to skip. |
searchPattern
| String!
| Pattern to search for branch names by. |
Repository.codeOwnersPath
Path to CODEOWNERS file in a ref.
Returns String
.
Arguments
Name | Type | Description |
---|---|---|
ref
| String
| Name of the ref. |
Repository.paginatedTree
Paginated tree of the repository.
Returns TreeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
path
| String
| 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
| Commit ref to get the tree for. Default value is HEAD. |
refType
| RefType
| Type of ref. |
Repository.tree
Tree of the repository.
Returns Tree
.
Arguments
Name | Type | Description |
---|---|---|
path
| String
| 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
| Commit ref to get the tree for. Default value is HEAD. |
refType
| RefType
| Type of ref. |
Repository.validateCodeownerFile
Shows linting errors in the CODEOWNER file of the repository.
Returns RepositoryCodeownerValidation
.
Arguments
Name | Type | Description |
---|---|---|
path
| String
| Path of a file called CODEOWNERS that should be validated. Default to file in use. |
ref
| String
| Ref where code owners file needs to be checked. Defaults to the repository’s default branch. |
RepositoryBlob
Fields
Name | Type | Description |
---|---|---|
archived
| Boolean
| Whether the current project is archived. |
blamePath
| String
| Web path to blob blame page. |
canCurrentUserPushToBranch
| Boolean
| Whether the current user can push to the branch. |
canModifyBlob
| Boolean
| Whether the current user can modify the blob. |
codeNavigationPath
| String
| Web path for code navigation. |
codeOwners
| [UserCore!]
| List of code owners for the blob. |
editBlobPath
| String
| Web path to edit the blob in the old-style editor. |
environmentExternalUrlForRouteMap
| String
| Web path to blob on an environment. |
environmentFormattedExternalUrl
| String
| Environment on which the blob is available. |
externalStorage
| String
| External storage being used, if enabled (for instance, ‘LFS’). |
externalStorageUrl
| String
| Web path to download the raw blob via external storage, if enabled. |
fileType
| String
| Expected format of the blob based on the extension. |
findFilePath
| String
| Web path to find file. |
forkAndEditPath
| String
| Web path to edit this blob using a forked project. |
forkAndViewPath
| String
| Web path to view this blob using a forked project. |
gitpodBlobUrl
| String
| URL to the blob within Gitpod. |
historyPath
| String
| Web path to blob history page. |
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. |
language
| String
| Blob language. |
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. |
permalinkPath
| String
| Web path to blob permalink. |
pipelineEditorPath
| String
| Web path to edit .gitlab-ci.yml file. |
plainData
| String
| Blob plain highlighted data. |
projectBlobPathRoot
| String
| Web path for the root of the blob. |
rawBlob
| String
| Raw content of the blob. |
rawPath
| String
| Web path to download the raw blob. |
rawSize
| BigInt
| Size (in bytes) of the blob, or the blob target if stored externally. |
rawTextBlob
| String
| 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
| BigInt
| 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. |
Fields with arguments
RepositoryBlob.blame
Blob blame. Available only when feature flag graphql_git_blame
is enabled.
Returns Blame
.
Arguments
Name | Type | Description |
---|---|---|
fromLine
| Int
| Range starting from the line. Cannot be less than 1 or greater than to_line .
|
toLine
| Int
| Range ending on the line. Cannot be smaller than from_line or greater than from_line + 100.
|
RepositoryCodeownerError
Fields
Name | Type | Description |
---|---|---|
code
| String!
| Linting error code. |
lines
| [Int!]!
| Lines where the error occurred. |
RepositoryCodeownerValidation
Fields
Name | Type | Description |
---|---|---|
total
| Int!
| Total number of validation error in the file. |
validationErrors
| [RepositoryCodeownerError!]!
| Specific lint error code. |
RepositoryLanguage
Fields
Name | Type | Description |
---|---|---|
color
| Color
| Color to visualize the repository language. |
name
| String!
| Name of the repository language. |
share
| Float
| Percentage of the repository’s languages. |
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
| GitLab Flavored Markdown rendering of description .
|
id
| ID!
| ID of the requirement. |
iid | ID!
| Deprecated in 15.8. Use work_item_iid instead. |
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
| 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. |
workItemIid
| ID!
| Work item IID of the requirement, will replace current IID as identifier soon. |
Fields with arguments
Requirement.testReports
Test reports of the requirement.
Returns TestReportConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and 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!
| If true , the user can perform admin_requirement on this resource.
|
createRequirement
| Boolean!
| If true , the user can perform create_requirement on this resource.
|
destroyRequirement
| Boolean!
| If true , the user can perform destroy_requirement on this resource.
|
readRequirement
| Boolean!
| If true , the user can perform read_requirement on this resource.
|
updateRequirement
| Boolean!
| If true , 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!
| CI artifacts size in bytes. |
containerRegistrySize
| Float!
| Container Registry size in bytes. |
containerRegistrySizeIsEstimated
| Boolean!
| Indicates whether the deduplicated Container Registry size for the namespace is an estimated value or not. |
costFactoredStorageSize | Float!
| Introduced in 16.2. This feature is an Experiment. It can be changed or removed at any time. Total storage in bytes with any applicable cost factor for forks applied. This will equal storage_size if there is no applicable cost factor. |
dependencyProxySize
| Float!
| Dependency Proxy sizes in bytes. |
lfsObjectsSize
| Float!
| LFS objects size in bytes. |
packagesSize
| Float!
| Packages size in bytes. |
pipelineArtifactsSize
| Float!
| CI pipeline artifacts size in bytes. |
registrySizeEstimated | Boolean!
|
Deprecated in 16.2. Use container_registry_size_is_estimated .
|
repositorySize
| Float!
| Git repository size in bytes. |
snippetsSize
| Float!
| Snippets size in bytes. |
storageSize
| Float!
| Total storage in bytes. |
uploadsSize
| Float!
| Uploads size in bytes. |
wikiSize
| Float!
| Wiki size in bytes. |
RunnerArchitecture
Fields
Name | Type | Description |
---|---|---|
downloadLocation
| String!
| Download location for the runner for the platform architecture. |
name
| String!
| Name of the runner platform architecture. |
RunnerPermissions
Fields
Name | Type | Description |
---|---|---|
assignRunner
| Boolean!
| If true , the user can perform assign_runner on this resource.
|
deleteRunner
| Boolean!
| If true , the user can perform delete_runner on this resource.
|
readRunner
| Boolean!
| If true , the user can perform read_runner on this resource.
|
updateRunner
| Boolean!
| If true , the user can perform update_runner on this resource.
|
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. The actual registration tokens are not included in the commands. Instead, a placeholder $REGISTRATION_TOKEN is shown.
|
SastCiConfiguration
Represents a CI configuration of SAST.
Fields
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. |
SavedReply
Fields
Name | Type | Description |
---|---|---|
content
| String!
| Content of the saved reply. |
id
| UsersSavedReplyID!
| Global ID of the saved reply. |
name
| String!
| Name of the saved reply. |
Scan
Represents the security scan information.
Fields
Name | Type | Description |
---|---|---|
errors
| [String!]!
| List of errors. |
name
| String!
| Name of the scan. |
status
| ScanStatus!
| Indicates the status of the scan. |
warnings
| [String!]!
| List of warnings. |
ScanExecutionPolicy
Represents the scan execution policy.
Fields
Name | Type | Description |
---|---|---|
description
| String!
| Description of the policy. |
editPath
| String!
| URL of policy edit page. |
enabled
| Boolean!
| Indicates whether this policy is enabled. |
name
| String!
| Name of the policy. |
source
| SecurityPolicySource!
| Source of the policy. Its fields depend on the source type. |
updatedAt
| Time!
| Timestamp of when the policy YAML was last updated. |
yaml
| String!
| YAML definition of the policy. |
ScanResultPolicy
Represents the scan result policy.
Fields
Name | Type | Description |
---|---|---|
allGroupApprovers
| [PolicyApprovalGroup!]
| All potential approvers of the group type, including groups inaccessible to the user. |
description
| String!
| Description of the policy. |
editPath
| String!
| URL of policy edit page. |
enabled
| Boolean!
| Indicates whether this policy is enabled. |
groupApprovers | [Group!]
|
Deprecated in 16.5. Use allGroupApprovers .
|
name
| String!
| Name of the policy. |
roleApprovers
| [MemberAccessLevelName!]
| Approvers of the role type. Users belonging to these role(s) alone will be approvers. |
source
| SecurityPolicySource!
| Source of the policy. Its fields depend on the source type. |
updatedAt
| Time!
| Timestamp of when the policy YAML was last updated. |
userApprovers
| [UserCore!]
| Approvers of the user type. |
yaml
| String!
| YAML definition of the policy. |
ScannedResource
Represents a resource scanned by a security scan.
Fields
Name | Type | Description |
---|---|---|
requestMethod
| String
| HTTP request method used to access the URL. |
url
| String
| URL scanned by the scanner. |
SecurityPolicyValidationError
Security policy validation error.
Fields
Name | Type | Description |
---|---|---|
field
| String!
| Error field. |
level
| String!
| Error level. |
message
| String!
| Error message. |
title
| String
| Error title. |
SecurityReportSummary
Represents summary of a security report.
Fields
Name | Type | Description |
---|---|---|
apiFuzzing
| SecurityReportSummarySection
| Aggregated counts for the api_fuzzing scan.
|
clusterImageScanning
| SecurityReportSummarySection
| Aggregated counts for the cluster_image_scanning 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.
|
generic
| SecurityReportSummarySection
| Aggregated counts for the generic 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
| 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. |
SecurityTrainingUrl
Represents a URL related to a security training.
Fields
Name | Type | Description |
---|---|---|
identifier
| String
| Name of the vulnerability identifier. |
name
| String
| Name of the training provider. |
status
| TrainingUrlRequestStatus
| Status of the request to training provider. |
url
| String
| URL of the link for security training content. |
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. |
integrated
| Boolean
| Error tracking backend. |
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
, and 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
| Owner of the snippet. |
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
createdAt
| Time!
| Timestamp this snippet was created. |
description
| String
| Description of the snippet. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
fileName
| String
| File Name of the snippet. |
hidden
| Boolean!
| Indicates the snippet is hidden because the author has been banned. |
httpUrlToRepo
| String
| HTTP URL to the snippet repository. |
id
| SnippetID!
| ID of the snippet. |
project
| Project
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
paths
| [String!]
| Paths of the blobs. |
Snippet.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
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. |
rawPlainData
| String
| Raw content of the blob, if the blob is text data. |
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!
| If true , the user can perform admin_snippet on this resource.
|
awardEmoji
| Boolean!
| If true , the user can perform award_emoji on this resource.
|
createNote
| Boolean!
| If true , the user can perform create_note on this resource.
|
readSnippet
| Boolean!
| If true , the user can perform read_snippet on this resource.
|
reportSnippet
| Boolean!
| If true , the user can perform report_snippet on this resource.
|
updateSnippet
| Boolean!
| If true , 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 is 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. |
verificationChecksum
| String
| The local checksum of the SnippetRepositoryRegistry. |
verificationFailure
| String
| Error message during verification of the SnippetRepositoryRegistry. |
verificationRetryAt
| Time
| Timestamp after which the SnippetRepositoryRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the SnippetRepositoryRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of SnippetRepositoryRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the SnippetRepositoryRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the SnippetRepositoryRegistry. |
SshSignature
SSH signature for a signed commit.
Fields
Name | Type | Description |
---|---|---|
commitSha
| String
| SHA of the associated commit. |
key
| Key
| SSH key used for the signature. |
keyFingerprintSha256
| String
| Fingerprint of the key. |
project
| Project
| Project of the associated commit. |
user
| UserCore
| User associated with the key. |
verificationStatus
| VerificationStatus
| Indicates verification status of the associated key or certificate. |
StatusAction
Fields
Name | Type | Description |
---|---|---|
buttonTitle
| String
| Title for the button, for example: Retry this job. |
icon
| String
| Icon used in the action button. |
id
| String!
| ID for a status action. |
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. |
SubscriptionFutureEntry
Represents an entry from the future subscriptions.
Fields
Name | Type | Description |
---|---|---|
company
| String
| Company of the licensee. |
email
| String
| Email of the licensee. |
expiresAt
| Date
| Date when the license expires. |
name
| String
| Name of the licensee. |
plan
| String!
| Name of the subscription plan. |
startsAt
| Date
| Date when the license started. |
type
| String!
| Type of license the subscription will yield. |
usersInLicenseCount
| Int
| Number of paid user seats. |
SuggestedReviewersType
Represents a Suggested Reviewers result set.
Fields
Name | Type | Description |
---|---|---|
accepted
| [String!]
| List of accepted reviewer usernames. |
createdAt
| Time!
| Timestamp of when the suggestions were created. |
suggested
| [String!]!
| List of suggested reviewer usernames. |
updatedAt
| Time!
| Timestamp of when the suggestions were updated. |
SystemNoteMetadata
Fields
Name | Type | Description |
---|---|---|
action
| String
| System note metadata action. |
descriptionVersion
| DescriptionVersion
| Version of the changed description. |
id
| SystemNoteMetadataID!
| Global ID of the specific system note metadata. |
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. |
deletedAt
| Time
| Timestamp the Terraform state was deleted. |
id
| ID!
| ID of the Terraform state. |
latestVersion
| TerraformStateVersion
| Latest version of the Terraform state. |
lockedAt
| Time
| Timestamp the Terraform state was locked. |
lockedByUser
| UserCore
| 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
| 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
| 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 is 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. |
verificationChecksum
| String
| The local checksum of the TerraformStateVersionRegistry. |
verificationFailure
| String
| Error message during verification of the TerraformStateVersionRegistry. |
verificationRetryAt
| Time
| Timestamp after which the TerraformStateVersionRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the TerraformStateVersionRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of TerraformStateVersionRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the TerraformStateVersionRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the TerraformStateVersionRegistry. |
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. |
usesLegacyIid
| Boolean
| Indicates whether the test report was generated with references to legacy requirement IIDs. |
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. |
TimeTrackingTimelogCategory
Fields
Name | Type | Description |
---|---|---|
billable
| Boolean
| Whether the category is billable or not. |
billingRate
| Float
| Billing rate for the category. |
color
| Color
| Color assigned to the category. |
createdAt
| Time!
| When the category was created. |
description
| String
| Description of the category. |
id
| ID!
| Internal ID of the timelog category. |
name
| String!
| Name of the category. |
updatedAt
| Time!
| When the category was last updated. |
TimeboxMetrics
Represents measured stats metrics for timeboxes.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Count metric. |
weight
| Int!
| 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. |
error
| TimeboxReportError
| If the report cannot be generated, information about why. |
stats
| TimeReportStats
| Represents the time report stats for the timebox. |
TimeboxReportError
Explains why we could not generate a timebox report.
Fields
Name | Type | Description |
---|---|---|
code
| TimeboxReportErrorReason
| Machine readable code, categorizing the error. |
message
| String
| Human readable message explaining what happened. |
TimelineEventTagType
Describes a tag on an incident management timeline event.
Fields
Name | Type | Description |
---|---|---|
id
| IncidentManagementTimelineEventTagID!
| ID of the timeline event tag. |
name
| String!
| Name of the timeline event tag. |
TimelineEventType
Describes an incident management timeline event.
Fields
Name | Type | Description |
---|---|---|
action
| String!
| Indicates the timeline event icon. |
author
| UserCore
| User that created the timeline event. |
createdAt
| Time!
| Timestamp when the event created. |
editable
| Boolean!
| Indicates the timeline event is editable. |
id
| IncidentManagementTimelineEventID!
| ID of the timeline event. |
incident
| Issue!
| Incident of the timeline event. |
note
| String
| Text note of the timeline event. |
noteHtml
| String
| HTML note of the timeline event. |
occurredAt
| Time!
| Timestamp when the event occurred. |
promotedFromNote
| Note
| Note from which the timeline event was created. |
timelineEventTags
| TimelineEventTagTypeConnection
| Tags for the incident timeline event. (see Connections) |
updatedAt
| Time!
| Timestamp when the event updated. |
updatedByUser
| UserCore
| User that updated the timeline event. |
Timelog
Fields
Name | Type | Description |
---|---|---|
id
| ID!
| Internal ID of the timelog. |
issue
| Issue
| Issue that logged time was added to. |
mergeRequest
| MergeRequest
| Merge request that logged time was added to. |
note
| Note
| Note where the quick action was executed to add the logged time. |
project
| Project!
| Target project of the timelog merge request or issue. |
spentAt
| Time
| Timestamp of when the time tracked was spent at. |
summary
| String
| Summary of how the time was spent. |
timeSpent
| Int!
| Time spent displayed in seconds. |
user
| UserCore!
| User that logged the time. |
userPermissions
| TimelogPermissions!
| Permissions for the current user on the resource. |
TimelogPermissions
Fields
Name | Type | Description |
---|---|---|
adminTimelog
| Boolean!
| If true , the user can perform admin_timelog on this resource.
|
Todo
Representing a to-do entry.
Fields
Name | Type | Description |
---|---|---|
action
| TodoActionEnum!
| Action of the to-do item. |
author
| UserCore!
| Author of this to-do item. |
body
| String!
| Body of the to-do item. |
createdAt
| Time!
| Timestamp this to-do item was created. |
group
| Group
| Group this to-do item is associated with. |
id
| ID!
| ID of the to-do item. |
note
| Note
| Note which created this to-do item. |
project
| Project
| Project this to-do item is associated with. |
state
| TodoStateEnum!
| State of the to-do item. |
target
| Todoable!
| Target of the to-do item. |
targetType
| TodoTargetEnum!
| Target type of the to-do item. |
Topic
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL to avatar image file of the topic. |
description
| String
| Description of the topic. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
id
| ID!
| ID of the topic. |
name
| String!
| Name of the topic. |
title
| String!
| Title of the topic. |
Tree
Fields
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). |
UnprotectAccessLevel
Defines which user roles, users, or groups can unprotect a protected branch.
Fields
Name | Type | Description |
---|---|---|
accessLevel
| Int!
| GitLab::Access level. |
accessLevelDescription
| String!
| Human readable representation for this access level. |
group
| AccessLevelGroup
| Group associated with this access level. |
user
| AccessLevelUser
| User associated with this access level. |
UploadRegistry
Represents the Geo replication and verification state of an upload.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp when the UploadRegistry was created. |
fileId
| ID!
| ID of the Upload. |
id
| ID!
| ID of the UploadRegistry. |
lastSyncFailure
| String
| Error message during sync of the UploadRegistry. |
lastSyncedAt
| Time
| Timestamp of the most recent successful sync of the UploadRegistry. |
retryAt
| Time
| Timestamp after which the UploadRegistry is resynced. |
retryCount
| Int
| Number of consecutive failed sync attempts of the UploadRegistry. |
state
| RegistryState
| Sync state of the UploadRegistry. |
verificationChecksum
| String
| The local checksum of the UploadRegistry. |
verificationFailure
| String
| Error message during verification of the UploadRegistry. |
verificationRetryAt
| Time
| Timestamp after which the UploadRegistry is reverified. |
verificationRetryCount
| Int
| Number of consecutive failed verification attempts of the UploadRegistry. |
verificationStartedAt
| Time
| Timestamp when the verification started of UploadRegistry. |
verificationState
| VerificationStateEnum
| Verification state of the UploadRegistry. |
verifiedAt
| Time
| Timestamp of the most recent successful verification of the UploadRegistry. |
UsageTrendsMeasurement
Represents a recorded measurement (object count) for the Admins.
Fields
Name | Type | Description |
---|---|---|
count
| Int!
| Object count. |
identifier
| MeasurementIdentifier!
| Type of objects being measured. |
recordedAt
| Time
| Time the measurement was recorded. |
UserAchievement
Fields
Name | Type | Description |
---|---|---|
achievement
| Achievement!
| Achievement awarded. |
awardedByUser
| UserCore!
| Awarded by. |
createdAt
| Time!
| Timestamp the achievement was created. |
id
| AchievementsUserAchievementID!
| ID of the user achievement. |
priority
| Int
| Priority of the user achievement. |
revokedAt
| Time
| Timestamp the achievement was revoked. |
revokedByUser
| UserCore
| Revoked by. |
updatedAt
| Time!
| Timestamp the achievement was last updated. |
user
| UserCore!
| Achievement recipient. |
UserAddOnAssignment
An assignment of an AddOnPurchase to a User.
Fields
Name | Type | Description |
---|---|---|
addOnPurchase
| AddOnPurchase!
| Add-on purchase the user is assigned to. |
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 representation of a GitLab user.
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
UserCore.assignedMergeRequests
Merge requests assigned to the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
UserCore.authoredMergeRequests
Merge requests authored by the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
UserCore.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
UserCore.reviewRequestedMergeRequests
Merge requests assigned to the user for review.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
UserCore.savedReply
Saved reply authored by the user.
Returns SavedReply
.
Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
UserCore.snippets
Snippets authored by the user.
Returns SnippetConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
UserCore.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
UserCore.workspaces
Workspaces owned by the current user.
Returns WorkspaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
actualStates
| [String!]
| Filter workspaces by actual states. |
agentIds
| [ClustersAgentID!]
| Filter workspaces by agent GlobalIDs. |
ids
| [RemoteDevelopmentWorkspaceID!]
| Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"] .
|
includeActualStates | [String!]
| Deprecated in 16.7. Use actual_states instead. |
projectIds
| [ProjectID!]
| Filter workspaces by project GlobalIDs. |
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
| 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!
| If true , the user can perform create_snippet on this resource.
|
UserPreferences
Fields
Name | Type | Description |
---|---|---|
issuesSort
| IssueSort
| Sort order for issue lists. |
useWebIdeExtensionMarketplace
| Boolean!
| Whether Web IDE Extension Marketplace is enabled for the user. |
visibilityPipelineIdType
| VisibilityPipelineIdType
| Determines whether the pipeline list shows ID or IID. |
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. |
ValueStream
Fields
Name | Type | Description |
---|---|---|
id
| AnalyticsCycleAnalyticsValueStreamID!
| ID of the value stream. |
name
| String!
| Name of the value stream. |
namespace
| Namespace!
| Namespace the value stream belongs to. |
project | Project
| Introduced in 15.6. This feature is an Experiment. It can be changed or removed at any time. Project the value stream belongs to, returns empty if it belongs to a group. |
stages
| [ValueStreamStage!]
| Value Stream stages. |
ValueStreamAnalyticsMetric
Fields
Name | Type | Description |
---|---|---|
identifier
| String!
| Identifier for the metric. |
links
| [ValueStreamMetricLinkType!]!
| Optional links for drilling down. |
title
| String!
| Title for the metric. |
unit
| String
| Unit of measurement. |
value
| Float
| Value for the metric. |
ValueStreamDashboardCount
Represents a recorded measurement (object count) for the requested group.
Fields
Name | Type | Description |
---|---|---|
count
| Int
| Object count. |
identifier
| ValueStreamDashboardMetric!
| Type of object being measured. |
recordedAt
| Time
| Time the measurement was taken. |
ValueStreamMetricLinkType
Fields
Name | Type | Description |
---|---|---|
docsLink
| Boolean
| Link to the metric documentation. |
label
| String!
| Label for the link. |
name
| String!
| Name of the link group. |
url
| String!
| Drill-down URL. |
ValueStreamStage
Fields
Name | Type | Description |
---|---|---|
custom
| Boolean!
| Whether the stage is customized. |
endEventIdentifier
| ValueStreamStageEvent!
| End event identifier. |
endEventLabel
| Label
| Label associated with end event. |
hidden
| Boolean!
| Whether the stage is hidden. |
name
| String!
| Name of the stage. |
startEventIdentifier
| ValueStreamStageEvent!
| Start event identifier. |
startEventLabel
| Label
| Label associated with start event. |
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 |
---|---|---|
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
confirmedAt
| Time
| Timestamp of when the vulnerability state was changed to confirmed. |
confirmedBy
| UserCore
| User that confirmed the vulnerability. |
description
| String
| Description of the vulnerability. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
details
| [VulnerabilityDetail!]!
| Details of the vulnerability. |
detectedAt
| Time!
| Timestamp of when the vulnerability was first detected. |
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
dismissalReason
| VulnerabilityDismissalReason
| Reason for dismissal. Returns null for states other than dismissed .
|
dismissedAt
| Time
| Timestamp of when the vulnerability state was changed to dismissed. |
dismissedBy
| UserCore
| User that dismissed the vulnerability. |
externalIssueLinks
| VulnerabilityExternalIssueLinkConnection!
| List of external issue links related to the vulnerability. (see Connections) |
falsePositive
| Boolean
| Indicates whether the vulnerability is a false positive. |
hasRemediations
| Boolean
| Indicates whether there is a remediation available for this vulnerability. |
hasSolutions | Boolean
|
Deprecated in 16.3. Use hasRemediations .
|
id
| ID!
| GraphQL ID of the vulnerability. |
identifiers
| [VulnerabilityIdentifier!]!
| Identifiers of the vulnerability. |
links
| [VulnerabilityLink!]!
| List of links associated with 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. |
message | String
| Deprecated in 16.1. message field has been removed from security reports schema. |
presentOnDefaultBranch
| Boolean!
| Indicates whether the vulnerability is present on the default branch or not. |
primaryIdentifier
| VulnerabilityIdentifier
| Primary identifier of the vulnerability. |
project
| Project
| 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, CLUSTER_IMAGE_SCANNING, GENERIC). Scan Type in the UI.
|
resolvedAt
| Time
| Timestamp of when the vulnerability state was changed to resolved. |
resolvedBy
| UserCore
| 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). |
solution
| String
| Recommended solution for the vulnerability. |
state
| VulnerabilityState
| State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED). |
stateComment
| String
| Comment given for the vulnerability state change. |
stateTransitions
| VulnerabilityStateTransitionTypeConnection
| List of state transitions related to the vulnerability. (see Connections) |
title
| String
| Title of the vulnerability. |
updatedAt
| Time
| Timestamp of when the vulnerability was last updated. |
userNotesCount
| Int!
| Number of user notes attached to the vulnerability. |
userPermissions
| VulnerabilityPermissions!
| Permissions for the current user on the resource. |
uuid
| String!
| UUID of the vulnerability finding. Can be used to look up the associated security report finding. |
vulnerabilityPath
| String
| Path to the vulnerability’s details page. |
webUrl
| 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
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
linkType
| VulnerabilityIssueLinkType
| Filter issue links by link type. |
Vulnerability.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
VulnerabilityContainerImage
Represents a container image reported on the related vulnerability.
Fields
Name | Type | Description |
---|---|---|
name
| String
| Name of the container image. |
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!
| 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. |
VulnerabilityDetailNamedList
Represents the vulnerability details named list.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
items | [VulnerabilityDetailNamedListItem!]!
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Named list of details. |
name
| String
| Name of the field. |
VulnerabilityDetailNamedListItem
Represents the vulnerability details named list item.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
value | VulnerabilityDetail!
| Introduced in 16.1. This feature is an Experiment. It can be changed or removed at any time. Value of the field. |
VulnerabilityDetailRow
Represents an individual row in a table.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the field. |
fieldName
| String
| Name of the field. |
name
| String
| Name of the field. |
row
| [VulnerabilityDetail!]!
| Value of the field. |
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
| [VulnerabilityDetailRow!]!
| 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. |
VulnerabilityEvidence
Represents a Vulnerability Evidence.
Fields
Name | Type | Description |
---|---|---|
request
| VulnerabilityRequest
| HTTP request of the Vulnerability Evidence. |
response
| VulnerabilityResponse
| HTTP response of the Vulnerability Evidence. |
source
| VulnerabilityEvidenceSource
| Source of the Vulnerability Evidence. |
summary
| String
| Summary of the Vulnerability Evidence. |
supportingMessages
| [VulnerabilityEvidenceSupportingMessage!]
| Supporting messages of the Vulnerability Evidence. |
VulnerabilityEvidenceSource
Represents a vulnerability evidence.
Fields
Name | Type | Description |
---|---|---|
identifier
| String!
| ID of the Vulnerability Evidence Source. |
name
| String!
| Name of the Vulnerability Evidence Source. |
url
| String
| URL of the Vulnerability Evidence Source. |
VulnerabilityEvidenceSupportingMessage
Represents a vulnerability evidence supporting message.
Fields
Name | Type | Description |
---|---|---|
name
| String!
| Name of the vulnerability supporting message. |
request
| VulnerabilityRequest
| HTTP request of the vulnerability evidence supporting message. |
response
| VulnerabilityResponse
| HTTP response of the vulnerability evidence supporting message. |
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
| Issue attached to issue link. |
linkType
| VulnerabilityIssueLinkType!
| Type of the issue link. |
VulnerabilityLink
Represents a link related to a vulnerability.
Fields
Name | Type | Description |
---|---|---|
name
| String
| Name of the link. |
url
| String!
| URL of the link. |
VulnerabilityLocationClusterImageScanning
Represents the location of a vulnerability found by a cluster image scan.
Fields
Name | Type | Description |
---|---|---|
dependency
| VulnerableDependency
| Dependency containing the vulnerability. |
image
| String
| Name of the vulnerable container image. |
kubernetesResource
| VulnerableKubernetesResource
| Kubernetes resource which uses the vulnerable container image. |
operatingSystem
| String
| Operating system that runs on the vulnerable container image. |
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. |
crashAddress
| String
| Relative address in memory were the crash occurred. |
crashType
| String
| Type of the crash. |
endLine
| String
| Number of the last relevant line in the vulnerable file. |
file
| String
| Path to the vulnerable file. |
stacktraceSnippet
| String
| Stack trace recorded during fuzzing resulting the crash. |
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. |
VulnerabilityLocationGeneric
Represents the location of a vulnerability found by a generic scanner.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Free-form description of where the vulnerability is located. |
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!
| If true , the user can perform admin_vulnerability on this resource.
|
adminVulnerabilityExternalIssueLink
| Boolean!
| If true , the user can perform admin_vulnerability_external_issue_link on this resource.
|
adminVulnerabilityIssueLink
| Boolean!
| If true , the user can perform admin_vulnerability_issue_link on this resource.
|
createVulnerabilityExport
| Boolean!
| If true , the user can perform create_vulnerability_export on this resource.
|
createVulnerabilityFeedback
| Boolean!
| If true , the user can perform create_vulnerability_feedback on this resource.
|
destroyVulnerabilityFeedback
| Boolean!
| If true , the user can perform destroy_vulnerability_feedback on this resource.
|
readVulnerability
| Boolean!
| If true , the user can perform read_vulnerability on this resource.
|
readVulnerabilityFeedback
| Boolean!
| If true , the user can perform read_vulnerability_feedback on this resource.
|
updateVulnerabilityFeedback
| Boolean!
| If true , the user can perform update_vulnerability_feedback on this resource.
|
VulnerabilityRemediationType
Represents a vulnerability remediation type.
Fields
Name | Type | Description |
---|---|---|
diff
| String
| Diff of the remediation. |
summary
| String
| Summary of the remediation. |
VulnerabilityRequest
Represents a Vulnerability Request.
Fields
Name | Type | Description |
---|---|---|
body
| String
| Body of the Vulnerability Request. |
headers
| [VulnerabilityRequestResponseHeader!]!
| HTTP headers of the Vulnerability Request. |
method
| String
| Method of the Vulnerability Request. |
url
| String
| URL of the Vulnerability Request. |
VulnerabilityRequestResponseHeader
Represents a Vulnerability Request/Response Header.
Fields
Name | Type | Description |
---|---|---|
name
| String
| Name of the Vulnerability Request/Response Header. |
value
| String
| Value of the Vulnerability Request/Response Header. |
VulnerabilityResponse
Represents a Vulnerability Response.
Fields
Name | Type | Description |
---|---|---|
body
| String
| Body of the Vulnerability Response. |
headers
| [VulnerabilityRequestResponseHeader!]!
| HTTP headers of the Vulnerability Response. |
reasonPhrase
| String
| Reason Phrase of the Vulnerability Response. |
statusCode
| Int
| Status Code of the Vulnerability Response. |
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. |
reportTypeHumanized
| String
| Humanized 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. |
VulnerabilityStateTransitionType
Represents a state transition of a vulnerability.
Fields
Name | Type | Description |
---|---|---|
author
| UserCore
| User who changed the state of the vulnerability. |
comment
| String
| Comment for the state change. |
createdAt
| Time!
| Time of the state change of the vulnerability. |
dismissalReason
| VulnerabilityDismissalReason
| Reason for the dismissal. |
fromState
| VulnerabilityState!
| State of the vulnerability before transition. |
toState
| VulnerabilityState!
| State of the vulnerability after transition. |
VulnerableDependency
Represents a vulnerable dependency. Used in vulnerability location data.
Fields
Name | Type | Description |
---|---|---|
package
| VulnerablePackage
| Package associated with the vulnerable dependency. |
version
| String
| Version of the vulnerable dependency. |
VulnerableKubernetesResource
Represents a vulnerable Kubernetes resource. Used in vulnerability location data.
Fields
Name | Type | Description |
---|---|---|
agent
| ClusterAgent
| Kubernetes Agent which performed the scan. |
clusterId
| ClustersClusterID
| ID of the Cluster integration which was used to perform the scan. |
containerName
| String!
| Name of the container that had its image scanned. |
kind
| String!
| Kind of the Kubernetes resource. |
name
| String!
| Name of the Kubernetes resource. |
namespace
| String!
| Kubernetes namespace which the resource resides in. |
VulnerablePackage
Represents a vulnerable package. Used in vulnerability dependency data.
Fields
Name | Type | Description |
---|---|---|
name
| String
| 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) |
WorkItem
Fields
Name | Type | Description |
---|---|---|
archived | Boolean!
| Introduced in 16.5. This feature is an Experiment. It can be changed or removed at any time. Whether the work item belongs to an archived project. Always false for group level work items. |
author | UserCore
| Introduced in 15.9. This feature is an Experiment. It can be changed or removed at any time. User that created the work item. |
closedAt
| Time
| Timestamp of when the work item was closed. |
confidential
| Boolean!
| Indicates the work item is confidential. |
createNoteEmail
| String
| User specific email address for the work item. |
createdAt
| Time!
| Timestamp of when the work item was created. |
description
| String
| Description of the work item. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
id
| WorkItemID!
| Global ID of the work item. |
iid
| ID!
| Internal ID of the work item. |
lockVersion
| Int!
| Lock version of the work item. Incremented each time the work item is updated. |
namespace | Namespace
| Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Namespace the work item belongs to. |
project | Project
| Introduced in 15.3. This feature is an Experiment. It can be changed or removed at any time. Project the work item belongs to. |
state
| WorkItemState!
| State of the work item. |
title
| String!
| Title of the work item. |
titleHtml
| String
| GitLab Flavored Markdown rendering of title .
|
updatedAt
| Time!
| Timestamp of when the work item was last updated. |
userPermissions
| WorkItemPermissions!
| Permissions for the current user on the resource. |
webUrl
| String
| URL of this object. |
widgets
| [WorkItemWidget!]
| Collection of widgets that belong to the work item. |
workItemType
| WorkItemType!
| Type assigned to the work item. |
Fields with arguments
WorkItem.reference
Internal reference of the work item. Returned in shortened format by default.
Returns String!
.
Arguments
Name | Type | Description |
---|---|---|
full
| Boolean
| Boolean option specifying whether the reference should be returned in full. |
WorkItemPermissions
Check permissions for the current user on a work item.
Fields
Name | Type | Description |
---|---|---|
adminParentLink
| Boolean!
| If true , the user can perform admin_parent_link on this resource.
|
adminWorkItem
| Boolean!
| If true , the user can perform admin_work_item on this resource.
|
adminWorkItemLink
| Boolean!
| If true , the user can perform admin_work_item_link on this resource.
|
createNote
| Boolean!
| If true , the user can perform create_note on this resource.
|
deleteWorkItem
| Boolean!
| If true , the user can perform delete_work_item on this resource.
|
readWorkItem
| Boolean!
| If true , the user can perform read_work_item on this resource.
|
setWorkItemMetadata
| Boolean!
| If true , the user can perform set_work_item_metadata on this resource.
|
updateWorkItem
| Boolean!
| If true , the user can perform update_work_item on this resource.
|
WorkItemStateCountsType
Represents total number of work items for the represented states.
Fields
Name | Type | Description |
---|---|---|
all
| Int
| Number of work items for the project or group. |
closed
| Int
| Number of work items with state CLOSED for the project or group. |
opened
| Int
| Number of work items with state OPENED for the project or group. |
WorkItemType
Fields
Name | Type | Description |
---|---|---|
iconName
| String
| Icon name of the work item type. |
id
| WorkItemsTypeID!
| Global ID of the work item type. |
name
| String!
| Name of the work item type. |
widgetDefinitions | [WorkItemWidgetDefinition!]
| Introduced in 16.7. This feature is an Experiment. It can be changed or removed at any time. Available widgets for the work item type. |
WorkItemWidgetAssignees
Represents an assignees widget.
Fields
Name | Type | Description |
---|---|---|
allowsMultipleAssignees | Boolean
|
Deprecated in 16.7. Field moved to workItemType widget definition interface. Use: workitemWidgetDefinitionAssignees.allowsMultipleAssignees .
|
assignees
| UserCoreConnection
| Assignees of the work item. (see Connections) |
canInviteMembers | Boolean!
|
Deprecated in 16.7. Field moved to workItemType widget definition interface. Use: workitemWidgetDefinitionAssignees.canInviteMembers .
|
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetAwardEmoji
Represents the emoji reactions widget.
Fields
Name | Type | Description |
---|---|---|
awardEmoji
| AwardEmojiConnection
| Emoji reactions on the work item. (see Connections) |
downvotes
| Int!
| Number of downvotes the work item has received. |
type
| WorkItemWidgetType
| Widget type. |
upvotes
| Int!
| Number of upvotes the work item has received. |
WorkItemWidgetCurrentUserTodos
Represents a todos widget.
Fields
Name | Type | Description |
---|---|---|
type
| WorkItemWidgetType
| Widget type. |
Fields with arguments
WorkItemWidgetCurrentUserTodos.currentUserTodos
To-do items for the current user.
Returns TodoConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
WorkItemWidgetDefinitionAssignees
Represents an assignees widget definition.
Fields
Name | Type | Description |
---|---|---|
allowsMultipleAssignees
| Boolean!
| Indicates whether multiple assignees are allowed. |
canInviteMembers
| Boolean!
| Indicates whether the current user can invite members to the work item’s parent. |
type
| WorkItemWidgetType!
| Widget type. |
WorkItemWidgetDefinitionGeneric
Represents a generic widget definition.
Fields
Name | Type | Description |
---|---|---|
type
| WorkItemWidgetType!
| Widget type. |
WorkItemWidgetDefinitionHierarchy
Represents a hierarchy widget definition.
Fields
Name | Type | Description |
---|---|---|
allowedChildTypes
| WorkItemTypeConnection
| Allowed child types for the work item type. (see Connections) |
type
| WorkItemWidgetType!
| Widget type. |
WorkItemWidgetDefinitionLabels
Represents a labels widget definition.
Fields
Name | Type | Description |
---|---|---|
allowsScopedLabels
| Boolean!
| Indicates whether scoped labels are available. |
type
| WorkItemWidgetType!
| Widget type. |
WorkItemWidgetDescription
Represents a description widget.
Fields
Name | Type | Description |
---|---|---|
description
| String
| Description of the work item. |
descriptionHtml
| String
| GitLab Flavored Markdown rendering of description .
|
edited
| Boolean!
| Whether the description has been edited since the work item was created. |
lastEditedAt
| Time
| Timestamp of when the work item’s description was last edited. |
lastEditedBy
| UserCore
| User that made the last edit to the work item’s description. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetHealthStatus
Represents a health status widget.
Fields
Name | Type | Description |
---|---|---|
healthStatus
| HealthStatus
| Health status of the work item. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetHierarchy
Represents a hierarchy widget.
Fields
Name | Type | Description |
---|---|---|
ancestors
| WorkItemConnection
| Ancestors (parents) of the work item. (see Connections) |
children
| WorkItemConnection
| Child work items. (see Connections) |
hasChildren
| Boolean!
| Indicates if the work item has children. |
parent
| WorkItem
| Parent work item. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetIteration
Represents an iteration widget.
Fields
Name | Type | Description |
---|---|---|
iteration
| Iteration
| Iteration of the work item. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetLabels
Represents the labels widget.
Fields
Name | Type | Description |
---|---|---|
allowsScopedLabels | Boolean
|
Deprecated in 16.7. Field moved to workItemType widget definition interface. Use: WorkItemWidgetDefinitionLabels.allowsScopedLabels .
|
labels
| LabelConnection
| Labels assigned to the work item. (see Connections) |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetLinkedItems
Represents the linked items widget.
Fields
Name | Type | Description |
---|---|---|
blocked
| Boolean
| Indicates the work item is blocked. Returns null if linked_work_items feature flag is disabled.
|
blockedByCount
| Int
| Count of items blocking the work item. Returns null if linked_work_items feature flag is disabled.
|
blockingCount
| Int
| Count of items the work item is blocking. Returns null if linked_work_items feature flag is disabled.
|
type
| WorkItemWidgetType
| Widget type. |
Fields with arguments
WorkItemWidgetLinkedItems.linkedItems
Linked items for the work item. Returns null
if linked_work_items
feature flag is disabled.
Returns LinkedWorkItemTypeConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| WorkItemRelatedLinkType
| Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted. |
WorkItemWidgetMilestone
Represents a milestone widget.
Fields
Name | Type | Description |
---|---|---|
milestone
| Milestone
| Milestone of the work item. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetNotes
Represents a notes widget.
Fields
Name | Type | Description |
---|---|---|
type
| WorkItemWidgetType
| Widget type. |
Fields with arguments
WorkItemWidgetNotes.discussions
Notes on this work item.
Returns DiscussionConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
WorkItemWidgetNotifications
Represents the notifications widget.
Fields
Name | Type | Description |
---|---|---|
subscribed
| Boolean!
| Whether the current user is subscribed to notifications on the work item. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetProgress
Represents a progress widget.
Fields
Name | Type | Description |
---|---|---|
currentValue
| Int
| Current value of the work item. |
endValue
| Int
| End value of the work item. |
progress
| Int
| Progress of the work item. |
startValue
| Int
| Start value of the work item. |
type
| WorkItemWidgetType
| Widget type. |
updatedAt
| Time
| Timestamp of last progress update. |
WorkItemWidgetRequirementLegacy
Represents a legacy requirement widget.
Fields
Name | Type | Description |
---|---|---|
legacyIid | Int
| Deprecated in 15.9. Use Work Item IID instead. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetStartAndDueDate
Represents a start and due date widget.
Fields
Name | Type | Description |
---|---|---|
dueDate
| Date
| Due date of the work item. |
startDate
| Date
| Start date of the work item. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetStatus
Represents a status widget.
Fields
Name | Type | Description |
---|---|---|
status
| String
| Status of the work item. |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetTestReports
Represents a test reports widget.
Fields
Name | Type | Description |
---|---|---|
testReports
| TestReportConnection
| Test reports of the work item. (see Connections) |
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetWeight
Represents a weight widget.
Fields
Name | Type | Description |
---|---|---|
type
| WorkItemWidgetType
| Widget type. |
weight
| Int
| Weight of the work item. |
Workspace
Represents a remote development workspace.
Fields
Name | Type | Description |
---|---|---|
actualState
| String!
| Actual state of the workspace. |
clusterAgent
| ClusterAgent!
| Kubernetes Agent associated with the workspace. |
createdAt
| Time!
| Timestamp of workspace creation. |
deploymentResourceVersion
| Int
| ResourceVersion of the Deployment resource for the workspace. |
desiredState
| String!
| Desired state of the workspace. |
desiredStateUpdatedAt
| Time!
| Timestamp of last update to desired state. |
devfile
| String!
| Source YAML of the devfile used to configure the workspace. |
devfilePath
| String!
| Project repo git path containing the devfile used to configure the workspace. |
devfileRef
| String!
| Project repo git ref containing the devfile used to configure the workspace. |
editor
| String!
| Editor used to configure the workspace. Must match a configured template. |
id
| RemoteDevelopmentWorkspaceID!
| Global ID of the workspace. |
maxHoursBeforeTermination
| Int!
| Maximum hours the workspace can exist before it is automatically terminated. |
name
| String!
| Name of the workspace in Kubernetes. |
namespace
| String!
| Namespace of the workspace in Kubernetes. |
processedDevfile
| String!
| Processed YAML of the devfile used to configure the workspace. |
projectId
| ID!
| ID of the Project providing the Devfile for the workspace. |
respondedToAgentAt
| Time
| Timestamp of last response sent to GA4K for the workspace. |
updatedAt
| Time!
| Timestamp of last update to any mutable workspace property. |
url
| String!
| URL of the workspace. |
user
| UserCore!
| Owner of the workspace. |
X509Certificate
Represents an X.509 certificate.
Fields
Name | Type | Description |
---|---|---|
certificateStatus
| String!
| Indicates if the certificate is good or revoked. |
createdAt
| Time!
| Timestamp of when the certificate was saved. |
email
| String!
| Email associated with the cerificate. |
id
| ID!
| ID of the certificate. |
serialNumber
| String!
| Serial number of the certificate. |
subject
| String!
| Subject of the certificate. |
subjectKeyIdentifier
| String!
| Subject key identifier of the certificate. |
updatedAt
| Time!
| Timestamp of when the certificate was last updated. |
x509Issuer
| X509Issuer!
| Issuer of the certificate. |
X509Issuer
Issuer of an X.509 certificate.
Fields
Name | Type | Description |
---|---|---|
createdAt
| Time
| Timestamp of when the issuer was created. |
crlUrl
| String
| Certificate revokation list of the issuer. |
id
| ID
| ID of the issuer. |
subject
| String
| Subject of the issuer. |
subjectKeyIdentifier
| String
| Subject key identifier of the issuer. |
updatedAt
| Time
| Timestamp of when the issuer was last updated. |
X509Signature
X.509 signature for a signed commit.
Fields
Name | Type | Description |
---|---|---|
commitSha
| String
| SHA of the associated commit. |
project
| Project
| Project of the associated commit. |
user
| UserCore
| User associated with the key. |
verificationStatus
| VerificationStatus
| Indicates verification status of the associated key or certificate. |
x509Certificate
| X509Certificate
| Certificate used for the signature. |
Enumeration types
Also called Enums, enumeration types are a special kind of scalar that is restricted to a particular set of allowed values.
For more information, see
Enumeration Types
on graphql.org
.
AccessLevelEnum
Access level to a resource.
AgentTokenStatus
Agent token statuses.
Value | Description |
---|---|
ACTIVE
| Active agent token. |
REVOKED
| Revoked agent token. |
AiAction
Action to subscribe to.
Value | Description |
---|---|
CHAT
| Chat action. |
AiMessageRole
Possible message roles for AI features.
Value | Description |
---|---|
ASSISTANT
| assistant message. |
SYSTEM
| system message. |
USER
| user message. |
AiMessageType
Types of messages returned from AI features.
Value | Description |
---|---|
TOOL
| Tool selection message. |
AlertManagementAlertSort
Values for sorting alerts.
AlertManagementDomainFilter
Filters the alerts based on given domain.
Value | Description |
---|---|
operations
| Alerts for operations domain. |
threat_monitoring | Deprecated in 15.0. Network policies are deprecated and will be removed in GitLab 16.0. |
AlertManagementIntegrationType
Values of types of integrations.
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.
Value | Description |
---|---|
ACKNOWLEDGED
| Someone is actively investigating the problem. |
IGNORED
| No action will be taken. |
RESOLVED
| The problem has been addressed. |
TRIGGERED
| Investigation has not started. |
ApiFuzzingScanMode
All possible ways to specify the API surface for an API fuzzing scan.
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. |
ApprovalReportType
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. |
AvailableExportFields
Available fields to be exported as CSV.
Value | Description |
---|---|
AUTHOR
| Author name. |
AUTHOR_USERNAME
| Author username. |
CREATED_AT
| Date of creation. |
DESCRIPTION
| Description. |
ID
| Unique identifier. |
TITLE
| Title. |
TYPE
| Type of the work item. |
BlobViewersType
Types of blob viewers.
Value | Description |
---|---|
auxiliary
| Auxiliary blob viewers type. |
rich
| Rich blob viewers type. |
simple
| Simple blob viewers type. |
CiCatalogResourceScope
Values for scoping catalog resources.
Value | Description |
---|---|
ALL
| All catalog resources visible to the current user. |
NAMESPACES
| Catalog resources belonging to authorized namespaces of the user. |
CiCatalogResourceSort
Values for sorting catalog resources.
CiCatalogResourceVersionSort
Values for sorting catalog resource versions.
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. |
CiConfigIncludeType
Include type.
Value | Description |
---|---|
component
| Component include. |
file
| Project file include. |
local
| Local include. |
remote
| Remote include. |
template
| Template include. |
CiConfigStatus
Values for YAML processor result.
Value | Description |
---|---|
INVALID
| Configuration file is not valid. |
VALID
| Configuration file is valid. |
CiFreezePeriodStatus
Deploy freeze period status.
Value | Description |
---|---|
ACTIVE
| Freeze period is active. |
INACTIVE
| Freeze period is inactive. |
CiGroupVariablesSort
Values for sorting inherited variables.
Value | Description |
---|---|
CREATED_ASC
| Created at ascending order. |
CREATED_DESC
| Created at descending order. |
KEY_ASC
| Key by ascending order. |
KEY_DESC
| Key by descending order. |
CiJobFailureReason
CiJobKind
Value | Description |
---|---|
BRIDGE
| Bridge CI job connecting a parent and child pipeline. |
BUILD
| Standard CI job. |
CiJobStatus
CiJobTokenScopeDirection
Direction of access.
CiRunnerAccessLevel
Value | Description |
---|---|
NOT_PROTECTED
| A runner that is not protected. |
REF_PROTECTED
| A runner that is ref protected. |
CiRunnerJobExecutionStatus
CiRunnerMembershipFilter
Values for filtering runners in namespaces. The previous type name RunnerMembershipFilter
was deprecated in 15.4.
CiRunnerSort
Values for sorting runners.
CiRunnerStatus
Value | Description |
---|---|
ACTIVE |
Deprecated in 14.6. This was renamed. Use: CiRunner.paused .
|
NEVER_CONTACTED
| Runner that has never contacted this instance. |
OFFLINE
| Runner that has not contacted this instance within the last 2 hours. Will be considered STALE if offline for more than 3 months.
|
ONLINE
| Runner that contacted this instance within the last 2 hours. |
PAUSED |
Deprecated in 14.6. This was renamed. Use: CiRunner.paused .
|
STALE
| Runner that has not contacted this instance within the last 3 months. |
CiRunnerType
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. |
CiRunnerUpgradeStatus
CiVariableSort
Values for sorting variables.
Value | Description |
---|---|
KEY_ASC
| Sorted by key in ascending order. |
KEY_DESC
| Sorted by key in descending order. |
CiVariableType
Value | Description |
---|---|
ENV_VAR
| Env var type. |
FILE
| File type. |
CodeQualityDegradationSeverity
CodequalityReportsComparerReportGenerationStatus
Represents the generation status of the compared codequality report.
Value | Description |
---|---|
ERROR
| An error happened while generating the report. |
PARSED
| Report was generated. |
PARSING
| Report is being generated. |
CodequalityReportsComparerStatus
Represents the state of the code quality report.
Value | Description |
---|---|
FAILED
| Report generated and there are new code quality degradations. |
NOT_FOUND
| Head report or base report not found. |
SUCCESS
| No degradations found in the head pipeline report. |
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. |
ComparableSecurityReportType
Comparable security report type.
ComplianceFrameworkPresenceFilter
ComplianceFramework of a project for filtering.
Value | Description |
---|---|
ANY
| Any compliance framework is assigned. |
NONE
| No compliance framework is assigned. |
ComplianceStandardsAdherenceCheckName
Name of the check for the compliance standard.
ComplianceStandardsAdherenceStandard
Name of the compliance standard.
Value | Description |
---|---|
GITLAB
| Gitlab. |
ComplianceStandardsAdherenceStatus
Status of the compliance standards adherence.
Value | Description |
---|---|
FAIL
| Fail. |
SUCCESS
| Success. |
ComplianceViolationReason
Reason for the compliance violation.
Value | Description |
---|---|
APPROVED_BY_COMMITTER
| Approved by committer. |
APPROVED_BY_INSUFFICIENT_USERS
| Approved by insufficient users. |
APPROVED_BY_MERGE_REQUEST_AUTHOR
| Approved by merge request author. |
ComplianceViolationSeverity
Severity of the compliance violation.
Value | Description |
---|---|
CRITICAL
| Critical severity. |
HIGH
| High severity. |
INFO
| Info severity. |
LOW
| Low severity. |
MEDIUM
| Medium severity. |
ComplianceViolationSort
Compliance violation sort values.
ConanMetadatumFileTypeEnum
Conan file types.
Value | Description |
---|---|
PACKAGE_FILE
| A package file type. |
RECIPE_FILE
| A recipe file type. |
ContactSort
Values for sorting contacts.
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
ContainerRegistryProtectionRuleAccessLevel
Access level of a container registry protection rule resource.
Value | Description |
---|---|
DEVELOPER
| Developer access. |
MAINTAINER
| Maintainer access. |
OWNER
| Owner access. |
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_ONGOING
| Delete Ongoing status. |
DELETE_SCHEDULED
| Delete Scheduled status. |
ContainerRepositoryTagSort
Values for sorting tags.
Value | Description |
---|---|
NAME_ASC
| Ordered by name in ascending order. |
NAME_DESC
| Ordered by name in descending order. |
CustomerRelationsContactState
Value | Description |
---|---|
active
| Active contacts. |
all
| All available contacts. |
inactive
| Inactive contacts. |
CustomerRelationsOrganizationState
Value | Description |
---|---|
active
| Active organizations. |
all
| All available organizations. |
inactive
| Inactive organizations. |
CustomizableDashboardCategory
Categories for customizable dashboards.
Value | Description |
---|---|
ANALYTICS
| Analytics category for customizable dashboards. |
DastPreScanVerificationCheckType
Check type of the pre scan verification step.
Value | Description |
---|---|
AUTHENTICATION
| Authentication check. |
CONNECTION
| Connection check. |
CRAWLING
| Crawling check. |
DastPreScanVerificationStatus
Status of DAST pre scan verification.
DastProfileCadenceUnit
Unit for the duration of Dast Profile Cadence.
Value | Description |
---|---|
DAY
| DAST Profile Cadence duration in days. |
MONTH
| DAST Profile Cadence duration in months. |
WEEK
| DAST Profile Cadence duration in weeks. |
YEAR
| DAST Profile Cadence duration in years. |
DastScanMethodType
Scan method to be used by the scanner.
Value | Description |
---|---|
GRAPHQL
| GraphQL scan method. |
HAR
| HAR scan method. |
OPENAPI
| OpenAPI scan method. |
POSTMAN_COLLECTION
| Postman scan method. |
WEBSITE
| Website scan method. |
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
DastSiteValidationStatusEnum
DastSiteValidationStrategyEnum
Value | Description |
---|---|
HEADER
| Header validation. |
META_TAG
| Meta tag 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.
DependencyProxyManifestStatus
DependencySort
Values for sorting dependencies.
DeploymentApprovalSummaryStatus
Status of the deployment approval summary.
DeploymentStatus
All deployment statuses.
DeploymentTier
All environment deployment tiers.
Value | Description |
---|---|
DEVELOPMENT
| Development. |
OTHER
| Other. |
PRODUCTION
| Production. |
STAGING
| Staging. |
TESTING
| Testing. |
DeploymentsApprovalStatus
Status of the deployment approval.
Value | Description |
---|---|
APPROVED
| A deployment approval that is approved. |
REJECTED
| A deployment approval that is rejected. |
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. |
DetailedMergeStatus
Detailed representation of whether a GitLab merge request can be merged.
DiffPositionType
Type of file the position refers to.
Value | Description |
---|---|
file
| Unknown file type. |
image
| An image. |
text
| Text file. |
DoraMetricBucketingInterval
All possible ways that DORA metrics can be aggregated.
Value | Description |
---|---|
ALL
| All data points are combined into a single value. |
DAILY
| Data points are combined into chunks by day. |
MONTHLY
| Data points are combined into chunks by month. |
DoraMetricType
All supported DORA metric types.
Value | Description |
---|---|
CHANGE_FAILURE_RATE
| Change failure rate. |
DEPLOYMENT_FREQUENCY
| Deployment frequency. |
LEAD_TIME_FOR_CHANGES
| Lead time for changes. |
TIME_TO_RESTORE_SERVICE
| Time to restore service. |
EntryType
Type of a tree entry.
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.
FindingReportsComparerStatus
Report comparison status.
Value | Description |
---|---|
ERROR
| An error happened while generating the report. |
PARSED
| Report was generated. |
PARSING
| Report is being generated. |
ForecastStatus
List of statuses for forecasting model.
Value | Description |
---|---|
READY
| Forecast is ready. |
UNAVAILABLE
| Forecast is unavailable. |
GeoRegistriesBulkAction
Action to trigger on multiple Geo registries.
Value | Description |
---|---|
RESYNC_ALL
| Resync multiple registries. |
REVERIFY_ALL
| Reverify multiple registries. |
GeoRegistryAction
Action to trigger on an individual Geo registry.
Value | Description |
---|---|
RESYNC
| Resync a registry. |
REVERIFY
| Reverify a registry. |
GeoRegistryClass
Geo registry class.
GitlabSubscriptionsAddOnType
Types of add-ons.
Value | Description |
---|---|
CODE_SUGGESTIONS
| Code suggestions seat add-on. |
GitlabSubscriptionsUserRole
Role of User.
Value | Description |
---|---|
DEVELOPER
| Developer. |
GUEST
| Guest. |
MAINTAINER
| Maintainer. |
OWNER
| Owner. |
REPORTER
| Reporter. |
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. |
SHARED_FROM_GROUPS
| Invited group’s members. |
GroupPermission
User permission on groups.
GroupReleaseSort
Values for sorting releases belonging to a group.
Value | Description |
---|---|
RELEASED_AT_ASC
| Released at by ascending order. |
RELEASED_AT_DESC
| Released at by descending order. |
HealthStatus
Health status of an issue or epic.
Value | Description |
---|---|
atRisk
| At risk. |
needsAttention
| Needs attention. |
onTrack
| On track. |
HealthStatusFilter
Health status of an issue or epic for filtering.
Value | Description |
---|---|
ANY
| Any health status is assigned. |
NONE
| No health status is assigned. |
atRisk
| At risk. |
needsAttention
| Needs attention. |
onTrack
| On track. |
IssuableResourceLinkType
Issuable resource link type enum.
Value | Description |
---|---|
general
| General link type. |
pagerduty
| Pagerduty link type. |
slack
| Slack link type. |
zoom
| Zoom link type. |
IssuableSearchableField
Fields to perform the search in.
Value | Description |
---|---|
DESCRIPTION
| Search in description field. |
TITLE
| Search in title field. |
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. |
IssuableSubscriptionEvent
Values for subscribing and unsubscribing from issuables.
Value | Description |
---|---|
SUBSCRIBE
| Subscribe to an issuable. |
UNSUBSCRIBE
| Unsubscribe from an issuable. |
IssueCreationIterationWildcardId
Iteration ID wildcard values for issue creation.
Value | Description |
---|---|
CURRENT
| Current iteration. |
IssueEscalationStatus
Issue escalation status values.
Value | Description |
---|---|
ACKNOWLEDGED
| Someone is actively investigating the problem. |
IGNORED
| No action will be taken. |
RESOLVED
| The problem has been addressed. |
TRIGGERED
| Investigation has not started. |
IssueSort
Values for sorting issues.
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.
IterationSearchableField
Fields to perform the search in.
Value | Description |
---|---|
CADENCE_TITLE
| Search in cadence_title field. |
TITLE
| Search in title field. |
IterationSort
Iteration sort values.
Value | Description |
---|---|
CADENCE_AND_DUE_DATE_ASC
| Sort by cadence id in ascending and due date in ascending order. |
CADENCE_AND_DUE_DATE_DESC
| Sort by cadence id in ascending and due date in descending order. |
IterationState
State of a GitLab iteration.
Value | Description |
---|---|
all
| Any iteration. |
closed
| Closed iteration. |
current
| Current iteration. |
opened
| Open iteration. |
upcoming
| Upcoming iteration. |
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.
MemberAccessLevel
Access level of a group or project member.
Value | Description |
---|---|
DEVELOPER
| Developer access. |
GUEST
| Guest access. |
MAINTAINER
| Maintainer access. |
MINIMAL_ACCESS
| Minimal access. |
OWNER
| Owner access. |
REPORTER
| Reporter access. |
MemberAccessLevelName
Name of access levels of a group or project member.
Value | Description |
---|---|
DEVELOPER
| Developer access. |
GUEST
| Guest access. |
MAINTAINER
| Maintainer access. |
OWNER
| Owner access. |
REPORTER
| Reporter access. |
MemberRolePermission
Member role permission.
MemberSort
Values for sorting members.
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 |
---|---|
REQUESTED_CHANGES
| Merge request reviewer has requested changes. |
REVIEWED
| Merge request reviewer has reviewed. |
UNREVIEWED
| Awaiting review from merge request reviewer. |
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
| Opened merge request. |
MergeStatus
Representation of whether a GitLab merge request can be merged.
MergeStrategyEnum
MergeabilityCheckIdentifier
Representation of mergeability check identifier.
MergeabilityCheckStatus
Representation of whether a mergeability check passed, failed or is inactive.
Value | Description |
---|---|
FAILED
| Mergeability check has failed. The merge request cannot be merged. |
INACTIVE
| Mergeability check is disabled via settings. |
SUCCESS
| Mergeability check has passed. |
MilestoneSort
Values for sorting milestones.
MilestoneStateEnum
Current state of milestone.
Value | Description |
---|---|
active
| Milestone is currently active. |
closed
| Milestone is closed. |
MilestoneWildcardId
Milestone ID wildcard values.
MoveType
The position to which the adjacent object should be moved.
Value | Description |
---|---|
after
| Adjacent object is moved after the object that is being moved. |
before
| Adjacent object is moved before the object that is being moved. |
MutationOperationMode
Different toggles for changing mutator behavior.
Value | Description |
---|---|
APPEND
| Performs an append operation. |
REMOVE
| Performs a removal operation. |
REPLACE
| Performs a replace operation. |
NamespaceProjectSort
Values for sorting projects.
NegatedIterationWildcardId
Negated Iteration ID wildcard values.
Value | Description |
---|---|
CURRENT
| Current iteration. |
NegatedMilestoneWildcardId
Negated Milestone ID wildcard values.
Value | Description |
---|---|
STARTED
| Milestone assigned is open and yet to be started (start date > today). |
UPCOMING
| Milestone assigned is open but due in the past (due date <= today). |
NetworkPolicyKind
Kind of the network policy.
Value | Description |
---|---|
CiliumNetworkPolicy
| Policy kind of Cilium Network Policy. |
NetworkPolicy
| Policy kind of Network Policy. |
NotesFilterType
Work item notes collection type.
Value | Description |
---|---|
ALL_NOTES
| Show all activity. |
ONLY_ACTIVITY
| Show history only. |
ONLY_COMMENTS
| Show comments only. |
OncallRotationUnitEnum
Rotation length unit of an on-call rotation.
Value | Description |
---|---|
DAYS
| Days. |
HOURS
| Hours. |
WEEKS
| Weeks. |
OrganizationGroupSort
Values for sorting organization groups.
OrganizationSort
Values for sorting organizations.
PackageDependencyType
PackageGroupSort
Values for sorting group packages.
PackageManager
Values for package manager.
PackageSort
Values for sorting package.
PackageStatus
PackageTypeEnum
PackagesCleanupKeepDuplicatedPackageFilesEnum
PackagesProtectionRuleAccessLevel
Access level of a package protection rule resource.
Value | Description |
---|---|
DEVELOPER
| Developer access. |
MAINTAINER
| Maintainer access. |
OWNER
| Owner access. |
PackagesProtectionRulePackageType
Package type of a package protection rule resource.
Value | Description |
---|---|
NPM
| Packages of the npm format. |
PipelineConfigSourceEnum
PipelineMergeRequestEventType
Event type of the pipeline associated with a merge request.
PipelineScheduleStatus
Value | Description |
---|---|
ACTIVE
| Active pipeline schedules. |
INACTIVE
| Inactive pipeline schedules. |
PipelineScopeEnum
Value | Description |
---|---|
BRANCHES
| Branches. |
FINISHED
| Pipeline has completed. |
PENDING
| Pipeline has not started running yet. |
RUNNING
| Pipeline is running. |
TAGS
| Tags. |
PipelineStatusEnum
ProductAnalyticsState
Current state of the product analytics stack.
ProjectFeatureAccessLevel
Access level of a project feature.
Value | Description |
---|---|
DISABLED
| Not enabled for anyone. |
ENABLED
| Enabled for everyone able to access the project. |
PRIVATE
| Enabled only for team members. |
ProjectMemberRelation
Project member relation.
Value | Description |
---|---|
DESCENDANTS
| Descendants members. |
DIRECT
| Direct members. |
INHERITED
| Inherited members. |
INVITED_GROUPS
| Invited Groups members. |
SHARED_INTO_ANCESTORS
| Shared Into Ancestors members. |
RefType
Type of ref.
Value | Description |
---|---|
HEADS
| Ref type for branches. |
TAGS
| Ref type for tags. |
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. |
RelativePositionType
The position to which the object should be moved.
Value | Description |
---|---|
AFTER
| Object is moved after an adjacent object. |
BEFORE
| Object is moved before an adjacent object. |
ReleaseAssetLinkType
Type of the link: other
, runbook
, image
, package
.
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. |
ReleaseTagWildcardId
Release tag ID wildcard values.
Value | Description |
---|---|
ANY
| Release tag is assigned. |
NONE
| No release tag is assigned. |
ReplicationStateEnum
RequirementState
State of a requirement.
Value | Description |
---|---|
ARCHIVED
| Archived requirement. |
OPENED
| Open requirement. |
RequirementStatusFilter
Status of a requirement based on last test report.
Value | Description |
---|---|
FAILED
| Failed test report. |
MISSING
| Requirements without any test report. |
PASSED
| Passed test report. |
SastUiComponentSize
Size of UI component in SAST configuration page.
ScanStatus
The status of the security scan.
SecurityPolicyRelationType
SecurityReportTypeEnum
SecurityScannerType
The type of the security scanner.
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
ShaFormat
How to format SHA strings.
Value | Description |
---|---|
LONG
| Unabbreviated format. |
SHORT
| Abbreviated format. Short SHAs are typically eight characters long. |
SharedRunnersSetting
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.
SortDirectionEnum
Values for sort direction.
Value | Description |
---|---|
ASC
| Ascending order. |
DESC
| Descending order. |
TestCaseStatus
TestReportState
State of a test report.
Value | Description |
---|---|
FAILED
| Failed test report. |
PASSED
| Passed test report. |
TimeboxReportErrorReason
Category of error.
TimelogSort
Values for sorting timelogs.
TodoActionEnum
TodoStateEnum
Value | Description |
---|---|
done
| State of the todo is done. |
pending
| State of the todo is pending. |
TodoTargetEnum
Value | Description |
---|---|
ALERT
| Alert. |
COMMIT
| Commit. |
DESIGN
| Design. |
EPIC
| An Epic. |
ISSUE
| Issue. |
MERGEREQUEST
| Merge request. |
WORKITEM
| Work item. |
TrainingUrlRequestStatus
Status of the request to the training provider. The URL of a TrainingUrl is calculated asynchronously. When PENDING, the URL of the TrainingUrl will be null. When COMPLETED, the URL of the TrainingUrl will be available.
Value | Description |
---|---|
COMPLETED
| Completed request. |
PENDING
| Pending request. |
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.
ValueStreamDashboardMetric
Possible identifier types for a measurement.
ValueStreamStageEvent
Stage event identifiers.
VerificationStateEnum
VerificationStatus
Verification status of a GPG or X.509 signature for a commit.
VisibilityLevelsEnum
Value | Description |
---|---|
internal
| Internal visibility level. |
private
| Private visibility level. |
public
| Public visibility level. |
VisibilityPipelineIdType
Determines whether the pipeline list shows ID or IID.
Value | Description |
---|---|
ID
| Display pipeline ID. |
IID
| Display pipeline IID. |
VisibilityScopesEnum
VulnerabilityConfidence
Confidence that a given vulnerability is present in the codebase.
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
| A grade. |
B
| B grade. |
C
| C grade. |
D
| D grade. |
F
| F grade. |
VulnerabilityIssueLinkType
The type of the issue link related to a vulnerability.
Value | Description |
---|---|
CREATED
| Issue is created for the vulnerability. |
RELATED
| Has a related issue. |
VulnerabilityReportType
The type of the security scan that found the vulnerability.
VulnerabilitySeverity
The severity of the vulnerability.
Value | Description |
---|---|
CRITICAL
| Critical severity. |
HIGH
| High severity. |
INFO
| Info severity. |
LOW
| Low severity. |
MEDIUM
| Medium severity. |
UNKNOWN
| Unknown severity. |
VulnerabilitySort
Vulnerability sort values.
VulnerabilityState
The state of the vulnerability.
Value | Description |
---|---|
CONFIRMED
| For details, see vulnerability status values. |
DETECTED
| For details, see vulnerability status values. |
DISMISSED
| For details, see vulnerability status values. |
RESOLVED
| For details, see vulnerability status values. |
WeightWildcardId
Weight ID wildcard values.
Value | Description |
---|---|
ANY
| Weight is assigned. |
NONE
| No weight is assigned. |
WorkItemAwardEmojiUpdateAction
Values for work item award emoji update enum.
Value | Description |
---|---|
ADD
| Adds the emoji. |
REMOVE
| Removes the emoji. |
TOGGLE
| Toggles the status of the emoji. |
WorkItemRelatedLinkType
Values for work item link types.
Value | Description |
---|---|
BLOCKED_BY
| Blocked by type. |
BLOCKS
| Blocks type. |
RELATED
| Related type. |
WorkItemSort
Values for sorting work items.
WorkItemState
State of a GitLab work item.
Value | Description |
---|---|
CLOSED
| In closed state. |
OPEN
| In open state. |
WorkItemStateEvent
Values for work item state events.
Value | Description |
---|---|
CLOSE
| Closes the work item. |
REOPEN
| Reopens the work item. |
WorkItemTodoUpdateAction
Values for work item to-do update enum.
Value | Description |
---|---|
ADD
| Adds the to-do. |
MARK_AS_DONE
| Marks the to-do as done. |
WorkItemWidgetType
Type of a work item widget.
Scalar types
Scalar values are atomic values, and do not have fields of their own. Basic scalars include strings, boolean values, and numbers. This schema also defines various custom scalar values, such as types for times and dates.
This schema includes custom scalar types for identifiers, with a specific type for each kind of object.
For more information, read about Scalar Types on graphql.org
.
AbuseReportID
A AbuseReportID
is a global ID. It is encoded as a string.
An example AbuseReportID
is: "gid://gitlab/AbuseReport/1"
.
AchievementsAchievementID
A AchievementsAchievementID
is a global ID. It is encoded as a string.
An example AchievementsAchievementID
is: "gid://gitlab/Achievements::Achievement/1"
.
AchievementsUserAchievementID
A AchievementsUserAchievementID
is a global ID. It is encoded as a string.
An example AchievementsUserAchievementID
is: "gid://gitlab/Achievements::UserAchievement/1"
.
AiModelID
A AiModelID
is a global ID. It is encoded as a string.
An example AiModelID
is: "gid://gitlab/Ai::Model/1"
.
AlertManagementAlertID
A AlertManagementAlertID
is a global ID. It is encoded as a string.
An example AlertManagementAlertID
is: "gid://gitlab/AlertManagement::Alert/1"
.
AlertManagementHttpIntegrationID
A AlertManagementHttpIntegrationID
is a global ID. It is encoded as a string.
An example AlertManagementHttpIntegrationID
is: "gid://gitlab/AlertManagement::HttpIntegration/1"
.
AnalyticsCycleAnalyticsValueStreamID
A AnalyticsCycleAnalyticsValueStreamID
is a global ID. It is encoded as a string.
An example AnalyticsCycleAnalyticsValueStreamID
is: "gid://gitlab/Analytics::CycleAnalytics::ValueStream/1"
.
AnalyticsDevopsAdoptionEnabledNamespaceID
A AnalyticsDevopsAdoptionEnabledNamespaceID
is a global ID. It is encoded as a string.
An example AnalyticsDevopsAdoptionEnabledNamespaceID
is: "gid://gitlab/Analytics::DevopsAdoption::EnabledNamespace/1"
.
AppSecFuzzingCoverageCorpusID
A AppSecFuzzingCoverageCorpusID
is a global ID. It is encoded as a string.
An example AppSecFuzzingCoverageCorpusID
is: "gid://gitlab/AppSec::Fuzzing::Coverage::Corpus/1"
.
AuditEventsAmazonS3ConfigurationID
A AuditEventsAmazonS3ConfigurationID
is a global ID. It is encoded as a string.
An example AuditEventsAmazonS3ConfigurationID
is: "gid://gitlab/AuditEvents::AmazonS3Configuration/1"
.
AuditEventsExternalAuditEventDestinationID
A AuditEventsExternalAuditEventDestinationID
is a global ID. It is encoded as a string.
An example AuditEventsExternalAuditEventDestinationID
is: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1"
.
AuditEventsGoogleCloudLoggingConfigurationID
A AuditEventsGoogleCloudLoggingConfigurationID
is a global ID. It is encoded as a string.
An example AuditEventsGoogleCloudLoggingConfigurationID
is: "gid://gitlab/AuditEvents::GoogleCloudLoggingConfiguration/1"
.
AuditEventsInstanceAmazonS3ConfigurationID
A AuditEventsInstanceAmazonS3ConfigurationID
is a global ID. It is encoded as a string.
An example AuditEventsInstanceAmazonS3ConfigurationID
is: "gid://gitlab/AuditEvents::Instance::AmazonS3Configuration/1"
.
AuditEventsInstanceExternalAuditEventDestinationID
A AuditEventsInstanceExternalAuditEventDestinationID
is a global ID. It is encoded as a string.
An example AuditEventsInstanceExternalAuditEventDestinationID
is: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1"
.
AuditEventsInstanceGoogleCloudLoggingConfigurationID
A AuditEventsInstanceGoogleCloudLoggingConfigurationID
is a global ID. It is encoded as a string.
An example AuditEventsInstanceGoogleCloudLoggingConfigurationID
is: "gid://gitlab/AuditEvents::Instance::GoogleCloudLoggingConfiguration/1"
.
AuditEventsStreamingHTTPNamespaceFilterID
A AuditEventsStreamingHTTPNamespaceFilterID
is a global ID. It is encoded as a string.
An example AuditEventsStreamingHTTPNamespaceFilterID
is: "gid://gitlab/AuditEvents::Streaming::HTTP::NamespaceFilter/1"
.
AuditEventsStreamingHeaderID
A AuditEventsStreamingHeaderID
is a global ID. It is encoded as a string.
An example AuditEventsStreamingHeaderID
is: "gid://gitlab/AuditEvents::Streaming::Header/1"
.
AuditEventsStreamingInstanceHeaderID
A AuditEventsStreamingInstanceHeaderID
is a global ID. It is encoded as a string.
An example AuditEventsStreamingInstanceHeaderID
is: "gid://gitlab/AuditEvents::Streaming::InstanceHeader/1"
.
AwardableID
A AwardableID
is a global ID. It is encoded as a string.
An example AwardableID
is: "gid://gitlab/Awardable/1"
.
BigInt
Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it’s encoded as a string.
BoardID
A BoardID
is a global ID. It is encoded as a string.
An example BoardID
is: "gid://gitlab/Board/1"
.
BoardsEpicBoardID
A BoardsEpicBoardID
is a global ID. It is encoded as a string.
An example BoardsEpicBoardID
is: "gid://gitlab/Boards::EpicBoard/1"
.
BoardsEpicListID
A BoardsEpicListID
is a global ID. It is encoded as a string.
An example BoardsEpicListID
is: "gid://gitlab/Boards::EpicList/1"
.
Boolean
Represents true
or false
values.
CiBuildID
A CiBuildID
is a global ID. It is encoded as a string.
An example CiBuildID
is: "gid://gitlab/Ci::Build/1"
.
CiCatalogResourceID
A CiCatalogResourceID
is a global ID. It is encoded as a string.
An example CiCatalogResourceID
is: "gid://gitlab/Ci::Catalog::Resource/1"
.
CiCatalogResourcesComponentID
A CiCatalogResourcesComponentID
is a global ID. It is encoded as a string.
An example CiCatalogResourcesComponentID
is: "gid://gitlab/Ci::Catalog::Resources::Component/1"
.
CiCatalogResourcesVersionID
A CiCatalogResourcesVersionID
is a global ID. It is encoded as a string.
An example CiCatalogResourcesVersionID
is: "gid://gitlab/Ci::Catalog::Resources::Version/1"
.
CiJobArtifactID
A CiJobArtifactID
is a global ID. It is encoded as a string.
An example CiJobArtifactID
is: "gid://gitlab/Ci::JobArtifact/1"
.
CiPipelineID
A CiPipelineID
is a global ID. It is encoded as a string.
An example CiPipelineID
is: "gid://gitlab/Ci::Pipeline/1"
.
CiPipelineScheduleID
A CiPipelineScheduleID
is a global ID. It is encoded as a string.
An example CiPipelineScheduleID
is: "gid://gitlab/Ci::PipelineSchedule/1"
.
CiPipelineScheduleVariableID
A CiPipelineScheduleVariableID
is a global ID. It is encoded as a string.
An example CiPipelineScheduleVariableID
is: "gid://gitlab/Ci::PipelineScheduleVariable/1"
.
CiProcessableID
A CiProcessableID
is a global ID. It is encoded as a string.
An example CiProcessableID
is: "gid://gitlab/Ci::Processable/1"
.
CiRunnerID
A CiRunnerID
is a global ID. It is encoded as a string.
An example CiRunnerID
is: "gid://gitlab/Ci::Runner/1"
.
CiRunnerManagerID
A CiRunnerManagerID
is a global ID. It is encoded as a string.
An example CiRunnerManagerID
is: "gid://gitlab/Ci::RunnerManager/1"
.
CiStageID
A CiStageID
is a global ID. It is encoded as a string.
An example CiStageID
is: "gid://gitlab/Ci::Stage/1"
.
CiSubscriptionsProjectID
A CiSubscriptionsProjectID
is a global ID. It is encoded as a string.
An example CiSubscriptionsProjectID
is: "gid://gitlab/Ci::Subscriptions::Project/1"
.
CiTriggerID
A CiTriggerID
is a global ID. It is encoded as a string.
An example CiTriggerID
is: "gid://gitlab/Ci::Trigger/1"
.
ClustersAgentID
A ClustersAgentID
is a global ID. It is encoded as a string.
An example ClustersAgentID
is: "gid://gitlab/Clusters::Agent/1"
.
ClustersAgentTokenID
A ClustersAgentTokenID
is a global ID. It is encoded as a string.
An example ClustersAgentTokenID
is: "gid://gitlab/Clusters::AgentToken/1"
.
ClustersClusterID
A ClustersClusterID
is a global ID. It is encoded as a string.
An example ClustersClusterID
is: "gid://gitlab/Clusters::Cluster/1"
.
Color
Color represented as a hex code or named color.
For example: “#fefefe”.
ComplianceManagementFrameworkID
A ComplianceManagementFrameworkID
is a global ID. It is encoded as a string.
An example ComplianceManagementFrameworkID
is: "gid://gitlab/ComplianceManagement::Framework/1"
.
ContainerRegistryProtectionRuleID
A ContainerRegistryProtectionRuleID
is a global ID. It is encoded as a string.
An example ContainerRegistryProtectionRuleID
is: "gid://gitlab/ContainerRegistry::Protection::Rule/1"
.
ContainerRepositoryID
A ContainerRepositoryID
is a global ID. It is encoded as a string.
An example ContainerRepositoryID
is: "gid://gitlab/ContainerRepository/1"
.
CustomEmojiID
A CustomEmojiID
is a global ID. It is encoded as a string.
An example CustomEmojiID
is: "gid://gitlab/CustomEmoji/1"
.
CustomerRelationsContactID
A CustomerRelationsContactID
is a global ID. It is encoded as a string.
An example CustomerRelationsContactID
is: "gid://gitlab/CustomerRelations::Contact/1"
.
CustomerRelationsOrganizationID
A CustomerRelationsOrganizationID
is a global ID. It is encoded as a string.
An example CustomerRelationsOrganizationID
is: "gid://gitlab/CustomerRelations::Organization/1"
.
DastProfileID
A DastProfileID
is a global ID. It is encoded as a string.
An example DastProfileID
is: "gid://gitlab/Dast::Profile/1"
.
DastProfileScheduleID
A DastProfileScheduleID
is a global ID. It is encoded as a string.
An example DastProfileScheduleID
is: "gid://gitlab/Dast::ProfileSchedule/1"
.
DastScannerProfileID
A DastScannerProfileID
is a global ID. It is encoded as a string.
An example DastScannerProfileID
is: "gid://gitlab/DastScannerProfile/1"
.
DastSiteProfileID
A DastSiteProfileID
is a global ID. It is encoded as a string.
An example DastSiteProfileID
is: "gid://gitlab/DastSiteProfile/1"
.
DastSiteTokenID
A DastSiteTokenID
is a global ID. It is encoded as a string.
An example DastSiteTokenID
is: "gid://gitlab/DastSiteToken/1"
.
DastSiteValidationID
A DastSiteValidationID
is a global ID. It is encoded as a string.
An example DastSiteValidationID
is: "gid://gitlab/DastSiteValidation/1"
.
Date
Date represented in ISO 8601.
DependencyProxyManifestID
A DependencyProxyManifestID
is a global ID. It is encoded as a string.
An example DependencyProxyManifestID
is: "gid://gitlab/DependencyProxy::Manifest/1"
.
DeploymentID
A DeploymentID
is a global ID. It is encoded as a string.
An example DeploymentID
is: "gid://gitlab/Deployment/1"
.
DescriptionVersionID
A DescriptionVersionID
is a global ID. It is encoded as a string.
An example DescriptionVersionID
is: "gid://gitlab/DescriptionVersion/1"
.
DesignManagementDesignAtVersionID
A DesignManagementDesignAtVersionID
is a global ID. It is encoded as a string.
An example DesignManagementDesignAtVersionID
is: "gid://gitlab/DesignManagement::DesignAtVersion/1"
.
DesignManagementDesignID
A DesignManagementDesignID
is a global ID. It is encoded as a string.
An example DesignManagementDesignID
is: "gid://gitlab/DesignManagement::Design/1"
.
DesignManagementVersionID
A DesignManagementVersionID
is a global ID. It is encoded as a string.
An example DesignManagementVersionID
is: "gid://gitlab/DesignManagement::Version/1"
.
DiffNoteID
A DiffNoteID
is a global ID. It is encoded as a string.
An example DiffNoteID
is: "gid://gitlab/DiffNote/1"
.
DiscussionID
A DiscussionID
is a global ID. It is encoded as a string.
An example DiscussionID
is: "gid://gitlab/Discussion/1"
.
Duration
Duration between two instants, represented as a fractional number of seconds.
For example: 12.3334.
EmailID
A EmailID
is a global ID. It is encoded as a string.
An example EmailID
is: "gid://gitlab/Email/1"
.
EnvironmentID
A EnvironmentID
is a global ID. It is encoded as a string.
An example EnvironmentID
is: "gid://gitlab/Environment/1"
.
EpicID
A EpicID
is a global ID. It is encoded as a string.
An example EpicID
is: "gid://gitlab/Epic/1"
.
EpicTreeSortingID
A EpicTreeSortingID
is a global ID. It is encoded as a string.
An example EpicTreeSortingID
is: "gid://gitlab/EpicTreeSorting/1"
.
Float
Represents signed double-precision fractional values as specified by IEEE 754.
GeoBaseRegistryID
A GeoBaseRegistryID
is a global ID. It is encoded as a string.
An example GeoBaseRegistryID
is: "gid://gitlab/Geo::BaseRegistry/1"
.
GitlabErrorTrackingDetailedErrorID
A GitlabErrorTrackingDetailedErrorID
is a global ID. It is encoded as a string.
An example GitlabErrorTrackingDetailedErrorID
is: "gid://gitlab/Gitlab::ErrorTracking::DetailedError/1"
.
GitlabSubscriptionsAddOnPurchaseID
A GitlabSubscriptionsAddOnPurchaseID
is a global ID. It is encoded as a string.
An example GitlabSubscriptionsAddOnPurchaseID
is: "gid://gitlab/GitlabSubscriptions::AddOnPurchase/1"
.
GlobalID
A global identifier.
A global identifier represents an object uniquely across the application.
An example of a global identifier is "gid://gitlab/User/1"
.
gid://gitlab
stands for the root name.
User
is the name of the ActiveRecord class of the record.
1
is the record id as per the id in the db table.
Global identifiers are encoded as strings.
GroupID
A GroupID
is a global ID. It is encoded as a string.
An example GroupID
is: "gid://gitlab/Group/1"
.
ID
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA=="
) or integer (such as 4
) input value will be accepted as an ID.
ISO8601Date
An ISO 8601-encoded date.
IncidentManagementEscalationPolicyID
A IncidentManagementEscalationPolicyID
is a global ID. It is encoded as a string.
An example IncidentManagementEscalationPolicyID
is: "gid://gitlab/IncidentManagement::EscalationPolicy/1"
.
IncidentManagementEscalationRuleID
A IncidentManagementEscalationRuleID
is a global ID. It is encoded as a string.
An example IncidentManagementEscalationRuleID
is: "gid://gitlab/IncidentManagement::EscalationRule/1"
.
IncidentManagementIssuableResourceLinkID
A IncidentManagementIssuableResourceLinkID
is a global ID. It is encoded as a string.
An example IncidentManagementIssuableResourceLinkID
is: "gid://gitlab/IncidentManagement::IssuableResourceLink/1"
.
IncidentManagementOncallParticipantID
A IncidentManagementOncallParticipantID
is a global ID. It is encoded as a string.
An example IncidentManagementOncallParticipantID
is: "gid://gitlab/IncidentManagement::OncallParticipant/1"
.
IncidentManagementOncallRotationID
A IncidentManagementOncallRotationID
is a global ID. It is encoded as a string.
An example IncidentManagementOncallRotationID
is: "gid://gitlab/IncidentManagement::OncallRotation/1"
.
IncidentManagementTimelineEventID
A IncidentManagementTimelineEventID
is a global ID. It is encoded as a string.
An example IncidentManagementTimelineEventID
is: "gid://gitlab/IncidentManagement::TimelineEvent/1"
.
IncidentManagementTimelineEventTagID
A IncidentManagementTimelineEventTagID
is a global ID. It is encoded as a string.
An example IncidentManagementTimelineEventTagID
is: "gid://gitlab/IncidentManagement::TimelineEventTag/1"
.
Int
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
IntegrationsPrometheusID
A IntegrationsPrometheusID
is a global ID. It is encoded as a string.
An example IntegrationsPrometheusID
is: "gid://gitlab/Integrations::Prometheus/1"
.
The older format "gid://gitlab/PrometheusService/1"
was deprecated in 14.1.
IssuableID
A IssuableID
is a global ID. It is encoded as a string.
An example IssuableID
is: "gid://gitlab/Issuable/1"
.
IssueID
A IssueID
is a global ID. It is encoded as a string.
An example IssueID
is: "gid://gitlab/Issue/1"
.
IssueParentID
A IssueParentID
is a global ID. It is encoded as a string.
An example IssueParentID
is: "gid://gitlab/IssueParent/1"
.
IterationID
A IterationID
is a global ID. It is encoded as a string.
An example IterationID
is: "gid://gitlab/Iteration/1"
.
The older format "gid://gitlab/EEIteration/1"
was deprecated in 13.3.
IterationsCadenceID
A IterationsCadenceID
is a global ID. It is encoded as a string.
An example IterationsCadenceID
is: "gid://gitlab/Iterations::Cadence/1"
.
JSON
Represents untyped JSON.
JobID
A CommitStatusID
is a global ID. It is encoded as a string.
An example CommitStatusID
is: "gid://gitlab/CommitStatus/1"
.
JsonString
JSON object as raw string.
LabelID
A LabelID
is a global ID. It is encoded as a string.
An example LabelID
is: "gid://gitlab/Label/1"
.
ListID
A ListID
is a global ID. It is encoded as a string.
An example ListID
is: "gid://gitlab/List/1"
.
MemberRoleID
A MemberRoleID
is a global ID. It is encoded as a string.
An example MemberRoleID
is: "gid://gitlab/MemberRole/1"
.
MergeRequestID
A MergeRequestID
is a global ID. It is encoded as a string.
An example MergeRequestID
is: "gid://gitlab/MergeRequest/1"
.
MilestoneID
A MilestoneID
is a global ID. It is encoded as a string.
An example MilestoneID
is: "gid://gitlab/Milestone/1"
.
MlCandidateID
A MlCandidateID
is a global ID. It is encoded as a string.
An example MlCandidateID
is: "gid://gitlab/Ml::Candidate/1"
.
MlModelID
A MlModelID
is a global ID. It is encoded as a string.
An example MlModelID
is: "gid://gitlab/Ml::Model/1"
.
MlModelVersionID
A MlModelVersionID
is a global ID. It is encoded as a string.
An example MlModelVersionID
is: "gid://gitlab/Ml::ModelVersion/1"
.
NamespaceID
A NamespaceID
is a global ID. It is encoded as a string.
An example NamespaceID
is: "gid://gitlab/Namespace/1"
.
NamespacesNamespaceBanID
A NamespacesNamespaceBanID
is a global ID. It is encoded as a string.
An example NamespacesNamespaceBanID
is: "gid://gitlab/Namespaces::NamespaceBan/1"
.
NoteID
A NoteID
is a global ID. It is encoded as a string.
An example NoteID
is: "gid://gitlab/Note/1"
.
NoteableID
A NoteableID
is a global ID. It is encoded as a string.
An example NoteableID
is: "gid://gitlab/Noteable/1"
.
OrganizationsOrganizationID
A OrganizationsOrganizationID
is a global ID. It is encoded as a string.
An example OrganizationsOrganizationID
is: "gid://gitlab/Organizations::Organization/1"
.
PackagesConanFileMetadatumID
A PackagesConanFileMetadatumID
is a global ID. It is encoded as a string.
An example PackagesConanFileMetadatumID
is: "gid://gitlab/Packages::Conan::FileMetadatum/1"
.
PackagesConanMetadatumID
A PackagesConanMetadatumID
is a global ID. It is encoded as a string.
An example PackagesConanMetadatumID
is: "gid://gitlab/Packages::Conan::Metadatum/1"
.
PackagesDependencyID
A PackagesDependencyID
is a global ID. It is encoded as a string.
An example PackagesDependencyID
is: "gid://gitlab/Packages::Dependency/1"
.
PackagesDependencyLinkID
A PackagesDependencyLinkID
is a global ID. It is encoded as a string.
An example PackagesDependencyLinkID
is: "gid://gitlab/Packages::DependencyLink/1"
.
PackagesMavenMetadatumID
A PackagesMavenMetadatumID
is a global ID. It is encoded as a string.
An example PackagesMavenMetadatumID
is: "gid://gitlab/Packages::Maven::Metadatum/1"
.
PackagesNugetDependencyLinkMetadatumID
A PackagesNugetDependencyLinkMetadatumID
is a global ID. It is encoded as a string.
An example PackagesNugetDependencyLinkMetadatumID
is: "gid://gitlab/Packages::Nuget::DependencyLinkMetadatum/1"
.
PackagesNugetMetadatumID
A PackagesNugetMetadatumID
is a global ID. It is encoded as a string.
An example PackagesNugetMetadatumID
is: "gid://gitlab/Packages::Nuget::Metadatum/1"
.
PackagesPackageFileID
A PackagesPackageFileID
is a global ID. It is encoded as a string.
An example PackagesPackageFileID
is: "gid://gitlab/Packages::PackageFile/1"
.
PackagesPackageID
A PackagesPackageID
is a global ID. It is encoded as a string.
An example PackagesPackageID
is: "gid://gitlab/Packages::Package/1"
.
PackagesProtectionRuleID
A PackagesProtectionRuleID
is a global ID. It is encoded as a string.
An example PackagesProtectionRuleID
is: "gid://gitlab/Packages::Protection::Rule/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"
.
ProjectImportStateID
A ProjectImportStateID
is a global ID. It is encoded as a string.
An example ProjectImportStateID
is: "gid://gitlab/ProjectImportState/1"
.
ProtectedBranchID
A ProtectedBranchID
is a global ID. It is encoded as a string.
An example ProtectedBranchID
is: "gid://gitlab/ProtectedBranch/1"
.
ReleaseID
A ReleaseID
is a global ID. It is encoded as a string.
An example ReleaseID
is: "gid://gitlab/Release/1"
.
ReleasesLinkID
A ReleasesLinkID
is a global ID. It is encoded as a string.
An example ReleasesLinkID
is: "gid://gitlab/Releases::Link/1"
.
RemoteDevelopmentWorkspaceID
A RemoteDevelopmentWorkspaceID
is a global ID. It is encoded as a string.
An example RemoteDevelopmentWorkspaceID
is: "gid://gitlab/RemoteDevelopment::Workspace/1"
.
SecurityTrainingProviderID
A SecurityTrainingProviderID
is a global ID. It is encoded as a string.
An example SecurityTrainingProviderID
is: "gid://gitlab/Security::TrainingProvider/1"
.
SnippetID
A SnippetID
is a global ID. It is encoded as a string.
An example SnippetID
is: "gid://gitlab/Snippet/1"
.
String
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
SystemNoteMetadataID
A SystemNoteMetadataID
is a global ID. It is encoded as a string.
An example SystemNoteMetadataID
is: "gid://gitlab/SystemNoteMetadata/1"
.
TerraformStateID
A TerraformStateID
is a global ID. It is encoded as a string.
An example TerraformStateID
is: "gid://gitlab/Terraform::State/1"
.
Time
Time represented in ISO 8601.
For example: “2021-03-09T14:58:50+00:00”.
See https://www.iso.org/iso-8601-date-and-time-format.html
.
TimelogID
A TimelogID
is a global ID. It is encoded as a string.
An example TimelogID
is: "gid://gitlab/Timelog/1"
.
TodoID
A TodoID
is a global ID. It is encoded as a string.
An example TodoID
is: "gid://gitlab/Todo/1"
.
TodoableID
A TodoableID
is a global ID. It is encoded as a string.
An example TodoableID
is: "gid://gitlab/Todoable/1"
.
UntrustedRegexp
A regexp containing patterns sourced from user input.
Upload
UploadID
A UploadID
is a global ID. It is encoded as a string.
An example UploadID
is: "gid://gitlab/Upload/1"
.
UserID
A UserID
is a global ID. It is encoded as a string.
An example UserID
is: "gid://gitlab/User/1"
.
UsersSavedReplyID
A UsersSavedReplyID
is a global ID. It is encoded as a string.
An example UsersSavedReplyID
is: "gid://gitlab/Users::SavedReply/1"
.
VulnerabilitiesExternalIssueLinkID
A VulnerabilitiesExternalIssueLinkID
is a global ID. It is encoded as a string.
An example VulnerabilitiesExternalIssueLinkID
is: "gid://gitlab/Vulnerabilities::ExternalIssueLink/1"
.
VulnerabilitiesScannerID
A VulnerabilitiesScannerID
is a global ID. It is encoded as a string.
An example VulnerabilitiesScannerID
is: "gid://gitlab/Vulnerabilities::Scanner/1"
.
VulnerabilityID
A VulnerabilityID
is a global ID. It is encoded as a string.
An example VulnerabilityID
is: "gid://gitlab/Vulnerability/1"
.
WorkItemID
A WorkItemID
is a global ID. It is encoded as a string.
An example WorkItemID
is: "gid://gitlab/WorkItem/1"
.
While we transition from Issues into Work Items this type will temporarily support
IssueID
like: "gid://gitlab/Issue/1"
. This behavior will be removed without notice in the future.
WorkItemsRelatedWorkItemLinkID
A WorkItemsRelatedWorkItemLinkID
is a global ID. It is encoded as a string.
An example WorkItemsRelatedWorkItemLinkID
is: "gid://gitlab/WorkItems::RelatedWorkItemLink/1"
.
WorkItemsTypeID
A WorkItemsTypeID
is a global ID. It is encoded as a string.
An example WorkItemsTypeID
is: "gid://gitlab/WorkItems::Type/1"
.
Abstract types
Abstract types (unions and interfaces) are ways the schema can represent values that may be one of several concrete types.
- A
Union
is a set of possible types. The types might not have any fields in common. - An
Interface
is a defined set of fields. Types 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
DependencyLinkMetadata
Represents metadata associated with a dependency link.
One of:
Issuable
Represents an issuable.
One of:
JobNeedUnion
One of:
NoteableType
Represents an object that supports notes.
One of:
PackageMetadata
Represents metadata associated with a Package.
One of:
Registrable
One of:
CiSecureFileRegistry
ContainerRepositoryRegistry
DependencyProxyBlobRegistry
DependencyProxyManifestRegistry
DesignManagementRepositoryRegistry
GroupWikiRepositoryRegistry
JobArtifactRegistry
LfsObjectRegistry
MergeRequestDiffRegistry
PackageFileRegistry
PagesDeploymentRegistry
PipelineArtifactRegistry
ProjectWikiRepositoryRegistry
SnippetRepositoryRegistry
TerraformStateVersionRegistry
UploadRegistry
SecurityPolicySource
Represents a policy source. Its fields depend on the source type.
One of:
VulnerabilityDetail
Represents a vulnerability detail field. The fields with data will depend on the vulnerability detail type.
One of:
VulnerabilityDetailBase
VulnerabilityDetailBoolean
VulnerabilityDetailCode
VulnerabilityDetailCommit
VulnerabilityDetailDiff
VulnerabilityDetailFileLocation
VulnerabilityDetailInt
VulnerabilityDetailList
VulnerabilityDetailMarkdown
VulnerabilityDetailModuleLocation
VulnerabilityDetailNamedList
VulnerabilityDetailTable
VulnerabilityDetailText
VulnerabilityDetailUrl
VulnerabilityLocation
Represents a vulnerability location. The fields with data will depend on the vulnerability report type.
One of:
VulnerabilityLocationClusterImageScanning
VulnerabilityLocationContainerScanning
VulnerabilityLocationCoverageFuzzing
VulnerabilityLocationDast
VulnerabilityLocationDependencyScanning
VulnerabilityLocationGeneric
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. |
AmazonS3ConfigurationInterface
Implementations:
Fields
Name | Type | Description |
---|---|---|
accessKeyXid
| String!
| Access key ID of the Amazon S3 account. |
awsRegion
| String!
| AWS region where the bucket is created. |
bucketName
| String!
| Name of the bucket where the audit events would be logged. |
id
| ID!
| ID of the configuration. |
name
| String!
| Name of the external destination to send audit events to. |
BaseHeaderInterface
Implementations:
Fields
Name | Type | Description |
---|---|---|
active
| Boolean!
| Header is active or not. |
id
| ID!
| ID of the header. |
key
| String!
| Key of the header. |
value
| String!
| Value of the header. |
CiVariable
Implementations:
Fields
Name | Type | Description |
---|---|---|
id
| ID!
| ID of the variable. |
key
| String
| Name of the variable. |
raw
| Boolean
| Indicates whether the variable is raw. |
value
| String
| Value of the variable. |
variableType
| CiVariableType
| Type of the variable. |
CommitSignature
Represents signing information for a commit.
Implementations:
Fields
Name | Type | Description |
---|---|---|
commitSha
| String
| SHA of the associated commit. |
project
| Project
| Project of the associated commit. |
verificationStatus
| VerificationStatus
| Indicates verification status of the associated key or certificate. |
CurrentUserTodos
Implementations:
Fields with arguments
CurrentUserTodos.currentUserTodos
To-do items for the current user.
Returns TodoConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
state
| TodoStateEnum
| State of the to-do items. |
DesignFields
Implementations:
Fields
Name | Type | Description |
---|---|---|
diffRefs
| DiffRefs!
| Diff refs for this design. |
event
| DesignVersionEvent!
| How this design was changed in the current version. |
filename
| String!
| Filename of the design. |
fullPath
| String!
| Full path to the design file. |
id
| ID!
| ID of this design. |
image
| String!
| URL of the full-sized image. |
imageV432x230
| 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!
| Issue the design belongs to. |
notesCount
| Int!
| Total count of user-created notes for this design. |
project
| Project!
| Project the design belongs to. |
Entry
Implementations:
Fields
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
| List of events associated with the object. (see Connections) |
ExternalAuditEventDestinationInterface
Implementations:
Fields
Name | Type | Description |
---|---|---|
destinationUrl
| String!
| External destination to send audit events to. |
eventTypeFilters
| [String!]!
| List of event type filters added for streaming. |
id
| ID!
| ID of the destination. |
name
| String!
| Name of the external destination to send audit events to. |
verificationToken
| String!
| Verification token to validate source of event. |
GoogleCloudLoggingConfigurationInterface
Implementations:
Fields
Name | Type | Description |
---|---|---|
clientEmail
| String!
| Client email. |
googleProjectIdName
| String!
| Google project ID. |
id
| ID!
| ID of the configuration. |
logIdName
| String!
| Log ID. |
name
| String!
| Name of the external destination to send audit events to. |
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. |
Fields with arguments
MemberInterface.mergeRequestInteraction
Find a merge request.
Returns UserMergeRequestInteraction
.
# Arguments
Name | Type | Description |
---|---|---|
id
| MergeRequestID!
| Global ID of the merge request. |
NoteableInterface
Implementations:
AbuseReport
AlertManagementAlert
BoardEpic
Design
Epic
EpicIssue
Issue
MergeRequest
Snippet
Vulnerability
Fields
Name | Type | Description |
---|---|---|
commenters
| UserCoreConnection!
| All commenters on this noteable. (see Connections) |
discussions
| DiscussionConnection!
| All discussions on this noteable. (see Connections) |
Fields with arguments
NoteableInterface.notes
All notes on this noteable.
Returns NoteConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
filter
| NotesFilterType
| Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY. |
OrchestrationPolicy
Implementations:
Fields
Name | Type | Description |
---|---|---|
description
| String!
| Description of the policy. |
editPath
| String!
| URL of policy edit page. |
enabled
| Boolean!
| Indicates whether this policy is enabled. |
name
| String!
| Name of the policy. |
updatedAt
| Time!
| Timestamp of when the policy YAML was last updated. |
yaml
| String!
| YAML definition of the policy. |
PackageFileMetadata
Represents metadata associated with a Package file.
Implementations:
Fields
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. |
serviceType
| ServiceType
| Type of the service. |
type
| String
| Class name of the service. |
TimeboxReportInterface
Implementations:
Fields with arguments
TimeboxReportInterface.report
Historically accurate report about the timebox.
Returns TimeboxReport
.
# Arguments
Name | Type | Description |
---|---|---|
fullPath
| String
| Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab .
|
Todoable
Implementations:
Fields
Name | Type | Description |
---|---|---|
webUrl
| String
| URL of this object. |
User
Representation of a GitLab user.
Implementations:
AddOnUser
AutocompletedUser
CurrentUser
MergeRequestAssignee
MergeRequestAuthor
MergeRequestParticipant
MergeRequestReviewer
UserCore
Fields
Name | Type | Description |
---|---|---|
avatarUrl
| String
| URL of the user’s avatar. |
bio
| String
| Bio of the user. |
bot
| Boolean!
| Indicates if the user is a bot. |
callouts
| UserCalloutConnection
| User callouts that belong to the user. (see Connections) |
commitEmail
| String
| User’s default commit email. |
createdAt
| Time
| Timestamp of when the user was created. |
discord
| String
| Discord ID of the user. |
email | String
|
Deprecated in 13.7. This was renamed. Use: User.publicEmail .
|
emails
| EmailConnection
| User’s email addresses. (see Connections) |
gitpodEnabled
| Boolean
| Whether Gitpod is enabled at the user level. |
groupCount
| Int
| Group count for the user. |
groupMemberships
| GroupMemberConnection
| Group memberships of the user. (see Connections) |
id
| ID!
| ID of the user. |
ide
| Ide
| IDE settings. |
jobTitle
| String
| Job title of the user. |
lastActivityOn
| Date
| Date the user last performed any actions. |
linkedin
| String
| LinkedIn profile name of the user. |
location
| String
| Location of the user. |
name
| String!
| Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
|
namespace
| Namespace
| Personal namespace of the user. |
namespaceCommitEmails
| NamespaceCommitEmailConnection
| User’s custom namespace commit emails. (see Connections) |
organization
| String
| Who the user represents or works for. |
organizations | OrganizationConnection
| Introduced in 16.6. This feature is an Experiment. It can be changed or removed at any time. Organizations where the user has access. |
preferencesGitpodPath
| String
| Web path to the Gitpod section within user preferences. |
profileEnableGitpodPath
| String
| Web path to enable Gitpod for the user. |
projectMemberships
| ProjectMemberConnection
| Project memberships of the user. (see Connections) |
pronouns
| String
| Pronouns of the user. |
publicEmail
| String
| User’s public email. |
savedReplies
| SavedReplyConnection
| Saved replies authored by the user. (see Connections) |
state
| UserState!
| State of the user. |
status
| UserStatus
| User status. |
twitter
| String
| X (formerly Twitter) username of the user. |
userAchievements | UserAchievementConnection
|
Introduced in 15.10. This feature is an Experiment. It can be changed or removed at any time. Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.
|
userPermissions
| UserPermissions!
| Permissions for the current user on the resource. |
username
| String!
| Username of the user. Unique within this instance of GitLab. |
webPath
| String!
| Web path of the user. |
webUrl
| String!
| Web URL of the user. |
Fields with arguments
User.assignedMergeRequests
Merge requests assigned to the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
User.authoredMergeRequests
Merge requests authored by the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
User.groups
Groups where the user has access.
Returns GroupConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
permissionScope
| GroupPermission
| Filter by permissions the user has on groups. |
search
| String
| Search by group name or path. |
User.reviewRequestedMergeRequests
Merge requests assigned to the user for review.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
approved
| Boolean
| Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
|
assigneeUsername
| String
| Username of the assignee. |
authorUsername
| String
| Username of the author. |
createdAfter
| Time
| Merge requests created after this timestamp. |
createdBefore
| Time
| Merge requests created before this timestamp. |
draft
| Boolean
| Limit result to draft merge requests. |
groupId
| GroupID
| The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included. |
iids
| [String!]
| Array of IIDs of merge requests, for example [1, 2] .
|
labels
| [String!]
| Array of label names. All resolved merge requests will have all of these labels. |
mergedAfter
| 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
| 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. |
updatedAfter
| Time
| Merge requests updated after this timestamp. |
updatedBefore
| Time
| Merge requests updated before this timestamp. |
User.savedReply
Saved reply authored by the user.
Returns SavedReply
.
# Arguments
Name | Type | Description |
---|---|---|
id
| UsersSavedReplyID!
| ID of a saved reply. |
User.snippets
Snippets authored by the user.
Returns SnippetConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
ids
| [SnippetID!]
| Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 .
|
type
| TypeEnum
| Type of snippet. |
visibility
| VisibilityScopesEnum
| 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
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
search
| String
| Search query. |
User.timelogs
Time logged by the user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
endDate
| Time
| List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
| Time
| List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
| GroupID
| List timelogs for a group. |
projectId
| ProjectID
| List timelogs for a project. |
sort
| TimelogSort
| List timelogs in a particular order. |
startDate
| Time
| List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
| Time
| List timelogs within a time range where the logged time is equal to or after startTime. |
username
| String
| List timelogs for a user. |
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
, and last: Int
.
# Arguments
Name | Type | Description |
---|---|---|
action
| [TodoActionEnum!]
| Action to be filtered. |
authorId
| [ID!]
| ID of an author. |
groupId
| [ID!]
| ID of a group. |
projectId
| [ID!]
| ID of a project. |
state
| [TodoStateEnum!]
| State of the todo. |
type
| [TodoTargetEnum!]
| Type of the todo. |
WorkItemWidget
Implementations:
WorkItemWidgetAssignees
WorkItemWidgetAwardEmoji
WorkItemWidgetCurrentUserTodos
WorkItemWidgetDescription
WorkItemWidgetHealthStatus
WorkItemWidgetHierarchy
WorkItemWidgetIteration
WorkItemWidgetLabels
WorkItemWidgetLinkedItems
WorkItemWidgetMilestone
WorkItemWidgetNotes
WorkItemWidgetNotifications
WorkItemWidgetProgress
WorkItemWidgetRequirementLegacy
WorkItemWidgetStartAndDueDate
WorkItemWidgetStatus
WorkItemWidgetTestReports
WorkItemWidgetWeight
Fields
Name | Type | Description |
---|---|---|
type
| WorkItemWidgetType
| Widget type. |
WorkItemWidgetDefinition
Implementations:
WorkItemWidgetDefinitionAssignees
WorkItemWidgetDefinitionGeneric
WorkItemWidgetDefinitionHierarchy
WorkItemWidgetDefinitionLabels
Fields
Name | Type | Description |
---|---|---|
type
| WorkItemWidgetType!
| Widget type. |
Input types
Types that may be used as arguments (all scalar types may also be used as arguments).
Only general use input types are listed here. For mutation input types, see the associated mutation type above.
AiChatInput
Arguments
Name | Type | Description |
---|---|---|
content
| String!
| Content of the message. |
currentFile | AiCurrentFileInput
| Deprecated: This feature is an Experiment. It can be changed or removed at any time. Introduced in 16.6. |
namespaceId
| NamespaceID
| Global ID of the namespace the user is acting on. |
resourceId
| AiModelID
| Global ID of the resource to mutate. |
AiCurrentFileInput
Arguments
Name | Type | Description |
---|---|---|
contentAboveCursor
| String
| Content above cursor. |
contentBelowCursor
| String
| Content below cursor. |
fileName
| String!
| File name. |
selectedText
| String!
| Selected text. |
AiExplainCodeInput
Arguments
Name | Type | Description |
---|---|---|
messages
| [AiExplainCodeMessageInput!]!
| Code messages that is passed to be explained by AI. |
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
AiExplainCodeMessageInput
Arguments
Name | Type | Description |
---|---|---|
content
| String!
| Content of the message. |
role
| String!
| Role of the message (system, user, assistant). |
AiExplainVulnerabilityInput
Arguments
Name | Type | Description |
---|---|---|
includeSourceCode
| Boolean
| Include vulnerablility source code in the AI prompt. |
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
AiFillInMergeRequestTemplateInput
Arguments
Name | Type | Description |
---|---|---|
content
| String!
| Template content to fill in. |
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
sourceBranch
| String!
| Source branch of the changes. |
sourceProjectId
| ID
| ID of the project where the changes are from. |
targetBranch
| String!
| Target branch of where the changes will be merged into. |
title
| String!
| Title of the merge request to be created. |
AiGenerateCommitMessageInput
Arguments
Name | Type | Description |
---|---|---|
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
AiGenerateDescriptionInput
Arguments
Name | Type | Description |
---|---|---|
content
| String!
| Content of the message. |
descriptionTemplateName
| String
| Name of the description template to use to generate message off of. |
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
AiResolveVulnerabilityInput
Arguments
Name | Type | Description |
---|---|---|
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
AiSummarizeCommentsInput
Arguments
Name | Type | Description |
---|---|---|
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
AiSummarizeReviewInput
Arguments
Name | Type | Description |
---|---|---|
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
AlertManagementPayloadAlertFieldInput
Field that are available while modifying the custom mapping attributes for an HTTP integration.
Arguments
Name | Type | Description |
---|---|---|
fieldName
| AlertManagementPayloadAlertFieldName!
| 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. |
AnalyzeCiJobFailureInput
Arguments
Name | Type | Description |
---|---|---|
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
BoardIssueInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsername
| [String]
| Filter by assignee username. |
assigneeWildcardId
| AssigneeWildcardId
| Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames. |
authorUsername
| String
| Filter by author username. |
confidential
| Boolean
| Filter by confidentiality. |
epicId
| EpicID
| Filter by epic ID. Incompatible with epicWildcardId. |
epicWildcardId
| EpicWildcardId
| Filter by epic ID wildcard. Incompatible with epicId. |
healthStatusFilter
| HealthStatusFilter
| Health status of the issue, “none” and “any” values are supported. |
iids
| [String!]
| List of IIDs of issues. For example ["1", "2"] .
|
iterationCadenceId
| [IterationsCadenceID!]
| Filter by a list of iteration cadence IDs. |
iterationId
| [IterationID!]
| Filter by a list of iteration IDs. Incompatible with iterationWildcardId. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| IterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Filter by label name. |
milestoneTitle
| String
| Filter by milestone title. |
milestoneWildcardId
| MilestoneWildcardId
| Filter by milestone ID wildcard. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported. |
not
| NegatedBoardIssueInput
| List of negated arguments. |
or
| UnionedIssueFilterInput
| List of arguments with inclusive OR. |
releaseTag
| String
| Filter by release tag. |
search
| String
| Search query for issue title or description. |
types
| [IssueType!]
| Filter by the given issue types. |
weight
| String
| Filter by weight. |
weightWildcardId
| WeightWildcardId
| Filter by weight ID wildcard. Incompatible with weight. |
CiVariableInput
Attributes for defining a CI/CD variable.
Arguments
Name | Type | Description |
---|---|---|
key
| String!
| Name of the variable. |
value
| String!
| Value of the variable. |
CommitAction
Arguments
Name | Type | Description |
---|---|---|
action
| CommitActionMode!
| Action to perform: create, delete, move, update, or 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. |
ComplianceFrameworkFilters
Arguments
Name | Type | Description |
---|---|---|
id
| ComplianceManagementFrameworkID
| ID of the compliance framework. |
not
| NegatedComplianceFrameworkFilters
| Negated compliance framework filter input. |
presenceFilter
| ComplianceFrameworkPresenceFilter
| Checks presence of compliance framework of the project, “none” and “any” values are supported. |
ComplianceFrameworkInput
Arguments
Name | Type | Description |
---|---|---|
color
| String
| New color representation of the compliance framework in hex format. e.g. #FCA121. |
default
| Boolean
| Set this compliance framework as the default framework for the group. |
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 Ultimate All offerings .
|
ComplianceStandardsAdherenceInput
Arguments
Name | Type | Description |
---|---|---|
checkName
| ComplianceStandardsAdherenceCheckName
| Name of the check for the compliance standard. |
projectIds
| [ProjectID!]
| Filter compliance standards adherence by project. |
standard
| ComplianceStandardsAdherenceStandard
| Name of the compliance standard. |
ComplianceViolationInput
Arguments
Name | Type | Description |
---|---|---|
mergedAfter
| Date
| Merge requests merged after this date (inclusive). |
mergedBefore
| Date
| Merge requests merged before this date (inclusive). |
projectIds
| [ProjectID!]
| Filter compliance violations by project. |
targetBranch
| String
| Filter compliance violations by target branch. |
DastProfileCadenceInput
Represents DAST Profile Cadence.
Arguments
Name | Type | Description |
---|---|---|
duration
| Int
| Duration of the DAST Profile Cadence. |
unit
| DastProfileCadenceUnit
| Unit for the duration of DAST Profile Cadence. |
DastProfileScheduleInput
Input type for DAST Profile Schedules.
Arguments
Name | Type | Description |
---|---|---|
active
| Boolean
| Status of a Dast Profile Schedule. |
cadence
| DastProfileCadenceInput
| Cadence of a Dast Profile Schedule. |
startsAt
| Time
| Start time of a Dast Profile Schedule. |
timezone
| String
| Time Zone for the Start time of a Dast Profile Schedule. |
DastSiteProfileAuthInput
Input type for DastSiteProfile authentication.
Arguments
Name | Type | Description |
---|---|---|
enabled
| Boolean
| Indicates whether authentication is enabled. |
password
| String
| Password to authenticate with on the target. |
passwordField
| String
| Name of password field at the sign-in HTML form. |
submitField
| String
| Name or ID of sign-in submit button 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
| Username to authenticate with on the target. |
usernameField
| String
| Name of username field at the sign-in HTML form. |
DeploymentsOrderByInput
Values for ordering deployments by a specific field.
Arguments
Name | Type | Description |
---|---|---|
createdAt
| SortDirectionEnum
| Order by Created time. |
finishedAt
| SortDirectionEnum
| Order by Finished time. |
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
| Path of the file on the HEAD SHA. |
oldPath
| String
| 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. Please see the REST API Documentation for more information on how to use this field. |
oldLine
| Int
| Line on start SHA that was changed. Please see the REST API Documentation for more information on how to use this field. |
paths
| DiffPathsInput!
| The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required. |
startSha
| String!
| SHA of the branch being compared against. |
DoraProjectFilterInput
Filter parameters for projects to be aggregated for DORA metrics.
Arguments
Name | Type | Description |
---|---|---|
topic
| [String!]
| Filter projects by topic. |
EpicFilters
Arguments
Name | Type | Description |
---|---|---|
authorUsername
| String
| Filter by author username. |
confidential
| Boolean
| Filter by confidentiality. |
labelName
| [String]
| Filter by label name. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported. |
not
| NegatedEpicBoardIssueInput
| Negated epic arguments. |
or
| UnionedEpicFilterInput
| List of arguments with inclusive OR. Ignored unless or_issuable_queries flag is enabled.
|
search
| String
| Search query for epic title or description. |
EpicTreeNodeFieldsInputType
A node of an epic tree.
Arguments
Name | Type | Description |
---|---|---|
adjacentReferenceId
| EpicTreeSortingID
| ID of the epic issue or issue the epic or issue is switched with. |
id
| EpicTreeSortingID!
| ID of the epic issue or epic that is being moved. |
newParentId
| EpicID
| ID of the new parent epic. |
relativePosition
| MoveType
| Type of switch. Valid values are after or before .
|
EscalationRuleInput
Represents an escalation rule.
Arguments
Name | Type | Description |
---|---|---|
elapsedTimeSeconds
| Int!
| Time in seconds before the rule is activated. |
oncallScheduleIid
| ID
| On-call schedule to notify. |
status
| EscalationRuleStatus!
| Status required to prevent the rule from activating. |
username
| String
| Username of the user to notify. |
GenerateTestFileInput
Arguments
Name | Type | Description |
---|---|---|
filePath
| String!
| File path to generate test files for. |
resourceId
| AiModelID!
| Global ID of the resource to mutate. |
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. |
MonthSelectionInput
A year and month input for querying product analytics usage data.
Arguments
Name | Type | Description |
---|---|---|
month
| Int!
| Month of the period to return. |
year
| Int!
| Year of the period to return. |
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. |
healthStatusFilter
| HealthStatus
| Health status not applied to the issue. Includes issues where health status is not set. |
iids
| [String!]
| List of IIDs of issues. For example ["1", "2"] .
|
iterationId
| [IterationID!]
| Filter by a list of iteration IDs. Incompatible with iterationWildcardId. |
iterationTitle
| String
| Filter by iteration title. |
iterationWildcardId
| NegatedIterationWildcardId
| Filter by iteration ID wildcard. |
labelName
| [String]
| Filter by label name. |
milestoneTitle
| String
| Filter by milestone title. |
milestoneWildcardId
| MilestoneWildcardId
| Filter by milestone ID wildcard. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported. |
releaseTag
| String
| Filter by release tag. |
types
| [IssueType!]
| Filter by the given issue types. |
weight
| String
| Filter by weight. |
NegatedComplianceFrameworkFilters
Arguments
Name | Type | Description |
---|---|---|
id
| ComplianceManagementFrameworkID
| ID of the compliance framework. |
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. Wildcard values “NONE” and “ANY” are supported. |
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. |
authorUsername
| [String!]
| Username of a user who didn’t author the issue. |
epicId
| String
| ID of an epic not associated with the issues. |
healthStatusFilter
| [HealthStatus!]
| Health status not applied to the issue. Includes issues where health status is not set. |
iids
| [String!]
| List of IIDs of issues to exclude. For example, [1, 2] .
|
iterationId
| [ID!]
| List of iteration Global IDs not applied to the issue. |
iterationWildcardId
| IterationWildcardId
| Filter by negated iteration ID wildcard. |
labelName
| [String!]
| Labels not applied to this issue. |
milestoneTitle
| [String!]
| Milestone not applied to this issue. |
milestoneWildcardId
| NegatedMilestoneWildcardId
| Filter by negated milestone wildcard values. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
releaseTag
| [String!]
| Release tag not associated with the issue’s milestone. Ignored when parent is a group. |
types
| [IssueType!]
| Filters out issues by the given issue types. |
weight
| String
| Weight not applied to the issue. |
NegatedValueStreamAnalyticsIssueFilterInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Usernames of users not assigned to the issue. |
authorUsername
| String
| Username of a user who didn’t author the issue. |
epicId
| ID
| ID of an epic not associated with the issues. |
iterationId
| ID
| List of iteration Global IDs not applied to the issue. |
labelNames
| [String!]
| Labels not applied to this issue. |
milestoneTitle
| String
| Milestone not applied to this issue. |
myReactionEmoji
| String
| Filter by reaction emoji applied by the current user. |
weight
| Int
| Weight not applied to the issue. |
OncallRotationActivePeriodInputType
Active period time range for on-call rotation.
Arguments
Name | Type | Description |
---|---|---|
endTime
| String!
| End of the rotation active period in 24 hour format. For example, “18:30”. |
startTime
| String!
| Start of the rotation active period in 24 hour format. For example, “18:30”. |
OncallRotationDateInputType
Date input type for on-call rotation.
Arguments
Name | Type | Description |
---|---|---|
date
| String!
| Date component of the date in YYYY-MM-DD format. |
time
| String!
| Time component of the date in 24hr HH:MM format. |
OncallRotationLengthInputType
The rotation length of the on-call rotation.
Arguments
Name | Type | Description |
---|---|---|
length
| Int!
| Rotation length of the on-call rotation. |
unit
| OncallRotationUnitEnum!
| Unit of the rotation length of the on-call rotation. |
OncallUserInputType
The rotation user and color palette.
Arguments
Name | Type | Description |
---|---|---|
colorPalette
| DataVisualizationColorEnum
| Value of DataVisualizationColorEnum. The color from the palette to assign to the on-call user. |
colorWeight
| DataVisualizationWeightEnum
| Color weight to assign to for the on-call user. To view on-call schedules in GitLab, do not provide a value below 500. A value between 500 and 950 ensures sufficient contrast. |
username
| String!
| Username of the user to participate in the on-call rotation. For example, "user_one" .
|
PipelineScheduleVariableInput
Attributes for the pipeline schedule variable.
Arguments
Name | Type | Description |
---|---|---|
destroy
| Boolean
| Boolean option to destroy the variable. |
id
| CiPipelineScheduleVariableID
| ID of the variable to mutate. |
key
| String!
| Name of the variable. |
value
| String!
| Value of the variable. |
variableType
| CiVariableType!
| Type of the variable. |
ReleaseAssetLinkInput
Fields that are available when modifying a release asset link.
Arguments
Name | Type | Description |
---|---|---|
directAssetPath
| String
| Relative path for a direct asset link. |
linkType
| ReleaseAssetLinkType
| 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!]
| List of asset links to associate to the release. |
RequirementLegacyFilterInput
Arguments
Name | Type | Description |
---|---|---|
legacyIids
| [String!]!
| List of legacy requirement IIDs of work items. or example ["1", "2"] .
|
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. |
StatusFilterInput
Arguments
Name | Type | Description |
---|---|---|
status
| RequirementStatusFilter!
| Status of the work item. |
StatusInput
Arguments
Name | Type | Description |
---|---|---|
status
| TestReportState!
| Status to assign to the work item. |
Timeframe
A time-frame defined as a closed inclusive range of two dates.
Arguments
Name | Type | Description |
---|---|---|
end
| Date!
| End of the range. |
start
| Date!
| Start of the range. |
UnionedEpicFilterInput
Arguments
Name | Type | Description |
---|---|---|
authorUsername | [String!]
| Deprecated: Use authorUsernames instead. Deprecated in 16.6. |
authorUsernames
| [String!]
| Filters epics that are authored by one of the given users. |
labelName | [String!]
| Deprecated: Use labelNames instead. Deprecated in 16.6. |
labelNames
| [String!]
| Filters epics that have at least one of the given labels. |
UnionedIssueFilterInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
| [String!]
| Filters issues that are assigned to at least one of the given users. |
authorUsernames
| [String!]
| Filters issues that are authored by one of the given users. |
labelNames
| [String!]
| Filters issues that have at least one of the given labels. |
UpdateDiffImagePositionInput
Arguments
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. |
ValueStreamSettingInput
Attributes for value stream setting.
Arguments
Name | Type | Description |
---|---|---|
projectIdsFilter
| [ProjectID!]
| Projects’ global IDs used to filter value stream data. |
ValueStreamStageInput
Attributes for value stream stage.
Arguments
Name | Type | Description |
---|---|---|
custom
| Boolean
| Whether the stage is customized. If false, it assigns a built-in default stage by name. |
endEventIdentifier
| ValueStreamStageEvent
| End event identifier. |
endEventLabelId
| LabelID
| Label ID associated with the end event identifier. |
hidden
| Boolean
| Whether the stage is hidden. |
name
| String!
| Name of the stage. |
startEventIdentifier
| ValueStreamStageEvent
| Start event identifier. |
startEventLabelId
| LabelID
| Label ID associated with the start event identifier. |
VulnerabilityIdentifierInput
Arguments
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. |
VulnerabilityScannerInput
Arguments
Name | Type | Description |
---|---|---|
id
| String!
| Unique ID that identifies the scanner. |
name
| String!
| Human readable value that identifies the analyzer, not required to be unique. |
url
| String!
| Link to more information about the analyzer. |
vendor
| VulnerabilityScannerVendorInput
| Information about vendor/maintainer of the scanner. |
version
| String!
| Version of the scanner. |
VulnerabilityScannerVendorInput
Arguments
Name | Type | Description |
---|---|---|
name
| String!
| Name of the vendor/maintainer. |
WorkItemConvertTaskInput
Arguments
Name | Type | Description |
---|---|---|
lineNumberEnd
| Int!
| Last line in the Markdown source that defines the list item task. |
lineNumberStart
| Int!
| First line in the Markdown source that defines the list item task. |
lockVersion
| Int!
| Current lock version of the work item containing the task in the description. |
title
| String!
| Full string of the task to be replaced. New title for the created work item. |
workItemTypeId
| WorkItemsTypeID!
| Global ID of the work item type used to create the new work item. |
WorkItemUpdatedTaskInput
Arguments
Name | Type | Description |
---|---|---|
assigneesWidget
| WorkItemWidgetAssigneesInput
| Input for assignees widget. |
awardEmojiWidget
| WorkItemWidgetAwardEmojiUpdateInput
| Input for emoji reactions widget. |
confidential
| Boolean
| Sets the work item confidentiality. |
currentUserTodosWidget
| WorkItemWidgetCurrentUserTodosInput
| Input for to-dos widget. |
descriptionWidget
| WorkItemWidgetDescriptionInput
| Input for description widget. |
hierarchyWidget
| WorkItemWidgetHierarchyUpdateInput
| Input for hierarchy widget. |
id
| WorkItemID!
| Global ID of the work item. |
labelsWidget
| WorkItemWidgetLabelsUpdateInput
| Input for labels widget. |
milestoneWidget
| WorkItemWidgetMilestoneInput
| Input for milestone widget. |
notificationsWidget
| WorkItemWidgetNotificationsUpdateInput
| Input for notifications widget. |
startAndDueDateWidget
| WorkItemWidgetStartAndDueDateUpdateInput
| Input for start and due date widget. |
stateEvent
| WorkItemStateEvent
| Close or reopen a work item. |
title
| String
| Title of the work item. |
WorkItemWidgetAssigneesInput
Arguments
Name | Type | Description |
---|---|---|
assigneeIds
| [UserID!]!
| Global IDs of assignees. |
WorkItemWidgetAwardEmojiUpdateInput
Arguments
Name | Type | Description |
---|---|---|
action
| WorkItemAwardEmojiUpdateAction!
| Action for the update. |
name
| String!
| Emoji name. |
WorkItemWidgetCurrentUserTodosInput
Arguments
Name | Type | Description |
---|---|---|
action
| WorkItemTodoUpdateAction!
| Action for the update. |
todoId
| TodoID
| Global ID of the to-do. If not present, all to-dos of the work item will be updated. |
WorkItemWidgetDescriptionInput
Arguments
Name | Type | Description |
---|---|---|
description
| String!
| Description of the work item. |
WorkItemWidgetHealthStatusInput
Arguments
Name | Type | Description |
---|---|---|
healthStatus
| HealthStatus
| Health status to be assigned to the work item. |
WorkItemWidgetHierarchyCreateInput
Arguments
Name | Type | Description |
---|---|---|
parentId
| WorkItemID
| Global ID of the parent work item. |
WorkItemWidgetHierarchyUpdateInput
Arguments
Name | Type | Description |
---|---|---|
adjacentWorkItemId
| WorkItemID
| ID of the work item to be switched with. |
childrenIds
| [WorkItemID!]
| Global IDs of children work items. |
parentId
| WorkItemID
| Global ID of the parent work item. Use null to remove the association.
|
relativePosition
| RelativePositionType
| Type of switch. Valid values are BEFORE or AFTER .
|
WorkItemWidgetIterationInput
Arguments
Name | Type | Description |
---|---|---|
iterationId
| IterationID
| Iteration to assign to the work item. |
WorkItemWidgetLabelsUpdateInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
| [LabelID!]
| Global IDs of labels to be added to the work item. |
removeLabelIds
| [LabelID!]
| Global IDs of labels to be removed from the work item. |
WorkItemWidgetMilestoneInput
Arguments
Name | Type | Description |
---|---|---|
milestoneId
| MilestoneID
| Milestone to assign to the work item. |
WorkItemWidgetNotificationsUpdateInput
Arguments
Name | Type | Description |
---|---|---|
subscribed
| Boolean!
| Desired state of the subscription. |
WorkItemWidgetProgressInput
Arguments
Name | Type | Description |
---|---|---|
currentValue
| Int!
| Current progress value of the work item. |
endValue
| Int
| End value of the work item. |
startValue
| Int
| Start value of the work item. |
WorkItemWidgetStartAndDueDateUpdateInput
Arguments
Name | Type | Description |
---|---|---|
dueDate
| Date
| Due date for the work item. |
startDate
| Date
| Start date for the work item. |
WorkItemWidgetWeightInput
Arguments
Name | Type | Description |
---|---|---|
weight
| Int
| Weight of the work item. |