InfoGrab DocsInfoGrab Docs

GraphQL API 객체

요약

An object is a GraphQL type with fields. Deprecated items are planned to be removed in a future release. Represents the Geo replication and verification state of a abuse_report_upload.

An object is a GraphQL type with fields.

Warning

Deprecated items are planned to be removed in a future release. For more information, see the GitLab deprecation process.

AbuseReport#

An abuse report.

Fields#

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

AbuseReportUploadRegistry#

Represents the Geo replication and verification state of a abuse_report_upload.

Fields#

Name Type Description
abuseReportUploadId ID! ID of the Abuse Report Upload.
checksumMismatch Boolean Indicate if the checksums of the AbuseReportUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AbuseReportUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AbuseReportUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AbuseReportUploadRegistry.
lastSyncFailure String Error message during sync of the AbuseReportUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AbuseReportUploadRegistry.
missingOnPrimary Boolean Indicate if the AbuseReportUploadRegistry is missing on primary.
modelRecordId Int ID of the AbuseReportUploadRegistry's model record.
retryAt Time Timestamp after which the AbuseReportUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AbuseReportUploadRegistry.
state RegistryState Sync state of the AbuseReportUploadRegistry.
verificationChecksum String The local checksum of the AbuseReportUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AbuseReportUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AbuseReportUploadRegistry.
verificationRetryAt Time Timestamp after which the AbuseReportUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AbuseReportUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AbuseReportUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AbuseReportUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AbuseReportUploadRegistry.

AbuseReportUploadRegistryConnection#

Paginated collection of AbuseReportUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

AccessLevel#

Represents the access level of a relationship between a User and object that it is related to.

Fields#

Name Type Description
humanAccess String Human-readable display name for the access level.
integerValue Int Integer number of the access level.
stringValue AccessLevelEnum Enum string of the the 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.

AccessLevelDeployKeyConnection#

Paginated collection of AccessLevelDeployKey. See Standard connection fields for the fields available on every connection.

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.

AccessTokenGranularScope#

Granular scope applied to an access token.

Fields#

Name Type Description
access AccessTokenGranularScopeAccess! Access configured on a granular scope.
group Group Group of the granular scope, when the scope targets a specific group.
namespace Namespace Namespace of the granular scope.
permissions [AccessTokenPermission!] List of permissions of a granular scope.
project Project Project of the granular scope, when the scope targets a specific project.

AccessTokenLegacyScope#

Legacy scope applied to an access token.

Fields#

Name Type Description
value String! Value of the scope.

AccessTokenPermission#

Permission that belongs to a granular scope.

Fields#

Name Type Description
action String! Action of the permission.
boundaries [PermissionBoundary!]! List of resource types that the permission can be applied to.
category String! Permission category.
categoryName String! Display name of the permission category.
description String! Description of the permission.
name String! Name of the permission.
resource String! Resource of the permission.
resourceDescription String! Description of the resource.
resourceName String! Display name of the resource.

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.
uniqueUsers UserCoreConnection! Unique users who have received the achievement. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp the achievement was last updated.
userAchievements UserAchievementConnection Recipients for the achievement. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

AchievementConnection#

Paginated collection of Achievement. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AchievementUploadRegistry#

Represents the Geo replication and verification state of an achievement_upload.

Fields#

Name Type Description
achievementUploadId ID! ID of the Achievement Upload.
checksumMismatch Boolean Indicate if the checksums of the AchievementUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AchievementUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AchievementUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AchievementUploadRegistry.
lastSyncFailure String Error message during sync of the AchievementUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AchievementUploadRegistry.
missingOnPrimary Boolean Indicate if the AchievementUploadRegistry is missing on primary.
modelRecordId Int ID of the AchievementUploadRegistry's model record.
retryAt Time Timestamp after which the AchievementUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AchievementUploadRegistry.
state RegistryState Sync state of the AchievementUploadRegistry.
verificationChecksum String The local checksum of the AchievementUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AchievementUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AchievementUploadRegistry.
verificationRetryAt Time Timestamp after which the AchievementUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AchievementUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AchievementUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AchievementUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AchievementUploadRegistry.

AchievementUploadRegistryConnection#

Paginated collection of AchievementUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ActiveTrial#

Active trial information.

Fields#

Name Type Description
endDate ISO8601Date Trial end date.
startDate ISO8601Date Trial start date.

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.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
addOnAssignments UserAddOnAssignmentConnection Introduced as an experiment in GitLab 16.4.

Add-on purchase assignments for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for addOnAssignments:
addOnPurchaseIds ([GitlabSubscriptionsAddOnPurchaseID!]!)
Global IDs of the add on purchases to find assignments for.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
lastDuoActivityOn Date Date of the last Duo activity of the user. Refreshed on any GitLab Duo activity.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

AddOnUserConnection#

Paginated collection of AddOnUser. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AdminDuoAvailabilityLockedAncestor#

The ancestor group that introduced an admin-locked GitLab Duo availability override.

Fields#

Name Type Description
fullPath String! Full path of the locking ancestor group.
id GroupID! Global ID of the locking ancestor group.

AdminDuoAvailabilityLockedAncestorConnection#

Paginated collection of AdminDuoAvailabilityLockedAncestor. See Standard connection fields for the fields available on every connection.

AdminDuoAvailabilityNamespace#

A group with its resolved GitLab Duo availability, for the admin override list.

Fields#

Name Type Description
adminLocked Boolean! Whether this group is the introducer of an admin-locked override. False on descendants that merely inherit a locking value.
duoAvailability DuoAvailability! Effective GitLab Duo availability: the group own override if set, otherwise the inherited value.
fullPath String! Full path of the group.
id GroupID! Global ID of the group.
inheritedValue DuoAvailability! GitLab Duo availability the group resolves to from its nearest ancestor override, or the instance default, ignoring the group own override.
lockedByAncestor AdminDuoAvailabilityLockedAncestor Nearest strict ancestor that introduced an admin lock, or null when the group is not locked by an ancestor.
name String! Name of the group.

AdminDuoAvailabilityNamespaceConnection#

Paginated collection of AdminDuoAvailabilityNamespace. See Standard connection fields for the fields available on every connection.

AdminMemberRole#

Represents an admin member role.

Implements: CustomRoleInterface, RoleInterface

Fields#

Name Type Description
createdAt Time! Timestamp of when the member role was created.
description String Role description.
detailsPath String Introduced as an experiment in GitLab 17.4.

URL path to the role details webpage.
editPath String! Introduced as an experiment in GitLab 16.11.

Web UI path to edit the custom role.
enabledPermissions CustomizableAdminPermissionConnection! Introduced as an experiment in GitLab 17.7.

Array of all permissions enabled for the custom role. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Role ID.
ldapAdminRoleLinks LdapAdminRoleLinkConnection Introduced as an experiment in GitLab 18.1.

LDAP admin role sync configurations that will assign the admin member role. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Role name.
usersCount Int Introduced as an experiment in GitLab 17.5.

Number of users who have been directly assigned the admin member role.

AdminMemberRoleConnection#

Paginated collection of AdminMemberRole. See Standard connection fields for the fields available on every connection.

AgentConfiguration#

Configuration details for an Agent.

Fields#

Name Type Description
agentName String Name of the agent.

AgentConfigurationConnection#

Paginated collection of AgentConfiguration. See Standard connection fields for the fields available on every connection.

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.

AgentPlatformFlowMetric#

Agent platform aggregated metrics by flow type.

Fields#

Name Type Description
completionRate Float Completion rate as a percentage.
flowType String! Type of the flow.
medianExecutionTime Float Median flow execution time in seconds.
sessionsCount Int! Total number of sessions, equivalent to the count of the agent_platform_session_created event.
usersCount Int! Number of unique users.

AgentPlatformSessionsAggregationResponse#

Response for AgentPlatformSessions aggregation engine.

Fields#

Name Type Description
completionRate Float Session completion rate.
dimensions AgentPlatformSessionsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
duration AgentPlatformSessionsAggregationResponseDurationMetrics Aggregated duration metrics.
durationQuantile Float Session duration quantile in seconds.

Arguments for durationQuantile:
quantile (Float)
featuresCount Int Number of unique features (flow types).
finishedCount Int Number of finished sessions.
meanDuration Float Average session duration in seconds.
totalCount Int Total number of sessions.
usersCount Int Number of unique users.

AgentPlatformSessionsAggregationResponseConnection#

Paginated collection of AgentPlatformSessionsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

AgentPlatformSessionsAggregationResponseDimensions#

Response dimensions for AgentPlatformSessions aggregation engine.

Fields#

Name Type Description
createdEventAt Date Session creation date.

Arguments for createdEventAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
flowType String Type of session.
project Project Project the session ran in.
user UserCore Session owner.

AgentPlatformSessionsAggregationResponseDurationMetrics#

Aggregated duration metrics for AgentPlatformSessions aggregation engine.

Fields#

Name Type Description
max Int Maximum session duration in seconds.
mean Float Mean session duration in seconds.
min Int Minimum session duration in seconds.
quantile Float Quantile of session duration in seconds.

Arguments for quantile:
quantile (Float)
sum Float Sum of session duration in seconds.

AgentPlatformSessionsAggregationScope#

Aggregation scope for AgentPlatformSessions. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated AgentPlatformSessionsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
featuresCountFrom (Int)
Filter by the number of unique features. The features_count metric must also be requested when using this filter. Start of the range.
featuresCountTo (Int)
Filter by the number of unique features. The features_count metric must also be requested when using this filter. End of the range.
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

AgentPlatformUserFlowCount#

Agent platform flow counts aggergated per user.

Fields#

Name Type Description
flowType String! Type of the flow.
sessionsCount Int! Total number of flow sessions.
user UserCore User who triggered the flow.

AgentPlatformUserFlowCountConnection#

Paginated collection of AgentPlatformUserFlowCount. See Standard connection fields for the fields available on every connection.

AgentVersionWarning#

Version-related warning for a connected Agent.

Fields#

Name Type Description
message String Warning message related to the version.
type String Warning type related to the version.

AgentWarning#

Warning object for a connected Agent.

Fields#

Name Type Description
version AgentVersionWarning Agent warning related to the version.

AggregationStatus#

Fields#

Name Type Description
enabled Boolean! Whether background aggregation is enabled or disabled. For downgraded, non-licensed groups and projects the field is false.
estimatedNextUpdateAt Time Estimated time when the next incremental update will happen.
lastUpdateAt Time Last incremental update time.

AiAdditionalContext#

Additional context for AI message.

Fields#

Name Type Description
category AiAdditionalContextCategory! Category of the additional context.
content String! Content of the additional context.
id ID! ID of the additional context.
metadata JSON Metadata of the additional context.

AiAuditEvent#

Audit event recorded for a GitLab Duo Agent Platform session.

Fields#

Name Type Description
author UserCore User who triggered the audit event.
createdAt Time! Timestamp of when the audit event was created.
details JSON Event-specific details payload.
eventName String Name of the audit event.
humanAuthor UserCore Human user on whose behalf the audit event was triggered, present only for composite-identity sessions where a service account acts on behalf of a human.
id ID! ID of the audit event.
ipAddress String IP address recorded for the audit event.
sessionId AiGovernanceSessionID Global ID of the AI governance session the event belongs to.
workflowId ID ID of the Duo Agent Platform session the event belongs to. Null for events from external agents.

AiAuditEventConnection#

Paginated collection of AiAuditEvent. See Standard connection fields for the fields available on every connection.

AiCatalogAgent#

An AI catalog agent.

Implements: AiCatalogItem

Fields#

Name Type Description
configurationForGroup AiCatalogItemConsumer Introduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProject AiCatalogItemConsumer Introduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAt Time! Timestamp of when the item was created.
description String! Description of the item.
descriptionHtml String GitLab Flavored Markdown rendering of description.
effectiveVersion AiCatalogItemVersion Introduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundational Boolean! Whether the item is a foundational item.
foundationalAgentReference String Introduced as an experiment in GitLab 19.2.

Foundational agent reference.
foundationalFlowReference String Foundational flow reference.
id ID! ID of the item.
isEnabledInManagedByProject Boolean! Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemType AiCatalogItemType! Type of the item.
last30DayUsageCount Int! Number of projects using the item in the last 30 days.
latestVersion AiCatalogItemVersion Latest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
name String! Name of the item.
project Project Project for the item.
public Boolean! Deprecated in GitLab 19.3. Use visibility.
softDeleted Boolean Indicates if the item has been soft deleted.
softDeletedAt Time Timestamp of when the item was soft deleted.
starCount Int! Number of stars for the item.
starred Boolean! Whether the current user has starred the item.
updatedAt Time! Timestamp of when the item was updated.
userPermissions AiCatalogItemPermissions! Permissions for the current user on the resource.
verificationLevel AiCatalogItemVerificationLevel! Verification level of the item.
versions AiCatalogItemVersionConnection Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibility AiCatalogItemVisibility! Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPath String Introduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogAgentVersion#

An AI catalog agent version.

Implements: AiCatalogItemVersion

Fields#

Name Type Description
createdAt Time! Timestamp of when the item version was created.
createdBy UserCore User that created the item version.
deprecated Boolean! Indicates the item version has been deprecated by the author.
humanVersionName String Human-friendly name of the item version. In the form v1.0.0-draft.
id ID! ID of the item version.
item AiCatalogItem! Item the version belongs to.
mcpServers AiCatalogMcpServerConnection Introduced as an experiment in GitLab 18.10.

MCP servers associated with the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
mcpTools [String!] Introduced as an experiment in GitLab 18.11.

List of MCP tools enabled for the agent.
released Boolean! Indicates the item version is released.
releasedAt Time Timestamp of when the item version was released.
systemPrompt String System prompt for the agent.
tools AiCatalogBuiltInToolConnection! List of GitLab tools enabled for the agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp of when the item version was updated.
userPrompt String User prompt for the agent.
versionName String Version name of the item version.

AiCatalogBuiltInTool#

An AI catalog built-in tool.

Fields#

Name Type Description
description String! Description of the built-in tool.
id AiCatalogBuiltInToolID! Global ID of the built-in tool.
name String! Name of the built-in tool.
title String! Title of the built-in tool.

AiCatalogBuiltInToolConnection#

Paginated collection of AiCatalogBuiltInTool. See Standard connection fields for the fields available on every connection.

AiCatalogCustomAndFoundationalItemConnection#

Paginated collection of AiCatalogCustomAndFoundationalItem. See Standard connection fields for the fields available on every connection.

AiCatalogFlow#

An AI catalog flow.

Implements: AiCatalogItem

Fields#

Name Type Description
acceptsTriggerGoal Boolean! Introduced as an experiment in GitLab 19.5.

Whether a flow trigger for the flow can carry a configured goal.
configurationForGroup AiCatalogItemConsumer Introduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProject AiCatalogItemConsumer Introduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAt Time! Timestamp of when the item was created.
description String! Description of the item.
descriptionHtml String GitLab Flavored Markdown rendering of description.
effectiveVersion AiCatalogItemVersion Introduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundational Boolean! Whether the item is a foundational item.
foundationalFlowReference String Foundational flow reference.
id ID! ID of the item.
isEnabledInManagedByProject Boolean! Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemType AiCatalogItemType! Type of the item.
last30DayUsageCount Int! Number of projects using the item in the last 30 days.
latestVersion AiCatalogItemVersion Latest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
name String! Name of the item.
project Project Project for the item.
public Boolean! Deprecated in GitLab 19.3. Use visibility.
softDeleted Boolean Indicates if the item has been soft deleted.
softDeletedAt Time Timestamp of when the item was soft deleted.
starCount Int! Number of stars for the item.
starred Boolean! Whether the current user has starred the item.
updatedAt Time! Timestamp of when the item was updated.
userPermissions AiCatalogItemPermissions! Permissions for the current user on the resource.
verificationLevel AiCatalogItemVerificationLevel! Verification level of the item.
versions AiCatalogItemVersionConnection Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibility AiCatalogItemVisibility! Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPath String Introduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogFlowVersion#

An AI catalog flow version.

Implements: AiCatalogItemVersion

Fields#

Name Type Description
createdAt Time! Timestamp of when the item version was created.
createdBy UserCore User that created the item version.
definition String YAML definition of the flow.
deprecated Boolean! Indicates the item version has been deprecated by the author.
humanVersionName String Human-friendly name of the item version. In the form v1.0.0-draft.
id ID! ID of the item version.
item AiCatalogItem! Item the version belongs to.
released Boolean! Indicates the item version is released.
releasedAt Time Timestamp of when the item version was released.
updatedAt Time! Timestamp of when the item version was updated.
versionName String Version name of the item version.

AiCatalogItemConnection#

Paginated collection of AiCatalogItem. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogItemConsumer#

An AI catalog item configuration.

Fields#

Name Type Description
consumerKind AiCatalogItemConsumerKind! Type of configured catalog item.
enabled Boolean Indicates if the configuration item is enabled.
flowTrigger AiFlowTriggerType Deprecated in GitLab 19.4. Use flowTriggers.
flowTriggers [AiFlowTriggerType!] Introduced as an experiment in GitLab 19.4.

Triggers associated with the configured catalog item.
group Group Group in which the catalog item is configured.
id ID! ID of the configuration item.
item AiCatalogItem Configuration catalog item.
organization Organization Organization in which the catalog item is configured.
parentItemConsumer AiCatalogItemConsumer Parent item consumer associated with the configured catalog item.
pinnedItemVersion AiCatalogItemVersion Resolved item version according to the pinnedVersionPrefix.This field can only be resolved for 20 AiCatalogItemConsumers in any single request.
pinnedVersionPrefix AiCatalogPinnedVersion Version the item is pinned to, in the format n.n.n.
project Project Project in which the catalog item is configured.
serviceAccount UserCore Service account associated with the item consumer.
userPermissions AiCatalogItemConsumerPermissions! Permissions for the current user on the resource.
webPath String Web path of the catalog item consumer configuration page.

AiCatalogItemConsumerConnection#

Paginated collection of AiCatalogItemConsumer. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogItemConsumerPermissions#

Check permissions for the current user on an AI catalog item consumer.

Fields#

Name Type Description
adminAiCatalogItemConsumer Boolean! If true, the user can perform admin_ai_catalog_item_consumer on this resource.
executeAiCatalogItem Boolean! If true, the user can perform execute_ai_catalog_item on this resource.
readAiCatalogItemConsumer Boolean! If true, the user can perform read_ai_catalog_item_consumer on this resource.

AiCatalogItemPermissions#

Check permissions for the current user on an AI catalog item.

Fields#

Name Type Description
adminAiCatalogItem Boolean! If true, the user can perform admin_ai_catalog_item on this resource.
forceHardDeleteAiCatalogItem Boolean! If true, the user can perform force_hard_delete_ai_catalog_item on this resource.
readAiCatalogItem Boolean! If true, the user can perform read_ai_catalog_item on this resource.
reportAiCatalogItem Boolean! If true, the user can perform report_ai_catalog_item on this resource.

AiCatalogItemVersionConnection#

Paginated collection of AiCatalogItemVersion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogMcpServer#

An MCP (Model Context Protocol) server.

Fields#

Name Type Description
authType AiCatalogMcpServerAuthType! Authentication type for the MCP server.
blockStatus AiCatalogMcpServerBlockStatus! Block status of the MCP server for the given group or project (kill-switch state). Provide exactly one of groupFullPath or projectFullPath.

Arguments for blockStatus:
groupFullPath (ID)
Full path of the group to resolve the block status for.
projectFullPath (ID)
Full path of the project to resolve the block status for.
createdAt Time! Timestamp when the MCP server was created.
currentUserConnected Boolean! Whether the current user has connected to the MCP server.
description String Description of the MCP server.
homepageUrl String Homepage URL of the MCP server.
id ID! ID of the MCP server.
name String! Name of the MCP server.
oauthClientId String OAuth client ID for the MCP server.
organization Organization! Organization that owns the MCP server.
transport AiCatalogMcpServerTransport! Transport type for the MCP server.
updatedAt Time! Timestamp when the MCP server was last updated.
url String! URL of the MCP server.

AiCatalogMcpServerConnection#

Paginated collection of AiCatalogMcpServer. See Standard connection fields for the fields available on every connection.

AiCatalogMcpTool#

An MCP tool dynamically discovered from the GitLab MCP server.

Fields#

Name Type Description
description String Description of the MCP tool.
icons [AiCatalogMcpToolIcon!]! Icons advertised for the MCP tool, per the MCP spec icons field.
name ID! Machine-readable name of the MCP tool.
title String! Human-readable title of the MCP tool.

AiCatalogMcpToolConnection#

Paginated collection of AiCatalogMcpTool. See Standard connection fields for the fields available on every connection.

AiCatalogMcpToolIcon#

An icon advertised for an MCP tool, per the MCP spec icons field.

Fields#

Name Type Description
mimeType String! MIME type of the icon image.
src String! URL to the icon image.
theme String Theme the icon is intended for: "light" or "dark".

AiCatalogSkill#

An AI catalog skill. The repository pointer fields resolve against the latest item version.

Implements: AiCatalogItem

Fields#

Name Type Description
authorName String Introduced as an experiment in GitLab 19.5.

Git author name of the commit that last changed the published SKILL.md.
blobSha String Introduced as an experiment in GitLab 19.5.

Git object ID of the published SKILL.md blob.
commitSha String Introduced as an experiment in GitLab 19.5.

Commit that last changed the published SKILL.md.
configurationForGroup AiCatalogItemConsumer Introduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProject AiCatalogItemConsumer Introduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAt Time! Timestamp of when the item was created.
description String! Description of the item.
descriptionHtml String GitLab Flavored Markdown rendering of description.
directory String Introduced as an experiment in GitLab 19.5.

Directory of the skill. Co-located resources live alongside SKILL.md.
effectiveVersion AiCatalogItemVersion Introduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundational Boolean! Whether the item is a foundational item.
foundationalFlowReference String Foundational flow reference.
gitRef String Introduced as an experiment in GitLab 19.5.

Git reference the skill was published from.
id ID! ID of the item.
isEnabledInManagedByProject Boolean! Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemType AiCatalogItemType! Type of the item.
last30DayUsageCount Int! Number of projects using the item in the last 30 days.
latestVersion AiCatalogItemVersion Latest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
name String! Name of the item.
path String Introduced as an experiment in GitLab 19.5.

Path of the SKILL.md file in the project repository.
project Project Project for the item.
public Boolean! Deprecated in GitLab 19.3. Use visibility.
softDeleted Boolean Indicates if the item has been soft deleted.
softDeletedAt Time Timestamp of when the item was soft deleted.
starCount Int! Number of stars for the item.
starred Boolean! Whether the current user has starred the item.
updatedAt Time! Timestamp of when the item was updated.
userPermissions AiCatalogItemPermissions! Permissions for the current user on the resource.
verificationLevel AiCatalogItemVerificationLevel! Verification level of the item.
versions AiCatalogItemVersionConnection Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibility AiCatalogItemVisibility! Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPath String Introduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogSkillVersion#

An AI catalog skill version.

Implements: AiCatalogItemVersion

Fields#

Name Type Description
authorName String Introduced as an experiment in GitLab 19.5.

Git author name of the commit that last changed SKILL.md for the item version.
blobSha String Introduced as an experiment in GitLab 19.5.

Git object ID of the SKILL.md blob for the item version.
commitSha String Introduced as an experiment in GitLab 19.5.

Commit that last changed SKILL.md for the item version.
createdAt Time! Timestamp of when the item version was created.
createdBy UserCore User that created the item version.
deprecated Boolean! Indicates the item version has been deprecated by the author.
gitRef String Introduced as an experiment in GitLab 19.5.

Git reference the skill version was published from.
humanVersionName String Human-friendly name of the item version. In the form v1.0.0-draft.
id ID! ID of the item version.
item AiCatalogItem! Item the version belongs to.
path String Introduced as an experiment in GitLab 19.5.

Path of the SKILL.md file in the project repository.
released Boolean! Indicates the item version is released.
releasedAt Time Timestamp of when the item version was released.
updatedAt Time! Timestamp of when the item version was updated.
versionName String Version name of the item version.

AiCatalogThirdPartyFlow#

An AI catalog third party flow.

Implements: AiCatalogItem

Fields#

Name Type Description
acceptsTriggerGoal Boolean! Introduced as an experiment in GitLab 19.5.

Whether a flow trigger for the flow can carry a configured goal.
configurationForGroup AiCatalogItemConsumer Introduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProject AiCatalogItemConsumer Introduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAt Time! Timestamp of when the item was created.
description String! Description of the item.
descriptionHtml String GitLab Flavored Markdown rendering of description.
effectiveVersion AiCatalogItemVersion Introduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundational Boolean! Whether the item is a foundational item.
foundationalFlowReference String Foundational flow reference.
id ID! ID of the item.
isEnabledInManagedByProject Boolean! Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemType AiCatalogItemType! Type of the item.
last30DayUsageCount Int! Number of projects using the item in the last 30 days.
latestVersion AiCatalogItemVersion Latest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
name String! Name of the item.
project Project Project for the item.
public Boolean! Deprecated in GitLab 19.3. Use visibility.
softDeleted Boolean Indicates if the item has been soft deleted.
softDeletedAt Time Timestamp of when the item was soft deleted.
starCount Int! Number of stars for the item.
starred Boolean! Whether the current user has starred the item.
updatedAt Time! Timestamp of when the item was updated.
userPermissions AiCatalogItemPermissions! Permissions for the current user on the resource.
verificationLevel AiCatalogItemVerificationLevel! Verification level of the item.
versions AiCatalogItemVersionConnection Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibility AiCatalogItemVisibility! Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPath String Introduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogThirdPartyFlowVersion#

An AI catalog third party flow version.

Implements: AiCatalogItemVersion

Fields#

Name Type Description
createdAt Time! Timestamp of when the item version was created.
createdBy UserCore User that created the item version.
definition String! YAML definition of the third party flow.
deprecated Boolean! Indicates the item version has been deprecated by the author.
humanVersionName String Human-friendly name of the item version. In the form v1.0.0-draft.
id ID! ID of the item version.
item AiCatalogItem! Item the version belongs to.
released Boolean! Indicates the item version is released.
releasedAt Time Timestamp of when the item version was released.
updatedAt Time! Timestamp of when the item version was updated.
versionName String Version name of the item version.

AiChatQuestionCategory#

Category of suggested questions for GitLab Duo Chat.

Fields#

Name Type Description
contextual Boolean! Indicates whether the questions are about the resource on the current page. At most one category is contextual, and the agent category, when present, is returned before it.
key String! Stable identifier of the category. agent for the agent category, the current page type for contextual categories, for example merge_request or blob, and the topic for static ones, for example security.
questions [String!]! Suggested questions in the category.
title String! Display title of the category, for example the name of the selected agent or the reference of the current resource.

AiConversationsThread#

Conversation thread of the AI feature.

Fields#

Name Type Description
conversationType AiConversationsThreadsConversationType! Conversation type of the thread.
createdAt Time! Created date of the thread.
id ID! ID of the thread.
lastUpdatedAt Time! Last updated date of the thread.
title String Title of the thread.

AiConversationsThreadConnection#

Paginated collection of AiConversationsThread. See Standard connection fields for the fields available on every connection.

AiFeatureSetting#

Duo Chat feature setting.

Fields#

Name Type Description
allowList AiModelSelectionAllowList Introduced as an experiment in GitLab 19.1.

Model selection allowlist for the feature. Returns null when the current user cannot read the allowlist or when the feature does not support one.
compatibleLlms [String!] LLMs Compatible with the feature.
defaultGitlabModel AiModelSelectionOfferedModel GitLab model selected for use with the AI feature.
feature String! Identifier for the AI feature.
gitlabModel AiModelSelectionOfferedModel GitLab model selected for use with the AI feature.
mainFeature String Displayed name of the main feature.
provider String! Humanized name for the AI feature, e.g "Code Completion".
releaseState String Current release state of the feature.
selfHostedModel AiSelfHostedModel Self-hosted model selected for use with the AI feature.
title String Displayed AI feature name.
validGitlabModels AiModelSelectionOfferedModelConnection! Valid GitLab managed models for the feature. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
validModels AiSelfHostedModelConnection! Compatible self-hosted models for the feature. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

AiFeatureSettingConnection#

Paginated collection of AiFeatureSetting. See Standard connection fields for the fields available on every connection.

AiFlowCapability#

A capability the instance advertises for Duo Agent Platform flows.

Fields#

Name Type Description
metadata JSON Arbitrary JSON-encoded metadata associated with the capability.
name String! Name of the capability.

AiFlowScheduleLastRun#

Details of the most recent execution attempt of a flow schedule.

Fields#

Name Type Description
error String Error message from the most recent failed execution.
ranAt Time Timestamp of the most recent execution attempt.
status String Status of the most recent execution attempt.

AiFlowScheduleType#

Represents a cron-based schedule for an AI flow trigger.

Fields#

Name Type Description
active Boolean! Indicates the schedule is active.
consecutiveFailureCount Int! Number of consecutive execution failures.
createdAt Time! Timestamp of when the flow schedule was created.
cron String! Cron expression defining the schedule frequency.
cronTimezone String! IANA timezone for the cron expression.
description String! Description of the flow schedule.
flowTrigger AiFlowTriggerType! Flow trigger the schedule executes.
id AiFlowScheduleID! Global ID of the flow schedule.
lastRun AiFlowScheduleLastRun Details of the most recent execution attempt, or null if the schedule has never run.
nextRunAt Time Timestamp of the next scheduled execution.
project Project! Project of the flow schedule.
updatedAt Time! Timestamp of when the flow schedule was last updated.

AiFlowScheduleTypeConnection#

Paginated collection of AiFlowScheduleType. See Standard connection fields for the fields available on every connection.

AiFlowTriggerType#

Represents an AI flow trigger.

Fields#

Name Type Description
active Boolean! Introduced as an experiment in GitLab 19.4.

Indicates whether the flow trigger is active. Inactive triggers do not run automatically.
aiCatalogItemConsumer AiCatalogItemConsumer AI catalog item consumer associated with the trigger.
configPath String Path to the configuration file for the trigger.
configUrl String Web URL to the configuration file for the trigger.
createdAt Time! Timestamp of when the flow trigger was created.
description String! Description of the flow trigger.
eventTypes [Int!]! List of events that triggers the flow.
filter JSON Introduced as an experiment in GitLab 18.11.

Filter conditions for the AI flow trigger.
flowSchedules AiFlowScheduleTypeConnection Introduced as an experiment in GitLab 19.4.

Cron-based schedules associated with the flow trigger. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
goals JSON! Introduced as an experiment in GitLab 19.5.

Goals for the AI flow trigger, keyed by event type.
id ID! ID of the flow trigger.
precondition JSON Introduced as an experiment in GitLab 18.11.

Enforced filter conditions from the foundational flow definition.
project Project! Project of the flow trigger.
updatedAt Time! Timestamp of when the flow trigger was last updated.
user UserCore Service account of the flow trigger.

AiFlowTriggerTypeConnection#

Paginated collection of AiFlowTriggerType. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiFlowsMetadata#

Metadata describing Duo Agent Platform flow capabilities available to the caller.

Fields#

Name Type Description
capabilities [AiFlowCapability!]! List of capabilities the instance advertises for Duo Agent Platform flows.

AiFoundationalChatAgent#

Core Agent available for GitLab features.

Fields#

Name Type Description
avatarUrl String Avatar URL of the foundational chat agent.
description String! Description of the agent.
flowConfig AiFoundationalChatAgentFlowConfig Flow versioning parameters used when starting a workflow for this agent. Null for agents that resolve versioning elsewhere (e.g. AI Catalog-backed agents).
id AiFoundationalChatAgentID! Global ID of the foundational chat agent.
name String! Name of the agent.
reference String! Reference ID of the agent.
referenceWithVersion String Versioned reference of the agent.
selectableInChat Boolean! Whether the agent is selectable in the chat agent selection UI.
systemPrompt String System prompt for the agent.
tools [AiCatalogBuiltInTool!]! List of built-in tools enabled for the agent.
version String Version of the agent.
visibility AiCatalogItemVisibility! Visibility of the agent in the catalog.

AiFoundationalChatAgentConnection#

Paginated collection of AiFoundationalChatAgent. See Standard connection fields for the fields available on every connection.

AiFoundationalChatAgentFlowConfig#

Flow versioning parameters for a foundational chat agent.

Fields#

Name Type Description
flowConfigId String Flow config ID sent to the Duo Workflow Service.
flowConfigSchemaVersion String Flow config schema version sent to the Duo Workflow Service.
flowVersion String Flow version sent to the Duo Workflow Service.

AiGovernanceConnectedAgent#

Registered external agents of one type, with their session activity.

Fields#

Name Type Description
activeCount Int! Registered machines whose identity has not been revoked.
agentType String! External agent type, for example claude-code.
identityCount Int! Registered machines of the agent type, revoked ones included.
lastSessionAt Time When a machine of the agent type last opened a session, across all time.
revokedCount Int! Registered machines whose identity was revoked.
sessionCount Int! Sessions opened by these machines in the selected timeframe.
userCount Int! Distinct users with a registered machine of the agent type.

AiGovernanceKpi#

Aggregated KPI for the AI governance dashboard.

Fields#

Name Type Description
count Int Count in the selected timeframe.
cumulativeTrend [AiGovernanceKpiTrendPoint!] Introduced as an experiment in GitLab 19.4.

Running totals across the selected timeframe: each bucket is the total as of the end of that bucket, seeded with the 30 days before the timeframe. Agents count from the bucket of their first session in that period onward, so the series is monotonic and its last point can exceed count.
previousCount Int Count in the preceding timeframe of equal length.
trend [AiGovernanceKpiTrendPoint!] Bucketed counts across the selected timeframe. Each bucket is computed independently, so for distinct-count KPIs such as agents the buckets do not sum to count: an agent active on several days is counted once per day here and once in the total.

AiGovernanceKpiTrendPoint#

Single bucket of an AI governance KPI trend series.

Fields#

Name Type Description
bucketStart Time! Timestamp of the start of the bucket.
count Int! Count of items in the bucket.

AiGovernanceMetrics#

Aggregated AI governance dashboard metrics.

Fields#

Name Type Description
agents AiGovernanceKpi Distinct AI agent instances with sessions in the timeframe. Chat conversations are not counted.
connectedAgents [AiGovernanceConnectedAgent!] Registered external (Connected) agents by type, ordered by registered machines. Empty when agentClass is INTERNAL_DAP.

Arguments for connectedAgents:
limit (Int)
Number of agent types to return. Defaults to 5, maximum 20.
sessionDistribution AiGovernanceSessionDistribution Introduced as an experiment in GitLab 19.5.

Sessions and distinct developers in the timeframe, split by agent or flow type. Empty when ClickHouse is not enabled for analytics. Returns null when the ai_governance_dashboard_charts feature flag is disabled.
sessions AiGovernanceKpi AI sessions in the timeframe, including Duo Chat conversations.
toolCalls AiGovernanceKpi Introduced as an experiment in GitLab 19.5.

Tools invoked by AI agents in the timeframe. Counts every invocation, not distinct tools. Returns null when the ai_governance_tool_calls feature flag is disabled or when ClickHouse is not enabled.
topProjects [AiGovernanceProjectActivity!] Projects with the most AI sessions in the timeframe, ordered by session count. Sessions attached to a namespace rather than a project are not counted.

Arguments for topProjects:
limit (Int)
Number of projects to return. Defaults to 5, maximum 20.
topUsers [AiGovernanceUserActivity!] Users with the most AI sessions in the timeframe, ordered by session count.

Arguments for topUsers:
limit (Int)
Number of users to return. Defaults to 5, maximum 20.

AiGovernanceProjectActivity#

AI session activity in a single project.

Fields#

Name Type Description
project Project Project the sessions ran in. Resolves to null when the current user cannot read the project.
sessionCount Int Number of AI sessions in the project in the selected timeframe.

AiGovernanceSession#

AI session recorded for AI governance, from GitLab Duo or an external agent.

Fields#

Name Type Description
agentType String Type of the agent that ran the session, for example claude-code. Values differ between sources.
auditEvents AiAuditEventConnection Audit events recorded for the session. Returns no events for GitLab Duo sessions delivered through a private messaging integration. This field can only be resolved for one session in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
auditEventsCount Int Number of audit events recorded for the session.
downloadPath String Path to download the session artifact as a JSON file. Null for sessions from sources other than GitLab Duo.
flowType String Flow type of the session, for example chat. Values differ between sources.
id AiGovernanceSessionID! Global ID of the session.
project Project Project the session belongs to. Null for namespace-scoped sessions, or when the current user cannot read the project.
sessionId String ID of the session in its source. For GitLab Duo sessions, the Duo workflow ID. For other sources, the session ID from the external agent.
sessionStartedAt Time! Timestamp of when the session started.
source AiGovernanceSessionSource! Source that recorded the session.
triggeredBy UserCore User who initiated the session.
webPath String Path of the session page. Null for sessions from sources other than GitLab Duo, and for GitLab Duo sessions without a project.

AiGovernanceSessionConnection#

Paginated collection of AiGovernanceSession. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiGovernanceSessionDistribution#

AI sessions and developers in the timeframe, split by agent or flow type.

Fields#

Name Type Description
slices [AiGovernanceSessionDistributionSlice!]! Slices ordered by developers, then sessions, then name. Returns the top 10. Missing names are reported as unknown.
totalDevelopers Int! Number of distinct developers with sessions in the timeframe, across all slices.
totalSessions Int! Number of sessions in the timeframe, across all slices.

AiGovernanceSessionDistributionSlice#

AI sessions and developers for one agent or flow type.

Fields#

Name Type Description
developers Int! Number of distinct developers with sessions in the slice.
name String! Name of the slice. Version-less flow type for INTERNAL_DAP, agent type for EXTERNAL. For ALL, gitlab_duo for GitLab Duo sessions and agent type for external sessions.
sessions Int! Number of sessions in the slice.

AiGovernanceToolCall#

AI agent tool usage aggregated for the AI governance dashboard.

Fields#

Name Type Description
count Int! Number of tool invocations in the selected timeframe.
toolName String! Name of the tool.

AiGovernanceToolCallsByRisk#

AI agent tool calls grouped by risk level.

Fields#

Name Type Description
approximate Boolean! Whether the counts leave out some tools because the namespace used more distinct tools than are read.
slices [AiGovernanceToolCallsRiskSlice!]! Tool calls per risk level, in the order READ, WRITE, DESTROY, UNCLASSIFIED. Risk levels with no calls have a count of zero.
total Int! Total number of tool invocations in the selected timeframe.

AiGovernanceToolCallsReport#

Top tools invoked by AI agents, with a flag marking approximate counts.

Fields#

Name Type Description
approximate Boolean! Indicates whether counts were capped and are approximate.
byRisk AiGovernanceToolCallsByRisk Introduced as an experiment in GitLab 19.5.

Tool calls grouped by risk level. Computed only when selected.
nodes [AiGovernanceToolCall!]! Tools invoked in the selected timeframe, ordered by invocation count.

AiGovernanceToolCallsRiskSlice#

Number of AI agent tool calls at one risk level.

Fields#

Name Type Description
count Int! Number of tool invocations at the risk level in the selected timeframe.
risk AiGovernanceToolRisk! Risk level of the tools.

AiGovernanceUserActivity#

AI session activity of a single user.

Fields#

Name Type Description
sessionCount Int Number of AI sessions the user started in the selected timeframe.
user UserCore User the sessions belong to.

AiInstanceUsageData#

Instance wide usage data for events stored in either PostgreSQL (default) or ClickHouse (when configured). Data retention: three months in PostgreSQL, indefinite in ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
all AiInstanceUsageEventConnection All Duo usage events. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for all:
endDate (Date)
End date for the date range. Default is the current day.
events ([AiUsageEventType!])
Filters by events.
startDate (Date)
Start date for the date range. Default is 7 days before the current date.
userIds ([UserID!])
Filters by users.

AiInstanceUsageEvent#

Fields#

Name Type Description
event AiUsageEventType! Type of the event.
extras JSON Associated event context data.
namespacePath String Namespace hierarchy for Namespace or ProjectNamespace associated with the event.
timestamp Time! When the event happened.
user UserCore! User associated with the event.

AiInstanceUsageEventConnection#

Paginated collection of AiInstanceUsageEvent. See Standard connection fields for the fields available on every connection.

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.
threadId AiConversationThreadID Global ID of the existing thread for the Chat conversation.
timestamp Time! Message creation timestamp.
type AiMessageType Message type.

AiMessageConnection#

Paginated collection of AiMessage. See Standard connection fields for the fields available on every connection.

AiMessageExtras#

Extra metadata for AI message.

Fields#

Name Type Description
additionalContext [AiAdditionalContext!] Additional context for the message.
hasFeedback Boolean Whether the user has provided feedback for the message.
sources [JSON!] Sources used to form the message.

AiMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
agentPlatform agentPlatformMetrics Duo Agent Platform metrics.

Arguments for agentPlatform:
flowTypes ([String!])
List of flow types to filter.
not (AgentPlatformMetricsNotInput)
Negation filters.
chat duoChatMetrics Duo Chat metrics.
codeContributorsCount Int Number of code contributors.
codeReview codeReviewMetrics Code review metrics.
codeSuggestions codeSuggestionMetrics Code suggestions metrics.

Arguments for codeSuggestions:
ideNames ([String!])
Filter code suggestion metrics by one or more IDE names.
languages ([String!])
Filter code suggestion metrics by one or more languages.
codeSuggestionsAcceptedCount Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
codeSuggestionsContributorsCount Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
codeSuggestionsShownCount Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
duoChatContributorsCount Int Number of contributors who used GitLab Duo Chat features.
duoUsedCount Int Number of contributors who used any GitLab Duo feature.
mcp mcpMetrics Model Context Protocol metrics.
rootCauseAnalysisUsersCount Int Number of users using troubleshoot within a failed pipeline.
troubleshoot troubleshootJobMetrics Troubleshoot job metrics.

AiModelSelectionAllowList#

Model selection allowlist for an AI feature.

Fields#

Name Type Description
enabled Boolean! Whether the model selection allowlist is enabled for the feature.
models AiModelSelectionAllowListModelConnection! All GitLab-managed models offered for the feature with their effective allowlist state. Includes both allowed and disallowed models so callers can render a complete allowlist UI. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

AiModelSelectionAllowListModel#

GitLab-managed model row in the model selection allowlist for a feature.

Fields#

Name Type Description
allowed Boolean! Whether the model is allowed for this feature under the effective allowlist. The currently chosen/default model for the feature is implicitly allowed and is therefore true even when the allowlist is enabled and the model is not in the stored allowlist refs.
costIndicator String Introduced as an experiment in GitLab 18.7.

Presentational cost indicator for model usage, e.g "$", "$$", "$$$".
currentlyChosenModelForFeature Boolean! Whether this model is the currently chosen/default model for the feature. This is the admin-chosen model when set, otherwise the GitLab default model from definitions.
modelDescription String Introduced as an experiment in GitLab 18.7.

Brief description of the model, e.g "Fast, cost-effective responses".
modelProvider String Introduced as an experiment in GitLab 18.6.

Provider for the model, e.g "OpenAI".
name String! Humanized name for the offered model, e.g "Chat GPT 4o".
ref String! Identifier for the offered model.

AiModelSelectionAllowListModelConnection#

Paginated collection of AiModelSelectionAllowListModel. See Standard connection fields for the fields available on every connection.

AiModelSelectionNamespaceFeatureSetting#

Model Selection feature setting for namespaces.

Fields#

Name Type Description
allowList AiModelSelectionAllowList Introduced as an experiment in GitLab 19.1.

Model selection allowlist for the feature. Returns null when the current user cannot read the allowlist or when the feature does not support one.
defaultModel AiModelSelectionOfferedModel LLMs Compatible with the feature.
feature String! Identifier for the AI feature.
mainFeature String Displayed name of the main feature.
namespace Group! Namespace that the feature setting is set for.
selectableModels [AiModelSelectionOfferedModel!]! LLMs Compatible with the feature.
selectedModel AiModelSelectionOfferedModel Identifier of the current model selected.
title String Displayed AI feature name.

AiModelSelectionNamespaceFeatureSettingConnection#

Paginated collection of AiModelSelectionNamespaceFeatureSetting. See Standard connection fields for the fields available on every connection.

AiModelSelectionOfferedModel#

Model offered for Model Selection.

Fields#

Name Type Description
costIndicator String Introduced as an experiment in GitLab 18.7.

Presentational cost indicator for model usage, e.g "$", "$$", "$$$".
modelDescription String Introduced as an experiment in GitLab 18.7.

Brief description of the model, e.g "Fast, cost-effective responses".
modelProvider String Introduced as an experiment in GitLab 18.6.

Provider for the model, e.g "OpenAI".
name String! Humanized name for the offered model, e.g "Chat GPT 4o".
ref String! Identifier for the offered model.
requiresPaidCredits Boolean Introduced as an experiment in GitLab 19.5.

Whether GitLab Credits must be purchased before the current user can use this model.

AiModelSelectionOfferedModelConnection#

Paginated collection of AiModelSelectionOfferedModel. See Standard connection fields for the fields available on every connection.

AiNamespaceSettings#

Fields#

Name Type Description
aiCatalogRestrictedToGroupHierarchy Boolean! Indicates whether the AI Catalog is restricted to items within the top-level group's hierarchy.
duoWorkflowMcpEnabled Boolean! Indicates whether the namespace has MCP enabled.
promptInjectionProtectionLevel PromptInjectionProtectionLevel! Level of prompt injection protection for the namespace.
webSearchEnabled Boolean! Indicates whether web search is allowed in GitLab Duo Chat for the namespace.

AiSelfHostedModel#

Self-hosted LLM servers.

Fields#

Name Type Description
apiToken String Optional API key for the self-hosted model server.
createdAt Time! Timestamp of creation.
endpoint String Endpoint of the self-hosted model server.
featureSettings AiFeatureSettingConnection AI feature settings using the self-hosted model. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
hasApiToken Boolean! Indicates if an API key is set for the self-hosted model server.
iamRole String IAM role ARN that the AI Gateway assumes when calling Amazon Bedrock.
id AiSelfHostedModelID! ID of the self-hosted model server.
identifier String Identifier for 3rd party model provider.
model String! AI model deployed.
modelDisplayName String! Display name of the AI model deployed.
name String! Deployment name of the self-hosted model.
provider AiSelfHostedModelProvider! Provider for the self-hosted model.
releaseState AiSelfHostedModelReleaseState! GitLab release status of the model.
updatedAt Time Timestamp of last update.

AiSelfHostedModelConnection#

Paginated collection of AiSelfHostedModel. See Standard connection fields for the fields available on every connection.

AiSuggestedReviewer#

AI-recommended reviewer for a merge request.

Fields#

Name Type Description
approvalRule ApprovalRule Approval rule the user was suggested as a reviewer for.
createdAt Time! Timestamp of when the suggestion was created.
id ID! ID of the suggested reviewer.
reason String Model rationale for recommending the user.
user UserCore User recommended as a reviewer.

AiSuggestedReviewerConnection#

Paginated collection of AiSuggestedReviewer. See Standard connection fields for the fields available on every connection.

AiToolRule#

A governance rule for an AI agent tool.

Fields#

Name Type Description
actionType AiToolActionType! Action type categorisation for the tool.
backgroundAccess AiBackgroundToolPermission Introduced as an experiment in GitLab 19.3.

Effective permission mode for the background-flow surface, after applying group and project rules and the default.
category String! Display category for the tool. For example, GitLab Read, Files, and Commands.
configuredAccess AiToolRuleAccess! Introduced as an experiment in GitLab 19.5.

Permission modes set at the requested scope: the project when a project path is given, otherwise the namespace. A null mode is not set at that scope.
defaultAccess AiToolRuleAccess! Introduced as an experiment in GitLab 19.5.

Permission modes that apply when no rule is set.
id ID! Tool name. Used as stable identifier. Always the tool name string and never a database ID.
localAccess AiToolPermission Effective permission mode for local or IDE surface, after applying group and project rules and the default.
name String! Name of the tool as registered in the tool registry.
source AiToolSource! Source of the tool. Either "gitlab" or "mcp".
webAccess AiToolPermission Effective permission mode for web surface, after applying group and project rules and the default.

AiToolRuleAccess#

Permission modes of an AI tool rule for each surface.

Fields#

Name Type Description
backgroundAccess AiBackgroundToolPermission Permission mode for the background-flow surface.
localAccess AiToolPermission Permission mode for the local or IDE surface.
webAccess AiToolPermission Permission mode for the web surface.

AiToolRuleConnection#

Paginated collection of AiToolRule. See Standard connection fields for the fields available on every connection.

AiUsageData#

Usage data for events stored in either PostgreSQL (default) or ClickHouse (when configured). Data retention: three months in PostgreSQL, indefinite in ClickHouse. Requires a personal access token. Works only on top-level groups. Premium and Ultimate only.

Fields#

Name Type Description
all AiUsageEventConnection All Duo usage events. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for all:
endDate (Date)
End date for the date range. Default is the current day.
events ([AiUsageEventType!])
Filters by events.
startDate (Date)
Start date for the date range. Default is 7 days before the current date.
userIds ([UserID!])
Filters by users.
codeSuggestionEvents CodeSuggestionEventConnection Events related to code suggestions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for codeSuggestionEvents:
endDate (Date)
End date for the date range. Default is the current day.
events ([AiUsageEventType!])
Filters by events.
startDate (Date)
Start date for the date range. Default is 7 days before the current date.
userIds ([UserID!])
Filters by users.

AiUsageEvent#

Fields#

Name Type Description
event AiUsageEventType! Type of the event.
timestamp Time! When the event happened.
user UserCore! User associated with the event.

AiUsageEventConnection#

Paginated collection of AiUsageEvent. See Standard connection fields for the fields available on every connection.

AiUserMetrics#

Pre-aggregated per-user metrics for GitLab Code Suggestions and GitLab Duo Chat. Requires ClickHouse to be enabled. Premium or Ultimate only.

Fields#

Name Type Description
agentPlatform agentPlatformUserMetrics Agent Platform metrics for the user.
aiCatalog aiCatalogUserMetrics Ai Catalog metrics for the user.
chat chatUserMetrics Chat metrics for the user.
codeReview codeReviewUserMetrics Code Review metrics for the user.
codeSuggestions codeSuggestionsUserMetrics Code Suggestions metrics for the user.
codeSuggestionsAcceptedCount Int Deprecated in GitLab 18.7. Use codeSuggestions.codeSuggestionAcceptedInIdeEventCount instead.
duoChatInteractionsCount Int Deprecated in GitLab 18.7. Use chat.requestDuoChatResponseEventCount instead.
duoMessaging duoMessagingUserMetrics Duo Messaging metrics for the user.
duoWorkflow duoWorkflowUserMetrics Duo Workflow metrics for the user.
explainCode explainCodeUserMetrics Explain Code metrics for the user.
explainVulnerability explainVulnerabilityUserMetrics Explain Vulnerability metrics for the user.
featureDiscovery featureDiscoveryUserMetrics Feature Discovery metrics for the user.
fixCode fixCodeUserMetrics Fix Code metrics for the user.
fixPipeline fixPipelineUserMetrics Fix Pipeline metrics for the user.
generateMergeCommitMessage generateMergeCommitMessageUserMetrics Generate Merge Commit Message metrics for the user.
lastDuoActivityOn Date Date of the last Duo activity across all features for the user.
mcp mcpUserMetrics Mcp metrics for the user.
refactorCode refactorCodeUserMetrics Refactor Code metrics for the user.
requestDuoVulnerabilityResolution requestDuoVulnerabilityResolutionUserMetrics Request Duo Vulnerability Resolution metrics for the user.
summarizeNewMergeRequest summarizeNewMergeRequestUserMetrics Summarize New Merge Request metrics for the user.
summarizeReview summarizeReviewUserMetrics Summarize Review metrics for the user.
totalEventCount Int Total count of all tracked events for the user.
troubleshootJob troubleshootJobUserMetrics Deprecated in GitLab 19.1. Legacy troubleshoot job metrics for the user (event ID 7 only). For current GitLab Duo Agent Platform-based troubleshoot jobs, use agentPlatformSessions with flow_type = 'fix_pipeline/v1'.
user AddOnUser User associated with metrics.
writeTests writeTestsUserMetrics Write Tests metrics for the user.

AiUserMetricsConnection#

Paginated collection of AiUserMetrics. See Standard connection fields for the fields available on every connection.

AiVectorizableFileUploadRegistry#

Represents the Geo replication and verification state of an ai_vectorizable_file_upload.

Fields#

Name Type Description
aiVectorizableFileUploadId ID! ID of the AI Vectorizable File Upload.
checksumMismatch Boolean Indicate if the checksums of the AiVectorizableFileUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AiVectorizableFileUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AiVectorizableFileUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AiVectorizableFileUploadRegistry.
lastSyncFailure String Error message during sync of the AiVectorizableFileUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AiVectorizableFileUploadRegistry.
missingOnPrimary Boolean Indicate if the AiVectorizableFileUploadRegistry is missing on primary.
modelRecordId Int ID of the AiVectorizableFileUploadRegistry's model record.
retryAt Time Timestamp after which the AiVectorizableFileUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AiVectorizableFileUploadRegistry.
state RegistryState Sync state of the AiVectorizableFileUploadRegistry.
verificationChecksum String The local checksum of the AiVectorizableFileUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AiVectorizableFileUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AiVectorizableFileUploadRegistry.
verificationRetryAt Time Timestamp after which the AiVectorizableFileUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AiVectorizableFileUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AiVectorizableFileUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AiVectorizableFileUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AiVectorizableFileUploadRegistry.

AiVectorizableFileUploadRegistryConnection#

Paginated collection of AiVectorizableFileUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

AiXrayReport#

Fields#

Name Type Description
language String! Language of the x-ray report.

AiXrayReportConnection#

Paginated collection of AiXrayReport. See Standard connection fields for the fields available on every connection.

AlertManagementAlert#

Describes an alert from the project's Alert Management.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
assignees UserCoreConnection Assignees of the alert. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
endedAt Time Timestamp the alert ended.
environment Environment Environment for the alert.
eventCount Int Number of events of the alert.
hosts [String!] List of hosts the alert came from.
id ID! ID of the alert.
iid String! Internal ID of the alert.
issue Issue Issue attached to the alert.
issueIid String Deprecated in GitLab 13.10. Use issue field.
metricsDashboardUrl String Deprecated in GitLab 16.0. Returns no data. Underlying feature was removed in 16.0.
monitoringTool String Monitoring tool the alert came from.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
prometheusAlert PrometheusAlert Deprecated in GitLab 17.3. Returns no data. Underlying feature was removed in 16.0.
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.
todos TodoConnection To-do items of the current user for the alert. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
updatedAt Time Timestamp the alert was last updated.
webUrl String! URL of the alert.

AlertManagementAlertConnection#

Paginated collection of AlertManagementAlert. See Standard connection fields for the fields available on every connection.

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.

Implements: AlertManagementIntegration

Fields#

Name Type Description
active Boolean Whether the endpoint is currently accepting alerts.
apiUrl String Deprecated in GitLab 18.2. Feature removed in 16.0.
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.

AlertManagementHttpIntegrationConnection#

Paginated collection of AlertManagementHttpIntegration. See Standard connection fields for the fields available on every connection.

AlertManagementIntegrationConnection#

Paginated collection of AlertManagementIntegration. See Standard connection fields for the fields available on every connection.

AlertManagementMetricImageUploadRegistry#

Represents the Geo replication and verification state of a alert_management_metric_image_upload.

Fields#

Name Type Description
alertManagementMetricImageUploadId ID! ID of the Alert Management Metric Image Upload.
checksumMismatch Boolean Indicate if the checksums of the AlertManagementMetricImageUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AlertManagementMetricImageUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AlertManagementMetricImageUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AlertManagementMetricImageUploadRegistry.
lastSyncFailure String Error message during sync of the AlertManagementMetricImageUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AlertManagementMetricImageUploadRegistry.
missingOnPrimary Boolean Indicate if the AlertManagementMetricImageUploadRegistry is missing on primary.
modelRecordId Int ID of the AlertManagementMetricImageUploadRegistry's model record.
retryAt Time Timestamp after which the AlertManagementMetricImageUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AlertManagementMetricImageUploadRegistry.
state RegistryState Sync state of the AlertManagementMetricImageUploadRegistry.
verificationChecksum String The local checksum of the AlertManagementMetricImageUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AlertManagementMetricImageUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AlertManagementMetricImageUploadRegistry.
verificationRetryAt Time Timestamp after which the AlertManagementMetricImageUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AlertManagementMetricImageUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AlertManagementMetricImageUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AlertManagementMetricImageUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AlertManagementMetricImageUploadRegistry.

AlertManagementMetricImageUploadRegistryConnection#

Paginated collection of AlertManagementMetricImageUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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#

DEPRECATED - Use AlertManagementHttpIntegration directly An endpoint and credentials used to accept Prometheus alerts for a project.

Implements: AlertManagementIntegration

Fields#

Name Type Description
active Boolean Whether the endpoint is currently accepting alerts.
apiUrl String Deprecated in GitLab 18.2. Feature removed in 16.0.
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.

Implements: AmazonS3ConfigurationInterface

Fields#

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
active Boolean! Active status of the destination.
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.

AmazonS3ConfigurationTypeConnection#

Paginated collection of AmazonS3ConfigurationType. See Standard connection fields for the fields available on every connection.

Analytics#

ClickHouse-based analytics endpoints aggregating data across groups and projects. Data can be delayed by 10 minutes.

Fields#

Name Type Description
agentPlatformSessions AgentPlatformSessionsAggregationScope Aggregation engine for GitLab Duo Agent Platform sessions usage.

Arguments for agentPlatformSessions:
createdEventAtFrom (Time)
Filter by session creation timestamp. Start of the range.
createdEventAtTo (Time)
Filter by session creation timestamp. End of the range.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
flowType ([String!])
Filter by one or many flow types.
flowTypeNot ([String!])
Exclude one or many flow types. Maximum is 100.
projectId ([String!])
Filter by one or many project Global IDs.
projectIdNot ([String!])
Exclude one or many project Global IDs. Sessions not scoped to a project are returned, because they store 0 rather than NULL. Maximum is 100.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Maximum is 100.
contributions ContributionsAggregationScope Introduced as an experiment in GitLab 19.0.

Aggregation engine for contribution analytics. Requires Siphon replication to be enabled on the instance.

Arguments for contributions:
authorId ([String!])
Filter by one or many author Global IDs.
authorIdNot ([String!])
Exclude one or many author Global IDs. Maximum is 100.
createdAtFrom (Time)
Filter by contribution timestamp. Start of the range.
createdAtTo (Time)
Filter by contribution timestamp. End of the range.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
deployments DeploymentsAggregationScope Introduced as an experiment in GitLab 19.0.

Aggregation engine for deployment analytics. Requires Siphon replication to be enabled on the instance.

Arguments for deployments:
createdAtFrom (Time)
Filter by deployment creation timestamp. Start of the range.
createdAtTo (Time)
Filter by deployment creation timestamp. End of the range.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
environmentId ([String!])
Filter by one or many environment Global IDs.
environmentIdNot ([String!])
Exclude one or many environment Global IDs. Maximum is 100.
finishedAtFrom (Time)
Filter by deployment finish timestamp. Start of the range.
finishedAtTo (Time)
Filter by deployment finish timestamp. End of the range.
ref ([String!])
Filter by one or many deployment refs.
refNot ([String!])
Exclude one or many deployment refs. Maximum is 100.
status ([String!])
Filter by one or many deployment statuses.
statusNot ([String!])
Exclude one or many deployment statuses. Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Deployments with no triggering user are excluded as well. Maximum is 100.
duoCodeSuggestions DuoCodeSuggestionsAggregationScope Aggregation engine for GitLab Duo Code Suggestions usage.

Arguments for duoCodeSuggestions:
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
ideName ([String!])
Filter by IDE name.
ideNameNot ([String!])
Exclude one or many IDE names. Maximum is 100.
language ([String!])
Filter by suggestion language.
languageNot ([String!])
Exclude one or many suggestion languages. Maximum is 100.
timestampFrom (Time)
Filter by suggestion timestamp. Start of the range.
timestampTo (Time)
Filter by suggestion timestamp. End of the range.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Maximum is 100.
duoUsageEvents DuoUsageEventsAggregationScope Aggregation engine for GitLab Duo AI usage events.

Arguments for duoUsageEvents:
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
event ([String!])
Filter by one or many events.
eventNot ([String!])
Exclude one or many events. Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
feature ([String!])
Filter by one or many features.
featureNot ([String!])
Exclude one or many features. Events with no recognized feature are excluded as well. Maximum is 100.
flowType ([String!])
Filter by one or many Duo Agent Platform flow types.
flowTypeNot ([String!])
Exclude one or many Duo Agent Platform flow types. Returns only Duo Agent Platform events, because events from elsewhere have no flow type. Maximum is 100.
groupId ([String!])
Filter by one or many group Global IDs, including events from their descendants.
timestampFrom (Time)
Filter by event timestamp. Start of the range.
timestampTo (Time)
Filter by event timestamp. End of the range.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Maximum is 100.
duoWorkflows DuoWorkflowsAggregationScope Introduced as an experiment in GitLab 19.4.

Aggregation engine for GitLab Duo Agent Platform flows. Requires Siphon replication to be enabled on the instance.

Arguments for duoWorkflows:
activeDaysFrom (Int)
Filter by the number of distinct days the user created flows in the selected period. Start of the range.
activeDaysTo (Int)
Filter by the number of distinct days the user created flows in the selected period. End of the range.
createdAtFrom (Time)
Filter by flow creation timestamp. Start of the range.
createdAtTo (Time)
Filter by flow creation timestamp. End of the range.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
flowTypesUsedFrom (Int)
Filter by the number of distinct flow types the user ran in the selected period. Start of the range.
flowTypesUsedTo (Int)
Filter by the number of distinct flow types the user ran in the selected period. End of the range.
groupId ([String!])
Filter by one or many group Global IDs, including flows from their descendants.
modelUsed ([String!])
Filter by one or many models.
modelUsedNot ([String!])
Exclude one or many models. Flows with no attributed model are stored as an empty string, so pass one to exclude them. Maximum is 100.
projectId ([String!])
Filter by one or many project Global IDs.
projectIdNot ([String!])
Exclude one or many project Global IDs. Flows created at namespace level are excluded as well. Maximum is 100.
status ([String!])
Filter by one or many flow statuses (created, running, finished, failed, ...).
statusNot ([String!])
Exclude one or many flow statuses (created, running, finished, failed, ...). Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Maximum is 100.
workflowDefinition ([String!])
Filter by one or many flow types.
workflowDefinitionNot ([String!])
Exclude one or many flow types. Maximum is 100.
mergeRequests MergeRequestsAggregationScope Introduced as an experiment in GitLab 19.2.

Aggregation engine for merge request analytics. Requires Siphon replication to be enabled on the instance.

Arguments for mergeRequests:
authorId ([String!])
Filter by one or many author Global IDs.
authorIdNot ([String!])
Exclude one or many author Global IDs. Merge requests with no author are excluded as well. Maximum is 100.
createdAtFrom (Time)
Filter by merge request creation timestamp. Start of the range.
createdAtTo (Time)
Filter by merge request creation timestamp. End of the range.
createdByDuo ([Boolean!])
Filter by whether the merge request was created by a GitLab Duo Agent Platform session.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
metricMergedAtFrom (Time)
Filter by merge timestamp. Start of the range.
metricMergedAtTo (Time)
Filter by merge timestamp. End of the range.
stateId ([String!])
Filter by one or many states (opened, closed, merged, locked).
stateIdNot ([String!])
Exclude one or many states (opened, closed, merged, locked). Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
targetBranch ([String!])
Filter by one or many target branches.
targetBranchNot ([String!])
Exclude one or many target branches. Maximum is 100.
pipelines PipelinesAggregationScope Introduced as an experiment in GitLab 19.2.

Aggregation engine for CI pipeline analytics. Requires Siphon replication to be enabled on the instance.

Arguments for pipelines:
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
finishedAtFrom (Time)
Filter by pipeline finish timestamp. Start of the range.
finishedAtTo (Time)
Filter by pipeline finish timestamp. End of the range.
ref ([String!])
Filter by one or many pipeline refs.
refNot ([String!])
Exclude one or many pipeline refs. Pipelines with no ref are excluded as well. Maximum is 100.
source ([String!])
Filter by one or many pipeline sources.
sourceNot ([String!])
Exclude one or many pipeline sources. Pipelines with no source are excluded as well. Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
startedAtFrom (Time)
Filter by pipeline start timestamp. Start of the range.
startedAtTo (Time)
Filter by pipeline start timestamp. End of the range.
status ([String!])
Filter by one or many pipeline statuses.
statusNot ([String!])
Exclude one or many pipeline statuses. Maximum is 100.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Pipelines with no triggering user are excluded as well. Maximum is 100.

AnalyzerGroupStatusType#

Counts for each analyzer status in the group and subgroups.

Fields#

Name Type Description
analyzerType AnalyzerTypeForStatus! Analyzer type.
failure Int! Number of projects where analyzer_type failed to execute.
namespaceId Int! Namespace ID.
notConfigured Int! Number of projects where analyzer_type is not configured.
stale Int! Number of projects where analyzer_type has not run in three consecutive pipelines in the default branch.
success Int! Number of projects where analyzer_type completed successfully.
totalProjectsCount Int! Total number of projects descending from the group.
updatedAt ISO8601DateTime! Timestamp of when the status was last updated.

AnalyzerProjectStatusType#

Analyzer status (success/fail) for projects.

Fields#

Name Type Description
analyzerType AnalyzerTypeForStatus! Analyzer type.
buildId JobID Build ID.
lastCall Time! Last time analyzer was called.
projectId Int! Project ID.
source AnalyzerSourceEnum Introduced as an experiment in GitLab 19.0.

Source of the build associated with the analyzer status.
status AnalyzerStatusEnum! Analyzer status.
updatedAt ISO8601DateTime! Timestamp of when the status was last updated.

AncestorType#

Fields#

Name Type Description
name String Name of the ancestor.
version String Version of the ancestor.

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.

AppearanceUploadRegistry#

Represents the Geo replication and verification state of an appearance_upload.

Fields#

Name Type Description
appearanceUploadId ID! ID of the Appearance Upload.
checksumMismatch Boolean Indicate if the checksums of the AppearanceUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AppearanceUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AppearanceUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AppearanceUploadRegistry.
lastSyncFailure String Error message during sync of the AppearanceUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AppearanceUploadRegistry.
missingOnPrimary Boolean Indicate if the AppearanceUploadRegistry is missing on primary.
modelRecordId Int ID of the AppearanceUploadRegistry's model record.
retryAt Time Timestamp after which the AppearanceUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AppearanceUploadRegistry.
state RegistryState Sync state of the AppearanceUploadRegistry.
verificationChecksum String The local checksum of the AppearanceUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AppearanceUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AppearanceUploadRegistry.
verificationRetryAt Time Timestamp after which the AppearanceUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AppearanceUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AppearanceUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AppearanceUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AppearanceUploadRegistry.

AppearanceUploadRegistryConnection#

Paginated collection of AppearanceUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ApprovalPolicy#

Represents the approval policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
actionApprovers [PolicyApproversType!] Multiple approvers action.
allGroupApprovers [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
deprecatedProperties [String!] Introduced as an experiment in GitLab 16.10.

All deprecated properties in the policy.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
enforcementType PolicyEnforcementType Enforcement type of the policy. Can be "enforce" or "warn".
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.

ApprovalPolicyAttributesType#

Represents policy fields related to the approval policy.

Fields#

Name Type Description
actionApprovers [PolicyApproversType!] Multiple approvers action.
allGroupApprovers [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
deprecatedProperties [String!] Introduced as an experiment in GitLab 16.10.

All deprecated properties in the policy.
enforcementType PolicyEnforcementType Enforcement type of the policy. Can be "enforce" or "warn".
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.
userApprovers [UserCore!] Approvers of the user type.

ApprovalPolicyConnection#

Paginated collection of ApprovalPolicy. See Standard connection fields for the fields available on every connection.

ApprovalProjectRule#

Describes a project approval rule regarding who can approve merge requests.

Fields#

Name Type Description
approvalsRequired Int Number of required approvals.
coverageMinimumThreshold Float Minimum code coverage threshold (0-100). Approval is required if coverage falls below the specified threshold.
eligibleApprovers UserCoreConnection List of users eligible to approve merge requests for the approval rule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id GlobalID! ID of the rule.
name String Name of the rule.
type ApprovalRuleType Type of the rule.

ApprovalProjectRuleConnection#

Paginated collection of ApprovalProjectRule. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commentedBy UserCoreConnection List of users, defined in the rule, who commented on the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
patterns [String!] Introduced as an experiment in GitLab 19.4.

CODEOWNERS patterns grouped into this rule. Returns null when the rule is not a grouped Code Owner rule.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

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.

ArtifactRegistry#

Artifact Registry an organization is activated for.

Fields#

Name Type Description
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the registry was provisioned, presented as the active-since date. null when the status is unknown.
id ID! Introduced as an experiment in GitLab 19.5.

Artifact Registry's UUID for the namespace mapped to the organization. Neither a GitLab namespace nor a GitLab global ID. Pass it as resourceId to the Artifact Registry role mutations. Present even when the status is unknown.
slug String Introduced as an experiment in GitLab 19.4.

Registry slug, Artifact Registry's immutable identifier for the namespace. null when the status is unknown.
statistics ArtifactRegistryNamespaceStatistics Introduced as an experiment in GitLab 19.5.

Namespace-wide Artifact Registry statistics, read as the current user when this field is selected. null on any unresolved read, so an unavailable service or a drifted slug omits the figures rather than raising. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this field is not reached.
status String! Introduced as an experiment in GitLab 19.4.

Status Artifact Registry returned, one of active, suspended, disabled, blocked, deleted, or purged, or unknown when the mapped namespace did not resolve. Deliberately a string rather than an enum so a status Artifact Registry adds within its API version reaches the response instead of raising.
userPermissions ArtifactRegistryNamespacePermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the namespace, read from the namespace details as the user when this field is selected. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.

ArtifactRegistryImage#

Image in an Artifact Registry repository.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.4.

ID of the image in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the image was last pulled. Null when it was never pulled.
manifests ArtifactRegistryManifestConnection Introduced as an experiment in GitLab 19.4.

Manifests of the image, ordered by publication date descending by default. Reads at most 20 rows per page and can be selected for up to 20 images per operation, matching the images page size. Returns null for an image that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for manifests:
includeReferrers (Boolean)
Introduced as an experiment in GitLab 19.4.

Include referrer manifests in the list. Defaults to false, matching the endpoint.
sort (ArtifactRegistryManifestSort)
Introduced as an experiment in GitLab 19.4.

Sort manifests by the criteria. Defaults to publication date descending.
name String! Introduced as an experiment in GitLab 19.4.

Name of the image.

ArtifactRegistryImageConnection#

Paginated collection of ArtifactRegistryImage. See Standard connection fields for the fields available on every connection.

ArtifactRegistryManifest#

Manifest of a container image in an Artifact Registry repository (Docker and OCI).

Fields#

Name Type Description
architecture String Introduced as an experiment in GitLab 19.5.

CPU architecture an image manifest targets. Null on an index, per value on an image whose config did not carry it, and always null on a remote repository.
artifactType String Introduced as an experiment in GitLab 19.4.

Artifact type of the manifest. Null when the manifest declares none.
childrenCount Int Introduced as an experiment in GitLab 19.5.

Number of platform children of a manifest index. Zero on an image manifest, and always zero on a remote repository. Null on a deployment predating the field.
childrenPreview [ArtifactRegistryManifestPlatform!] Introduced as an experiment in GitLab 19.5.

First ten platform children of a manifest index, child digest ascending, each with its digest and platform triple. Empty on an image manifest and on a remote repository. childrenCount on this type already carries the true total; read the complete children list on the detail type. Null on a deployment predating the field.
createdAt Time Introduced as an experiment in GitLab 19.4.

Time the manifest was pushed. Null if the timestamp is absent or unparseable.
digest String! Introduced as an experiment in GitLab 19.4.

Content-addressable digest of the manifest.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the manifest in Artifact Registry.
mediaType String! Introduced as an experiment in GitLab 19.4.

Media type of the manifest.
os String Introduced as an experiment in GitLab 19.5.

Operating system an image manifest targets. Null on an index, per value on an image whose config did not carry it, and always null on a remote repository.
osVariant String Introduced as an experiment in GitLab 19.5.

CPU variant an image manifest targets. Null on an index, on most images, and always null on a remote repository.
parentsPreview [String!] Introduced as an experiment in GitLab 19.5.

First ten digests of the indexes that reference this manifest, in the order Artifact Registry returns them. Empty when no index references it. The list carries no parent count; read the complete list, and the total in parentsCount, on the detail type. Null on a deployment predating the field.
referrersCount Int Introduced as an experiment in GitLab 19.5.

Number of manifests in the image that name this digest as their subject. Zero when none do, and always zero on a remote repository. Null on a deployment predating the field.
size BigInt! Introduced as an experiment in GitLab 19.4.

Size of the manifest, in bytes. For a hosted repository, the push-time tree total, where an index total already contains its platform children and so does not sum across sibling rows. For a remote repository, the cached manifest's own payload bytes.
subjectDigest String Introduced as an experiment in GitLab 19.4.

Digest of the subject manifest a referrer refers to. Null for a manifest that is not a referrer. Populated on the referrers connection, where every row is a referrer of the manifest it hangs off. On the manifests connection it is null unless the caller passes includeReferrers, which the default omits.
tagsCount Int Introduced as an experiment in GitLab 19.5.

Number of tags pointing at the manifest. Zero when untagged. Null on a deployment predating the field.
tagsPreview [String!] Introduced as an experiment in GitLab 19.5.

First ten tags pointing at the manifest, name ascending. Empty when untagged. tagsCount on this type already carries the true total; read the complete tags list on the detail type. Null on a deployment predating the field.

ArtifactRegistryManifestAnnotation#

OCI annotation of a container manifest in an Artifact Registry repository.

Fields#

Name Type Description
key String! Introduced as an experiment in GitLab 19.5.

Annotation key.
value String! Introduced as an experiment in GitLab 19.5.

Annotation value.

ArtifactRegistryManifestConnection#

Paginated collection of ArtifactRegistryManifest. See Standard connection fields for the fields available on every connection.

ArtifactRegistryManifestDetails#

Single container manifest in an Artifact Registry repository, reached by digest under the image it belongs to (Docker and OCI).

Fields#

Name Type Description
annotations [ArtifactRegistryManifestAnnotation!] Introduced as an experiment in GitLab 19.5.

OCI annotations of the manifest, as key/value pairs. Empty when the manifest carried an empty annotations map, and null when it carried none: the two are kept apart. Always null on a remote repository, where the field is not served.
architecture String Introduced as an experiment in GitLab 19.5.

CPU architecture an image manifest targets. Null on an index, per value on an image whose config did not carry it, and always null on a remote repository.
artifactType String Introduced as an experiment in GitLab 19.4.

Artifact type of the manifest. Null when the manifest declares none.
children [ArtifactRegistryManifestPlatform!] Introduced as an experiment in GitLab 19.5.

Platform children of a manifest index, child digest ascending, each with its digest and platform triple. Empty on an image manifest and on a remote repository. Null on a deployment predating the field.
childrenCount Int Introduced as an experiment in GitLab 19.5.

Number of platform children of a manifest index. Zero on an image manifest, and always zero on a remote repository. Null on a deployment predating the field.
createdAt Time Introduced as an experiment in GitLab 19.4.

Time the manifest was pushed. Null if the timestamp is absent or unparseable.
digest String! Introduced as an experiment in GitLab 19.4.

Content-addressable digest of the manifest.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the manifest in Artifact Registry.
mediaType String! Introduced as an experiment in GitLab 19.4.

Media type of the manifest.
os String Introduced as an experiment in GitLab 19.5.

Operating system an image manifest targets. Null on an index, per value on an image whose config did not carry it, and always null on a remote repository.
osVariant String Introduced as an experiment in GitLab 19.5.

CPU variant an image manifest targets. Null on an index, on most images, and always null on a remote repository.
parentDigests [String!] Introduced as an experiment in GitLab 19.5.

Digests of the indexes that reference this manifest, parent id ascending. Empty when no index references it. Null until Artifact Registry serves the field.
parentsCount Int Introduced as an experiment in GitLab 19.5.

Number of indexes that reference this manifest. Zero when none do. Null until Artifact Registry serves the field.
referrers ArtifactRegistryManifestConnection Introduced as an experiment in GitLab 19.5.

Manifests in the image that name this manifest as their subject, ordered by digest ascending. Reads at most 20 rows per page and can be selected once per operation, counting every selection of the field. Empty on a remote repository. Returns null for a manifest that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
referrersCount Int Introduced as an experiment in GitLab 19.5.

Number of manifests in the image that name this digest as their subject. Zero when none do, and always zero on a remote repository. Null on a deployment predating the field.
size BigInt! Introduced as an experiment in GitLab 19.4.

Size of the manifest, in bytes. For a hosted repository, the push-time tree total, where an index total already contains its platform children and so does not sum across sibling rows. For a remote repository, the cached manifest's own payload bytes.
subjectDigest String Introduced as an experiment in GitLab 19.5.

Digest of the subject manifest this manifest refers to. Null for a manifest that is not a referrer. Populated here even for a referrer, unlike the manifests list, because the detail route serves a referrer row like any other manifest.
tags [String!] Introduced as an experiment in GitLab 19.5.

Tags pointing at the manifest, name ascending. Empty when untagged. A window bounded by container.manifest_max_tags (1,000 by default), so it can stop short of tagsCount. Null on a deployment predating the field.
tagsCount Int Introduced as an experiment in GitLab 19.5.

Number of tags pointing at the manifest. Zero when untagged. Null on a deployment predating the field.

ArtifactRegistryManifestPlatform#

Platform child of a container manifest index in an Artifact Registry repository.

Fields#

Name Type Description
architecture String Introduced as an experiment in GitLab 19.5.

CPU architecture the child targets. Null when the manifest carries none.
digest String! Introduced as an experiment in GitLab 19.5.

Content-addressable digest of the child manifest.
os String Introduced as an experiment in GitLab 19.5.

Operating system the child targets. Null when the manifest carries none.
osVariant String Introduced as an experiment in GitLab 19.5.

CPU variant the child targets. Null when the manifest carries none, which is most images.

ArtifactRegistryMavenPackage#

Maven package in an Artifact Registry repository.

Fields#

Name Type Description
artifactId String! Introduced as an experiment in GitLab 19.3.

Maven artifact ID coordinate of the package.
groupId String! Introduced as an experiment in GitLab 19.3.

Maven group ID coordinate of the package.
id ID! Introduced as an experiment in GitLab 19.3.

ID of the package in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the package was last pulled. Null when it was never pulled.
versions ArtifactRegistryVersionConnection Introduced as an experiment in GitLab 19.4.

Versions of the package, ordered by publication date descending by default. Resolves at most once per package in a page, so one operation reads versions for up to 20 packages. Returns null for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
sort (ArtifactRegistryVersionSort)
Introduced as an experiment in GitLab 19.4.

Sort versions by the criteria. Defaults to publication date descending.

ArtifactRegistryMavenPackageDetails#

A single Maven package in an Artifact Registry repository, returned by the by-ID package read.

Fields#

Name Type Description
artifactId String! Introduced as an experiment in GitLab 19.3.

Maven artifact ID coordinate of the package.
groupId String! Introduced as an experiment in GitLab 19.3.

Maven group ID coordinate of the package.
id ID! Introduced as an experiment in GitLab 19.3.

ID of the package in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the package was last pulled. Null when it was never pulled.
versions ArtifactRegistryVersionConnection Introduced as an experiment in GitLab 19.4.

Versions of the package, ordered by publication date descending by default. Resolves at most once per package in a page, so one operation reads versions for up to 20 packages. Returns null for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
sort (ArtifactRegistryVersionSort)
Introduced as an experiment in GitLab 19.4.

Sort versions by the criteria. Defaults to publication date descending.

ArtifactRegistryMavenVersionFile#

File of a Maven version in an Artifact Registry repository.

Fields#

Name Type Description
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the file was stored. Null until Artifact Registry serializes the Maven file timestamp.
fileName String! Introduced as an experiment in GitLab 19.4.

Name of the file.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the file in Artifact Registry.
md5 String Introduced as an experiment in GitLab 19.4.

MD5 checksum of the file. Null when the deploy stored none.
sha1 String! Introduced as an experiment in GitLab 19.4.

SHA-1 checksum of the file.
sha256 String! Introduced as an experiment in GitLab 19.4.

SHA-256 checksum of the file.
sha512 String! Introduced as an experiment in GitLab 19.4.

SHA-512 checksum of the file.
sizeBytes BigInt! Introduced as an experiment in GitLab 19.4.

Stored size of the file in bytes.

ArtifactRegistryNamespacePermissions#

Per-action permissions Artifact Registry reports for the current user on a namespace.

Fields#

Name Type Description
createRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can create a repository in the namespace.
createRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can add an upstream to the namespace's repositories.
deleteRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can delete repositories of the namespace.
deleteRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can remove an upstream from the namespace's repositories.
readRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can read repositories of the namespace and their metadata.
updateRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can change the settings of the namespace's repositories.
updateRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can change an upstream of the namespace's repositories.

ArtifactRegistryNamespaceStatistics#

Namespace-wide statistics for an Artifact Registry.

Fields#

Name Type Description
deduplicatedSizeBytes BigInt Introduced as an experiment in GitLab 19.5.

Namespace's storage footprint in bytes, counting each distinct blob once.
repositoriesCount BigInt Introduced as an experiment in GitLab 19.5.

Number of active repositories in the namespace, every format and kind.

ArtifactRegistryNpmDistTag#

npm dist-tag of a package in an Artifact Registry repository.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.4.

ID of the dist-tag in Artifact Registry.
name String! Introduced as an experiment in GitLab 19.4.

Name of the dist-tag.
version String! Introduced as an experiment in GitLab 19.4.

Version string the dist-tag points at.
versionId ID! Introduced as an experiment in GitLab 19.4.

Artifact Registry ID of the version the dist-tag points at.

ArtifactRegistryNpmDistTagConnection#

Paginated collection of ArtifactRegistryNpmDistTag. See Standard connection fields for the fields available on every connection.

ArtifactRegistryNpmPackage#

npm package in an Artifact Registry repository.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.3.

ID of the package in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the package was last pulled. Null when it was never pulled.
name String! Introduced as an experiment in GitLab 19.3.

Name of the package, including its scope when it has one.
scope String Introduced as an experiment in GitLab 19.3.

npm scope of the package. Null for an unscoped package.
versions ArtifactRegistryVersionConnection Introduced as an experiment in GitLab 19.4.

Versions of the package, ordered by publication date descending by default. Resolves at most once per package in a page, so one operation reads versions for up to 20 packages. Returns null for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
sort (ArtifactRegistryVersionSort)
Introduced as an experiment in GitLab 19.4.

Sort versions by the criteria. Defaults to publication date descending.
versionsCount Int Introduced as an experiment in GitLab 19.3.

Number of versions of the package. Buffered, so it can lag the version list. Null for a package of a remote repository, which Artifact Registry supplies no count for.

ArtifactRegistryNpmPackageDetails#

A single npm package in an Artifact Registry repository, returned by the by-ID package read; carries the npm dist-tags.

Fields#

Name Type Description
distTags ArtifactRegistryNpmDistTagConnection Introduced as an experiment in GitLab 19.4.

npm dist-tags of the package, ordered by name. Truncates above 100 dist-tags. Can be selected once per operation. null without a read on a remote repository, which Artifact Registry serves no dist-tag rows for. Also null for a package that is gone, and when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Introduced as an experiment in GitLab 19.3.

ID of the package in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the package was last pulled. Null when it was never pulled.
name String! Introduced as an experiment in GitLab 19.3.

Name of the package, including its scope when it has one.
scope String Introduced as an experiment in GitLab 19.3.

npm scope of the package. Null for an unscoped package.
versions ArtifactRegistryVersionConnection Introduced as an experiment in GitLab 19.4.

Versions of the package, ordered by publication date descending by default. Resolves at most once per package in a page, so one operation reads versions for up to 20 packages. Returns null for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
sort (ArtifactRegistryVersionSort)
Introduced as an experiment in GitLab 19.4.

Sort versions by the criteria. Defaults to publication date descending.
versionsCount Int Introduced as an experiment in GitLab 19.3.

Number of versions of the package. Buffered, so it can lag the version list. Null for a package of a remote repository, which Artifact Registry supplies no count for.

ArtifactRegistryNpmVersionFile#

File of an npm version in an Artifact Registry repository.

Fields#

Name Type Description
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the file was stored. Null on a remote repository, whose cached row carries none.
fileName String! Introduced as an experiment in GitLab 19.4.

Name of the file.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the file in Artifact Registry.
sha256 String! Introduced as an experiment in GitLab 19.4.

SHA-256 checksum of the file.
sizeBytes BigInt! Introduced as an experiment in GitLab 19.4.

Stored size of the file in bytes.

ArtifactRegistryPackageConnection#

Paginated collection of ArtifactRegistryPackage. See Standard connection fields for the fields available on every connection.

ArtifactRegistryRemoteSettings#

Upstream configuration of a remote Artifact Registry repository.

Fields#

Name Type Description
cacheValidityHours Int Introduced as an experiment in GitLab 19.4.

Revalidation window for cached artifacts, in hours. Zero means cached artifacts never revalidate.
credentialsCleared Boolean Introduced as an experiment in GitLab 19.4.

Indicates the update that returned this repository cleared the stored upstream credentials. Null on any other response.
hasCredentials Boolean Introduced as an experiment in GitLab 19.4.

Indicates upstream credentials are stored. Reported in place of the credentials themselves, which are write-only and exposed by no field.
lastHealthCheckedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of the most recent health probe of the upstream. Null until the first probe.
lastHealthStatus ArtifactRegistryHealthStatus Introduced as an experiment in GitLab 19.4.

Health verdict the most recent probe of the upstream stored. UNKNOWN before the first probe, and for a status this schema does not recognize.
metadataCacheValidityHours Int Introduced as an experiment in GitLab 19.4.

Revalidation window for cached metadata, in hours. Null for a format that caches no metadata, such as Docker and OCI.
snapshotMetadataAlwaysRevalidate Boolean Introduced as an experiment in GitLab 19.4.

Indicates snapshot metadata revalidates on every read instead of on the metadata window. Null for a format without snapshot metadata, so non-null only for Maven.
url String Introduced as an experiment in GitLab 19.4.

Base URL of the upstream registry, in the canonical form Artifact Registry stores.

ArtifactRegistryRepository#

Repository in Artifact Registry.

Fields#

Name Type Description
artifactsCount BigInt! Introduced as an experiment in GitLab 19.4.

Number of artifacts the repository holds. Buffered, so it can lag.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of when the repository was created. Null when the time is unknown.
createdBy UserCore Introduced as an experiment in GitLab 19.4.

User who created the repository. Null when the creator is unknown or no longer exists.
description String Introduced as an experiment in GitLab 19.3.

Human-readable description of the repository. Null when unset.
downloadsCount BigInt! Introduced as an experiment in GitLab 19.3.

Number of artifact downloads from the repository. Buffered, so it can lag.
format ArtifactRegistryRepositoryFormat! Introduced as an experiment in GitLab 19.3.

Package format the repository holds.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the repository in Artifact Registry.
kind ArtifactRegistryRepositoryKind! Introduced as an experiment in GitLab 19.3.

How the repository sources its artifacts.
lastUpdatedAt Time Introduced as an experiment in GitLab 19.3.

Time the repository content last changed. Null when the content never changed.
name String! Introduced as an experiment in GitLab 19.3.

Name of the repository, unique within its namespace.
settings ArtifactRegistryRemoteSettings Introduced as an experiment in GitLab 19.3.

Upstream configuration Artifact Registry returned for the repository. Null when it returned none, so null on a hosted or virtual repository.
sizeBytes BigInt! Introduced as an experiment in GitLab 19.3.

Storage the repository occupies, in bytes. Buffered, so it can lag.
updatedBy UserCore Introduced as an experiment in GitLab 19.4.

User who last changed the repository. Null when the editor is unknown or no longer exists.
userPermissions ArtifactRegistryRepositoryPermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the repository. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.
visibility ArtifactRegistryRepositoryVisibility! Introduced as an experiment in GitLab 19.3.

Who can read the repository.

ArtifactRegistryRepositoryConnection#

Paginated collection of ArtifactRegistryRepository. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
userPermissions ArtifactRegistryNamespacePermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the namespace the repositories belong to. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.

ArtifactRegistryRepositoryDetails#

Repository in Artifact Registry, with the packages or images it holds.

Fields#

Name Type Description
artifactsCount BigInt! Introduced as an experiment in GitLab 19.4.

Number of artifacts the repository holds. Buffered, so it can lag.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of when the repository was created. Null when the time is unknown.
createdBy UserCore Introduced as an experiment in GitLab 19.4.

User who created the repository. Null when the creator is unknown or no longer exists.
description String Introduced as an experiment in GitLab 19.3.

Human-readable description of the repository. Null when unset.
downloadsCount BigInt! Introduced as an experiment in GitLab 19.3.

Number of artifact downloads from the repository. Buffered, so it can lag.
format ArtifactRegistryRepositoryFormat! Introduced as an experiment in GitLab 19.3.

Package format the repository holds.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the repository in Artifact Registry.
image ArtifactRegistryImage Introduced as an experiment in GitLab 19.4.

Single container image the repository holds, by Artifact Registry ID. Can be selected once per operation. Returns null for a repository holding packages and for an image that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.

Arguments for image:
id (ID!)
ID of the image in Artifact Registry.
images ArtifactRegistryImageConnection Introduced as an experiment in GitLab 19.4.

Images the repository holds. Can be selected once per operation, so one operation reads images for one repository. Returns null for a virtual repository, for a repository holding packages, and for a repository that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
kind ArtifactRegistryRepositoryKind! Introduced as an experiment in GitLab 19.3.

How the repository sources its artifacts.
lastUpdatedAt Time Introduced as an experiment in GitLab 19.3.

Time the repository content last changed. Null when the content never changed.
manifest ArtifactRegistryManifestDetails Introduced as an experiment in GitLab 19.5.

Single container manifest the repository holds, by digest and the ID of the image it belongs to. Can be selected once per operation, counting every selection of the field. null while the artifact_registry_ui feature flag is off, resolved without a read. Returns null for a repository holding packages, for a manifest that is gone, and for a blank or dot-segment image ID or digest, which resolves without a read. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.

Arguments for manifest:
artifactId (ID!)
ID of the image the manifest belongs to, in Artifact Registry.
digest (String!)
Digest of the manifest in Artifact Registry.
name String! Introduced as an experiment in GitLab 19.3.

Name of the repository, unique within its namespace.
package ArtifactRegistryPackageDetails Introduced as an experiment in GitLab 19.4.

Single package the repository holds, by Artifact Registry ID. Can be selected once per operation. Returns null for a repository holding images and for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.

Arguments for package:
id (ID!)
ID of the package in Artifact Registry.
packages ArtifactRegistryPackageConnection Introduced as an experiment in GitLab 19.3.

Packages the repository holds, ordered by name. Can be selected once per operation, so one operation reads packages for one repository. Returns null for a virtual repository, for a repository holding images, for a repository that is gone, and when Artifact Registry rejects the read. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
settings ArtifactRegistryRemoteSettings Introduced as an experiment in GitLab 19.3.

Upstream configuration Artifact Registry returned for the repository. Null when it returned none, so null on a hosted or virtual repository.
sizeBytes BigInt! Introduced as an experiment in GitLab 19.3.

Storage the repository occupies, in bytes. Buffered, so it can lag.
statistics ArtifactRegistryRepositoryStatistics Introduced as an experiment in GitLab 19.5.

Read-time package or image count of a hosted repository. Can be selected once per operation. Returns null without a read for a remote or virtual repository, and null for a repository that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.
updatedBy UserCore Introduced as an experiment in GitLab 19.4.

User who last changed the repository. Null when the editor is unknown or no longer exists.
upstreamRepositories [ArtifactRegistryUpstreamRepositoryAssociation!] Introduced as an experiment in GitLab 19.5.

Upstream repositories a virtual repository resolves through, in resolution order. Can be selected once per operation. Returns null for a hosted or remote repository, for a repository that is gone, and when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.
userPermissions ArtifactRegistryRepositoryPermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the repository. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.
version ArtifactRegistryVersionDetails Introduced as an experiment in GitLab 19.4.

Single version the repository holds, by Artifact Registry ID and the ID of the package it is displayed under. Can be selected once per operation. Returns null for a repository holding images, for a version that is gone, and for a version that belongs to a different package. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.

Arguments for version:
artifactId (ID!)
ID of the package the version is displayed under, in Artifact Registry. The version resolves null when it belongs to a different package.
id (ID!)
ID of the version in Artifact Registry.
visibility ArtifactRegistryRepositoryVisibility! Introduced as an experiment in GitLab 19.3.

Who can read the repository.

ArtifactRegistryRepositoryPermissions#

Per-action permissions Artifact Registry reports for the current user on a repository.

Fields#

Name Type Description
createArtifact Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can publish artifacts to the repository.
createRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can add an upstream to the repository.
deleteArtifact Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can delete artifacts from the repository.
deleteRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can delete the repository.
deleteRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can remove an upstream from the repository.
readArtifact Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can read artifacts held by the repository.
readRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can read the repository and its metadata.
updateRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can change the repository's settings.
updateRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can change an upstream of the repository.

ArtifactRegistryRepositoryStatistics#

Read-time statistics for a hosted repository in Artifact Registry.

Fields#

Name Type Description
imagesCount BigInt Introduced as an experiment in GitLab 19.5.

Number of images the repository holds, computed at read time. null for a repository holding packages.
packagesCount BigInt Introduced as an experiment in GitLab 19.5.

Number of packages the repository holds, computed at read time. null for a repository holding images.

ArtifactRegistryRoleAssignment#

A direct role assignment. A user, the Artifact Registry role they hold, and the resource it is assigned on. Does not represent inherited access.

Fields#

Name Type Description
assignee UserCore User the role is assigned to.
createdAt Time Time the assignment was created.
resourceId String! UUID of the Artifact Registry resource the role is assigned on.
role ArtifactRegistryRole Assigned Artifact Registry role.

ArtifactRegistryRoleAssignmentConnection#

Paginated collection of ArtifactRegistryRoleAssignment. See Standard connection fields for the fields available on every connection.

ArtifactRegistryUpstreamRepositoryAssociation#

One upstream of a virtual Artifact Registry repository: its position and a summary of the repository it points at.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.5.

ID of the upstream association in Artifact Registry.
position Int! Introduced as an experiment in GitLab 19.5.

1-based resolution position of the upstream, consulted in ascending order.
upstreamRepository ArtifactRegistryUpstreamRepositorySummary! Introduced as an experiment in GitLab 19.5.

Summary of the repository the association points at.

ArtifactRegistryUpstreamRepositorySummary#

Summary of a repository that is an upstream of a virtual Artifact Registry repository.

Fields#

Name Type Description
format ArtifactRegistryRepositoryFormat! Introduced as an experiment in GitLab 19.5.

Package format the upstream repository holds.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the upstream repository in Artifact Registry.
kind ArtifactRegistryUpstreamRepositoryKind Introduced as an experiment in GitLab 19.5.

How the upstream repository sources its artifacts. Artifact Registry returns hosted or remote by contract; a value outside those resolves null alongside a top-level error rather than a badge.
name String! Introduced as an experiment in GitLab 19.5.

Name of the upstream repository.
settings ArtifactRegistryUpstreamRepositorySummarySettings Introduced as an experiment in GitLab 19.5.

Upstream configuration of a remote upstream repository. Null on a hosted upstream, and when the current user cannot read the upstream repository.
sizeBytes BigInt Introduced as an experiment in GitLab 19.5.

Storage the upstream repository occupies, in bytes. Buffered, so it can lag. Null when the current user cannot read the upstream repository.
userPermissions ArtifactRegistryRepositoryPermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the upstream repository. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. upstreamRepositories returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.
visibility ArtifactRegistryRepositoryVisibility Introduced as an experiment in GitLab 19.5.

Who can read the upstream repository. Null when the current user cannot read the upstream repository. A value outside this enum resolves null alongside a top-level error.

ArtifactRegistryUpstreamRepositorySummarySettings#

Settings a remote upstream repository shows in the upstream list of a virtual Artifact Registry repository.

Fields#

Name Type Description
lastHealthStatus ArtifactRegistryHealthStatus Introduced as an experiment in GitLab 19.5.

Health verdict the most recent probe of the upstream stored. UNKNOWN before the first probe, and for a status this schema does not recognize.
url String Introduced as an experiment in GitLab 19.5.

Base URL of the upstream registry, in the canonical form Artifact Registry stores.

ArtifactRegistryVersion#

Version of a package in an Artifact Registry repository (Maven and npm).

Fields#

Name Type Description
commitPath String Introduced as an experiment in GitLab 19.4.

Web path to the publishing commit within the resolved project. Null when there is no SHA or project, or the viewer cannot read the project code.
commitSha String Introduced as an experiment in GitLab 19.4.

Commit SHA the version was published from, within the resolved project. Null when there is no SHA or project, or the viewer cannot read the project code.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the version was published. Null when Artifact Registry stored none.
createdBy UserCore Introduced as an experiment in GitLab 19.4.

User who published the version, resolved from the reference Artifact Registry stores. Null when it stored none or the user no longer exists.
distTags [String!]! Introduced as an experiment in GitLab 19.4.

Names of the npm dist-tags bound to the version, in ascending name order. Empty for Maven versions.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the version in Artifact Registry.
project Project Introduced as an experiment in GitLab 19.4.

Project the version was published from, resolved from the reference Artifact Registry stores. Null when it stored none, the project no longer exists, or the viewer cannot see the project.
sizeBytes BigInt Introduced as an experiment in GitLab 19.4.

Stored size of the version in bytes. Null for a Maven version until Artifact Registry serializes the column, and on a remote repository.
version String! Introduced as an experiment in GitLab 19.4.

Version string of the package.

ArtifactRegistryVersionConnection#

Paginated collection of ArtifactRegistryVersion. See Standard connection fields for the fields available on every connection.

ArtifactRegistryVersionDetails#

Single version of a package in an Artifact Registry repository, reached by ID and the package it is displayed under.

Fields#

Name Type Description
commitPath String Introduced as an experiment in GitLab 19.4.

Web path to the publishing commit within the resolved project. Null when there is no SHA or project, or the viewer cannot read the project code.
commitSha String Introduced as an experiment in GitLab 19.4.

Commit SHA the version was published from, within the resolved project. Null when there is no SHA or project, or the viewer cannot read the project code.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the version was published. Null when Artifact Registry stored none.
createdBy UserCore Introduced as an experiment in GitLab 19.4.

User who published the version, resolved from the reference Artifact Registry stores. Null when it stored none or the user no longer exists.
distTags [String!]! Introduced as an experiment in GitLab 19.4.

Names of the npm dist-tags bound to the version, in ascending name order. Empty for Maven versions.
files ArtifactRegistryVersionFileConnection Introduced as an experiment in GitLab 19.4.

Files the version holds, ordered by file name. Reads at most 20 rows per page and can be selected once per operation. Returns null for a version that is gone, and when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the version in Artifact Registry.
project Project Introduced as an experiment in GitLab 19.4.

Project the version was published from, resolved from the reference Artifact Registry stores. Null when it stored none, the project no longer exists, or the viewer cannot see the project.
sizeBytes BigInt Introduced as an experiment in GitLab 19.4.

Stored size of the version in bytes. Null for a Maven version until Artifact Registry serializes the column, and on a remote repository.
statistics ArtifactRegistryVersionStatistics Introduced as an experiment in GitLab 19.5.

Read-time statistics for the version. Hosted repositories only, so null without a read on a virtual or remote repository and on a container repository. Can be selected once per operation. null when Artifact Registry does not serve the statistics route, and when it rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, any other 5xx, or any other 4xx.
version String! Introduced as an experiment in GitLab 19.4.

Version string of the package.

ArtifactRegistryVersionFileConnection#

Paginated collection of ArtifactRegistryVersionFile. See Standard connection fields for the fields available on every connection.

ArtifactRegistryVersionStatistics#

Read-time statistics for a version in an Artifact Registry repository.

Fields#

Name Type Description
filesCount BigInt Introduced as an experiment in GitLab 19.5.

Number of files the version holds, computed at read time.

AscpComponent#

A logical component of a project identified by ASCP security scanning.

Fields#

Name Type Description
createdAt Time! Timestamp when the component was created.
dependencies AscpComponentConnection! Components the component depends on. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String Description of the component.
expectedUserBehavior String Expected user behavior for the component.
id SecurityAscpComponentID! Global ID of the component.
scan AscpScan! Scan when the component was identified.
securityContext AscpSecurityContext Security context for the component.
subDirectory String! Sub-directory containing the component.
title String! Title of the component.
updatedAt Time! Timestamp when the component was last updated.

AscpComponentConnection#

Paginated collection of AscpComponent. See Standard connection fields for the fields available on every connection.

AscpScan#

An ASCP scan of a project.

Fields#

Name Type Description
baseCommitSha String Base commit SHA for incremental scans.
baseScan AscpScan Reference to the base scan for incremental scans.
commitSha String! Git commit SHA that was scanned.
createdAt Time! Timestamp when the scan was created.
id SecurityAscpScanID! ID of the scan.
scanSequence Int! Sequence number of the scan within the project.
scanType AscpScanType! Type of scan (full or incremental).
updatedAt Time! Timestamp when the scan was last updated.

AscpScanConnection#

Paginated collection of AscpScan. See Standard connection fields for the fields available on every connection.

AscpSecurityContext#

Security context for an ASCP component.

Fields#

Name Type Description
authenticationModel String How users authenticate to the component.
authorizationModel String How access is controlled for the component.
dataSensitivity String Types of sensitive data handled by the component.
id SecurityAscpSecurityContextID! ID of the security context.
scan AscpScan! Scan when the security context was generated.
securityBoundary [AscpSecurityBoundary!]! Security boundaries the component sits on.
securityGuidelines AscpSecurityGuidelineConnection! Security guidelines for the context. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
summary String High-level threat model summary.

AscpSecurityGuideline#

A security guideline for an ASCP component.

Fields#

Name Type Description
businessContext String How to assess business impact if violated.
id SecurityAscpSecurityGuidelineID! ID of the guideline.
legitimateUse String When the operation is expected and acceptable.
name String! Policy name.
operation String! Security-sensitive operation.
securityBoundary String When the operation becomes a security risk.
severityIfViolated AscpSeverity! Severity level if the guideline is violated.

AscpSecurityGuidelineConnection#

Paginated collection of AscpSecurityGuideline. See Standard connection fields for the fields available on every connection.

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.

AuditEvent#

Audit event.

Fields#

Name Type Description
author UserCore User who triggered the event.
createdAt Time! Timestamp when the audit event was created.
details String Additional details of the audit event.
entityId ID ID of the entity.
entityPath String Path of the entity.
entityType String Type of the entity.
eventName String Name of the event.
group Group Group associated with the audit event.
id ID! Audit Event ID.
ipAddress String IP address of the user.
project Project Project associated with the audit event.
targetDetails String Additional details of the target.
targetId ID ID of the target of the audit event.
targetType String Type of the target of the audit event.
user UserCore User associated with the audit event.

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.

AuditEventDefinitionConnection#

Paginated collection of AuditEventDefinition. See Standard connection fields for the fields available on every connection.

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.

Implements: BaseHeaderInterface

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.

AuditEventStreamingHeaderConnection#

Paginated collection of AuditEventStreamingHeader. See Standard connection fields for the fields available on every connection.

AuditEventsStreamingInstanceHeader#

Represents a HTTP header key/value that belongs to an instance level audit streaming destination.

Implements: BaseHeaderInterface

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.

AuditEventsStreamingInstanceHeaderConnection#

Paginated collection of AuditEventsStreamingInstanceHeader. See Standard connection fields for the fields available on every connection.

AutoRemediationConfiguration#

Auto-remediation configuration for a dependency scanning post-processing scan profile.

Fields#

Name Type Description
cooldown Int Minimum number of days after a package is released before it can be used.
enabled Boolean Indicates whether auto-remediation is enabled.
openMergeRequestsLimit Int Maximum number of open merge requests the feature may have open at once.
runnerTags [String!] Runner tags used for auto-remediation jobs.
severityLevel VulnerabilitySeverity Minimum vulnerability severity that triggers an automated upgrade.
upgradePolicy SecurityScanProfileUpgradePolicy Highest version bump allowed when remediating.

AutocompletedUser#

Core representation of a GitLab user.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean! Indicates if the user has composite identity enforcement enabled.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 Merge request state related to the user.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

AvailableModels#

Available models for Duo Agentic Chat.

Fields#

Name Type Description
defaultModel AiModelSelectionOfferedModel Default LLM for Duo Agentic Chat.
pinnedModel AiModelSelectionOfferedModel Pinned model for Duo Agentic Chat if set via feature settings.
selectableModels [AiModelSelectionOfferedModel!] LLMs compatible with Duo Agentic Chat.

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 the emoji.
user UserCore! User who awarded the emoji.

AwardEmojiConnection#

Paginated collection of AwardEmoji. See Standard connection fields for the fields available on every connection.

BaseService#

Implements: Service

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#

Implements: Entry

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! SHA of the entry.
type EntryType! Type of tree entry.
webPath String Web path of the blob.
webUrl String Web URL of the blob.

BlobConnection#

Paginated collection of Blob. See Standard connection fields for the fields available on every connection.

BlobSearch#

Full JSON structure of multi-match results in a single file.

Fields#

Name Type Description
durationS Float Introduced as an experiment in GitLab 18.0.

Duration of the request in seconds.
fileCount Int Introduced as an experiment in GitLab 17.2.

Total number of files with matches.
files [SearchBlobFileType!] Introduced as an experiment in GitLab 17.2.

List of files with matches.
matchCount Int Introduced as an experiment in GitLab 17.2.

Total number of matches.
perPage Int Introduced as an experiment in GitLab 17.2.

Total number of files per page.
searchLevel SearchLevel Introduced as an experiment in GitLab 17.2.

Level of search performed.
searchType SearchType Introduced as an experiment in GitLab 17.2.

Type of search performed.

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.
epics BoardEpicConnection Epics associated with board issues. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for epics:
issueFilters (BoardIssueInput)
Filters applied when selecting issues on the board.
sort (EpicSort)
List epics by sort order.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
lists BoardListConnection Lists of the board. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for lists:
id (ListID)
Find a list by its global ID.
issueFilters (BoardIssueInput)
Filters applied when getting issue metadata in the board list.
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.

BoardConnection#

Paginated collection of Board. See Standard connection fields for the fields available on every connection.

BoardEpic#

Represents an epic on an issue board.

Implements: CurrentUserTodos, Eventable, NoteableInterface, Todoable

Fields#

Name Type Description
ancestors EpicConnection Ancestors (parents) of the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ancestors:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
author UserCore! Author of the epic.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blocked Boolean Indicates the epic is blocked.
blockedByCount Int Count of epics blocking the epic.
blockedByEpics EpicConnection Epics blocking the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingCount Int Count of epics that the epic is blocking.
children EpicConnection Children (sub-epics) of the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for children:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
closedAt Time Timestamp of when the epic was closed.
color String Color of the epic.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
confidential Boolean Indicates if the epic is confidential.
createdAt Time Timestamp of when the epic was created.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
group Group! Group to which the epic belongs.
hasChildren Boolean! Indicates if the epic has children.
hasChildrenWithinTimeframe Boolean! Indicates if the epic has children in the specified timeframe.
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 String! Internal ID of the epic.
issues EpicIssueConnection A list of issues associated with the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
labels LabelConnection Labels assigned to the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems LinkedWorkItemTypeConnection Work items linked to the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedWorkItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
parent Epic Parent epic of the epic.
participants UserCoreConnection List of participants for the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
reference String! Internal reference of the epic. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Indicates if the reference should be returned in full.
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.
title String Title of the epic.
titleHtml String HTML 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.
workItemId WorkItemID! ID of the corresponding work item for a legacy epic.

BoardEpicConnection#

Paginated collection of BoardEpic. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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 the user.
id ID! ID (global ID) of the list.
issues IssueConnection Board issues. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issues:
filters (BoardIssueInput)
Filters applied when selecting issues in the board 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.
status WorkItemStatus Introduced as an experiment in GitLab 18.0.

Status of the list.
title String! Title of the list.
totalIssueWeight BigInt Total weight of all issues in the list, encoded as a string.

BoardListConnection#

Paginated collection of BoardList. See Standard connection fields for the fields available on every connection.

BooleanExpression#

an expression with a boolean value.

Implements: ExpressionInterface

Fields#

Name Type Description
field String! Field the expression applies to.
operator String! Operator of the expression.
value Boolean! Boolean value of the expression.

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.
isGroupLevel Boolean! Introduced as an experiment in GitLab 18.3.

Indicates whether the branch protection rule was created at the group level.
mergeAccessLevels MergeAccessLevelConnection Details about who can merge when the branch is the source branch. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
modificationBlockedByPolicy Boolean! Indicates if a security policy prevents modification.
protectedFromPushBySecurityPolicy Boolean! Indicates if a security policy prevents push or force push.
pushAccessLevels PushAccessLevelConnection Details about who can push when the branch is the source branch. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
unprotectAccessLevels UnprotectAccessLevelConnection Details about who can unprotect the branch. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
warnModificationBlockedByPolicy Boolean! Indicates if a warn mode security policy would prevent modification.
warnProtectedFromPushBySecurityPolicy Boolean! Indicates if a warn mode security policy would prevent push or force push.

BranchRule#

Branch rules configured for a rule target.

Fields#

Name Type Description
approvalRules ApprovalProjectRuleConnection Merge request approval rules configured for the branch rule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
branchProtection BranchProtection Branch protections configured for the branch rule.
createdAt Time Timestamp of when the branch rule was created.
externalStatusChecks ExternalStatusCheckConnection External status checks configured for the branch rule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ProjectsBranchRuleID ID of the branch rule.
isDefault Boolean! Check if the branch rule protects the project's default branch.
isGroupLevel Boolean! Introduced as an experiment in GitLab 19.3.

Indicates whether the branch rule was created at the group level. Unlike the equivalent field on BranchProtection, this field is readable by every user who can read the branch rule.
isProtected Boolean! Check if the branch rule protects access for the branch.
matchingBranchesCount Int! Number of existing branches that match the branch rule.
name String! Name of the branch rule target. Includes wildcards.
squashOption SquashOption Introduced as an experiment in GitLab 17.9.

Default behavior for squashing in merge requests.
updatedAt Time Timestamp of when the branch rule was last updated.

BranchRuleConnection#

Paginated collection of BranchRule. See Standard connection fields for the fields available on every connection.

BulkImportExportUploadUploadRegistry#

Represents the Geo replication and verification state of a bulk_import_export_upload_upload.

Fields#

Name Type Description
bulkImportExportUploadUploadId ID! ID of the bulk import/export archive upload.
checksumMismatch Boolean Indicate if the checksums of the BulkImportExportUploadUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the BulkImportExportUploadUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this BulkImportExportUploadUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the BulkImportExportUploadUploadRegistry.
lastSyncFailure String Error message during sync of the BulkImportExportUploadUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the BulkImportExportUploadUploadRegistry.
missingOnPrimary Boolean Indicate if the BulkImportExportUploadUploadRegistry is missing on primary.
modelRecordId Int ID of the BulkImportExportUploadUploadRegistry's model record.
retryAt Time Timestamp after which the BulkImportExportUploadUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the BulkImportExportUploadUploadRegistry.
state RegistryState Sync state of the BulkImportExportUploadUploadRegistry.
verificationChecksum String The local checksum of the BulkImportExportUploadUploadRegistry.
verificationChecksumMismatched String The expected checksum of the BulkImportExportUploadUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the BulkImportExportUploadUploadRegistry.
verificationRetryAt Time Timestamp after which the BulkImportExportUploadUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the BulkImportExportUploadUploadRegistry.
verificationStartedAt Time Timestamp when the verification of BulkImportExportUploadUploadRegistry started.
verificationState VerificationStateEnum Verification state of the BulkImportExportUploadUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the BulkImportExportUploadUploadRegistry.

BulkImportExportUploadUploadRegistryConnection#

Paginated collection of BulkImportExportUploadUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

BulkToolRuleResult#

Result for a single tool rule update within a bulk operation.

Fields#

Name Type Description
errors [String!]! Errors for the specific tool rule update.
toolId String! Tool name that was processed.
toolRule AiToolRule Updated tool rule, if successful.

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 the day.
completedWeight Int! Total weight of closed issues as of the day.
date ISO8601Date! Date for burnup totals.
scopeCount Int! Number of issues as of the day.
scopeWeight Int! Total weight of issues as of the day.

CarPermissions#

Check user's permission for the car.

Fields#

Name Type Description
deleteMergeTrainCar Boolean! If true, the user can perform delete_merge_train_car on this resource.

CdApplication#

Continuous deployment application.

Fields#

Name Type Description
applicationFlowDefinitions CdApplicationFlowDefinitionConnection Introduced as an experiment in GitLab 19.2.

Flow definitions of the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp of when the application was created.
deployments CdDeploymentConnection Introduced as an experiment in GitLab 19.2.

Deployments actuated by the application, across its most recent rollouts and environments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String Description of the application.
environments CdEnvironmentConnection Introduced as an experiment in GitLab 19.2.

Distinct environments the application has been rolled out to, based on the application's most recent rollouts. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
health CdServiceHealth Introduced as an experiment in GitLab 19.2.

Worst health reported across the application's services, or null when no health has been reported.
id CdApplicationID! Global ID of the application.
lastDeployedAt Time Introduced as an experiment in GitLab 19.2.

Timestamp of the application's most recently finished deployment, among its most recent rollouts.
links CdApplicationLinkConnection Introduced as an experiment in GitLab 19.2.

Links belonging to the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String! Name of the application.
organization Organization Organization the application belongs to.
rollouts CdRolloutConnection Introduced as an experiment in GitLab 19.2.

Rollouts of the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for rollouts:
search (String)
Search rollouts by ID (IID).
statuses ([CdRolloutStatus!])
Filter rollouts by status.
services CdServiceConnection Introduced as an experiment in GitLab 19.2.

Services belonging to the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for services:
search (String)
Search services by name or description.
status CdApplicationStatus Introduced as an experiment in GitLab 19.3.

Current status of the application, derived from its services' worst health and whether it has a rollout in progress, or null when neither applies.
updatedAt Time! Timestamp of when the application was last updated.
userPermissions CdApplicationPermissions Introduced as an experiment in GitLab 19.2.

Permissions of the current user for the application.
versionSets CdVersionSetConnection Introduced as an experiment in GitLab 19.2.

Version sets of the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versionSets:
search (String)
Search version sets by name or description.
statuses ([CdVersionSetStatus!])
Filter releases by status.

CdApplicationConnection#

Paginated collection of CdApplication. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdApplicationFlowDefinition#

Continuous deployment application flow definition.

Fields#

Name Type Description
application CdApplication Application the flow definition belongs to.
createdAt Time! Timestamp of when the application flow definition was created.
definition String Introduced as an experiment in GitLab 19.2.

Body of the application flow definition.
definitionSteps [CdDefinitionStep!] Introduced as an experiment in GitLab 19.3.

Top-level nodes of the flow definition's static step tree, computed from its YAML and not persisted. A stage node exposes its nested steps through its own steps field.
id CdApplicationFlowDefinitionID! Global ID of the application flow definition.
updatedAt Time! Timestamp of when the application flow definition was last updated.
version Int! Version of the application flow definition.

CdApplicationFlowDefinitionConnection#

Paginated collection of CdApplicationFlowDefinition. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

Continuous deployment application link.

Fields#

Name Type Description
application CdApplication! Application the link belongs to.
createdAt Time! Timestamp of when the link was created.
id CdApplicationLinkID! Global ID of the link.
linkType CdApplicationLinkType! Type of the link.
name String! Name of the link.
updatedAt Time! Timestamp of when the link was last updated.
url String! URL of the link.

CdApplicationLinkConnection#

Paginated collection of CdApplicationLink. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdApplicationPermissions#

Check permissions for the current user on a continuous deployment application.

Fields#

Name Type Description
createCdApplicationFlowDefinition Boolean! If true, the user can perform create_cd_application_flow_definition on this resource.
createCdApplicationLink Boolean! If true, the user can perform create_cd_application_link on this resource.
createCdRollout Boolean! If true, the user can perform create_cd_rollout on this resource.
createCdService Boolean! If true, the user can perform create_cd_service on this resource.
createCdVersionSet Boolean! If true, the user can perform create_cd_version_set on this resource.
readCdApplication Boolean! If true, the user can perform read_cd_application on this resource.
resolveCdRolloutGate Boolean! If true, the user can perform resolve_cd_rollout_gate on this resource.
updateCdApplication Boolean! If true, the user can perform update_cd_application on this resource.
updateCdService Boolean! If true, the user can perform update_cd_service on this resource.

CdArtifactSource#

Continuous deployment artifact source.

Fields#

Name Type Description
createdAt Time! Timestamp of when the artifact source was created.
id CdArtifactSourceID! Global ID of the artifact source.
name String Name of the artifact source.
service CdService Service the artifact source belongs to.
sourceConfig JSON Configuration of the artifact source, defined by the consuming driver.
sourceRef String Reference of the artifact source.
updatedAt Time! Timestamp of when the artifact source was last updated.
versions CdVersionConnection Introduced as an experiment in GitLab 19.2.

Versions of the artifact source. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

CdArtifactSourceConnection#

Paginated collection of CdArtifactSource. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdDefinitionStep#

Node in a continuous deployment flow definition step tree, computed from its YAML and not persisted.

Fields#

Name Type Description
environment CdEnvironment Environment the step targets, null for steps that target no environment (for example a stage container or a wait step) or that name an environment that does not exist.
name String Name of the step, as defined by the flow definition.
params JSON Step-specific configuration copied from the flow definition (for example wait seconds or canary service weights).
parentPath String Path of the parent step, null for a top-level step.
path String! Position of the step in the flow definition tree (for example "0", "0.1").
stepType String! Type of the step, as defined by the flow definition (for example "com.gitlab.cd.steps.stage" or a deploy driver step type).
steps [CdDefinitionStep!] Nested steps, for a stage step. Empty for any other step type.

CdDeployment#

Continuous deployment deployment.

Fields#

Name Type Description
createdAt Time! Timestamp of when the deployment was created.
deploymentTransitions CdDeploymentTransitionConnection Introduced as an experiment in GitLab 19.2.

Transition journal of the deployment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
finishedAt Time Timestamp of when the deployment finished.
id CdDeploymentID! Global ID of the deployment.
rolloutEnvironment CdRolloutEnvironment Rollout environment the deployment belongs to.
service CdService Service being deployed.
startedAt Time Timestamp of when the deployment started.
state CdDeploymentState! State of the deployment.
updatedAt Time! Timestamp of when the deployment was last updated.

CdDeploymentConnection#

Paginated collection of CdDeployment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdDeploymentTransition#

Continuous deployment deployment transition journal entry.

Fields#

Name Type Description
createdAt Time! Timestamp of when the transition was recorded.
event String! Event that triggered the transition.
fromState CdDeploymentTransitionState! State the deployment transitioned from.
id CdDeploymentTransitionID! Global ID of the deployment transition.
onBehalfOf String Originating principal a composite-identity action was performed on behalf of.
principal String! Identity reference of the principal that triggered the transition, for example user:1234.
reason String Reason for the transition.
toState CdDeploymentTransitionState! State the deployment transitioned to.
triggeredBy String Identifier of what triggered the transition.

CdDeploymentTransitionConnection#

Paginated collection of CdDeploymentTransition. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironment#

Continuous deployment environment.

Fields#

Name Type Description
applications CdEnvironmentApplicationConnection Introduced as an experiment in GitLab 19.3.

Applications with services in the environment, each with its service count in the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
applicationsCount Int! Introduced as an experiment in GitLab 19.3.

Number of applications with services in the environment.
createdAt Time! Timestamp of when the environment was created.
description String Description of the environment.
environmentDriverBindings CdEnvironmentDriverBindingConnection Introduced as an experiment in GitLab 19.2.

Driver bindings of the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
healthStatus CdServiceHealth Introduced as an experiment in GitLab 19.4.

Worst observed service health across the environment. Null when no service health has been reported.
id CdEnvironmentID! Global ID of the environment.
latestFinishedRolloutEnvironment CdRolloutEnvironment Introduced as an experiment in GitLab 19.4.

Most recently finished rollout environment for the environment.
name String! Name of the environment.
organization Organization Organization the environment belongs to.
rolloutEnvironments CdRolloutEnvironmentConnection Introduced as an experiment in GitLab 19.2.

Rollout environments of the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
serviceEnvironmentHealths CdServiceEnvironmentHealthConnection Introduced as an experiment in GitLab 19.2.

Observed service health in the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
servicesCount Int! Introduced as an experiment in GitLab 19.3.

Number of services with observed health in the environment.
tier CdEnvironmentTier! Tier of the environment.
updatedAt Time! Timestamp of when the environment was last updated.

CdEnvironmentApplication#

An application with services in a continuous deployment environment.

Fields#

Name Type Description
application CdApplication Introduced as an experiment in GitLab 19.3.

Application with services in the environment.
serviceEnvironmentHealths CdServiceEnvironmentHealthConnection Introduced as an experiment in GitLab 19.3.

Observed health of the application's services in the environment, each with the versions currently deployed there. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
servicesCount Int! Introduced as an experiment in GitLab 19.3.

Number of the application's services in the environment.

CdEnvironmentApplicationConnection#

Paginated collection of CdEnvironmentApplication. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironmentConnection#

Paginated collection of CdEnvironment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironmentDriverBinding#

Continuous deployment environment driver binding.

Fields#

Name Type Description
createdAt Time! Timestamp of when the environment driver binding was created.
driverConfig JSON! Introduced as an experiment in GitLab 19.2.

Configuration of the environment driver binding, defined by the driver's own schema.
driverRef String! Reference of the driver.
environment CdEnvironment Environment the driver binding belongs to.
id CdEnvironmentDriverBindingID! Global ID of the environment driver binding.
updatedAt Time! Timestamp of when the environment driver binding was last updated.
version Int! Version of the environment driver binding.

CdEnvironmentDriverBindingConnection#

Paginated collection of CdEnvironmentDriverBinding. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRollout#

Continuous deployment rollout.

Fields#

Name Type Description
application CdApplication Application the rollout belongs to.
applicationFlowDefinition CdApplicationFlowDefinition Introduced as an experiment in GitLab 19.2.

Flow definition the rollout was created from.
awaitingApproval Boolean! Introduced as an experiment in GitLab 19.3.

Indicates whether the rollout has an open approval gate awaiting a decision, derived from its transition journal.
createdAt Time! Timestamp of when the rollout was created.
finishedAt Time Timestamp of when the rollout finished.
gates [CdRolloutGate!] Introduced as an experiment in GitLab 19.4.

Approval gates recorded against the rollout, in the order they were opened, derived from its transition journal.
id CdRolloutID! Global ID of the rollout.
iid Int! Internal ID of the rollout, unique and user-facing within its application.
rolloutEnvironments CdRolloutEnvironmentConnection Introduced as an experiment in GitLab 19.2.

Rollout environments of the rollout. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
rolloutSteps [CdRolloutStep!] Introduced as an experiment in GitLab 19.3.

Top-level nodes of the rollout flow definition tree, in position order. A stage node exposes its nested steps through its own steps field.
rolloutTransitions CdRolloutTransitionConnection Introduced as an experiment in GitLab 19.2.

Transition journal of the rollout. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
startedAt Time Timestamp of when the rollout started.
state CdRolloutState! State of the rollout.
triggeredByUser UserCore Introduced as an experiment in GitLab 19.3.

User who triggered the rollout, derived from its transition journal. Null if the rollout was triggered by a non-user principal (for example, a policy or schedule).
updatedAt Time! Timestamp of when the rollout was last updated.
versionSet CdVersionSet Version set the rollout deploys.
workflowRef String Workflow reference of the rollout.

CdRolloutConnection#

Paginated collection of CdRollout. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutEnvironment#

Continuous deployment rollout environment.

Fields#

Name Type Description
createdAt Time! Timestamp of when the rollout environment was created.
deployments CdDeploymentConnection Introduced as an experiment in GitLab 19.2.

Deployments of the rollout environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
environment CdEnvironment Environment the rollout environment targets.
finishedAt Time Timestamp of when the rollout environment finished.
id CdRolloutEnvironmentID! Global ID of the rollout environment.
position Int! Position of the rollout environment in the rollout sequence.
rollout CdRollout Rollout the rollout environment belongs to.
startedAt Time Timestamp of when the rollout environment started.
state CdRolloutEnvironmentState! State of the rollout environment.
updatedAt Time! Timestamp of when the rollout environment was last updated.

CdRolloutEnvironmentConnection#

Paginated collection of CdRolloutEnvironment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutGate#

Continuous deployment rollout approval gate, derived from its transition journal.

Fields#

Name Type Description
id CdRolloutTransitionID! Global ID of the transition that opened the gate.
name String Label of the gate, derived from the step it was opened for.
reason String Reason the approval was requested for.
resolutionReason String Reason given when the gate was resolved, if any.
resolvedAt Time Timestamp of when the gate was resolved, null while still pending.
resolvedBy UserCore User that resolved the gate, when the resolving principal identifies a user that still exists; null while pending or for other principal kinds.
state CdRolloutGateState! State of the gate.
step CdRolloutStep Rollout step the gate was opened for, null for a gate opened for a non-step reason.

CdRolloutStep#

Node in a continuous deployment rollout flow definition tree.

Fields#

Name Type Description
createdAt Time! Timestamp of when the step was created.
environment CdEnvironment Environment the step targets, null for steps that target no environment (for example a stage container or a wait step).
error String Error message of the step, if it failed.
finishedAt Time Timestamp of when the step finished.
id CdRolloutStepID! Global ID of the rollout step.
name String Name of the step, as defined by the flow definition.
params JSON Step-specific configuration copied from the flow definition (for example wait seconds or canary service weights).
parentPath String Path of the parent step, null for a top-level step.
path String! Position of the step in the flow definition tree (for example "0", "0.1").
startedAt Time Timestamp of when the step started.
state CdRolloutStepState! State of the step.
stepType String! Type of the step, as defined by the flow definition (for example "com.gitlab.cd.steps.stage" or a deploy driver step type).
steps [CdRolloutStep!] Nested steps, for a stage step. Empty for any other step type.
updatedAt Time! Timestamp of when the step was last updated.

CdRolloutTransition#

Continuous deployment rollout transition journal entry.

Fields#

Name Type Description
createdAt Time! Timestamp of when the transition was recorded.
event String! Event that triggered the transition.
fromState CdRolloutTransitionState! State the rollout transitioned from.
id CdRolloutTransitionID! Global ID of the rollout transition.
onBehalfOf String Originating principal a composite-identity action was performed on behalf of.
principal String! Identity reference of the principal that triggered the transition, for example user:1234.
principalUser UserCore Introduced as an experiment in GitLab 19.3.

User that triggered the transition, when the principal identifies a user that still exists; null for other principal kinds or a deleted user.
reason String Reason for the transition.
resolutionReason String Reason given when resolving an approval gate, for an approve/reject transition.
toState CdRolloutTransitionState! State the rollout transitioned to.
triggeredBy String Identifier of what triggered the transition.

CdRolloutTransitionConnection#

Paginated collection of CdRolloutTransition. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutUpdate#

Live rollout update pushed to the client: new deployment status, and a Duo session to open when one applies.

Fields#

Name Type Description
reason CdRolloutUpdateReason Why Duo should engage for the update (failed or created); null for a plain status update.
rollout CdRollout! Rollout the update is for.
rolloutEnvironment CdRolloutEnvironment Rollout environment whose state changed. Read its state and environment.tier to color the stage dot.
thread AiConversationsThread Duo session to open in the sidebar for the update, when one applies.

CdService#

Continuous deployment service.

Fields#

Name Type Description
application CdApplication! Application the service belongs to.
artifactSources CdArtifactSourceConnection Introduced as an experiment in GitLab 19.2.

Artifact sources of the service. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp of when the service was created.
description String Description of the service.
id CdServiceID! Global ID of the service.
lastDeployedAt Time Introduced as an experiment in GitLab 19.2.

Timestamp of the service's most recently finished deployment.
name String! Name of the service.
serviceEnvironmentHealths CdServiceEnvironmentHealthConnection Introduced as an experiment in GitLab 19.2.

Observed health of the service across environments, ordered from worst to best. Request the first result to get the worst observed health of the service overall. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp of when the service was last updated.

CdServiceConnection#

Paginated collection of CdService. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdServiceEnvironmentHealth#

Observed health of a continuous deployment service in an environment.

Fields#

Name Type Description
createdAt Time! Timestamp of when the service environment health was created.
deployedVersions CdVersionConnection Introduced as an experiment in GitLab 19.3.

Versions of the service currently deployed in this environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
environment CdEnvironment Environment the health belongs to.
health CdServiceHealth! Observed health of the service in the environment.
id CdServiceEnvironmentHealthID! Global ID of the service environment health.
observedAt Time! Timestamp of when the health was observed.
service CdService Service the health belongs to.

CdServiceEnvironmentHealthConnection#

Paginated collection of CdServiceEnvironmentHealth. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersion#

Continuous deployment artifact version.

Fields#

Name Type Description
artifactSource CdArtifactSource Artifact source the version belongs to.
createdAt Time! Timestamp of when the version was created.
digest String Digest of the version.
environments CdEnvironmentConnection Introduced as an experiment in GitLab 19.2.

Distinct environments the version has been deployed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id CdVersionID! Global ID of the version.
name String! Name of the version.
reference String Reference of the version.
updatedAt Time! Timestamp of when the version was last updated.
verified Boolean! Indicates the version was observed being pushed to the artifact source, rather than entered as a free-text name.

CdVersionConnection#

Paginated collection of CdVersion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersionSet#

Continuous deployment version set.

Fields#

Name Type Description
application CdApplication Application the version set belongs to.
author UserCore Introduced as an experiment in GitLab 19.3.

User who created the version set. Null if it was created before author tracking was added.
createdAt Time! Timestamp of when the version set was created.
description String Description of the version set.
entriesDigest String Digest of the version set entries.
id CdVersionSetID! Global ID of the version set.
name String! Name of the version set.
rollouts CdRolloutConnection Introduced as an experiment in GitLab 19.2.

Rollouts of the version set. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for rollouts:
search (String)
Search rollouts by ID (IID).
statuses ([CdRolloutStatus!])
Filter rollouts by status.
status CdVersionSetStatus Introduced as an experiment in GitLab 19.3.

High-level lifecycle status of the release, or null when the release is currently live and has not been superseded or rolled back.
updatedAt Time! Timestamp of when the version set was last updated.
versionSetEntries CdVersionSetEntryConnection Introduced as an experiment in GitLab 19.2.

Entries of the version set. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

CdVersionSetConnection#

Paginated collection of CdVersionSet. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersionSetEntry#

Continuous deployment version set entry.

Fields#

Name Type Description
artifactSource CdArtifactSource Artifact source the entry references.
createdAt Time! Timestamp of when the version set entry was created.
id CdVersionSetEntryID! Global ID of the version set entry.
service CdService Service the entry references.
updatedAt Time! Timestamp of when the version set entry was last updated.
version CdVersion Version the entry references.
versionSet CdVersionSet Version set the entry belongs to.

CdVersionSetEntryConnection#

Paginated collection of CdVersionSetEntry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

CiBuildNeedConnection#

Paginated collection of CiBuildNeed. See Standard connection fields for the fields available on every connection.

CiCatalogBundledResource#

A GitLab-maintained bundled CI/CD catalog resource on the current cell.

Fields#

Name Type Description
description String Introduced as an experiment in GitLab 19.3.

Description of the bundled catalog resource.
fullPath ID Introduced as an experiment in GitLab 19.3.

Full path of the bundled catalog resource (for example, components/sast).
id ID! Introduced as an experiment in GitLab 19.3.

ID of the bundled catalog resource.
latestReleasedAt Time Introduced as an experiment in GitLab 19.3.

Release date of the bundled catalog resource's latest version.
latestVersionName String Introduced as an experiment in GitLab 19.3.

Name of the latest version of the bundled catalog resource (for example, v1.2.3).
name String Introduced as an experiment in GitLab 19.3.

Name of the bundled catalog resource.
serverFqdn String Introduced as an experiment in GitLab 19.3.

FQDN of the GitLab instance that maintains the bundled catalog resource.

CiCatalogBundledResourceConnection#

Paginated collection of CiCatalogBundledResource. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCatalogResource#

Fields#

Name Type Description
archived Boolean Indicates the archived status of the project.
description String Description of the catalog resource.
fullPath ID Introduced as an experiment in GitLab 16.11.

Full project path of the catalog resource.
icon String Icon for the catalog resource.
id ID! ID of the catalog resource.
last30DayUsageCount Int! Introduced as an experiment in GitLab 17.0.

Number of unique projects that used a component from this catalog project in a pipeline by using include:component in the last 30 days.
latestReleasedAt Time Introduced as an experiment in GitLab 16.5.

Release date of the catalog resource's latest version.
name String Name of the catalog resource.
projectComponentUsages CiCatalogResourceProjectUsageConnection Introduced as an experiment in GitLab 18.11.

Projects using components from this catalog resource. Only available to maintainers of the catalog resource project. This field can only be resolved for one catalog resource in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectComponentUsages:
componentName (String)
Filter to projects using a component with this name. Matches across all versions of the catalog resource.
sort (CiCatalogResourceProjectUsageSort)
Sort projects by given criteria.
versionId (CiCatalogResourcesVersionID)
Filter to projects using a specific version of the catalog resource.
versionIds ([CiCatalogResourcesVersionID!])
Returns projects that used one or more specific versions of the catalog resource.
starCount Int! Number of times the catalog resource has been starred.
starrersPath String Relative path to the starrers page for the catalog resource project.
topics [String!] Topics for the catalog resource.
verificationLevel CiCatalogResourceVerificationLevel Verification level of the catalog resource.
versions CiCatalogResourceVersionConnection Versions of the catalog resource. This field can only be resolved for one catalog resource in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
name (String)
Name of the version.
search (String)
Search term to filter versions by name.
visibilityLevel VisibilityLevelsEnum Visibility level of the catalog resource.
webPath String Introduced as an experiment in GitLab 16.1.

Web path of the catalog resource.

CiCatalogResourceComponent#

Fields#

Name Type Description
description String Description of the component.
id CiCatalogResourcesComponentID! ID of the component.
includePath String Path used to include the component.
inputs [CiInputsSpec!] Inputs for the component.
last30DayUsageCount Int Number of unique projects that used this version of the component in a pipeline by using include in the last 30 days.
name String Name of the component.

CiCatalogResourceComponentConnection#

Paginated collection of CiCatalogResourceComponent. See Standard connection fields for the fields available on every connection.

CiCatalogResourceComponentUsage#

Represents a component usage in a project.

Fields#

Name Type Description
lastUsedDate ISO8601Date When the component was last used.
name String Name of the component.
version String Version of the component.

CiCatalogResourceComponentUsageConnection#

Paginated collection of CiCatalogResourceComponentUsage. See Standard connection fields for the fields available on every connection.

CiCatalogResourceComponentUsageDetail#

Details of a project's usage of a component from a catalog resource.

Fields#

Name Type Description
component CiCatalogResourceComponent! Introduced as an experiment in GitLab 18.11.

Component being used.
lastUsedDate ISO8601Date! Introduced as an experiment in GitLab 18.11.

Date when the component was last used by the project.
outdated Boolean! Introduced as an experiment in GitLab 18.11.

Whether the project is using a component version older than the catalog resource latest version.
version CiCatalogResourceVersion Introduced as an experiment in GitLab 18.11.

Version of the component being used.

CiCatalogResourceConnection#

Paginated collection of CiCatalogResource. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCatalogResourceProjectUsage#

A project that uses components from a catalog resource.

Fields#

Name Type Description
componentsUsed [CiCatalogResourceComponentUsageDetail!]! Introduced as an experiment in GitLab 18.11.

List of components from the catalog resource used by the project.
project Project Introduced as an experiment in GitLab 18.11.

Project using the components. Returns null if user cannot access the project.

CiCatalogResourceProjectUsageConnection#

Paginated collection of CiCatalogResourceProjectUsage. See Standard connection fields for the fields available on every connection.

CiCatalogResourceSemver#

Semantic version information for a catalog resource version.

Fields#

Name Type Description
major Int Major version number.
minor Int Minor version number.
patch Int Patch version number.

CiCatalogResourceVersion#

Fields#

Name Type Description
author UserCore User that created the version.
commit Commit Commit associated with the version.
components CiCatalogResourceComponentConnection Components belonging to the catalog resource. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time Timestamp of when the version was created.
id CiCatalogResourcesVersionID! Global ID of the version.
name String Name that uniquely identifies the version within the catalog resource.
path String Relative web path to the version.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.
releasedAt Time Introduced as an experiment in GitLab 16.7.

Timestamp of when the version was released.
semver CiCatalogResourceSemver Semantic version information.

CiCatalogResourceVersionConnection#

Paginated collection of CiCatalogResourceVersion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCdSettings#

Fields#

Name Type Description
pipelineVariablesDefaultRole String Indicates the default minimum role required to override pipeline variables in the namespace.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the job group.
size Int Size of the job group.

CiConfigGroupConnection#

Paginated collection of CiConfigGroup. See Standard connection fields for the fields available on every connection.

CiConfigGroupV2#

Fields#

Name Type Description
jobs [CiConfigJobV2!] Jobs in group.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

CiConfigJobConnection#

Paginated collection of CiConfigJob. See Standard connection fields for the fields available on every connection.

CiConfigJobRestriction#

Fields#

Name Type Description
refs [String!] Git refs the job restriction applies to.

CiConfigJobV2#

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 [CiConfigNeed!] Builds that must complete before the jobs run.
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.

CiConfigNeed#

Fields#

Name Type Description
name String Name of the need.

CiConfigNeedConnection#

Paginated collection of CiConfigNeed. See Standard connection fields for the fields available on every connection.

CiConfigStage#

Fields#

Name Type Description
groups CiConfigGroupConnection Groups of jobs for the stage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the stage.

CiConfigStageConnection#

Paginated collection of CiConfigStage. See Standard connection fields for the fields available on every connection.

CiConfigStageV2#

Fields#

Name Type Description
groups [CiConfigGroupV2!] Groups of jobs for the stage.
name String Name of the stage.

CiConfigV2#

Fields#

Name Type Description
errors [String!] Linting errors.
includes [CiConfigInclude!] List of included files.
mergedYaml String Merged CI configuration YAML.
stages [CiConfigStageV2!] Stages of the pipeline.
status CiConfigStatus Status of linting, can be either valid or invalid.
warnings [String!] Linting warnings.

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.

CiDedicatedHostedRunnerFilters#

Filter options available for GitLab Dedicated runner usage data.

Fields#

Name Type Description
deletedRunners CiDeletedRunnerConnection List of runner IDs from usage data without associated runner records. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
runners CiRunnerConnection List of unique runners with usage data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
years [Int!] List of years with available usage data.

CiDedicatedHostedRunnerUsage#

Compute usage data for hosted runners on GitLab Dedicated.

Fields#

Name Type Description
billingMonth String! Month of the usage data.
billingMonthIso8601 ISO8601Date! Timestamp of the billing month in ISO 8601 format.
computeMinutes Int! Total compute minutes used across all namespaces. Values are rounded down to the nearest integer.
computeMinutesUsage Float! Total compute minutes used across all namespaces.
durationMinutes Float! Total duration in minutes of runner usage.
durationSeconds Int! Total duration in seconds of runner usage. Values are rounded down to the nearest integer.
rootNamespace NamespaceUnion Namespace associated with the usage data. Null for instance aggregate data.

CiDedicatedHostedRunnerUsageConnection#

Paginated collection of CiDedicatedHostedRunnerUsage. See Standard connection fields for the fields available on every connection.

CiDeletedNamespace#

Reference to a namespace that no longer exists.

Fields#

Name Type Description
id NamespaceID ID of the deleted namespace.

CiDeletedRunner#

Reference to a deleted runner.

Fields#

Name Type Description
id CiRunnerID! Global ID of the deleted runner.

CiDeletedRunnerConnection#

Paginated collection of CiDeletedRunner. See Standard connection fields for the fields available on every connection.

CiDurationStatistics#

Histogram of durations for a group of CI/CD jobs or pipelines.

Fields#

Name Type Description
mean Duration Introduced as an experiment in GitLab 18.7.

Mean (average) duration.
p50 Duration Introduced as an experiment in GitLab 15.8.

50th percentile. 50% of the durations are lower than this value.
p75 Duration Introduced as an experiment in GitLab 15.8.

75th percentile. 75% of the durations are lower than this value.
p90 Duration Introduced as an experiment in GitLab 15.8.

90th percentile. 90% of the durations are lower than this value.
p95 Duration Introduced as an experiment in GitLab 15.8.

95th percentile. 95% of the durations are lower than this value.
p99 Duration Introduced as an experiment in GitLab 15.8.

99th percentile. 99% of the durations are lower than this value.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the job group.
size Int Size of the group.

CiGroupConnection#

Paginated collection of CiGroup. See Standard connection fields for the fields available on every connection.

CiGroupEnvironmentScope#

CI/CD environment scope for a group.

Fields#

Name Type Description
name String Scope name defininig the enviromnments that can use the variable.

CiGroupEnvironmentScopeConnection#

Paginated collection of CiGroupEnvironmentScope. See Standard connection fields for the fields available on every connection.

CiGroupVariable#

CI/CD variables for a group.

Implements: CiVariable

Fields#

Name Type Description
description String Description of the variable.
environmentScope String Scope defining the environments that can use the variable.
hidden Boolean Indicates whether the variable is hidden.
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.

CiGroupVariableConnection#

Paginated collection of CiGroupVariable. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
limit Int! Maximum amount of group CI/CD variables.

CiInputsCondition#

Condition node in rule expression tree.

Fields#

Name Type Description
children [CiInputsCondition!] Child conditions for AND/OR nodes.
field String Input field name for comparison nodes.
operator String! Operator type: equals, not_equals, AND, OR.
value CiInputsValue Expected value for comparison nodes.

CiInputsField#

CI input saved for a pipeline schedule.

Fields#

Name Type Description
name String! Name of the input.
value CiInputsValue Value of the input.

CiInputsFieldConnection#

Paginated collection of CiInputsField. See Standard connection fields for the fields available on every connection.

CiInputsRule#

Conditional rule for dynamic input options.

Fields#

Name Type Description
conditionTree CiInputsCondition Parsed condition tree for frontend eval.
default CiInputsValue Default value when rule matches. Can be a string, array, number, or boolean.
if String Condition expression.
options [CiInputsValue!] Available options when rule matches. Each option can be a string, array, number, or boolean.

CiInputsSpec#

Input for pipeline creation.

Fields#

Name Type Description
default CiInputsValue Default value for the input, if provided.
description String Description of the input.
name String! Name of the input.
options CiInputsValue Possible values that the input can take, if provided.
regex String Regular expression pattern that the input value must match if provided.
required Boolean! Indicates whether the input is required.
rules [CiInputsRule!] Conditional rules for dynamic input options.
type CiInputsType! Input data type.

CiInstanceVariable#

CI/CD variables for a GitLab instance.

Implements: CiVariable

Fields#

Name Type Description
description String Description of the variable.
environmentScope String Deprecated in GitLab 15.3. No longer used, only available for GroupVariableType and ProjectVariableType.
hidden Boolean Indicates whether the variable is hidden.
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.

CiInstanceVariableConnection#

Paginated collection of CiInstanceVariable. See Standard connection fields for the fields available on every connection.

CiJob#

Implements: CiJobInterface

Fields#

Name Type Description
active Boolean! Indicates the job is active.
allowFailure Boolean! Whether the job is allowed to fail.
artifacts CiJobArtifactConnection Artifacts generated by the job. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
exitCode Int Exit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code.
expandedEnvironmentName String Variable-expanded name of the environment the job is configured to deploy to, recorded when the pipeline was created. Null when the job does not declare an environment, or when no name was recorded for it.
failureMessage String Message on why the job failed.
finishedAt Time When a job has finished running.
id JobID ID of the job.
inputs [CiInputsField!] Input values that were used when the job was created or retried. A value is only present in the field if it differs from the default value in the input configuration. This field can only be resolved for one job in any single request.
inputsSpec [CiInputsSpec!] Input specification for the job. Defines the inputs that can be provided when creating or retrying the job. This field can only be resolved for one job in any single request.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the job.
needs CiBuildNeedConnection References to builds that must complete before the jobs run. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipeline PipelineInterface Pipeline the job belongs to.
playPath String Play path of the job.
playable Boolean! Indicates the job can be played.
previousStageJobs CiJobConnection Deprecated in GitLab 19.2. No longer required. Previous stage jobs are now computed on the client side. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
previousStageJobsOrNeeds JobNeedUnionConnection Deprecated in GitLab 16.4. Replaced by previousStageJobs and needs fields. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
retryPath String Retry path of the job.
retryable Boolean! Indicates the job can be retried.
runner CiRunner Runner assigned to execute the job.
runnerManager CiRunnerManager 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.
source String Policy or action that initiated the job. If not set, the value is inherited from the pipeline.
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.

CiJobAnalytics#

CI/CD job analytics data.

Fields#

Name Type Description
name String Job name.
stageName String Stage name.
statistics CiJobAnalyticsStatistics Statistics for the jobs.

CiJobAnalyticsConnection#

Paginated collection of CiJobAnalytics. See Standard connection fields for the fields available on every connection.

CiJobAnalyticsStatistics#

Statistics for CI/CD job analytics.

Fields#

Name Type Description
count BigInt Count of jobs, optionally filtered by status.

Arguments for count:
status (PipelineAnalyticsJobStatus)
Filter job count by status.
durationStatistics CiDurationStatistics Duration statistics for the jobs.
rate Float Percentage of jobs, optionally filtered by status. SUCCESS and FAILED rates use (success + failed) as the denominator; OTHER (canceled or skipped) uses the total job count.

Arguments for rate:
status (PipelineAnalyticsJobStatus)
Filter job rate by status. If not specified, returns 100.0 (representing all jobs).

CiJobArtifact#

Fields#

Name Type Description
downloadPath String URL for downloading the artifact's file.
expireAt Time Expiry date of the artifact.
expired Boolean! Expired state 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.

CiJobArtifactConnection#

Paginated collection of CiJobArtifact. See Standard connection fields for the fields available on every connection.

CiJobConnection#

Paginated collection of CiJob. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

CiJobInterfaceConnection#

Paginated collection of CiJobInterface. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

CiJobMinimalAccess#

Implements: CiJobInterface

Fields#

Name Type Description
active Boolean! Indicates the job is active.
allowFailure Boolean! Whether the job is allowed to fail.
artifacts CiJobArtifactConnection Artifacts generated by the job. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
duration Int Duration of the job in seconds.
erasedAt Time When the job was erased.
exitCode Int Exit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code.
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.
name String Name of the job.
pipeline PipelineInterface Pipeline the job belongs to.
playPath String Play path of the job.
playable Boolean Indicates the job can be played.
project ProjectInterface 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.
retryPath String Retry path of the job.
retryable Boolean Indicates the job can be retried.
runner CiRunner Runner assigned to execute 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.
source String Policy or action that initiated the job. If not set, the value is inherited from the pipeline.
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 job.
webPath String Web path of the job.

CiJobTokenAccessibleGroup#

Group that can access the current project by authenticating with a CI/CD job token.

Fields#

Name Type Description
avatarUrl String Avatar URL of the group.
fullPath ID! Full path of the group.
id ID! ID of the group.
name String! Name of the group.
path String! Path of the group.
webUrl String Web URL of the group.

CiJobTokenAccessibleGroupConnection#

Paginated collection of CiJobTokenAccessibleGroup. See Standard connection fields for the fields available on every connection.

CiJobTokenAccessibleProject#

Project that can access the current project by authenticating with a CI/CD job token.

Fields#

Name Type Description
avatarUrl String URL to avatar image file of the project.
fullPath ID! Full path of the project.
id ID! ID of the project.
name String! Name of the project (without namespace).
path String! Path of the project.
webUrl String Web URL of the project.

CiJobTokenAccessibleProjectConnection#

Paginated collection of CiJobTokenAccessibleProject. See Standard connection fields for the fields available on every connection.

CiJobTokenAuthLog#

Fields#

Name Type Description
lastAuthorizedAt Time! Introduced as an experiment in GitLab 17.6.

Last authorization date time.
originProject CiJobTokenAccessibleProject! Introduced as an experiment in GitLab 17.6.

Origin project.

CiJobTokenAuthLogConnection#

Paginated collection of CiJobTokenAuthLog. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiJobTokenScopeAllowlist#

Fields#

Name Type Description
groupsAllowlist CiJobTokenScopeAllowlistEntryConnection Allowlist of groups that can access the current project by authenticating with a CI/CD job token. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projectsAllowlist CiJobTokenScopeAllowlistEntryConnection Allowlist of projects that can access the current project by authenticating with a CI/CD job token. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

CiJobTokenScopeAllowlistEntry#

Represents an allowlist entry for the CI_JOB_TOKEN.

Fields#

Name Type Description
addedBy UserCore User that added the entry.
autopopulated Boolean Indicates whether the entry is created by the autopopulation process.
createdAt Time! When the entry was created.
defaultPermissions Boolean Indicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
direction String Deprecated in GitLab 18.0. Outbound job token scope is being removed. This field can only be INBOUND.
jobTokenPolicies [CiJobTokenScopePolicies!] Introduced as an experiment in GitLab 17.5.

List of policies for the entry.
sourceProject Project! Project that owns the allowlist entry.
target CiJobTokenScopeTarget Group or project allowed by the entry.

CiJobTokenScopeAllowlistEntryConnection#

Paginated collection of CiJobTokenScopeAllowlistEntry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiJobTokenScopeType#

Fields#

Name Type Description
groupAllowlistAutopopulatedIds [GroupID!]! List of IDs of groups which have been created by the autopopulation process.
groupsAllowlist CiJobTokenAccessibleGroupConnection! Allowlist of groups that can access the current project by authenticating with a CI/CD job token. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupsAllowlistCount Int! Count of groups that can access the current project by authenticating with a CI/CD job token. The count does not include subgroups.
inboundAllowlist CiJobTokenAccessibleProjectConnection! Allowlist of projects that can access the current project by authenticating with a CI/CD job token. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
inboundAllowlistAutopopulatedIds [ProjectID!]! List of IDs of projects which have been created by the autopopulation process.
inboundAllowlistCount Int! Count of projects that can access the current project by authenticating with a CI/CD job token. The count does not include nested projects.
outboundAllowlist ProjectConnection! Deprecated in GitLab 18.0. Outbound job token scope is being removed. Only inbound allowlist is supported. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projects ProjectConnection! Deprecated in GitLab 15.9. The projects attribute is being deprecated. Use outbound_allowlist. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

CiJobTrace#

Fields#

Name Type Description
htmlSummary String! Introduced as an experiment in GitLab 15.11.

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.

Arguments for htmlSummary:
lastLines (Int)
Number of tail lines to return, up to a maximum of 100 lines.

CiJobsStatistics#

Statistics for a group of CI jobs.

Fields#

Name Type Description
queuedDuration CiDurationStatistics Statistics for the amount of time that jobs were waiting to be picked up. The calculation is based on the 100 most recent jobs run by the 5000 most recently created runners in context. If no filter is applied to runners, the calculation uses the 100 most recent jobs globally.

CiManualVariable#

CI/CD variables given to a manual job.

Implements: CiVariable

Fields#

Name Type Description
environmentScope String Deprecated in GitLab 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.

CiManualVariableConnection#

Paginated collection of CiManualVariable. See Standard connection fields for the fields available on every connection.

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 Deprecated in GitLab 19.1. Use ciMinutesProjectMonthlyUsage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
sharedRunnersDuration Int Total duration (in seconds) of shared runners use by the namespace for the month.

CiMinutesNamespaceMonthlyUsageConnection#

Paginated collection of CiMinutesNamespaceMonthlyUsage. See Standard connection fields for the fields available on every connection.

CiMinutesProjectMonthlyUsage#

Fields#

Name Type Description
minutes Int Number of compute minutes used by the project in the month.
project Project Project having the recorded usage.
sharedRunnersDuration Int Total duration (in seconds) of shared runners use by the project for the month.

CiMinutesProjectMonthlyUsageConnection#

Paginated collection of CiMinutesProjectMonthlyUsage. See Standard connection fields for the fields available on every connection.

CiPipelineCreationRequest#

Information about an asynchronous pipeline creation request.

Fields#

Name Type Description
error String Error message if pipeline creation failed.
id String Unique ID of the pipeline creation request.
pipeline Pipeline Pipeline object created by the request.
pipelineId CiPipelineID ID of the created pipeline if creation was successful.
status CiPipelineCreationStatus! Current status of the pipeline creation.
userInitiated Boolean! Indicates whether the pipeline creation was explicitly requested by a user.

CiProjectSubscription#

Fields#

Name Type Description
author UserCore Author of the subscription.
downstreamProject CiSubscriptionsProjectDetails Downstream project of the subscription.When an upstream project's pipeline completes, a pipeline is triggered in the downstream project.
id CiSubscriptionsProjectID Global ID of the subscription.
upstreamProject CiSubscriptionsProjectDetails Upstream project of the subscription.When an upstream project's pipeline completes, a pipeline is triggered in the downstream project.

CiProjectSubscriptionConnection#

Paginated collection of CiProjectSubscription. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiProjectVariable#

CI/CD variables for a project.

Implements: CiVariable

Fields#

Name Type Description
description String Description of the variable.
environmentScope String Scope defining the environments that can use the variable.
hidden Boolean Indicates whether the variable is hidden.
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.

CiProjectVariableConnection#

Paginated collection of CiProjectVariable. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
limit Int! Maximum amount of project CI/CD variables.

CiRunner#

Fields#

Name Type Description
accessLevel CiRunnerAccessLevel! Access level of the runner.
active Boolean! Deprecated in GitLab 14.8. Use paused. This field is the inverse of paused and has no relationship to the runner's job execution status. For more details, see jobExecutionStatus.
adminUrl String Admin URL of the runner. Only available for administrators.
contactedAt Time Timestamp of last contact from the runner.
createdAt Time Timestamp of creation of the runner.
createdBy UserCore User that created the runner.
creationMethod CiRunnerCreationMethod Introduced as an experiment in GitLab 17.0.

Type of runner registration.
creationState CiRunnerCreationState Runner creation state. Used to determine if a runner has been registered and has contacted the GitLab instance.
description String Description of the runner.
editAdminUrl String Admin form URL of the runner. Only available for administrators.
ephemeralAuthenticationToken String Introduced as an experiment in GitLab 15.9.

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 as an experiment in GitLab 15.11.

URL of the registration page of the runner manager. Only available for the creator of the runner for a limited time during registration.
groups GroupInterfaceConnection Groups the runner is associated with. For group runners only. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id CiRunnerID! ID of the runner.
jobCount Int 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. The count only includes jobs on recent CI build partitions.

Arguments for jobCount:
statuses ([CiJobStatus!])
Filter jobs by status.
jobExecutionStatus CiRunnerJobExecutionStatus Job execution status of the runner.
jobs CiJobInterfaceConnection Jobs assigned to the runner. This field can only be resolved for one runner in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobs:
statuses ([CiJobStatus!])
Filter jobs by status.
locked Boolean Indicates the runner is locked.
maintenanceNote String Runner's maintenance notes.
maintenanceNoteHtml String GitLab Flavored Markdown rendering of maintenance_note.
managers CiRunnerManagerConnection Runner managers associated with the runner configuration. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for managers:
status (CiRunnerStatus)
Filter runner managers by status.
systemId (String)
Filter runner managers by system ID.
maximumTimeout Int Maximum timeout (in seconds) for jobs processed by the runner.
ownerProject ProjectInterface Project that owns the runner. For project runners only.
paused Boolean! Indicates the runner is paused and not available to run jobs.
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. The count includes projects that might not be visible to the current user.
projects ProjectConnection Find projects the runner is associated with. For project runners only. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
membership (Boolean)
Return only projects that the current user is a member of.
namespacePath (ID)
Filter projects by their namespace's full path (group or user).
personal (Boolean)
Return only personal projects.
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. Defaults to id_desc, or similarity if search used.
topics ([String!])
Filter projects by topics.
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.
runUntagged Boolean! Indicates the runner is able to run untagged jobs.
runnerType CiRunnerType! Type of the runner.
shortSha String First eight characters of the runner's token used to authenticate new job requests. Used as the runner's unique ID.
status CiRunnerStatus! Status of the runner.
tagList [String!] Tags associated with the runner.
tokenExpiresAt Time Runner token expiration time.
tokenRotationDeadline Time Introduced as an experiment in GitLab 18.10.

Deadline after which token rotation is rejected.
upgradeStatus CiRunnerUpgradeStatus Availability of upgrades for the runner.
userPermissions RunnerPermissions! Permissions for the current user on the resource.

CiRunnerCloudProvisioningStep#

Step used to provision the runner to Google Cloud.

Fields#

Name Type Description
instructions String Instructions to provision the runner.
languageIdentifier String Identifier of the language used for the instructions field. This identifier can be any of the identifiers specified in the list of supported languages and lexers.
title String Title of the step.

CiRunnerConnection#

Paginated collection of CiRunner. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
jobsStatistics CiJobsStatistics Jobs statistics for jobs executed by a collection of runners. Available only to admins.

CiRunnerEdge#

An edge in a connection.

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 the 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 the field in the query. You can use it for projects or groups.

CiRunnerGkeProvisioning#

Information used for GKE runner provisioning.

Fields#

Name Type Description
projectSetupShellScript String Instructions for setting up a Google Cloud project.
provisioningSteps [CiRunnerGkeProvisioningStep!] Steps used to provision a runner in GKE.

Arguments for provisioningSteps:
nodePools ([GoogleCloudNodePool!])
Configuration for the node pools of the runner.
region (GoogleCloudRegion!)
Name of the region to provision the runner in.
runnerToken (String!)
Authentication token of the runner.
zone (GoogleCloudZone!)
Name of the zone to provision the runner in.

CiRunnerGkeProvisioningStep#

Step used to provision the runner to GKE.

Fields#

Name Type Description
instructions String Instructions to provision the runner.
languageIdentifier String Identifier of the language used for the instructions field. This identifier can be any of the identifiers specified in the list of supported languages and lexers.
title String Title of the step.

CiRunnerGoogleCloudProvisioning#

Information used for runner Google Cloud provisioning.

Fields#

Name Type Description
projectSetupShellScript String Instructions for setting up a Google Cloud project.
provisioningSteps [CiRunnerCloudProvisioningStep!] Steps used to provision a runner in the cloud.

Arguments for provisioningSteps:
ephemeralMachineType (GoogleCloudMachineType!)
Name of the machine type to use for running jobs.
region (GoogleCloudRegion!)
Name of the region to provision the runner in.
runnerToken (String)
Authentication token of the runner.
zone (GoogleCloudZone!)
Name of the zone to provision the runner in.

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 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 Availability of upgrades for the runner manager.
version String Version of the runner.

CiRunnerManagerConnection#

Paginated collection of CiRunnerManager. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiRunnerUsage#

Runner usage in minutes.

Fields#

Name Type Description
ciBuildCount BigInt! Amount of builds executed during the selected period. Encoded as a string.
ciDuration BigInt! Number of minutes spent to process jobs during the selected period. Encoded as a string.
ciMinutesUsed BigInt! Deprecated in GitLab 17.5. Use ciDuration.
runner CiRunner Runner that the usage refers to. Null means "Other runners".

CiRunnerUsageByProject#

Runner usage in minutes by project.

Fields#

Name Type Description
ciBuildCount BigInt! Amount of builds executed during the selected period. Encoded as a string.
ciDuration BigInt! Number of minutes spent to process jobs during the selected period. Encoded as a string.
ciMinutesUsed BigInt! Deprecated in GitLab 17.5. Use ciDuration.
project Project Project that the usage refers to. Null means "Other projects".

CiSecureFileRegistry#

Represents the Geo replication and verification state of a ci_secure_file.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the CiSecureFileRegistry do not match on the primary and secondary.
ciSecureFileId ID! ID of the Ci Secure File.
createdAt Time Timestamp when the CiSecureFileRegistry was created.
dataManagementDetailsPath String Path to the data management view for this CiSecureFileRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the CiSecureFileRegistry is missing on primary.
modelRecordId Int ID of the CiSecureFileRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the CiSecureFileRegistry in case of mismatch.
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 of CiSecureFileRegistry started.
verificationState VerificationStateEnum Verification state of the CiSecureFileRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the CiSecureFileRegistry.

CiSecureFileRegistryConnection#

Paginated collection of CiSecureFileRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

CiStage#

Fields#

Name Type Description
detailedStatus DetailedStatus Detailed status of the stage.
groups CiGroupConnection Group of jobs for the stage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! ID of the stage.
jobs CiJobConnection Jobs for the stage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the stage.
status String Status of the pipeline stage.

CiStageConnection#

Paginated collection of CiStage. See Standard connection fields for the fields available on every connection.

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.

CiSubscriptionsProjectConnection#

Paginated collection of CiSubscriptionsProject. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiSubscriptionsProjectDetails#

Fields#

Name Type Description
id ID! ID of the project.
name ID! Full path of the project.
namespace CiSubscriptionsProjectNamespaceDetails! Namespace of the project.
webUrl String Web URL of the project.

CiSubscriptionsProjectNamespaceDetails#

Fields#

Name Type Description
id ID! ID of the project.
name ID! Full path of the project.

CiTemplate#

GitLab CI/CD configuration template.

Fields#

Name Type Description
content String! Contents of the CI template.
name String! Name of the CI template.

CleanupPolicyLastRunDetailedMetrics#

Represents the metrics of the last run virtual registry cleanup policy.

Fields#

Name Type Description
container CleanupPolicyLastRunUpstreamMetrics Introduced as an experiment in GitLab 18.7.

Last run detail metrics of container.
maven CleanupPolicyLastRunUpstreamMetrics Introduced as an experiment in GitLab 18.7.

Last run detail metrics of maven.

CleanupPolicyLastRunUpstreamMetrics#

Represents the metrics of the last run virtual registry cleanup policy of an upstream.

Fields#

Name Type Description
deletedEntriesCount Int! Introduced as an experiment in GitLab 18.7.

Number of entries deleted.
deletedSize BigInt! Introduced as an experiment in GitLab 18.7.

Size in bytes of data deleted.

CloudConnectorProbeResult#

Fields#

Name Type Description
details JSON Additional details about the probe result.
errors [String!] Full list of errors about the probe result.
message String Additional message or details about the probe result.
name String Name of the probe.
success Boolean Indicates if the probe was successful.

CloudConnectorStatus#

Fields#

Name Type Description
probeResults [CloudConnectorProbeResult!] Results of individual probes run during verification.
success Boolean Indicates if the setup verification was successful.

ClusterAgent#

Fields#

Name Type Description
activityEvents ClusterAgentActivityEventConnection Recent activity for the cluster agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
connections ConnectedAgentConnection Active connections for the cluster agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
isReceptive Boolean Whether the cluster agent is receptive or not.
name String Name of the cluster agent.
project Project Project the cluster agent is associated with.
tokens ClusterAgentTokenConnection Tokens associated with the cluster agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time Timestamp the cluster agent was updated.
urlConfigurations ClusterAgentUrlConfigurationConnection URL configurations for the cluster agent in case it is a receptive agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
userAccessAuthorizations ClusterAgentAuthorizationUserAccess User access config for the cluster agent.
vulnerabilityImages VulnerabilityContainerImageConnection Container images reported on the agent vulnerabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
webPath String Web path of the cluster agent.
workspaces WorkspaceConnection Workspaces associated with the agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GlobalIDs.
workspacesAgentConfig WorkspacesAgentConfig Introduced as an experiment in GitLab 17.4.

Workspaces agent config for the cluster agent.

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.

ClusterAgentActivityEventConnection#

Paginated collection of ClusterAgentActivityEvent. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ClusterAgentAuthorizationCiAccess#

Fields#

Name Type Description
agent ClusterAgent Authorized cluster agent.
config JSON Configuration for the authorized project.

ClusterAgentAuthorizationCiAccessConnection#

Paginated collection of ClusterAgentAuthorizationCiAccess. See Standard connection fields for the fields available on every connection.

ClusterAgentAuthorizationUserAccess#

Fields#

Name Type Description
agent ClusterAgent Authorized cluster agent.
config JSON Configuration for the authorized project.

ClusterAgentAuthorizationUserAccessConnection#

Paginated collection of ClusterAgentAuthorizationUserAccess. See Standard connection fields for the fields available on every connection.

ClusterAgentConnection#

Paginated collection of ClusterAgent. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ClusterAgentToken#

Fields#

Name Type Description
clusterAgent ClusterAgent Cluster agent the 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.

ClusterAgentTokenConnection#

Paginated collection of ClusterAgentToken. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ClusterAgentUrlConfiguration#

Fields#

Name Type Description
caCert String CA certificate of the URL configuration. It is used to verify the agent endpoint.
clientCert String Client certificate if JWT authentication is used.
clusterAgent ClusterAgent Cluster agent of the URL configuration.
id ClustersAgentsUrlConfigurationID! Global ID of the URL configuration.
publicKey String Public key if JWT authentication is used.
tlsHost String TLS host of the URL configuration. It is used to verify the server name in the agent endpoint certificate.
url String URL of the URL configuration.

ClusterAgentUrlConfigurationConnection#

Paginated collection of ClusterAgentUrlConfiguration. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

CodeCoverageActivityConnection#

Paginated collection of CodeCoverageActivity. See Standard connection fields for the fields available on every connection.

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.

CodeQualityDegradationConnection#

Paginated collection of CodeQualityDegradation. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

CodeSuggestionEvent#

Fields#

Name Type Description
event AiUsageEventType! Type of the event.
language String Programming language in the context of the suggestion.
suggestionSize String Size of the code suggestion measured in lines of code.
timestamp Time! When the event happened.
uniqueTrackingId String Unique tracking number of sequence of events for one suggestion.
user UserCore! User associated with the event.

CodeSuggestionEventConnection#

Paginated collection of CodeSuggestionEvent. See Standard connection fields for the fields available on every connection.

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.

CommentTemplatePath#

Fields#

Name Type Description
href String! Path of the comment template.
text String! Text used on the template path.

CommentTemplatePathType#

Fields#

Name Type Description
href String! Management link to the comment template.
text String! Name of the comment template scope.

Commit#

Implements: NoteableInterface, Todoable

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.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
diffStats [DiffStats!] Details about which files were changed in the commit. This field can only be resolved for 10 commits in any single request.
diffStatsSummary DiffStatsSummary Summary of which files were changed in the commit. This field can only be resolved for 10 commits in any single request.
diffs [Diff!] Diffs contained within the commit. This field can only be resolved for 10 diffs in any single request.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
fullTitle String Full title of the commit message.
fullTitleHtml String HTML rendering of full_title.
hasAgentSession Boolean! Indicates the commit was authored during a GitLab Duo Agent Platform flow.
id ID! ID (global ID) of the commit.
latestPipeline Pipeline Latest pipeline that determines the commit CI status. Excludes dangling pipelines, such as security policy scans, that do not affect the commit CI status.

Arguments for latestPipeline:
ref (String)
Ref to scope the pipeline to. When provided, returns the latest pipeline for the commit on that ref; otherwise the latest pipeline for the commit across all refs.
message String Raw commit message.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
parentSha String SHA ID of the first parent.
pipelines PipelineConnection Pipelines of the commit ordered latest first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelines:
ids ([ID!])
Filter pipelines by their Global IDs. Maximum 20 IDs per request.
ref (String)
Filter pipelines by the ref they are run for.
refType (RefType)
Type of ref.
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 the date.
updatedBefore (Time)
Pipelines updated before the date.
username (String)
Filter pipelines by the user that triggered the pipeline.
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.
tags [String!] Tag names pointing to the commit.
title String Title of the commit message.
titleHtml String HTML rendering of title.
webPath String! Web path of the commit.
webUrl String! Web URL of the commit.

CommitConnection#

Paginated collection of Commit. See Standard connection fields for the fields available on every connection.

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.
previousBlamePath String Path to blame prior to the change.
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#

Name Type Description
containingBranches CommitParentNames Get branch names containing a given commit.

Arguments for containingBranches:
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.
containingTags CommitParentNames Get tag names containing a given commit.

Arguments for containingTags:
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.
tippingBranches CommitParentNames Get branch names tipping at a given commit.

Arguments for tippingBranches:
limit (Int!)
Number of ref names to return.
tippingTags CommitParentNames Get tag names tipping at a given commit.

Arguments for tippingTags:
limit (Int!)
Number of ref names to return.

ComparedSecurityReport#

Represents compared security report.

Fields#

Name Type Description
added [ComparedSecurityReportFinding!] Introduced as an experiment in GitLab 16.1.

New vulnerability findings.
baseReportCreatedAt Time Time of the base report creation.
baseReportOutOfDate Boolean Indicates whether the base report out of date.
fixed [ComparedSecurityReportFinding!] Introduced as an experiment in GitLab 16.1.

Fixed vulnerability findings.
headReportCreatedAt Time Time of the base report creation.

ComparedSecurityReportFinding#

Represents finding.

Fields#

Name Type Description
aiResolutionEnabled Boolean Introduced as an experiment in GitLab 18.6.

Indicates whether the specific finding can be resolved with AI.
autoSeverityOverride VulnerabilitySeverity Introduced as an experiment in GitLab 18.11.

The severity that will be automatically applied after merge by a severity override policy. Returns null if no severity override policy matches.
description String Description of the vulnerability finding.
details [VulnerabilityDetail!]! Introduced as an experiment in GitLab 17.6.

Details of the vulnerability finding.
foundByPipelineIid String IID of the pipeline.
identifiers [VulnerabilityIdentifier!] Introduced as an experiment in GitLab 16.3.

Identifiers of the vulnerability finding.
location VulnerabilityLocation Introduced as an experiment in GitLab 16.3.

Location of the vulnerability finding.
matchesAutoDismissPolicy Boolean Introduced as an experiment in GitLab 18.9.

Indicates whether the finding matches an auto-dismiss policy.
scanner ComparedSecurityReportScanner Compared report vulnerability scanner.
severity VulnerabilitySeverity Severity of the vulnerability finding.
state VulnerabilityState Finding status.
title String Title of the vulnerability finding.
unverified Boolean! Indicates whether the finding was detected without an identified source (untrusted input).
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
approvalPolicies ScanResultPolicyConnection Approval Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
color String! Hexadecimal representation of compliance framework's label color.
complianceRequirements ComplianceRequirementConnection Compliance requirements of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
default Boolean Default compliance framework for the group.
description String! Description of the compliance framework.
editPath String! Web UI path to edit the compliance framework.
id ID! Compliance framework ID.
name String! Name of the compliance framework.
namespaceId TypesNamespaceID! Namespace ID.
pipelineConfigurationFullPath String Deprecated in GitLab 17.4. Use pipeline execution policies instead.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipelineExecutionSchedulePolicies PipelineExecutionSchedulePolicyConnection Pipeline Execution Schedule Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projects ProjectConnection Projects associated with the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
scanResultPolicies ScanResultPolicyConnection Deprecated in GitLab 19.0. Use approvalPolicies. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
securityPolicies ComplianceFrameworkPolicySummaryConnection All security policies scoped to the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time Timestamp of when the compliance framework was last updated.
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Vulnerability Management Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

ComplianceFrameworkConnection#

Paginated collection of ComplianceFramework. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ComplianceFrameworkCoverageDetail#

Framework coverage details for a specific compliance framework.

Fields#

Name Type Description
coveredCount Int! Number of projects covered by the framework.
framework ComplianceFramework! Compliance framework associated with the coverage detail.
id ID! ID of the framework.

ComplianceFrameworkCoverageDetailConnection#

Paginated collection of ComplianceFrameworkCoverageDetail. See Standard connection fields for the fields available on every connection.

ComplianceFrameworkCoverageSummary#

Compliance framework Coverage summary for a group.

Fields#

Name Type Description
coveredCount Int! Number of projects covered by at least one framework.
totalProjects Int! Total number of projects in the group.

ComplianceFrameworkPolicySummary#

A security policy scoped to a compliance framework.

Fields#

Name Type Description
hasActiveProjects Boolean! Whether the policy has at least one non-archived assigned project.
name String! Name of the security policy.
source SecurityPolicySource Source of the security policy.
type String Type of the security policy.

ComplianceFrameworkPolicySummaryConnection#

Paginated collection of ComplianceFrameworkPolicySummary. See Standard connection fields for the fields available on every connection.

ComplianceFrameworkTemplate#

Represents a compliance framework template that can be used to create a compliance framework.

Fields#

Name Type Description
color String! Hexadecimal representation of the template's label color.
description String! Description of the compliance framework template.
id ID! Unique identifier of the template.
json String! Full JSON representation of the compliance framework template.
name String! Name of the compliance framework template.
templateVersion Int! Version of the template.

ComplianceFrameworksNeedingAttention#

Compliance framework requiring attention.

Fields#

Name Type Description
framework ComplianceFramework! Compliance framework needing attention.
id ID! ID of the framework needing attention.
projectsCount Int! Number of projects with the framework applied.
requirementsCount Int! Number of requirements in the framework.
requirementsWithoutControls [ComplianceRequirement!] Requirements without controls.

ComplianceFrameworksNeedingAttentionConnection#

Paginated collection of ComplianceFrameworksNeedingAttention. See Standard connection fields for the fields available on every connection.

ComplianceRequirement#

Represents a ComplianceRequirement associated with a ComplianceFramework.

Fields#

Name Type Description
complianceRequirementsControls ComplianceRequirementsControlConnection Compliance controls of the compliance requirement. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String! Description of the compliance requirement.
framework ComplianceFramework Compliance framework associated with the requirement.
id ID! Compliance requirement ID.
name String! Name of the compliance requirement.

ComplianceRequirementConnection#

Paginated collection of ComplianceRequirement. See Standard connection fields for the fields available on every connection.

ComplianceRequirementControl#

Lists down all the possible types of requirement controls.

Fields#

Name Type Description
controlExpressions [ControlExpression!]! List of requirement controls.

ComplianceRequirementsControl#

Represents a ComplianceRequirementsControl associated with a ComplianceRequirement.

Fields#

Name Type Description
complianceRequirement ComplianceRequirement Compliance requirement associated with the control.
controlType String! Type of the compliance control.
expression String Expression of the compliance control.
externalControlName String Name of the external control.
externalUrl String URL of the external control.
id ID! Compliance requirements control ID.
name String! Name of the compliance control.
pingEnabled Boolean! Whether ping is enabled for external controls.

ComplianceRequirementsControlConnection#

Paginated collection of ComplianceRequirementsControl. See Standard connection fields for the fields available on every connection.

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.

ComplianceStandardsAdherenceConnection#

Paginated collection of ComplianceStandardsAdherence. See Standard connection fields for the fields available on every connection.

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.

ComplianceViolationConnection#

Paginated collection of ComplianceViolation. See Standard connection fields for the fields available on every connection.

Component#

A software dependency used by a project.

Fields#

Name Type Description
id SbomComponentID! ID of the dependency.
name String! Name of the dependency.

ComponentVersion#

A software dependency version used by a project.

Fields#

Name Type Description
id SbomComponentVersionID! ID of the dependency version.
version String! Version of the dependency.

ComponentVersionConnection#

Paginated collection of ComponentVersion. See Standard connection fields for the fields available on every connection.

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.

Implements: PackageFileMetadata

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.
warnings [AgentWarning!] Agent warnings list.

ConnectedAgentConnection#

Paginated collection of ConnectedAgent. See Standard connection fields for the fields available on every connection.

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 the container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnum Number of tags to retain.
nameRegex UntrustedRegexp Tags with names matching the regex pattern will expire.
nameRegexKeep UntrustedRegexp Tags with names matching the regex pattern will be preserved.
nextRunAt Time Next time that the container expiration policy will get executed.
olderThan ContainerExpirationPolicyOlderThanEnum Tags older than the given age will expire.
updatedAt Time! Timestamp of when the container expiration policy was updated.

ContainerProtectionAccessLevel#

Represents the most restrictive permissions for a container image tag.

Implements: AccessLevelInterface

Fields#

Name Type Description
immutable Boolean! Returns true when tag rule is for tag immutability. Otherwise, false.
minimumAccessLevelForDelete ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags.
minimumAccessLevelForPush ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags.

ContainerProtectionRepositoryRule#

A container repository protection rule designed to prevent users with a certain access level or lower from altering the container registry.

Fields#

Name Type Description
id ContainerRegistryProtectionRuleID! ID of the container repository protection rule.
minimumAccessLevelForDelete ContainerProtectionRepositoryRuleAccessLevel Introduced as an experiment in GitLab 17.11.

Minimum GitLab access level required to delete container images from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER. Valid only when feature flag container_registry_protected_containers_delete is enabled.
minimumAccessLevelForPush ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
repositoryPathPattern String! Container repository path pattern protected by the protection rule. Must start with the project's full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project's full path.

ContainerProtectionRepositoryRuleConnection#

Paginated collection of ContainerProtectionRepositoryRule. See Standard connection fields for the fields available on every connection.

ContainerProtectionTagRule#

A container repository tag protection rule designed to prevent users with a certain access level or lower from altering the container registry.

Implements: AccessLevelInterface

Fields#

Name Type Description
id ContainerRegistryProtectionTagRuleID! ID of the container repository tag protection rule.
immutable Boolean! Returns true when tag rule is for tag immutability. Otherwise, false.
minimumAccessLevelForDelete ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags.
minimumAccessLevelForPush ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags.
tagNamePattern String! The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.
userPermissions ContainerRegistryProtectionTagRulePermissions! Permissions for the current user on the resource.

ContainerProtectionTagRuleConnection#

Paginated collection of ContainerProtectionTagRule. See Standard connection fields for the fields available on every connection.

ContainerRegistry#

Represents a container virtual registry.

Implements: RegistryInterface

Fields#

Name Type Description
description String Description of the virtual registry.
id ID! ID of the virtual registry.
name String! Name of the virtual registry.
updatedAt Time! Timestamp of when the virtual registry was updated.

ContainerRegistryConnection#

Paginated collection of ContainerRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ContainerRegistryDetails#

Represents container virtual registry details.

Implements: RegistryInterface

Fields#

Name Type Description
description String Description of the virtual registry.
id ID! ID of the virtual registry.
name String! Name of the virtual registry.
registryUpstreams [ContainerRegistryUpstreamWithUpstream!]! Introduced as an experiment in GitLab 18.7.

List of registry upstreams for the container virtual registry.
updatedAt Time! Timestamp of when the virtual registry was updated.

ContainerRegistryProtectionTagRulePermissions#

Fields#

Name Type Description
destroyContainerRegistryProtectionTagRule Boolean! If true, the user can perform destroy_container_registry_protection_tag_rule on this resource.

ContainerRegistryUpstreamWithRegistry#

Represents a container registry upstream and its registry.

Implements: RegistryUpstreamInterface

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
position Int! Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.
registry ContainerRegistry! Introduced as an experiment in GitLab 18.8.

Container registry associated with the upstream registry.

ContainerRegistryUpstreamWithUpstream#

Represents a container virtual registry upstream and its relationship to the upstream.

Implements: RegistryUpstreamInterface

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
position Int! Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.
upstream ContainerUpstream! Introduced as an experiment in GitLab 18.7.

Container upstream associated with the registry upstream.

ContainerRepository#

A container repository.

Fields#

Name Type Description
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! Deprecated in GitLab 17.0. Returns an empty string. This was used for the migration of GitLab.com, which is now complete. Not used by Self-managed instances.
name String! Name of the container repository.
path String! Path of the container repository.
project Project! Project of the container registry.
protectionRuleExists Boolean! Whether any matching container protection rule exists for the container repository.
status ContainerRepositoryStatus Status of the container repository.
tagsCount Int! Number of tags associated with the image.
updatedAt Time! Timestamp when the container repository was updated.
userPermissions ContainerRepositoryPermissions! Permissions for the current user on the resource.

ContainerRepositoryConnection#

Paginated collection of ContainerRepository. See Standard connection fields for the fields available on every connection.

ContainerRepositoryDetails#

Details of a container repository.

Fields#

Name Type Description
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.
lastPublishedAt Time Timestamp when a repository tag was last created or updated. Only present for repositories that had tags created or updated after GitLab 16.11.
location String! URL of the container repository.
manifest String An image manifest from the container repository.

Arguments for manifest:
reference (String!)
Tag name or digest of the manifest.
migrationState String! Deprecated in GitLab 17.0. Returns an empty string. This was used for the migration of GitLab.com, which is now complete. Not used by Self-managed instances.
name String! Name of the container repository.
path String! Path of the container repository.
project Project! Project of the container registry.
protectionRuleExists Boolean! Whether any matching container protection rule exists for the container repository.
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.
tagDetails ContainerRepositoryTagDetails Details for a specific tag in the container repository.

Arguments for tagDetails:
name (String!)
Name of the tag.
tags ContainerRepositoryTagConnection Tags of the container repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for tags:
name (String)
Search by tag name.
referrerType (String)
Comma-separated list of artifact types used to filter referrers. Applies only when referrers is set to true.
referrers (Boolean)
Include tag referrers.
sort (ContainerRepositoryTagSort)
Sort tags by these criteria.
tagsCount Int! Number of tags associated with the image.
updatedAt Time! Timestamp when the container repository was updated.
userPermissions ContainerRepositoryPermissions! Permissions for the current user on the resource.

ContainerRepositoryImageManifest#

A manifest describing a reference to an image.

Fields#

Name Type Description
digest String Digest of the manifest.
mediaType String Media type of the manifest.
platform ContainerRepositoryImagePlatform Platform specifier for the image reference.
size BigInt Size of the manifest in bytes.

ContainerRepositoryImagePlatform#

Description of the target platform for an image.

Fields#

Name Type Description
architecture String CPU architecture of the platform.
os String Operating system of the platform.
osVersion String Operating system version, typically used for Windows images.
variant String CPU variant of the platform.

ContainerRepositoryPermissions#

Fields#

Name Type Description
destroyContainerRepository Boolean! If true, the user can perform destroy_container_image on this resource.

ContainerRepositoryReferrer#

A referrer for a container repository tag.

Fields#

Name Type Description
artifactType String Artifact type of the referrer.
digest String Digest of the referrer.
userPermissions ContainerRepositoryTagPermissions! Permissions for the current user on the resource.

ContainerRepositoryRegistry#

Represents the Geo replication and verification state of an Container Repository.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ContainerRepositoryRegistry do not match on the primary and secondary.
containerRepositoryId ID! ID of the ContainerRepository.
createdAt Time Timestamp when the ContainerRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ContainerRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the ContainerRepositoryRegistry is missing on primary.
modelRecordId Int ID of the ContainerRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the ContainerRepositoryRegistry in case of mismatch.
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 of ContainerRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the ContainerRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ContainerRepositoryRegistry.

ContainerRepositoryRegistryConnection#

Paginated collection of ContainerRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ContainerRepositoryTag#

A tag from a container repository.

Fields#

Name Type Description
createdAt Time Timestamp when the tag was created.
digest String Digest of the tag.
location String! URL of the tag.
mediaType String Media type of the tag.
name String! Name of the tag.
path String! Path of the tag.
protection ContainerProtectionAccessLevel Minimum GitLab access level required to push and delete container image tags. If the value is nil, no minimum access level is enforced. Users with the Developer role or higher can push tags by default.
publishedAt Time Timestamp when the tag was published.
referrers [ContainerRepositoryReferrer!] Referrers for 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.

ContainerRepositoryTagConnection#

Paginated collection of ContainerRepositoryTag. See Standard connection fields for the fields available on every connection.

ContainerRepositoryTagDetails#

Details of a tag within a container repository.

Fields#

Name Type Description
createdAt Time Timestamp when the tag was created.
digest String Digest of the tag.
location String! URL of the tag.
manifests [ContainerRepositoryImageManifest!] Manifests of the index tag. Null for non-index tags.
mediaType String Media type of the tag.
name String! Name of the tag.
path String! Path of the tag.
platform ContainerRepositoryImagePlatform Platform of the image tag. Null for index tags.
publishedAt Time Timestamp when the tag was published.
totalSize BigInt Size of the tag.

ContainerRepositoryTagPermissions#

Fields#

Name Type Description
destroyContainerRepositoryTag Boolean! If true, the user can perform destroy_container_image_tag on this resource.

ContainerTagsExpirationPolicy#

A tag expiration policy using regex patterns to control which images to keep or expire.

Fields#

Name Type Description
cadence ContainerExpirationPolicyCadenceEnum Schedule of the container expiration policy.
createdAt Time Timestamp of when the container expiration policy was created.
enabled Boolean! Indicates whether the container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnum Number of tags to retain.
nameRegex UntrustedRegexp Tags with names matching the regex pattern will expire.
nameRegexKeep UntrustedRegexp Tags with names matching the regex pattern will be preserved.
nextRunAt Time Next time that the container expiration policy will get executed.
olderThan ContainerExpirationPolicyOlderThanEnum Tags older than the given age will expire.
updatedAt Time Timestamp of when the container expiration policy was updated.

ContainerUpstream#

Represents a container upstream registry.

Implements: UpstreamInterface

Fields#

Name Type Description
cacheValidityHours Int! Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
description String Introduced as an experiment in GitLab 18.1.

Description of the upstream registry.
id ID! Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
name String! Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCount Int! Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
url String! Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.
username String Introduced as an experiment in GitLab 18.7.

Username to sign in to the upstream registry.

ContainerUpstreamCacheEntry#

Represents a cache entry for an upstream container registry.

Implements: EntryInterface

Fields#

Name Type Description
contentType String! Introduced as an experiment in GitLab 18.9.

Content type of the cached file.
createdAt Time! Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was created.
downloadedAt Time Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last downloaded.
downloadsCount Int! Introduced as an experiment in GitLab 18.9.

Number of times the entry has been downloaded.
fileMd5 String Introduced as an experiment in GitLab 18.9.

MD5 hash of the cached file.
fileSha1 String! Introduced as an experiment in GitLab 18.9.

SHA1 hash of the cached file.
id String! Introduced as an experiment in GitLab 18.9.

ID of the cache entry.
relativePath String! Introduced as an experiment in GitLab 18.9.

Relative path of the cached entry.
size BigInt! Introduced as an experiment in GitLab 18.9.

Size of the cached file in bytes.
updatedAt Time! Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last updated.
upstreamCheckedAt Time Introduced as an experiment in GitLab 18.9.

Timestamp when the upstream was last checked.
upstreamEtag String Introduced as an experiment in GitLab 18.9.

ETag from the upstream source.

ContainerUpstreamCacheEntryConnection#

Paginated collection of ContainerUpstreamCacheEntry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ContainerUpstreamConnection#

Paginated collection of ContainerUpstream. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ContainerUpstreamDetails#

Represents container upstream details.

Implements: UpstreamInterface

Fields#

Name Type Description
cacheEntries ContainerUpstreamCacheEntryConnection Introduced as an experiment in GitLab 18.9.

Represents cache entries for the upstream container registry. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cacheEntries:
search (String)
Search cache entries by relative path.
cacheValidityHours Int! Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
description String Introduced as an experiment in GitLab 18.1.

Description of the upstream registry.
id ID! Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
name String! Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCount Int! Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
registryUpstreams [ContainerRegistryUpstreamWithRegistry!]! Introduced as an experiment in GitLab 18.8.

Represents the connected upstream registry for an upstream and the upstream position data.
url String! Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.
username String Introduced as an experiment in GitLab 18.7.

Username to sign in to the upstream registry.

ContextPreset#

Presets for GitLab Duo Chat window based on current context.

Fields#

Name Type Description
aiResourceData String Serialized representation of the AI resource in the current context.
questionCategories [AiChatQuestionCategory!] Introduced as an experiment in GitLab 19.4.

Suggested questions grouped by category. Not affected by questionCount.
questions [String!] Array of questions that the user can ask GitLab Duo Chat from the current page.

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.

ContributionAnalyticsContributionConnection#

Paginated collection of ContributionAnalyticsContribution. See Standard connection fields for the fields available on every connection.

ContributionsAggregationResponse#

Response for Contributions aggregation engine.

Fields#

Name Type Description
dimensions ContributionsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
totalCount Int Total number of contributions.
usersCount Int Number of unique contributors.

ContributionsAggregationResponseConnection#

Paginated collection of ContributionsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

ContributionsAggregationResponseDimensions#

Response dimensions for Contributions aggregation engine.

Fields#

Name Type Description
author UserCore Contribution author.
createdAt Date Contribution date.

Arguments for createdAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.

ContributionsAggregationScope#

Aggregation scope for Contributions. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated ContributionsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

ControlExpression#

Represents a control expression.

Fields#

Name Type Description
expression ExpressionValue! Expression details for the control.
id ID! ID for the control.
name String! Name of the control.

CountableVulnerability#

Represents a vulnerability. The connection type is countable.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
aiResolutionAvailable Boolean Indicates whether the type of vulnerability can be resolved with AI.
aiResolutionEnabled Boolean Indicates whether the specific vulnerability can be resolved with AI.
aiWorkflows VulnerabilityTriggeredWorkflowConnection Introduced as an experiment in GitLab 18.6.

AI workflows triggered for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
archivalInformation VulnerabilityArchivalInformation! Introduced as an experiment in GitLab 17.11.

Indicates whether the vulnerability is about to be archived in the next month.
ascpComponent AscpComponent Introduced as an experiment in GitLab 19.4.

The ASCP component the vulnerability belongs to. Returns null when there is no matchor when the ascp_component_vulnerability_association feature flag is disabled.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
confirmedAt Time Timestamp of when the vulnerability state was changed to confirmed.
confirmedBy UserCore User that confirmed the vulnerability.
cveEnrichment CveEnrichmentType Enrichment (EPSS score and KEV) for CVE vulnerabilities.
cvss [CvssType!]! CVSS information for the vulnerability.
dependencies DependencyConnection! Introduced as an experiment in GitLab 18.2.

Dependencies for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencies:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
dueDate ISO8601Date Vulnerability finding due date.
duoSastVrWorkflowEnabled Boolean Introduced as an experiment in GitLab 19.1.

Indicates whether the SAST vulnerability review workflow is enabled for the project.
externalIssueLinks VulnerabilityExternalIssueLinkConnection! List of external issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
falsePositive Boolean Indicates whether the vulnerability is a false positive.
findingTokenStatus VulnerabilityFindingTokenStatus Status of the secret token associated with this vulnerability.
flags VulnerabilityFlagConnection Introduced as an experiment in GitLab 18.5.

Flags set on the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
hasRemediations Boolean Indicates whether there is a remediation available for the vulnerability.
id ID! GraphQL ID of the vulnerability.
identifiers [VulnerabilityIdentifier!]! Identifiers of the vulnerability.
initialDetectedPipeline Pipeline Introduced as an experiment in GitLab 18.2.

Pipeline where the vulnerability was first detected.
issueLinks VulnerabilityIssueLinkConnection! List of issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issueLinks:
linkType (VulnerabilityIssueLinkType)
Filter issue links by link type.
latestDetectedPipeline Pipeline Introduced as an experiment in GitLab 18.2.

Pipeline where the vulnerability was last detected.
latestFlag VulnerabilityFlag Introduced as an experiment in GitLab 18.5.

Latest flag for the vulnerability.
latestNonClosedMergeRequest MergeRequest Introduced as an experiment in GitLab 19.1.

Latest non-closed merge request linked to fix the vulnerability.
latestSecurityReportFinding PipelineSecurityReportFinding Introduced as an experiment in GitLab 18.4.

Latest security report finding for the vulnerability. On large projects, the field can time out and return null. Clients should check the top-level errors array for timeout errors, even when the HTTP response status is 200.
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.
malware Boolean Indicates whether the vulnerability is associated with a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
mergeRequest MergeRequest Merge request that fixes the vulnerability.
mergeRequests MergeRequestConnection Merge requests that are linked to fix the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
policyAutoDismissed Boolean Introduced as an experiment in GitLab 18.7.

Indicates whether the vulnerability was auto-dismissed by a security policy.
policyViolations PolicyViolations Introduced as an experiment in GitLab 18.6.

Policy violation for the vulnerability.
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.
reachability ReachabilityType Introduced as an experiment in GitLab 17.11.

Reachability status of the vulnerability.
removedFromCode Boolean! Indicates whether the vulnerability is present in the code or not.
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, CONTAINER_SCANNING_FOR_REGISTRY, SARIF, GENERIC). Scan Type in the UI.
representationInformation VulnerabilityRepresentationInformation Introduced as an experiment in GitLab 17.7.

Information about the representation of the vulnerability, such as resolved commit SHA.
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).
severityOverrides SeverityOverrideConnection List of severity changes for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String Title of the vulnerability.
trackedRef SecurityTrackedRef Introduced as an experiment in GitLab 18.10.

Tracked ref (branch or tag) where the vulnerability was detected.
unverified Boolean! Indicates whether the finding was detected without an identified source (untrusted input).
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.
validityDisplayState VulnerabilityValidityDisplayState Introduced as an experiment in GitLab 19.5.

Validity state derived from the token status and current vendor support.
vulnerabilityPath String Path to the vulnerability's details page.
webUrl String URL to the vulnerability's details page.

CountableVulnerabilityConnection#

Paginated collection of CountableVulnerability. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CoverageFuzzingCorpus#

Corpus for a coverage fuzzing job.

Fields#

Name Type Description
id AppSecFuzzingCoverageCorpusID! ID of the corpus.
package PackageDetailsType! Package of the corpus.

CoverageFuzzingCorpusConnection#

Paginated collection of CoverageFuzzingCorpus. See Standard connection fields for the fields available on every connection.

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 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.
hasGitlabCreditsAddOn Boolean! Whether the license has an active GitLab Credits add-on.
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.
subscriptionName String Name of the subscription in the Customers Portal.
trial Boolean Indicates if the license is a trial.
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.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
admin Boolean! Indicates if the user is an instance administrator.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
assigneeOrReviewerMergeRequests MergeRequestConnection Merge requests the current user is an assignee or a reviewer of. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assigneeOrReviewerMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assignedReviewStates ([MergeRequestReviewState!])
Reviewer states for merge requests the current user is assigned to.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerReviewStates ([MergeRequestReviewState!])
Reviewer states for the merge requests the current user is a reviewer of.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
codeSuggestionsContexts [String!]! Introduced as an experiment in GitLab 17.9.

List of additional contexts enabled for Code Suggestions.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
creditsUsage GitlabSubscriptionUserCreditsUsage Introduced as an experiment in GitLab 19.4.

GitLab Credits usage for the current user.

Arguments for creditsUsage:
endDate (ISO8601Date)
End date of the usage period to query. Defaults to the end of the current month.
flowTypes ([String!])
Filter usage data by flow type identifiers (for example, ["chat", "code_review"]).
namespacePath (ID!)
Path of the top-level namespace to report usage for.
startDate (ISO8601Date)
Start date of the usage period to query. Defaults to the beginning of the current month.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoChatAvailable Boolean! Introduced as an experiment in GitLab 16.8.

User access to AI chat feature.
duoChatAvailableFeatures [String!]! Introduced as an experiment in GitLab 17.6.

List of available features for AI chat.
duoClassicChatAvailable Boolean! User access to GitLab Duo Chat (non-agentic) feature.
duoCodeSuggestionsAvailable Boolean! Introduced as an experiment in GitLab 16.8.

User access to code suggestions feature.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
importSourceUsers ImportSourceUserConnection Introduced as an experiment in GitLab 19.5.

Completed mappings of source users whose contributions were reassigned to the current user. Returns an empty result if the revoke_import_source_user_reassignment feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
mergeRequestSavedViews MergeRequestSavedViewConnection Introduced as an experiment in GitLab 19.4.

Saved views on the merge request dashboard for the current user. Returns an empty result if the mr_dashboard_saved_views feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
recentlyViewedIssues [Issue!] Introduced as an experiment in GitLab 17.9.

Most-recently viewed issues for the current user.
recentlyViewedItems [RecentlyViewedItem!] Most-recently viewed items for the current user.
recentlyViewedMergeRequests [MergeRequest!] Introduced as an experiment in GitLab 17.10.

Most-recently viewed merge requests for the current user.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
runners CiRunnerConnection Introduced as an experiment in GitLab 18.3.

List all runners the current user manages. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for runners:
active (Boolean)
Deprecated in GitLab 14.8. Renamed. Use paused instead.
assignableToProjectPath (ID)
Path of a project. When set, returns runners that can be assigned to a project, are not locked, and not already assigned to the project.
creatorId (UserID)
Filter runners by creator ID.
creatorUsername (String)
Filter runners by creator username.
ownerFullPath (String)
Introduced as an experiment in GitLab 17.8.

Filter runners by owning project or group.
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)
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'.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workItemPreferences WorkItemTypesUserPreference Introduced as an experiment in GitLab 17.10.

User preferences for the given work item type and namespace.

Arguments for workItemPreferences:
namespacePath (ID!)
Full path of the namespace the work item is created in.
workItemTypeId (WorkItemsTypeID)
Global ID of a work item type.
workItems WorkItemConnection Introduced as an experiment in GitLab 17.10.

Find work items visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItems:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
search (String)
Search query for title or description.
sort (WorkItemSort)
Sort work items by criteria.
state (IssuableState)
Current state of the work item.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

CustomAttribute#

A custom attribute key-value pair. Only available to admins.

Fields#

Name Type Description
key String! Key of the custom attribute.
value String! Value of the custom attribute.

CustomDashboard#

Customizable analytics dashboard.

Implements: CustomDashboardInterface

Fields#

Name Type Description
config JSON! Dashboard layout and widget configuration.
createdAt Time Timestamp when the dashboard was created.
createdBy UserCore User who created the dashboard.
description String Optional summary or purpose of the dashboard.
id ID! Global ID of the custom dashboard.
lockVersion Int! Version used for optimistic concurrency control.
name String! Display name of the dashboard.
namespace Namespace Namespace scope of the dashboard, if any.
organization Organization! Organization that owns the dashboard.
project Project Project scope of the dashboard, if any.
slug String Dashboard url slug.
system Boolean! Whether the dashboard is a built-in GitLab dashboard.
updatedAt Time! Timestamp when the dashboard was last updated.
updatedBy UserCore User who last updated the dashboard.

CustomDashboardInterfaceConnection#

Paginated collection of CustomDashboardInterface. See Standard connection fields for the fields available on every connection.

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.

CustomEmojiConnection#

Paginated collection of CustomEmoji. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

CustomField#

Represents a custom field.

Fields#

Name Type Description
active Boolean! Whether the custom field is active.
createdAt Time! Timestamp when the custom field was created.
createdBy UserCore User that created the custom field.
fieldType CustomFieldType! Type of custom field.
id IssuablesCustomFieldID! Global ID of the custom field.
name String! Name of the custom field.
selectOptions [CustomFieldSelectOption!] Available options for a select field.
updatedAt Time! Timestamp when the custom field was last updated.
updatedBy UserCore User that last updated the custom field.
workItemTypes [WorkItemType!] Work item types that the custom field is available on.

CustomFieldConnection#

Paginated collection of CustomField. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CustomFieldSelectOption#

Represents a custom field select option.

Fields#

Name Type Description
id IssuablesCustomFieldSelectOptionID! Global ID of the custom field select option.
value String! Value of the custom field select option.

CustomSystemDashboard#

GitLab built-in analytics dashboard (read-only).

Implements: CustomDashboardInterface

Fields#

Name Type Description
config JSON! Dashboard layout and widget configuration.
createdAt Time Timestamp when the dashboard was created.
description String Optional summary or purpose of the dashboard.
id ID! Global ID of the dashboard.
name String! Display name of the dashboard.
slug String Dashboard url slug.
system Boolean! Whether the dashboard is a built-in GitLab dashboard.

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.

CustomerRelationsContactConnection#

Paginated collection of CustomerRelationsContact. See Standard connection fields for the fields available on every connection.

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.

CustomerRelationsOrganizationConnection#

Paginated collection of CustomerRelationsOrganization. See Standard connection fields for the fields available on every connection.

CustomizableAdminPermission#

Fields#

Name Type Description
description String Description of the permission.
name String! Localized name of the permission.
requirements [MemberRoleAdminPermission!] Requirements of the permission.
value MemberRoleAdminPermission! Value of the permission.

CustomizableAdminPermissionConnection#

Paginated collection of CustomizableAdminPermission. See Standard connection fields for the fields available on every connection.

CustomizableDashboard#

Represents a customizable dashboard.

Fields#

Name Type Description
category CustomizableDashboardCategory! Category of dashboard.
configurationProject Project Project which contains the dashboard definition.
description String Description of the dashboard.
errors [String!] Errors on yaml definition.
filters JSON Dashboard global filters.
gridHeight CustomizableDashboardGridHeight Introduced as an experiment in GitLab 18.9.

Grid cell height of the dashboard.
panels CustomizableDashboardPanelConnection Panels shown on the dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
slug String! Slug of the dashboard.
status String Introduced as an experiment in GitLab 17.0.

Status of the dashboard.
title String Title of the dashboard.
userDefined Boolean! Indicates whether the dashboard is user-defined or provided by GitLab.

CustomizableDashboardConnection#

Paginated collection of CustomizableDashboard. See Standard connection fields for the fields available on every connection.

CustomizableDashboardPanel#

Represents a customizable 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.
titleIcon String Icon displayed next to the title of the panel.
tooltip CustomizableDashboardPanelTooltip Tooltip for the panel containing descriptive text and an optional link.
views [CustomizableDashboardPanelView!]! Visualizations the user can switch between within the panel.
visualization CustomizableDashboardVisualization Visualization of the panel.

CustomizableDashboardPanelConnection#

Paginated collection of CustomizableDashboardPanel. See Standard connection fields for the fields available on every connection.

CustomizableDashboardPanelTooltip#

Tooltip for a customizable dashboard panel.

Fields#

Name Type Description
description String! Popover text content. When descriptionLink is provided, must include %{linkStart} and %{linkEnd} placeholders around the link text.
descriptionLink String Optional URL for link insertion in the description between %{linkStart} and %{linkEnd} placeholders.

CustomizableDashboardPanelView#

Represents a view that can be selected within a customizable dashboard panel.

Fields#

Name Type Description
text String Label shown in the segmented control for the view.
visualization CustomizableDashboardVisualization Visualization rendered when the view is selected.

CustomizableDashboardVisualization#

Represents a customizable 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.

CustomizableDashboardVisualizationConnection#

Paginated collection of CustomizableDashboardVisualization. See Standard connection fields for the fields available on every connection.

CustomizableStandardPermission#

Fields#

Name Type Description
availableFor [String!]! Objects the permission is available for.
description String Description of the permission.
enabledForGroupAccessLevels [AccessLevelEnum!] Group access levels from which the permission is allowed.
enabledForProjectAccessLevels [AccessLevelEnum!] Project access levels from which the permission is allowed.
name String! Localized name of the permission.
requirements [MemberRoleStandardPermission!] Requirements of the permission.
value MemberRoleStandardPermission! Value of the permission.

CustomizableStandardPermissionConnection#

Paginated collection of CustomizableStandardPermission. See Standard connection fields for the fields available on every connection.

CveEnrichmentType#

Represents a CVE's Enrichment (EPSS score).

Fields#

Name Type Description
cve String! CVE identifier of relevant vulnerability.
epssScore Float! EPSS score for the CVE.
isKnownExploit Boolean! Whether the CVE appears in the CISA KEV catalog.

CvssType#

Represents a vulnerability's CVSS score.

Fields#

Name Type Description
baseScore Float! Base score of the CVSS.
overallScore Float! Overall score of the CVSS.
severity CvssSeverity! Severity calculated from the overall score.
vector String! CVSS vector string.
vendor String! Vendor who assigned the CVSS score.
version Float! Version of the CVSS.

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 GitLab 15.10. Renamed. Use DastPreScanVerificationStep.checkType instead.
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.

DastProfileConnection#

Paginated collection of DastProfile. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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

DastScannerProfileConnection#

Paginated collection of DastScannerProfile. See Standard connection fields for the fields available on every connection.

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.
optionalVariables [JSON!] Optional variables that can be configured for DAST scans.
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.

DastSiteProfileConnection#

Paginated collection of DastSiteProfile. See Standard connection fields for the fields available on every connection.

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.

DastSiteValidationConnection#

Paginated collection of DastSiteValidation. See Standard connection fields for the fields available on every connection.

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.

Implements: DependencyInterface

Fields#

Name Type Description
componentVersion ComponentVersion Version of the dependency.
dependencyPaths DependencyPathPage Introduced as an experiment in GitLab 18.2.

Ancestor dependency paths for a dependency. Returns null if dependency_graph_graphql feature flag is disabled.

Arguments for dependencyPaths:
after (String)
Fetch paths after the cursor.
before (String)
Fetch paths before the cursor.
limit (Int)
Number of paths to fetch.
hasDependencyPaths Boolean! Introduced as an experiment in GitLab 18.4.

Indicates whether the dependency has any dependency paths.
id GlobalID! ID of the dependency.
licenses [License!] Licenses associated to the dependency.
location Location Information about where the dependency is located.
malware Boolean Introduced as an experiment in GitLab 19.1.

Indicates whether the dependency is a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
name String! Name of the dependency.
packager PackageManager Description of the tool used to manage the dependency.
reachability ReachabilityType Information about reachability of a dependency.
trackedRefsCount Int! Introduced as an experiment in GitLab 19.2.

Number of tracked refs (branches or tags) associated with the dependency.
version String Deprecated in GitLab 18.1. Replaced by component_version.
vulnerabilities VulnerabilityConnection Vulnerabilities associated with the dependency. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilityCount Int! Number of vulnerabilities within the dependency.

DependencyAggregation#

A software dependency aggregation used by a group.

Implements: DependencyInterface

Fields#

Name Type Description
componentVersion ComponentVersion Version of the dependency.
dependencyPaths DependencyPathPage Introduced as an experiment in GitLab 18.2.

Ancestor dependency paths for a dependency. Returns null if dependency_graph_graphql feature flag is disabled.

Arguments for dependencyPaths:
after (String)
Fetch paths after the cursor.
before (String)
Fetch paths before the cursor.
limit (Int)
Number of paths to fetch.
id GlobalID! ID of the dependency.
licenses [License!] Licenses associated to the dependency.
location Location Information about where the dependency is located.
malware Boolean Introduced as an experiment in GitLab 19.1.

Indicates whether the dependency is a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
name String! Name of the dependency.
occurrenceCount Int! Number of occurrences of the dependency across projects.
packager PackageManager Description of the tool used to manage the dependency.
projectCount Int Introduced as an experiment in GitLab 19.2.

Number of projects that use the dependency.
reachability ReachabilityType Information about reachability of a dependency.
version String Deprecated in GitLab 18.1. Replaced by component_version.
vulnerabilities VulnerabilityConnection Vulnerabilities associated with the dependency. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilityCount Int! Number of vulnerabilities within the dependency.

DependencyAggregationConnection#

Paginated collection of DependencyAggregation. See Standard connection fields for the fields available on every connection.

DependencyConnection#

Paginated collection of Dependency. See Standard connection fields for the fields available on every connection.

DependencyFirewallActivitySummary#

Aggregate dependency firewall enforcement activity totals for a group or project.

Fields#

Name Type Description
activeRules Int! Number of active (enabled) dependency firewall rules.
allowed Int! Total allowed (pass-through) enforcement events in the window.
blocked Int! Total blocked enforcement events in the window.
blockingRules Int! Number of active rules in enforce (blocking) mode.
licenseRisksPrevented Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions blocked by license rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
licenseRisksWarnedOnly Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions warned but never blocked by license rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
maliciousPackagesPrevented Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions blocked by malicious-package rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
maliciousPackagesWarnedOnly Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions warned but never blocked by malicious-package rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
totalTriggers Int! Total enforcement events (blocked + warned + allowed) in the window.
vulnerabilitiesPrevented Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions blocked by vulnerability or risk-severity rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
vulnerabilitiesPreventedBySeverity [DependencyFirewallSeverityCount!] Introduced as an experiment in GitLab 19.5.

Breakdown of prevented packages by their highest carried severity. Sums to the prevented total. Counts from from up to now; to does not apply. Null when not available, including for groups.
warned Int! Total warned enforcement events in the window.
warningRules Int! Number of active rules in warn mode.

DependencyFirewallPolicyAttributesType#

Represents policy fields related to the dependency firewall policy.

Fields#

Name Type Description
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.

DependencyFirewallRuleActivity#

Block and warn enforcement activity for a single dependency firewall policy rule.

Fields#

Name Type Description
activityCount Int! Activity count matching the rule mode: blocks for enforce, warns for warn.
blockedCount Int! Number of blocked enforcement events for the rule in the window.
enabled Boolean! Whether the policy the rule belongs to is enabled.
id SecurityDependencyFirewallPolicyRuleID! Global ID of the dependency firewall policy rule.
lastModified DependencyFirewallRuleLastModified When and by whom the policy the rule belongs to was last modified.
mode PolicyEnforcementType Enforcement mode of the rule.
policyName String Name of the policy the rule belongs to.
ruleType DependencyFirewallRuleType Type of the rule.
scope PolicyScope Scope of the policy the rule belongs to.
source SecurityPolicySource Source of the policy, indicating whether it is inherited from an ancestor group.
sourceRelationship SecurityPolicyRelationType Where the policy is defined relative to the viewed container.
warnedCount Int! Number of warned enforcement events for the rule in the window.

DependencyFirewallRuleLastModified#

When and by whom a dependency firewall policy was last modified.

Fields#

Name Type Description
at Time Timestamp of when the policy was last modified.
by UserCore User who last modified the policy.

DependencyFirewallSeverityCount#

Count of distinct prevented packages at one severity level.

Fields#

Name Type Description
count Int! Number of distinct packages whose highest carried severity matches the severity field.
severity VulnerabilitySeverity! Severity level of the count.

DependencyListExportPartUploadRegistry#

Represents the Geo replication and verification state of a dependency_list_export_part_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyListExportPartUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyListExportPartUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DependencyListExportPartUploadRegistry.
dependencyListExportPartUploadId ID! ID of the Dependency List Export Part Upload.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DependencyListExportPartUploadRegistry.
lastSyncFailure String Error message during sync of the DependencyListExportPartUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DependencyListExportPartUploadRegistry.
missingOnPrimary Boolean Indicate if the DependencyListExportPartUploadRegistry is missing on primary.
modelRecordId Int ID of the DependencyListExportPartUploadRegistry's model record.
retryAt Time Timestamp after which the DependencyListExportPartUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DependencyListExportPartUploadRegistry.
state RegistryState Sync state of the DependencyListExportPartUploadRegistry.
verificationChecksum String The local checksum of the DependencyListExportPartUploadRegistry.
verificationChecksumMismatched String The expected checksum of the DependencyListExportPartUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the DependencyListExportPartUploadRegistry.
verificationRetryAt Time Timestamp after which the DependencyListExportPartUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DependencyListExportPartUploadRegistry.
verificationStartedAt Time Timestamp when the verification of DependencyListExportPartUploadRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyListExportPartUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyListExportPartUploadRegistry.

DependencyListExportPartUploadRegistryConnection#

Paginated collection of DependencyListExportPartUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

DependencyListExportUploadRegistry#

Represents the Geo replication and verification state of a dependency_list_export_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyListExportUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyListExportUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DependencyListExportUploadRegistry.
dependencyListExportUploadId ID! ID of the Dependency List Export Upload.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DependencyListExportUploadRegistry.
lastSyncFailure String Error message during sync of the DependencyListExportUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DependencyListExportUploadRegistry.
missingOnPrimary Boolean Indicate if the DependencyListExportUploadRegistry is missing on primary.
modelRecordId Int ID of the DependencyListExportUploadRegistry's model record.
retryAt Time Timestamp after which the DependencyListExportUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DependencyListExportUploadRegistry.
state RegistryState Sync state of the DependencyListExportUploadRegistry.
verificationChecksum String The local checksum of the DependencyListExportUploadRegistry.
verificationChecksumMismatched String The expected checksum of the DependencyListExportUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the DependencyListExportUploadRegistry.
verificationRetryAt Time Timestamp after which the DependencyListExportUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DependencyListExportUploadRegistry.
verificationStartedAt Time Timestamp when the verification of DependencyListExportUploadRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyListExportUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyListExportUploadRegistry.

DependencyListExportUploadRegistryConnection#

Paginated collection of DependencyListExportUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

DependencyLocation#

Location of a software dependency within a project.

Fields#

Name Type Description
hasDependencyPaths Boolean! Indicates whether the dependency has any dependency paths.
location Location Information about where the dependency is located.
occurrenceId SbomOccurrenceID! Global ID of the SBOM occurrence.
project Project Project containing the dependency.

DependencyLocationConnection#

Paginated collection of DependencyLocation. See Standard connection fields for the fields available on every connection.

DependencyPath#

Ancestor path of a given dependency.

Fields#

Name Type Description
isCyclic Boolean! Indicates if the path is cyclic.
path [DependencyPathPartial!]! Name of the dependency.

DependencyPathEdge#

Edge for a paginated dependency path for SBOM occurrences.

Fields#

Name Type Description
cursor String! Cursor for use in pagination.
node DependencyPath Dependency path node.

DependencyPathPage#

Paginated dependency paths for SBOM occurrences.

Fields#

Name Type Description
edges [DependencyPathEdge!]! List of dependency path edges.
nodes [DependencyPath!]! List of dependency paths.
pageInfo DependencyPathPageInfo! Pagination information for dependency paths.

DependencyPathPageInfo#

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.

DependencyPathPartial#

Ancestor path partial of a given dependency.

Fields#

Name Type Description
name String! Name of 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.

DependencyProxyBlobConnection#

Paginated collection of DependencyProxyBlob. See Standard connection fields for the fields available on every connection.

DependencyProxyBlobRegistry#

Represents the Geo replication and verification state of a dependency_proxy_blob.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyProxyBlobRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyProxyBlobRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DependencyProxyBlobRegistry.
dependencyProxyBlobId ID! ID of the Dependency Proxy Blob.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the DependencyProxyBlobRegistry is missing on primary.
modelRecordId Int ID of the DependencyProxyBlobRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the DependencyProxyBlobRegistry in case of mismatch.
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 of DependencyProxyBlobRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyProxyBlobRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyProxyBlobRegistry.

DependencyProxyBlobRegistryConnection#

Paginated collection of DependencyProxyBlobRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

DependencyProxyManifestConnection#

Paginated collection of DependencyProxyManifest. See Standard connection fields for the fields available on every connection.

DependencyProxyManifestRegistry#

Represents the Geo replication and verification state of a dependency_proxy_manifest.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyProxyManifestRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyProxyManifestRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DependencyProxyManifestRegistry.
dependencyProxyManifestId ID! ID of the Dependency Proxy Manifest.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the DependencyProxyManifestRegistry is missing on primary.
modelRecordId Int ID of the DependencyProxyManifestRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the DependencyProxyManifestRegistry in case of mismatch.
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 of DependencyProxyManifestRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyProxyManifestRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyProxyManifestRegistry.

DependencyProxyManifestRegistryConnection#

Paginated collection of DependencyProxyManifestRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

DependencyProxyPackagesSetting#

Project-level Dependency Proxy for packages settings.

Fields#

Name Type Description
enabled Boolean! Indicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryUrl String URL for the external Maven packages registry.
mavenExternalRegistryUsername String 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.
identity String Identity credential used to authenticate with Docker Hub when pulling images. Can be a username (for password or personal access token (PAT)) or organization name (for organization access token (OAT)).

DependencyScanningConfiguration#

Configuration for a dependency scanning scan profile.

Fields#

Name Type Description
additionalCaCertBundle String Introduced as an experiment in GitLab 19.5.

CA certificate bundle to trust. The bundle is added to the system's certificates and used by other tools during the scan.
apiScanDownloadDelay Int Introduced as an experiment in GitLab 19.5.

Vulnerability scanning API initial delay in seconds before downloading scan results.
apiTimeout Int Introduced as an experiment in GitLab 19.5.

Vulnerability scanning API request timeout in seconds.
disabledResolutionJobs [SecurityScanProfileDependencyResolutionJob!] Introduced as an experiment in GitLab 19.5.

Resolution jobs that are disabled.
enableManifestFallback Boolean Introduced as an experiment in GitLab 19.5.

Whether manifest fallback for dependency scanning is enabled.
enableVulnerabilityScan Boolean Introduced as an experiment in GitLab 19.5.

Whether the vulnerability analysis of generated SBOMs is enabled.
excludedPaths [String!] Introduced as an experiment in GitLab 19.5.

Glob paths excluded from the scan.
gradleCliOpts String Introduced as an experiment in GitLab 19.5.

Additional command-line options passed to Gradle during dependency resolution.
gradleResolutionImage String Introduced as an experiment in GitLab 19.5.

Image used by the Gradle dependency resolution job.
includeDevDependencies Boolean Introduced as an experiment in GitLab 19.5.

Whether development and test dependencies are included when scanning a supported file.
mavenArgs String Introduced as an experiment in GitLab 19.5.

Additional arguments passed to Maven during dependency resolution.
mavenDependencyPluginVersion String Introduced as an experiment in GitLab 19.5.

Version of maven-dependency-plugin used during resolution.
mavenResolutionImage String Introduced as an experiment in GitLab 19.5.

Image used by the Maven dependency resolution job.
maxDepth Int Introduced as an experiment in GitLab 19.5.

Specifies the directory depth the analyzer should scan. A value of -1 scans all directories.
pipDependencyPath String Introduced as an experiment in GitLab 19.5.

Path to install Python packages for analysis.
pipExtraIndexUrl [String!] Introduced as an experiment in GitLab 19.5.

Additional URLs of Python package indexes used in addition to pipIndexUrl.
pipIndexUrl String Introduced as an experiment in GitLab 19.5.

Base URL of the Python Package Index.
pipManifestFileNamePattern String Introduced as an experiment in GitLab 19.5.

Custom pip manifest file name pattern to use for dependency resolution and manifest scanning. The pattern matches file names only, not directory paths.
pipcompileLockfileFileNamePattern String Introduced as an experiment in GitLab 19.5.

Custom pipcompile lockfile file name pattern to use when analyzing. The pattern matches file names only, not directory paths.
pythonResolutionImage String Introduced as an experiment in GitLab 19.5.

Image used by the Python dependency resolution job.
searchIgnoreHiddenDirs Boolean Introduced as an experiment in GitLab 19.5.

Whether hidden directories are ignored when searching for supported files.
secureAnalyzersPrefix String Introduced as an experiment in GitLab 19.5.

Prefix for the container registry from which the analyzer image is pulled.
secureLogLevel SecurityScanProfileSecureLogLevel Introduced as an experiment in GitLab 19.5.

Logging level used by the analyzer.
staticReachabilityEnabled Boolean Introduced as an experiment in GitLab 19.5.

Whether static reachability is enabled.

DependencyTrackedRef#

Ref (branch or tag) where a software dependency appears.

Fields#

Name Type Description
id SecurityProjectTrackedContextID! Global ID of the tracked ref.
isDefault Boolean! Indicates whether the ref is the default branch.
name String! Name of the ref (branch or tag name).
refType SecurityTrackedRefType! Type of the ref (branch or tag).

DependencyTrackedRefConnection#

Paginated collection of DependencyTrackedRef. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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 String 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.
refPath String Path to the 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.
webPath String Web path to the deployment page.

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.

DeploymentConnection#

Paginated collection of Deployment. See Standard connection fields for the fields available on every connection.

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 the git tag.
path String Path for the tag.
webPath String Web path for the tag.

DeploymentsAggregationResponse#

Response for Deployments aggregation engine.

Fields#

Name Type Description
canceledRate Float Deployment canceled rate (out of finished deployments).
deploymentDurationQuantile Float Deployment duration quantile in milliseconds.

Arguments for deploymentDurationQuantile:
quantile (Float)
dimensions DeploymentsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
duration DeploymentsAggregationResponseDurationMetrics Aggregated duration metrics.
failureRate Float Deployment failure rate (out of finished deployments).
successRate Float Deployment success rate (out of finished deployments).
totalCount Int Total number of deployments.

DeploymentsAggregationResponseConnection#

Paginated collection of DeploymentsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

DeploymentsAggregationResponseDimensions#

Response dimensions for Deployments aggregation engine.

Fields#

Name Type Description
createdAt Date Deployment creation date.

Arguments for createdAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
environment Environment Environment ID.
finishedAt Date Deployment finish date.

Arguments for finishedAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
ref String Deployment ref.
status String Deployment status.
user UserCore User who created the deployment. Returns null if there is no recorded creator, or if that user has been deleted.

DeploymentsAggregationResponseDurationMetrics#

Aggregated duration metrics for Deployments aggregation engine.

Fields#

Name Type Description
max Int Maximum deployment duration in seconds.
mean Float Mean deployment duration in seconds.
min Int Minimum deployment duration in seconds.
quantile Float Quantile of deployment duration in seconds.

Arguments for quantile:
quantile (Float)
sum Float Sum of deployment duration in seconds.

DeploymentsAggregationScope#

Aggregation scope for Deployments. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated DeploymentsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

DescriptionVersion#

Fields#

Name Type Description
canDelete Boolean Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deletePath String Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deleted Boolean Deprecated in GitLab 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.
diff String Description diff between versions.

Arguments for diff:
versionId (DescriptionVersionID)
ID of a previous version to compare. If not specified first previous version is used.
diffPath String Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
id DescriptionVersionID! ID of the description version.

Design#

A single design.

Implements: CurrentUserTodos, DesignFields, NoteableInterface, Todoable

Fields#

Name Type Description
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
description String Description of the design.
descriptionHtml String GitLab Flavored Markdown rendering of description.
diffRefs DiffRefs! Diff refs for the design.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
event DesignVersionEvent! How the design was changed in the current version.
filename String! Filename of the design.
fullPath ID! Full path to the design file.
id ID! ID of the 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.
imported Boolean! Indicates whether the design was imported.
importedFrom ImportSource! Import source of the design.
issue Issue! Issue the design belongs to.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
notesCount Int! Total count of user-created notes for the design.
project Project! Project the design belongs to.
versions DesignVersionConnection! All versions related to this design ordered newest first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
earlierOrEqualToId (DesignManagementVersionID)
Global ID of the most recent acceptable version.
earlierOrEqualToSha (String)
SHA256 of the most recent acceptable version.
webUrl String! URL of the design.

DesignAtVersion#

A design pinned to a specific version. The image field reflects the design as of the associated version.

Implements: DesignFields

Fields#

Name Type Description
design Design! Underlying design.
diffRefs DiffRefs! Diff refs for the design.
event DesignVersionEvent! How the design was changed in the current version.
filename String! Filename of the design.
fullPath ID! Full path to the design file.
id ID! ID of the 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 the design.
project Project! Project the design belongs to.
version DesignVersion! Version the design-at-versions is pinned to.

DesignAtVersionConnection#

Paginated collection of DesignAtVersion. See Standard connection fields for the fields available on every connection.

DesignCollection#

A collection of designs.

Fields#

Name Type Description
copyState DesignCollectionCopyState Copy state of the design collection.
design Design Find a specific design.

Arguments for design:
filename (String)
Find a design by its filename.
id (DesignManagementDesignID)
Find a design by its ID.
designAtVersion DesignAtVersion Find a design as of a version.

Arguments for designAtVersion:
id (DesignManagementDesignAtVersionID!)
Global ID of the design at the version.
designs DesignConnection! All designs for the design collection. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for designs:
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.
issue Issue! Issue associated with the design collection.
project Project! Project associated with the design collection.
version DesignVersion A specific version.

Arguments for version:
id (DesignManagementVersionID)
Global ID of the version.
sha (String)
SHA256 of a specific version.
versions DesignVersionConnection! All versions related to all designs, ordered newest first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
earlierOrEqualToId (DesignManagementVersionID)
Global ID of the most recent acceptable version.
earlierOrEqualToSha (String)
SHA256 of the most recent acceptable version.

DesignConnection#

Paginated collection of Design. See Standard connection fields for the fields available on every connection.

DesignManagement#

Fields#

Name Type Description
designAtVersion DesignAtVersion Find a design as of a version.

Arguments for designAtVersion:
id (DesignManagementDesignAtVersionID!)
Global ID of the design at the version.
version DesignVersion Find a version.

Arguments for version:
id (DesignManagementVersionID!)
Global ID of the version.

DesignManagementActionUploadRegistry#

Represents the Geo replication and verification state of a design_management_action_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DesignManagementActionUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DesignManagementActionUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DesignManagementActionUploadRegistry.
designManagementActionUploadId ID! ID of the Design Management Action Upload.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DesignManagementActionUploadRegistry.
lastSyncFailure String Error message during sync of the DesignManagementActionUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DesignManagementActionUploadRegistry.
missingOnPrimary Boolean Indicate if the DesignManagementActionUploadRegistry is missing on primary.
modelRecordId Int ID of the DesignManagementActionUploadRegistry's model record.
retryAt Time Timestamp after which the DesignManagementActionUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DesignManagementActionUploadRegistry.
state RegistryState Sync state of the DesignManagementActionUploadRegistry.
verificationChecksum String The local checksum of the DesignManagementActionUploadRegistry.
verificationChecksumMismatched String The expected checksum of the DesignManagementActionUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the DesignManagementActionUploadRegistry.
verificationRetryAt Time Timestamp after which the DesignManagementActionUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DesignManagementActionUploadRegistry.
verificationStartedAt Time Timestamp when the verification of DesignManagementActionUploadRegistry started.
verificationState VerificationStateEnum Verification state of the DesignManagementActionUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DesignManagementActionUploadRegistry.

DesignManagementActionUploadRegistryConnection#

Paginated collection of DesignManagementActionUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

DesignManagementRepositoryRegistry#

Represents the Geo replication and verification state of a Design Management Repository.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DesignManagementRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DesignManagementRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DesignManagementRepositoryRegistry.
designManagementRepositoryId ID! ID of the Design Management Repository.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the DesignManagementRepositoryRegistry is missing on primary.
modelRecordId Int ID of the DesignManagementRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the DesignManagementRepositoryRegistry in case of mismatch.
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 of DesignManagementRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the DesignManagementRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DesignManagementRepositoryRegistry.

DesignManagementRepositoryRegistryConnection#

Paginated collection of DesignManagementRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.
designAtVersion DesignAtVersion! A particular design as of this version, provided it is visible at this version.

Arguments for designAtVersion:
designId (DesignManagementDesignID)
ID of a specific design.
filename (String)
Filename of a specific design.
id (DesignManagementDesignAtVersionID)
ID of the DesignAtVersion.
designs DesignConnection! All designs that were changed in the version. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
designsAtVersion DesignAtVersionConnection! All designs that are visible at this version, as of this version. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for designsAtVersion:
filenames ([String!])
Filters designs by their filename.
ids ([DesignManagementDesignID!])
Filters designs by their ID.
id ID! ID of the design version.
sha ID! SHA of the design version.

DesignVersionConnection#

Paginated collection of DesignVersion. See Standard connection fields for the fields available on every connection.

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.
deploymentDetailsPath String Path of the deployment details for the status.
detailsPath String Path of the details for the status.
favicon String Favicon of the status.
group String Deprecated in GitLab 16.4. The group attribute is deprecated. Use name instead.
hasDetails Boolean Indicates if the status has further details.
icon String Deprecated in GitLab 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 GitLab 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.
snapshots DevopsAdoptionSnapshotConnection Data snapshots of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snapshots:
endTimeAfter (Time)
Filter to snapshots with month end after the provided date.
endTimeBefore (Time)
Filter to snapshots with month end before the provided date.

DevopsAdoptionEnabledNamespaceConnection#

Paginated collection of DevopsAdoptionEnabledNamespace. See Standard connection fields for the fields available on every connection.

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.

DevopsAdoptionSnapshotConnection#

Paginated collection of DevopsAdoptionSnapshot. See Standard connection fields for the fields available on every connection.

Diff#

Fields#

Name Type Description
aMode String Old file mode of the file.
bMode String New file mode of the file.
collapsed String File diffs are excluded but can be fetched on request.
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.
tooLarge String File diffs are excluded and cannot be retrieved.

DiffConnection#

Paginated collection of Diff. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
overflow Boolean! Whether files were omitted from the page because it exceeded the diff size limits. Omitted files are absent from nodes and are not flagged with collapsed or too_large.

DiffLine#

A single line of a diff displayed above a diff note.

Fields#

Name Type Description
canReceiveSuggestion Boolean! Indicates whether the line can receive a suggestion.
lineCode String Line code of the diff line.
newLine Int Line number on the HEAD SHA.
oldLine Int Line number on the start SHA.
richText String Syntax-highlighted HTML of the diff line.
text String Raw text of the diff line, including the leading diff sign.
type String Type of the diff line, such as 'new' or 'old'. Null for unchanged context lines.

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 the file.
deletions Int! Number of lines deleted from the 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#

Implements: BaseDiscussionInterface, ResolvableInterface

Fields#

Name Type Description
createdAt Time! Timestamp of the discussion's creation.
id DiscussionID! ID of the discussion.
noteable NoteableType Object which the discussion belongs to.
notes NoteConnection! All notes in the discussion. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
replyId DiscussionID! ID used to reply to the 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.
truncatedDiffLines [DiffLine!] At most 16 highlighted diff lines above the diff note, up to and including the commented line. Null for non-diff discussions.
userPermissions DiscussionPermissions! Permissions for the current user on the resource.

DiscussionConnection#

Paginated collection of Discussion. See Standard connection fields for the fields available on every connection.

DiscussionPermissions#

Fields#

Name Type Description
resolveNote Boolean! If true, the user can perform resolve_note on this resource.

Dora#

All information related to DORA metrics.

Fields#

Name Type Description
metrics [DoraMetric!] DORA metrics for the current group or project.

Arguments for metrics:
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.
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.

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.

DoraPerformanceScoreCountConnection#

Paginated collection of DoraPerformanceScoreCount. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
noDoraDataProjectsCount Int! Count of projects without any DORA scores within the scope.
totalProjectsCount Int! Count of total projects.

DuoCodeSuggestionsAggregationResponse#

Response for DuoCodeSuggestions aggregation engine.

Fields#

Name Type Description
acceptanceRate Float Acceptance rate (accepted / shown).
acceptedCount Int Number of accepted suggestions.
dimensions DuoCodeSuggestionsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
rejectedCount Int Number of rejected suggestions.
shownCount Int Number of shown suggestions.
suggestionSizeSum Int Total suggestions volume.
totalCount Int Total number of suggestions.
usersCount Int Number of unique users.

DuoCodeSuggestionsAggregationResponseConnection#

Paginated collection of DuoCodeSuggestionsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

DuoCodeSuggestionsAggregationResponseDimensions#

Response dimensions for DuoCodeSuggestions aggregation engine.

Fields#

Name Type Description
ideName String IDE name.
language String Programming language.
timestamp Date Suggestion date.

Arguments for timestamp:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
user UserCore User.

DuoCodeSuggestionsAggregationScope#

Aggregation scope for DuoCodeSuggestions. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated DuoCodeSuggestionsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

DuoContextExclusionSettings#

Settings for Duo context exclusion rules.

Fields#

Name Type Description
exclusionRules [String!] List of rules for excluding files from Duo context.

DuoMessage#

A message in a Duo Workflow chat log.

Fields#

Name Type Description
additionalContext [AiAdditionalContext!] Additional context items attached to the message.
alternativeCount Int Introduced as an experiment in GitLab 19.3.

The count of alternative branches for a user message -1 (the currently displayed branch). A thread can have multiple branches when a message is retried, and a new branch is created with the same parent_ts as the message being retried.Returns null on every message, if the dw_read_blobs_graphql feature flag is disabled, or if the session does not store incremental checkpoints.
componentName String Introduced as an experiment in GitLab 19.0.

Component name associated with the message.
content String! Content of the message.
correlationId String Optional client-supplied identifier echoed back to correlate this message with the request that initiated it.
messageId ID Opaque identifier for the message, assigned by the workflow executor.
messageSubType String Introduced as an experiment in GitLab 19.0.

Sub-type of the message, used to discriminate among messages of the same type.
messageType String! Type of the message.
parentTs String Introduced as an experiment in GitLab 19.3.

Identifier of the checkpoint preceding the one that introduced the message, which is the point a client resumes the session from to regenerate it. Returns null if the dw_read_blobs_graphql feature flag is disabled, or if the session does not store incremental checkpoints.
role String Role of the message.
status String Status of the message.
subsessionId String Introduced as an experiment in GitLab 19.0.

Subsession ID associated with the message.
threadTs String Introduced as an experiment in GitLab 19.3.

Identifier of the checkpoint that introduced the message. Returns null if the dw_read_blobs_graphql feature flag is disabled, or if the session does not store incremental checkpoints.
timestamp String Timestamp of the message.
toolInfo String Tool information for the message.

DuoSettings#

GitLab Duo settings.

Fields#

Name Type Description
aiGatewayTimeoutSeconds Int Timeout in seconds for requests to the AI Gateway server.
aiGatewayUrl String Introduced as an experiment in GitLab 17.9.

URL for the local AI Gateway server.
allowAllUnixSockets Boolean Introduced as an experiment in GitLab 19.0.

Whether all Unix sockets are allowed for network access.
allowProjectExtension Boolean Introduced as an experiment in GitLab 19.0.

Whether projects can extend the network access domain allowlist.
duoAgentPlatformServiceUrl String Introduced as an experiment in GitLab 18.4.

URL for local Duo Agent Platform service.
duoCliEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates whether GitLab Duo CLI access is enabled.
duoCoreFeaturesEnabled Boolean Introduced as an experiment in GitLab 18.0.

Indicates whether GitLab Duo Core features are enabled.
includeRecommendedAllowed Boolean Introduced as an experiment in GitLab 19.0.

Whether recommended domains are included in the network access allowlist.
minimumAccessLevelEnableOnProjects AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level required to enable Duo Agent Platform. Returns null if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelExecute AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level required to execute Duo Agent Platform. Returns null if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelExecuteAsync AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level required to execute Duo Agent Platform features in CI/CD. Returns null if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelManage AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level required to manage Duo Agent Platform. Returns null if dap_instance_customizable_permissions feature flag is disabled.
selfHostedDuoAgentPlatformServiceSecure Boolean Whether local Duo Agent Platform service uses secure transport (TLS).
updatedAt Time! Introduced as an experiment in GitLab 17.9.

Timestamp of last GitLab Duo setting update.

DuoUsageEventsAggregationResponse#

Response for DuoUsageEvents aggregation engine.

Fields#

Name Type Description
dimensions DuoUsageEventsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
featuresCount Int Number of unique features.
previousPeriodUsersCount Int Number of unique users in the previous period.
returningUsersCount Int Number of users who also used this feature in the previous period.
totalCount Int Total number of events, optionally filtered by event name.

Arguments for totalCount:
event ([String!])
Only count the given events.
usersCount Int Number of unique users.

DuoUsageEventsAggregationResponseConnection#

Paginated collection of DuoUsageEventsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

DuoUsageEventsAggregationResponseDimensions#

Response dimensions for DuoUsageEvents aggregation engine.

Fields#

Name Type Description
event String Event identifier.
feature String Feature identifier.
flowType String Duo Agent Platform flow type; NULL for non-DAP events.
group Group Group at the requested depth of the hierarchy. NULL for events tracked above that depth. Events tracked in a project at that depth bucket by project namespace ID, which also resolves to NULL.

Arguments for group:
depth (Int)
Depth in the group hierarchy, counted from the top-level group. Defaults to 1.
timestamp Date Event date.

Arguments for timestamp:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
user UserCore Event owner.

DuoUsageEventsAggregationScope#

Aggregation scope for DuoUsageEvents. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated DuoUsageEventsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
featuresCountFrom (Int)
Filter by the number of unique features The features_count metric must also be requested when using this filter. Start of the range.
featuresCountTo (Int)
Filter by the number of unique features The features_count metric must also be requested when using this filter. End of the range.
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

DuoWorkflow#

GitLab Duo Agent Platform session.

Implements: Todoable

Fields#

Name Type Description
agentName String Introduced as an experiment in GitLab 18.8.

Name of the agent used for the workflow.
agentPrivilegesNames [String!] Privileges granted to the agent during execution.
aiCatalogItem AiCatalogItem Introduced as an experiment in GitLab 19.4.

AI catalog item (flow or agent definition) that the session ran.
aiCatalogItemVersionId AiCatalogItemVersionID Introduced as an experiment in GitLab 18.4.

ID of the AI catalog item version that triggered the workflow.
allExecutorLogsUrls [String!] List of all the executor logs for the workflow.
allowAgentToRequestUser Boolean Allow the agent to request user input.
allowClientInjectedMcpTools Boolean Introduced as an experiment in GitLab 19.5.

Indicates MCP tools supplied by the client skip the tool call approval gate. Toggled by the dap_allow_client_injected_mcp_tools feature flag; returns false when it is disabled.
archived Boolean Archived due to retention policy.
auditEvents AiAuditEventConnection Introduced as an experiment in GitLab 19.0.

Audit events recorded for the session. Requires read_agent_artifacts on the workflow's project or namespace. Returns no events when the agent_artifacts_page feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp of when the session was created.
environment WorkflowEnvironment Environment, like IDE or web.
firstCheckpoint DuoWorkflowEvent First checkpoint of the session.

Arguments for firstCheckpoint:
checkpointNs (String)
Introduced as an experiment in GitLab 19.3.

LangGraph checkpoint namespace to scope the lookup to. Omit (or pass an empty string) for the session's own top-level checkpoint lineage; used internally to resolve one nested subgraph invocation, e.g. a delegated subagent.
flowMetadataId String Introduced as an experiment in GitLab 19.3.

Identifier of the flow that was executed in the session.
flowMetadataSchemaVersion String Introduced as an experiment in GitLab 19.3.

Schema version of the flow metadata for the session.
flowMetadataVersion String Introduced as an experiment in GitLab 19.3.

Version of the flow that was executed in the session.
goal String Goal of the session.
humanStatus String! Human-readable status of the session.
id ID! ID of the session.
incrementalCheckpointsEnabled Boolean Indicates incremental checkpoints were enabled for the session at creation.
inverseWorkflowLinks DuoWorkflowWorkflowLinkConnection Other sessions that link to the session, for example the sessions restarted from it. On each link, workflow is the other session and linkedWorkflow is the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for inverseWorkflowLinks:
linkType (DuoWorkflowWorkflowLinkType)
Filter links by their link type.
lastExecutorLogsUrl String URL to the latest executor logs of the workflow.
latestCheckpoint DuoWorkflowEvent Latest checkpoint of the session.

Arguments for latestCheckpoint:
checkpointNs (String)
Introduced as an experiment in GitLab 19.3.

LangGraph checkpoint namespace to scope the lookup to. Omit (or pass an empty string) for the session's own top-level checkpoint lineage; used internally to resolve one nested subgraph invocation, e.g. a delegated subagent.
mcpEnabled Boolean Has MCP been enabled for the namespace.
mergeRequest MergeRequest Associated merge request, if any.
mergeRequestLinks DuoWorkflowMergeRequestLinkConnection Merge requests linked to the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequestLinks:
linkType (DuoWorkflowMergeRequestLinkType)
Filter links by their link type.
modelMetadataIdentifier String Introduced as an experiment in GitLab 19.2.

Provider model identifier used for the session.
modelMetadataName String Introduced as an experiment in GitLab 19.2.

Model used for the session.
name String Name or title of the object.
namespace Namespace namespace that the session is in.
namespaceId TypesNamespaceID ID of the namespace.
noteLinks DuoWorkflowNoteLinkConnection Notes linked to the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for noteLinks:
linkType (DuoWorkflowNoteLinkType)
Filter links by their link type.
pipelineLinks DuoWorkflowPipelineLinkConnection Pipelines linked to the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineLinks:
linkType (DuoWorkflowPipelineLinkType)
Filter links by their link type.
preApprovedAgentPrivilegesNames [String!] Privileges pre-approved for the agent during execution.
project Project Project that the session is in.
projectId ProjectID ID of the project.
resourceIid Int IID of the associated resource (issue or merge request).
resourceWebUrl String Web URL of the associated resource (issue or merge request).
sourceLink String Introduced as an experiment in GitLab 19.4.

URL or deep link to the location where the session was triggered from.
sourceType DuoWorkflowSourceType Introduced as an experiment in GitLab 19.4.

Type of source that initiated the session.
stalled Boolean Workflow got created but has no checkpoints.
status DuoWorkflowStatus Status of the session.
statusGroup DuoWorkflowStatusGroup Status group of the flow session.
statusName String Status name of the session.
summary String Summary of the session.
title String Title of the session.
toolCallApprovalMatch DuoWorkflowToolCallApprovalMatch! Introduced as an experiment in GitLab 19.3.

Approval match details for the specified tool call.

Arguments for toolCallApprovalMatch:
toolCallArgs (String!)
JSON-serialized arguments for the tool call.
toolName (String!)
Name of the tool to check.
toolCallApprovals JSON Tools approval per session policy.
toolCallApproved Boolean! Whether the specified tool call is approved for the session.

Arguments for toolCallApproved:
toolCallArgs (String!)
JSON-serialized arguments for the tool call.
toolName (String!)
Name of the tool to check.
updatedAt Time! Timestamp of when the session was last updated.
user UserCore User who created the session.
userId UserID! ID of the user.
userPermissions DuoWorkflowPermissions Permissions of the current user for the workflow.
webSearchEnabled Boolean Introduced as an experiment in GitLab 19.3.

Whether web search is enabled for the session.
webUrl String URL of the session.
workItem WorkItem Associated work item (issue or epic), if any.
workItemLinks DuoWorkflowWorkItemLinkConnection Work items linked to the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemLinks:
linkType (DuoWorkflowWorkItemLinkType)
Filter links by their link type.
workflowDefinition String GitLab Duo Agent Platform flow type based on its capabilities.
workflowLinks DuoWorkflowWorkflowLinkConnection Other sessions linked to the session, for example the session it was restarted from. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workflowLinks:
linkType (DuoWorkflowWorkflowLinkType)
Filter links by their link type.

DuoWorkflowAgentPresence#

Agent attribution for an object, such as a note, created by a GitLab Duo Agent Platform session.

Fields#

Name Type Description
agentCatalogWebPath String Web path of the agent in the AI Catalog. Null when the agent has no catalog profile.
agentName String Name of the agent that ran the session.
sessionId AiDuoWorkflowsWorkflowID! Global ID of the session that created the object.
sourceLink String URL or deep link to the location where the session was triggered from. Null unless the current user can read the session.
sourceType DuoWorkflowSourceType Type of source that initiated the session.
triggerSource DuoWorkflowTriggerSource Kind of initiator that started the session.
user UserCore User the session ran as. For triggered sessions, the account the trigger runs with.
userPermissions DuoWorkflowAgentPresencePermissions! Permissions for the current user on the session.

DuoWorkflowAgentPresencePermissions#

Check permissions for the current user on the session that created the object.

Fields#

Name Type Description
readDuoWorkflow Boolean! If true, the user can perform read_duo_workflow on this resource.

DuoWorkflowBranch#

Alternative branch of a Duo Agent Platform session, created by retrying a message.

Fields#

Name Type Description
forkThreadTs String Identifier of the checkpoint to resume the session from to switch to the branch.
messages [DuoMessage!]! Messages the branch added after the point it diverged, oldest first.

DuoWorkflowCheckpointWrite#

A pending write associated with a Duo Workflow checkpoint.

Fields#

Name Type Description
channel String! LangGraph channel the write was made to.
data String! Write data.
id ID! ID of the checkpoint write.
idx Int Index of the write within the task.
task String! LangGraph task identifier the write was made for.
threadTs String! LangGraph thread timestamp identifier the write belongs to.
writeType String! Serialization type of the write data.

DuoWorkflowConnection#

Paginated collection of DuoWorkflow. See Standard connection fields for the fields available on every connection.

DuoWorkflowEnablement#

Duo Agent Platform enablement status checks.

Fields#

Name Type Description
checks [DuoWorkflowEnablementCheck!] Enablement checks.
createDuoWorkflowForCiAllowed Boolean! Introduced as an experiment in GitLab 18.9.

Indicates whether the user can create Duo Workflows for CI in the project.
enabled Boolean! Indicates whether Duo Agent Platform is enabled for current user and the project.
enabledFoundationalFlows [String!] References of the foundational flows enabled for the project, for example "code_review/v1".
foundationalFlowsEnabled Boolean Indicates if Duo Agent Platform foundational flows are enabled for the project.
remoteFlowsEnabled Boolean Indicates if Duo Agent Platform remote flows are enabled for the project.

DuoWorkflowEnablementCheck#

Represents single Duo Agent Platform enablement check.

Fields#

Name Type Description
message String Description of status check.
name String! Name of the status check.
value Boolean! Whether the check was successful or not.

DuoWorkflowEvent#

Events that describe the history and progress of a GitLab Duo Agent Platform session.

Fields#

Name Type Description
checkpoint JsonString Deprecated in GitLab 18.7. Checkpoints are big & contain internal langgraph details.
checkpointNs String Introduced as an experiment in GitLab 19.3.

LangGraph checkpoint namespace this checkpoint belongs to. Blank for the session's own top-level checkpoint lineage; this field only ever surfaces that lineage (via first_checkpoint/latest_checkpoint), never a nested subgraph invocation's own.
checkpointWrites [DuoWorkflowCheckpointWrite!] Introduced as an experiment in GitLab 19.3.

Pending writes associated with the checkpoint, e.g. interrupts awaiting resumption.
compressedCheckpoint String Checkpoint of the event, zlib-compressed and Base64-encoded.
currentThread Int! Introduced as an experiment in GitLab 19.4.

Compaction group this checkpoint belongs to. The writer bumps it on every compaction and resets it when its process restarts, so a client that resumes a session must read it back from here to keep numbering the groups correctly.
duoMessages [DuoMessage!] Messages from the ui_chat_log for the checkpoint.
errors [String!] Message errors.
executionStatus String! Introduced as an experiment in GitLab 17.10.

Granular status of the session's execution.
lastDuoMessage DuoMessage Introduced as an experiment in GitLab 19.3.

Most recent message from the ui_chat_log for the checkpoint. Cheaper than duoMessages for list previews: it reads only the latest message instead of the full chat log.
metadata JsonString Metadata associated with the event.
parentTs String UUID v7 timestamp identifier of the parent message for branched conversations or responses.
threadTs String UUID v7 timestamp identifier for the conversation thread/session in LangGraph state management.
workflowDefinition String GitLab Duo Agent Platform flow type based on its capabilities.
workflowGoal String Goal of the session.
workflowStatus DuoWorkflowStatus Status of the session.

DuoWorkflowEventConnection#

Paginated collection of DuoWorkflowEvent. See Standard connection fields for the fields available on every connection.

Link between a GitLab Duo Agent Platform session and a merge request.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowMergeRequestLinkType! How the merge request relates to the session.
mergeRequest MergeRequest Linked merge request.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowMergeRequestLinkConnection#

Paginated collection of DuoWorkflowMergeRequestLink. See Standard connection fields for the fields available on every connection.

Link between a GitLab Duo Agent Platform session and a note.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowNoteLinkType! How the note relates to the session.
note Note Linked note.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowNoteLinkConnection#

Paginated collection of DuoWorkflowNoteLink. See Standard connection fields for the fields available on every connection.

DuoWorkflowPermissions#

Check permissions for the current user on a Duo workflow.

Fields#

Name Type Description
deleteDuoWorkflow Boolean! If true, the user can perform delete_duo_workflow on this resource.
readDuoWorkflow Boolean! If true, the user can perform read_duo_workflow on this resource.
restartDuoWorkflow Boolean! If true, the user can perform restart_duo_workflow on this resource.
resumeDuoWorkflow Boolean! If true, the user can perform resume_duo_workflow on this resource.
updateDuoWorkflow Boolean! If true, the user can perform update_duo_workflow on this resource.

Link between a GitLab Duo Agent Platform session and a pipeline.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowPipelineLinkType! How the pipeline relates to the session.
pipeline Pipeline Linked pipeline.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowPipelineLinkConnection#

Paginated collection of DuoWorkflowPipelineLink. See Standard connection fields for the fields available on every connection.

DuoWorkflowSessionArtifact#

A Duo Agent Platform session artifact.

Fields#

Name Type Description
agentType String Introduced as an experiment in GitLab 19.4.

Type of the external agent that ran the session, for example claude-code. Null for sessions run on the GitLab Duo Agent Platform.
auditEvents AiAuditEventConnection Audit events recorded for the session. Readable with read_agent_artifacts on the parent group or project; does not require access to the underlying workflow. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
auditEventsCount Int! Number of audit events recorded for the session.
creditsUsed Float Introduced as an experiment in GitLab 19.4.

Total GitLab Credits consumed by the session. Readable with read_agent_artifacts on the parent group or project. Requires ClickHouse to be configured for analytics; ingestion is gated by the duo_workflow_session_credits_ingestion feature flag. Null until credit data has been ingested for the session, including sessions that failed before ingestion.
downloadPath String Path to download the session artifact as a JSON file.
id ID! Global ID of the session, as an Ai::DuoWorkflows::Workflow.
project Project Project the session belongs to.
triggeredBy UserCore User who initiated the session.
webPath String Path of the session.
workflowCreatedAt Time! Timestamp of when the session was created.
workflowDefinition String! Workflow definition type of the session.

DuoWorkflowSessionArtifactConnection#

Paginated collection of DuoWorkflowSessionArtifact. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

DuoWorkflowToolCallApprovalMatch#

Approval match details for a Duo Workflow tool call.

Fields#

Name Type Description
matchType DuoWorkflowToolCallApprovalMatchType Mechanism that produced the match, null when unmatched.
matched Boolean! Indicates the tool call matches a stored approval.
matchedPattern String Glob pattern that produced the match, present only for pattern matches.

Link between a GitLab Duo Agent Platform session and a work item.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowWorkItemLinkType! How the work item relates to the session.
workItem WorkItem Linked work item.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowWorkItemLinkConnection#

Paginated collection of DuoWorkflowWorkItemLink. See Standard connection fields for the fields available on every connection.

Link between a GitLab Duo Agent Platform session and another session.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowWorkflowLinkType! How the linked session relates to the session.
linkedWorkflow DuoWorkflow Session the link points to. For a SOURCE link, the session that was restarted.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowWorkflowLinkConnection#

Paginated collection of DuoWorkflowWorkflowLink. See Standard connection fields for the fields available on every connection.

DuoWorkflowsAggregationResponse#

Response for DuoWorkflows aggregation engine.

Fields#

Name Type Description
churnedUsersCount Int Number of unique users who ran a flow in the previous period but not in this one.
closedMrCount DuoWorkflowsAggregationResponseClosedMrCountMetrics Aggregated closed_mr_count metrics.
createdMrCount DuoWorkflowsAggregationResponseCreatedMrCountMetrics Aggregated created_mr_count metrics.
creditsPerMergedMrRatio Float Credits used per Duo-created merge request that was later merged.
creditsUsed DuoWorkflowsAggregationResponseCreditsUsedMetrics Aggregated credits_used metrics.
dimensions DuoWorkflowsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
flowTypesCount Int Number of unique flow types.
joinedUsersCount Int Number of unique users who ran a flow in this period but not in the previous one.
mergedMrCount DuoWorkflowsAggregationResponseMergedMrCountMetrics Aggregated merged_mr_count metrics.
openMrCount DuoWorkflowsAggregationResponseOpenMrCountMetrics Aggregated open_mr_count metrics.
previousPeriodUsersCount Int Number of unique users in the previous period.
projectsCount Int Number of unique projects.
returningUsersCount Int Number of unique users who also ran a flow in the previous period.
totalCount Int Total number of flows, optionally filtered by status.

Arguments for totalCount:
status ([String!])
Only count flows with the given statuses (created, running, finished, failed, ...).
usersCount Int Number of unique users.

DuoWorkflowsAggregationResponseClosedMrCountMetrics#

Aggregated closed_mr_count metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Int Maximum number of merge requests created by the flow that were later closed without merging.
mean Float Mean number of merge requests created by the flow that were later closed without merging.
min Int Minimum number of merge requests created by the flow that were later closed without merging.
quantile Float Quantile of number of merge requests created by the flow that were later closed without merging.

Arguments for quantile:
quantile (Float)
sum Float Sum of number of merge requests created by the flow that were later closed without merging.

DuoWorkflowsAggregationResponseConnection#

Paginated collection of DuoWorkflowsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

DuoWorkflowsAggregationResponseCreatedMrCountMetrics#

Aggregated created_mr_count metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Int Maximum number of merge requests created by the flow.
mean Float Mean number of merge requests created by the flow.
min Int Minimum number of merge requests created by the flow.
quantile Float Quantile of number of merge requests created by the flow.

Arguments for quantile:
quantile (Float)
sum Float Sum of number of merge requests created by the flow.

DuoWorkflowsAggregationResponseCreditsUsedMetrics#

Aggregated credits_used metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Float Maximum credits used by the flow.
mean Float Mean credits used by the flow.
min Float Minimum credits used by the flow.
quantile Float Quantile of credits used by the flow.

Arguments for quantile:
quantile (Float)
sum Float Sum of credits used by the flow.

DuoWorkflowsAggregationResponseDimensions#

Response dimensions for DuoWorkflows aggregation engine.

Fields#

Name Type Description
createdAt Date Flow creation date.

Arguments for createdAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
group Group Group at the requested depth of the hierarchy. NULL for flows tracked above that depth. Flows tracked in a project at that depth bucket by project namespace ID, which also resolves to NULL.

Arguments for group:
depth (Int)
Depth in the group hierarchy, counted from the top-level group. Defaults to 1.
model DuoWorkflowsModelMetadata Model used by the flow, resolved to catalog metadata.
modelUsed String Model used by the flow.
project Project Project the flow ran in. Returns null for flows not scoped to a project.
status String Flow status.
user UserCore Flow owner.
userTier String User activity tier, bucketing users by their number of flows in the selected period using the thresholds argument.

Arguments for userTier:
thresholds ([Int!])
Ascending tier boundaries. Values below the first threshold map to tier_0, values at or above the last threshold map to the highest tier.
workflowDefinition String Type of flow.

DuoWorkflowsAggregationResponseMergedMrCountMetrics#

Aggregated merged_mr_count metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Int Maximum number of merge requests created by the flow that were later merged.
mean Float Mean number of merge requests created by the flow that were later merged.
min Int Minimum number of merge requests created by the flow that were later merged.
quantile Float Quantile of number of merge requests created by the flow that were later merged.

Arguments for quantile:
quantile (Float)
sum Float Sum of number of merge requests created by the flow that were later merged.

DuoWorkflowsAggregationResponseOpenMrCountMetrics#

Aggregated open_mr_count metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Int Maximum number of merge requests created by the flow that are still open.
mean Float Mean number of merge requests created by the flow that are still open.
min Int Minimum number of merge requests created by the flow that are still open.
quantile Float Quantile of number of merge requests created by the flow that are still open.

Arguments for quantile:
quantile (Float)
sum Float Sum of number of merge requests created by the flow that are still open.

DuoWorkflowsAggregationScope#

Aggregation scope for DuoWorkflows. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated DuoWorkflowsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

DuoWorkflowsModelMetadata#

Catalog metadata for a model used by GitLab Duo Agent Platform flows.

Fields#

Name Type Description
hosting DuoWorkflowsModelHosting Where the model is hosted. null for flows with no model attribution.
isDefault Boolean! Whether the model is a configured default for GitLab Duo Agent Platform features.
name String Display name from the model catalog, or the raw value when not in the catalog. null for flows with no model attribution.
provider String Model provider when the catalog identifies it unambiguously.

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.

EgressNodeConnection#

Paginated collection of EgressNode. See Standard connection fields for the fields available on every connection.

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.

EmailConnection#

Paginated collection of Email. See Standard connection fields for the fields available on every connection.

EmailParticipantType#

Fields#

Name Type Description
email String! Email address of the email participant. For guests, the email address is obfuscated.

EmailParticipantTypeConnection#

Paginated collection of EmailParticipantType. See Standard connection fields for the fields available on every connection.

EnabledSecurityScans#

Types of scans enabled on a merge request.

Fields#

Name Type Description
apiFuzzing Boolean! true if there is a Api fuzzing scan in the pipeline.
clusterImageScanning Boolean! true if there is a Cluster image scanning scan in the pipeline.
containerScanning Boolean! true if there is a Container scanning scan in the pipeline.
coverageFuzzing Boolean! true if there is a Coverage fuzzing scan in the pipeline.
dast Boolean! true if there is a Dast scan in the pipeline.
dependencyScanning Boolean! true if there is a Dependency scanning scan in the pipeline.
ready Boolean! Returns true when report processing has been completed.
sarif Boolean! true if there is a Sarif scan in the pipeline.
sast Boolean! true if there is a Sast scan in the pipeline.
secretDetection Boolean! true if there is a Secret detection scan in the pipeline.

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.
autoStopSetting AutoStopSetting Auto stop setting of the environment.
clusterAgent ClusterAgent Cluster agent of the environment.
createdAt Time When the environment was created.
deployFreezes [CiFreezePeriod!] Deployment freeze periods of the environment.
deployments DeploymentConnection Deployments of the environment. This field can only be resolved for one environment in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for deployments:
orderBy (DeploymentsOrderByInput)
Order by a specified field.
statuses ([DeploymentStatus!])
Statuses of the deployments.
deploymentsDisplayCount String Number of deployments in the environment for display. Returns the precise number up to 999, and "999+" for counts exceeding this limit.
description String Description of the environment.
descriptionHtml String GitLab Flavored Markdown rendering of description.
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.
lastDeployment Deployment Last deployment of the environment.

Arguments for lastDeployment:
status (DeploymentStatus!)
Status of the Deployment.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

EnvironmentConnection#

Paginated collection of Environment. See Standard connection fields for the fields available on every connection.

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.

Implements: CurrentUserTodos, Eventable, NoteableInterface, Todoable

Fields#

Name Type Description
ancestors EpicConnection Ancestors (parents) of the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ancestors:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
author UserCore! Author of the epic.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blocked Boolean Indicates the epic is blocked.
blockedByCount Int Count of epics blocking the epic.
blockedByEpics EpicConnection Epics blocking the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingCount Int Count of epics that the epic is blocking.
children EpicConnection Children (sub-epics) of the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for children:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
closedAt Time Timestamp of when the epic was closed.
color String Color of the epic.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
confidential Boolean Indicates if the epic is confidential.
createdAt Time Timestamp of when the epic was created.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
group Group! Group to which the epic belongs.
hasChildren Boolean! Indicates if the epic has children.
hasChildrenWithinTimeframe Boolean! Indicates if the epic has children in the specified timeframe.
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 String! Internal ID of the epic.
issues EpicIssueConnection A list of issues associated with the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
labels LabelConnection Labels assigned to the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems LinkedWorkItemTypeConnection Work items linked to the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedWorkItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
parent Epic Parent epic of the epic.
participants UserCoreConnection List of participants for the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
reference String! Internal reference of the epic. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Indicates if the reference should be returned in full.
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.
title String Title of the epic.
titleHtml String HTML 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.
workItemId WorkItemID! ID of the corresponding work item for a legacy epic.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
lists EpicListConnection Epic board lists. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for lists:
epicFilters (EpicFilters)
Filters applied when getting epic metadata in the epic board list.
id (BoardsEpicListID)
Find an epic board list by ID.
name String Name of the epic board.
webPath String! Web path of the epic board.
webUrl String! Web URL of the epic board.

EpicBoardConnection#

Paginated collection of EpicBoard. See Standard connection fields for the fields available on every connection.

EpicConnection#

Paginated collection of Epic. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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 GitLab 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 GitLab 16.6. Use OpenedIssuesTotal.
openedIssuesTotal BigInt Total weight of opened issues in the 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.

Implements: CurrentUserTodos, NoteableInterface, Todoable

Fields#

Name Type Description
alertManagementAlert AlertManagementAlert Deprecated in GitLab 15.6. Use alert_management_alerts.
alertManagementAlerts AlertManagementAlertConnection Alert Management alerts associated to this issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementAlerts:
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 the criteria.
statuses ([AlertManagementStatus!])
Alerts with the specified statues. For example, [TRIGGERED].
assignees UserCoreConnection Assignees of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
author UserCore! User that created the issue.
availableQuickActions [QuickActionCommand!] Quick actions available to the current user on the issue.
blocked Boolean! Indicates the issue is blocked.
blockedByCount Int Count of issues blocking the issue.
blockedByIssues IssueConnection Issues blocking the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingCount Int! Count of issues the issue is blocking.
closedAsDuplicateOf Issue Issue the issue was closed as a duplicate of.
closedAt Time Timestamp of when the issue was closed.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
customerRelationsContacts CustomerRelationsContactConnection Customer relations contacts of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String Description of the issue.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designCollection DesignCollection Collection of design images associated with the issue.
discussionLocked Boolean! Indicates discussion is locked on the issue.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
downvotes Int! Number of downvotes the issue has received.
dueDate Time Due date of the issue.
emailsDisabled Boolean! Deprecated in GitLab 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 Deprecated in GitLab 17.5. Replaced by WorkItem type.
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 as an experiment in GitLab 16.5.

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 String! Internal ID of the issue.
issuableResourceLinks IssuableResourceLinkConnection Issuable resource links of the incident issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issuableResourceLinks:
incidentId (IssueID!)
ID of the incident.
iteration Iteration Iteration of the issue.
labels LabelConnection Labels of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems LinkedWorkItemTypeConnection Introduced as an experiment in GitLab 17.8.

Work items linked to the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedWorkItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
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.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
participants UserCoreConnection List of participants in the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projectId Int ID of the issue project.
reference String! Internal reference of the issue. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Boolean option specifying whether the reference should be returned in full.
relatedMergeRequests MergeRequestConnection Merge requests related to the issue. This field can only be resolved for one issue in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
relatedVulnerabilities VulnerabilityConnection Related vulnerabilities of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
startDate Time Start date of the issue.
state IssueState! State of the issue.
status WorkItemStatus Introduced as an experiment in GitLab 18.0.

Status 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String! Title of the issue.
titleHtml String HTML 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.
workItemType WorkItemType! Type assigned to the issue.

EpicIssueConnection#

Paginated collection of EpicIssue. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
weight Int! Total weight of issues collection.

EpicList#

Represents an epic board list.

Fields#

Name Type Description
collapsed Boolean Indicates if the list is collapsed for the user.
epics EpicConnection List epics. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for epics:
filters (EpicFilters)
Filters applied when selecting epics in the board list.
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.

EpicListConnection#

Paginated collection of EpicList. See Standard connection fields for the fields available on every connection.

EpicListMetadata#

Represents epic board list metadata.

Fields#

Name Type Description
epicsCount Int Count of epics in the list.
totalWeight Int Introduced as an experiment in GitLab 14.7.

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.
adminEpicRelation Boolean! If true, the user can perform admin_epic_relation 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.

ErrorTrackingStackTrace#

Represents a stack trace.

Fields#

Name Type Description
absolutePath String Absolute path of the stack trace.
columnNumber Int Column number of the stack trace.
context [WorkItemWidgetErrorTrackingStackTraceContext!] Context of the stack trace.
filename String Filename of the stack trace.
function String Name of the function where the error occurred.
lineNumber Int Line number of the stack trace.

ErrorTrackingStackTraceConnection#

Paginated collection of ErrorTrackingStackTrace. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

EscalationPolicyTypeConnection#

Paginated collection of EscalationPolicyType. See Standard connection fields for the fields available on every connection.

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 the event.
createdAt Time! When the event was created.
id ID! ID of the event.
project Project Project of the event.
pushEventPayload PushEventPayload Payload of the push event, when the event represents a push. null for non-push events.
target EventTargetType Target of the event.
updatedAt Time! When the event was updated.

EventConnection#

Paginated collection of Event. See Standard connection fields for the fields available on every connection.

ExternalAuditEventDestination#

Represents an external resource to send audit events to.

Implements: ExternalAuditEventDestinationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

ExternalAuditEventDestinationConnection#

Paginated collection of ExternalAuditEventDestination. See Standard connection fields for the fields available on every connection.

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.
hmac Boolean! Whether or not HMAC secret is enabled for the status check.
id GlobalID! ID of the rule.
name String! Name of the rule.

ExternalStatusCheckConnection#

Paginated collection of ExternalStatusCheck. See Standard connection fields for the fields available on every connection.

FeatureFlag#

Fields#

Name Type Description
active Boolean! Whether the feature flag is active.
id OperationsFeatureFlagID! Global ID of the feature flag.
name String! Name of the feature flag.
path String! Path to feature flag.
reference String! Reference to feature flag.

FeatureFlagConnection#

Paginated collection of FeatureFlag. See Standard connection fields for the fields available on every connection.

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.

FindingDueDatesSetError#

Represents an error encountered while setting due dates for a vulnerability finding.

Fields#

Name Type Description
code String! Machine-readable error code.
findingUuid String UUID of the vulnerability finding associated with the error.
message String! Human-readable error message.

FindingReportsComparer#

Represents security reports comparison for vulnerability findings.

Fields#

Name Type Description
report ComparedSecurityReport Introduced as an experiment in GitLab 16.1.

Compared security report.
status FindingReportsComparerStatus Comparison status.
statusReason String Text explaining the status.

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.

FunctionalVerificationStatus#

Status of a GitLab Duo Agent Platform functional verification check.

Fields#

Name Type Description
message String Message describing the result of the latest failed run.
state FunctionalVerificationState! State of the verification run.
updatedAt Time Timestamp the latest run was last updated at.

GeoNode#

Fields#

Name Type Description
abuseReportUploadRegistries AbuseReportUploadRegistryConnection Introduced as an experiment in GitLab 18.10.

Find Abuse Report Upload registries on this Geo node. Ignored if geo_abuse_report_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for abuseReportUploadRegistries:
ids ([GeoAbuseReportUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
achievementUploadRegistries AchievementUploadRegistryConnection Introduced as an experiment in GitLab 18.11.

Find Achievement Upload registries on this Geo node. Ignored if geo_achievement_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for achievementUploadRegistries:
ids ([GeoAchievementUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
aiVectorizableFileUploadRegistries AiVectorizableFileUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find AI Vectorizable File Upload registries on this Geo node. Ignored if geo_ai_vectorizable_file_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiVectorizableFileUploadRegistries:
ids ([GeoAiVectorizableFileUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
alertManagementMetricImageUploadRegistries AlertManagementMetricImageUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Alert Management Metric Image Upload registries on this Geo node. Ignored if geo_alert_management_metric_image_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementMetricImageUploadRegistries:
ids ([GeoAlertManagementMetricImageUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
appearanceUploadRegistries AppearanceUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Appearance Upload registries on this Geo node. Ignored if geo_appearance_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for appearanceUploadRegistries:
ids ([GeoAppearanceUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
bulkImportExportUploadUploadRegistries BulkImportExportUploadUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find bulk import/export archive upload registries on this Geo node. Ignored if geo_bulk_import_export_upload_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for bulkImportExportUploadUploadRegistries:
ids ([GeoBulkImportExportUploadUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
checksumMismatchReportThreshold Int Number of consecutive checksum mismatches on a secondary before it reports the resource to the primary for self-heal re-verification.
checksumMismatchSelfHealCooldownMinutes Int Minimum time (in minutes) between self-heal re-verification triggers for the same resource on the primary.
ciSecureFileRegistries CiSecureFileRegistryConnection Find Ci Secure File registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ciSecureFileRegistries:
ids ([GeoCiSecureFileRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
containerRepositoriesMaxCapacity Int Maximum concurrency of container repository sync for the secondary node.
containerRepositoryRegistries ContainerRepositoryRegistryConnection Find Container Repository registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for containerRepositoryRegistries:
ids ([GeoContainerRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
dependencyListExportPartUploadRegistries DependencyListExportPartUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Dependency List Export Part Upload registries on this Geo node. Ignored if geo_dependency_list_export_part_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyListExportPartUploadRegistries:
ids ([GeoDependencyListExportPartUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
dependencyListExportUploadRegistries DependencyListExportUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Dependency List Export Upload registries on this Geo node. Ignored if geo_dependency_list_export_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyListExportUploadRegistries:
ids ([GeoDependencyListExportUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
dependencyProxyBlobRegistries DependencyProxyBlobRegistryConnection Introduced as an experiment in GitLab 15.6.

Find Dependency Proxy Blob registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyProxyBlobRegistries:
ids ([GeoDependencyProxyBlobRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
dependencyProxyManifestRegistries DependencyProxyManifestRegistryConnection Find Dependency Proxy Manifest registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyProxyManifestRegistries:
ids ([GeoDependencyProxyManifestRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
designManagementActionUploadRegistries DesignManagementActionUploadRegistryConnection Introduced as an experiment in GitLab 18.11.

Find Design Management Action Upload registries on this Geo node. Ignored if geo_design_management_action_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for designManagementActionUploadRegistries:
ids ([GeoDesignManagementActionUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
designManagementRepositoryRegistries DesignManagementRepositoryRegistryConnection Introduced as an experiment in GitLab 16.1.

Find Design Management Repository registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for designManagementRepositoryRegistries:
ids ([GeoDesignManagementRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
enabled Boolean Indicates whether the Geo node is enabled.
filesMaxCapacity Int Maximum concurrency of LFS/attachment backfill for the secondary node.
groupUploadRegistries GroupUploadRegistryConnection Introduced as an experiment in GitLab 18.11.

Find Group Upload registries on this Geo node. Ignored if geo_group_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groupUploadRegistries:
ids ([GeoGroupUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
groupWikiRepositoryRegistries GroupWikiRepositoryRegistryConnection Find group wiki repository registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groupWikiRepositoryRegistries:
ids ([GeoGroupWikiRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
id ID! ID of the GeoNode.
importExportUploadUploadRegistries ImportExportUploadUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find import/export archive upload registries on this Geo node. Ignored if geo_import_export_upload_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for importExportUploadUploadRegistries:
ids ([GeoImportExportUploadUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
internalUrl String URL defined on the primary node secondary nodes should use to contact it.
issuableMetricImageUploadRegistries IssuableMetricImageUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Issuable Metric Image Upload registries on this Geo node. Ignored if geo_issuable_metric_image_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issuableMetricImageUploadRegistries:
ids ([GeoIssuableMetricImageUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
jobArtifactRegistries JobArtifactRegistryConnection Find Job Artifact registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobArtifactRegistries:
ids ([GeoJobArtifactRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
lfsObjectRegistries LfsObjectRegistryConnection Find LFS object registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for lfsObjectRegistries:
ids ([GeoLfsObjectRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
mergeRequestDiffRegistries MergeRequestDiffRegistryConnection Find merge request diff registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequestDiffRegistries:
ids ([GeoMergeRequestDiffRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
minimumReverificationInterval Int Interval (in days) in which the repository verification is valid. After expiry, it is reverted.
name String Unique identifier for the Geo node.
organizationDetailUploadRegistries OrganizationDetailUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Organization Detail Upload registries on this Geo node. Ignored if geo_organization_detail_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizationDetailUploadRegistries:
ids ([GeoOrganizationDetailUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
packageFileRegistries PackageFileRegistryConnection Package file registries of the GeoNode. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packageFileRegistries:
ids ([GeoPackageFileRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
packagesDebianProjectComponentFileRegistries PackagesDebianProjectComponentFileRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Debian Project Component File registries on this Geo node. Ignored if geo_packages_debian_project_component_file_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packagesDebianProjectComponentFileRegistries:
ids ([GeoPackagesDebianProjectComponentFileRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
packagesHelmMetadataCacheRegistries PackagesHelmMetadataCacheRegistryConnection Find Helm Metadata Cache registries on this Geo node. Ignored if geo_packages_helm_metadata_cache_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packagesHelmMetadataCacheRegistries:
ids ([GeoPackagesHelmMetadataCacheRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
packagesNugetSymbolRegistries PackagesNugetSymbolRegistryConnection Find Packages::Nuget::Symbols registries on this Geo node. Ignored if geo_packages_nuget_symbol_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packagesNugetSymbolRegistries:
ids ([GeoPackagesNugetSymbolRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
pagesDeploymentRegistries PagesDeploymentRegistryConnection Find Pages Deployment registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pagesDeploymentRegistries:
ids ([GeoPagesDeploymentRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
personalSnippetUploadRegistries PersonalSnippetUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Personal Snippet Upload registries on this Geo node. Ignored if geo_personal_snippet_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalSnippetUploadRegistries:
ids ([GeoPersonalSnippetUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
pipelineArtifactRegistries PipelineArtifactRegistryConnection Find pipeline artifact registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineArtifactRegistries:
ids ([GeoPipelineArtifactRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
primary Boolean Indicates whether the Geo node is the primary.
projectImportExportRelationExportUploadUploadRegistries ProjectImportExportRelationExportUploadUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find Relation Export File Upload registries on this Geo node. Ignored if geo_project_import_export_relation_export_upload_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectImportExportRelationExportUploadUploadRegistries:
ids ([GeoProjectImportExportRelationExportUploadUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
projectRepositoryRegistries ProjectRepositoryRegistryConnection Find Project registries on this Geo node. Ignored if geo_project_repository_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectRepositoryRegistries:
ids ([GeoProjectRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
projectTopicUploadRegistries ProjectTopicUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Project Topic Upload registries on this Geo node. Ignored if geo_project_topic_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectTopicUploadRegistries:
ids ([GeoProjectTopicUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
projectUploadRegistries ProjectUploadRegistryConnection Introduced as an experiment in GitLab 18.10.

Find Project Upload registries on this Geo node. Ignored if geo_project_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectUploadRegistries:
ids ([GeoProjectUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
projectWikiRepositoryRegistries ProjectWikiRepositoryRegistryConnection Find Project Wiki Repository registries on this Geo node. Ignored if geo_project_wiki_repository_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectWikiRepositoryRegistries:
ids ([GeoProjectWikiRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
reposMaxCapacity Int Maximum concurrency of repository backfill for the secondary node.
selectiveSyncNamespaces NamespaceConnection Namespaces that should be synced, if selective_sync_type == namespaces. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
snippetRepositoryRegistries SnippetRepositoryRegistryConnection Find snippet repository registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippetRepositoryRegistries:
ids ([GeoSnippetRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
syncObjectStorage Boolean Indicates if the secondary node will replicate blobs in Object Storage.
terraformStateVersionRegistries TerraformStateVersionRegistryConnection Find terraform state version registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for terraformStateVersionRegistries:
ids ([GeoTerraformStateVersionRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
uploadRegistries UploadRegistryConnection Find Upload registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for uploadRegistries:
ids ([GeoUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
url String User-facing URL for the Geo node.
userPermissionExportUploadUploadRegistries UserPermissionExportUploadUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find User Permission Export File Upload registries on this Geo node. Ignored if geo_user_permission_export_upload_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userPermissionExportUploadUploadRegistries:
ids ([GeoUserPermissionExportUploadUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
userUploadRegistries UserUploadRegistryConnection Introduced as an experiment in GitLab 18.11.

Find User Upload registries on this Geo node. Ignored if geo_user_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userUploadRegistries:
ids ([GeoUserUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
verificationMaxCapacity Int Maximum concurrency of repository verification for the secondary node.
vulnerabilityArchiveExportUploadRegistries VulnerabilityArchiveExportUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find Vulnerability Archive Export Upload registries on this Geo node. Ignored if geo_vulnerability_archive_export_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityArchiveExportUploadRegistries:
ids ([GeoVulnerabilityArchiveExportUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
vulnerabilityExportPartUploadRegistries VulnerabilityExportPartUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Vulnerability Export Part Upload registries on this Geo node. Ignored if geo_vulnerability_export_part_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityExportPartUploadRegistries:
ids ([GeoVulnerabilityExportPartUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
vulnerabilityExportUploadRegistries VulnerabilityExportUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find Vulnerability Export Upload registries on this Geo node. Ignored if geo_vulnerability_export_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityExportUploadRegistries:
ids ([GeoVulnerabilityExportUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
vulnerabilityRemediationUploadRegistries VulnerabilityRemediationUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Vulnerability Remediation Upload registries on this Geo node. Ignored if geo_vulnerability_remediation_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityRemediationUploadRegistries:
ids ([GeoVulnerabilityRemediationUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.

GitlabInstanceFeatureFlag#

A feature flag for the GitLab instance.

Fields#

Name Type Description
enabled Boolean! Indicates whether the GitLab instance feature flag is enabled or not.
name String! Name of the GitLab instance feature flag.

GitlabSubscriptionBudgetCapUserOverride#

Per-user budget cap override.

Fields#

Name Type Description
cap Float! Budget cap amount for the user.
capEnabled Boolean! Whether the budget cap is enabled for the user.
createdAt Time When the override was created.
updatedAt Time When the override was last updated.
user UserCore GitLab user the override applies to.

GitlabSubscriptionBudgetCapUserOverrideConnection#

Paginated collection of GitlabSubscriptionBudgetCapUserOverride. See Standard connection fields for the fields available on every connection.

GitlabSubscriptionBudgetCaps#

Budget cap controls for a subscription.

Fields#

Name Type Description
flatUserCap Float Default per-user budget cap applied to all users.
flatUserCapEnabled Boolean Whether the flat per-user budget cap is enabled.
subscriptionCap Float Maximum budget cap for the subscription.
subscriptionCapEnabled Boolean Whether the subscription-level budget cap is enabled.
userOverrides GitlabSubscriptionBudgetCapUserOverrideConnection Per-user budget cap overrides. CDot returns a maximum of 20 overrides per page. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userOverrides:
userIds ([UserID!])
Filter overrides to specific users.

GitlabSubscriptionDailyUsage#

Describes daily the usage of GitLab Credits.

Fields#

Name Type Description
creditsUsed Float! GitLab Credits consumed on the date.
date ISO8601Date! Date when credits were used.

GitlabSubscriptionHistory#

Describes the subscription history of a given namespace.

Fields#

Name Type Description
changeType SubscriptionHistoryChangeType Indicates what type of change in the subscription has happened.
createdAt Time Timestamp of the subscription history entry creation.
endDate Time Subscription end date.
maxSeatsUsed Int Maximum seats used in subscription.
seats Int Seats purchased in subscription.
seatsInUse Int Seats being used in subscription.
startDate Time Subscription start date.

GitlabSubscriptionHistoryConnection#

Paginated collection of GitlabSubscriptionHistory. See Standard connection fields for the fields available on every connection.

GitlabSubscriptionMonthlyCommitment#

Describes the usage of GitLab Credits for the subscription's monthly commitment.

Fields#

Name Type Description
creditsUsed Float Total of GitLab Credits consumed from the subscription's monthly commitment.
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily usage of the subscription's monthly commitment.
totalCredits Float Total of GitLab Credits allocated as a subscription's monthly commitment.

GitlabSubscriptionMonthlyWaiver#

GitLab Credits used from the Monthly Waiver allocation.

Fields#

Name Type Description
creditsUsed Float GitLab Credits used from the Monthly Waiver allocation.
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily usage of the Monthly Waiver allocation.
totalCredits Float Total of GitLab Credits allocated as Monthly Waiver.

GitlabSubscriptionOverage#

Describes the overage of consumables for the subscription.

Fields#

Name Type Description
creditsUsed Float Overage consumed by the subscription.
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily overage usage.
isAllowed Boolean Whether GitLab Credits overage is allowed for the subscription.

GitlabSubscriptionPaidTierTrial#

Describes paid tier trial information for the subscription.

Fields#

Name Type Description
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily usage of the subscription's paid tier trial.
isActive Boolean! Indicates whether the subscription is currently in a paid tier trial for GitLab Credits.

GitlabSubscriptionUsage#

Describes the usage of consumables under the subscription.

Fields#

Name Type Description
budgetCaps GitlabSubscriptionBudgetCaps Budget cap controls for the subscription.
canAcceptOverageTerms Boolean! Indicates whether the subscription is currently eligible to accept overage terms.
creditsUsed Float Total credits used for the subscription.
dailyAverage Float Average daily credits used for the subscription.
dailyUsage [GitlabSubscriptionDailyUsage!] Daily usage for the subscription.

Arguments for dailyUsage:
limit (Int)
Maximum number of daily usage entries to return. Defaults to every day in the date range.
sort (DailyUsageSort)
Sort daily usage entries by the selected criteria.
dapPromoEnabled Boolean! Indicates whether the Duo AI promo (DAP) is enabled for the subscription.
enabled Boolean! Indicates if the Customer Portal GitLab Credits API is enabled.
endDate ISO8601Date End date of the period covered by the usage data.
isOutdatedClient Boolean Indicates if the GitLab instance has an outdated API contract with the Customer Portal.
lastEventTransactionAt ISO8601DateTime Date and time when the last usage event resulted in a wallet transaction.
monthlyCommitment GitlabSubscriptionMonthlyCommitment Monthly commitment usage for the subscription.
monthlyWaiver GitlabSubscriptionMonthlyWaiver Monthly waiver usage for the subscription.
nonBillableUsage [GitlabSubscriptionUsageNonBillableUsage!] GitLab Credits usage that was not billed, grouped by product and skip reason. Not included in creditsUsed or dailyUsage. Null when the usage cannot be read.
overage GitlabSubscriptionOverage Overage statistics.
overageTermsAccepted Boolean! Indicates whether overage terms have been accepted for the subscription.
paidTierTrial GitlabSubscriptionPaidTierTrial! Paid tier trial data for the subscription.
products [GitlabSubscriptionUsageProduct!] All supported products with their associated flow types.
purchaseCreditsPath String URL to purchase GitLab Credits.
startDate ISO8601Date Start date of the period covered by the usage data.
subscriptionPortalUsageDashboardUrl String Full URL to the GitLab Credits usage dashboard in the Customer Portal.
usersUsage GitlabSubscriptionUsageUsersUsage Consumption usage for users under the subscription.

GitlabSubscriptionUsageBlockedStatus#

Describes the blocked status of a user under the subscription budget cap.

Fields#

Name Type Description
blocked Boolean! Whether the user is blocked from using credits due to reaching their cap.
capType GitlabSubscriptionUsageBlockedCapType Type of cap that caused the block. Null when not blocked.

GitlabSubscriptionUsageFlowTypeInfo#

Information about a GitLab Credits flow type.

Fields#

Name Type Description
id String! Identifier for the flow type, used for filtering.
title String! Display name for the flow type.

GitlabSubscriptionUsageNonBillableUsage#

GitLab Credits usage that was not billed, for one product and skip reason.

Fields#

Name Type Description
dailyUsage [GitlabSubscriptionDailyUsage!]! Daily non-billable GitLab Credits for the product and skip reason.
productId String! Identifier of the product the usage belongs to. Matches GitlabSubscriptionUsageProduct.id.
skipReason String Reason the usage was not billed, as recorded on the usage event. Null when the event has no recorded reason.
totalCreditsUsed Float! Total non-billable GitLab Credits for the product and skip reason in the date range.

GitlabSubscriptionUsageProduct#

A product with GitLab Credits usage.

Fields#

Name Type Description
creditsUsed Float Total GitLab Credits consumed for the product.
flowTypes [GitlabSubscriptionUsageProductFlowType!]! Flow types belonging to the product.
id String! Identifier for the product.
title String! Display name for the product.

GitlabSubscriptionUsageProductFlowType#

A flow type within a product for GitLab Credits usage.

Fields#

Name Type Description
id String! Identifier for the flow type.
title String! Display name for the flow type.

GitlabSubscriptionUsageUser#

Describes the user with their usage data.

Fields#

Name Type Description
avatarUrl String URL of the user's avatar.
blockedStatus GitlabSubscriptionUsageBlockedStatus Blocked status of the user under the subscription budget cap.
entityType String Type of consumer for the user usage.
events GitlabSubscriptionUsageUserEventConnection Billable events from the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
flowTypes ([String])
Filter events by one or more flow type IDs.
id UserID! Global ID of the user.
name String! Human-readable name of the user.
usage GitlabSubscriptionUsageUserUsage Usage of consumables for a user under the subscription.
usedFlowTypes [GitlabSubscriptionUsageFlowTypeInfo!] Flow types used by the user during the billing period.
username String! Username of the user. Unique within the instance of GitLab.

GitlabSubscriptionUsageUserConnection#

Paginated collection of GitlabSubscriptionUsageUser. See Standard connection fields for the fields available on every connection.

GitlabSubscriptionUsageUserEvent#

Describes a usage event for the subscription.

Fields#

Name Type Description
creditsUsed Float GitLab Credits consumed on the date.
eventType String Event type.
flowType String User-friendly display name for the event flow type.
location GitlabSubscriptionUsageEventLocation Event location: project or namespace.
locationId GlobalID Global ID of the event location. Populated even when the referenced record is deleted or not visible to the user, unlike location. When both fields are present, they identify the same record.
sessionLink String URL of the agent session associated with the event.
timestamp ISO8601DateTime Date and time of the event.

GitlabSubscriptionUsageUserEventConnection#

Paginated collection of GitlabSubscriptionUsageUserEvent. See Standard connection fields for the fields available on every connection.

GitlabSubscriptionUsageUserUsage#

Describes the usage of consumables for a user under the subscription.

Fields#

Name Type Description
creditsUsed Float GitLab Credits used by the user.
monthlyCommitmentCreditsUsed Float Monthly Commitment GitLab Credits used by the user.
monthlyWaiverCreditsUsed Float Monthly Waiver GitLab Credits used by the user.
overageCreditsUsed Float Overage GitLab Credits used by the user.
paidTierTrialCreditsUsed Float Paid Tier Trial GitLab Credits used by the user.
totalCredits Float Total GitLab Credits available for the user.
totalCreditsUsed Float Total GitLab Credits used by the user across all wallets.

GitlabSubscriptionUsageUsersUsage#

Describes the usage of consumables by users under the subscription.

Fields#

Name Type Description
creditsUsed Float GitLab Credits used by consumers of the subscription.
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily usage of GitLab Credits.
totalActiveUsers Int Total number of users with usage in the subscription.
totalUsersUsingCredits Int Total number of users consuming GitLab Credits from their included allocation.
totalUsersUsingMonthlyCommitment Int Total number of users consuming GitLab Credits from the subscription monthly commitment.
totalUsersUsingOverage Int Total number of users consuming overage.
users GitlabSubscriptionUsageUserConnection List of users with their usage data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for users:
searchQuery (String)
Filter users with a matching name, username, or email. Ignored when username is provided or when sorting by total credits used.
sort (GitlabSubscriptionUsageUserSort)
Sort users by the criteria.
username (String)
Username of the User.

GitlabSubscriptionUserCreditsUsage#

GitLab Credits usage for the current user.

Fields#

Name Type Description
blockedStatus GitlabSubscriptionUsageBlockedStatus Blocked status of the current user under the subscription budget cap.
creditsUsed Float Total GitLab Credits consumed by the current user.
dailyUsage [GitlabSubscriptionUserCreditsUsageDailyUsage!] Daily GitLab Credits usage for the current user.
enabled Boolean! Indicates if the Customer Portal GitLab Credits API is enabled.
endDate ISO8601Date End date of the period covered by the usage data.
isOutdatedClient Boolean Indicates if the GitLab instance has an outdated API contract with the Customer Portal.
products [GitlabSubscriptionUserCreditsUsageProduct!] All supported products with their associated flow types.
startDate ISO8601Date Start date of the period covered by the usage data.
usedFlowTypes [GitlabSubscriptionUsageFlowTypeInfo!] Flow types the current user consumed credits under during the period.

GitlabSubscriptionUserCreditsUsageDailyUsage#

Daily GitLab Credits usage for the current user.

Fields#

Name Type Description
creditsUsed Float! GitLab Credits consumed by the current user on the date.
date ISO8601Date! Date when credits were used.

GitlabSubscriptionUserCreditsUsageProduct#

A product with its flow types.

Fields#

Name Type Description
flowTypes [GitlabSubscriptionUsageFlowTypeInfo!]! Flow types belonging to the product.
id String! Identifier for the product.
title String! Display name for the product.

GitlabTrialUsage#

Describes the usage and details of a trial subscription.

Fields#

Name Type Description
activeTrial ActiveTrial Active trial information if the subscription has an active trial.
usersUsage TrialUsage Trial usage statistics for users.

GitlabTrialUsageUser#

Describes the user with their trial usage data.

Fields#

Name Type Description
avatarUrl String URL of the user's avatar.
id UserID! Global ID of the user.
name String! Human-readable name of the user.
usage GitlabTrialUsageUserUsage Credit usage for a user during a trial.
username String! Username of the user. Unique within the instance of GitLab.

GitlabTrialUsageUserConnection#

Paginated collection of GitlabTrialUsageUser. See Standard connection fields for the fields available on every connection.

GitlabTrialUsageUserUsage#

Describes any credit usage for a user during a trial.

Fields#

Name Type Description
creditsUsed Float GitLab Credits consumed by the user during a trial.
totalCredits Float Total GitLab Credits available to the user during a trial.

GoogleCloudArtifactRegistryArtifactConnection#

Paginated collection of GoogleCloudArtifactRegistryArtifact. See Standard connection fields for the fields available on every connection.

GoogleCloudArtifactRegistryDockerImage#

Represents a docker artifact of Google Artifact Registry.

Fields#

Name Type Description
digest String! Image's digest.
image String! Image's name.
name String! Unique image name.
tags [String!] Tags attached to the image.
updateTime Time Time when the image was last updated.
uploadTime Time Time when the image was uploaded.
uri String! Google Cloud URI to access the image.

GoogleCloudArtifactRegistryDockerImageDetails#

Represents details about docker artifact of Google Artifact Registry.

Fields#

Name Type Description
artifactRegistryImageUrl String! Google Cloud URL to access the image.
buildTime Time Time when the image was built.
digest String! Image's digest.
image String! Image's name.
imageSizeBytes String Calculated size of the image.
location String! Location of the Artifact Registry repository.
mediaType String Media type of the image.
name String! Unique image name.
projectId String! ID of the Google Cloud project.
repository String! Repository on the Google Artifact Registry.
tags [String!] Tags attached to the image.
updateTime Time Time when the image was last updated.
uploadTime Time Time when the image was uploaded.
uri String! Google Cloud URI to access the image.

GoogleCloudArtifactRegistryRepository#

Represents a repository of Google Artifact Registry.

Fields#

Name Type Description
artifactRegistryRepositoryUrl String! Google Cloud URL to access the repository.
artifacts GoogleCloudArtifactRegistryArtifactConnection Google Artifact Registry repository artifacts. Returns null if GitLab.com feature is unavailable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for artifacts:
sort (GoogleCloudArtifactRegistryArtifactsSort)
Criteria to sort artifacts by.
projectId String! ID of the Google Cloud project.
repository String! Repository on the Google Artifact Registry.

GoogleCloudLoggingConfigurationType#

Stores Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Implements: GoogleCloudLoggingConfigurationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
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.

GoogleCloudLoggingConfigurationTypeConnection#

Paginated collection of GoogleCloudLoggingConfigurationType. See Standard connection fields for the fields available on every connection.

GovernPolicy#

Policy stored in the policy store.

Fields#

Name Type Description
actions [JSON!] Introduced as an experiment in GitLab 19.4.

Actions of the policy.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of when the policy was created.
description String Introduced as an experiment in GitLab 19.4.

Description of the policy.
id Int! Introduced as an experiment in GitLab 19.4.

ID of the policy.
lifecycleState String Introduced as an experiment in GitLab 19.4.

Lifecycle state of the policy.
mode String Introduced as an experiment in GitLab 19.4.

Enforcement mode of the policy.
name String! Introduced as an experiment in GitLab 19.4.

Name of the policy.
namespaceId Int Introduced as an experiment in GitLab 19.4.

ID of the namespace the policy is scoped to. Null for organization-wide policies.
organizationId Int! Introduced as an experiment in GitLab 19.4.

ID of the organization the policy belongs to.
policyRego String Introduced as an experiment in GitLab 19.4.

Rego program merged from the compiled rules. Null when the rules cannot be merged.
policyScope JSON Introduced as an experiment in GitLab 19.4.

Scope of the policy.
rules [JSON!] Introduced as an experiment in GitLab 19.4.

Rules of the policy.
scopeDimensions [String!] Introduced as an experiment in GitLab 19.4.

Dotted context paths scopeRego reads to decide whether the policy applies. Null when scopeRego was authored directly instead of compiled from policyScope.
scopeRego String Introduced as an experiment in GitLab 19.4.

Rego expression scoping the policy. Mutually exclusive with policyScope.
triggerType String! Introduced as an experiment in GitLab 19.4.

Trigger the policy responds to.
updatedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of when the policy was last updated.
version Int Introduced as an experiment in GitLab 19.4.

Version of the policy.

GovernPolicyConnection#

Paginated collection of GovernPolicy. See Standard connection fields for the fields available on every connection.

GovernPolicyEvaluation#

Recorded evaluation of a policy stored in the policy store.

Fields#

Name Type Description
environmentId Int Introduced as an experiment in GitLab 19.4.

ID of the environment the evaluation ran for. Null when the evaluation was not scoped to an environment.
evaluatedAt Time! Introduced as an experiment in GitLab 19.4.

Timestamp of when the policy was evaluated.
id GovernPolicyEvaluationID! Introduced as an experiment in GitLab 19.4.

Global ID of the evaluation.
mode GovernPolicyEvaluationMode! Introduced as an experiment in GitLab 19.4.

Enforcement mode of the policy at the time of the evaluation.
policyId Int! Introduced as an experiment in GitLab 19.4.

ID of the policy that was evaluated.
policyVersion Int! Introduced as an experiment in GitLab 19.4.

Version of the policy at the time of the evaluation.
projectId Int Introduced as an experiment in GitLab 19.4.

ID of the project the evaluation ran for. Null when the evaluation was not scoped to a project.
triggerType GovernPolicyEvaluationTriggerType! Introduced as an experiment in GitLab 19.4.

Trigger that started the evaluation.
userId Int Introduced as an experiment in GitLab 19.4.

ID of the user whose operation triggered the evaluation. Null when the evaluation was not triggered by a user.
verdict GovernPolicyEvaluationVerdict! Introduced as an experiment in GitLab 19.4.

Verdict the evaluation produced.
violations [GovernPolicyViolation!] Introduced as an experiment in GitLab 19.4.

Violations the evaluation produced.

GovernPolicyEvaluationConnection#

Paginated collection of GovernPolicyEvaluation. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

GovernPolicyViolation#

Violation a policy evaluation produced.

Fields#

Name Type Description
createdAt Time! Introduced as an experiment in GitLab 19.4.

Timestamp of when the violation was recorded.
details JSON Introduced as an experiment in GitLab 19.4.

Details of the violation.
id GovernPolicyViolationID! Introduced as an experiment in GitLab 19.4.

Global ID of the violation.

GpgSignature#

GPG signature for a signed commit.

Implements: CommitSignature

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#

Implements: GroupInterface, Todoable

Fields#

Name Type Description
achievements AchievementConnection Achievements for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for achievements:
ids ([AchievementsAchievementID!])
Filter achievements by IDs.
achievementsPath String Path for the namespace's achievements. Returns null if the namespace is not a group.
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.
addOnEligibleUsers AddOnUserConnection Introduced as an experiment in GitLab 16.5.

Users in the namespace hierarchy that add-ons are applicable for. This only applies to root namespaces. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for addOnEligibleUsers:
addOnPurchaseIds ([GitlabSubscriptionsAddOnPurchaseID!]!)
Global IDs of the add on purchases to find assignments for.
addOnType (GitlabSubscriptionsAddOnType!)
Type of add on to filter the eligible users by.
filterByAssignedSeat (String)
Filter users list by assigned seat.
search (String)
Search the user list.
sort (GitlabSubscriptionsUserSort)
Sort the user list.
additionalPurchasedStorageSize Float Additional storage purchased for the root namespace in bytes.
adminEditPath String Admin path for editing group. Only available to admins.
adminShowPath String Admin path of the group. Only available to admins.
aiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events are stored for the group.
aiDomainSettings StringConnection Introduced as an experiment in GitLab 19.0.

List of allowed or denied domains for AI features. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiDomainSettings:
domainSettingType (AiDomainSettingType!)
Type of domain setting to retrieve.
search (String)
Filter domains by substring match.
aiGovernanceMetrics AiGovernanceMetrics Introduced as an experiment in GitLab 19.3.

Aggregated AI governance dashboard metrics. Returns null when the ai_governance_dashboard feature flag is disabled.

Arguments for aiGovernanceMetrics:
agentClass (AiGovernanceAgentClass)
Agent class to segment the metrics by. Defaults to ALL.
timeframe (AiGovernanceMetricsTimeframe)
Time window for the metrics. Defaults to LAST_7_DAYS.
aiGovernanceSessions AiGovernanceSessionConnection Introduced as an experiment in GitLab 19.5.

AI sessions for the group, from GitLab Duo and external agents. Returns no sessions when the ai_governance_sessions_api feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiGovernanceSessions:
agentClass (AiGovernanceAgentClass)
Filter sessions by agent class. Defaults to all agent classes.
flowType (String)
Filter by flow type.
id (AiGovernanceSessionID)
Global ID of the session.
not (AiGovernanceSessionNegatedFilterInput)
Negated filter conditions.
projectPath (String)
Filter by project full path.
sessionStartedAfter (Time)
Return sessions started at or after the timestamp.
sessionStartedBefore (Time)
Return sessions started at or before the timestamp.
triggeredByUserId (UserID)
Filter to sessions triggered by the user with the given global ID.
aiGovernanceToolCalls AiGovernanceToolCallsReport Introduced as an experiment in GitLab 19.5.

Top tools invoked by AI agents, with invocation counts. Returns null when the ai_governance_dashboard or ai_governance_tool_calls feature flag is disabled or when ClickHouse is not enabled.

Arguments for aiGovernanceToolCalls:
agentClass (AiGovernanceAgentClass)
Agent class to segment the tool calls by. Defaults to ALL.
timeframe (AiGovernanceMetricsTimeframe)
Time window for the tool calls. Defaults to LAST_7_DAYS.
aiMetrics AiMetrics Introduced as an experiment in GitLab 16.11.

AI-related metrics.

Arguments for aiMetrics:
endDate (Date)
Date range to end at. Default is the end of current month.
startDate (Date)
Date range to start from. Default is the beginning of current month.
aiSettings AiNamespaceSettings Introduced as an experiment in GitLab 18.8.

AI settings for the namespace.
aiUsageData AiUsageData Introduced as an experiment in GitLab 17.5.

AI-related data.
aiUserMetrics AiUserMetricsConnection Introduced as an experiment in GitLab 17.5.

AI-related user metrics. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiUserMetrics:
endDate (Date)
Date range to end at. Default is the end of current month. ClickHouse needs to be enabled when passing this param.
sort (AiUserMetricsSort)
Sort AI user metrics.
startDate (Date)
Date range to start from. Default is the beginning of current month. ClickHouse needs to be enabled when passing this param.
allowStaleRunnerPruning Boolean! Indicates whether to regularly prune stale group runners. Defaults to false.
amazonS3Configurations AmazonS3ConfigurationTypeConnection Deprecated in GitLab 18.10. Use externalAuditEventStreamingDestinations with amazonS3 category instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
analytics Analytics Introduced as an experiment in GitLab 18.11.

Group analytics aggregation endpoints.
analyzerStatuses [AnalyzerGroupStatusType!] Status for all analyzers in the group.
approvalPolicies ApprovalPolicyConnection Approval Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for approvalPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
archived Boolean Indicates if the group or any ancestor is archived.
autoDevopsEnabled Boolean Indicates whether Auto DevOps is enabled for all projects within the group.
autocompleteUsers [AutocompletedUser!] Search users for autocompletion.

Arguments for autocompleteUsers:
search (String)
Query to search users by name, username, or public email.
availableFeatures NamespaceAvailableFeatures! Introduced as an experiment in GitLab 18.3.

Features available on the namespace.
availableSecurityScanProfiles [ScanProfileType!] Introduced as an experiment in GitLab 18.8.

Security scan profiles available for the group.

Arguments for availableSecurityScanProfiles:
gitlabRecommended (Boolean)
Filter scan profiles by GitLab Recommended.
type (SecurityScanProfileType)
Filter scan profiles by type.
avatarUrl String Avatar URL of the group.
billableMembersCount Int Number of billable users in the group.

Arguments for billableMembersCount:
requestedHostedPlan (String)
Plan from which to get billable members.
board Board A single board of the group.

Arguments for board:
id (BoardID!)
ID of the board.
boards BoardConnection Boards of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for boards:
id (BoardID)
Find a board by its ID.
builtInProjectTemplatesEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates whether built-in project templates are available for new projects in the group.
canPushInitialCommit Boolean! Introduced as an experiment in GitLab 18.11.

Whether the current user can push the initial commit to the default branch of new projects in the namespace.
ciCdSettings CiCdSettings Introduced as an experiment in GitLab 17.9.

Namespace CI/CD settings for the namespace.
ciQueueingHistory QueueingDelayHistory Time taken for CI jobs to be picked up by this group's runners by percentile. Available to users with Maintainer role for the group. Enable the ClickHouse database backend to use this query.

Arguments for ciQueueingHistory:
fromTime (Time)
Start of the requested time. Defaults to three hours ago.
toTime (Time)
End of the requested time. Defaults to the current time.
ciVariables CiGroupVariableConnection List of the group's CI/CD variables. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ciVariables:
sort (CiVariableSort)
Sort order of results.
clusterAgents ClusterAgentConnection Cluster agents associated with projects in the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for clusterAgents:
hasRemoteDevelopmentAgentConfig (Boolean)
Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled (Boolean)
Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities (Boolean)
Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig (Boolean)
Returns only cluster agents which have an associated workspaces agent config.
codeCoverageActivities CodeCoverageActivityConnection Represents the code coverage activity for this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for codeCoverageActivities:
startDate (Date!)
First day for which to fetch code coverage activity (maximum time window is set to 90 days).
complianceFrameworkCoverageSummary ComplianceFrameworkCoverageSummary Introduced as an experiment in GitLab 18.1.

Summary of compliance framework coverage in a group and its subgroups.
complianceFrameworks ComplianceFrameworkConnection Compliance frameworks available to projects in this namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceFrameworks:
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.
sort (ComplianceFrameworkSort)
Sort compliance frameworks by the criteria.
complianceFrameworksCoverageDetails ComplianceFrameworkCoverageDetailConnection Introduced as an experiment in GitLab 18.1.

Detailed compliance framework coverage for each framework in the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
complianceFrameworksNeedingAttention ComplianceFrameworksNeedingAttentionConnection Introduced as an experiment in GitLab 18.2.

Frameworks missing either project assignments or requirements definitions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
complianceRequirementControlCoverage RequirementControlCoverage Introduced as an experiment in GitLab 18.1.

Compliance control status summary showing count of passed, failed, and pending controls.
complianceRequirementCoverage RequirementCoverage Introduced as an experiment in GitLab 18.2.

Compliance requirement coverage statistics for the group.
componentVersions ComponentVersionConnection! Introduced as an experiment in GitLab 18.0.

Find software dependency versions by component name. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for componentVersions:
componentName (String!)
Name of the SBoM component.
components [Component!] Introduced as an experiment in GitLab 17.5.

Find software dependencies by name.

Arguments for components:
name (String)
Entire name or part of the name.
contactStateCounts ContactStateCounts Counts of contacts by state for the group.

Arguments for contactStateCounts:
search (String)
Search term to find contacts with.
state (CustomerRelationsContactState)
State of the contacts to search for.
contacts CustomerRelationsContactConnection Find contacts of this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contacts:
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.
containerRepositories ContainerRepositoryConnection Container repositories of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for containerRepositories:
name (String)
Filter the container repositories by their name.
sort (ContainerRepositorySort)
Sort container repositories by the criteria.
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.
contributions ContributionAnalyticsContributionConnection Provides the aggregated contributions by users within the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributions:
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.
createdAt Time Timestamp of the group creation.
crossProjectPipelineAvailable Boolean! Indicates if the cross_project_pipeline feature is available for the namespace.
customAttributes [CustomAttribute!] Custom attributes of the group. Only available to admins.
customEmoji CustomEmojiConnection Custom emoji in this namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customEmoji:
includeAncestorGroups (Boolean)
Includes custom emoji from parent groups.
customField CustomField Introduced as an experiment in GitLab 17.6.

A custom field configured for the group.

Arguments for customField:
id (IssuablesCustomFieldID!)
Global ID of the custom field.
customFields CustomFieldConnection Introduced as an experiment in GitLab 17.5.

Custom fields configured for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customFields:
active (Boolean)
Filter for active fields. If false, excludes active fields. If true, returns only active fields.
fieldType (CustomFieldType)
Filter for selected field type.
search (String)
Search query for custom field name.
workItemTypeId (WorkItemsTypeID)
Filter custom fields associated to the given work item type.
customizableDashboardVisualizations CustomizableDashboardVisualizationConnection Visualizations of the group or associated configuration project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customizableDashboardVisualizations:
slug (String)
Slug of the visualization to return.
customizableDashboards CustomizableDashboardConnection Customizable dashboards for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customizableDashboards:
category (CustomizableDashboardCategory)
Find by dashboard type.
slug (String)
Find by dashboard slug.
dataTransfer GroupDataTransfer Data transfer data point for a specific period. This is mocked data under a development feature flag.

Arguments for dataTransfer:
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.
dependencies DependencyConnection Software dependencies used by projects under this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencies:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
dependencyAggregations DependencyAggregationConnection Introduced as an experiment in GitLab 18.0.

Software dependencies used by projects under this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyAggregations:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
projectCountMax (Int)
Filter dependencies by maximum project count.
projectCountMin (Int)
Filter dependencies by minimum project count.
projectIds ([ProjectID!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by projects within the group.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
dependencyFirewallActivitySummary DependencyFirewallActivitySummary Introduced as an experiment in GitLab 19.3.

Aggregate dependency firewall activity totals for the group. Available behind the dependency_firewall_phase1 feature flag.

Arguments for dependencyFirewallActivitySummary:
from (Date)
Start date (inclusive) of the activity window. Defaults to 7 days ago.
to (Date)
End date (inclusive) of the activity window. Defaults to the current date.
dependencyFirewallRuleActivity [DependencyFirewallRuleActivity!] Introduced as an experiment in GitLab 19.3.

Dependency firewall per-rule block and warn activity for the group. Available behind the dependency_firewall_phase1 feature flag.

Arguments for dependencyFirewallRuleActivity:
from (Date)
Start date (inclusive) of the activity window. Defaults to 7 days ago.
to (Date)
End date (inclusive) of the activity window. Defaults to the current date.
dependencyLocations DependencyLocationConnection Introduced as an experiment in GitLab 19.1.

Locations of a software dependency across projects under this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyLocations:
componentVersionId (SbomComponentVersionID!)
Global ID of the component version to find locations for.
search (String)
Filter locations by file path.
dependencyProxyBlobCount Int! Number of dependency proxy blobs cached in the group.
dependencyProxyBlobs DependencyProxyBlobConnection Dependency Proxy blobs. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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 GitLab 16.1. Use dependencyProxyTotalSizeBytes.
descendantGroups GroupConnection List of descendant groups of this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for descendantGroups:
archived (Boolean)
Filters archived groups.
ids ([ID!])
Filter groups by IDs.
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.
sort (GroupSort)
Sort groups by given criteria.
descendantGroupsCount Int! Count of direct descendant groups of the group.
description String Description of the namespace.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designatedAsCsp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the namespace is designated to centrally manage security policies.
dora GroupDora Group's DORA metrics.
doraPerformanceScoreCounts DoraPerformanceScoreCountConnection Group's DORA scores for all projects by DORA key metric for the last complete month. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for doraPerformanceScoreCounts:
projectFilters (DoraProjectFilterInput)
Filter DORA metric results by project attributes.
duoAutoModeEnabled Boolean Introduced as an experiment in GitLab 19.5.

Indicates whether Duo Agent Platform auto mode is enabled for the group.
duoFeaturesEnabled Boolean Introduced as an experiment in GitLab 16.10.

Indicates whether GitLab Duo features are enabled for the group.
duoSettingsPath String Introduced as an experiment in GitLab 18.9.

Path of the group Duo settings page.
duoWorkflowSessionArtifacts DuoWorkflowSessionArtifactConnection Introduced as an experiment in GitLab 19.1.

Duo Agent Platform session artifacts for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowSessionArtifacts:
agentClass (AiGovernanceAgentClass)
Filter sessions by agent class. Defaults to all agent classes.
not (DuoWorkflowSessionArtifactNegatedFilterInput)
Negated filter conditions.
projectPath (String)
Filter by project full path.
triggeredByUserId (UserID)
Filter to sessions triggered by the user with the given global ID.
workflowCreatedAfter (Time)
Return sessions created after the timestamp.
workflowCreatedBefore (Time)
Return sessions created before the timestamp.
workflowDefinition (String)
Filter by workflow definition.
workflowId (AiDuoWorkflowsWorkflowID)
Filter to a single session by its workflow (session) global ID.
editPath String! Path for editing group.
emailsDisabled Boolean Indicates if a group has email notifications disabled.
emailsEnabled Boolean Indicates if a group has email notifications enabled.
enforceFreeUserCap Boolean Indicates whether the group has limited users for a free plan.
environmentScopes CiGroupEnvironmentScopeConnection Environment scopes of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for environmentScopes:
name (String)
Name of the environment scope.
search (String)
Search query for environment scope name.
epic Epic Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide.

Arguments for epic:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
epicBoard EpicBoard Deprecated in GitLab 17.5. Replaced by WorkItem type.

Arguments for epicBoard:
id (BoardsEpicBoardID!)
Find an epic board by ID.
epicBoards EpicBoardConnection Deprecated in GitLab 17.5. Replaced by WorkItem type. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
epics EpicConnection Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for epics:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
epicsEnabled Boolean Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide.
externalAuditEventDestinations ExternalAuditEventDestinationConnection Deprecated in GitLab 18.10. Use externalAuditEventStreamingDestinations instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
externalAuditEventStreamingDestinations GroupAuditEventStreamingDestinationConnection Introduced as an experiment in GitLab 16.11.

External destinations that receive audit events belonging to the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
flowMetrics GroupValueStreamAnalyticsFlowMetrics Introduced as an experiment in GitLab 15.10.

Flow metrics for value stream analytics.
fullName String Full name of the group.
fullPath ID! Full path of the group.
gitlabSubscriptionsPreviewBillableUserChange PreviewBillableUserChange Preview Billable User Changes.

Arguments for gitlabSubscriptionsPreviewBillableUserChange:
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.
googleCloudLoggingConfigurations GoogleCloudLoggingConfigurationTypeConnection Deprecated in GitLab 18.10. Use externalAuditEventStreamingDestinations with gcpLogging category instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupMembers GroupMemberConnection A membership of a user within this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groupMembers:
accessLevels ([AccessLevelEnum!])
Filter members by the given access levels.
enterprise (Boolean)
Filter members by enterprise users.
ids ([ID!])
List of group members IDs.
relations ([GroupMemberRelation!])
Filter members by the given member relations.
search (String)
Search query.
sort (MemberSort)
sort query.
groupMembersCount Int! Count of direct members of the group.
id ID ID of the group.
importSourceUsers ImportSourceUserConnection Introduced as an experiment in GitLab 17.2.

Import source users of the namespace. This field can only be resolved for one namespace in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for importSourceUsers:
search (String)
Query to search mappings by name or username of users on source instance.
sort (SourceUserSort)
Sort mapping of users on source instance to users on destination instance by the criteria.
statuses ([ImportSourceUserStatus!])
Filter mapping of users on source instance to users on destination instance by status.
isLinkedToSubscription Boolean Indicates if group is linked to a subscription.
isSelfArchived Boolean Indicates if the group is archived.
isSelfDeletionInProgress Boolean! Introduced as an experiment in GitLab 18.2.

Indicates if group deletion is in progress.
isSelfDeletionScheduled Boolean! Introduced as an experiment in GitLab 18.2.

Indicates if group deletion is scheduled.
issues IssueConnection Issues for projects in this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issues:
assigneeId (String)
ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername (String)
Deprecated in GitLab 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 the date.
closedBefore (Time)
Issues closed before the date.
confidential (Boolean)
Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter (Time)
Issues created after the date.
createdBefore (Time)
Issues created before the date.
crmContactId (String)
ID of a contact assigned to the issues.
crmOrganizationId (String)
ID of an organization assigned to the issues.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter (Time)
Return issues due on or after the given time.
dueBefore (Time)
Return issues due on or before the given time.
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 GitLab 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 the issue.
milestoneTitle ([String])
Milestone applied to the 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 the criteria.
state (IssuableState)
Current state of the issue.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Issues the current user is subscribed to.
types ([IssueType!])
Filter issues by the given issue types.
updatedAfter (Time)
Issues updated after the date.
updatedBefore (Time)
Issues updated before the date.
weight (String)
Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter issues by work item type global IDs.
iterationCadences IterationCadenceConnection Find iteration cadences. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for iterationCadences:
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 the 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.
iterations IterationConnection Find iterations. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for iterations:
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 GitLab 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
knowledgeGraphAvailable Boolean! Introduced as an experiment in GitLab 19.0.

Indicates whether the Knowledge Graph can be enabled for the namespace.
knowledgeGraphEnabled Boolean! Introduced as an experiment in GitLab 18.10.

Indicates whether the Knowledge Graph is enabled for the namespace.
label Label Label available on the group.

Arguments for label:
title (String!)
Title of the label.
labels LabelConnection Labels available on this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for labels:
archived (Boolean)
Filters archived labels. Defaults to false.
fuzzySearch (Boolean)
Match searchTerm fuzzily: labels match when they contain the searched characters in order, but not necessarily contiguously (for example, bugu matches bug::ux). Ignored if using title, or if the fuzzy_label_search feature flag is disabled.
includeAncestorGroups (Boolean)
Include labels from ancestor groups.
includeDescendantGroups (Boolean)
Include labels from descendant groups.
onlyGroupLabels (Boolean)
Include only group level labels.
searchIn ([LabelSearchFieldList!]!)
Specify which fields to search in. Ignored if using title.
searchTerm (String)
Search term to find labels with.
title (String)
Exact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.
lfsEnabled Boolean Indicates if Large File Storage (LFS) is enabled for namespace.
licensedFeatureAvailability LicensedFeatureAvailability! Introduced as an experiment in GitLab 18.11.

Check whether a licensed feature is available.

Arguments for licensedFeatureAvailability:
feature (LicensedFeature!)
Feature to check availability for (for example, EPICS).
licensedFeatures NamespaceAvailableFeatures! Introduced as an experiment in GitLab 18.1.

Licensed features available on the namespace.
lifecycleTemplates [WorkItemLifecycle!] Introduced as an experiment in GitLab 18.4.

Lifecycle templates available to the namespace.
lifecycles WorkItemLifecycleConnection Introduced as an experiment in GitLab 18.1.

Lifecycles of work items available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkPaths NamespacesLinkPaths Introduced as an experiment in GitLab 18.1.

Namespace relevant paths to create links on the UI.
lockAiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events storage is enforced for all subgroups and projects.
lockBuiltInProjectTemplatesEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates if the built-in project templates enabled setting is enforced for all subgroups.
lockDuoAutoModeEnabled Boolean Introduced as an experiment in GitLab 19.5.

Indicates if the Duo Agent Platform auto mode setting is enforced for all subgroups.
lockDuoFeaturesEnabled Boolean Introduced as an experiment in GitLab 16.10.

Indicates if the GitLab Duo features enabled setting is enforced for all subgroups.
lockMathRenderingLimitsEnabled Boolean Indicates if math rendering limits are locked for all descendant groups.
lockToolApprovalForSessionEnabled Boolean Introduced as an experiment in GitLab 18.11.

Indicates if the tool approval for session setting is enforced for all subgroups.
markdownPaths MarkdownPaths Introduced as an experiment in GitLab 18.1.

Namespace relevant paths to create markdown links on the UI.
markedForDeletion Boolean! Introduced as an experiment in GitLab 18.2.

Indicates if group or any ancestor is scheduled to be deleted.
markedForDeletionOn Time Introduced as an experiment in GitLab 16.11.

Date when group was scheduled to be deleted.
mathRenderingLimitsEnabled Boolean Indicates if math rendering limits are used for the group.
maxAccessLevel AccessLevel! Maximum access level of the current user in the group.
memberRoles MemberRoleConnection Introduced as an experiment in GitLab 16.5.

Custom roles available for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for memberRoles:
assignable (Boolean)
Filter for member roles the current user can assign.
id (MemberRoleID)
Global ID of the member role to look up.
ids ([MemberRoleID!])
Global IDs of the member role to look up.
orderBy (MemberRolesOrderBy)
Ordering column. Default is NAME.
sort (SortDirectionEnum)
Ordering column. Default is ASC.
mentionsDisabled Boolean Indicates if a group is disabled from getting mentioned.
mergeRequestViolations ComplianceViolationConnection Compliance violations reported on merge requests merged within the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequestViolations:
filters (ComplianceViolationInput)
Filters applied when retrieving compliance violations.
sort (ComplianceViolationSort)
List compliance violations by sort order.
mergeRequests MergeRequestConnection Merge requests for projects in this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, 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 merge requests from archived projects.
includeSubgroups (Boolean)
Include merge requests belonging to subgroups.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
mergeRequestsEnabled Boolean! Introduced as an experiment in GitLab 18.3.

Indicates if merge requests are enabled for the namespace.
metadata NamespaceMetadata Introduced as an experiment in GitLab 18.6.

Metadata information for the namespace.
milestones MilestoneConnection Milestones of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for milestones:
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 the criteria.
state (MilestoneStateEnum)
Filter milestones by state.
timeframe (Timeframe)
List items overlapping the given timeframe.
title (String)
Title of the milestone.
name String Name of the group.
namespaceSettings NamespaceSettings Namespace settings for the namespace.
orbit OrbitNamespace Introduced as an experiment in GitLab 19.5.

Orbit data of the group. Returns null when Orbit is not available to the current user.
orbitAccess OrbitAccess Introduced as an experiment in GitLab 19.5.

Orbit access state of the top-level group. Returns null when the user cannot read the Orbit setting of the group. This field can only be resolved for one group in any single request.
orbitTrial OrbitTrial Introduced as an experiment in GitLab 19.5.

Orbit trial state of the top-level group. Returns null when the CustomersDot request fails. This field can be resolved for at most 10 groups in any single request.
organizationEditPath String Introduced as an experiment in GitLab 17.1.

Path for editing group at the organization level.
organizationStateCounts OrganizationStateCounts Counts of organizations by status for the group.

Arguments for organizationStateCounts:
search (String)
Search term to find organizations with.
state (CustomerRelationsOrganizationState)
State of the organizations to search for.
organizations CustomerRelationsOrganizationConnection Find organizations of this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
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.
packageSettings PackageSettings Package settings for the namespace.
packages PackageConnection Packages of the group. This field can only be resolved for one group in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packages:
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 the criteria.
status (PackageStatus)
Filter a package by status.
pagesDeployments PagesDeploymentConnection List of the namespaces's Pages Deployments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pagesDeployments:
active (Boolean)
Filter by active or inactive state.
sort (Sort)
Sort results.
versioned (Boolean)
Filter deployments that are versioned or unversioned.
parent Group Parent group.
path String! Path of the namespace.
pendingMemberApprovals MemberApprovalConnection Pending member promotions of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pendingMembers PendingMemberInterfaceConnection Introduced as an experiment in GitLab 16.6.

A pending membership of a user within this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
permanentDeletionDate String Introduced as an experiment in GitLab 16.11.

For groups pending deletion, returns the group's scheduled deletion date. For groups not pending deletion, returns a theoretical date based on current settings if marked for deletion today.
pipelineAnalytics PipelineAnalytics Pipeline analytics.

Arguments for pipelineAnalytics:
fromTime (Time)
Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref (String)
Branch that triggered the pipeline.
source (CiPipelineSources)
Source of the pipeline.
subgroupFullPaths ([String!])
Introduced as an experiment in GitLab 18.11.

Full paths of subgroups to filter by. Only applies when querying pipeline analytics for a group (maximum is 10).
toTime (Time)
End of the requested time (in UTC). Defaults to the pipelines started before the current date.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
pipelineExecutionSchedulePolicies PipelineExecutionSchedulePolicyConnection Pipeline Execution Schedule Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionSchedulePolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
plan NamespacePlan Introduced as an experiment in GitLab 18.2.

Subscription plan associated with the namespace.
policyStore PolicyStore Introduced as an experiment in GitLab 19.4.

Policy store catalogs. Returns null when the policy store experiment is not active for the group.
projectComplianceRequirementsStatus ProjectComplianceRequirementStatusConnection Introduced as an experiment in GitLab 17.10.

Compliance statuses for the projects in a group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectComplianceRequirementsStatus:
filters (GroupProjectRequirementComplianceStatusInput)
Filters applied when retrieving compliance requirement statuses.
orderBy (ProjectComplianceRequirementStatusOrderBy)
Field used to sort compliance requirement statuses.
projectComplianceStandardsAdherence ComplianceStandardsAdherenceConnection Compliance standards adherence for the projects in a group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectComplianceStandardsAdherence:
filters (ComplianceStandardsAdherenceInput)
Filters applied when retrieving compliance standards adherence.
projectComplianceViolations ProjectComplianceViolationConnection Introduced as an experiment in GitLab 18.1.

Compliance violations for the projects in a group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectComplianceViolations:
filters (ProjectComplianceViolationFilterInput)
Filters applied when retrieving compliance violations.
projectCreationLevel String Permission level required to create projects in the group.
projectStatistics NamespaceProjectStatistics Introduced as an experiment in GitLab 18.2.

Statistics of the projects in the group. Only available from Query.groups.
projects ProjectConnection! Projects within this namespace. Returns projects from the parent group if namespace is project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
archivedOnly (Boolean)
Return only archived projects.
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.
includeArchived (Boolean)
Include also archived projects.
includeSiblingProjects (Boolean)
Introduced as an experiment in GitLab 17.2.

Include also projects from parent group.
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 the criteria.
withIssuesEnabled (Boolean)
Return only projects with issues enabled.
withMergeRequestsEnabled (Boolean)
Return only projects with merge requests enabled.
withNamespaceDomainPages (Boolean)
Return only projects that use the namespace domain for pages projects.
projectsCount Int! Count of direct projects in the group.
recentIssueBoards BoardConnection List of recently visited boards of the group. Maximum size is 4. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
releases ReleaseConnection Releases belonging to projects in the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for releases:
sort (GroupReleaseSort)
Sort group releases by given criteria.
remoteDevelopmentClusterAgents ClusterAgentConnection Deprecated in GitLab 17.8. Use workspacesClusterAgents. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for remoteDevelopmentClusterAgents:
filter (NamespaceClusterAgentFilter!)
Filter the types of cluster agents to return.
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 the group are required to set up two-factor authentication.
rootNamespace Namespace! Top-level namespace of the namespace.
rootStorageStatistics RootStorageStatistics Aggregated storage statistics of the namespace. Only available for root namespaces.
runnerCloudProvisioning CiRunnerCloudProvisioning Introduced as an experiment in GitLab 16.10.

Information used for provisioning the runner on a cloud provider. Returns null if the GitLab instance is not a SaaS instance.

Arguments for runnerCloudProvisioning:
cloudProjectId (GoogleCloudProject!)
Identifier of the cloud project.
provider (CiRunnerCloudProvider!)
Identifier of the cloud provider.
runners CiRunnerConnection Find runners visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for runners:
active (Boolean)
Deprecated in GitLab 14.8. Renamed. Use paused instead.
creatorId (UserID)
Filter runners by creator ID.
creatorUsername (String)
Filter runners by creator username.
membership (CiRunnerMembershipFilter)
Control which runners to include in the results.
ownerFullPath (String)
Introduced as an experiment in GitLab 17.8.

Filter runners by owning project or group.
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)
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'.
savedReplies GroupSavedReplyConnection Saved replies available to the group. This field can only be resolved for one group in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for savedReplies:
includeAncestorGroups (Boolean)
Include saved replies from parent groups.
savedReply GroupSavedReply Saved reply in the group. This field can only be resolved for one group in any single request.

Arguments for savedReply:
id (GroupsSavedReplyID!)
Global ID of a saved reply.
savedViews WorkItemSavedViewTypeConnection Introduced as an experiment in GitLab 18.7.

Saved views associated with the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for savedViews:
id (WorkItemsSavedViewsSavedViewID)
ID of the saved view. Required when requesting work_items, filters, or filter_warnings fields.
search (String)
Search query for saved view name or description.
sort (WorkItemsSavedViewsSort)
Sort work items by criteria. Default is ID.
subscribedOnly (Boolean)
Whether to return only saved views subscribed to by the current user.
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanExecutionPolicies:
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.
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
scanResultPolicies ScanResultPolicyConnection Deprecated in GitLab 16.9. Use approvalPolicies. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanResultPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
secretsManagerEntitlement SecretsManagerEntitlement Introduced as an experiment in GitLab 19.2.

Secrets Manager entitlement for the top-level group. Returns null for non-root groups, INELIGIBLE when unresolvable.
securityCategories [SecurityCategory!] Security categories for the group.
securityMetrics SecurityMetrics Introduced as an experiment in GitLab 18.2.

Security metrics.This feature is currently under development and not yet available for general use.

Arguments for securityMetrics:
projectId ([ID!])
Filter by project IDs in a group or an organization. This argument is ignored when we are querying for a project.
reportType ([VulnerabilityReportType!])
Filter by report types.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 18.8.

Filter by security attributes. Up to 20 filters.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref IDs. This argument is ignored when querying for a group. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
securityPolicies SecurityPolicyTypeConnection Introduced as an experiment in GitLab 18.1.

List of security policies configured for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicies:
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship.
type (PolicyType)
Filter policies by type.
securityPolicyProject Project Security policy project assigned to the namespace.
securityPolicyProjectSuggestions ProjectConnection Security policy project suggestions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicyProjectSuggestions:
onlyLinked (Boolean)
Whether to suggest only projects already linked as security policy projects.
search (String!)
Search query for projects' full paths.
securityPostureCounters SecurityPostureCounters Introduced as an experiment in GitLab 19.0.

Security posture counters for the group.
shareWithGroupLock Boolean Indicates if sharing a project with another group within the group is prevented.
sharedGroups GroupConnection List of shared groups this group was invited to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for sharedGroups:
search (String)
Search for a specific group.
sort (GroupSort)
Order by name, created at, updated at, path, id or similarity if searching.
sharedProjects ProjectConnection List of shared projects this group was invited to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for sharedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query, which can be for the project name, a path, or a description.
sort (String)
Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc. Defaults to id_desc, or similarity if search used.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.
sidebar NamespaceSidebar Introduced as an experiment in GitLab 17.6.

Data needed to render the sidebar for the namespace.
standardRole StandardRole Introduced as an experiment in GitLab 17.6.

Finds a single default role for the group. Available only for SaaS.

Arguments for standardRole:
accessLevel ([MemberAccessLevel!])
Access level or levels to filter by.
standardRoles StandardRoleConnection Introduced as an experiment in GitLab 17.4.

Default roles available for the group. Available only for SaaS. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for standardRoles:
accessLevel ([MemberAccessLevel!])
Access level or levels to filter by.
stats GroupStats Group statistics.
statuses WorkItemStatusConnection Introduced as an experiment in GitLab 18.1.

Statuses of work items available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for statuses:
ids ([WorkItemsStatusesStatusID!])
Filter statuses by ID. A max of 70 can be provided.
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.
subscribedSavedViewLimit Int! Introduced as an experiment in GitLab 18.8.

Maximum number of subscribed saved views allowed on the namespace.
subscriptionHistory GitlabSubscriptionHistoryConnection Introduced as an experiment in GitLab 17.3.

Find subscription history records. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
targetedMessages [TargetedMessage!] Introduced as an experiment in GitLab 18.7.

Targeted messages for the namespace.
timelogCategories TimeTrackingTimelogCategoryConnection Introduced as an experiment in GitLab 15.3.

Timelog categories for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
timelogs TimelogConnection! Time logged on issues and merge requests in the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
toolApprovalForSessionEnabled Boolean Introduced as an experiment in GitLab 18.11.

Indicates whether tool approval for session is enabled for the group.
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.
transferInProgress Boolean! Introduced as an experiment in GitLab 19.3.

Indicates if the group is currently being transferred.
triageAndRemediationCoverageCounters TriageAndRemediationCoverageCounters Introduced as an experiment in GitLab 19.5.

Triage and remediation coverage counters for the group, for a given trigger type.

Arguments for triageAndRemediationCoverageCounters:
triggerType (ScanProfileTriggerType!)
Trigger type to count coverage for.
twoFactorGracePeriod Int Time before two-factor authentication is enforced.
updatedAt Time Timestamp of when the group was last updated.
userPermissions GroupPermissions! Permissions for the current user on the resource.
valueStreamAnalytics ValueStreamAnalytics Information about Value Stream Analytics within the group.
valueStreamDashboardUsageOverview ValueStreamDashboardCount Introduced as an experiment in GitLab 16.4.

Aggregated usage counts within the group.

Arguments for valueStreamDashboardUsageOverview:
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).
valueStreams ValueStreamConnection Value streams available to the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for valueStreams:
id (ID)
Value stream id.
virtualRegistriesCleanupPolicy VirtualRegistryCleanupPolicy Introduced as an experiment in GitLab 18.7.

Virtual registries cleanup policy of the group. Returns null if the maven_virtual_registry feature flag is disabled.
virtualRegistriesContainerRegistries ContainerRegistryConnection Introduced as an experiment in GitLab 18.7.

Container virtual registries registered to the group. Returns null if the container_virtual_registries feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
virtualRegistriesContainerUpstreams ContainerUpstreamConnection Introduced as an experiment in GitLab 18.7.

Container upstreams registered to the group. Returns null if the container_virtual_registries feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for virtualRegistriesContainerUpstreams:
upstreamName (String)
Search upstreams by name.
virtualRegistriesPackagesMavenRegistries MavenRegistryConnection Introduced as an experiment in GitLab 18.6.

Maven virtual registries registered to the group. Returns null if the maven_virtual_registry feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
virtualRegistriesPackagesMavenUpstreams MavenUpstreamConnection Introduced as an experiment in GitLab 18.6.

Maven upstream registries registered to the group. Returns null if the maven_virtual_registry feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for virtualRegistriesPackagesMavenUpstreams:
upstreamName (String)
Search upstreams by name.
virtualRegistriesSetting VirtualRegistriesSetting Introduced as an experiment in GitLab 18.5.

Virtual registries settings for the group. Returns null if the maven_virtual_registry feature flag is disabled.
visibility String Visibility of the namespace.
vulnerabilities VulnerabilityConnection Vulnerabilities reported on the projects in the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilities:
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities which have been auto dismissed by security policies. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
sort (VulnerabilitySort)
List vulnerabilities by sort order.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.10.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured and advanced vulnerability management set up.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.9.

Filter by tracked ref scope. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by validity check.
vulnerabilitiesCountByDay VulnerabilitiesCountByDayConnection The historical number of vulnerabilities per day for the projects in the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilitiesCountByDay:
endDate (ISO8601Date!)
Last day for which to fetch vulnerability history.
startDate (ISO8601Date!)
First day for which to fetch vulnerability history.
vulnerabilityGrades [VulnerableProjectsByGrade!] Represents vulnerable project counts for each grade.

Arguments for vulnerabilityGrades:
includeSubgroups (Boolean)
Include grades belonging to subgroups.
letterGrade (VulnerabilityGrade)
Filter the response by given letter grade.
vulnerabilityIdentifierSearch [String!] Search for vulnerabilities by identifier.

Arguments for vulnerabilityIdentifierSearch:
name (String!)
Search identifier by name. Substring or partial match search is supported and argument should be greater than 3 characters.
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Introduced as an experiment in GitLab 17.7.

Vulnerability Management Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityManagementPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
vulnerabilityNamespaceStatistic VulnerabilityNamespaceStatisticType Counts for each vulnerability severity in the group and its subgroups.
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilitySeveritiesCount VulnerabilitySeveritiesCount Counts for each vulnerability severity in the group and its subgroups.

Arguments for vulnerabilitySeveritiesCount:
capped (Boolean)
Default value is false. When set to true, the count returned for each severity is capped at a maximum of 1001. Ignored when used along with any argument that requires advanced vulnerability management.
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Introduced as an experiment in GitLab 17.7.

Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Filter by policy auto dismissed. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by scanner.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref scope. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by token status.
webBasedCommitSigningEnabled Boolean! Introduced as an experiment in GitLab 18.2.

Indicates whether web-based commit signing is enabled for the group.
webPath String! Web path of the group.
webUrl String! Web URL of the group.
webhook GroupHook Introduced as an experiment in GitLab 18.5.

A single group webhook.

Arguments for webhook:
id (GroupHookID!)
ID of the group webhook.
wikiPages WikiPageConnection Introduced as an experiment in GitLab 19.2.

Wiki pages of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
workItem WorkItem Find a work item by IID directly associated with the group.

Arguments for workItem:
iid (String!)
IID of the work item.
workItemDescriptionTemplates WorkItemDescriptionTemplateConnection Introduced as an experiment in GitLab 17.6.

Work item description templates available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemDescriptionTemplates:
name (String)
Deprecated in GitLab 17.9. name and project ID are both required for fetching, use DescriptionTemplateContentInputType instead.
search (String)
Deprecated in GitLab 17.8. search on template names is performed on the FE only.
workItemMoveTargets [WorkItemMoveTarget!] Introduced as an experiment in GitLab 19.1.

Valid target work item types and a suggested default for moving work items of given source types into this namespace.

Arguments for workItemMoveTargets:
sourceFullPath (String!)
Full path of the source namespace. For example, gitlab-org/gitlab-foss.
sourceTypeIds ([WorkItemsTypeID!]!)
Global IDs of the source work item types to compute move targets for. A maximum of 50 IDs can be provided.
workItemSettings WorkItemSettings Introduced as an experiment in GitLab 19.0.

Work item settings for the group.
workItemStateCounts WorkItemStateCountsType Counts of work items by state for the namespace.

Arguments for workItemStateCounts:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
excludeGroupWorkItems (Boolean)
Introduced as an experiment in GitLab 18.4.

Exclude group-level work items within the group and its descendants. Ignored for project namespaces.
excludeProjects (Boolean)
Introduced as an experiment in GitLab 17.5.

Exclude work items from projects within the group. Ignored for project namespaces.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeAncestors (Boolean)
Include work items from ancestor groups. Ignored for project namespaces.
includeArchived (Boolean)
Introduced as an experiment in GitLab 18.5.

Return work items from archived projects. Ignored for project namespaces.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
includeDescendants (Boolean)
Include work items from descendant groups and projects. Ignored for project namespaces.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe. Ignored for project namespaces.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemTypes WorkItemTypeConnection Work item types available to the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemTypes:
name (IssueType)
Deprecated in GitLab 19.0. Name-based filtering is no longer supported with introduction of configurable work item types in 19.0.
onlyAvailable (Boolean)
Introduced as an experiment in GitLab 18.6.

When true, returns only the available work item types for the current user. This experimental field will be removed in 19.0. Use canUserCreateItems and isFilterableListView fields from the WorkItemTypes API instead.
workItems WorkItemConnection Work items that belong to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItems:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
excludeGroupWorkItems (Boolean)
Introduced as an experiment in GitLab 18.4.

Exclude group-level work items within the group and its descendants. Ignored for project namespaces.
excludeProjects (Boolean)
Introduced as an experiment in GitLab 17.5.

Exclude work items from projects within the group. Ignored for project namespaces.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeAncestors (Boolean)
Include work items from ancestor groups. Ignored for project namespaces.
includeArchived (Boolean)
Introduced as an experiment in GitLab 18.5.

Return work items from archived projects. Ignored for project namespaces.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
includeDescendants (Boolean)
Include work items from descendant groups and projects. Ignored for project namespaces.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe. Ignored for project namespaces.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemsWidgets [String!] Introduced as an experiment in GitLab 18.2.

List of available widgets for the given work items.

Arguments for workItemsWidgets:
ids ([WorkItemsTypeID!]!)
Global ID array of work items types to fetch available widgets for. A max of 100 IDs can be provided at a time.
union (Boolean!)
When true, returns the union of widgets across all work item types. When false, returns only widgets common to all work item types.
workspacesClusterAgents ClusterAgentConnection Introduced as an experiment in GitLab 17.8.

Cluster agents in the namespace with workspaces capabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspacesClusterAgents:
filter (NamespaceClusterAgentFilter!)
Filter the types of cluster agents to return.

GroupAuditEventNamespaceFilter#

Represents a subgroup or project filter that belongs to a group level external audit event streaming destination.

Fields#

Name Type Description
externalStreamingDestination GroupAuditEventStreamingDestination! Destination to which the filter belongs.
id ID! ID of the filter.
namespace Namespace! Group or project namespace the filter belongs to.

GroupAuditEventStreamingDestination#

Represents an external destination to stream group level audit events.

Implements: AuditEventStreamingDestinationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
category String! Category of the external destination to send audit events to.
config JSON! Config of the external destination.
eventTypeFilters [String!]! List of event type filters added for streaming.
group Group! Group to which the destination belongs.
id ID! ID of the destination.
name String! Name of the external destination to send audit events to.
namespaceFilters [GroupAuditEventNamespaceFilter!] List of subgroup or project filters for the destination.
secretToken String! Secret token for the destination, will be non-empty value only for http category.

GroupAuditEventStreamingDestinationConnection#

Paginated collection of GroupAuditEventStreamingDestination. See Standard connection fields for the fields available on every connection.

GroupConnection#

Paginated collection of Group. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

GroupDataTransfer#

Fields#

Name Type Description
egressNodes EgressNodeConnection Data nodes. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

GroupDora#

All information related to group DORA metrics.

Fields#

Name Type Description
metrics [DoraMetric!] DORA metrics for the current group or project.

Arguments for metrics:
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.
startDate (Date)
Date range to start from. Default is 3 months ago.
projects ProjectConnection! Projects within this group with at least 1 DORA metric for given period. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
archivedOnly (Boolean)
Return only archived projects.
complianceFrameworkFilters (ComplianceFrameworkFilters)
Filters applied when selecting a compliance framework.
endDate (Date!)
Date range to end DORA lookup at.
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.
includeArchived (Boolean)
Include also archived projects.
includeSiblingProjects (Boolean)
Introduced as an experiment in GitLab 17.2.

Include also projects from parent group.
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 the criteria.
startDate (Date!)
Date range to start DORA lookup from.
withIssuesEnabled (Boolean)
Return only projects with issues enabled.
withMergeRequestsEnabled (Boolean)
Return only projects with merge requests enabled.
withNamespaceDomainPages (Boolean)
Return only projects that use the namespace domain for pages projects.

GroupHook#

Fields#

Name Type Description
alertStatus WebhookAlertStatus! Auto-disabling status of the webhook.
branchFilterStrategy WebhookBranchFilterStrategy! Strategy for filtering push events by branch name.
confidentialIssuesEvents Boolean! Whether the webhook is triggered on confidential issues events.
confidentialNoteEvents Boolean! Whether the webhook is triggered on confidential note events.
createdAt Time! Timestamp of when the webhook was created.
customHeaders [WebhookCustomHeader!] List of custom header names for the webhook.
customWebhookTemplate String Custom payload template for the webhook request body.
deploymentEvents Boolean! Whether the webhook is triggered on deployment events.
description String Description of the webhook.
disabledUntil Time Timestamp when the webhook will be automatically re-enabled if temporarily disabled.
emojiEvents Boolean! Whether the webhook is triggered on emoji events.
enableSslVerification Boolean Whether SSL verification is done when triggering the webhook.
featureFlagEvents Boolean! Whether the webhook is triggered on feature flag events.
id GroupHookID! ID of the webhook.
issuesEvents Boolean! Whether the webhook is triggered on issues events.
jobEvents Boolean! Whether the webhook is triggered on job events.
memberEvents Boolean! Whether the webhook is triggered on member events.
mergeRequestsEvents Boolean! Whether the webhook is triggered on merge request events.
milestoneEvents Boolean! Whether the webhook is triggered on milestone events.
name String Name of the webhook.
noteEvents Boolean! Whether the webhook is triggered on note events.
pipelineEvents Boolean! Whether the webhook is triggered on pipeline events.
projectEvents Boolean! Whether the webhook is triggered on project events.
pushEvents Boolean! Whether the webhook is triggered on push events.
pushEventsBranchFilter String Trigger hook on push events for matching branches only.
releasesEvents Boolean! Whether the webhook is triggered on releases events.
resourceAccessTokenEvents Boolean! Whether the webhook is triggered on resource access token events.
signingTokenPresent Boolean! Whether an HMAC signing token is configured for webhook-signature header generation.
subgroupEvents Boolean! Whether the webhook is triggered on subgroup events.
tagPushEvents Boolean! Whether the webhook is triggered on tag push events.
tokenPresent Boolean! Whether a secret token is configured for X-Gitlab-Token header validation.
url String! URL of the webhook.
urlVariables [WebhookUrlVariable!] List of URL variable masks to hide sensitive portions of the webhook URL.
vulnerabilityEvents Boolean! Whether the webhook is triggered on vulnerability events.
webhookEvent WebhookEvent A single webhook event.

Arguments for webhookEvent:
id (WebHookLogID!)
ID of the webhook event.
timestampRange (TimestampRange)
Filter for webhook events within a range of timestamps. Defaults to events within the last seven days.
webhookEvents WebhookEventConnection List of recent webhook events. This field can only be resolved for one webhook in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for webhookEvents:
timestampRange (TimestampRange)
Filter for webhook events within a range of timestamps. Defaults to events within the last seven days.
wikiPageEvents Boolean! Whether the webhook is triggered on wiki page events.

GroupInterfaceConnection#

Paginated collection of GroupInterface. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

GroupMember#

Represents a Group Membership.

Implements: MemberInterface

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.
mergeRequestInteraction UserMergeRequestInteraction Find a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
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 GroupMemberPermissions! Permissions for the current user on the resource.

GroupMemberConnection#

Paginated collection of GroupMember. See Standard connection fields for the fields available on every connection.

GroupMemberPermissions#

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.
removeGroup Boolean! If true, the user can perform remove_group on this resource.
viewEditPage Boolean! If true, the user can perform view_edit_page on this resource.

GroupMinimalAccess#

Limited group data accessible to users without full group read access (e.g. non-members with READ_ADMIN_CICD admin custom role).

Implements: GroupInterface

Fields#

Name Type Description
avatarUrl String Avatar URL of the group.
fullName String! Full name of the group.
fullPath ID! Full path of the group.
id ID! ID of the group.
name String! Name of the group.
userPermissions GroupPermissions! Permissions for the current user on the resource.
webUrl String Web URL of the group.

Implements: NamespacesLinkPaths

Fields#

Name Type Description
autocompleteAwardEmojisPath String Introduced as an experiment in GitLab 18.6.

Path for autocomplete award emojis.
calendarPath String Introduced as an experiment in GitLab 18.4.

Calendar path for work items.
contributionGuidePath String Namespace contribution guide path.
emailsHelpPagePath String Help page path for emails.
epicsList String Namespace epics_list.
epicsListPath String Introduced as an experiment in GitLab 18.6.

Path to the epics list for the namespace.
groupIssues String Namespace group_issues.
groupPath String Introduced as an experiment in GitLab 18.6.

Full path of the group.
issuesList String Namespace issues_list.
issuesListPath String Introduced as an experiment in GitLab 18.6.

Path to the issues list for the namespace.
issuesSettings String Namespace issues settings path.
labelsFetch String Namespace labels_fetch.
labelsManage String Namespace labels_manage.
markdownHelpPath String Help page path for Markdown.
namespaceFullPath String Introduced as an experiment in GitLab 18.6.

Full path of the namespace (project.namespace.full_path or group full_path).
newCommentTemplate [CommentTemplatePath!] Namespace new_comment_template_paths.
newIssuePath String Introduced as an experiment in GitLab 18.6.

Path to create a new issue.
newProject String Namespace new_project.
newTrialPath String Introduced as an experiment in GitLab 18.6.

New trial path for the namespace.
quickActionsHelpPath String Help page path for quick actions.
register String Namespace register_path.
reportAbuse String Namespace report_abuse.
rssPath String Introduced as an experiment in GitLab 18.4.

RSS path for work items.
signIn String Namespace sign_in_path.
userExportEmail String Introduced as an experiment in GitLab 18.3.

User email for export CSV. Returns null for user namespaces.

GroupNamespaceMarkdownPaths#

Implements: MarkdownPaths

Fields#

Name Type Description
autocompleteSourcesPath JSON Supported paths for autocomplete sources for a given namespace.

Arguments for autocompleteSourcesPath:
iid (String)
IID of the work item.
workItemTypeId (String)
ID of the work item type.
markdownPreviewPath String Path for the markdown preview for given namespace.

Arguments for markdownPreviewPath:
iid (String)
IID of the target item for markdown preview.
uploadsPath String Uploads path for a given namespace.

GroupNamespaceMetadata#

Implements: NamespaceMetadata

Fields#

Name Type Description
groupId String Introduced as an experiment in GitLab 18.6.

ID of the group. Returns null for user namespaces.
hasProjects Boolean Introduced as an experiment in GitLab 18.6.

Whether the group has any projects.
initialSort String Introduced as an experiment in GitLab 18.6.

User preference for initial sort order.
isIssueRepositioningDisabled Boolean Introduced as an experiment in GitLab 18.6.

Whether issue repositioning is disabled for the namespace.
maxAttachmentSize String Introduced as an experiment in GitLab 18.6.

Maximum allowed attachment size (humanized).
showNewWorkItem Boolean Introduced as an experiment in GitLab 18.6.

Whether to show the new work item link.
timeTrackingLimitToHours Boolean Introduced as an experiment in GitLab 18.6.

Time tracking limit to hours setting.

GroupPermissions#

Fields#

Name Type Description
adminAiCatalogItemConsumer Boolean! If true, the user can perform admin_ai_catalog_item_consumer on this resource.
adminAllResources Boolean! If true, the user is an instance administrator.
adminIssue Boolean! If true, the user can perform admin_issue on this resource.
adminWorkItemLifecycle Boolean! If true, the user can perform admin_work_item_lifecycle on this resource.
applySecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform apply_security_scan_profiles on this resource. Attaching a profile is authorized per project, so this ability is evaluated on this resource rather than on the root ancestor.
archiveGroup Boolean! If true, the user can perform archive_group on this resource.
canLeave Boolean! If true, the user can leave this group.
changeGroup Boolean! If true, the user can perform change_group on this resource.
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.
createSecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform create_security_scan_profiles on the top-level namespace of this resource. Security scan profiles belong to the top-level namespace, so this ability is evaluated on the root ancestor rather than on this resource.
deleteSecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform delete_security_scan_profiles on the top-level namespace of this resource. Security scan profiles belong to the top-level namespace, so this ability is evaluated on the root ancestor rather than on this resource.
generateDescription Boolean! If true, the user can perform generate_description on this resource.
readCrmContact Boolean! If true, the user can perform read_crm_contact on this resource.
readCrmOrganization Boolean! If true, the user can perform read_crm_organization on this resource.
readCycleAnalytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_cycle_analytics on this resource.
readDora4Analytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_dora4_analytics on this resource.
readGroup Boolean! If true, the user can perform read_group on this resource.
readOrbitTrial Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_orbit_trial on this resource.
readProAiAnalytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_pro_ai_analytics on this resource.
readRunnerCloudProvisioningInfo Boolean! Introduced as an experiment in GitLab 18.8.

If true, the user can perform read_runner_cloud_provisioning_info on this resource.
readSecurityResource Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_security_resource on this resource.
readSecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform read_security_scan_profiles on the top-level namespace of this resource. Security scan profiles belong to the top-level namespace, so this ability is evaluated on the root ancestor rather than on this resource.
removeGroup Boolean! If true, the user can perform remove_group on this resource.
startOrbitTrial Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform start_orbit_trial on this resource.
updateSecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform update_security_scan_profiles on the top-level namespace of this resource. Security scan profiles belong to the top-level namespace, so this ability is evaluated on the root ancestor rather than on this resource.
viewEditPage Boolean! If true, the user can perform view_edit_page 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.

GroupSavedReply#

Fields#

Name Type Description
content String! Content of the saved reply.
id GroupsSavedReplyID! Global ID of the group-level saved reply.
name String! Name of the saved reply.

GroupSavedReplyConnection#

Paginated collection of GroupSavedReply. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

GroupSecret#

Represents a group secret.

Fields#

Name Type Description
createdAt Time Timestamp when the secret creation started.
description String Description of the group secret.
environment String! Environments that can access the secret.
group Group! Group the secret belongs to.
metadataVersion Int Current metadata version of the group secret.
name String! Name of the group secret.
protected Boolean! Whether the secret is only accessible from protected branches.
rotationInfo SecretRotationInfo Rotation configuration for the secret.
status SecretStatus! Computed lifecycle status of the secret, based on timestamps.

GroupSecretConnection#

Paginated collection of GroupSecret. See Standard connection fields for the fields available on every connection.

GroupSecretsManager#

Representation of a group secrets manager.

Fields#

Name Type Description
group Group! Group the secrets manager belongs to.
readOnly Boolean! Introduced as an experiment in GitLab 19.4.

Whether the instance is in strict read-only mode (Geo secondary or maintenance mode). No secrets or permissions can be created, updated, or deleted while it is true.
status GroupSecretsManagerStatus Status of the group secrets manager.
userPermissions GroupSecretsManagerPermissions! Permissions for the current user on the resource.
writeDenialReason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.5.

Reason the Secrets Manager entitlement does not allow secrets or their permissions to be created or updated. Null when it allows them.

GroupSecretsManagerPermissions#

Permissions the current user has on a group secrets manager.

Fields#

Name Type Description
createSecrets Boolean! Indicates the user can create secrets in this group secrets manager.
deleteSecrets Boolean! Indicates the user can delete secrets in this group secrets manager.
readMetadata Boolean! Indicates the user can read secret metadata in this group secrets manager.
updateSecrets Boolean! Indicates the user can update secrets in this group secrets manager.

GroupSecretsPermission#

Representation of a group secrets permission.

Fields#

Name Type Description
actions [SecretsManagementAction!]! Actions that can be performed on secrets.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
grantedBy UserCore User who created the Secret Permission.
group Group! Group the secret permission belong to.
principal Principal! Who is provided access to. For eg: User/Role/MemberRole.

GroupSecretsPermissionConnection#

Paginated collection of GroupSecretsPermission. See Standard connection fields for the fields available on every connection.

GroupSecurityPolicySource#

Represents the source of a security policy belonging to a group.

Fields#

Name Type Description
inherited Boolean! Indicates whether the 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.

GroupUploadRegistry#

Represents the Geo replication and verification state of a group_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the GroupUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the GroupUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this GroupUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
groupUploadId ID! ID of the Group Upload.
id ID! ID of the GroupUploadRegistry.
lastSyncFailure String Error message during sync of the GroupUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the GroupUploadRegistry.
missingOnPrimary Boolean Indicate if the GroupUploadRegistry is missing on primary.
modelRecordId Int ID of the GroupUploadRegistry's model record.
retryAt Time Timestamp after which the GroupUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the GroupUploadRegistry.
state RegistryState Sync state of the GroupUploadRegistry.
verificationChecksum String The local checksum of the GroupUploadRegistry.
verificationChecksumMismatched String The expected checksum of the GroupUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the GroupUploadRegistry.
verificationRetryAt Time Timestamp after which the GroupUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the GroupUploadRegistry.
verificationStartedAt Time Timestamp when the verification of GroupUploadRegistry started.
verificationState VerificationStateEnum Verification state of the GroupUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the GroupUploadRegistry.

GroupUploadRegistryConnection#

Paginated collection of GroupUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

GroupValueStreamAnalyticsFlowMetrics#

Exposes aggregated value stream flow metrics.

Fields#

Name Type Description
cycleTime ValueStreamAnalyticsMetric Median time from first commit to issue closed.

Arguments for cycleTime:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
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.
deploymentCount ValueStreamAnalyticsMetric Number of production deployments in the given period.

Arguments for deploymentCount:
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.
issueCount ValueStreamAnalyticsMetric Number of issues opened in the given period.

Arguments for issueCount:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
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.
issuesCompletedCount ValueStreamAnalyticsMetric Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Arguments for issuesCompletedCount:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
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.
leadTime ValueStreamAnalyticsMetric Median time from when the issue was created to when it was closed.

Arguments for leadTime:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
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.
timeToMerge ValueStreamAnalyticsMetric Median time from merge request creation to merge request merged.

Arguments for timeToMerge:
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
checksumMismatch Boolean Indicate if the checksums of the GroupWikiRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the GroupWikiRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this GroupWikiRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the GroupWikiRepositoryRegistry is missing on primary.
modelRecordId Int ID of the GroupWikiRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the GroupWikiRepositoryRegistry in case of mismatch.
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 of GroupWikiRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the GroupWikiRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the GroupWikiRepositoryRegistry.

GroupWikiRepositoryRegistryConnection#

Paginated collection of GroupWikiRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.
previousPath String Path to the file in the commit's first parent.
span Int! Number of contiguous lines which the blame spans for the commit group.

HelmFileMetadata#

Helm file metadata.

Implements: PackageFileMetadata

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.

ImagePullSecrets#

Fields#

Name Type Description
name String! Name of the Kubernetes image pull secret.
namespace String! Namespace of the kubernetes image pull secret.

ImportExportUploadUploadRegistry#

Represents the Geo replication and verification state of an import/export archive upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ImportExportUploadUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ImportExportUploadUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ImportExportUploadUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ImportExportUploadUploadRegistry.
importExportUploadUploadId ID! ID of the import/export archive upload.
lastSyncFailure String Error message during sync of the ImportExportUploadUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ImportExportUploadUploadRegistry.
missingOnPrimary Boolean Indicate if the ImportExportUploadUploadRegistry is missing on primary.
modelRecordId Int ID of the ImportExportUploadUploadRegistry's model record.
retryAt Time Timestamp after which the ImportExportUploadUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ImportExportUploadUploadRegistry.
state RegistryState Sync state of the ImportExportUploadUploadRegistry.
verificationChecksum String The local checksum of the ImportExportUploadUploadRegistry.
verificationChecksumMismatched String The expected checksum of the ImportExportUploadUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the ImportExportUploadUploadRegistry.
verificationRetryAt Time Timestamp after which the ImportExportUploadUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ImportExportUploadUploadRegistry.
verificationStartedAt Time Timestamp when the verification of ImportExportUploadUploadRegistry started.
verificationState VerificationStateEnum Verification state of the ImportExportUploadUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ImportExportUploadUploadRegistry.

ImportExportUploadUploadRegistryConnection#

Paginated collection of ImportExportUploadUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ImportSourceUser#

Fields#

Name Type Description
createdAt Time! Timestamp of when the source user was created.
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.
importType ImportSource! Name of the importer.
namespace Namespace Namespace the contributions were imported to.
placeholderUser UserCore Placeholder user associated with the import source user.
reassignToUser UserCore User that contributions are reassigned to.
reassignedByUser UserCore User that did the reassignment.
reassignmentError String Error message if reassignment failed.
sourceHostname String! Source instance hostname.
sourceName String Name of user in the source instance.
sourceUserIdentifier String! ID of the user in the source instance.
sourceUsername String Username of user in the source instance.
status ImportSourceUserStatus! Status of the mapping.

ImportSourceUserConnection#

Paginated collection of ImportSourceUser. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
shifts IncidentManagementOncallShiftConnection Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for shifts:
endTime (Time!)
End of timeframe to include shifts for. Cannot exceed one month after start.
startTime (Time!)
Start of timeframe to include shifts for.
startsAt Time Start date of the on-call rotation.

IncidentManagementOncallRotationConnection#

Paginated collection of IncidentManagementOncallRotation. See Standard connection fields for the fields available on every connection.

IncidentManagementOncallSchedule#

Describes an incident management on-call schedule.

Fields#

Name Type Description
description String Description of the on-call schedule.
iid String! Internal ID of the on-call schedule.
name String! Name of the on-call schedule.
oncallUsers [UserCore!]
rotation IncidentManagementOncallRotation On-call rotation for the on-call schedule.

Arguments for rotation:
id (IncidentManagementOncallRotationID!)
ID of the on-call rotation.
rotations IncidentManagementOncallRotationConnection! On-call rotations for the on-call schedule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
timezone String! Time zone of the on-call schedule.

IncidentManagementOncallScheduleConnection#

Paginated collection of IncidentManagementOncallSchedule. See Standard connection fields for the fields available on every connection.

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.

IncidentManagementOncallShiftConnection#

Paginated collection of IncidentManagementOncallShift. See Standard connection fields for the fields available on every connection.

InheritedCiVariable#

CI/CD variables a project inherits from its parent group and ancestors.

Fields#

Name Type Description
description String Description of the variable.
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.
hidden Boolean Indicates whether the variable is hidden.
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.

InheritedCiVariableConnection#

Paginated collection of InheritedCiVariable. See Standard connection fields for the fields available on every connection.

InstanceAmazonS3ConfigurationType#

Stores instance level Amazon S3 configurations for audit event streaming.

Implements: AmazonS3ConfigurationInterface

Fields#

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
active Boolean! Active status of the destination.
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.

InstanceAmazonS3ConfigurationTypeConnection#

Paginated collection of InstanceAmazonS3ConfigurationType. See Standard connection fields for the fields available on every connection.

InstanceAuditEventNamespaceFilter#

Represents a subgroup or project filter that belongs to an instance level external audit event streaming destination.

Fields#

Name Type Description
externalStreamingDestination InstanceAuditEventStreamingDestination! Destination to which the filter belongs.
id ID! ID of the filter.
namespace Namespace! Group or project namespace the filter belongs to.

InstanceAuditEventStreamingDestination#

Represents an external destination to stream instance level audit events.

Implements: AuditEventStreamingDestinationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
category String! Category of the external destination to send audit events to.
config JSON! Config of the external destination.
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.
namespaceFilters [InstanceAuditEventNamespaceFilter!] List of subgroup or project filters for the destination.
secretToken String! Secret token for the destination, will be non-empty value only for http category.

InstanceAuditEventStreamingDestinationConnection#

Paginated collection of InstanceAuditEventStreamingDestination. See Standard connection fields for the fields available on every connection.

InstanceExternalAuditEventDestination#

Represents an external resource to send instance audit events to.

Implements: ExternalAuditEventDestinationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

InstanceExternalAuditEventDestinationConnection#

Paginated collection of InstanceExternalAuditEventDestination. See Standard connection fields for the fields available on every connection.

InstanceGoogleCloudLoggingConfigurationType#

Stores instance level Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Implements: GoogleCloudLoggingConfigurationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
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.

InstanceGoogleCloudLoggingConfigurationTypeConnection#

Paginated collection of InstanceGoogleCloudLoggingConfigurationType. See Standard connection fields for the fields available on every connection.

InstanceSecurityDashboard#

Fields#

Name Type Description
clusterAgents ClusterAgentConnection Cluster agents associated with projects selected in the Instance Security Dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for clusterAgents:
hasRemoteDevelopmentAgentConfig (Boolean)
Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled (Boolean)
Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities (Boolean)
Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig (Boolean)
Returns only cluster agents which have an associated workspaces agent config.
projects ProjectConnection! Projects selected in Instance Security Dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
search (String)
Search query, which can be for the project name, a path, or a description.
vulnerabilityGrades [VulnerableProjectsByGrade!]! Represents vulnerable project counts for each grade.

Arguments for vulnerabilityGrades:
letterGrade (VulnerabilityGrade)
Filter the response by given letter grade.
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilitySeveritiesCount VulnerabilitySeveritiesCount Counts for each vulnerability severity from projects selected in Instance Security Dashboard.

Arguments for vulnerabilitySeveritiesCount:
capped (Boolean)
Default value is false. When set to true, the count returned for each severity is capped at a maximum of 1001. Ignored when used along with any argument that requires advanced vulnerability management.
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Introduced as an experiment in GitLab 17.7.

Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Filter by policy auto dismissed. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by scanner.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref scope. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by token status.

IntegerExpression#

An expression with an integer value.

Implements: ExpressionInterface

Fields#

Name Type Description
field String! Field the expression applies to.
operator String! Operator of the expression.
value Int! Integer value of the expression.

IntegrationExclusion#

An integration to override the level settings of instance specific integrations.

Fields#

Name Type Description
group Group Group that has been excluded from the instance specific integration.
project Project Project that has been excluded from the instance specific integration.

IntegrationExclusionConnection#

Paginated collection of IntegrationExclusion. See Standard connection fields for the fields available on every connection.

IssuableMetricImageUploadRegistry#

Represents the Geo replication and verification state of a issuable_metric_image_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the IssuableMetricImageUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the IssuableMetricImageUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this IssuableMetricImageUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the IssuableMetricImageUploadRegistry.
issuableMetricImageUploadId ID! ID of the Issuable Metric Image Upload.
lastSyncFailure String Error message during sync of the IssuableMetricImageUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the IssuableMetricImageUploadRegistry.
missingOnPrimary Boolean Indicate if the IssuableMetricImageUploadRegistry is missing on primary.
modelRecordId Int ID of the IssuableMetricImageUploadRegistry's model record.
retryAt Time Timestamp after which the IssuableMetricImageUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the IssuableMetricImageUploadRegistry.
state RegistryState Sync state of the IssuableMetricImageUploadRegistry.
verificationChecksum String The local checksum of the IssuableMetricImageUploadRegistry.
verificationChecksumMismatched String The expected checksum of the IssuableMetricImageUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the IssuableMetricImageUploadRegistry.
verificationRetryAt Time Timestamp after which the IssuableMetricImageUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the IssuableMetricImageUploadRegistry.
verificationStartedAt Time Timestamp when the verification of IssuableMetricImageUploadRegistry started.
verificationState VerificationStateEnum Verification state of the IssuableMetricImageUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the IssuableMetricImageUploadRegistry.

IssuableMetricImageUploadRegistryConnection#

Paginated collection of IssuableMetricImageUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

IssuableResourceLinkConnection#

Paginated collection of IssuableResourceLink. See Standard connection fields for the fields available on every connection.

Issue#

Implements: CurrentUserTodos, NoteableInterface, Todoable

Fields#

Name Type Description
alertManagementAlert AlertManagementAlert Deprecated in GitLab 15.6. Use alert_management_alerts.
alertManagementAlerts AlertManagementAlertConnection Alert Management alerts associated to this issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementAlerts:
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 the criteria.
statuses ([AlertManagementStatus!])
Alerts with the specified statues. For example, [TRIGGERED].
assignees UserCoreConnection Assignees of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
author UserCore! User that created the issue.
availableQuickActions [QuickActionCommand!] Quick actions available to the current user on the issue.
blocked Boolean! Indicates the issue is blocked.
blockedByCount Int Count of issues blocking the issue.
blockedByIssues IssueConnection Issues blocking the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingCount Int! Count of issues the issue is blocking.
closedAsDuplicateOf Issue Issue the issue was closed as a duplicate of.
closedAt Time Timestamp of when the issue was closed.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
customerRelationsContacts CustomerRelationsContactConnection Customer relations contacts of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String Description of the issue.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designCollection DesignCollection Collection of design images associated with the issue.
discussionLocked Boolean! Indicates discussion is locked on the issue.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
downvotes Int! Number of downvotes the issue has received.
dueDate Time Due date of the issue.
emailsDisabled Boolean! Deprecated in GitLab 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 Deprecated in GitLab 17.5. Replaced by WorkItem type.
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 as an experiment in GitLab 16.5.

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 String! Internal ID of the issue.
issuableResourceLinks IssuableResourceLinkConnection Issuable resource links of the incident issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issuableResourceLinks:
incidentId (IssueID!)
ID of the incident.
iteration Iteration Iteration of the issue.
labels LabelConnection Labels of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems LinkedWorkItemTypeConnection Introduced as an experiment in GitLab 17.8.

Work items linked to the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedWorkItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
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.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
participants UserCoreConnection List of participants in the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projectId Int ID of the issue project.
reference String! Internal reference of the issue. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Boolean option specifying whether the reference should be returned in full.
relatedMergeRequests MergeRequestConnection Merge requests related to the issue. This field can only be resolved for one issue in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
relatedVulnerabilities VulnerabilityConnection Related vulnerabilities of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
startDate Time Start date of the issue.
state IssueState! State of the issue.
status WorkItemStatus Introduced as an experiment in GitLab 18.0.

Status 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String! Title of the issue.
titleHtml String HTML 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.
workItemType WorkItemType! Type assigned to the issue.

IssueConnection#

Paginated collection of Issue. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
weight Int! Total weight of issues collection.

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.
adminIssueRelation Boolean! If true, the user can perform admin_issue_relation on this resource.
cloneIssue Boolean! If true, the user can perform clone_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.
moveDesign Boolean! If true, the user can perform move_design on this resource.
moveIssue Boolean! If true, the user can perform move_issue 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.

Implements: TimeboxReportInterface

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.
group Group! Group of the iteration.
id ID! ID of the iteration.
iid String! Internal ID of the iteration.
iterationCadence IterationCadence! Cadence of the iteration.
report TimeboxReport Historically accurate report about the timebox.

Arguments for report:
fullPath (String)
Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.
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.

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 the cadence.
id IterationsCadenceID! Global ID of the iteration cadence.
iterationsInAdvance Int Number of future iterations to schedule in addition to the current one.
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.

IterationCadenceConnection#

Paginated collection of IterationCadence. See Standard connection fields for the fields available on every connection.

IterationConnection#

Paginated collection of Iteration. See Standard connection fields for the fields available on every connection.

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.

JiraImportConnection#

Paginated collection of JiraImport. See Standard connection fields for the fields available on every connection.

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.

JiraProjectConnection#

Paginated collection of JiraProject. See Standard connection fields for the fields available on every connection.

JiraService#

Implements: Service

Fields#

Name Type Description
active Boolean Indicates if the service is active.
projects JiraProjectConnection List of all Jira projects fetched through Jira REST API. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
name (String)
Project name or key.
serviceType ServiceType Type of the service.
type String Class name of the service.

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.
checksumMismatch Boolean Indicate if the checksums of the JobArtifactRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the JobArtifactRegistry was created.
dataManagementDetailsPath String Path to the data management view for this JobArtifactRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the JobArtifactRegistry is missing on primary.
modelRecordId Int ID of the JobArtifactRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the JobArtifactRegistry in case of mismatch.
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 of JobArtifactRegistry started.
verificationState VerificationStateEnum Verification state of the JobArtifactRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the JobArtifactRegistry.

JobArtifactRegistryConnection#

Paginated collection of JobArtifactRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

JobNeedUnionConnection#

Paginated collection of JobNeedUnion. See Standard connection fields for the fields available on every connection.

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 GitLab Relay (KAS) is enabled.
externalK8sProxyUrl String URL used by the Kubernetes tooling to communicate with the KAS Kubernetes API proxy.
externalUrl String URL used by the agents to communicate with the server.
version String KAS version.

Key#

Represents an SSH key.

Implements: Todoable

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.
name String Name or title of the object.
title String! Title of the key.
webUrl String URL of the object.

KubernetesAnnotation#

Annotation to apply to associated Kubernetes objects of a workspace.

Fields#

Name Type Description
key String! Key of the annotation.
value String! Value of the annotation.

KubernetesLabel#

Label to apply to associated Kubernetes objects of a workspace.

Fields#

Name Type Description
key String! Key of the label.
value String! Value of the label.

Label#

Implements: LabelInterface

Fields#

Name Type Description
archived Boolean! Indicates the label is archived.
color String! Background color of the label.
createdAt Time! When the label was created.
description String Description of the label (Markdown rendered as HTML for caching).
descriptionHtml String GitLab Flavored Markdown rendering of description.
id LabelID! Global ID of the label.
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 the label was last updated.

LabelConnection#

Paginated collection of Label. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

Represents an instance-level LDAP link.

Fields#

Name Type Description
adminMemberRole AdminMemberRole! Custom admin member role.
cn String Common Name (CN) of the LDAP group.
createdAt Time! Timestamp of when the role link was created.
filter String Search filter for the LDAP group.
id ID! ID of the LDAP link.
lastSuccessfulSyncAt Time Timestamp of the last successful sync.
provider LdapProvider! LDAP provider for the LDAP link.
syncEndedAt Time Timestamp of when the last sync ended.
syncError String Error message if the sync has failed.
syncStartedAt Time Timestamp of when the last sync started.
syncStatus LdapAdminRoleSyncStatus Status of the last sync.

LdapAdminRoleLinkConnection#

Paginated collection of LdapAdminRoleLink. See Standard connection fields for the fields available on every connection.

LdapProvider#

Represents a LDAP provider.

Fields#

Name Type Description
id String ID of the LDAP provider.
label String Display name of the LDAP provider.

LfsObjectRegistry#

Represents the Geo sync and verification state of an LFS object.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the LfsObjectRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the LfsObjectRegistry was created.
dataManagementDetailsPath String Path to the data management view for this LfsObjectRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the LfsObjectRegistry is missing on primary.
modelRecordId Int ID of the LfsObjectRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the LfsObjectRegistry in case of mismatch.
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 of LfsObjectRegistry started.
verificationState VerificationStateEnum Verification state of the LfsObjectRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the LfsObjectRegistry.

LfsObjectRegistryConnection#

Paginated collection of LfsObjectRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

License#

Fields#

Name Type Description
name String! Name of the license.
policyViolations [PolicyDismissal!] Policy dismissals associated with the license for the dependency.
spdxIdentifier String Name of the SPDX identifier.
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 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.

LicenseHistoryEntryConnection#

Paginated collection of LicenseHistoryEntry. See Standard connection fields for the fields available on every connection.

LicensedFeatureAvailability#

Represents the availability of a licensed feature for a namespace or project.

Fields#

Name Type Description
available Boolean! Whether the feature is available on the current plan.
requiredPlan String The minimum plan required to access this feature. Returns null if the required plan cannot be determined.

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.
workItemState WorkItemState! State of the linked work item.

LinkedWorkItemTypeConnection#

Paginated collection of LinkedWorkItemType. See Standard connection fields for the fields available on every connection.

Location#

Fields#

Name Type Description
ancestors [AncestorType!] Ancestors of the dependency.
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.
topLevel Boolean Is top level dependency.

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.

Represents links to perform actions on the model.

Fields#

Name Type Description
showPath String Path to the details page of the model.

Represents links to perform actions on the model version.

Fields#

Name Type Description
importPath String File upload path for the machine learning model.
packagePath String Path to the package of the model version.
showPath String Path to the details page of the model version.

MavenLocalUpstream#

Represents a Maven local upstream registry.

Fields#

Name Type Description
cacheValidityHours Int! Introduced as an experiment in GitLab 19.5.

Time before the cache expires for the local upstream registry.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the local upstream registry.
localGroup MavenLocalUpstreamTargetGroup Introduced as an experiment in GitLab 19.5.

Group the local upstream registry serves packages from. Null when the local upstream registry targets a project, or when the user cannot read the group.
localProject MavenLocalUpstreamTargetProject Introduced as an experiment in GitLab 19.5.

Project the local upstream registry serves packages from. Null when the local upstream registry targets a group, or when the user cannot read the project.
metadataCacheValidityHours Int! Introduced as an experiment in GitLab 19.5.

Time before the cache expires for Maven metadata.
name String! Introduced as an experiment in GitLab 19.5.

Name of the local upstream registry.

MavenLocalUpstreamTargetGroup#

Group a Maven local upstream registry serves packages from.

Fields#

Name Type Description
fullPath ID! Introduced as an experiment in GitLab 19.5.

Full path of the group.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the group.
webUrl String Introduced as an experiment in GitLab 19.5.

Web URL of the group.

MavenLocalUpstreamTargetProject#

Project a Maven local upstream registry serves packages from.

Fields#

Name Type Description
fullPath ID! Introduced as an experiment in GitLab 19.5.

Full path of the project.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the project.
webUrl String Introduced as an experiment in GitLab 19.5.

Web URL of the project.

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.

MavenRegistry#

Represents a Maven virtual registry.

Implements: RegistryInterface

Fields#

Name Type Description
description String Description of the virtual registry.
id ID! ID of the virtual registry.
name String! Name of the virtual registry.
updatedAt Time! Timestamp of when the virtual registry was updated.

MavenRegistryConnection#

Paginated collection of MavenRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MavenRegistryDetails#

Represents Maven virtual registry details.

Implements: RegistryInterface

Fields#

Name Type Description
description String Description of the virtual registry.
id ID! ID of the virtual registry.
name String! Name of the virtual registry.
registryUpstreams [MavenRegistryUpstreamWithUpstream!]! Introduced as an experiment in GitLab 18.7.

List of registry upstreams for the Maven virtual registry.
updatedAt Time! Timestamp of when the virtual registry was updated.

MavenRegistryUpstreamWithRegistry#

Represents a Maven virtual registry upstream and its relationship to the registry.

Implements: RegistryUpstreamInterface

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
position Int! Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.
registry MavenRegistry! Introduced as an experiment in GitLab 18.6.

Maven registry associated with the registry upstream.

MavenRegistryUpstreamWithUpstream#

Represents a Maven virtual registry upstream and its relationship to the upstream.

Implements: RegistryUpstreamInterface

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
position Int! Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.
targetUpstream MavenTargetUpstream Introduced as an experiment in GitLab 19.5.

Maven remote or local upstream associated with the registry upstream.
upstream MavenUpstream! Introduced as an experiment in GitLab 18.7.

Maven upstream associated with the registry upstream.

MavenUpstream#

Represents a Maven upstream registry.

Implements: UpstreamInterface

Fields#

Name Type Description
cacheValidityHours Int! Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
description String Introduced as an experiment in GitLab 18.1.

Description of the upstream registry.
id ID! Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
metadataCacheValidityHours Int! Introduced as an experiment in GitLab 18.4.

Time before the cache expires for Maven metadata.
name String! Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCount Int! Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
rulesCount Int! Introduced as an experiment in GitLab 18.10.

Total number of rules for the upstream.
url String! Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.
username String Introduced as an experiment in GitLab 18.1.

Username to sign in to the upstream registry.

MavenUpstreamCacheEntry#

Represents a cache entry for a Maven upstream.

Implements: EntryInterface

Fields#

Name Type Description
contentType String! Introduced as an experiment in GitLab 18.9.

Content type of the cached file.
createdAt Time! Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was created.
downloadedAt Time Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last downloaded.
downloadsCount Int! Introduced as an experiment in GitLab 18.9.

Number of times the entry has been downloaded.
fileMd5 String Introduced as an experiment in GitLab 18.9.

MD5 hash of the cached file.
fileSha1 String! Introduced as an experiment in GitLab 18.9.

SHA1 hash of the cached file.
id String! Introduced as an experiment in GitLab 18.9.

ID of the cache entry.
relativePath String! Introduced as an experiment in GitLab 18.9.

Relative path of the cached entry.
size BigInt! Introduced as an experiment in GitLab 18.9.

Size of the cached file in bytes.
updatedAt Time! Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last updated.
upstreamCheckedAt Time Introduced as an experiment in GitLab 18.9.

Timestamp when the upstream was last checked.
upstreamEtag String Introduced as an experiment in GitLab 18.9.

ETag from the upstream source.

MavenUpstreamCacheEntryConnection#

Paginated collection of MavenUpstreamCacheEntry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MavenUpstreamConnection#

Paginated collection of MavenUpstream. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MavenUpstreamDetails#

Represents Maven upstream registry details.

Implements: UpstreamInterface

Fields#

Name Type Description
allowRules [MavenUpstreamRule!]! Introduced as an experiment in GitLab 18.10.

Allow rules for the upstream.
cacheEntries MavenUpstreamCacheEntryConnection Introduced as an experiment in GitLab 18.7.

Represents cache entries for the upstream. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cacheEntries:
search (String)
Search cache entries by relative path.
cacheValidityHours Int! Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
denyRules [MavenUpstreamRule!]! Introduced as an experiment in GitLab 18.10.

Deny rules for the upstream.
description String Introduced as an experiment in GitLab 18.1.

Description of the upstream registry.
id ID! Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
metadataCacheValidityHours Int! Introduced as an experiment in GitLab 18.4.

Time before the cache expires for Maven metadata.
name String! Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCount Int! Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
registryUpstreams [MavenRegistryUpstreamWithRegistry!]! Introduced as an experiment in GitLab 18.2.

Represents the upstream registry for the upstream which contains the position data.
rulesCount Int! Introduced as an experiment in GitLab 18.10.

Total number of rules for the upstream.
url String! Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.
username String Introduced as an experiment in GitLab 18.1.

Username to sign in to the upstream registry.

MavenUpstreamRule#

Represents a Maven upstream rule.

Implements: RuleInterface

Fields#

Name Type Description
createdAt Time! When the rule was created.
id VirtualRegistriesPackagesMavenUpstreamRuleID! Global ID of the rule.
pattern String! Pattern for the rule.
patternType MavenUpstreamPatternType! Type of pattern (WILDCARD or REGEX).
targetCoordinate MavenUpstreamTargetCoordinate! Target coordinate for the rule.

MemberApproval#

Represents a Member Approval queued for role promotion.

Fields#

Name Type Description
createdAt Time Timestamp when the member approval was created.
member MemberInterface Member associated with the member approval object.
memberRoleId ID ID of the member role.
newAccessLevel AccessLevel New GitLab::Access level requested for the member.
oldAccessLevel AccessLevel Existing GitLab::Access level for the member.
requestedBy UserCore User who requested the member promotion.
reviewedBy UserCore User who reviewed the member promotion.
status String Status for the member approval request (approved, denied, pending).
updatedAt Time Timestamp when the member approval was last updated.
user UserCore User that is associated with the member approval object.

MemberApprovalConnection#

Paginated collection of MemberApproval. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MemberInterfaceConnection#

Paginated collection of MemberInterface. See Standard connection fields for the fields available on every connection.

MemberRole#

Represents a member role.

Implements: CustomRoleInterface, RoleInterface

Fields#

Name Type Description
baseAccessLevel AccessLevel! Introduced as an experiment in GitLab 16.5.

Base access level for the custom role.
createdAt Time! Timestamp of when the member role was created.
dependentSecurityPolicies [ApprovalPolicy!] Array of security policies dependent on the custom role.
description String Role description.
detailsPath String Introduced as an experiment in GitLab 17.4.

URL path to the role details webpage.
editPath String! Introduced as an experiment in GitLab 16.11.

Web UI path to edit the custom role.
enabledPermissions CustomizableStandardPermissionConnection! Introduced as an experiment in GitLab 16.5.

Array of all permissions enabled for the custom role. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Role ID.
membersCount Int Introduced as an experiment in GitLab 17.3.

Number of times the role has been directly assigned to a group or project member.
name String Role name.
usersCount Int Introduced as an experiment in GitLab 17.5.

Number of users who have been directly assigned the role in at least one group or project.

MemberRoleConnection#

Paginated collection of MemberRole. See Standard connection fields for the fields available on every connection.

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 the access level.
group AccessLevelGroup Group associated with the access level.
memberRole MemberRole Custom role associated with the access level.
user AccessLevelUser User associated with the access level.

MergeAccessLevelConnection#

Paginated collection of MergeAccessLevel. See Standard connection fields for the fields available on every connection.

MergeRequest#

Implements: CurrentUserTodos, NoteableInterface, Todoable

Fields#

Name Type Description
aiSuggestedReviewers AiSuggestedReviewerConnection Introduced as an experiment in GitLab 19.4.

AI-recommended reviewers for the merge request. Returns null unless the recommend reviewers flow is enabled for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
allowCollaboration Boolean Indicates if members of the target project can push to the fork.
allowsMultipleAssignees Boolean! Allows assigning multiple users to a merge request.
allowsMultipleReviewers Boolean! Allows assigning multiple reviewers to a merge request.
approvalState MergeRequestApprovalState! Information relating to rules that must be satisfied to merge the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
assignees MergeRequestAssigneeConnection Assignees of the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
author MergeRequestAuthor User who created the 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.
availableQuickActions [QuickActionCommand!] Quick actions available to the current user on the merge request.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingMergeRequests BlockingMergeRequests Introduced as an experiment in GitLab 16.5.

Merge requests that block another merge request from merging.
changeRequesters UserCoreConnection Users that have requested changes to the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
closedAt Time Timestamp of when the merge request was closed, null if not closed.
codequalityReportsComparer CodequalityReportsComparer Code quality reports comparison reported on the merge request.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitCount Int Number of commits in the merge request.
commits CommitConnection Merge request commits. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitsWithoutMergeCommits CommitConnection Merge request commits excluding merge commits. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
committers UserCoreConnection Users who have added commits to the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
conflictFiles [MergeRequestConflict!] Introduced as an experiment in GitLab 19.4.

Files with conflicts that prevent the merge request from being merged, including raw Git conflict markers. Null unless the merge request cannot be merged and the current user can push to the source branch. This field can only be resolved once per request.
conflictStatus MergeRequestConflictStatus Introduced as an experiment in GitLab 19.4.

Why conflict files are or are not available. Use alongside conflictFiles to distinguish permission errors, unchecked mergeability, and missing branches.
conflicts Boolean! Indicates if the merge request has conflicts.
createdAt Time! Timestamp of when the merge request was created.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
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.
diffRefs DiffRefs References of the base SHA, the head SHA, and the start SHA for the merge request.
diffStats [DiffStats!] Details about which files were changed in the merge request.

Arguments for diffStats:
path (String)
Specific file path.
diffStatsSummary DiffStatsSummary Summary of which files were changed in the merge request.
diffs DiffConnection Introduced as an experiment in GitLab 19.4.

Diffs of the merge request, including per-file patch text. Files whose content is omitted because they exceed size limits are reported with the collapsed or too_large flags. When a page exceeds the diff size limits, later files are omitted entirely and the connection overflow field is set. Supports forward-only pagination. This field can only be resolved 10 times in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for diffs:
expanded (Boolean)
Return full patch text even for files that would otherwise be collapsed for size.
discussionLocked Boolean! Indicates if comments on the merge request are locked to members only.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
discussionsWithActivity DiscussionConnection! Introduced as an experiment in GitLab 19.2.

Discussions on the merge request, including synthetic system notes generated from resource events such as label, milestone, and state changes. Supports forward-only pagination. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for discussionsWithActivity:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
sort (WorkItemDiscussionsSort)
Sort order for the discussions.
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.
duoDependencyBumpBreakingChangesAvailable Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether the GitLab Duo resolve dependency bump breaking changes flow can be triggered for the merge request.
duoWorkflowLinks DuoWorkflowMergeRequestLinkConnection GitLab Duo Agent Platform sessions linked to the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowLinks:
linkType (DuoWorkflowMergeRequestLinkType)
Filter links by their link type.
duoWorkflows DuoWorkflowConnection Introduced as an experiment in GitLab 18.10.

Duo Workflow sessions associated with the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
findingReportsComparer FindingReportsComparer Introduced as an experiment in GitLab 16.1.

Vulnerability finding reports comparison reported on the merge request.

Arguments for findingReportsComparer:
reportType (ComparableSecurityReportType!)
Filter vulnerability findings by report type.
scanMode (ScanModeEnum)
Filter results by scan mode.
forceRemoveSourceBranch Boolean Indicates if the project settings will lead to source branch deletion after merge.
groupedApprovalsLeft Int Introduced as an experiment in GitLab 19.4.

Number of approvals left, counting Code Owner rules that share a section and approvers as a single rule.
groupedApprovalsRequired Int Introduced as an experiment in GitLab 19.4.

Number of approvals required, counting Code Owner rules that share a section and approvers as a single rule.
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.
hidden Boolean Indicates the merge request is hidden because the author has been banned.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems [MergeRequestLinkedWorkItem!] Deprecated in GitLab 19.2. Use workItemRelations instead.

Arguments for linkedWorkItems:
types ([MergeRequestWorkItemLinkType!])
Filter by link types. Returns all types if not specified.
mergeAfter Time Date after which the merge request can be merged.
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 as an experiment in GitLab 16.2.

Diff versions of a merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
mergeStatus String Deprecated in GitLab 14.0. Renamed. Use MergeRequest.mergeStatusEnum instead.
mergeStatusEnum MergeStatus Merge status of the merge request.
mergeTrainCar MergeTrainCar Introduced as an experiment in GitLab 17.2.

Represents the merge request in a merge train.
mergeTrainIndex Int Deprecated in GitLab 17.4. Use index on MergeTrains::CarType instead.
mergeTrainsCount Int Deprecated in GitLab 17.4. Use count from cars connection on MergeTrains::TrainType instead.
mergeUser UserCore User who merged the merge request or set it to auto-merge.
mergeWhenPipelineSucceeds Boolean Deprecated in GitLab 17.11. Renamed. Use MergeRequest.autoMergeEnabled instead.
mergeabilityChecks [MergeRequestMergeabilityCheck!]! Introduced as an experiment in GitLab 16.5.

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.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
participants MergeRequestParticipantConnection Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipelineCreationRequests [CiPipelineCreationRequest!]! Pipeline creation requests for the merge request.
pipelines PipelineConnection Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelines:
ids ([ID!])
Filter pipelines by their Global IDs. Maximum 20 IDs per request.
ref (String)
Filter pipelines by the ref they are run for.
refType (RefType)
Type of ref.
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 the date.
updatedBefore (Time)
Pipelines updated before the date.
username (String)
Filter pipelines by the user that triggered the pipeline.
policiesOverridingApprovalSettings [PolicyApprovalSettingsOverride!] Approval settings that are overridden by the policies for the merge request.
policyBypassStatuses [PolicyBypassStatus!] Introduced as an experiment in GitLab 18.5.

List of bypass settings for security policies.
policyViolations PolicyViolationDetails Policy violations reported on the merge request.
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.
reference String! Internal reference of the merge request. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Boolean option specifying whether the reference should be returned in full.
resolvableDiscussionsCount Int Number of user discussions that are resolvable in the merge request.
resolvedDiscussionsCount Int Number of user discussions that are resolved in the merge request.
resourceLabelEvents MergeRequestResourceLabelEventConnection Label events of the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for resourceLabelEvents:
labelId (LabelID)
Global ID of the label to filter the label events.
retargeted Boolean Indicates if merge request was retargeted.
reviewers MergeRequestReviewerConnection Users from whom a review has been requested. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
riskAssessment MergeRequestRiskAssessment Introduced as an experiment in GitLab 19.4.

Risk assessment for the merge request. Ultimate only.
securityAutoFix Boolean Deprecated in GitLab 16.11. Security Auto Fix experiment feature was removed. It was always hidden behind security_auto_fix feature flag.
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.
squashReadOnly Boolean! Indicates if squashReadOnly is enabled.
stack [MergeRequest!] Other open merge requests in the same stack as this merge request, ordered from the top of the stack to the bottom. Returns null if this merge request is not part of a stack, or if the stack contains more than 20 merge requests.
state MergeRequestState! State of the merge request.
subscribed Boolean! Indicates if the currently logged in user is subscribed to the merge request.
suggestedReviewers SuggestedReviewersType Suggested reviewers for merge request.
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.
targetBranchPath String Path to the target branch of the merge request.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String! Title of the merge request.
titleHtml String HTML 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.
webPath String! Web path of the merge request.
webUrl String Web URL of the merge request.
workItemRelations MergeRequestWorkItemRelationConnection Relations between this merge request and work items (closing or mentioned). This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemRelations:
types ([MergeRequestWorkItemLinkType!])
Filter by link types. Returns all types if not specified.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

MergeRequestAssignee#

A user assigned to a merge request.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

MergeRequestAssigneeConnection#

Paginated collection of MergeRequestAssignee. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MergeRequestAuthor#

The author of the merge request.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

MergeRequestConflict#

File with conflicts in a merge request that cannot be merged.

Fields#

Name Type Description
content String Raw content of the conflicting file, including Git conflict markers. Returns null for files with unsupported encodings (binary, non-UTF-8).
ourPath String Path of the conflicting file on the source branch.
theirPath String Path of the conflicting file on the target branch.

MergeRequestConnection#

Paginated collection of MergeRequest. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
totalTimeToMerge Float Total sum of time to merge, in seconds, for the collection of merge requests.

MergeRequestDiff#

A diff version of a merge request.

Fields#

Name Type Description
createdAt Time! Timestamp of when the diff was created.
updatedAt Time! Timestamp of when the diff was updated.

MergeRequestDiffConnection#

Paginated collection of MergeRequestDiff. See Standard connection fields for the fields available on every connection.

MergeRequestDiffRegistry#

Represents the Geo sync and verification state of a Merge Request diff.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the MergeRequestDiffRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the MergeRequestDiffRegistry was created.
dataManagementDetailsPath String Path to the data management view for this MergeRequestDiffRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the MergeRequestDiffRegistry is missing on primary.
modelRecordId Int ID of the MergeRequestDiffRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the MergeRequestDiffRegistry in case of mismatch.
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 of MergeRequestDiffRegistry started.
verificationState VerificationStateEnum Verification state of the MergeRequestDiffRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the MergeRequestDiffRegistry.

MergeRequestDiffRegistryConnection#

Paginated collection of MergeRequestDiffRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MergeRequestExternalIssue#

An external issue referenced by a merge request.

Fields#

Name Type Description
reference String! Reference of the external issue (e.g. JIRA-123).
title String Title of the external issue.
webUrl String URL of the external issue on the external tracker.

MergeRequestLinkedWorkItem#

A work item linked to a merge request.

Fields#

Name Type Description
externalIssue MergeRequestExternalIssue Linked external issue.
linkType MergeRequestWorkItemLinkType! Type of relationship between the merge request and work item.
workItem WorkItem Linked work item.

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.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

MergeRequestParticipantConnection#

Paginated collection of MergeRequestParticipant. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

MergeRequestResourceLabelEvent#

Label event on a merge request.

Fields#

Name Type Description
action ResourceLabelEventAction! Action of the label event.
createdAt Time! Timestamp of when the label event was created.
id ResourceLabelEventID! Global ID of the label event.
label Label Label associated with the event. Null if the label was deleted.
user UserCore User who triggered the event.

MergeRequestResourceLabelEventConnection#

Paginated collection of MergeRequestResourceLabelEvent. See Standard connection fields for the fields available on every connection.

MergeRequestReviewer#

A user assigned to a merge request as a reviewer.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

MergeRequestReviewerConnection#

Paginated collection of MergeRequestReviewer. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MergeRequestRiskAssessment#

Risk assessment for a merge request.

Fields#

Name Type Description
assessedAt Time When the assessment completed.
confidence Int Confidence in the score, from 0 to 100. Derived from how much of the change could be measured and whether the signals agreed.
confidenceTier MergeRequestRiskConfidenceTier Tier derived from the confidence score.
contributingSignals [MergeRequestRiskContributingSignal!]! What each signal contributed to the score.
domainTags [String!]! Risk domains the change touches, used to route specialist review.
duoWorkflowId Int ID of the Duo workflow session that produced the assessment.
missingSignals [MergeRequestRiskMissingSignal!]! Signals that could not be measured, which is why confidence may be low.
rationale String Plain-language explanation of the assessment.
risk Int Risk score from 0 to 100.
riskTier MergeRequestRiskTier Tier derived from the risk score.
stale Boolean! Whether the merge request has changed since it was assessed. Assessment runs once, so this is a notice rather than a trigger to re-run.
status MergeRequestRiskAssessmentStatus! Status of the assessment.

MergeRequestRiskContributingSignal#

Contribution a single signal made to a merge request risk score.

Fields#

Name Type Description
contribution Float! Points the signal added to the overall score.
detail String Human-readable explanation of the contribution.
label String Human-readable name of the signal or claim. Null when the key matches neither a registered signal nor a risk domain.
signal String! Name of the signal or claim.

MergeRequestRiskMissingSignal#

A signal that could not be measured for a merge request risk assessment.

Fields#

Name Type Description
label String Human-readable name of the signal or claim. Null when the key matches neither a registered signal nor a risk domain.
signal String! Name of the signal or claim.

MergeRequestSavedView#

Saved view on the merge request dashboard.

Fields#

Name Type Description
filters JSON! Merge request filters stored in the saved view.
id MergeRequestsSavedViewID! Global ID of the saved view.
name String! Name of the saved view.
userPermissions MergeRequestSavedViewPermissions! Permissions for the current user on the resource.

MergeRequestSavedViewConnection#

Paginated collection of MergeRequestSavedView. See Standard connection fields for the fields available on every connection.

MergeRequestSavedViewPermissions#

Check permissions for the current user on a merge request saved view.

Fields#

Name Type Description
deleteSavedView Boolean! If true, the user can perform delete_saved_view on this resource.
updateSavedView Boolean! If true, the user can perform update_saved_view on this resource.

MergeRequestWorkItemRelation#

A relation between a merge request and a work item.

Fields#

Name Type Description
fromMrDescription Boolean! Whether the relation was derived from a closing pattern in the merge request description.
id MergeRequestIssueID! Global ID of the merge request to work item relation.
linkType MergeRequestWorkItemLinkType! Type of relationship between the merge request and the work item.
workItem WorkItem Related work item.

MergeRequestWorkItemRelationConnection#

Paginated collection of MergeRequestWorkItemRelation. See Standard connection fields for the fields available on every connection.

MergeRequestsAggregationResponse#

Response for MergeRequests aggregation engine.

Fields#

Name Type Description
acceptanceRate Float Share of merge requests that were merged.
dimensions MergeRequestsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
throughputCount Int Number of merged merge requests.
timeToMerge MergeRequestsAggregationResponseTimeToMergeMetrics Aggregated time_to_merge metrics.
timeToMergeQuantile Float Time to merge quantile in milliseconds.

Arguments for timeToMergeQuantile:
quantile (Float)
Quantile level between 0.0 and 1.0 (e.g. 0.5 for median).
totalCount Int Total number of merge requests.

MergeRequestsAggregationResponseConnection#

Paginated collection of MergeRequestsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

MergeRequestsAggregationResponseDimensions#

Response dimensions for MergeRequests aggregation engine.

Fields#

Name Type Description
author UserCore Merge request author.
createdAt Date Merge request creation date.

Arguments for createdAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
createdByDuo Boolean Whether the merge request was created by a GitLab Duo session.
metricMergedAt Date Merge request merge date.

Arguments for metricMergedAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
stateId String Merge request state.
targetBranch String Target branch of the merge request.

MergeRequestsAggregationResponseTimeToMergeMetrics#

Aggregated time_to_merge metrics for MergeRequests aggregation engine.

Fields#

Name Type Description
max Int Maximum time to merge in seconds.
mean Float Mean time to merge in seconds.
min Int Minimum time to merge in seconds.
quantile Float Quantile of time to merge in seconds.

Arguments for quantile:
quantile (Float)
sum Float Sum of time to merge in seconds.

MergeRequestsAggregationScope#

Aggregation scope for MergeRequests. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated MergeRequestsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

MergeTrain#

Represents a set of cars/merge_requests queued for merging.

Fields#

Name Type Description
cars MergeTrainCarConnection! Introduced as an experiment in GitLab 17.1.

Cars queued in the train. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cars:
activityStatus (MergeTrainStatus!)
Filter by the high-level status of the cars. Defaults to ACTIVE.
targetBranch String! Target branch of the car's merge request.

MergeTrainCar#

MergeTrainCar represents an attempt to merge a merge requestusing merge trains.

Fields#

Name Type Description
createdAt Time! Timestamp of when the car was created.
duration Int Duration of the car.
id MergeTrainsCarID! Global ID of the car.
index Int Zero-based position of the car in the merge train. Returns null if the car is not active in a merge train.
mergeRequest MergeRequest! Merge request the car contains.
mergedAt Time Timestamp of when the car was merged.
pipeline Pipeline Pipeline of the car.
status CarStatus! Status of the car.
targetBranch String! Target branch of the car's merge request.
targetProject Project! Project the car's MR targets.
updatedAt Time! Timestamp of when the car was last updated.
user UserCore! Creator of the car (user who added the merge request to the train).
userPermissions CarPermissions! Permissions for the current user on the resource.

MergeTrainCarConnection#

Paginated collection of MergeTrainCar. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MergeTrainConnection#

Paginated collection of MergeTrain. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

Metadata#

Fields#

Name Type Description
enterprise Boolean! Enterprise edition.
featureFlags [GitlabInstanceFeatureFlag!]! Introduced as an experiment in GitLab 17.4.

Feature flags for the GitLab instance. External API consumers should read the feature flag guidance before using this field.

Arguments for featureFlags:
names ([String!]!)
Names of the feature flags to lookup (maximum of 20).
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 String! 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.

Implements: TimeboxReportInterface

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.
group Group Group of the milestone.
groupMilestone Boolean! Indicates if milestone is at group level.
id ID! ID of the milestone.
iid ID! Internal ID of the milestone.
project Project Project of the milestone.
projectMilestone Boolean! Indicates if milestone is at project level.
releases ReleaseConnection Releases associated with the milestone. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
report TimeboxReport Historically accurate report about the timebox.

Arguments for report:
fullPath (String)
Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.
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.
upcoming Boolean! Upcoming state of the milestone (a milestone is upcoming when the start date is in the future). Defaults to false when start date has not been set.
updatedAt Time! Timestamp of last milestone update.
webPath String! Web path of the milestone.

MilestoneConnection#

Paginated collection of Milestone. See Standard connection fields for the fields available on every connection.

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.
ciJob CiJob CI information about the job that created the candidate.
createdAt Time! Date of creation.
creator UserCore User that created the candidate.
eid String! MLflow uuid for the candidate.
id MlCandidateID! ID of the candidate.
iid Int! IID of the candidate scoped to project.
metadata MlCandidateMetadataConnection! Metadata entries for the candidate. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
metrics MlCandidateMetricConnection! Metrics for the candidate. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the candidate.
params MlCandidateParamConnection! Parameters for the candidate. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
status String Candidate status.

MlCandidateConnection#

Paginated collection of MlCandidate. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlCandidateMetadata#

Metadata for a candidate in the model registry.

Fields#

Name Type Description
id MlCandidateMetadataID! ID of the metadata.
name String Name of the metadata entry.
value String! Value set for the metadata entry.

MlCandidateMetadataConnection#

Paginated collection of MlCandidateMetadata. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlCandidateMetric#

Metric for a candidate in the model registry.

Fields#

Name Type Description
id MlCandidateMetricID! ID of the metric.
name String Name of the metric.
step Int! Step at which the metric was measured.
value Float! Value set for the metric.

MlCandidateMetricConnection#

Paginated collection of MlCandidateMetric. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlCandidateParam#

Parameter for a candidate in the model registry.

Fields#

Name Type Description
id MlCandidateParamID! ID of the parameter.
name String Name of the parameter.
value String! Value set for the parameter.

MlCandidateParamConnection#

Paginated collection of MlCandidateParam. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlExperiment#

Machine learning experiment in model experiments.

Fields#

Name Type Description
candidateCount Int! Number of candidates in the experiment.
candidates MlCandidateConnection Candidates of the experiment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp of when the experiment was created.
creator UserCore User who created the experiment.
id MlExperimentID! ID of the experiment.
modelId MlModelID ID of the model.
name String! Name of the experiment.
path String! Web URL of the experiment.
updatedAt Time! Timestamp of when the experiment was updated.

MlExperimentConnection#

Paginated collection of MlExperiment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlModel#

Machine learning model in the model registry.

Fields#

Name Type Description
_links MLModelLinks! Map of links to perform actions on the model.
author UserCore User that created the model.
candidateCount Int Count of candidates in the model.
candidates MlCandidateConnection Version candidates of the model. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Date of creation.
defaultExperimentPath String Path to default experiment page for the model.
description String Description of the model.
descriptionHtml String GitLab Flavored Markdown rendering of description.
id MlModelID! ID of the model.
latestVersion MlModelVersion Latest version of the model.
name String! Name of the model.
version MlModelVersion Version of the model.

Arguments for version:
modelVersionId (MlModelVersionID)
Id of the version to be fetched.
versionCount Int Count of versions in the model.
versions MlModelVersionConnection Versions of the model. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
orderBy (MlModelVersionsOrderBy)
Ordering column. Default is created_at.
sort (SortDirectionEnum)
Ordering column. Default is desc.
version (String)
Search for versions where the name includes the string.

MlModelConnection#

Paginated collection of MlModel. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlModelVersion#

Version of a machine learning model.

Fields#

Name Type Description
_links MLModelVersionLinks! Map of links to perform actions on the model version.
artifactsCount Int Number of files in the package.
author UserCore User that created the model version.
candidate MlCandidate! Metrics, params and metadata for the model version.
createdAt Time! Date of creation.
description String Description of the version.
descriptionHtml String GitLab Flavored Markdown rendering of description.
id MlModelVersionID! ID of the model version.
packageId PackagesPackageID! Package for model version artifacts.
version String! Name of the version.

MlModelVersionConnection#

Paginated collection of MlModelVersion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MttrOverTimeBucket#

Mean time to remediation for a single weekly (Monday to Sunday) bucket, with optional breakdowns by severity and report type.

Fields#

Name Type Description
byReportType [MttrOverTimeByReportType!]! Remediation metrics for the bucket broken down by report type.
bySeverity [MttrOverTimeBySeverity!]! Remediation metrics for the bucket broken down by severity.
count Int! Number of vulnerabilities remediated in the bucket. Denominator of the MTTR average.
endDate ISO8601Date! End of the weekly bucket (Sunday). Capped at the current date, so the most recent bucket may be partial.
mttr Float Mean time to remediation, in days (sumDays / count). Null when no vulnerabilities were remediated in the bucket.
startDate ISO8601Date! Start of the weekly bucket (Monday).
sumDays Float! Sum of remediation time, in days, across vulnerabilities remediated in the bucket. Numerator of the MTTR average.

MttrOverTimeByReportType#

Mean time to remediation for a single report type within a weekly bucket.

Fields#

Name Type Description
count Int! Number of vulnerabilities of the report type remediated in the bucket.
mttr Float Mean time to remediation for the report type, in days (sumDays / count). Null when the count is 0.
reportType VulnerabilityReportType! Report type the breakdown applies to.
sumDays Float! Sum of remediation time, in days, across vulnerabilities of the report type remediated in the bucket.

MttrOverTimeBySeverity#

Mean time to remediation for a single severity within a weekly bucket.

Fields#

Name Type Description
count Int! Number of vulnerabilities of the severity remediated in the bucket.
mttr Float Mean time to remediation for the severity, in days (sumDays / count). Null when the count is 0.
severity VulnerabilitySeverity! Severity the breakdown applies to.
sumDays Float! Sum of remediation time, in days, across vulnerabilities of the severity remediated in the bucket.

Namespace#

Implements: Todoable

Fields#

Name Type Description
achievements AchievementConnection Achievements for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for achievements:
ids ([AchievementsAchievementID!])
Filter achievements by IDs.
achievementsPath String Path for the namespace's achievements. Returns null if the namespace is not a group.
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.
addOnEligibleUsers AddOnUserConnection Introduced as an experiment in GitLab 16.5.

Users in the namespace hierarchy that add-ons are applicable for. This only applies to root namespaces. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for addOnEligibleUsers:
addOnPurchaseIds ([GitlabSubscriptionsAddOnPurchaseID!]!)
Global IDs of the add on purchases to find assignments for.
addOnType (GitlabSubscriptionsAddOnType!)
Type of add on to filter the eligible users by.
filterByAssignedSeat (String)
Filter users list by assigned seat.
search (String)
Search the user list.
sort (GitlabSubscriptionsUserSort)
Sort the user list.
additionalPurchasedStorageSize Float Additional storage purchased for the root namespace in bytes.
aiDomainSettings StringConnection Introduced as an experiment in GitLab 19.0.

List of allowed or denied domains for AI features. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiDomainSettings:
domainSettingType (AiDomainSettingType!)
Type of domain setting to retrieve.
search (String)
Filter domains by substring match.
aiSettings AiNamespaceSettings Introduced as an experiment in GitLab 18.8.

AI settings for the namespace.
approvalPolicies ApprovalPolicyConnection Approval Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for approvalPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
availableFeatures NamespaceAvailableFeatures! Introduced as an experiment in GitLab 18.3.

Features available on the namespace.
avatarUrl String URL to avatar image file of the namespace.
canPushInitialCommit Boolean! Introduced as an experiment in GitLab 18.11.

Whether the current user can push the initial commit to the default branch of new projects in the namespace.
ciCdSettings CiCdSettings Introduced as an experiment in GitLab 17.9.

Namespace CI/CD settings for the namespace.
complianceFrameworks ComplianceFrameworkConnection Compliance frameworks available to projects in this namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceFrameworks:
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.
sort (ComplianceFrameworkSort)
Sort compliance frameworks by the criteria.
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.
customFields CustomFieldConnection Introduced as an experiment in GitLab 17.10.

Custom fields configured for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customFields:
active (Boolean)
Filter for active fields. If false, excludes active fields. If true, returns only active fields.
fieldType (CustomFieldType)
Filter for selected field type.
search (String)
Search query for custom field name.
workItemTypeId (WorkItemsTypeID)
Filter custom fields associated to the given work item type.
description String Description of the namespace.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designatedAsCsp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the namespace is designated to centrally manage security policies.
fullName String! Full name of the namespace.
fullPath ID! Full path of the namespace.
id ID! ID of the namespace.
importSourceUsers ImportSourceUserConnection Introduced as an experiment in GitLab 17.2.

Import source users of the namespace. This field can only be resolved for one namespace in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for importSourceUsers:
search (String)
Query to search mappings by name or username of users on source instance.
sort (SourceUserSort)
Sort mapping of users on source instance to users on destination instance by the criteria.
statuses ([ImportSourceUserStatus!])
Filter mapping of users on source instance to users on destination instance by status.
lfsEnabled Boolean Indicates if Large File Storage (LFS) is enabled for namespace.
licensedFeatureAvailability LicensedFeatureAvailability! Introduced as an experiment in GitLab 18.11.

Check whether a licensed feature is available.

Arguments for licensedFeatureAvailability:
feature (LicensedFeature!)
Feature to check availability for (for example, EPICS).
licensedFeatures NamespaceAvailableFeatures! Introduced as an experiment in GitLab 18.1.

Licensed features available on the namespace.
lifecycleTemplates [WorkItemLifecycle!] Introduced as an experiment in GitLab 18.4.

Lifecycle templates available to the namespace.
lifecycles WorkItemLifecycleConnection Introduced as an experiment in GitLab 18.1.

Lifecycles of work items available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkPaths NamespacesLinkPaths Introduced as an experiment in GitLab 18.1.

Namespace relevant paths to create links on the UI.
markdownPaths MarkdownPaths Introduced as an experiment in GitLab 18.1.

Namespace relevant paths to create markdown links on the UI.
mergeRequestsEnabled Boolean! Introduced as an experiment in GitLab 18.3.

Indicates if merge requests are enabled for the namespace.
metadata NamespaceMetadata Introduced as an experiment in GitLab 18.6.

Metadata information for the namespace.
name String! Name of the namespace.
namespaceSettings NamespaceSettings Namespace settings for the namespace.
packageSettings PackageSettings Package settings for the namespace.
pagesDeployments PagesDeploymentConnection List of the namespaces's Pages Deployments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pagesDeployments:
active (Boolean)
Filter by active or inactive state.
sort (Sort)
Sort results.
versioned (Boolean)
Filter deployments that are versioned or unversioned.
path String! Path of the namespace.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
pipelineExecutionSchedulePolicies PipelineExecutionSchedulePolicyConnection Pipeline Execution Schedule Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionSchedulePolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
plan NamespacePlan Introduced as an experiment in GitLab 18.2.

Subscription plan associated with the namespace.
projects ProjectConnection! Projects within this namespace. Returns projects from the parent group if namespace is project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
archivedOnly (Boolean)
Return only archived projects.
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.
includeArchived (Boolean)
Include also archived projects.
includeSiblingProjects (Boolean)
Introduced as an experiment in GitLab 17.2.

Include also projects from parent group.
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 the criteria.
withIssuesEnabled (Boolean)
Return only projects with issues enabled.
withMergeRequestsEnabled (Boolean)
Return only projects with merge requests enabled.
withNamespaceDomainPages (Boolean)
Return only projects that use the namespace domain for pages projects.
remoteDevelopmentClusterAgents ClusterAgentConnection Deprecated in GitLab 17.8. Use workspacesClusterAgents. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for remoteDevelopmentClusterAgents:
filter (NamespaceClusterAgentFilter!)
Filter the types of cluster agents to return.
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.
rootNamespace Namespace! Top-level namespace of the namespace.
rootStorageStatistics RootStorageStatistics Aggregated storage statistics of the namespace. Only available for root namespaces.
savedViews WorkItemSavedViewTypeConnection Introduced as an experiment in GitLab 18.7.

Saved views associated with the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for savedViews:
id (WorkItemsSavedViewsSavedViewID)
ID of the saved view. Required when requesting work_items, filters, or filter_warnings fields.
search (String)
Search query for saved view name or description.
sort (WorkItemsSavedViewsSort)
Sort work items by criteria. Default is ID.
subscribedOnly (Boolean)
Whether to return only saved views subscribed to by the current user.
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanExecutionPolicies:
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.
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
scanResultPolicies ScanResultPolicyConnection Deprecated in GitLab 16.9. Use approvalPolicies. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanResultPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
securityPolicies SecurityPolicyTypeConnection Introduced as an experiment in GitLab 18.1.

List of security policies configured for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicies:
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship.
type (PolicyType)
Filter policies by type.
securityPolicyProject Project Security policy project assigned to the namespace.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.
sidebar NamespaceSidebar Introduced as an experiment in GitLab 17.6.

Data needed to render the sidebar for the namespace.
statuses WorkItemStatusConnection Introduced as an experiment in GitLab 18.1.

Statuses of work items available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for statuses:
ids ([WorkItemsStatusesStatusID!])
Filter statuses by ID. A max of 70 can be provided.
storageSizeLimit Float The storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement.
subscribedSavedViewLimit Int! Introduced as an experiment in GitLab 18.8.

Maximum number of subscribed saved views allowed on the namespace.
subscriptionHistory GitlabSubscriptionHistoryConnection Introduced as an experiment in GitLab 17.3.

Find subscription history records. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
targetedMessages [TargetedMessage!] Introduced as an experiment in GitLab 18.7.

Targeted messages for the namespace.
timelogCategories TimeTrackingTimelogCategoryConnection Introduced as an experiment in GitLab 15.3.

Timelog categories for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
userPermissions NamespacePermissions! Permissions for the current user on the resource.
visibility String Visibility of the namespace.
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Introduced as an experiment in GitLab 17.7.

Vulnerability Management Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityManagementPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
webPath String Path of the namespace relative to the instance root.
webUrl String URL of the namespace.
workItem WorkItem Introduced as an experiment in GitLab 16.10.

Find a work item by IID directly associated with the namespace (project or group).

Arguments for workItem:
iid (String!)
IID of the work item.
workItemDescriptionTemplates WorkItemDescriptionTemplateConnection Introduced as an experiment in GitLab 17.6.

Work item description templates available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemDescriptionTemplates:
name (String)
Deprecated in GitLab 17.9. name and project ID are both required for fetching, use DescriptionTemplateContentInputType instead.
search (String)
Deprecated in GitLab 17.8. search on template names is performed on the FE only.
workItemMoveTargets [WorkItemMoveTarget!] Introduced as an experiment in GitLab 19.1.

Valid target work item types and a suggested default for moving work items of given source types into this namespace.

Arguments for workItemMoveTargets:
sourceFullPath (String!)
Full path of the source namespace. For example, gitlab-org/gitlab-foss.
sourceTypeIds ([WorkItemsTypeID!]!)
Global IDs of the source work item types to compute move targets for. A maximum of 50 IDs can be provided.
workItemSettings WorkItemSettings Introduced as an experiment in GitLab 19.0.

Work item settings for the namespace.
workItemStateCounts WorkItemStateCountsType Introduced as an experiment in GitLab 18.3.

Counts of work items by state for the namespace (project or group). Returns null for user namespaces.

Arguments for workItemStateCounts:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
excludeGroupWorkItems (Boolean)
Introduced as an experiment in GitLab 18.4.

Exclude group-level work items within the group and its descendants. Ignored for project namespaces.
excludeProjects (Boolean)
Introduced as an experiment in GitLab 17.5.

Exclude work items from projects within the group. Ignored for project namespaces.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeAncestors (Boolean)
Include work items from ancestor groups. Ignored for project namespaces.
includeArchived (Boolean)
Introduced as an experiment in GitLab 18.5.

Return work items from archived projects. Ignored for project namespaces.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
includeDescendants (Boolean)
Include work items from descendant groups and projects. Ignored for project namespaces.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe. Ignored for project namespaces.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemTypes WorkItemTypeConnection Introduced as an experiment in GitLab 17.2.

Work item types available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemTypes:
name (IssueType)
Deprecated in GitLab 19.0. Name-based filtering is no longer supported with introduction of configurable work item types in 19.0.
onlyAvailable (Boolean)
Introduced as an experiment in GitLab 18.6.

When true, returns only the available work item types for the current user. This experimental field will be removed in 19.0. Use canUserCreateItems and isFilterableListView fields from the WorkItemTypes API instead.
workItems WorkItemConnection Introduced as an experiment in GitLab 18.1.

Work items that belong to the namespace (project or group). Returns null for user namespaces. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItems:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
excludeGroupWorkItems (Boolean)
Introduced as an experiment in GitLab 18.4.

Exclude group-level work items within the group and its descendants. Ignored for project namespaces.
excludeProjects (Boolean)
Introduced as an experiment in GitLab 17.5.

Exclude work items from projects within the group. Ignored for project namespaces.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeAncestors (Boolean)
Include work items from ancestor groups. Ignored for project namespaces.
includeArchived (Boolean)
Introduced as an experiment in GitLab 18.5.

Return work items from archived projects. Ignored for project namespaces.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
includeDescendants (Boolean)
Include work items from descendant groups and projects. Ignored for project namespaces.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe. Ignored for project namespaces.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemsWidgets [String!] Introduced as an experiment in GitLab 18.2.

List of available widgets for the given work items.

Arguments for workItemsWidgets:
ids ([WorkItemsTypeID!]!)
Global ID array of work items types to fetch available widgets for. A max of 100 IDs can be provided at a time.
union (Boolean!)
When true, returns the union of widgets across all work item types. When false, returns only widgets common to all work item types.
workspacesClusterAgents ClusterAgentConnection Introduced as an experiment in GitLab 17.8.

Cluster agents in the namespace with workspaces capabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspacesClusterAgents:
filter (NamespaceClusterAgentFilter!)
Filter the types of cluster agents to return.

NamespaceAvailableFeatures#

Fields#

Name Type Description
hasBlockedIssuesFeature Boolean! Introduced as an experiment in GitLab 18.3.

Whether blocked issues are enabled for the namespace.
hasCustomFieldsFeature Boolean! Introduced as an experiment in GitLab 18.3.

Whether custom fields are enabled for the namespace.
hasDesignManagementFeature Boolean! Introduced as an experiment in GitLab 18.6.

Whether design management is enabled for the namespace.
hasDuoRemoteFlowsFeature Boolean! Introduced as an experiment in GitLab 18.6.

Whether Duo remote flows are enabled for the namespace.
hasEpicsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether epics are enabled for the namespace.
hasGroupBulkEditFeature Boolean! Introduced as an experiment in GitLab 18.3.

Whether group bulk edit is enabled for the namespace.
hasIssuableHealthStatusFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether issuable health status is enabled for the namespace.
hasIssueWeightsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether issue weights are enabled for the namespace.
hasIterationsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether iterations are enabled for the namespace.
hasLinkedItemsEpicsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether linked items epics are enabled for the namespace.
hasOkrsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether OKRs are enabled for the namespace.
hasQualityManagementFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether quality management is enabled for the namespace.
hasScopedLabelsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether scoped labels are enabled for the namespace.
hasSubepicsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether subepics are enabled for the namespace.
hasWorkItemStatusFeature Boolean! Introduced as an experiment in GitLab 18.3.

Whether work item statuses are enabled for the namespace.

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 the namespace should be periodically pruned.
namespace Namespace Namespace the CI/CD settings belong to.

NamespaceClusterAgentMapping#

Represents a namespace-cluster-agent mapping.

Fields#

Name Type Description
clusterAgentId ClustersAgentID! Global ID of the cluster agent.
createdAt Time! Timestamp when the namespace-cluster-agent mapping was created.
creatorId UserID! Global ID of the creator.
id RemoteDevelopmentNamespaceClusterAgentMappingID! Global ID of the namespace-cluster-agent mapping.
namespaceId NamespaceID! Global ID of the namespace.
updatedAt Time! Timestamp when the namespace-cluster-agent mapping was last updated.

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.

NamespaceCommitEmailConnection#

Paginated collection of NamespaceCommitEmail. See Standard connection fields for the fields available on every connection.

NamespaceConnection#

Paginated collection of Namespace. See Standard connection fields for the fields available on every connection.

NamespacePermissions#

Fields#

Name Type Description
adminIssue Boolean! If true, the user can perform admin_issue on this resource.
adminLabel Boolean! If true, the user can perform admin_label on this resource.
adminProject Boolean! If true, the user can perform admin_project on this resource.
bulkAdminEpic Boolean! If true, the user can perform bulk_admin_epic on this resource.
createEpic Boolean! If true, the user can perform create_epic on this resource.
createLabel Boolean! If true, the user can perform create_label on this resource.
createProjects Boolean! If true, the user can perform create_projects on this resource.
createSavedView Boolean! If true, the user can perform create_saved_view on this resource.
createWorkItem Boolean! If true, the user can perform create_work_item on this resource.
generateDescription Boolean! If true, the user can perform generate_description on this resource.
importIssues Boolean! If true, the user can perform import_issues on this resource.
importWorkItems Boolean! If true, the user can perform import_work_items on this resource.
readCrmContact Boolean! If true, the user can read CRM contacts.
readCrmOrganization Boolean! If true, the user can read CRM organizations.
readNamespace Boolean! If true, the user can perform read_namespace on this resource.
setNewWorkItemMetadata Boolean! If true, the user can set work item metadata for new work items.

NamespacePlan#

Represents a subscription plan.

Fields#

Name Type Description
isPaid Boolean True if plan is paid.
name String Name of the plan.
title String Title of the plan.

NamespaceProjectStatistics#

Fields#

Name Type Description
buildArtifactsSize Float Build artifacts size of the project in bytes.
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/CD 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.

NamespaceSettings#

Settings for the namespace.

Fields#

Name Type Description
stepUpAuthRequiredOauthProvider String OAuth provider required for step-up authentication.

NamespaceSidebar#

Fields#

Name Type Description
openEpicsCount Int Number of open epics of the namespace.
openIssuesCount Int Number of open issues of the namespace.
openMergeRequestsCount Int Number of open merge requests of the namespace.
openWorkItemsCount Int Introduced as an experiment in GitLab 18.11.

Number of open work items in the namespace (limited to 10,000).

NamespaceWorkItemChangesPayload#

Fields#

Name Type Description
action WorkItemChangeAction! Introduced as an experiment in GitLab 19.3.

Action that triggered the change event.
workItemId WorkItemID! Introduced as an experiment in GitLab 19.3.

Global ID of the work item that changed.

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.

NestedEnvironmentConnection#

Paginated collection of NestedEnvironment. See Standard connection fields for the fields available on every connection.

NetworkPolicyEgress#

Fields#

Name Type Description
allow String! IP range to allow traffic from.
except [String!] List of IP ranges to exclude from the allow range.

Note#

Implements: BaseNoteInterface, ResolvableInterface

Fields#

Name Type Description
agentPresence DuoWorkflowAgentPresence Introduced as an experiment in GitLab 19.5.

Agent attribution for a note posted by a GitLab Duo Agent Platform session. Available to anyone who can read the note; userPermissions.readDuoWorkflow tells whether the session itself can be opened. Returns null when no session posted the note or when the agent_presence_consolidation feature flag is disabled.
author UserCore User who wrote the note.
authorIsContributor Boolean Indicates whether the note author is a contributor.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the note. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
body String! Content of the note.
bodyFirstLineHtml String! First line of the note content.
bodyHtml String GitLab Flavored Markdown rendering of the content of the note.
createdAt Time! Timestamp of the note creation.
discussion Discussion Discussion the note is a part of.
duoCreatedSession DuoWorkflow GitLab Duo Agent Platform session that created the note.
duoTriggeredSession DuoWorkflow Duo Agent Platform session triggered by the note. Returns nil for system notes or when no triggered session exists.
duoWorkflowLinks DuoWorkflowNoteLinkConnection GitLab Duo Agent Platform sessions linked to the note. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowLinks:
linkType (DuoWorkflowNoteLinkType)
Filter links by their link type.
externalAuthor String Email address of non-GitLab user adding the note. For guests, the email address is obfuscated.
id NoteID! ID of the note.
imported Boolean Indicates whether the note was imported.
internal Boolean Indicates if the 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.
noteableId Int Noteable ID which the note belongs to.
noteableType String! Noteable type which the note belongs to.
position DiffPosition Position of the 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.
suggestions SuggestionConnection Suggested changes contained in the note. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
system Boolean! Indicates whether the 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 the note in the Web UI.
userPermissions NotePermissions! Permissions for the current user on the resource.

NoteConnection#

Paginated collection of Note. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

ObservabilityLog#

ObservabilityLog represents a connection between an issue and a log entry.

Fields#

Name Type Description
fingerprint String! Log fingerprint of the log.
issue Issue! Issue associated with the log.
serviceName String! Service name of the log.
severityNumber Int! Severity number of the log.
timestamp ISO8601DateTime! Timestamp of the log.
traceIdentifier String! Trace identifier of the log.

ObservabilityLogConnection#

Paginated collection of ObservabilityLog. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ObservabilityMetric#

ObservabilityMetric represents a connection between an issue and a metric.

Fields#

Name Type Description
issue Issue Issues that the metric is attributed to.
name String! Name of the metric.
type String! OpenTelemetry metric type of the metric.

ObservabilityMetricConnection#

Paginated collection of ObservabilityMetric. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ObservabilityTrace#

ObservabilityTrace represents a connection between an issue and a trace.

Fields#

Name Type Description
issue Issue! Issue associated with the trace.
traceIdentifier String! Identifier of the trace.

ObservabilityTraceConnection#

Paginated collection of ObservabilityTrace. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

OncallParticipantTypeConnection#

Paginated collection of OncallParticipantType. See Standard connection fields for the fields available on every connection.

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.

OrbitAccess#

Orbit access state of a group.

Fields#

Name Type Description
reason OrbitAccessReason Introduced as an experiment in GitLab 19.5.

Cause of the access state when it has more than one cause. Null when the state has a single cause.
state OrbitAccessState! Introduced as an experiment in GitLab 19.5.

Access state of the group for Orbit.
trial OrbitTrial Introduced as an experiment in GitLab 19.5.

Orbit trial of the group. Null when the group is not in the trial flow.
turnOnDenialReason OrbitTurnOnDenialReason Introduced as an experiment in GitLab 19.5.

Reason the user cannot turn Orbit on. Null when turning on is allowed or Orbit is already on.

OrbitIndexingDomain#

Indexing status of one Orbit domain.

Fields#

Name Type Description
name String! Name of the domain.
phase OrbitIndexingPhase Indexing phase of the domain.

OrbitIndexingProjects#

Indexing progress of the projects in a group or project.

Fields#

Name Type Description
gaps Int Number of projects that are not indexed.
indexed Int Number of indexed projects.
totalKnown Int Number of projects known to Orbit.

OrbitIndexingStatus#

Indexing status of a group or project in Orbit.

Fields#

Name Type Description
domains [OrbitIndexingDomain!] Indexing status of each domain.
phase OrbitIndexingPhase Indexing phase of the group or project.
projects OrbitIndexingProjects Indexing progress of the projects in the group or project.

OrbitItemCountDomain#

Number of indexed items in one Orbit domain.

Fields#

Name Type Description
entities [OrbitItemCountEntity!] Number of indexed items of each entity in the domain.
name String! Name of the domain.

OrbitItemCountEntity#

Number of indexed items of one Orbit entity.

Fields#

Name Type Description
count BigInt Number of indexed items of the entity.
name String! Name of the entity.

OrbitItemCounts#

Number of indexed items of a group or project in Orbit.

Fields#

Name Type Description
domains [OrbitItemCountDomain!] Number of indexed items in each domain.

OrbitNamespace#

Orbit data of a group or project.

Fields#

Name Type Description
enabledAt Time Introduced as an experiment in GitLab 19.5.

When Orbit was turned on for the top-level group. Null for subgroups, projects, and when Orbit is off.
indexingStatus OrbitIndexingStatus Indexing status of the group or project.
itemCounts OrbitItemCounts Number of indexed items in the group or project. This field can be resolved for only one group or project in any single request.

OrbitTrial#

Orbit trial of a top-level group, as reported by CustomersDot.

Fields#

Name Type Description
credits OrbitTrialCredits Introduced as an experiment in GitLab 19.5.

Credits of the trial.
expiresOn Date Introduced as an experiment in GitLab 19.5.

Last day of the trial, in UTC. Null before a trial starts.
offer OrbitTrialOffer Introduced as an experiment in GitLab 19.6.

Terms of a new trial. Null unless the group can start one and CustomersDot sends valid terms.
state OrbitTrialState! Introduced as an experiment in GitLab 19.5.

State of the trial.

OrbitTrialCredits#

Credits of an Orbit trial.

Fields#

Name Type Description
remaining Float Introduced as an experiment in GitLab 19.5.

Number of trial credits remaining.
total Float Introduced as an experiment in GitLab 19.5.

Number of credits the trial started with.

OrbitTrialOffer#

Terms of a new Orbit trial, as offered by CustomersDot.

Fields#

Name Type Description
durationDays Int Introduced as an experiment in GitLab 19.6.

Number of days a new trial lasts.
initialCredits Float Introduced as an experiment in GitLab 19.6.

Number of free credits a new trial starts with.

Organization#

Fields#

Name Type Description
analytics Analytics Introduced as an experiment in GitLab 19.3.

Analytics aggregation endpoints scoped to groups and projects of the organization.
artifactRegistry ArtifactRegistry Introduced as an experiment in GitLab 19.4.

Artifact Registry the organization is activated for. Returns null when the organization has no registry, or when the artifact_registry_ui feature flag is disabled.
artifactRegistryRepositories ArtifactRegistryRepositoryConnection Introduced as an experiment in GitLab 19.3.

Artifact Registry repositories in the organization. Returns null when the artifact_registry_ui feature flag is disabled. Raises a resource-not-available error when the organization is not activated for Artifact Registry, where artifactRegistry returns null instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for artifactRegistryRepositories:
format (ArtifactRegistryRepositoryFormat)
Introduced as an experiment in GitLab 19.3.

Return only repositories holding the given package format.
formats ([ArtifactRegistryRepositoryFormat!])
Introduced as an experiment in GitLab 19.5.

Return only repositories holding one of the given package formats.
kind (ArtifactRegistryRepositoryKind)
Introduced as an experiment in GitLab 19.3.

Return only repositories sourcing their artifacts the given way.
kinds ([ArtifactRegistryRepositoryKind!])
Introduced as an experiment in GitLab 19.5.

Return only repositories sourcing their artifacts one of the given ways.
sort (ArtifactRegistryRepositorySort)
Introduced as an experiment in GitLab 19.3.

Sort repositories by the criteria.
artifactRegistryRepository ArtifactRegistryRepositoryDetails Introduced as an experiment in GitLab 19.3.

Single Artifact Registry repository in the organization, by name. Returns null when not found or when the artifact_registry_ui feature flag is disabled. Raises a resource-not-available error when the organization is not activated for Artifact Registry, where artifactRegistry returns null instead.

Arguments for artifactRegistryRepository:
name (String!)
Name of the repository to read, unique within its namespace.
avatarUrl String Introduced as an experiment in GitLab 16.7.

Avatar URL of the organization.
cdApplication CdApplication Introduced as an experiment in GitLab 19.2.

Continuous deployment application in the organization.

Arguments for cdApplication:
id (CdApplicationID!)
Global ID of the application.
cdApplications CdApplicationConnection Introduced as an experiment in GitLab 19.1.

Continuous deployment applications in the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cdApplications:
search (String)
Search applications by name or description.
status (CdApplicationStatus)
Filter applications by status. Returns applications whose most-urgent status matches the given value.
cdAvailableAgents ClusterAgentConnection Introduced as an experiment in GitLab 19.2.

GitLab agents for Kubernetes available in the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
cdAvailableDeployDrivers [String!] Introduced as an experiment in GitLab 19.2.

Reference of continuous deployment deploy drivers available in the organization.
cdEnvironment CdEnvironment Introduced as an experiment in GitLab 19.2.

Continuous deployment environment in the organization.

Arguments for cdEnvironment:
id (CdEnvironmentID!)
Global ID of the environment.
cdEnvironmentTiers [CdEnvironmentTier!] Introduced as an experiment in GitLab 19.2.

Continuous deployment environment tiers available in the organization.
cdEnvironments CdEnvironmentConnection Introduced as an experiment in GitLab 19.1.

Continuous deployment environments in the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cdEnvironments:
applicationId (CdApplicationID)
Filter environments to those where the application has services deployed.
search (String)
Search environments by name or description.
status (CdEnvironmentStatus)
Filter environments by status. An environment can match more than one status.
tier (CdEnvironmentTier)
Filter environments by tier.
cdRollout CdRollout Introduced as an experiment in GitLab 19.2.

Continuous deployment rollout in the organization.

Arguments for cdRollout:
id (CdRolloutID!)
Global ID of the rollout.
cdService CdService Introduced as an experiment in GitLab 19.2.

Continuous deployment service in the organization.

Arguments for cdService:
id (CdServiceID!)
Global ID of the service.
cdVersionSet CdVersionSet Introduced as an experiment in GitLab 19.2.

Continuous deployment version set in the organization.

Arguments for cdVersionSet:
id (CdVersionSetID!)
Global ID of the version set.
description String Introduced as an experiment in GitLab 16.7.

Description of the organization.
descriptionHtml String Introduced as an experiment in GitLab 16.7.

GitLab Flavored Markdown rendering of description.
groups GroupConnection! Introduced as an experiment in GitLab 16.4.

Groups within this organization that the user has access to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
active (Boolean)
When nil (default value), returns all groups. When true, returns only groups that are not pending deletion. When false, only returns groups that are pending deletion.
aimedForDeletion (Boolean)
Filter groups that are marked for deletion.
allAvailable (Boolean)
When true, returns all accessible groups. When false, returns only groups where the user is a member. Unauthenticated requests always return all public groups. The owned_only argument takes precedence.
ids ([ID!])
Filter groups by IDs.
includeSubgroups (Boolean)
Include descendant groups of the group given in parentPath. Ignored unless parentPath is also provided.
markedForDeletionOn (Date)
Date when the group was marked for deletion.
not (BaseGroupsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
ownedOnly (Boolean)
Only include groups where the current user has an owner role.
parentPath (ID)
Full path of the parent group.
search (String)
Search query for group name or group full path.
sort (String)
Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc. Use similarity to rank results by closeness to search. similarity applies only when search is given and results are already scoped to the current user's memberships, such as with ownedOnly: true or allAvailable: false. Filtering by visibilityLevel to public or internal groups only disables similarity, because the results are then no longer scoped by membership. Results fall back to id_desc when similarity does not apply.
topLevelOnly (Boolean)
Only include top-level groups.
visibilityLevel (VisibilityLevelsEnum)
Filter groups by visibility level.
withKnowledgeGraphEnabled (Boolean)
Introduced as an experiment in GitLab 18.10.

Return only groups with Knowledge Graph enabled.
id ID! Introduced as an experiment in GitLab 16.4.

ID of the organization.
name String! Introduced as an experiment in GitLab 16.4.

Name of the organization.
organizationUsers OrganizationUserConnection! Introduced as an experiment in GitLab 16.4.

Users with access to the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizationUsers:
search (String)
Search query for the name, username, or public email of the user. Partial matches require at least 3 characters.
path String! Introduced as an experiment in GitLab 16.4.

Path of the organization.
policyStore PolicyStore Introduced as an experiment in GitLab 19.4.

Policy store catalogs. Returns null when the policy store experiment is not active for the organization.
projects ProjectConnection! Introduced as an experiment in GitLab 16.8.

Projects within this organization that the user has access to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
aimedForDeletion (Boolean)
Return only projects marked for deletion.
archived (ProjectArchived)
Filter projects by archived status.
duoLicensedFeature (DuoLicensedFeature)
Introduced as an experiment in GitLab 18.11.

Include only projects eligible for the specified GitLab Duo licensed feature. Results are automatically filtered to projects where the user has the Maintainer or Owner role.
fullPaths ([String!])
Filter projects by full paths. You cannot provide more than 50 full paths.
ids ([ID!])
Filter projects by IDs.
includeHidden (Boolean)
Include hidden projects.
lastRepositoryCheckFailed (Boolean)
Return only projects where the last repository check failed. Only available for administrators.
markedForDeletionOn (Date)
Date when the project was marked for deletion.
membership (Boolean)
Return only projects that the current user is a member of.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
namespacePath (ID)
Filter projects by their namespace's full path (group or user).
notAimedForDeletion (Boolean)
Exclude projects that are marked for deletion.
personal (Boolean)
Return only personal projects.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
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. Defaults to id_desc, or similarity if search used.
topics ([String!])
Filter projects by topics.
trending (Boolean)
Deprecated in GitLab 18.8. No longer functional. Underlying feature was removed in 19.0.
visibilityLevel (VisibilityLevelsEnum)
Filter projects by visibility level.
withIssuesEnabled (Boolean)
Return only projects with issues enabled.
withMergeRequestsEnabled (Boolean)
Return only projects with merge requests enabled.
rootPath String! Introduced as an experiment in GitLab 18.5.

Root path in the context of the organization.
securityMetrics SecurityMetrics Introduced as an experiment in GitLab 19.3.

Security metrics aggregated across the organization. Available only when the organization_security_dashboard feature flag is enabled. This feature is currently under development and not yet available for general use.

Arguments for securityMetrics:
projectId ([ID!])
Filter by project IDs in a group or an organization. This argument is ignored when we are querying for a project.
reportType ([VulnerabilityReportType!])
Filter by report types.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 18.8.

Filter by security attributes. Up to 20 filters.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref IDs. This argument is ignored when querying for a group. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
softDeletedAt Time Introduced as an experiment in GitLab 19.1.

Timestamp when the organization was soft-deleted.Visible to admins and organization owners only.
state OrganizationState! Introduced as an experiment in GitLab 19.0.

State of the organization.
uuid String! Introduced as an experiment in GitLab 19.2.

Globally unique identifier (UUID) of the organization.
visibility OrganizationVisibility Visibility of the organization.
webPath String! Introduced as an experiment in GitLab 19.0.

Web path of the organization.
webUrl String! Introduced as an experiment in GitLab 16.6.

Web URL of the organization.
workItemSettings WorkItemSettings Introduced as an experiment in GitLab 19.0.

Work item settings for the organization.
workItemTypes WorkItemTypeConnection Introduced as an experiment in GitLab 18.10.

Work item types available to the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemTypes:
name (IssueType)
Deprecated in GitLab 19.0. Name-based filtering is no longer supported with introduction of configurable work item types in 19.0.
onlyAvailable (Boolean)
Introduced as an experiment in GitLab 18.6.

When true, returns only the available work item types for the current user. This experimental field will be removed in 19.0. Use canUserCreateItems and isFilterableListView fields from the WorkItemTypes API instead.
workspacesClusterAgents ClusterAgentConnection Introduced as an experiment in GitLab 17.10.

Cluster agents in the organization with workspaces capabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspacesClusterAgents:
filter (OrganizationClusterAgentFilter!)
Filter the types of cluster agents to return.

OrganizationConnection#

Paginated collection of Organization. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

OrganizationDetailUploadRegistry#

Represents the Geo replication and verification state of an organization_detail_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the OrganizationDetailUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the OrganizationDetailUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this OrganizationDetailUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the OrganizationDetailUploadRegistry.
lastSyncFailure String Error message during sync of the OrganizationDetailUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the OrganizationDetailUploadRegistry.
missingOnPrimary Boolean Indicate if the OrganizationDetailUploadRegistry is missing on primary.
modelRecordId Int ID of the OrganizationDetailUploadRegistry's model record.
organizationDetailUploadId ID! ID of the Organization Detail Upload.
retryAt Time Timestamp after which the OrganizationDetailUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the OrganizationDetailUploadRegistry.
state RegistryState Sync state of the OrganizationDetailUploadRegistry.
verificationChecksum String The local checksum of the OrganizationDetailUploadRegistry.
verificationChecksumMismatched String The expected checksum of the OrganizationDetailUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the OrganizationDetailUploadRegistry.
verificationRetryAt Time Timestamp after which the OrganizationDetailUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the OrganizationDetailUploadRegistry.
verificationStartedAt Time Timestamp when the verification of OrganizationDetailUploadRegistry started.
verificationState VerificationStateEnum Verification state of the OrganizationDetailUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the OrganizationDetailUploadRegistry.

OrganizationDetailUploadRegistryConnection#

Paginated collection of OrganizationDetailUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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
accessLevel OrganizationUserAccess Introduced as an experiment in GitLab 16.11.

Access level of the user in the organization.
badges [OrganizationUserBadge!] Introduced as an experiment in GitLab 16.4.

Badges describing the user within the organization.
id ID! Introduced as an experiment in GitLab 16.4.

ID of the organization user.
isLastOwner Boolean Introduced as an experiment in GitLab 16.11.

Whether the user is the last owner of the organization.
user UserCore! Introduced as an experiment in GitLab 16.4.

User that is associated with the organization.
userPermissions OrganizationUserPermissions! Permissions for the current user on the resource.

OrganizationUserAccess#

Represents the access level of a relationship between a User and Organization that it is related to.

Fields#

Name Type Description
integerValue Int Introduced as an experiment in GitLab 16.11.

Integer representation of access level.
stringValue OrganizationUserAccessLevel Introduced as an experiment in GitLab 16.11.

String representation of access level.

OrganizationUserBadge#

An organization user badge.

Fields#

Name Type Description
text String! Badge text.
variant String! Badge variant.

OrganizationUserConnection#

Paginated collection of OrganizationUser. See Standard connection fields for the fields available on every connection.

OrganizationUserPermissions#

Fields#

Name Type Description
adminOrganization Boolean! If true, the user can perform admin_organization on this resource.
deleteOrganizationUser Boolean! If true, the user can perform delete_organization_user on this resource.

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.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
project Project! Project where the package is stored.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
status PackageStatus! Package status.
statusMessage String Status message.
tags PackageTagConnection Package tags. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
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.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
status PackageStatus! Package status.
statusMessage String Status message.
tags PackageTagConnection Package tags. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Date of most recent update.
userPermissions PackagePermissions! Permissions for the current user on the resource.
version String Version string.

PackageBaseConnection#

Paginated collection of PackageBase. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

PackageConnection#

Paginated collection of Package. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

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.

PackageDependencyLinkConnection#

Paginated collection of PackageDependencyLink. See Standard connection fields for the fields available on every connection.

PackageDetailsType#

Represents a package details in the Package Registry.

Fields#

Name Type Description
_links PackageLinks! Map of links to perform actions on the package.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id PackagesPackageID! ID of the package.
lastDownloadedAt Time Last time that a file of the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
packageType PackageTypeEnum! Package type.
pipelines PipelineConnection Pipelines that built the package. Max page size 20. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
project Project! Project where the package is stored.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

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.

PackageFileConnection#

Paginated collection of PackageFile. See Standard connection fields for the fields available on every connection.

PackageFileRegistry#

Represents the Geo sync and verification state of a package file.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackageFileRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackageFileRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PackageFileRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the PackageFileRegistry is missing on primary.
modelRecordId Int ID of the PackageFileRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the PackageFileRegistry in case of mismatch.
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 of PackageFileRegistry started.
verificationState VerificationStateEnum Verification state of the PackageFileRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackageFileRegistry.

PackageFileRegistryConnection#

Paginated collection of PackageFileRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

Represents links to perform actions on the package.

Fields#

Name Type Description
webPath String Path to the package details page.

PackageMetadataAdvisory#

Represents a security advisory from package metadata sources.

Fields#

Name Type Description
advisoryXid String! External ID of the advisory.
createdAt Time! Timestamp when the advisory was created.
cve String CVE identifier if applicable.
cvssV2 String CVSS v2 vector string.
cvssV3 String CVSS v3 vector string.
description String Description of the advisory.
id ID! ID of the advisory.
identifiers [PackageMetadataAdvisoryIdentifier!]! Additional identifiers for the advisory.
publishedDate Date! Date when the advisory was published.
sourceXid PackageMetadataAdvisorySource! Source of the advisory.
title String Title of the advisory.
updatedAt Time! Timestamp when the advisory was last updated.
urls [String!] Related URLs for the advisory.

PackageMetadataAdvisoryConnection#

Paginated collection of PackageMetadataAdvisory. See Standard connection fields for the fields available on every connection.

PackageMetadataAdvisoryIdentifier#

Represents an identifier for a package metadata advisory.

Fields#

Name Type Description
name String! Human-readable name of the identifier.
type String! Type of identifier (for example, CVE, CWE, OSVDB, USN).
url String URL of the identifier's documentation.
value String! Value of the identifier, for matching purposes.

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
auditEventsEnabled Boolean! Indicates whether audit events are created when publishing or deleting a package in the namespace (Premium and Ultimate only).
genericDuplicateExceptionRegex UntrustedRegexp When generic_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When generic_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
genericDuplicatesAllowed Boolean! Indicates whether duplicate generic packages are allowed for the 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.
lockRubygemsPackageRequestsForwarding Boolean! Indicates whether RubyGems package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegex UntrustedRegexp When maven_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When maven_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
mavenDuplicatesAllowed Boolean! Indicates whether duplicate Maven packages are allowed for the namespace.
mavenPackageRequestsForwarding Boolean Indicates whether Maven package forwarding is allowed for the 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 the 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 or versions that match this regex. When nuget_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
nugetDuplicatesAllowed Boolean! Indicates whether duplicate NuGet packages are allowed for the namespace.
nugetSymbolServerEnabled Boolean! Indicates whether the NuGet symbol server is enabled for the namespace.
pypiPackageRequestsForwarding Boolean Indicates whether PyPI package forwarding is allowed for the namespace.
pypiPackageRequestsForwardingLocked Boolean! Indicates whether PyPI package forwarding settings are locked by a parent namespace.
rubygemsPackageRequestsForwarding Boolean Indicates whether RubyGems package forwarding is allowed for the namespace.
rubygemsPackageRequestsForwardingLocked Boolean! Indicates whether RubyGems package forwarding settings are locked by a parent namespace.
terraformModuleDuplicateExceptionRegex UntrustedRegexp When terraform_module_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. When terraform_module_duplicates_allowed is true, duplicate packages with names that match this regex are rejected.
terraformModuleDuplicatesAllowed Boolean! Indicates whether duplicate Terraform packages are allowed for the 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.

PackageTagConnection#

Paginated collection of PackageTag. See Standard connection fields for the fields available on every connection.

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 the packages cleanup policy will be executed.

PackagesDebianProjectComponentFileRegistry#

Represents the Geo replication and verification state of a packages_debian_project_component_file.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackagesDebianProjectComponentFileRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackagesDebianProjectComponentFileRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PackagesDebianProjectComponentFileRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PackagesDebianProjectComponentFileRegistry.
lastSyncFailure String Error message during sync of the PackagesDebianProjectComponentFileRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PackagesDebianProjectComponentFileRegistry.
missingOnPrimary Boolean Indicate if the PackagesDebianProjectComponentFileRegistry is missing on primary.
modelRecordId Int ID of the PackagesDebianProjectComponentFileRegistry's model record.
packagesDebianProjectComponentFileId ID! ID of the Packages::Debian::ProjectComponentFile.
retryAt Time Timestamp after which the PackagesDebianProjectComponentFileRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PackagesDebianProjectComponentFileRegistry.
state RegistryState Sync state of the PackagesDebianProjectComponentFileRegistry.
verificationChecksum String The local checksum of the PackagesDebianProjectComponentFileRegistry.
verificationChecksumMismatched String The expected checksum of the PackagesDebianProjectComponentFileRegistry in case of mismatch.
verificationFailure String Error message during verification of the PackagesDebianProjectComponentFileRegistry.
verificationRetryAt Time Timestamp after which the PackagesDebianProjectComponentFileRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PackagesDebianProjectComponentFileRegistry.
verificationStartedAt Time Timestamp when the verification of PackagesDebianProjectComponentFileRegistry started.
verificationState VerificationStateEnum Verification state of the PackagesDebianProjectComponentFileRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackagesDebianProjectComponentFileRegistry.

PackagesDebianProjectComponentFileRegistryConnection#

Paginated collection of PackagesDebianProjectComponentFileRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

PackagesHelmMetadataCacheRegistry#

Represents the Geo replication and verification state of a packages_helm_metadata_cache.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackagesHelmMetadataCacheRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackagesHelmMetadataCacheRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PackagesHelmMetadataCacheRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PackagesHelmMetadataCacheRegistry.
lastSyncFailure String Error message during sync of the PackagesHelmMetadataCacheRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PackagesHelmMetadataCacheRegistry.
missingOnPrimary Boolean Indicate if the PackagesHelmMetadataCacheRegistry is missing on primary.
modelRecordId Int ID of the PackagesHelmMetadataCacheRegistry's model record.
packagesHelmMetadataCacheId ID! ID of the Helm Metadata Cache.
retryAt Time Timestamp after which the PackagesHelmMetadataCacheRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PackagesHelmMetadataCacheRegistry.
state RegistryState Sync state of the PackagesHelmMetadataCacheRegistry.
verificationChecksum String The local checksum of the PackagesHelmMetadataCacheRegistry.
verificationChecksumMismatched String The expected checksum of the PackagesHelmMetadataCacheRegistry in case of mismatch.
verificationFailure String Error message during verification of the PackagesHelmMetadataCacheRegistry.
verificationRetryAt Time Timestamp after which the PackagesHelmMetadataCacheRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PackagesHelmMetadataCacheRegistry.
verificationStartedAt Time Timestamp when the verification of PackagesHelmMetadataCacheRegistry started.
verificationState VerificationStateEnum Verification state of the PackagesHelmMetadataCacheRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackagesHelmMetadataCacheRegistry.

PackagesHelmMetadataCacheRegistryConnection#

Paginated collection of PackagesHelmMetadataCacheRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

PackagesNugetSymbolRegistry#

Represents the Geo replication and verification state of a packages_nuget_symbol.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackagesNugetSymbolRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackagesNugetSymbolRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PackagesNugetSymbolRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PackagesNugetSymbolRegistry.
lastSyncFailure String Error message during sync of the PackagesNugetSymbolRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PackagesNugetSymbolRegistry.
missingOnPrimary Boolean Indicate if the PackagesNugetSymbolRegistry is missing on primary.
modelRecordId Int ID of the PackagesNugetSymbolRegistry's model record.
packagesNugetSymbolId ID! ID of the Packages::Nuget::Symbol.
retryAt Time Timestamp after which the PackagesNugetSymbolRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PackagesNugetSymbolRegistry.
state RegistryState Sync state of the PackagesNugetSymbolRegistry.
verificationChecksum String The local checksum of the PackagesNugetSymbolRegistry.
verificationChecksumMismatched String The expected checksum of the PackagesNugetSymbolRegistry in case of mismatch.
verificationFailure String Error message during verification of the PackagesNugetSymbolRegistry.
verificationRetryAt Time Timestamp after which the PackagesNugetSymbolRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PackagesNugetSymbolRegistry.
verificationStartedAt Time Timestamp when the verification of PackagesNugetSymbolRegistry started.
verificationState VerificationStateEnum Verification state of the PackagesNugetSymbolRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackagesNugetSymbolRegistry.

PackagesNugetSymbolRegistryConnection#

Paginated collection of PackagesNugetSymbolRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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! Global ID of the package protection rule.
minimumAccessLevelForDelete PackagesProtectionRuleAccessLevelForDelete Introduced as an experiment in GitLab 17.10.

Minimum GitLab access required to delete packages from the package registry. Valid values include OWNER or ADMIN. If the value is nil, the default minimum access level is MAINTAINER. Available only when feature flag packages_protected_packages_delete is enabled.
minimumAccessLevelForPush PackagesProtectionRuleAccessLevel Minimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
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, PYPI.

PackagesProtectionRuleConnection#

Paginated collection of PackagesProtectionRule. See Standard connection fields for the fields available on every connection.

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.

PagesDeployment#

Represents a pages deployment.

Fields#

Name Type Description
active Boolean! Whether the deployment is currently active.
ciBuildId ID ID of the CI build that created the deployment.
createdAt ISO8601DateTime! Time the deployment was created.
deletedAt ISO8601DateTime Time the deployment was deleted.
expiresAt ISO8601DateTime Time the deployment will expire.
fileCount Int Number of files that were published with the deployment.
id ID! ID of the Pages Deployment.
pathPrefix String URL path Prefix that points to the deployment.
project Project! Project the deployment belongs to.
rootDirectory String Path within the build assets that functions as the root directory for Pages sites.
size BigInt Size of the storage used.
updatedAt ISO8601DateTime! Time the deployment was last updated.
url String! Publicly accessible URL of the deployment.

PagesDeploymentConnection#

Paginated collection of PagesDeployment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

PagesDeploymentRegistry#

Represents the Geo replication and verification state of a pages_deployment.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PagesDeploymentRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PagesDeploymentRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PagesDeploymentRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the PagesDeploymentRegistry is missing on primary.
modelRecordId Int ID of the PagesDeploymentRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the PagesDeploymentRegistry in case of mismatch.
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 of PagesDeploymentRegistry started.
verificationState VerificationStateEnum Verification state of the PagesDeploymentRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PagesDeploymentRegistry.

PagesDeploymentRegistryConnection#

Paginated collection of PagesDeploymentRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

PathLock#

Represents a file or directory in the project repository that has been locked.

Fields#

Name Type Description
createdAt Time! Timestamp of when the path was locked.
id PathLockID! ID of the path lock.
path String Locked path.
user UserCore User that has locked the path.
userPermissions PathLockPermissions! Permissions for the current user on the resource.

PathLockConnection#

Paginated collection of PathLock. See Standard connection fields for the fields available on every connection.

PathLockPermissions#

Fields#

Name Type Description
destroyPathLock Boolean! If true, the user can perform destroy_path_lock on this resource.

PendingGroupMember#

Represents a Pending Group Membership.

Implements: MemberInterface, PendingMemberInterface

Fields#

Name Type Description
accessLevel AccessLevel GitLab::Access level.
approved Boolean Whether the pending member has been approved.
avatarUrl String URL to avatar image file of the pending member.
createdAt Time Date and time the membership was created.
createdBy UserCore User that authorized membership.
email String Public email of the pending member.
expiresAt Time Date and time the membership expires.
id ID! ID of the member.
invited Boolean Whether the pending member has been invited.
mergeRequestInteraction UserMergeRequestInteraction Find a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
name String Name of the pending member.
updatedAt Time Date and time the membership was last updated.
user UserCore User that is associated with the member object.
username String Username of the pending member.
webUrl String Web URL of the pending member.

PendingMemberInterfaceConnection#

Paginated collection of PendingMemberInterface. See Standard connection fields for the fields available on every connection.

PendingProjectMember#

Represents a Pending Project Membership.

Implements: MemberInterface, PendingMemberInterface

Fields#

Name Type Description
accessLevel AccessLevel GitLab::Access level.
approved Boolean Whether the pending member has been approved.
avatarUrl String URL to avatar image file of the pending member.
createdAt Time Date and time the membership was created.
createdBy UserCore User that authorized membership.
email String Public email of the pending member.
expiresAt Time Date and time the membership expires.
id ID! ID of the member.
invited Boolean Whether the pending member has been invited.
mergeRequestInteraction UserMergeRequestInteraction Find a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
name String Name of the pending member.
updatedAt Time Date and time the membership was last updated.
user UserCore User that is associated with the member object.
username String Username of the pending member.
webUrl String Web URL of the pending member.

PersonalAccessToken#

Personal access token.

Fields#

Name Type Description
active Boolean! Whether the personal access token is active.
createdAt Time! Timestamp of when the personal access token was created.
description String Description of the personal access token.
expiresAt Date Date of when the personal access token expires.
granular Boolean! Whether the personal access token is granular.
id ID! ID of the personal access token.
lastUsedAt Time Timestamp of when the personal access token was last used.
lastUsedIps [String!]! Five most recent unique IP addresses that authenticated with the personal access token.
name String! Name of the personal access token.
revoked Boolean! Whether the personal access token has been revoked.
scopes [PersonalAccessTokenScope!]! List of scopes applied to a personal access token.
sudo Boolean! Whether the personal access token can impersonate other users with sudo.

PersonalAccessTokenConnection#

Paginated collection of PersonalAccessToken. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

PersonalSnippetUploadRegistry#

Represents the Geo replication and verification state of a personal_snippet_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PersonalSnippetUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PersonalSnippetUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PersonalSnippetUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PersonalSnippetUploadRegistry.
lastSyncFailure String Error message during sync of the PersonalSnippetUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PersonalSnippetUploadRegistry.
missingOnPrimary Boolean Indicate if the PersonalSnippetUploadRegistry is missing on primary.
modelRecordId Int ID of the PersonalSnippetUploadRegistry's model record.
personalSnippetUploadId ID! ID of the Personal Snippet Upload.
retryAt Time Timestamp after which the PersonalSnippetUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PersonalSnippetUploadRegistry.
state RegistryState Sync state of the PersonalSnippetUploadRegistry.
verificationChecksum String The local checksum of the PersonalSnippetUploadRegistry.
verificationChecksumMismatched String The expected checksum of the PersonalSnippetUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the PersonalSnippetUploadRegistry.
verificationRetryAt Time Timestamp after which the PersonalSnippetUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PersonalSnippetUploadRegistry.
verificationStartedAt Time Timestamp when the verification of PersonalSnippetUploadRegistry started.
verificationState VerificationStateEnum Verification state of the PersonalSnippetUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PersonalSnippetUploadRegistry.

PersonalSnippetUploadRegistryConnection#

Paginated collection of PersonalSnippetUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

Pipeline#

Implements: PipelineInterface

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commit Commit Git commit of the pipeline.
commitAuthorGravatar String Gravatar URL of the author of the pipeline's commit.
commitAuthorName String Name of the author of the pipeline's commit.
commitPath String Path to the commit that triggered the pipeline.
commitTitle String Title of the pipeline's commit.
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, PIPELINE_EXECUTION_POLICY_FORCED, SECURITY_SCAN_PROFILES_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 Latest pipelines triggered by the pipeline. Pipelines from trigger jobs that have since been retried are excluded. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
duoWorkflowLinks DuoWorkflowPipelineLinkConnection GitLab Duo Agent Platform sessions linked to the pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowLinks:
linkType (DuoWorkflowPipelineLinkType)
Filter links by their link type.
duoWorkflows DuoWorkflowConnection Introduced as an experiment in GitLab 19.3.

Duo Workflow sessions associated with the pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
duration Int Duration of the pipeline in seconds.
enabledPartialSecurityScans EnabledSecurityScans! Introduced as an experiment in GitLab 18.3.

Partial scans present in the pipeline and its descendents for each report type.
enabledSecurityScans EnabledSecurityScans! Introduced as an experiment in GitLab 18.3.

Security scans present in the pipeline and its descendents for each report type.
errorMessages PipelineMessageConnection Pipeline error messages. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
failedJobsCount Int! Number of failed jobs in the pipeline, including trigger jobs and external jobs.
failureReason String Reason why the pipeline failed.
finishedAt Time Timestamp of the pipeline's completion.
hasManualActions Boolean! Indicates if the pipeline has manual actions.
hasScheduledActions Boolean! Indicates if the pipeline has scheduled actions.
id ID! ID of the pipeline.
iid String! Internal ID of the pipeline.
job CiJob Specific job in the pipeline, either by name or ID.

Arguments for job:
id (JobID)
ID of the job.
name (String)
Name of the job.
jobArtifacts [CiJobArtifact!] Job artifacts of the pipeline.
jobs CiJobConnection Jobs belonging to the pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobs:
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.
latest Boolean! If the pipeline is the latest one or not.
manualVariables PipelineManualVariableConnection CI/CD variables added to a manual pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
mergeRequest MergeRequest 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.
pipelineSchedule PipelineSchedule Pipeline schedule that triggered the pipeline.
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! Reference text from the presenter.
retryable Boolean! Specifies if a pipeline's jobs can be retried.
securityReportFinding PipelineSecurityReportFinding Vulnerability finding reported on the pipeline.

Arguments for securityReportFinding:
uuid (String!)
UUID of the security report finding.
securityReportFindings PipelineSecurityReportFindingConnection Vulnerability findings reported on the pipeline. By default all the states except dismissed are included in the response. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityReportFindings:
reportType ([String!])
Filter vulnerability findings by report type.
scanner ([String!])
Filter vulnerability findings by Scanner.externalId.
severity ([String!])
Filter vulnerability findings by severity.
sort (PipelineSecurityReportFindingSort)
List vulnerability findings by sort order.
state ([VulnerabilityState!])
Filter vulnerability findings by state.
securityReportSummary SecurityReportSummary Vulnerability and scanned resource counts for each security scanner of the pipeline.
sha String SHA of the pipeline's commit.

Arguments for sha:
format (ShaFormat)
Format of the SHA.
source String Source of the pipeline.
sourceJob CiJob Job where pipeline was triggered from.
stages CiStageConnection Stages of the pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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, CANCELING, SKIPPED, MANUAL, SCHEDULED).
stuck Boolean! If the pipeline is stuck.
testReportSummary TestReportSummary! Summary of the test report generated by the pipeline.
testSuite TestSuite A specific test suite in a pipeline test report.

Arguments for testSuite:
buildIds ([ID!]!)
IDs of the builds used to run the test suite.
totalJobs Int! Total number of jobs in the pipeline.
trigger Boolean! If the pipeline was created by a Trigger request.
triggeredByPath String Path that triggered the pipeline.
troubleshootJobWithAi Boolean! If the user can troubleshoot jobs of a pipeline.
type String! Type of the pipeline.
updatedAt Time! Timestamp of the pipeline's last activity.
upstream Pipeline Pipeline that triggered the pipeline.
user UserCore Pipeline user.
userPermissions PipelinePermissions! Permissions for the current user on the resource.
usesNeeds Boolean Indicates if the pipeline has jobs with needs dependencies.
warningMessages PipelineMessageConnection Pipeline warning messages. Always empty for pipelines created in 19.5 and later due to database concerns. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
warnings Boolean! Indicates if a pipeline has warnings.
yamlErrorMessages String Pipeline YAML errors.
yamlErrors Boolean! If the pipeline has YAML errors.

PipelineAnalytics#

Fields#

Name Type Description
aggregate PipelineAnalyticsPeriod Introduced as an experiment in GitLab 17.5.

Pipeline analytics for the specified filter.
monthPipelinesLabels [String!] Labels for the monthly pipeline count. Only available for projects.
monthPipelinesSuccessful [Int!] Total monthly successful pipeline count. Only available for projects.
monthPipelinesTotals [Int!] Total monthly pipeline count. Only available for projects.
pipelineTimesLabels [String!] Pipeline times labels. Only available for projects.
pipelineTimesValues [Int!] Pipeline times. Only available for projects.
timeSeries [PipelineAnalyticsPeriod!] Introduced as an experiment in GitLab 17.9.

Pipeline analytics shown over time based on the specified filter. Data is aggregated in UTC, with adaptive resolution: hourly for 7-day windows or less, daily for longer periods.

Arguments for timeSeries:
period (AnalyticsAggregationPeriod!)
Periodicity of aggregated data.
weekPipelinesLabels [String!] Labels for the weekly pipeline count. Only available for projects.
weekPipelinesSuccessful [Int!] Total weekly successful pipeline count. Only available for projects.
weekPipelinesTotals [Int!] Total weekly pipeline count. Only available for projects.
yearPipelinesLabels [String!] Labels for the yearly pipeline count. Only available for projects.
yearPipelinesSuccessful [Int!] Total yearly successful pipeline count. Only available for projects.
yearPipelinesTotals [Int!] Total yearly pipeline count. Only available for projects.

PipelineAnalyticsPeriod#

Fields#

Name Type Description
count BigInt Introduced as an experiment in GitLab 17.5.

Pipeline count, optionally filtered by status.

Arguments for count:
status (PipelineAnalyticsJobStatus!)
Filter pipeline totals by status. If not specified, totals for all pipeline statuses are returned.
durationStatistics CiDurationStatistics Introduced as an experiment in GitLab 17.5.

Pipeline duration statistics.
label Date Introduced as an experiment in GitLab 17.5.

Data point label (UTC time).

PipelineArtifactRegistry#

Represents the Geo sync and verification state of a pipeline artifact.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PipelineArtifactRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PipelineArtifactRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PipelineArtifactRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the PipelineArtifactRegistry is missing on primary.
modelRecordId Int ID of the PipelineArtifactRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the PipelineArtifactRegistry in case of mismatch.
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 of PipelineArtifactRegistry started.
verificationState VerificationStateEnum Verification state of the PipelineArtifactRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PipelineArtifactRegistry.

PipelineArtifactRegistryConnection#

Paginated collection of PipelineArtifactRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

PipelineConnection#

Paginated collection of Pipeline. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

PipelineExecutionPolicy#

Represents the pipeline execution policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyBlobFilePath String! Path to the policy file in the project.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.
warnings [String!]! Warnings associated with the policy.
yaml String! YAML definition of the policy.

PipelineExecutionPolicyAttributesType#

Represents policy fields related to the pipeline execution policy.

Fields#

Name Type Description
policyBlobFilePath String! Path to the policy file in the project.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
warnings [String!]! Warnings associated with the policy.

PipelineExecutionPolicyConnection#

Paginated collection of PipelineExecutionPolicy. See Standard connection fields for the fields available on every connection.

PipelineExecutionProjectSchedule#

Represents a project schedule for a pipeline execution policy.

Fields#

Name Type Description
cron String! Cron expression for the schedule.
cronTimezone String! Timezone for the cron schedule.
id SecurityPipelineExecutionProjectScheduleID! ID of the schedule record.
nextRunAt Time Timestamp of the next scheduled run.
project Project! Project the scheduled pipeline will run for.
snoozedUntil Time Timestamp until which the schedule is snoozed.
timeWindowSeconds Int! Time window in seconds for distributing pipeline runs.

PipelineExecutionProjectScheduleConnection#

Paginated collection of PipelineExecutionProjectSchedule. See Standard connection fields for the fields available on every connection.

PipelineExecutionSchedulePolicy#

Represents the pipeline execution schedule policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyBlobFilePath String! Path to the policy file in the project.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope of the policy.
schedulePipelines PolicySchedulePipelineConnection Introduced as an experiment in GitLab 19.0.

Pipelines created by this scheduled policy. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
scheduleTimeWindowSeconds Int Introduced as an experiment in GitLab 19.1.

Time window in seconds from the first schedule of the policy.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
upcomingSchedules PipelineExecutionProjectScheduleConnection Introduced as an experiment in GitLab 19.1.

Upcoming scheduled runs for this policy. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp of when the policy YAML was last updated.
warnings [String!]! Warnings associated with the policy.
yaml String! YAML definition of the policy.

PipelineExecutionSchedulePolicyConnection#

Paginated collection of PipelineExecutionSchedulePolicy. See Standard connection fields for the fields available on every connection.

PipelineExecutionScheduledPolicyAttributesType#

Represents policy fields related to the pipeline execution scheduled policy.

Fields#

Name Type Description
policyBlobFilePath String! Path to the policy file in the project.
scheduleTimeWindowSeconds Int Introduced as an experiment in GitLab 19.1.

Time window in seconds from the first schedule of the policy.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
warnings [String!]! Warnings associated with the policy.

PipelineManualVariable#

CI/CD variables added to a manual pipeline.

Fields#

Name Type Description
id ID! ID of the variable.
key String Name of the variable.
value String Value of the variable.

PipelineManualVariableConnection#

Paginated collection of PipelineManualVariable. See Standard connection fields for the fields available on every connection.

PipelineMessage#

Fields#

Name Type Description
content String! Content of the pipeline message.
id ID! ID of the pipeline message.

PipelineMessageConnection#

Paginated collection of PipelineMessage. See Standard connection fields for the fields available on every connection.

PipelineMinimalAccess#

Implements: PipelineInterface

Fields#

Name Type Description
commit Commit Git commit of the pipeline.
id ID! ID of the pipeline.
iid String Internal ID of the pipeline.
path String Relative path to the pipeline's page.
project ProjectInterface Project the pipeline belongs to.
user UserCore Pipeline user.

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.
inputs CiInputsFieldConnection Introduced as an experiment in GitLab 17.10.

Inputs configured for the pipeline schedule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

PipelineScheduleConnection#

Paginated collection of PipelineSchedule. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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

PipelineScheduleStatusCount#

Counts of pipeline schedules by status.

Fields#

Name Type Description
active Int! Number of active pipeline schedules.
inactive Int! Number of inactive pipeline schedules.
total Int! Total number of pipeline schedules.

PipelineScheduleVariable#

Implements: CiVariable

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.

PipelineScheduleVariableConnection#

Paginated collection of PipelineScheduleVariable. See Standard connection fields for the fields available on every connection.

PipelineSecurityReportFinding#

Represents vulnerability finding of a security report on the pipeline.

Fields#

Name Type Description
aiResolutionAvailable Boolean Indicates whether the type of finding can be resolved with AI.
aiResolutionEnabled Boolean Indicates whether the specific finding can be resolved with AI.
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.
findingTokenStatus VulnerabilityFindingTokenStatus Status of the secret token associated with this finding.
identifiers [VulnerabilityIdentifier!]! Identifiers of the vulnerability finding.
issueLinks VulnerabilityIssueLinkConnection List of issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
originalSeverity VulnerabilitySeverity Severity of the vulnerability finding before any overrides.
project Project Project on which the vulnerability finding was found.
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.
severityOverrides SeverityOverrideConnection List of severity changes for the vulnerability finding. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
solution String Solution for resolving the security report finding.
solutionHtml String GitLab Flavored Markdown rendering of solution.
state VulnerabilityState Finding status.
stateComment String Comment for the state of the security report finding.
title String Title of the vulnerability finding.
unverified Boolean! Indicates whether the finding was detected without an identified source (untrusted input).
userPermissions PipelineSecurityReportFindingPermissions! Permissions for the current user on the resource.
uuid String UUIDv5 digest based on the vulnerability's report type, primary identifier, location, fingerprint, project identifier.
validityDisplayState VulnerabilityValidityDisplayState Introduced as an experiment in GitLab 19.5.

Validity state derived from the token status and current vendor support.
vulnerability Vulnerability Vulnerability related to the security report finding.

PipelineSecurityReportFindingConnection#

Paginated collection of PipelineSecurityReportFinding. See Standard connection fields for the fields available on every connection.

PipelineSecurityReportFindingPermissions#

Check permissions for the current user on a vulnerability finding.

Fields#

Name Type Description
adminVulnerability Boolean! If true, the user can perform admin_vulnerability on this resource.
createIssue Boolean! If true, the user can perform create_issue on this resource.

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.
expiresAt Time Timestamp of when the pipeline trigger token expires.
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.

PipelineTriggerConnection#

Paginated collection of PipelineTrigger. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

PipelinesAggregationResponse#

Response for Pipelines aggregation engine.

Fields#

Name Type Description
dimensions PipelinesAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
duration PipelinesAggregationResponseDurationMetrics Aggregated duration metrics.
durationQuantile Float Pipeline duration quantile in seconds.

Arguments for durationQuantile:
quantile (Float)
outcomeRate Float Rate of pipelines with the given status among completed pipelines.

Arguments for outcomeRate:
status ([String!])
totalCount Int Total number of pipelines, optionally filtered by source or status.

Arguments for totalCount:
source ([String!])
Only count pipelines with the given sources.
status ([String!])
Only count pipelines with the given statuses.

PipelinesAggregationResponseConnection#

Paginated collection of PipelinesAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

PipelinesAggregationResponseDimensions#

Response dimensions for Pipelines aggregation engine.

Fields#

Name Type Description
finishedAt Date Pipeline finish date.

Arguments for finishedAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
project Project Project.
ref String Pipeline ref.
source String Pipeline source.
startedAt Date Pipeline start date.

Arguments for startedAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
status String Pipeline status.
user UserCore User who triggered the pipeline.

PipelinesAggregationResponseDurationMetrics#

Aggregated duration metrics for Pipelines aggregation engine.

Fields#

Name Type Description
max Int Maximum pipeline duration in seconds.
mean Float Mean pipeline duration in seconds.
min Int Minimum pipeline duration in seconds.
quantile Float Quantile of pipeline duration in seconds.

Arguments for quantile:
quantile (Float)
sum Float Sum of pipeline duration in seconds.

PipelinesAggregationScope#

Aggregation scope for Pipelines. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated PipelinesAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

PolicyAnyMergeRequestViolation#

Represents policy violation for any_merge_request report_type.

Fields#

Name Type Description
commits JSON List of unsigned commits causing the violation. If policy targets any commits, it returns true.
name String! Represents the policy name.

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.

PolicyApprovalSettingsOverride#

Represents the approval settings of merge request overridden by a policy.

Fields#

Name Type Description
editPath String Introduced as an experiment in GitLab 17.8.

Path to edit the policy.
name String Introduced as an experiment in GitLab 17.8.

Policy name.
settings JSON! Overridden project approval settings.

PolicyApproversType#

Multiple approvers action.

Fields#

Name Type Description
allGroups [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
roles [MemberAccessLevelName!] Approvers of the role type. Users belonging to these role(s) alone will be approvers.
users [UserCore!] Approvers of the user type.

PolicyBypassStatus#

Represents bypass status of a merge request for a security policy.

Fields#

Name Type Description
allowBypass Boolean! Indicates if bypass is allowed for the policy.
bypassed Boolean! Indicates if the policy has been bypassed.
id ID! ID of the security policy.
name String! Name of the security policy.

PolicyComparisonPipeline#

Represents the source and target pipelines used for comparison in the policy evaluation.

Fields#

Name Type Description
reportType ApprovalReportType! Represents the report_type for which the pipeline IDs were evaluated.
source [CiPipelineID!] Represents the list of pipeline GIDs for the source branch.
target [CiPipelineID!] Represents the list of pipeline GIDs for the target branch.

PolicyDismissal#

Represents a policy dismissal for a security finding or license occurrence.

Fields#

Name Type Description
id ID! ID of the policy dismissal.
securityPolicy SecurityPolicy Security policy associated with the dismissal.

PolicyError#

Represents an error that can occur during policy evaluation.

Fields#

Name Type Description
data JSON Represents the error-specific data.
error PolicyViolationErrorType! Represents error code.
message String! Represents the error message.
reportType ApprovalReportType! Represents the report type.

PolicyLicenseScanningViolation#

Represents policy violation for license_scanning report_type.

Fields#

Name Type Description
dependencies [String!]! List of dependencies using the violated license.
license String! License name.
url String URL of the license.

PolicyProjectCreated#

Response of security policy creation.

Fields#

Name Type Description
errorMessage String Deprecated in GitLab 17.5. Use errors instead.
errors [String!] Error messages in case status is :error.
project Project Security Policy Project that was created.
status PolicyProjectCreatedStatus Status of the creation of the security policy project.

PolicyScanFindingViolation#

Represents policy violation for scan_finding report_type.

Fields#

Name Type Description
location JSON Location of the finding determined by the scanner.
name String Represents the name of the finding.
path String Represents the URL path to the finding.
reportType VulnerabilityReportType! Represents the report type.
severity VulnerabilitySeverity Severity of the finding.

PolicySchedulePipeline#

Represents a pipeline created by a scheduled security policy.

Fields#

Name Type Description
createdAt Time! Timestamp when the pipeline was triggered by the schedule.
id SecurityPolicySchedulePipelineID! ID of the policy schedule pipeline record.
pipeline Pipeline! Pipeline created by the scheduled policy.
project Project! Project the pipeline was created for.

PolicySchedulePipelineConnection#

Paginated collection of PolicySchedulePipeline. See Standard connection fields for the fields available on every connection.

PolicyScheduleTestRun#

Represents a test run for a scheduled pipeline execution policy.

Fields#

Name Type Description
completed Boolean! Whether the test run has completed.
createdAt Time! Timestamp when the test run was created.
duration Int Duration of the test run in seconds.
errorMessage String Error message if the test run failed.
finishedAt Time Timestamp when the test run finished.
id SecurityScheduledPipelineExecutionPolicyTestRunID! ID of the test run.
pipeline Pipeline Pipeline created by the test run.
project Project! Project the test run was executed on.
startedAt Time Timestamp when the test run started.
state PolicyScheduleTestRunState! State of the test run.

PolicyScheduleTestRunConnection#

Paginated collection of PolicyScheduleTestRun. See Standard connection fields for the fields available on every connection.

PolicyScope#

Fields#

Name Type Description
complianceFrameworks ComplianceFrameworkConnection! Compliance Frameworks linked to the policy. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingApplicationAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.0.

Application security attributes that the policy does not apply to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingArchivedProjects Boolean! Boolean indicating whether archived projects are excluded from the policy.
excludingBusinessImpactAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 18.11.

Business Impact security attributes that the policy does not apply to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingBusinessUnitAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.1.

Business Unit security attributes that the policy does not apply to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingExposureAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.1.

Exposure security attributes that the policy does not apply to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingGroups GroupConnection! Groups to which the policy should not be applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingPersonalProjects Boolean! Boolean indicating whether personal projects are excluded from the policy.
excludingProjects ProjectConnection! Projects to which the policy should not be applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingApplicationAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.0.

Application security attributes that the policy applies to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingBusinessImpactAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 18.11.

Business Impact security attributes that the policy applies to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingBusinessUnitAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.1.

Business Unit security attributes that the policy applies to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingExposureAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.1.

Exposure security attributes that the policy applies to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingGroups GroupConnection! Groups to which the policy should be applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingProjects ProjectConnection! Projects to which the policy should be applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
matchMode PolicyScopeMatchMode! Introduced as an experiment in GitLab 18.10.

Specifies how multiple policy scope conditions are combined.

PolicyStore#

Catalogs available when creating a policy in the policy store.

Fields#

Name Type Description
actions [PolicyStoreAction!]! Introduced as an experiment in GitLab 19.4.

Actions available when creating a policy in the policy store.
policies GovernPolicyConnection Introduced as an experiment in GitLab 19.4.

Policies stored in the policy store for the organization or group. For a group, organization-wide, ancestor, and descendant groups' policies are included. Only first and after are supported; page with pageInfo.endCursor. Cursor offsets are capped at 100000, so policies past that window cannot be paged. The ids argument cannot be combined with pagination arguments. Returns null when the current user cannot read the policies of the container. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for policies:
ids ([Int!])
Introduced as an experiment in GitLab 19.4.

Return only the policies with these IDs. Unknown IDs are ignored; an empty list returns no policies. Maximum is 1000 IDs.
triggerType (String)
Introduced as an experiment in GitLab 19.4.

Return only the policies that respond to this trigger. Valid values are the ids in the policy store triggers catalog.
policyEvaluations GovernPolicyEvaluationConnection Introduced as an experiment in GitLab 19.4.

Recorded evaluations of the policies stored in the policy store for the organization or group, newest first. For a group, only evaluations of the group's own policies are returned. Returns null when the current user cannot read the policies of the container. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for policyEvaluations:
evaluatedAfter (Time)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations that ran at or after the given timestamp.
evaluatedBefore (Time)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations that ran at or before the given timestamp.
mode (GovernPolicyEvaluationMode)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations that ran in the given enforcement mode.
policyId (Int)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations of the policy with the given ID.
verdict (GovernPolicyEvaluationVerdict)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations that produced the given verdict.
rules [PolicyStoreRule!]! Introduced as an experiment in GitLab 19.4.

Rule kinds available when creating a policy in the policy store.
triggers [PolicyStoreTrigger!]! Introduced as an experiment in GitLab 19.4.

Triggers available when creating a policy in the policy store.

PolicyStoreAction#

Action available when creating a policy in the policy store.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.4.

Identifier of the action.
name String! Introduced as an experiment in GitLab 19.4.

Human-readable name of the action.

PolicyStoreRole#

A role that can be assigned in a policy action.

Fields#

Name Type Description
id String! Introduced as an experiment in GitLab 19.4.

Unique identifier for the role.
name String! Introduced as an experiment in GitLab 19.4.

Human-readable name of the role.

PolicyStoreRule#

Rule kind available when creating a policy in the policy store.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.4.

Identifier of the rule kind.
name String! Introduced as an experiment in GitLab 19.4.

Human-readable name of the rule kind.

PolicyStoreTrigger#

Trigger available when creating a policy in the policy store.

Fields#

Name Type Description
availableRoles [PolicyStoreRole!]! Introduced as an experiment in GitLab 19.4.

Roles available for the trigger type.
id ID! Introduced as an experiment in GitLab 19.4.

Identifier of the trigger.
name String! Introduced as an experiment in GitLab 19.4.

Human-readable name of the trigger.

PolicyViolationDetails#

Represents the details of merge request approval policy violations.

Fields#

Name Type Description
anyMergeRequest [PolicyAnyMergeRequestViolation!]! Represents the violations of any_merge_request rules.
comparisonPipelines [PolicyComparisonPipeline!]! Represents the pipelines used for comparison in the policy evaluation.
errors [PolicyError!]! Represents the policy errors.
licenseScanning [PolicyLicenseScanningViolation!]! Represents the violations of license_scanning rules.
newScanFinding [PolicyScanFindingViolation!]! Represents the newly detected violations of scan_finding rules.
policies [PolicyViolationInfo!]! Information about policies that were violated.
previousScanFinding [PolicyScanFindingViolation!]! Represents the violations of scan_finding rules for previously existing vulnerabilities.
violationsCount Int! Total count of violations.

PolicyViolationInfo#

Represents generic policy violation information.

Fields#

Name Type Description
dismissed Boolean! Represents if a warn mode policy violation was dismissed.
enforcementType PolicyEnforcementType! Represents the enforcement type of the violated policy.
name String! Represents the name of the violated policy.
reportType ApprovalReportType! Represents the report type.
securityPolicyId ID Represents the violated security policy id.
status PolicyViolationStatus Represents the status of the violated policy.

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.

Principal#

Representation of who is provided access to. For eg: User/Role/MemberRole.

Fields#

Name Type Description
id ID! ID of the principal (User, MemberRole, Role).
type PrincipalType! Name of the principal (User, MemberRole, Role).
user UserCore User who is provided access to.
userRoleId String RoleID of the user.

Project#

Implements: ProjectInterface, Todoable

Fields#

Name Type Description
actualRepositorySizeLimit Float Size limit for the repository in bytes.
adminEditPath String Admin path for editing project. Only available to admins.
adminShowPath String Admin path of the project. Only available to admins.
agentConfigurations AgentConfigurationConnection Agent configurations defined by the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
aiCatalogItem AiCatalogItem Introduced as an experiment in GitLab 18.5.

AI Catalog item of the project.

Arguments for aiCatalogItem:
id (AiCatalogItemID!)
Global ID of the catalog item to find.
showSoftDeleted (Boolean)
Whether to show the item if it has been soft-deleted. Defaults to false.
aiCatalogItemConsumerForItem AiCatalogItemConsumer Introduced as an experiment in GitLab 19.0.

AI Catalog item configuration for the given item in the project.

Arguments for aiCatalogItemConsumerForItem:
id (AiCatalogItemID!)
Global ID of the catalog item to return the configuration of.
aiCatalogItems AiCatalogItemConnection! Introduced as an experiment in GitLab 18.6.

AI Catalog items of the project. This field can be resolved for only one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiCatalogItems:
allAvailable (Boolean)
Include public items from the AI Catalog.
enabled (Boolean)
Include only items that are enabled or disabled in the project.
itemTypes ([AiCatalogItemType!])
Types of items to retrieve.
search (String)
Search items by name and description.
sort (AiCatalogItemsSort)
Sort order of items.
aiFlowTriggers AiFlowTriggerTypeConnection Introduced as an experiment in GitLab 18.3.

AI flow triggers of the project. This field can only be resolved for one project per request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiFlowTriggers:
ids ([AiFlowTriggerID!])
Filter AI flow triggers by IDs.
aiGovernanceMetrics AiGovernanceMetrics Introduced as an experiment in GitLab 19.3.

Aggregated AI governance dashboard metrics. Returns null when the ai_governance_dashboard feature flag is disabled.

Arguments for aiGovernanceMetrics:
agentClass (AiGovernanceAgentClass)
Agent class to segment the metrics by. Defaults to ALL.
timeframe (AiGovernanceMetricsTimeframe)
Time window for the metrics. Defaults to LAST_7_DAYS.
aiGovernanceSessions AiGovernanceSessionConnection Introduced as an experiment in GitLab 19.5.

AI sessions for the project, from GitLab Duo and external agents. Returns no sessions when the ai_governance_sessions_api feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiGovernanceSessions:
agentClass (AiGovernanceAgentClass)
Filter sessions by agent class. Defaults to all agent classes.
flowType (String)
Filter by flow type.
id (AiGovernanceSessionID)
Global ID of the session.
not (AiGovernanceSessionNegatedFilterInput)
Negated filter conditions.
sessionStartedAfter (Time)
Return sessions started at or after the timestamp.
sessionStartedBefore (Time)
Return sessions started at or before the timestamp.
triggeredByUserId (UserID)
Filter to sessions triggered by the user with the given global ID.
aiGovernanceToolCalls AiGovernanceToolCallsReport Introduced as an experiment in GitLab 19.5.

Top tools invoked by AI agents, with invocation counts. Returns null when the ai_governance_dashboard or ai_governance_tool_calls feature flag is disabled or when ClickHouse is not enabled.

Arguments for aiGovernanceToolCalls:
agentClass (AiGovernanceAgentClass)
Agent class to segment the tool calls by. Defaults to ALL.
timeframe (AiGovernanceMetricsTimeframe)
Time window for the tool calls. Defaults to LAST_7_DAYS.
aiMetrics AiMetrics Introduced as an experiment in GitLab 16.11.

AI-related metrics.

Arguments for aiMetrics:
endDate (Date)
Date range to end at. Default is the end of current month.
startDate (Date)
Date range to start from. Default is the beginning of current month.
aiUsageData AiUsageData Introduced as an experiment in GitLab 17.5.

AI-related data.
aiUserMetrics AiUserMetricsConnection Introduced as an experiment in GitLab 17.5.

AI-related user metrics. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiUserMetrics:
endDate (Date)
Date range to end at. Default is the end of current month. ClickHouse needs to be enabled when passing this param.
sort (AiUserMetricsSort)
Sort AI user metrics.
startDate (Date)
Date range to start from. Default is the beginning of current month. ClickHouse needs to be enabled when passing this param.
aiXrayReports AiXrayReportConnection! Introduced as an experiment in GitLab 17.8.

X-ray reports of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
alertManagementAlert AlertManagementAlert A single Alert Management alert of the project.

Arguments for alertManagementAlert:
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 the criteria.
statuses ([AlertManagementStatus!])
Alerts with the specified statues. For example, [TRIGGERED].
alertManagementAlertStatusCounts AlertManagementAlertStatusCountsType Counts of alerts by status for the project.

Arguments for alertManagementAlertStatusCounts:
assigneeUsername (String)
Username of a user assigned to the issue.
search (String)
Search query for title, description, service, or monitoring_tool.
alertManagementAlerts AlertManagementAlertConnection Alert Management alerts of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementAlerts:
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 the criteria.
statuses ([AlertManagementStatus!])
Alerts with the specified statues. For example, [TRIGGERED].
alertManagementHttpIntegrations AlertManagementHttpIntegrationConnection HTTP Integrations which can receive alerts for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementHttpIntegrations:
id (AlertManagementHttpIntegrationID)
ID of the integration.
types ([AlertManagementIntegrationType!])
Types of integrations to return. Default is [HTTP].
alertManagementIntegrations AlertManagementIntegrationConnection Deprecated in GitLab 18.2. Use alertManagementHttpIntegrations. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementIntegrations:
id (GlobalID)
ID of the integration.
alertManagementPayloadFields [AlertManagementPayloadAlertField!] Extract alert fields from payload for custom mapping.

Arguments for alertManagementPayloadFields:
payloadExample (String!)
Sample payload for extracting alert fields for custom mappings.
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.
allowsMultipleMergeRequestAssignees Boolean! Project allows assigning multiple users to a merge request.
allowsMultipleMergeRequestReviewers Boolean! Project allows assigning multiple reviewers to a merge request.
analytics Analytics Introduced as an experiment in GitLab 18.11.

Project analytics aggregation endpoints.
analyzerStatuses [AnalyzerProjectStatusType!] Status for all analyzers in the project.
apiFuzzingCiConfiguration ApiFuzzingCiConfiguration API fuzzing configuration for the project.
approvalPolicies ApprovalPolicyConnection Approval Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for approvalPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
archived Boolean Indicates if the project or any ancestor is archived.
ascpComponents AscpComponentConnection Introduced as an experiment in GitLab 18.11.

ASCP business components in the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ascpComponents:
subDirectory (String)
Filter by exact sub-directory path.
title (String)
Filter by component title (case-insensitive partial match).
ascpScans AscpScanConnection Introduced as an experiment in GitLab 18.10.

ASCP security scans for this project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ascpScans:
scanType (AscpScanType)
Filter by scan type.
autocloseReferencedIssues Boolean Indicates if issues referenced by merge requests and commits within the default branch are closed automatically.
autocompleteUsers [AutocompletedUser!] Search users for autocompletion.

Arguments for autocompleteUsers:
search (String)
Query to search users by name, username, or public email.
availableDeployKeys AccessLevelDeployKeyConnection List of available deploy keys. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for availableDeployKeys:
titleQuery (String)
Term by which to search deploy key titles.
avatarUrl String Avatar URL of the project.
board Board A single board of the project.

Arguments for board:
id (BoardID!)
ID of the board.
boards BoardConnection Boards of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for boards:
id (BoardID)
Find a board by its ID.
branchRules BranchRuleConnection Branch rules configured for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for branchRules:
buildMissing (Boolean)
Return unpersisted custom branch rules.
ciAccessAuthorizedAgents ClusterAgentAuthorizationCiAccessConnection Authorized cluster agents for the project through ci_access keyword. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciCdSettings ProjectCiCdSetting CI/CD settings for the project.
ciConfigPathOrDefault String! Path of the CI configuration file. Returns an empty string if the user does not have permission to read the repository.
ciConfigVariables [CiConfigVariable!] Introduced as an experiment in GitLab 15.3.

CI/CD config variable.

Arguments for ciConfigVariables:
failOnCacheMiss (Boolean)
Whether to throw an error if cache is not ready.
ref (String!)
Ref.
ciDownstreamProjectSubscriptions CiProjectSubscriptionConnection Introduced as an experiment in GitLab 17.6.

Pipeline subscriptions where this project is the upstream project.When this project's pipeline completes, a pipeline is triggered in the downstream project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciJobTokenAuthLogs CiJobTokenAuthLogConnection Introduced as an experiment in GitLab 17.6.

The CI Job Tokens authorization logs. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciJobTokenScope CiJobTokenScopeType The CI Job Tokens scope of access.
ciJobTokenScopeAllowlist CiJobTokenScopeAllowlist Introduced as an experiment in GitLab 17.6.

List of CI job token scopes where the project is the source.
ciPipelineCreationInputs [CiInputsSpec!] Introduced as an experiment in GitLab 17.10.

Inputs to create a pipeline.

Arguments for ciPipelineCreationInputs:
failOnCacheMiss (Boolean)
Whether to throw an error for a cache miss.
ref (String!)
Ref where to create the pipeline.
ciPipelineCreationRequest CiPipelineCreationRequest Introduced as an experiment in GitLab 17.9.

Get information about an asynchronous pipeline creation request.

Arguments for ciPipelineCreationRequest:
requestId (String!)
ID of the pipeline creation request.
ciSubscribedProjects CiSubscriptionsProjectConnection Deprecated in GitLab 17.6. Use ciDownstreamProjectSubscriptions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciSubscriptionsProjects CiSubscriptionsProjectConnection Deprecated in GitLab 17.6. Use ciUpstreamProjectSubscriptions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciTemplate CiTemplate Find a single CI/CD template by name.

Arguments for ciTemplate:
name (String!)
Name of the CI/CD template to search for. Template must be formatted as Name.gitlab-ci.yml.
ciUpstreamProjectSubscriptions CiProjectSubscriptionConnection Introduced as an experiment in GitLab 17.6.

Pipeline subscriptions where this project is the downstream project.When an upstream project's pipeline completes, a pipeline is triggered in the downstream project (this project). This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciVariables CiProjectVariableConnection List of the project's CI/CD variables. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ciVariables:
sort (CiVariableSort)
Sort order of results.
clusterAgent ClusterAgent Find a single cluster agent by name.

Arguments for clusterAgent:
hasRemoteDevelopmentAgentConfig (Boolean)
Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled (Boolean)
Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities (Boolean)
Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig (Boolean)
Returns only cluster agents which have an associated workspaces agent config.
name (String!)
Name of the cluster agent.
clusterAgents ClusterAgentConnection Cluster agents associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for clusterAgents:
hasRemoteDevelopmentAgentConfig (Boolean)
Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled (Boolean)
Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities (Boolean)
Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig (Boolean)
Returns only cluster agents which have an associated workspaces agent config.
codeCoverageSummary CodeCoverageSummary Code coverage summary associated with the project.
commitReferences CommitReferences Introduced as an experiment in GitLab 16.0.

Get tag names containing a given commit.

Arguments for commitReferences:
commitSha (String!)
Project commit SHA identifier. For example, 287774414568010855642518513f085491644061.
complianceControlStatus ProjectComplianceControlStatusTypeConnection Introduced as an experiment in GitLab 17.11.

Compliance control statuses for a project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceControlStatus:
filters (ProjectComplianceControlStatusInput)
Filters applied when retrieving compliance control statuses for the project.
complianceFrameworks ComplianceFrameworkConnection Compliance frameworks associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceFrameworks:
sort (ComplianceFrameworkSort)
Sort compliance frameworks by the criteria.
complianceRequirementStatuses ProjectComplianceRequirementStatusConnection Introduced as an experiment in GitLab 18.0.

Compliance requirement statuses for a project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceRequirementStatuses:
filters (ProjectRequirementComplianceStatusInput)
Filters applied when retrieving compliance requirement statuses.
orderBy (ProjectComplianceRequirementStatusOrderBy)
Field used to sort compliance requirement statuses.
complianceStandardsAdherence ComplianceStandardsAdherenceConnection Compliance standards adherence for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceStandardsAdherence:
filters (ComplianceStandardsProjectAdherenceInput)
Filters applied when retrieving compliance standards adherence.
componentUsages CiCatalogResourceComponentUsageConnection Component(s) used by the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
componentVersions ComponentVersionConnection! Introduced as an experiment in GitLab 17.10.

Find software dependency versions by component name. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for componentVersions:
componentName (String!)
Name of the SBoM component.
components [Component!] Introduced as an experiment in GitLab 17.9.

Find software dependencies by name.

Arguments for components:
name (String)
Entire name or part of the name.
containerExpirationPolicy ContainerExpirationPolicy Deprecated in GitLab 17.5. Use container_tags_expiration_policy.
containerProtectionRepositoryRules ContainerProtectionRepositoryRuleConnection Container protection rules for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
containerProtectionTagRules ContainerProtectionTagRuleConnection Container repository tag protection rules for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
containerRegistryEnabled Boolean Indicates if Container registry is enabled for the current user.
containerRepositories ContainerRepositoryConnection Container repositories of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for containerRepositories:
name (String)
Filter the container repositories by their name.
sort (ContainerRepositorySort)
Sort container repositories by the criteria.
containerRepositoriesCount Int! Number of container repositories in the project.
containerScanningForRegistryEnabled Boolean Indicates whether container scanning for registry is enabled or not for the project. Returns null if unauthorized.
containerTagsExpirationPolicy ContainerTagsExpirationPolicy Container tags expiration policy of the project.
corpuses CoverageFuzzingCorpusConnection Find corpuses of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time Timestamp of the project creation.
customAttributes [CustomAttribute!] Custom attributes of the project. Only available to admins.
customizableDashboardVisualizations CustomizableDashboardVisualizationConnection Introduced as an experiment in GitLab 16.1.

Visualizations of the project or associated configuration project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customizableDashboardVisualizations:
slug (String)
Slug of the visualization to return.
customizableDashboards CustomizableDashboardConnection Introduced as an experiment in GitLab 15.6.

Customizable dashboards for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customizableDashboards:
category (CustomizableDashboardCategory)
Find by dashboard type.
slug (String)
Find by dashboard slug.
dastProfile DastProfile DAST Profile associated with the project.

Arguments for dastProfile:
hasDastProfileSchedule (Boolean)
Filter DAST Profiles by whether or not they have a schedule.
id (DastProfileID!)
ID of the DAST Profile.
dastProfiles DastProfileConnection DAST Profiles associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dastProfiles:
hasDastProfileSchedule (Boolean)
Filter DAST Profiles by whether or not they have a schedule.
dastScannerProfiles DastScannerProfileConnection DAST scanner profiles associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
dastSiteProfile DastSiteProfile DAST Site Profile associated with the project.

Arguments for dastSiteProfile:
id (DastSiteProfileID!)
ID of the site profile.
dastSiteProfiles DastSiteProfileConnection DAST Site Profiles associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
dastSiteValidations DastSiteValidationConnection DAST Site Validations associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dastSiteValidations:
normalizedTargetUrls ([String!])
Normalized URL of the target to be scanned.
status (DastSiteValidationStatusEnum)
Status of the site validation.
dataTransfer ProjectDataTransfer Data transfer data point for a specific period. This is mocked data under a development feature flag.

Arguments for dataTransfer:
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.
defaultMergeRequestTarget Project Default target project of merge requests created from the project. For a fork, this is the upstream project when the fork can target it, and the fork itself otherwise. Returns null when the target project is not visible to the current user.
dependencies DependencyConnection Software dependencies used by the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencies:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
dependencyFirewallActivitySummary DependencyFirewallActivitySummary Introduced as an experiment in GitLab 19.3.

Aggregate dependency firewall activity totals for the project. Available behind the dependency_firewall_phase1 feature flag. This field can be resolved for only one project in any single request.

Arguments for dependencyFirewallActivitySummary:
from (Date)
Start date (inclusive) of the activity window. Defaults to 7 days ago.
to (Date)
End date (inclusive) of the activity window. Defaults to the current date.
dependencyFirewallRuleActivity [DependencyFirewallRuleActivity!] Introduced as an experiment in GitLab 19.3.

Dependency firewall per-rule block and warn activity for the project. Available behind the dependency_firewall_phase1 feature flag.

Arguments for dependencyFirewallRuleActivity:
from (Date)
Start date (inclusive) of the activity window. Defaults to 7 days ago.
to (Date)
End date (inclusive) of the activity window. Defaults to the current date.
dependencyPaths DependencyPathPage Introduced as an experiment in GitLab 17.10.

Ancestor dependency paths for a dependency used by the project. Returns null if dependency_graph_graphql feature flag is disabled.

Arguments for dependencyPaths:
after (String)
Fetch paths after the cursor.
before (String)
Fetch paths before the cursor.
limit (Int)
Number of paths to fetch.
occurrence (SbomOccurrenceID!)
Dependency path for occurrence.
dependencyProxyPackagesSetting DependencyProxyPackagesSetting 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.
dependencyTrackedRefs DependencyTrackedRefConnection Introduced as an experiment in GitLab 19.3.

Refs (branches or tags) where a software dependency appears. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyTrackedRefs:
componentVersionId (SbomComponentVersionID!)
Global ID of the component version to find refs for.
search (String)
Filter refs by name.
deployment Deployment Details of the deployment of the project.

Arguments for deployment:
iid (ID!)
Project-level internal ID of the Deployment.
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.
duoAgenticChatAvailable Boolean Introduced as an experiment in GitLab 18.1.

User access to Duo agentic Chat feature.
duoContextExclusionSettings DuoContextExclusionSettings Introduced as an experiment in GitLab 18.2.

Settings for excluding files from Duo context.
duoDependencyBumpBreakingChangesAvailable Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether the GitLab Duo resolve dependency bump breaking changes flow can be triggered for the project.
duoFeaturesEnabled Boolean Introduced as an experiment in GitLab 16.9.

Indicates whether GitLab Duo features are enabled for the project.
duoMcpServersCount Int Introduced as an experiment in GitLab 19.4.

Number of distinct MCP servers used by the project's configured agents. Resolved on request only, because it reads the configured agents and their versions.
duoWorkflowEvents DuoWorkflowEventConnection Checkpoints for GitLab Duo Agent Platform flows, for all users (remote flows only). Returns only the latest checkpoint by default. Use first and after to page through history. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowEvents:
workflowId (AiDuoWorkflowsWorkflowID!)
Array of request IDs to fetch.
duoWorkflowRunnerAvailable Boolean Introduced as an experiment in GitLab 19.3.

Indicates whether the project has a runner that can pick up GitLab Duo Agent Platform workloads. Resolved on request only, because it queries the project's runners and their managers.
duoWorkflowSessionArtifacts DuoWorkflowSessionArtifactConnection Introduced as an experiment in GitLab 19.1.

Duo Agent Platform session artifacts for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowSessionArtifacts:
agentClass (AiGovernanceAgentClass)
Filter sessions by agent class. Defaults to all agent classes.
not (DuoWorkflowSessionArtifactNegatedFilterInput)
Negated filter conditions.
triggeredByUserId (UserID)
Filter to sessions triggered by the user with the given global ID.
workflowCreatedAfter (Time)
Return sessions created after the timestamp.
workflowCreatedBefore (Time)
Return sessions created before the timestamp.
workflowDefinition (String)
Filter by workflow definition.
workflowId (AiDuoWorkflowsWorkflowID)
Filter to a single session by its workflow (session) global ID.
duoWorkflowStatusCheck DuoWorkflowEnablement Introduced as an experiment in GitLab 17.7.

Indicates whether Duo Agent Platform is enabled for the project.
duoWorkflowUsableRunnerType String Introduced as an experiment in GitLab 19.3.

Runner type (instance_type, group_type, or project_type) of the runner that can pick up GitLab Duo Agent Platform workloads, or null when none can. Shares its runner scan with duoWorkflowRunnerAvailable when both are requested.
duoWorkflowWorkflows DuoWorkflowConnection GitLab Duo Agent Platform flows for a project, for all users (remote flows only). This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowWorkflows:
environment (WorkflowEnvironment)
Environment, for example, IDE or web.
excludeSourceTypes ([DuoWorkflowSourceType!])
Introduced as an experiment in GitLab 19.5.

Source types to exclude. Sessions with no recorded source type are never excluded.
excludeTypes ([String!])
Types of flows to exclude (for example, ["software_development", "chat"]).
ids ([AiDuoWorkflowsWorkflowID!])
Filter flows by a list of IDs.
projectId (ProjectID)
Global ID of the project that contains the flows.
projectPath (ID)
Full path of the project that contains the flows.
search (String)
Flow title or goal to search for.
sort (DuoWorkflowsWorkflowSort)
Sort flows by the criteria.
statusGroup (DuoWorkflowStatusGroup)
Status group to filter flow sessions by.
statuses ([DuoWorkflowStatus!])
Exact statuses to filter flow sessions by. Cannot be combined with statusGroup.
type (String)
Type of flow to filter by (for example, software_development or foundational_chat_agents).
updatedAfter (ISO8601DateTime)
Filters flows updated after a given date.
workflowId (AiDuoWorkflowsWorkflowID)
Flow ID to filter by.
editPath String! Path for editing project.
environment Environment A single environment of the project.

Arguments for environment:
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.
environments EnvironmentConnection Environments of the project. This field can only be resolved for one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for environments:
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.
exploreCatalogPath String Introduced as an experiment in GitLab 17.6.

Path to the project catalog resource.
flowMetrics ProjectValueStreamAnalyticsFlowMetrics Introduced as an experiment in GitLab 15.10.

Flow metrics for value stream analytics.
forkDetails ForkDetails Introduced as an experiment in GitLab 15.7.

Details of the fork project compared to its upstream project.

Arguments for forkDetails:
ref (String)
Ref of the fork. Default value is HEAD.
forkTargets NamespaceConnection Namespaces in which the current user can fork the project into. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for forkTargets:
search (String)
Search query for path or name.
forkedFrom Project Project the project was forked from.
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.
gitlabSubscriptionsPreviewBillableUserChange PreviewBillableUserChange Preview Billable User Changes.

Arguments for gitlabSubscriptionsPreviewBillableUserChange:
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.
googleCloudArtifactRegistryRepository GoogleCloudArtifactRegistryRepository Introduced as an experiment in GitLab 16.10.

Google Artifact Registry repository. Returns null if the GitLab instance is not a SaaS instance.
grafanaIntegration GrafanaIntegration Deprecated in GitLab 18.3. Feature was removed in 16.0. Always returns null.
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.
incidentManagementEscalationPolicies EscalationPolicyTypeConnection Incident Management escalation policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for incidentManagementEscalationPolicies:
name (String)
Fuzzy search by escalation policy name.
incidentManagementEscalationPolicy EscalationPolicyType Incident Management escalation policy of the project.

Arguments for incidentManagementEscalationPolicy:
id (IncidentManagementEscalationPolicyID!)
ID of the escalation policy.
name (String)
Fuzzy search by escalation policy name.
incidentManagementOncallSchedules IncidentManagementOncallScheduleConnection Incident Management On-call schedules of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for incidentManagementOncallSchedules:
iids ([ID!])
IIDs of on-call schedules.
incidentManagementTimelineEvent TimelineEventType Incident Management Timeline event associated with the incident.

Arguments for incidentManagementTimelineEvent:
id (IncidentManagementTimelineEventID!)
ID of the timeline event.
incidentId (IssueID!)
ID of the incident.
incidentManagementTimelineEventTags [TimelineEventTagType!] Timeline event tags for the project.
incidentManagementTimelineEvents TimelineEventTypeConnection Incident Management Timeline events associated with the incident. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for incidentManagementTimelineEvents:
incidentId (IssueID!)
ID of the incident.
inheritedCiVariables InheritedCiVariableConnection List of CI/CD variables the project inherited from its parent group and ancestors. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for inheritedCiVariables:
sort (CiGroupVariablesSort)
Sort variables by the criteria.
isCatalogResource Boolean Introduced as an experiment in GitLab 15.11.

Indicates if a project is a catalog resource.
isForked Boolean! Project is forked.
isPublished Boolean Introduced as an experiment in GitLab 18.6.

Indicates if a project's catalog resource is published.
isSelfArchived Boolean Introduced as an experiment in GitLab 18.6.

Indicates if the project is archived.
isSelfDeletionInProgress Boolean! Introduced as an experiment in GitLab 18.3.

Indicates if project deletion is in progress.
isSelfDeletionScheduled Boolean! Introduced as an experiment in GitLab 18.3.

Indicates if project deletion is scheduled.
issue Issue A single issue of the project.

Arguments for issue:
assigneeId (String)
ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername (String)
Deprecated in GitLab 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 the date.
closedBefore (Time)
Issues closed before the date.
confidential (Boolean)
Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter (Time)
Issues created after the date.
createdBefore (Time)
Issues created before the date.
crmContactId (String)
ID of a contact assigned to the issues.
crmOrganizationId (String)
ID of an organization assigned to the issues.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter (Time)
Return issues due on or after the given time.
dueBefore (Time)
Return issues due on or before the given time.
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 GitLab 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 the issue.
milestoneTitle ([String])
Milestone applied to the 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 the criteria.
state (IssuableState)
Current state of the issue.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Issues the current user is subscribed to.
types ([IssueType!])
Filter issues by the given issue types.
updatedAfter (Time)
Issues updated after the date.
updatedBefore (Time)
Issues updated before the date.
weight (String)
Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter issues by work item type global IDs.
issueStatusCounts IssueStatusCountsType Counts of issues by status for the project.

Arguments for issueStatusCounts:
assigneeId (String)
ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername (String)
Deprecated in GitLab 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 the date.
closedBefore (Time)
Issues closed before the date.
confidential (Boolean)
Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter (Time)
Issues created after the date.
createdBefore (Time)
Issues created before the date.
crmContactId (String)
ID of a contact assigned to the issues.
crmOrganizationId (String)
ID of an organization assigned to the issues.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter (Time)
Return issues due on or after the given time.
dueBefore (Time)
Return issues due on or before the given time.
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 the issue.
milestoneTitle ([String])
Milestone applied to the 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Issues the current user is subscribed to.
types ([IssueType!])
Filter issues by the given issue types.
updatedAfter (Time)
Issues updated after the date.
updatedBefore (Time)
Issues updated before the date.
weight (String)
Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter issues by work item type global IDs.
issues IssueConnection Issues of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issues:
assigneeId (String)
ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername (String)
Deprecated in GitLab 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 the date.
closedBefore (Time)
Issues closed before the date.
confidential (Boolean)
Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter (Time)
Issues created after the date.
createdBefore (Time)
Issues created before the date.
crmContactId (String)
ID of a contact assigned to the issues.
crmOrganizationId (String)
ID of an organization assigned to the issues.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter (Time)
Return issues due on or after the given time.
dueBefore (Time)
Return issues due on or before the given time.
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 GitLab 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 the issue.
milestoneTitle ([String])
Milestone applied to the 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 the criteria.
state (IssuableState)
Current state of the issue.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Issues the current user is subscribed to.
types ([IssueType!])
Filter issues by the given issue types.
updatedAfter (Time)
Issues updated after the date.
updatedBefore (Time)
Issues updated before the date.
weight (String)
Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter issues by work item type global IDs.
issuesAccessLevel ProjectFeatureAccess Access level required for issues access.
issuesEnabled Boolean Indicates if Issues are enabled for the current user.
iterationCadences IterationCadenceConnection Find iteration cadences. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for iterationCadences:
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 the 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.
iterations IterationConnection Find iterations. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for iterations:
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 GitLab 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
jiraImportStatus String Status of Jira import background job of the project.
jiraImports JiraImportConnection Jira imports into the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
job CiJob One job belonging to the project, selected by ID.

Arguments for job:
id (JobID!)
ID of the job.
jobAnalytics CiJobAnalyticsConnection Introduced as an experiment in GitLab 18.5.

CI/CD job analytics for the project. Returns an error if ClickHouse is not configured. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobAnalytics:
fromTime (Time)
Start of the requested time (in UTC). Defaults to the pipelines started in the past week. Cannot be earlier than 180 days ago.
nameSearch (String)
Search by name of the pipeline jobs. Supports partial matches.
ref (String)
Branch that triggered the pipeline.
sort (CiJobAnalyticsSort)
Sort order for the results.
source (CiPipelineSources)
Source of the pipeline.
toTime (Time)
End of the requested time (in UTC). Defaults to the pipelines started before the current date.
jobs CiJobConnection Jobs of a project. This field can only be resolved for one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobs:
kind (CiJobKind)
Filter jobs by kind.
name (String)
Introduced as an experiment in GitLab 17.11.

Filter jobs by name.
pipelineIid (String)
Filter jobs by the internal pipeline ID (iid).
sources ([CiJobSource!])
Introduced as an experiment in GitLab 17.7.

Filter jobs by source.
statuses ([CiJobStatus!])
Filter jobs by status.
withArtifacts (Boolean)
Filter by artifacts presence.
jobsEnabled Boolean Indicates if CI/CD pipeline jobs are enabled for the current user.
label Label Label available on the project.

Arguments for label:
title (String!)
Title of the label.
labels LabelConnection Labels available on this project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for labels:
archived (Boolean)
Filters archived labels. Defaults to false.
fuzzySearch (Boolean)
Match searchTerm fuzzily: labels match when they contain the searched characters in order, but not necessarily contiguously (for example, bugu matches bug::ux). Ignored if using title, or if the fuzzy_label_search feature flag is disabled.
includeAncestorGroups (Boolean)
Include labels from ancestor groups.
searchIn ([LabelSearchFieldList!]!)
Specify which fields to search in. Ignored if using title.
searchTerm (String)
Search term to find labels with.
title (String)
Exact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.
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.
licensedFeatureAvailability LicensedFeatureAvailability! Introduced as an experiment in GitLab 18.11.

Check whether a licensed feature is available.

Arguments for licensedFeatureAvailability:
feature (LicensedFeature!)
Feature to check availability for (for example, SECURITY_DASHBOARD).
markedForDeletion Boolean Introduced as an experiment in GitLab 18.1.

Indicates if the project or any ancestor is scheduled for deletion.
markedForDeletionOn Time Introduced as an experiment in GitLab 16.10.

Date when project was scheduled to be deleted.
maxAccessLevel AccessLevel! Maximum access level of the current user in the project.
memberRoles MemberRoleConnection Introduced as an experiment in GitLab 16.5.

Member roles available for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for memberRoles:
assignable (Boolean)
Filter for member roles the current user can assign.
id (MemberRoleID)
Global ID of the member role to look up.
ids ([MemberRoleID!])
Global IDs of the member role to look up.
orderBy (MemberRolesOrderBy)
Ordering column. Default is NAME.
sort (SortDirectionEnum)
Ordering column. Default is ASC.
mergeCommitTemplate String Template used to create merge commit message in merge requests.
mergeRequest MergeRequest A single merge request of the project.

Arguments for mergeRequest:
iid (String!)
IID of the merge request, for example 1.
mergeRequestTitleRegex String Regex used to validate the title of merge requests.
mergeRequestTitleRegexDescription String Description of the regex used to validate the title of merge requests.
mergeRequestViolations ComplianceViolationConnection Compliance violations reported on merge requests merged within the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequestViolations:
filters (ComplianceViolationProjectInput)
Filters applied when retrieving compliance violations.
sort (ComplianceViolationSort)
List compliance violations by sort order.
mergeRequests MergeRequestConnection Merge requests of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
mergeRequestsAccessLevel ProjectFeatureAccess Access level required for merge requests access.
mergeRequestsDefaultTargetSelf Boolean Indicates if merge requests of a forked project target the fork itself by default instead of the upstream project.
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.
mergeTrains MergeTrainConnection Introduced as an experiment in GitLab 17.1.

Merge trains available to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeTrains:
status (MergeTrainStatus)
Filter merge trains by a specific status.
targetBranches ([String!])
Filter merge trains by a list of target branches.
milestones MilestoneConnection Milestones of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for milestones:
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 the criteria.
state (MilestoneStateEnum)
Filter milestones by state.
timeframe (Timeframe)
List items overlapping the given timeframe.
title (String)
Title of the milestone.
mlExperiments MlExperimentConnection Find machine learning experiments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mlExperiments:
name (String)
Search for names that include the string.
orderBy (MlModelsOrderBy)
Ordering column. Default is created_at.
sort (SortDirectionEnum)
Ordering direction. Default is desc.
mlModels MlModelConnection Introduced as an experiment in GitLab 16.8.

Finds machine learning models. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mlModels:
name (String)
Search for names that include the string.
orderBy (MlModelsOrderBy)
Ordering column. Default is created_at.
sort (SortDirectionEnum)
Ordering column. Default is desc.
name String! Name of the project without the namespace.
nameWithNamespace String! Name of the project including the namespace.
namespace Namespace Namespace of the project.
nestedEnvironments NestedEnvironmentConnection Environments for this project with nested folders, can only be resolved for one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for nestedEnvironments:
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.
observabilityLogsLinks ObservabilityLogConnection Introduced as an experiment in GitLab 17.4.

Logs attached to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for observabilityLogsLinks:
fingerprint (String)
Fingerprint of the log.
serviceName (String)
Service name of the log.
severityNumber (Int)
Severity number of the log.
timestamp (ISO8601DateTime)
Log timestamp of the log.
traceIdentifier (String)
Trace id of the log.
observabilityMetricsLinks ObservabilityMetricConnection Introduced as an experiment in GitLab 17.4.

Metrics attached to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for observabilityMetricsLinks:
name (String)
Name of the metric.
type (OpenTelemetryMetricType)
Type of the metric.
observabilityTracesLinks ObservabilityTraceConnection Introduced as an experiment in GitLab 17.4.

Traces attached to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for observabilityTracesLinks:
traceIdentifier (String)
Identifier of the trace.
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.
orbit OrbitNamespace Introduced as an experiment in GitLab 19.5.

Orbit data of the project. Returns null when Orbit is not available to the current user.
organizationEditPath String Introduced as an experiment in GitLab 16.11.

Path for editing project at the organization level.
packages PackageConnection Packages of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packages:
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 the criteria.
status (PackageStatus)
Filter a package by status.
packagesCleanupPolicy PackagesCleanupPolicy Packages cleanup policy for the project.
packagesProtectionRules PackagesProtectionRuleConnection Introduced as an experiment in GitLab 16.6.

Packages protection rules for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pagesDeployments PagesDeploymentConnection List of the project's Pages Deployments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pagesDeployments:
active (Boolean)
Filter by active or inactive state.
sort (Sort)
Sort results.
versioned (Boolean)
Filter deployments that are versioned or unversioned.
pagesForceHttps Boolean! Project's Pages site redirects unsecured connections to HTTPS.
pagesUseUniqueDomain Boolean! Project's Pages site uses a unique subdomain.
path String! Path of the project.
pathLocks PathLockConnection The project's path locks. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pendingMemberApprovals MemberApprovalConnection Pending member promotions of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
permanentDeletionDate String Introduced as an experiment in GitLab 16.11.

For projects pending deletion, returns the project's scheduled deletion date. For projects not pending deletion, returns a theoretical date based on current settings if marked for deletion today.
pipeline Pipeline Pipeline of the project. If no arguments are provided, returns the latest pipeline for the head commit on the default branch.

Arguments for pipeline:
id (CiPipelineID)
Global ID of the Pipeline. For example, "gid://gitlab/Ci::Pipeline/314".
iid (ID)
IID of the Pipeline. For example, "1".
sha (String)
SHA of the Pipeline. For example, "dyd0f15ay83993f5ab66k927w28673882x99100b".
pipelineAnalytics PipelineAnalytics Pipeline analytics.

Arguments for pipelineAnalytics:
fromTime (Time)
Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref (String)
Branch that triggered the pipeline.
source (CiPipelineSources)
Source of the pipeline.
subgroupFullPaths ([String!])
Introduced as an experiment in GitLab 18.11.

Full paths of subgroups to filter by. Only applies when querying pipeline analytics for a group (maximum is 10).
toTime (Time)
End of the requested time (in UTC). Defaults to the pipelines started before the current date.
pipelineCounts PipelineCounts Pipeline counts of the project.

Arguments for pipelineCounts:
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.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
pipelineExecutionSchedulePolicies PipelineExecutionSchedulePolicyConnection Pipeline Execution Schedule Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionSchedulePolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
pipelineScheduleStatusCounts PipelineScheduleStatusCount Counts of pipeline schedules by status.
pipelineSchedules PipelineScheduleConnection Pipeline schedules of the project. This field can only be resolved for one project per request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineSchedules:
ids ([ID!])
Filter pipeline schedules by IDs.
sort (PipelineScheduleSort)
List pipeline schedules by sort order. Default is id_desc.
status (PipelineScheduleStatus)
Filter pipeline schedules by active status.
pipelineTriggers PipelineTriggerConnection Introduced as an experiment in GitLab 16.3.

List of pipeline trigger tokens. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipelines PipelineConnection Pipelines of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelines:
ids ([ID!])
Filter pipelines by their Global IDs. Maximum 20 IDs per request.
ref (String)
Filter pipelines by the ref they are run for.
refType (RefType)
Type of ref.
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 the date.
updatedBefore (Time)
Pipelines updated before the date.
username (String)
Filter pipelines by the user that triggered the pipeline.
preReceiveSecretDetectionEnabled Boolean Indicates whether secret push protection is on or not for the project.
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.
projectMembers MemberInterfaceConnection Members of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectMembers:
accessLevels ([AccessLevelEnum!])
Filter members by the given access levels.
ids ([ID!])
List of project members IDs.
relations ([ProjectMemberRelation!])
Filter members by the given member relations.
search (String)
Search query.
sort (MemberSort)
sort query.
userTypes ([UserType!])
Introduced as an experiment in GitLab 18.3.

Filter by user type.
projectPlanLimits ProjectPlanLimits Introduced as an experiment in GitLab 16.9.

Plan limits for the current project.
protectableBranches [String!] Introduced as an experiment in GitLab 16.9.

List of unprotected branches, ignoring any wildcard branch rules.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
release Release A single release of the project.

Arguments for release:
tagName (String!)
Name of the tag associated to the release.
releases ReleaseConnection Releases of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for releases:
sort (ReleaseSort)
Sort releases by given criteria.
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.
requirement Requirement Find a single requirement.

Arguments for requirement:
authorUsername ([String!])
Filter requirements by author username.
iid (ID)
Deprecated in GitLab 15.8. Use work_item_iid instead.
iids ([ID!])
Deprecated in GitLab 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].
requirementStatesCount RequirementStatesCount Number of requirements for the project by their state.
requirements RequirementConnection Find requirements. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for requirements:
authorUsername ([String!])
Filter requirements by author username.
iid (ID)
Deprecated in GitLab 15.8. Use work_item_iid instead.
iids ([ID!])
Deprecated in GitLab 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].
rootGroup Group Top-level group of the project.
runnerCloudProvisioning CiRunnerCloudProvisioning Introduced as an experiment in GitLab 16.9.

Information used for provisioning the runner on a cloud provider. Returns null if the GitLab instance is not a SaaS instance.

Arguments for runnerCloudProvisioning:
cloudProjectId (GoogleCloudProject!)
Identifier of the cloud project.
provider (CiRunnerCloudProvider!)
Identifier of the cloud provider.
runners CiRunnerConnection Find runners visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for runners:
active (Boolean)
Deprecated in GitLab 14.8. Renamed. Use paused instead.
creatorId (UserID)
Filter runners by creator ID.
creatorUsername (String)
Filter runners by creator username.
ownerFullPath (String)
Introduced as an experiment in GitLab 17.8.

Filter runners by owning project or group.
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)
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'.
sastCiConfiguration SastCiConfiguration SAST CI configuration for the project.
savedReplies ProjectSavedReplyConnection Saved replies available to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply ProjectSavedReply Saved reply in the project.

Arguments for savedReply:
id (ProjectsSavedReplyID!)
Global ID of a saved reply.
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanExecutionPolicies:
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.
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
scanProfileStatuses [ScanProfileProjectStatus!] Introduced as an experiment in GitLab 19.0.

Scan profile statuses for the project.
scanResultPolicies ScanResultPolicyConnection Deprecated in GitLab 16.9. Use approvalPolicies. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanResultPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
secretPushProtectionEnabled Boolean Indicates whether secret push protection is on or not for the project.
securityAttributes SecurityAttributeConnection Introduced as an experiment in GitLab 18.5.

Security attributes linked to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
securityConfigurationPath String Path to project's security configuration.
securityDashboardPath String Path to project's security dashboard.
securityExclusion ProjectSecurityExclusion Introduced as an experiment in GitLab 17.4.

A single security exclusion of a project.

Arguments for securityExclusion:
active (Boolean)
Filter entries by active status.
id (SecurityProjectSecurityExclusionID!)
ID of the project security exclusion.
scanner (ExclusionScannerEnum)
Filter entries by scanner.
type (ExclusionTypeEnum)
Filter entries by exclusion type.
securityExclusions ProjectSecurityExclusionConnection Introduced as an experiment in GitLab 17.4.

Security exclusions of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityExclusions:
active (Boolean)
Filter entries by active status.
scanner (ExclusionScannerEnum)
Filter entries by scanner.
type (ExclusionTypeEnum)
Filter entries by exclusion type.
securityMetrics SecurityMetrics Introduced as an experiment in GitLab 18.3.

Security metrics.This feature is currently under development and not yet available for general use.

Arguments for securityMetrics:
projectId ([ID!])
Filter by project IDs in a group or an organization. This argument is ignored when we are querying for a project.
reportType ([VulnerabilityReportType!])
Filter by report types.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 18.8.

Filter by security attributes. Up to 20 filters.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref IDs. This argument is ignored when querying for a group. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
securityPolicies SecurityPolicyTypeConnection Introduced as an experiment in GitLab 18.1.

All security policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicies:
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship.
type (PolicyType)
Filter policies by type.
securityPolicyEligibleProjects ProjectConnection Introduced as an experiment in GitLab 19.0.

All projects eligible for policy scope selection when this project is used as a Security Policy Project. Includes projects from root ancestors of all linked groups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicyEligibleProjects:
ids ([ProjectID!])
Filter eligible projects by global IDs (used to hydrate already-selected projects). A maximum of 100 IDs can be provided.
search (String)
Search query for project name or path.
securityPolicyPipelineMustSucceed Boolean Introduced as an experiment in GitLab 18.11.

Indicates that all security policy pipelines must succeed before merge requests can be merged.
securityPolicyProject Project Security policy project assigned to the project, absent if assigned to a parent group.
securityPolicyProjectLinkedGroups GroupConnection Groups linked to the project, when used as Security Policy Project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicyProjectLinkedGroups:
ids ([ID!])
Filter groups by IDs.
search (String)
Search query for groups.
topLevelOnly (Boolean)
Only include top-level groups.
securityPolicyProjectLinkedNamespaces NamespaceConnection Deprecated in GitLab 17.4. Renamed. Use security_policy_project_linked_groups instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
securityPolicyProjectLinkedProjects ProjectConnection Projects linked to the project, when used as Security Policy Project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
securityPolicyProjectSuggestions ProjectConnection Security policy project suggestions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicyProjectSuggestions:
onlyLinked (Boolean)
Whether to suggest only projects already linked as security policy projects.
search (String!)
Search query for projects' full paths.
securityScanProfiles [ScanProfileType!] Introduced as an experiment in GitLab 18.7.

Security scan profiles attached to the project.
securityScanners SecurityScanners Information about security analyzers used in the project.
securityTrackedRefs SecurityTrackedRefConnection Introduced as an experiment in GitLab 18.8.

Refs tracked for security vulnerabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityTrackedRefs:
state (SecurityTrackedRefState)
Filter by tracking state. Values: "TRACKED", "UNTRACKED". Returns all refs if not specified.
securityTrainingProviders [ProjectSecurityTraining!] List of security training providers for the project.

Arguments for securityTrainingProviders:
onlyEnabled (Boolean)
Filter the list by only enabled security trainings.
securityTrainingUrls [SecurityTrainingUrl!] Security training URLs for the enabled training providers of the project.

Arguments for securityTrainingUrls:
filename (String)
Filename to filter security training URLs by programming language.
identifierExternalIds ([String!]!)
List of external IDs of vulnerability identifiers.
sentryDetailedError SentryDetailedError Detailed version of a Sentry error on the project.

Arguments for sentryDetailedError:
id (GitlabErrorTrackingDetailedErrorID!)
ID of the Sentry issue.
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.
services ServiceConnection Project services. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for services:
active (Boolean)
Indicates if the integration is active.
type (ServiceType)
Type of integration.
sharedRunnersEnabled Boolean Indicates if shared runners are enabled for the project.
snippets SnippetConnection Snippets of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
snippetsEnabled Boolean Indicates if Snippets are enabled for the current user.
sourcedMergeRequests MergeRequestConnection Merge requests that have this project as their source, including merge requests targeting other projects. Ordered by ID in descending order. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for sourcedMergeRequests:
sourceBranches ([String!]!)
Array of source branch names (maximum is 100). 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 the state.
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 GitLab 13.12. Use topics.
targetBranchRules ProjectTargetBranchRuleConnection Target branch rules of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
terraformState TerraformState Find a single Terraform state by name.

Arguments for terraformState:
name (String!)
Name of the Terraform state.
terraformStateProtectionRules TerraformStateProtectionRuleConnection Introduced as an experiment in GitLab 18.11.

Terraform state protection rules for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
terraformStates TerraformStateConnection Terraform states associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
timelogCategories TimeTrackingTimelogCategoryConnection Introduced as an experiment in GitLab 15.3.

Timelog categories for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
timelogs TimelogConnection Time logged on issues and merge requests in the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
topics [String!] List of project topics.
trackingKey String Introduced as an experiment in GitLab 16.0.

Tracking key assigned to the project.
transferInProgress Boolean! Introduced as an experiment in GitLab 19.3.

Indicates if the project is currently being transferred.
triageAndRemediationCoverage TriageAndRemediationCoverage Introduced as an experiment in GitLab 19.5.

Triage and remediation capability coverage for the project.
unprotectedBranches StringConnection Introduced as an experiment in GitLab 19.4.

Paginated list of unprotected branches, ignoring any wildcard branch rules. Supports forward-only pagination with first and after. This field can only be resolved for one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for unprotectedBranches:
search (String)
Search query to filter branch names (case-insensitive).
updatedAt Time Timestamp of when the project was last updated.
userAccessAuthorizedAgents ClusterAgentAuthorizationUserAccessConnection Authorized cluster agents for the project through user_access keyword. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
userPermissions ProjectPermissions! Permissions for the current user on the resource.
valueStreamAnalytics ValueStreamAnalytics Information about Value Stream Analytics within the project.
valueStreamDashboardUsageOverview ValueStreamDashboardCount Introduced as an experiment in GitLab 17.2.

Aggregated usage counts within the project.

Arguments for valueStreamDashboardUsageOverview:
identifier (ValueStreamDashboardProjectLevelMetric!)
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).
valueStreams ValueStreamConnection Value streams available to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for valueStreams:
id (ID)
Value stream id.
visibility String Visibility of the project.
visibleForks ProjectConnection Introduced as an experiment in GitLab 15.10.

Visible forks of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for visibleForks:
minimumAccessLevel (AccessLevelEnum)
Minimum access level.
vulnerabilities VulnerabilityConnection Vulnerabilities reported on the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilities:
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities which have been auto dismissed by security policies. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
sort (VulnerabilitySort)
List vulnerabilities by sort order.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.10.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured and advanced vulnerability management set up.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.9.

Filter by tracked ref scope. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by validity check.
vulnerabilitiesCountByDay VulnerabilitiesCountByDayConnection The historical number of vulnerabilities per day for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilitiesCountByDay:
endDate (ISO8601Date!)
Last day for which to fetch vulnerability history.
startDate (ISO8601Date!)
First day for which to fetch vulnerability history.
vulnerabilityArchives [VulnerabilityArchive!] Introduced as an experiment in GitLab 17.9.

All vulnerability archives of the project.
vulnerabilityIdentifierSearch [String!] Search for vulnerabilities by identifier.

Arguments for vulnerabilityIdentifierSearch:
name (String!)
Search identifier by name. Substring or partial match search is supported and argument should be greater than 3 characters.
vulnerabilityImages VulnerabilityContainerImageConnection Container images reported on the project vulnerabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Introduced as an experiment in GitLab 17.5.

Vulnerability Management Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityManagementPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the project vulnerabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilitySeveritiesCount VulnerabilitySeveritiesCount Counts for each vulnerability severity in the project.

Arguments for vulnerabilitySeveritiesCount:
capped (Boolean)
Default value is false. When set to true, the count returned for each severity is capped at a maximum of 1001. Ignored when used along with any argument that requires advanced vulnerability management.
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Introduced as an experiment in GitLab 17.7.

Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Filter by policy auto dismissed. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by scanner.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref scope. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by token status.
vulnerabilityStatistic VulnerabilityStatisticType Counts for each vulnerability severity in the project.
vulnerabilityWorkflowExecution VulnerabilityWorkflowExecution Introduced as an experiment in GitLab 19.3.

Returns a vulnerability workflow execution.

Arguments for vulnerabilityWorkflowExecution:
executionId (String)
Execution identifier. When omitted, returns the latest execution.
workflow (VulnerabilityDuoWorkflow!)
Duo workflow associated with the execution.
webBasedCommitSigningEnabled Boolean! Introduced as an experiment in GitLab 18.9.

Indicates whether web-based commit signing is enabled for the project.
webPath String! Web path of the project.
webUrl String Web URL of the project.
webhook ProjectHook Introduced as an experiment in GitLab 18.5.

A single project webhook.

Arguments for webhook:
id (ProjectHookID!)
ID of the project webhook.
wikiEnabled Boolean Indicates if Wikis are enabled for the current user.
wikiPages WikiPageConnection Introduced as an experiment in GitLab 19.2.

Wiki pages of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
workItemStateCounts WorkItemStateCountsType Introduced as an experiment in GitLab 16.7.

Counts of work items by state for the project.

Arguments for workItemStateCounts:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemTypes WorkItemTypeConnection Work item types available to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemTypes:
name (IssueType)
Deprecated in GitLab 19.0. Name-based filtering is no longer supported with introduction of configurable work item types in 19.0.
onlyAvailable (Boolean)
Introduced as an experiment in GitLab 18.6.

When true, returns only the available work item types for the current user. This experimental field will be removed in 19.0. Use canUserCreateItems and isFilterableListView fields from the WorkItemTypes API instead.
workItems WorkItemConnection Introduced as an experiment in GitLab 15.1.

Work items of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItems:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.

ProjectCiCdSetting#

Fields#

Name Type Description
crossProjectPushForJobTokenAllowed Boolean Indicates the ability to push to this repository using a job token from an allowlisted project.
displayPipelineVariables Boolean Indicates whether pipeline variables can be displayed in the UI.
groupRunnersEnabled Boolean Indicates whether group runners are enabled for the project.
inboundJobTokenScopeEnabled Boolean Indicates whether CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabled Boolean Indicates whether CI/CD job tokens generated in this project have restricted access to other projects.
keepLatestArtifact Boolean Indicates whether the latest artifact should be kept for the project.
maxPipelinesPerMergeTrain Int Maximum number of parallel pipelines per merge train. When null, the plan limit applies.
mergePipelinesEnabled Boolean Indicates whether merged results pipelines are enabled.
mergeTrainEnforcement MergeTrainEnforcement! Merge train enforcement level for the project.
mergeTrainsEnabled Boolean Whether merge trains are enabled.
mergeTrainsSkipTrainAllowed Boolean! Whether merge immediately is allowed for merge trains.
pipelineVariablesMinimumOverrideRole String! Minimum role required to set variables when creating a pipeline or running a job.
project Project Project the CI/CD settings belong to.
pushRepositoryForJobTokenAllowed Boolean Indicates the ability to push to the original project repository using a job token.
resourceGroupDefaultProcessMode ResourceGroupsProcessMode Default process mode for resource groups.
skipBranchPipelinesForMrs Boolean Indicates whether branch pipelines are skipped if a merge request is open.

ProjectComplianceControlStatusType#

Compliance control status for a project.

Fields#

Name Type Description
complianceRequirementsControl ComplianceRequirementsControl! Control of the compliance status.
id ID! Compliance control status ID.
status ProjectComplianceControlStatus! Compliance status of the project for the control.
updatedAt Time! Timestamp when the control status was last updated.

ProjectComplianceControlStatusTypeConnection#

Paginated collection of ProjectComplianceControlStatusType. See Standard connection fields for the fields available on every connection.

ProjectComplianceRequirementStatus#

Compliance requirement status for a project.

Fields#

Name Type Description
complianceFramework ComplianceFramework! Framework of the compliance status.
complianceRequirement ComplianceRequirement! Requirement of the compliance status.
failCount Int! Total no. of failed compliance controls for the requirement.
id ID! Compliance requirement status ID.
passCount Int! Total no. of passed compliance controls for the requirement.
pendingCount Int! Total no. of pending compliance controls for the requirement.
project Project! Project of the compliance status.
updatedAt Time! Timestamp when the requirement status was last updated.

ProjectComplianceRequirementStatusConnection#

Paginated collection of ProjectComplianceRequirementStatus. See Standard connection fields for the fields available on every connection.

ProjectComplianceViolation#

Compliance violation for a project.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
auditEvent AuditEvent! Audit event related to the violation.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
complianceControl ComplianceRequirementsControl! Compliance control of the violation.
createdAt Time! Timestamp when the violation was detected.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Compliance violation ID.
issues IssueConnection Project issues linked to the violation. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
project Project! Project of the compliance violation.
status ComplianceViolationStatus! Compliance violation status of the project.
webUrl String URL of the object.

ProjectComplianceViolationConnection#

Paginated collection of ProjectComplianceViolation. See Standard connection fields for the fields available on every connection.

ProjectConnection#

Paginated collection of Project. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ProjectDataTransfer#

Fields#

Name Type Description
egressNodes EgressNodeConnection Data nodes. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

ProjectHook#

Fields#

Name Type Description
alertStatus WebhookAlertStatus! Auto-disabling status of the webhook.
branchFilterStrategy WebhookBranchFilterStrategy! Strategy for filtering push events by branch name.
confidentialIssuesEvents Boolean! Whether the webhook is triggered on confidential issues events.
confidentialNoteEvents Boolean! Whether the webhook is triggered on confidential note events.
createdAt Time! Timestamp of when the webhook was created.
customHeaders [WebhookCustomHeader!] List of custom header names for the webhook.
customWebhookTemplate String Custom payload template for the webhook request body.
deploymentEvents Boolean! Whether the webhook is triggered on deployment events.
description String Description of the webhook.
disabledUntil Time Timestamp when the webhook will be automatically re-enabled if temporarily disabled.
emojiEvents Boolean! Whether the webhook is triggered on emoji events.
enableSslVerification Boolean Whether SSL verification is done when triggering the webhook.
featureFlagEvents Boolean! Whether the webhook is triggered on feature flag events.
id ProjectHookID! ID of the webhook.
issuesEvents Boolean! Whether the webhook is triggered on issues events.
jobEvents Boolean! Whether the webhook is triggered on job events.
mergeRequestsEvents Boolean! Whether the webhook is triggered on merge request events.
milestoneEvents Boolean! Whether the webhook is triggered on milestone events.
name String Name of the webhook.
noteEvents Boolean! Whether the webhook is triggered on note events.
pipelineEvents Boolean! Whether the webhook is triggered on pipeline events.
pushEvents Boolean! Whether the webhook is triggered on push events.
pushEventsBranchFilter String Trigger hook on push events for matching branches only.
releasesEvents Boolean! Whether the webhook is triggered on releases events.
resourceAccessTokenEvents Boolean! Whether the webhook is triggered on resource access token events.
signingTokenPresent Boolean! Whether an HMAC signing token is configured for webhook-signature header generation.
tagPushEvents Boolean! Whether the webhook is triggered on tag push events.
tokenPresent Boolean! Whether a secret token is configured for X-Gitlab-Token header validation.
url String! URL of the webhook.
urlVariables [WebhookUrlVariable!] List of URL variable masks to hide sensitive portions of the webhook URL.
vulnerabilityEvents Boolean! Whether the webhook is triggered on vulnerability events.
webhookEvent WebhookEvent A single webhook event.

Arguments for webhookEvent:
id (WebHookLogID!)
ID of the webhook event.
timestampRange (TimestampRange)
Filter for webhook events within a range of timestamps. Defaults to events within the last seven days.
webhookEvents WebhookEventConnection List of recent webhook events. This field can only be resolved for one webhook in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for webhookEvents:
timestampRange (TimestampRange)
Filter for webhook events within a range of timestamps. Defaults to events within the last seven days.
wikiPageEvents Boolean! Whether the webhook is triggered on wiki page events.

ProjectImportExportRelationExportUploadUploadRegistry#

Represents the Geo replication and verification state of a relation export file upload project_import_export_relation_export_upload_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ProjectImportExportRelationExportUploadUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectImportExportRelationExportUploadUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectImportExportRelationExportUploadUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ProjectImportExportRelationExportUploadUploadRegistry.
lastSyncFailure String Error message during sync of the ProjectImportExportRelationExportUploadUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ProjectImportExportRelationExportUploadUploadRegistry.
missingOnPrimary Boolean Indicate if the ProjectImportExportRelationExportUploadUploadRegistry is missing on primary.
modelRecordId Int ID of the ProjectImportExportRelationExportUploadUploadRegistry's model record.
projectImportExportRelationExportUploadUploadId ID! ID of the Relation Export File Upload.
retryAt Time Timestamp after which the ProjectImportExportRelationExportUploadUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ProjectImportExportRelationExportUploadUploadRegistry.
state RegistryState Sync state of the ProjectImportExportRelationExportUploadUploadRegistry.
verificationChecksum String The local checksum of the ProjectImportExportRelationExportUploadUploadRegistry.
verificationChecksumMismatched String The expected checksum of the ProjectImportExportRelationExportUploadUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the ProjectImportExportRelationExportUploadUploadRegistry.
verificationRetryAt Time Timestamp after which the ProjectImportExportRelationExportUploadUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ProjectImportExportRelationExportUploadUploadRegistry.
verificationStartedAt Time Timestamp when the verification of ProjectImportExportRelationExportUploadUploadRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectImportExportRelationExportUploadUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectImportExportRelationExportUploadUploadRegistry.

ProjectImportExportRelationExportUploadUploadRegistryConnection#

Paginated collection of ProjectImportExportRelationExportUploadUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ProjectInterfaceConnection#

Paginated collection of ProjectInterface. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ProjectMember#

Represents a Project Membership.

Implements: MemberInterface

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.
mergeRequestInteraction UserMergeRequestInteraction Find a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
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.

ProjectMemberConnection#

Paginated collection of ProjectMember. See Standard connection fields for the fields available on every connection.

ProjectMinimalAccess#

Implements: ProjectInterface

Fields#

Name Type Description
avatarUrl String Avatar URL of the project.
description String Short description of the project.
fullPath ID! Full path of the project.
id ID! ID of the project.
name String! Name of the project without the namespace.
nameWithNamespace String! Name of the project including the namespace.
userPermissions ProjectPermissions! Permissions for the current user on the resource.
webUrl String Web URL of the project.

Implements: NamespacesLinkPaths

Fields#

Name Type Description
autocompleteAwardEmojisPath String Introduced as an experiment in GitLab 18.6.

Path for autocomplete award emojis.
calendarPath String Introduced as an experiment in GitLab 18.4.

Calendar path for work items.
contributionGuidePath String Namespace contribution guide path.
emailsHelpPagePath String Help page path for emails.
epicsList String Namespace epics_list.
epicsListPath String Introduced as an experiment in GitLab 18.6.

Path to the epics list for the namespace.
exportCsvPath String Introduced as an experiment in GitLab 18.6.

CSV export endpoint for work items.
groupIssues String Namespace group_issues.
groupPath String Introduced as an experiment in GitLab 18.6.

Full path of the group.
issuesList String Namespace issues_list.
issuesListPath String Introduced as an experiment in GitLab 18.6.

Path to the issues list for the namespace.
issuesSettings String Namespace issues settings path.
labelsFetch String Namespace labels_fetch.
labelsManage String Namespace labels_manage.
markdownHelpPath String Help page path for Markdown.
namespaceFullPath String Introduced as an experiment in GitLab 18.6.

Full path of the namespace (project.namespace.full_path or group full_path).
newCommentTemplate [CommentTemplatePath!] Namespace new_comment_template_paths.
newIssuePath String Introduced as an experiment in GitLab 18.6.

Path to create a new issue.
newProject String Namespace new_project.
newTrialPath String Introduced as an experiment in GitLab 18.6.

New trial path for the namespace.
newWorkItemEmailAddress String Email address that can be used to create a new work item in this project. Returns null if incoming email is not configured. More details on how to configure incoming email is in this documentation.
projectImportJiraPath String JIRA import path.
quickActionsHelpPath String Help page path for quick actions.
register String Namespace register_path.
releasesPath String Project releases path.
reportAbuse String Namespace report_abuse.
rssPath String Introduced as an experiment in GitLab 18.4.

RSS path for work items.
signIn String Namespace sign_in_path.
userExportEmail String Introduced as an experiment in GitLab 18.3.

User email for export CSV. Returns null for user namespaces.

ProjectNamespaceMarkdownPaths#

Implements: MarkdownPaths

Fields#

Name Type Description
autocompleteSourcesPath JSON Supported paths for autocomplete sources for a given namespace.

Arguments for autocompleteSourcesPath:
iid (String)
IID of the work item.
workItemTypeId (String)
ID of the work item type.
markdownPreviewPath String Path for the markdown preview for given namespace.

Arguments for markdownPreviewPath:
iid (String)
IID of the target item for markdown preview.
uploadsPath String Uploads path for a given namespace.

ProjectNamespaceMetadata#

Implements: NamespaceMetadata

Fields#

Name Type Description
defaultBranch String Introduced as an experiment in GitLab 18.6.

Default branch of the project.
groupId String Introduced as an experiment in GitLab 18.6.

ID of the group. Returns null for user namespaces.
initialSort String Introduced as an experiment in GitLab 18.6.

User preference for initial sort order.
isIssueRepositioningDisabled Boolean Introduced as an experiment in GitLab 18.6.

Whether issue repositioning is disabled for the namespace.
maxAttachmentSize String Introduced as an experiment in GitLab 18.6.

Maximum allowed attachment size (humanized).
showNewWorkItem Boolean Introduced as an experiment in GitLab 18.6.

Whether to show the new work item link.
timeTrackingLimitToHours Boolean Introduced as an experiment in GitLab 18.6.

Time tracking limit to hours setting.

ProjectPermissions#

Fields#

Name Type Description
adminAiCatalogItem Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform admin_ai_catalog_item on this resource.
adminAiCatalogItemConsumer Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform admin_ai_catalog_item_consumer on this resource.
adminAllResources Boolean! If true, the user is an instance administrator.
adminIssue Boolean! If true, the user can perform admin_issue on this resource.
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.
adminWorkItemLifecycle Boolean! If true, the user can perform admin_work_item_lifecycle on this resource.
archiveProject Boolean! If true, the user can perform archive_project on this resource.
canLeave Boolean! If true, the user can leave this project.
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.
createAiCatalogItemConsumer Boolean! Introduced as an experiment in GitLab 19.3.

If true, the user can enable an AI catalog item in this project by creating an item consumer.
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.
createPathLock Boolean! If true, the user can perform create_path_lock 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.
createWorkItem Boolean! If true, the user can perform create_work_item 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.
generateDescription Boolean! If true, the user can perform generate_description on this resource.
importIssues Boolean! If true, the user can perform import_issues on this resource.
manageAiFlowTriggers Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform manage_ai_flow_triggers on this resource.
moveDesign Boolean! If true, the user can perform move_design 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.
readAiCatalogItem Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform read_ai_catalog_item on this resource.
readAiCatalogItemConsumer Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform read_ai_catalog_item_consumer on this resource.
readCommitStatus Boolean! If true, the user can perform read_commit_status on this resource.
readCrmContact Boolean! If true, the user can perform read_crm_contact on this resource.
readCrmOrganization Boolean! If true, the user can perform read_crm_organization 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.
readDora4Analytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_dora4_analytics 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.
readPathLocks Boolean! If true, the user can perform read_path_locks on this resource.
readProAiAnalytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_pro_ai_analytics on this resource.
readProject Boolean! If true, the user can perform read_project on this resource.
readProjectComponentUsages Boolean! Introduced as an experiment in GitLab 19.0.

If true, the user can perform read_project_component_usages on this resource.
readProjectMember Boolean! If true, the user can perform read_project_member on this resource.
readRunnerCloudProvisioningInfo Boolean! Introduced as an experiment in GitLab 18.8.

If true, the user can perform read_runner_cloud_provisioning_info on this resource.
readSecurityResource Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_security_resource 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.
updateDesign Boolean! If true, the user can perform update_design 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.
viewEditPage Boolean! If true, the user can perform view_edit_page on this resource.

ProjectPlanLimits#

Plan limits for the current project.

Fields#

Name Type Description
ciPipelineSchedules Int Maximum number of pipeline schedules allowed per project.

ProjectRepositoryRegistry#

Represents the Geo replication and verification state of a project repository.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ProjectRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the ProjectRepositoryRegistry is missing on primary.
modelRecordId Int ID of the ProjectRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the ProjectRepositoryRegistry in case of mismatch.
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 of ProjectRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectRepositoryRegistry.

ProjectRepositoryRegistryConnection#

Paginated collection of ProjectRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ProjectSavedReply#

Fields#

Name Type Description
content String! Content of the saved reply.
id ProjectsSavedReplyID! Global ID of the project-level saved reply.
name String! Name of the saved reply.

ProjectSavedReplyConnection#

Paginated collection of ProjectSavedReply. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ProjectSecret#

Representation of a project secret.

Fields#

Name Type Description
branch String! Branches that can access the secret.
createdAt Time Timestamp when the secret creation started.
description String Description of the project secret.
environment String! Environments that can access the secret.
metadataVersion Int Current metadata version of the project secret.
name String! Name of the project secret.
project Project! Project the secret belongs to.
rotationInfo SecretRotationInfo Rotation configuration for the secret.
status SecretStatus! Computed lifecycle status of the secret, based on timestamps.

ProjectSecretConnection#

Paginated collection of ProjectSecret. See Standard connection fields for the fields available on every connection.

ProjectSecretsManager#

Representation of a project secrets manager.

Fields#

Name Type Description
project Project! Project the secrets manager belong to.
readOnly Boolean! Introduced as an experiment in GitLab 19.4.

Whether the instance is in strict read-only mode (Geo secondary or maintenance mode). No secrets or permissions can be created, updated, or deleted while it is true.
status ProjectSecretsManagerStatus Status of the project secrets manager.
userPermissions ProjectSecretsManagerPermissions! Permissions for the current user on the resource.
writeDenialReason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.5.

Reason the Secrets Manager entitlement does not allow secrets or their permissions to be created or updated. Null when it allows them.

ProjectSecretsManagerPermissions#

Permissions the current user has on a project secrets manager.

Fields#

Name Type Description
createSecrets Boolean! Indicates the user can create secrets in this project secrets manager.
deleteSecrets Boolean! Indicates the user can delete secrets in this project secrets manager.
readMetadata Boolean! Indicates the user can read secret metadata in this project secrets manager.
updateSecrets Boolean! Indicates the user can update secrets in this project secrets manager.

ProjectSecretsPermission#

Representation of a project secrets permission.

Fields#

Name Type Description
actions [SecretsManagementAction!]! Actions that can be performed on secrets.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
grantedBy UserCore User who created the Secret Permission.
principal Principal! Who is provided access to. For eg: User/Role/MemberRole.
project Project! Project the secrets permission belongs to.

ProjectSecretsPermissionConnection#

Paginated collection of ProjectSecretsPermission. See Standard connection fields for the fields available on every connection.

ProjectSecurityExclusion#

Represents a project-level security scanner exclusion.

Fields#

Name Type Description
active Boolean! Whether the exclusion is active.
createdAt Time! Timestamp of when the exclusion was created.
description String Optional description for the exclusion.
id SecurityProjectSecurityExclusionID! ID of the exclusion.
scanner ExclusionScannerEnum! Security scanner the exclusion will be used for.
type ExclusionTypeEnum! Type of the exclusion.
updatedAt Time! Timestamp of when the exclusion was updated.
value String! Value of the exclusion.

ProjectSecurityExclusionConnection#

Paginated collection of ProjectSecurityExclusion. See Standard connection fields for the fields available on every connection.

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.

ProjectSetting#

Fields#

Name Type Description
aiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events are stored for the project.
duoAutoModeEnabled Boolean Indicates whether Duo Agent Platform auto mode is enabled for the project.
duoContextExclusionSettings DuoContextExclusionSettings Settings for excluding files from Duo context.
duoFeaturesEnabled Boolean Indicates whether GitLab Duo features are enabled for the project.
project Project Project the settings belong to.
toolApprovalForSessionEnabled Boolean Indicates whether tool approval for Duo Workflow sessions is enabled for the project.
webBasedCommitSigningEnabled Boolean! Introduced as an experiment in GitLab 18.2.

Indicates whether web-based commit signing is enabled for the project.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.2.

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 as an experiment in GitLab 16.6.

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.

ProjectTargetBranchRule#

Fields#

Name Type Description
createdAt Time! Timestamp of when the target branch rule was created.
id ProjectsTargetBranchRuleID! ID of the target branch rule.
name String! Name of the target branch rule.
targetBranch String! Target branch for the target branch rule.

ProjectTargetBranchRuleConnection#

Paginated collection of ProjectTargetBranchRule. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ProjectTopicUploadRegistry#

Represents the Geo replication and verification state of a project_topic_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ProjectTopicUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectTopicUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectTopicUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ProjectTopicUploadRegistry.
lastSyncFailure String Error message during sync of the ProjectTopicUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ProjectTopicUploadRegistry.
missingOnPrimary Boolean Indicate if the ProjectTopicUploadRegistry is missing on primary.
modelRecordId Int ID of the ProjectTopicUploadRegistry's model record.
projectTopicUploadId ID! ID of the Project Topic Upload.
retryAt Time Timestamp after which the ProjectTopicUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ProjectTopicUploadRegistry.
state RegistryState Sync state of the ProjectTopicUploadRegistry.
verificationChecksum String The local checksum of the ProjectTopicUploadRegistry.
verificationChecksumMismatched String The expected checksum of the ProjectTopicUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the ProjectTopicUploadRegistry.
verificationRetryAt Time Timestamp after which the ProjectTopicUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ProjectTopicUploadRegistry.
verificationStartedAt Time Timestamp when the verification of ProjectTopicUploadRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectTopicUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectTopicUploadRegistry.

ProjectTopicUploadRegistryConnection#

Paginated collection of ProjectTopicUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ProjectUploadRegistry#

Represents the Geo replication and verification state of a project_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ProjectUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ProjectUploadRegistry.
lastSyncFailure String Error message during sync of the ProjectUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ProjectUploadRegistry.
missingOnPrimary Boolean Indicate if the ProjectUploadRegistry is missing on primary.
modelRecordId Int ID of the ProjectUploadRegistry's model record.
projectUploadId ID! ID of the Project Upload.
retryAt Time Timestamp after which the ProjectUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ProjectUploadRegistry.
state RegistryState Sync state of the ProjectUploadRegistry.
verificationChecksum String The local checksum of the ProjectUploadRegistry.
verificationChecksumMismatched String The expected checksum of the ProjectUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the ProjectUploadRegistry.
verificationRetryAt Time Timestamp after which the ProjectUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ProjectUploadRegistry.
verificationStartedAt Time Timestamp when the verification of ProjectUploadRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectUploadRegistry.

ProjectUploadRegistryConnection#

Paginated collection of ProjectUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ProjectValueStreamAnalyticsFlowMetrics#

Exposes aggregated value stream flow metrics.

Fields#

Name Type Description
cycleTime ValueStreamAnalyticsMetric Median time from first commit to issue closed.

Arguments for cycleTime:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
to (Time!)
Timestamp marking the end date and time.
weight (Int)
Weight applied to the issue.
deploymentCount ValueStreamAnalyticsMetric Number of production deployments in the given period.

Arguments for deploymentCount:
from (Time!)
Timestamp marking the start date and time.
to (Time!)
Timestamp marking the end date and time.
issueCount ValueStreamAnalyticsMetric Number of issues opened in the given period.

Arguments for issueCount:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
to (Time!)
Timestamp marking the end date and time.
weight (Int)
Weight applied to the issue.
issuesCompletedCount ValueStreamAnalyticsMetric Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Arguments for issuesCompletedCount:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
to (Time!)
Timestamp marking the end date and time.
weight (Int)
Weight applied to the issue.
leadTime ValueStreamAnalyticsMetric Median time from when the issue was created to when it was closed.

Arguments for leadTime:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
to (Time!)
Timestamp marking the end date and time.
weight (Int)
Weight applied to the issue.
timeToMerge ValueStreamAnalyticsMetric Median time from merge request creation to merge request merged.

Arguments for timeToMerge:
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
checksumMismatch Boolean Indicate if the checksums of the ProjectWikiRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectWikiRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectWikiRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the ProjectWikiRepositoryRegistry is missing on primary.
modelRecordId Int ID of the ProjectWikiRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the ProjectWikiRepositoryRegistry in case of mismatch.
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 of ProjectWikiRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectWikiRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectWikiRepositoryRegistry.

ProjectWikiRepositoryRegistryConnection#

Paginated collection of ProjectWikiRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
deployAccessLevels ProtectedEnvironmentDeployAccessLevelConnection Which group, user, or role is allowed to execute deployments to the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

ProtectedEnvironmentApprovalRuleConnection#

Paginated collection of ProtectedEnvironmentApprovalRule. See Standard connection fields for the fields available on every connection.

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.
canApprove Boolean Indicates whether a user is authorized to approve.
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.

ProtectedEnvironmentConnection#

Paginated collection of ProtectedEnvironment. See Standard connection fields for the fields available on every connection.

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.

ProtectedEnvironmentDeployAccessLevelConnection#

Paginated collection of ProtectedEnvironmentDeployAccessLevel. See Standard connection fields for the fields available on every connection.

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 the access level.
deployKey AccessLevelDeployKey Deploy key assigned to the access level.
group AccessLevelGroup Group associated with the access level.
memberRole MemberRole Custom role associated with the access level.
user AccessLevelUser User associated with the access level.

PushAccessLevelConnection#

Paginated collection of PushAccessLevel. See Standard connection fields for the fields available on every connection.

PushEventCommit#

Commit details associated with a push event.

Fields#

Name Type Description
count Int! Number of commits in the push.
from String SHA of the ref tip before the push. null when the ref was created.
title String Title of the most recent commit in the push.
to String SHA of the ref tip after the push. null when the ref was removed.

PushEventPayload#

Represents the payload of a push event.

Fields#

Name Type Description
action String! Action performed on the ref. One of created, removed, or pushed.
commit PushEventCommit! Commit details for the push.
ref PushEventRef! Ref (branch or tag) involved in the push.

PushEventRef#

Ref (branch or tag) involved in a push event.

Fields#

Name Type Description
count Int Number of refs pushed when more than one ref was pushed at once.
name String Name of the ref (branch or tag) that was pushed.
type String! Type of the ref. One of branch or tag.

PushRules#

Represents rules that commit pushes must follow.

Fields#

Name Type Description
authorEmailRegex String All commit author emails must match the regular expression.
branchNameRegex String All branch names must match the regular expression.
commitCommitterCheck Boolean! Only allow commits where the committer email matches a verified GitLab user email.
commitCommitterNameCheck Boolean! Only allow commits where the author name matches the GitLab user name.
commitMessageNegativeRegex String No commit message is allowed to match the regular expression.
commitMessageRegex String All commit messages must match the regular expression.
denyDeleteTag Boolean Deny deleting a tag with git push.
fileNameRegex String All committed filenames must not match the regular expression.
maxFileSize Int Maximum file size (MB).
memberCheck Boolean Restrict commits by author (email) to existing GitLab users.
preventSecrets Boolean GitLab rejects any files that are likely to contain secrets.
rejectNonDcoCommits Boolean! Reject commit when it is not DCO certified.
rejectUnsignedCommits Boolean! Reject commit when it is not signed through GPG.

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 50th percentile. 50% of the durations are lower than this value.
p75 Duration 75th percentile. 75% of the durations are lower than this value.
p90 Duration 90th percentile. 90% of the durations are lower than this value.
p95 Duration 95th percentile. 95% of the durations are lower than this value.
p99 Duration 99th percentile. 99% of the durations are lower than this value.
time Time! Start of the time interval.

QuickActionCommand#

A quick action available to the current user on a noteable.

Fields#

Name Type Description
aliases [String!]! Aliases that also invoke the command.
description String Description of what the command does.
icon String Name of the icon associated with the command.
name String! Primary name of the command, rendered as /name.
params [String!]! Parameter hints shown after the command.
warning String Warning about side effects of running the command.

QuickActionsStatus#

Fields#

Name Type Description
commandNames [String!] Quick action command names.
commandsOnly Boolean Returns true if only quick action commands were in the note.
errorMessages [String!] Error messages from quick actions that failed to apply.
messages [String!] Response messages from quick actions.

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.

RecentlyViewedItem#

Fields#

Name Type Description
item RecentlyViewedItemUnion! Recently viewed item.
viewedAt Time! When the item was last viewed.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
historicalRelease Boolean Indicates the release is a historical release.
id ReleaseID! Global ID of the release.
links ReleaseLinks Links of the release.
milestones MilestoneConnection Milestones associated to the release. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

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.

ReleaseAssetLinkConnection#

Paginated collection of ReleaseAssetLink. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
sources ReleaseSourceConnection Sources of the release. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

ReleaseConnection#

Paginated collection of Release. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

ReleaseEvidenceConnection#

Paginated collection of ReleaseEvidence. See Standard connection fields for the fields available on every connection.

Fields#

Name Type Description
closedIssuesUrl String HTTP URL of the issues page, filtered by the release and state=closed.
closedMergeRequestsUrl String HTTP URL of the merge request page, filtered by the 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 the release and state=merged.
openedIssuesUrl String HTTP URL of the issues page, filtered by the release and state=open.
openedMergeRequestsUrl String HTTP URL of the merge request page, filtered by the 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.

ReleaseSourceConnection#

Paginated collection of ReleaseSource. See Standard connection fields for the fields available on every connection.

Repository#

Fields#

Name Type Description
blobs RepositoryBlobConnection Blobs contained within the repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for blobs:
paths ([String!]!)
Array of desired blob paths. When requesting multiple blobs the total size is limited to 20 MiB.
ref (String)
Commit ref to get the blobs from. Default value is HEAD.
refType (RefType)
Type of ref.
branchCount Int! Number of branches in the repository.
branchNames [String!] Names of branches available in this repository that match the search pattern.

Arguments for branchNames:
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.
codeOwnersPath String Path to CODEOWNERS file in a ref.

Arguments for codeOwnersPath:
ref (String)
Name of the ref.
commit Commit Commit from the repository.

Arguments for commit:
ref (String!)
Commit reference (SHA, branch name, or tag name).
commitCount Int! Number of commits in the default branch of the repository.
commits CommitConnection Introduced as an experiment in GitLab 18.4.

List of commits from the repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for commits:
author (String)
Name or email of the author.
committedAfter (Time)
Commits created after an ISO8601 formatted time or date.
committedBefore (Time)
Commits created before an ISO8601 formatted time or date.
firstParent (Boolean)
Follow only the first parent of merge commits.
order (CommitOrder)
Order the commits are returned in. Defaults to reverse chronological.
path (String)
File path to filter commits by.
query (UntrustedRegexp)
Regular expression to filter the commits.
ref (String!)
Branch or tag to search for commits.
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.
lastCommit Commit The last commit made in the repository for the given path and ref.

Arguments for lastCommit:
path (String)
Path to get the last commit for. Default value is the root of the repository.
ref (String)
Commit ref to get the last commit for. Default value is HEAD.
refType (RefType)
Type of ref.
paginatedTree TreeConnection Paginated tree of the repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for paginatedTree:
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.
rootRef String Default branch of the repository.
tagCount Int! Number of tags in the repository.
tags TagConnection Introduced as an experiment in GitLab 19.5.

Tags in the repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for tags:
search (String)
Filter tags by name. Supports ^ for prefix, $ for suffix, and * as a wildcard.
sort (TagSort)
Sort tags by the criteria. Defaults to UPDATED_DESC.
tree Tree Tree of the repository.

Arguments for tree:
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.
validateCodeownerFile RepositoryCodeownerValidation Shows linting errors in the CODEOWNER file of the repository.

Arguments for validateCodeownerFile:
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.
base64EncodedBlob String Introduced as an experiment in GitLab 17.1.

Content of blob is encoded base64. Returns null if the unicode_escaped_data feature flag is disabled.
blame Blame Introduced as an experiment in GitLab 16.3.

Blob blame.

Arguments for blame:
fromLine (Int)
Range starting from the line. Cannot be less than 1 or greater than to_line.
ignoreRevs (Boolean)
Enable to ignore revisions in the .git-ignore-revs-file when fetching the blame.
toLine (Int)
Range ending on the line. Cannot be smaller than from_line or greater than or equal to from_line + the maximum line range cap (1000 when blame_line_range_cap_1000 is enabled, 100 otherwise).
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.
canModifyBlobWithWebIde Boolean! Whether the current user can modify the blob with Web IDE.
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 the blob using a forked project.
forkAndViewPath String Web path to view the blob using a forked project.
gitpodBlobUrl String URL to the blob within Ona.
historyPath String Web path to blob history page.
id ID! ID of the blob.
ideEditPath String Web path to edit the blob in the Web IDE.
ideForkAndEditPath String Web path to edit the 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.
showDuoWorkflowAction Boolean Indicator to show Duo Agent Platform action.
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.

RepositoryBlobConnection#

Paginated collection of RepositoryBlob. See Standard connection fields for the fields available on every connection.

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 String! Deprecated in GitLab 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.
testReports TestReportConnection Test reports of the requirement. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for testReports:
sort (Sort)
List test reports by sort order.
title String Title of the requirement.
titleHtml String HTML rendering of title.
updatedAt Time! Timestamp of when the requirement was last updated.
userPermissions RequirementPermissions! Permissions for the current user on the resource.
workItemIid String! Work item IID of the requirement, will replace current IID as identifier soon.

RequirementConnection#

Paginated collection of Requirement. See Standard connection fields for the fields available on every connection.

RequirementControlCoverage#

Compliance control coverage statistics across all requirements.

Fields#

Name Type Description
failed Int! Number of controls that failed compliance checks.
passed Int! Number of controls that passed compliance checks.
pending Int! Number of controls pending evaluation.

RequirementCoverage#

Coverage statistics requirements.

Fields#

Name Type Description
failed Int! Count of failed requirements.
passed Int! Count of passed requirements.
pending Int! Count of pending requirements.

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.

ResourceQuotas#

Resource quotas of a workspace.

Fields#

Name Type Description
cpu String! Number of cpu cores.
memory String! Bytes of memory.

RiskFactors#

Risk factors contributing to the total risk score.

Fields#

Name Type Description
vulnerabilitiesAverageScore VulnerabilityAverageScoreFactor Introduced as an experiment in GitLab 18.4.

Factor based on average vulnerability score.

RiskScore#

Total risk score information.

Fields#

Name Type Description
byProject RiskScoreByProjectConnection Introduced as an experiment in GitLab 18.4.

Risk scores grouped by project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
factors RiskFactors Introduced as an experiment in GitLab 18.4.

Risk factors contributing to the score.
projectCount Int Introduced as an experiment in GitLab 18.5.

Total number of projects with risk scores.
rating RiskRating! Introduced as an experiment in GitLab 18.4.

Overall risk rating.
score Float! Introduced as an experiment in GitLab 18.4.

Overall risk score.

RiskScoreByProject#

Risk score information for a specific project.

Fields#

Name Type Description
project Project Introduced as an experiment in GitLab 18.4.

Risk score belongs to the project.
rating RiskRating Introduced as an experiment in GitLab 18.4.

Risk rating for the project.
score Float Introduced as an experiment in GitLab 18.4.

Risk score for the project.

RiskScoreByProjectConnection#

Paginated collection of RiskScoreByProject. See Standard connection fields for the fields available on every connection.

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 as an experiment in GitLab 16.2.

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

RunnerArchitectureConnection#

Paginated collection of RunnerArchitecture. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
humanReadableName String! Human readable name of the runner platform.
name String! Name slug of the runner platform.

RunnerPlatformConnection#

Paginated collection of RunnerPlatform. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
global SastCiConfigurationEntityConnection List of global entities related to SAST configuration. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipeline SastCiConfigurationEntityConnection List of pipeline entities related to SAST configuration. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

SastCiConfigurationAnalyzersEntityConnection#

Paginated collection of SastCiConfigurationAnalyzersEntity. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
size SastUiComponentSize Size of the UI component.
type String Type of the field value.
value String Current value of the entity.

SastCiConfigurationEntityConnection#

Paginated collection of SastCiConfigurationEntity. See Standard connection fields for the fields available on every connection.

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.

SastCiConfigurationOptionsEntityConnection#

Paginated collection of SastCiConfigurationOptionsEntity. See Standard connection fields for the fields available on every connection.

SastConfiguration#

Configuration for a SAST scan profile.

Fields#

Name Type Description
advancedSastPartialScan SecurityScanProfileAdvancedSastPartialScan Introduced as an experiment in GitLab 19.4.

Controls GitLab Advanced SAST diff-based scanning.
analyzerImageTag String Introduced as an experiment in GitLab 19.4.

Tag of the analyzer image to use.
excludedAnalyzers [String!] Introduced as an experiment in GitLab 19.4.

Analyzers excluded from the scan.
excludedPaths [String!] Introduced as an experiment in GitLab 19.4.

Glob paths excluded from the scan.
gitlabAdvSastIncrScan Boolean Introduced as an experiment in GitLab 19.4.

Whether GitLab Advanced SAST incremental scanning is enabled.
imageSuffix SecurityScanProfileImageSuffix Introduced as an experiment in GitLab 19.4.

Suffix appended to the analyzer image name.
secureAnalyzersPrefix String Introduced as an experiment in GitLab 19.4.

Prefix for the container registry from which the analyzer image is pulled.

SastFalsePositiveConfiguration#

Configuration for the SAST false positive detection trigger of a triage and remediation scan profile.

Fields#

Name Type Description
cweClasses [String!] Introduced as an experiment in GitLab 19.4.

CWE identifiers false positive detection is restricted to.
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.4.

Whether false positive detection runs automatically or on demand.
severityLevel VulnerabilitySeverity Introduced as an experiment in GitLab 19.4.

Minimum vulnerability severity that triggers false positive detection.

SastVulnerabilityResolutionConfiguration#

Configuration for the SAST vulnerability resolution trigger of a triage and remediation scan profile.

Fields#

Name Type Description
cweClasses [String!] Introduced as an experiment in GitLab 19.4.

CWE identifiers resolution is restricted to.
falsePositiveConfidence SecurityScanProfileFalsePositiveConfidence Introduced as an experiment in GitLab 19.4.

False positive assessment a finding must carry to be resolved.
openMergeRequestsLimit Int Introduced as an experiment in GitLab 19.4.

Maximum number of open merge requests resolution may have at once. Null means no limit.
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.4.

Whether resolution runs automatically or on demand.
severityLevel VulnerabilitySeverity Introduced as an experiment in GitLab 19.4.

Minimum vulnerability severity that triggers a resolution attempt.

SavedReply#

Fields#

Name Type Description
content String! Content of the saved reply.
id UsersSavedReplyID! Global ID of the user saved reply.
name String! Name of the saved reply.

SavedReplyConnection#

Paginated collection of SavedReply. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

SavedViewPermissions#

Check permissions for the current user on a saved view.

Fields#

Name Type Description
deleteSavedView Boolean! If true, the user can perform delete_saved_view on this resource.
readSavedView Boolean! If true, the user can perform read_saved_view on this resource.
updateSavedView Boolean! If true, the user can perform update_saved_view on this resource.
updateSavedViewVisibility Boolean! If true, the user can perform update_saved_view_visibility on this resource.

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.

ScanConnection#

Paginated collection of Scan. See Standard connection fields for the fields available on every connection.

ScanExecutionPolicy#

Represents the scan execution policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
deprecatedProperties [String!] Introduced as an experiment in GitLab 17.3.

All deprecated properties in the policy.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.

ScanExecutionPolicyAttributesType#

Represents policy fields related to the scan execution policy.

Fields#

Name Type Description
deprecatedProperties [String!] Introduced as an experiment in GitLab 17.3.

All deprecated properties in the policy.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.

ScanExecutionPolicyConnection#

Paginated collection of ScanExecutionPolicy. See Standard connection fields for the fields available on every connection.

ScanProfileProjectStatus#

Status of a scan profile for a project.

Fields#

Name Type Description
buildId JobID ID of the last CI job that updated the status.
consecutiveFailureCount Int! Number of consecutive failed scans.
consecutiveSuccessCount Int! Number of consecutive successful scans.
lastScanAt Time Timestamp of the last profile-triggered scan.
scanProfile ScanProfileType! Scan profile associated with the status.
status ScanProfileStatus! Computed display status: NOT_CONFIGURED, PENDING, ACTIVE, WARNING, FAILED, or STALE.

ScanProfileTriggerSetting#

A scan profile trigger and its effective configuration.

Fields#

Name Type Description
configuration ScanProfileConfiguration Effective configuration for the trigger. Null for scan types without a typed configuration.
triggerType ScanProfileTriggerType! Type of the trigger.

ScanProfileType#

A scan profile.

Fields#

Name Type Description
configuration JSON! Introduced as an experiment in GitLab 19.2.

Configuration object of the scan profile.
createdAt ISO8601DateTime! Timestamp of when the scan profile was created.
description String! Description of the security scan profile.
gitlabRecommended Boolean! Indicates whether the scan profile is a default profile.
id SecurityScanProfileID Global ID of the security scan profile.
name String! Name of the security scan profile.
projectCount Int! Introduced as an experiment in GitLab 19.5.

Number of projects the scan profile is attached to, excluding archived projects.
scanType SecurityScanProfileType! Scan profile type.
triggerSettings [ScanProfileTriggerSetting!]! Introduced as an experiment in GitLab 19.3.

Trigger settings, including effective configuration, for the scan profile.
triggers [ScanProfileTriggerType!]! Introduced as an experiment in GitLab 18.10.

Trigger types for the scan profile.
updatedAt ISO8601DateTime! Timestamp of when the scan profile was last updated.

ScanResultPolicy#

Represents the scan result policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
actionApprovers [PolicyApproversType!] Multiple approvers action.
allGroupApprovers [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
deprecatedProperties [String!] Introduced as an experiment in GitLab 16.10.

All deprecated properties in the policy.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
enforcementType PolicyEnforcementType Enforcement type of the policy. Can be "enforce" or "warn".
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.

ScanResultPolicyConnection#

Paginated collection of ScanResultPolicy. See Standard connection fields for the fields available on every connection.

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.

ScannedResourceConnection#

Paginated collection of ScannedResource. See Standard connection fields for the fields available on every connection.

SearchBlobChunk#

JSON structure of a matched chunk.

Fields#

Name Type Description
lines [SearchBlobLine!] Introduced as an experiment in GitLab 17.2.

Path of the file.
matchCountInChunk Int Introduced as an experiment in GitLab 17.2.

Number of matches in the chunk.

SearchBlobFileType#

JSON structure of a file with matches.

Fields#

Name Type Description
blameUrl String Introduced as an experiment in GitLab 17.2.

Blame URL of the file.
chunks [SearchBlobChunk!] Introduced as an experiment in GitLab 17.2.

Maximum matches per file.
fileUrl String Introduced as an experiment in GitLab 17.2.

URL of the file.
language String Introduced as an experiment in GitLab 17.8.

Language of the file.
matchCount Int Introduced as an experiment in GitLab 17.2.

Matches per file up to a max of 50 chunks. Default is 3.
matchCountTotal Int Introduced as an experiment in GitLab 17.2.

Total number of matches per file.
path String Introduced as an experiment in GitLab 17.2.

Path of the file.
projectPath String Introduced as an experiment in GitLab 17.2.

Full path of the project.

SearchBlobLine#

JSON structure of each line in a matched chunk.

Fields#

Name Type Description
highlights [[Int!]!] Introduced as an experiment in GitLab 17.8.

Column numbers of the first and last highlighted characters on a line.
lineNumber Int Introduced as an experiment in GitLab 17.2.

Line number of the blob.
text String Introduced as an experiment in GitLab 17.2.

Text content of the blob.

SecondarySecurityFeature#

Secondary security feature information.

Fields#

Name Type Description
configurationText String! Display text for configuring the secondary feature.
description String! Description of what the secondary feature does.
name String! Name of the secondary feature.
type String! Type identifier for the secondary feature.

SecretDetectionConfiguration#

Configuration for a secret detection scan profile.

Fields#

Name Type Description
excludedPaths [String!] Glob paths excluded from the scan.
historicScan Boolean Indicates whether to scan the full Git history instead of only the current state.
imageSuffix SecurityScanProfileImageSuffix Suffix appended to the analyzer image name.
logOptions String Options passed to git log to control the commit range scanned.
rulesetGitReference String Git reference of the remote ruleset configuration to use.
secureAnalyzersPrefix String Prefix for the container registry from which the analyzer image is pulled.

SecretDetectionFalsePositiveConfiguration#

Configuration for the secret detection false positive detection trigger of a triage and remediation scan profile.

Fields#

Name Type Description
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.4.

Whether false positive detection runs automatically or on demand.
severityLevel VulnerabilitySeverity Introduced as an experiment in GitLab 19.4.

Minimum vulnerability severity that triggers false positive detection.

SecretPermission#

Representation of a secret permission.

Fields#

Name Type Description
actions [SecretsManagementAction!]! Actions that can be performed on secrets.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
grantedBy UserCore User who created the Secret Permission.
permissions String! Permissions to be provided. ['create', 'update', 'read', 'delete'].
principal Principal! Who is provided access to. For eg: User/Role/MemberRole.
project Project! Project the secret permission belong to.

SecretPermissionConnection#

Paginated collection of SecretPermission. See Standard connection fields for the fields available on every connection.

SecretRotationInfo#

Rotation configuration and status for a secret.

Fields#

Name Type Description
createdAt Time! When the rotation configuration was created.
lastReminderAt Time When the last rotation reminder was sent.
nextReminderAt Time! When the next rotation reminder will be sent.
rotationIntervalDays Int! Number of days between rotation reminders.
status SecretRotationStatus! Current rotation status.
updatedAt Time! When the rotation configuration was last updated.

SecretsManagerEnrollment#

Representation of a Secrets Manager namespace enrollment.

Fields#

Name Type Description
beta Boolean! Introduced as an experiment in GitLab 19.3.

Indicates the enrollment is part of the free beta cohort.
namespace Namespace! Namespace the enrollment belongs to.

SecretsManagerEntitlement#

Secrets Manager entitlement for a top-level group, or for the instance on GitLab Self-Managed.

Fields#

Name Type Description
betaProgramEnded Boolean Introduced as an experiment in GitLab 19.4.

Indicates whether the free-beta program has ended for the namespace. Set only when state is TRIAL_ELIGIBLE; null otherwise.
betaWindowEligible Boolean Introduced as an experiment in GitLab 19.4.

Indicates whether the namespace joined Secrets Manager during the free beta and keeps beta access until the beta program ends. True only when state is TRIAL_ELIGIBLE or INELIGIBLE; false or null otherwise.
blockedReason SecretsManagerEntitlementBlockedReason Introduced as an experiment in GitLab 19.2.

Reason the entitlement is blocked; null when state is not BLOCKED.
creditsRemaining Float Introduced as an experiment in GitLab 19.2.

Number of trial credits remaining.
creditsTotal Float Introduced as an experiment in GitLab 19.2.

Initial trial credit allocation for the current trial period.
gracePeriodEndDate Date Last day of the read-only grace period, inclusive. Set only when blockedReason is GRACE; null otherwise.
offlineFlexLicense Boolean Introduced as an experiment in GitLab 19.5.

Indicates whether the offline license is a GitLab Flex license, whose usage consumes GitLab Credits. Null unless state is OFFLINE_PAID.
offlineLicense Boolean Introduced as an experiment in GitLab 19.4.

Indicates whether the instance license is not an online cloud license, so no Secrets Manager trial can be started. Null on GitLab.com.
onDemandEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether on-demand purchasing is enabled for the namespace.
state SecretsManagerEntitlementState! Introduced as an experiment in GitLab 19.2.

Resolved entitlement state.
trialExpiresAt Time Introduced as an experiment in GitLab 19.2.

Timestamp when the Secrets Manager trial expires.
trialStartedAt Time Introduced as an experiment in GitLab 19.2.

Timestamp when the Secrets Manager trial started.

SecretsManagerInstanceEnrollment#

Representation of a Secrets Manager instance enrollment.

Fields#

Name Type Description
beta Boolean! Introduced as an experiment in GitLab 19.3.

Indicates the instance enrollment is part of the free beta cohort.
enrolled Boolean! Introduced as an experiment in GitLab 19.3.

Indicates Secrets Manager is enrolled at the instance level.

SecurityAttribute#

A security attribute.

Fields#

Name Type Description
color Color! Color of the security attribute.
description String Description of the security attribute.
editableState SecurityCategoryEditableState! Editable state of the security attribute.
id SecurityAttributeID! Global ID of the security attribute.
name String! Name of the security attribute.
securityCategory SecurityCategory! Security category the attribute belongs to.

SecurityAttributeConnection#

Paginated collection of SecurityAttribute. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

SecurityCategory#

A security category.

Fields#

Name Type Description
description String Description of the security category.
editableState SecurityCategoryEditableState! Editable state of the security category.
id SecurityCategoryID! Global ID of the security category.
multipleSelection Boolean! Whether multiple attributes can be selected.
name String! Name of the security category.
securityAttributes [SecurityAttribute!] Security attributes belonging to the category.
templateType SecurityCategoryTemplateType Template type for predefined categories.

SecurityConfiguration#

Security configuration data for a project.

Fields#

Name Type Description
autoDevopsEnabled Boolean Whether Auto DevOps is enabled for the project.
autoDevopsHelpPagePath String Path to Auto DevOps help documentation.
autoDevopsPath String Path to Auto DevOps settings.
canApplyProfiles Boolean! Whether the current user can apply security profiles.
canEnableAutoDevops Boolean! Whether the current user can enable Auto DevOps.
canEnableSpp Boolean Deprecated in GitLab 18.11. Automatic enablement of Secret Push Protection for public GitLab.com projects has been discontinued.
canManageAttributes Boolean! Whether the current user can manage security attributes.
canReadAttributes Boolean! Whether the current user can read security attributes.
containerScanningForRegistryEnabled Boolean Whether container scanning for registry is enabled.
features [SecurityScanFeature!]! List of security scan features and their configuration status.
gitlabCiHistoryPath String Path to the GitLab CI configuration file history.
gitlabCiPresent Boolean! Whether a GitLab CI configuration file exists in the project.
groupFullPath String Full path of the root ancestor group.
groupManageAttributesPath String Path to manage group security attributes.
helpPagePath String Path to application security help documentation.
isGitlabCom Boolean Deprecated in GitLab 18.11. Automatic enablement of Secret Push Protection for public GitLab.com projects has been discontinued.
latestPipelinePath String Path to the latest pipeline on the default branch.
licenseConfigurationSource String Source of license configuration.
licenseScanningForCyclonedxEnabled Boolean Whether license scanning for CycloneDX SBOM files is enabled.
maxTrackedRefs Int Maximum number of refs that can be tracked for security scanning.
secretDetectionConfigurationPath String Path to secret detection configuration.
secretPushProtectionAvailable Boolean! Whether secret push protection is available for projects in the instance.
secretPushProtectionEnabled Boolean Whether secret push protection is enabled for the project.
secretPushProtectionEnforced Boolean Whether secret push protection is automatically enforced for all projects in the instance.
secretPushProtectionLicensed Boolean Deprecated in GitLab 18.11. Automatic enablement of Secret Push Protection for public GitLab.com projects has been discontinued.
securityScanProfilesLicensed Boolean! Whether the project has a license for security scan profiles.
securityTrainingEnabled Boolean! Whether security training is available for the project.
upgradePath String Path to upgrade security features.
userIsProjectAdmin Boolean! Whether the current user has admin permissions for security testing.
validityChecksAvailable Boolean Whether secret detection validity checks are available.
validityChecksEnabled Boolean Whether secret detection validity checks are enabled.
vulnerabilityArchiveExportPath String Path to export vulnerability archives via API.
vulnerabilityTrainingDocsPath String Path to vulnerability training documentation.

SecurityFeature#

Security feature information for a scan type.

Fields#

Name Type Description
anchor String Anchor link for the security feature.
configurationHelpPath String Path to configuration help documentation.
description String! Description of what the security feature does.
helpPath String! Path to help documentation for the security feature.
name String! Full name of the security feature.
secondary SecondarySecurityFeature Secondary feature information.
shortName String Short name of the security feature.
type String! Type identifier for the security feature.

SecurityFindingTokenStatus#

Represents the status of a secret token found in a security finding.

Fields#

Name Type Description
createdAt Time! When the token status was created.
id ID! ID of the finding token status.
lastVerifiedAt Time When the token was last verified with the issuing service.
status VulnerabilityFindingTokenStatusState! Status of the token (unknown, active, inactive).
updatedAt Time! When the token status was last updated.

SecurityMetrics#

Represents security metrics.

Fields#

Name Type Description
mttrOverTime [MttrOverTimeBucket!] Introduced as an experiment in GitLab 19.5.

Weekly mean time to remediation (MTTR) of vulnerabilities. Each week only counts vulnerabilities detected no earlier than 90 days before the week starts, so a week's MTTR is at most about 97 days. Returns null unless the security_dashboard_mttr_chart feature flag is enabled. This feature is currently under development and not yet available for general use.

Arguments for mttrOverTime:
endDate (ISO8601Date!)
End date of the time range. Snapped forward to the end of its week (Sunday), capped at the current date. The most recent week may be partial. The range can span at most 12 weeks.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
startDate (ISO8601Date!)
Start date of the time range. Snapped back to the start of its week (Monday) so results align to full Monday to Sunday buckets.
riskScore RiskScore Introduced as an experiment in GitLab 18.4.

Total risk score information. This feature is currently under development and not yet available for general use.
vulnerabilitiesByAge [VulnerabilitiesByAge!] Introduced as an experiment in GitLab 18.9.

Vulnerability age statistics based on predefined age bands. See VulnerabilitiesByAge for details. This feature is currently under development and not yet available for general use.

Arguments for vulnerabilitiesByAge:
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
vulnerabilitiesByIdentifier [VulnerabilitiesByIdentifier!] Introduced as an experiment in GitLab 18.10.

Vulnerability identifier statistics with filtering. This feature is currently under development and not yet available for general use.

Arguments for vulnerabilitiesByIdentifier:
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
vulnerabilitiesOverTime VulnerabilitiesOverTimeConnection Vulnerability metrics over time with filtering and grouping capabilities. This feature is currently under development and not yet available for general use. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilitiesOverTime:
endDate (ISO8601Date!)
End date for the vulnerability metrics time range. The end date should be within 31 days from the start date.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
startDate (ISO8601Date!)
Start date for the vulnerability metrics time range.
vulnerabilitiesPerSeverity VulnerabilitiesPerSeverity Count of open vulnerabilities per severity level. This feature is currently under development and not yet available for general use.

Arguments for vulnerabilitiesPerSeverity:
endDate (ISO8601Date)
Introduced as an experiment in GitLab 18.3.

End date for the vulnerability metrics time range. Optional.
startDate (ISO8601Date)
Introduced as an experiment in GitLab 18.3.

Start date for the vulnerability metrics time range. Optional.
vulnerabilityResolutionFunnel VulnerabilityResolutionFunnel Introduced as an experiment in GitLab 19.2.

Adoption funnel for AI-assisted vulnerability resolution. This feature is currently under development and not yet available for general use.

Arguments for vulnerabilityResolutionFunnel:
endDate (ISO8601Date!)
End date of the detection window (inclusive).
startDate (ISO8601Date!)
Start date of the detection window (inclusive).

SecurityPolicy#

Represents a security policy.

Fields#

Name Type Description
id ID! ID of the security policy.
name String! Name of the security policy.

SecurityPolicyType#

Represents the security policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
linkedProjectsCount Int Introduced as an experiment in GitLab 19.1.

Number of projects linked to this policy. Does not account for policy_scope filtering.
name String! Name of the policy.
policyAttributes PolicyAttributesUnion! Attributes specific to the policy type.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope of the policy.
testRuns PolicyScheduleTestRunConnection Introduced as an experiment in GitLab 18.10.

Test runs for this security policy. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type String Description of the policy type.
updatedAt Time! Timestamp of when the policy YAML was last updated.
yaml String! YAML definition of the policy.

SecurityPolicyTypeConnection#

Paginated collection of SecurityPolicyType. See Standard connection fields for the fields available on every connection.

SecurityPolicyValidationError#

Security policy validation error.

Fields#

Name Type Description
field String! Error field.
index Int Index of the errored action.
level String! Error level.
message String! Error message.
title String Error title.

SecurityPostureCounters#

Aggregated security posture counters for a namespace.

Fields#

Name Type Description
total Int! Introduced as an experiment in GitLab 19.5.

Total number of unarchived projects in the namespace.
withFailures Int! Introduced as an experiment in GitLab 19.0.

Number of unarchived projects with at least one failed scan.
withScanners Int! Introduced as an experiment in GitLab 19.0.

Number of unarchived projects with at least one security scanner configured.
withStale Int! Introduced as an experiment in GitLab 19.0.

Number of unarchived projects with at least one stale scan.
withTriageCoverage Int Introduced as an experiment in GitLab 19.5.

Count of unarchived projects in the group with at least one triage and remediation trigger enabled.

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.
containerScanningForRegistry SecurityReportSummarySection Aggregated counts for the container_scanning_for_registry 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.
sarif SecurityReportSummarySection Aggregated counts for the sarif 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilitiesCount Int Total number of vulnerabilities.

SecurityScanFeature#

Security scan feature configuration.

Fields#

Name Type Description
available Boolean! Whether the security scan is available for the project.
canEnableByMergeRequest Boolean! Whether the security scan can be enabled via merge request.
canUserConfigure Boolean! Whether the current user can configure the security scan.
configurationPath String Path to configure the security scan.
configured Boolean! Whether the security scan is configured for the project.
metaInfoPath String Path to additional information about the security scan.
onDemandAvailable Boolean! Whether on-demand scanning is available for the scan type.
securityFeatures SecurityFeature Additional security features specific to the scan type.
type String! Type of security scan (e.g., sast, dast, secret_detection).

SecurityScanProfileVariable#

A configuration variable that a scan profile of a given type can set.

Fields#

Name Type Description
envVar String CI/CD variable the configuration field is passed to the scan as.
key String! Name of the configuration field, as used in the scan profile configuration input.

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.

SecurityTrackedRef#

Represents a ref (branch or tag) tracked for security vulnerabilities.

Fields#

Name Type Description
commit Commit Latest commit on the ref.
id ID! Global ID of the tracked ref.
isDefault Boolean! Whether the ref is the default branch.
isProtected Boolean! Whether the ref is protected.
name String! Name of the ref (branch or tag name).
refType SecurityTrackedRefType! Type of the ref being tracked.
state SecurityTrackedRefState! Current tracking state of the ref.
trackedAt Time! When tracking was enabled for the ref.
vulnerabilitiesCount Int! Count of open vulnerabilities on the ref.

SecurityTrackedRefConnection#

Paginated collection of SecurityTrackedRef. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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
detailedError SentryDetailedError Detailed version of a Sentry error on the project.

Arguments for detailedError:
id (GitlabErrorTrackingDetailedErrorID!)
ID of the Sentry issue.
errorStackTrace SentryErrorStackTrace Stack Trace of Sentry Error.

Arguments for errorStackTrace:
id (GitlabErrorTrackingDetailedErrorID!)
ID of the Sentry issue.
errors SentryErrorConnection Collection of Sentry Errors. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for errors:
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.
externalUrl String External URL for Sentry.

SentryErrorConnection#

Paginated collection of SentryError. See Standard connection fields for the fields available on every connection.

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.

ServiceConnection#

Paginated collection of Service. See Standard connection fields for the fields available on every connection.

SeverityOverride#

Represents a vulnerability severity override.

Fields#

Name Type Description
author UserCore! User who changed the severity.
createdAt Time Time of severity change.
newSeverity VulnerabilitySeverity! New severity of the vulnerability.
originalSeverity VulnerabilitySeverity! Original severity of the vulnerability.

SeverityOverrideConnection#

Paginated collection of SeverityOverride. See Standard connection fields for the fields available on every connection.

SlashCommand#

Duo Chat slash command.

Fields#

Name Type Description
description String! Description of what the slash command does.
name String! Name of the slash command.
shouldSubmit Boolean! Indicates whether the command should be submitted automatically when clicked.

Snippet#

Represents a snippet entry.

Implements: NoteableInterface

Fields#

Name Type Description
author UserCore Owner of the snippet.
blobs SnippetBlobConnection Snippet blobs. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for blobs:
paths ([String!])
Paths of the blobs.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp the snippet was created.
description String Description of the snippet.
descriptionHtml String GitLab Flavored Markdown rendering of description.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
imported Boolean! Indicates whether the snippet was imported.
importedFrom ImportSource! Import source of the snippet.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
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.
titleHtml String HTML rendering of title.
updatedAt Time! Timestamp the 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.

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.

SnippetBlobConnection#

Paginated collection of SnippetBlob. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
hasUnretrievableBlobs Boolean! Indicates if the snippet has unretrievable blobs.

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.

SnippetConnection#

Paginated collection of Snippet. See Standard connection fields for the fields available on every connection.

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
checksumMismatch Boolean Indicate if the checksums of the SnippetRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the SnippetRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this SnippetRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the SnippetRepositoryRegistry is missing on primary.
modelRecordId Int ID of the SnippetRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the SnippetRepositoryRegistry in case of mismatch.
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 of SnippetRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the SnippetRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the SnippetRepositoryRegistry.

SnippetRepositoryRegistryConnection#

Paginated collection of SnippetRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

SpdxLicense#

SPDX license entry from the SPDX licence catalogue.

Fields#

Name Type Description
name String! Full name of the license.
spdxIdentifier String! SPDX identifier of the license.
url String URL to the SPDX license page.

SquashOption#

Squash option overrides for a protected branch.

Fields#

Name Type Description
helpText String! Help text for the squash option.
option String! Human-readable description of the squash option.

SshSignature#

SSH signature for a signed commit.

Implements: CommitSignature

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.

StandardRole#

Represents a standard role.

Implements: RoleInterface

Fields#

Name Type Description
accessLevel Int! Access level as a number.
description String Role description.
detailsPath String Introduced as an experiment in GitLab 17.4.

URL path to the role details webpage.
id ID! Role ID.
name String Role name.

StandardRoleConnection#

Paginated collection of StandardRole. See Standard connection fields for the fields available on every connection.

StandardsAdherenceChecksStatus#

Progress of standards adherence checks.

Fields#

Name Type Description
checksCompleted Int! Number of adherence checks successfully completed.
startedAt Time! UTC timestamp when the adherence checks scan was started.
totalChecks Int! Number of adherence checks multiplied by the number of projects in the group.

StatusAction#

Fields#

Name Type Description
buttonTitle String Title for the button, for example: Retry the job.
confirmationMessage String Introduced as an experiment in GitLab 17.0.

Custom confirmation message for a manual 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.

StringConnection#

Paginated collection of String. See Standard connection fields for the fields available on every connection.

StringExpression#

an expression with a string value.

Implements: ExpressionInterface

Fields#

Name Type Description
field String! Field the expression applies to.
operator String! Operator of the expression.
value String! String value of the expression.

Submodule#

Implements: Entry

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! SHA of the entry.
treeUrl String Tree URL for the sub-module.
type EntryType! Type of tree entry.
webUrl String Web URL for the sub-module.

SubmoduleConnection#

Paginated collection of Submodule. See Standard connection fields for the fields available on every connection.

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.

SubscriptionFutureEntryConnection#

Paginated collection of SubscriptionFutureEntry. See Standard connection fields for the fields available on every connection.

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.

Suggestion#

Fields#

Name Type Description
applied Boolean! Indicates whether the suggestion has been applied.
fromContent String! Original content being replaced by the suggestion.
fromLine Int! First line number of the change being suggested.
id SuggestionID! ID of the suggestion.
toContent String! Content suggested as the replacement.
toLine Int! Last line number of the change being suggested.

SuggestionConnection#

Paginated collection of Suggestion. See Standard connection fields for the fields available on every connection.

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.

Tag#

Fields#

Name Type Description
commit Commit Commit for the tag.
message String Tagging message.
name String! Name of the tag.

TagConnection#

Paginated collection of Tag. See Standard connection fields for the fields available on every connection.

TargetedMessage#

Represents a targeted message.

Fields#

Name Type Description
id ID! ID of the targeted message.
roles [Int!]! Roles targeted by the message. Empty array means all roles.
targetType String! Type of the targeted message (e.g., banner_page_level).

TaskCompletionStatus#

Completion status of tasks.

Fields#

Name Type Description
completedCount Int! Number of completed tasks.
count Int! Number of total tasks.

TerraformModuleMetadata#

Terraform module metadata.

Fields#

Name Type Description
createdAt Time! Timestamp of when the metadata was created.
fields TerraformModuleMetadataFields! Fields of the metadata.
id PackagesTerraformModuleMetadatumID! ID of the metadata.
updatedAt Time! Timestamp of when the metadata was last updated.

TerraformModuleMetadataDependencies#

Terraform module metadata dependencies.

Fields#

Name Type Description
modules [TerraformModuleMetadataDependency!] Modules of the module.
providers [TerraformModuleMetadataDependency!] Providers of the module.

TerraformModuleMetadataDependency#

Terraform module metadata dependency.

Fields#

Name Type Description
name String! Name of the dependency.
source String Source of the dependency.
version String Version of the dependency.

TerraformModuleMetadataExample#

Terraform module metadata example.

Implements: TerraformModuleMetadataSharedFields

Fields#

Name Type Description
inputs [TerraformModuleMetadataInput!] Inputs of the module.
name String! Name of the example.
outputs [TerraformModuleMetadataOutput!] Outputs of the module.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.

TerraformModuleMetadataFields#

Terraform module metadata fields type.

Fields#

Name Type Description
examples [TerraformModuleMetadataExample!] Examples of the module.
root TerraformModuleMetadataRoot! Root module.
submodules [TerraformModuleMetadataSubmodule!] Submodules of the module.

TerraformModuleMetadataInput#

Terraform module metadata input type.

Fields#

Name Type Description
default String Default value of the input.
description String Description of the input.
name String! Name of the input.
type String! Type of the input.

TerraformModuleMetadataOutput#

Terraform module metadata output.

Fields#

Name Type Description
description String Description of the output field.
name String! Name of the output field.

TerraformModuleMetadataRoot#

Metadata for Terraform root module.

Implements: TerraformModuleMetadataSharedFields

Fields#

Name Type Description
dependencies TerraformModuleMetadataDependencies Dependencies of the module.
inputs [TerraformModuleMetadataInput!] Inputs of the module.
outputs [TerraformModuleMetadataOutput!] Outputs of the module.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.
resources [String!] Resources of the module.

TerraformModuleMetadataSubmodule#

Terraform module metadata submodule.

Implements: TerraformModuleMetadataSharedFields

Fields#

Name Type Description
dependencies TerraformModuleMetadataDependencies Dependencies of the submodule.
inputs [TerraformModuleMetadataInput!] Inputs of the module.
name String! Name of the submodule.
outputs [TerraformModuleMetadataOutput!] Outputs of the module.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.
resources [String!] Resources of the submodule.

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.
permanentDeletionAt Time Introduced as an experiment in GitLab 19.5.

Timestamp of when the state will be permanently deleted, if it is scheduled for deletion.
protectionRuleExists Boolean! Introduced as an experiment in GitLab 19.0.

Whether a protection rule exists for the Terraform state.
updatedAt Time! Timestamp the Terraform state was updated.
versions TerraformStateVersionConnection Versions of the Terraform state, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

TerraformStateConnection#

Paginated collection of TerraformState. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

TerraformStateProtectionRule#

A protection rule for Terraform state backends, controlling who can write to a state based on project role and request source.

Fields#

Name Type Description
allowedFrom TerraformStateProtectionRuleAllowedFrom! Introduced as an experiment in GitLab 18.11.

Restriction on the source of write requests. ANYWHERE allows all sources, CI_ONLY requires a CI job token, CI_ON_PROTECTED_BRANCH_ONLY requires a CI job on a protected branch.
id TerraformStateProtectionRuleID! Introduced as an experiment in GitLab 18.11.

Global ID of the Terraform state protection rule.
minimumAccessLevelForWrite TerraformStateProtectionRuleAccessLevel! Introduced as an experiment in GitLab 18.11.

Minimum GitLab access level required to perform write operations on the Terraform state. Valid values include DEVELOPER, MAINTAINER, OWNER, or ADMIN.
stateName String! Introduced as an experiment in GitLab 18.11.

Terraform state name protected by the rule.

TerraformStateProtectionRuleConnection#

Paginated collection of TerraformStateProtectionRule. See Standard connection fields for the fields available on every connection.

TerraformStateVersion#

Fields#

Name Type Description
createdAt Time! Timestamp the version was created.
createdByUser UserCore User that created the version.
downloadPath String URL for downloading the version's JSON file.
id ID! ID of the Terraform state version.
job CiJob Job that created the version.
serial Int Serial number of the version.
updatedAt Time! Timestamp the version was updated.

TerraformStateVersionConnection#

Paginated collection of TerraformStateVersion. See Standard connection fields for the fields available on every connection.

TerraformStateVersionRegistry#

Represents the Geo sync and verification state of a terraform state version.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the TerraformStateVersionRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the TerraformStateVersionRegistry was created.
dataManagementDetailsPath String Path to the data management view for this TerraformStateVersionRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the TerraformStateVersionRegistry is missing on primary.
modelRecordId Int ID of the TerraformStateVersionRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the TerraformStateVersionRegistry in case of mismatch.
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 of TerraformStateVersionRegistry started.
verificationState VerificationStateEnum Verification state of the TerraformStateVersionRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the TerraformStateVersionRegistry.

TerraformStateVersionRegistryConnection#

Paginated collection of TerraformStateVersionRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

TestCaseConnection#

Paginated collection of TestCase. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

TestReportConnection#

Paginated collection of TestReport. See Standard connection fields for the fields available on every connection.

TestReportSummary#

Test report for a pipeline.

Fields#

Name Type Description
testSuites TestSuiteSummaryConnection! Test suites belonging to a pipeline test report. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

TestSuiteSummaryConnection#

Paginated collection of TestSuiteSummary. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

TimeTrackingTimelogCategoryConnection#

Paginated collection of TimeTrackingTimelogCategory. See Standard connection fields for the fields available on every connection.

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.

TimelineEventTagTypeConnection#

Paginated collection of TimelineEventTagType. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp when the event updated.
updatedByUser UserCore User that updated the timeline event.

TimelineEventTypeConnection#

Paginated collection of TimelineEventType. See Standard connection fields for the fields available on every connection.

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.

TimelogConnection#

Paginated collection of Timelog. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
totalSpentTime BigInt! Total time spent in seconds.

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 the to-do item.
body String! Body of the to-do item.
createdAt Time! Timestamp the to-do item was created.
group Group Group the to-do item is associated with.
id ID! ID of the to-do item.
memberAccessType String Access type of access request to-do items.
note Note Note which created the to-do item.
project Project Project the to-do item is associated with.
snoozedUntil Time Time until when the todo is snoozed.
state TodoStateEnum! State of the to-do item.
target Todoable! Deprecated in GitLab 17.4. Under certain circumstances, the target field on a to-do item can be null. The GraphQL schema currently declares target field as non-nullable. Use the new target_entity field instead.
targetEntity Todoable Target of the to-do item.
targetType TodoTargetEnum! Target type of the to-do item.
targetUrl String URL of the to-do item target.
transferFailedRetryUrl String URL that retries a transfer-failed to-do item.
transferFailureReason String Reason the transfer failed, for a transfer-failed to-do item.

TodoConnection#

Paginated collection of Todo. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

TopicConnection#

Paginated collection of Topic. See Standard connection fields for the fields available on every connection.

Tree#

Fields#

Name Type Description
blobs BlobConnection! Blobs of the tree. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
lastCommit Commit Last commit for the tree.

Arguments for lastCommit:
path (String)
Path to get the last commit for. Default value is the root of the repository.
ref (String)
Commit ref to get the last commit for. Default value is HEAD.
refType (RefType)
Type of ref.
permalinkPath String Introduced as an experiment in GitLab 17.11.

Web path to tree permalink. The permalinkPath field returns a string that represents the web path to a specific version of a directory, identified by its commit SHA. Use this path to create permanent links to directories at specific points in your repository's history.
submodules SubmoduleConnection! Sub-modules of the tree. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
trees TreeEntryConnection! Trees of the tree. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

TreeConnection#

Paginated collection of Tree. See Standard connection fields for the fields available on every connection.

TreeEntry#

Represents a directory.

Implements: Entry

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! SHA of 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).

TreeEntryConnection#

Paginated collection of TreeEntry. See Standard connection fields for the fields available on every connection.

TriageAndRemediationCapability#

A triage and remediation capability and its coverage state for a project.

Fields#

Name Type Description
enabled Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the capability is attached to the project.
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.5.

Run mode for the capability.
triggerType ScanProfileTriggerType! Introduced as an experiment in GitLab 19.5.

Trigger type the capability applies to.

TriageAndRemediationCoverage#

Triage and remediation capability coverage for a project.

Fields#

Name Type Description
capabilities [TriageAndRemediationCapability!]! Introduced as an experiment in GitLab 19.5.

Triage and remediation capabilities and their coverage state, one entry per trigger type.

TriageAndRemediationCoverageCounters#

Triage and remediation coverage counters for a namespace, for a given trigger type.

Fields#

Name Type Description
autoCount Int! Introduced as an experiment in GitLab 19.5.

Count of unarchived projects in the group where the trigger type is attached and set to automatic.
enabledCount Int! Introduced as an experiment in GitLab 19.5.

Count of unarchived projects in the group where the trigger type is attached.

TrialUsage#

Trial usage statistics.

Fields#

Name Type Description
creditsUsed Float Total credits used during a trial.
totalUsersUsingCredits Int Number of users who have used credits during a trial.
users GitlabTrialUsageUserConnection List of users with their trial usage data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for users:
username (String)
Username of the User.

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 the access level.
group AccessLevelGroup Group associated with the access level.
memberRole MemberRole Custom role associated with the access level.
user AccessLevelUser User associated with the access level.

UnprotectAccessLevelConnection#

Paginated collection of UnprotectAccessLevel. See Standard connection fields for the fields available on every connection.

UploadRegistry#

Represents the Geo replication and verification state of an upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the UploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the UploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this UploadRegistry.
fileId ID! ID of the Upload.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the UploadRegistry is missing on primary.
modelRecordId Int ID of the UploadRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the UploadRegistry in case of mismatch.
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 of UploadRegistry started.
verificationState VerificationStateEnum Verification state of the UploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the UploadRegistry.

UploadRegistryConnection#

Paginated collection of UploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

UsageTrendsMeasurementConnection#

Paginated collection of UsageTrendsMeasurement. See Standard connection fields for the fields available on every connection.

UserAchievement#

Fields#

Name Type Description
achievement Achievement! Achievement awarded.
awardMessage String Message associated with the awarded achievement.
awardMessageHtml String GitLab Flavored Markdown rendering of award_message.
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.
showOnProfile Boolean! Indicates whether or not the achievement is shown on the profile.
updatedAt Time! Timestamp the achievement was last updated.
user UserCore! Achievement recipient.

UserAchievementConnection#

Paginated collection of UserAchievement. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

UserAddOnAssignment#

An assignment of an AddOnPurchase to a User.

Fields#

Name Type Description
addOnPurchase AddOnPurchase! Add-on purchase the user is assigned to.

UserAddOnAssignmentConnection#

Paginated collection of UserAddOnAssignment. See Standard connection fields for the fields available on every connection.

UserCallout#

Fields#

Name Type Description
dismissedAt Time Date when the callout was dismissed.
featureName UserCalloutFeatureNameEnum Name of the feature that the callout is for.

UserCalloutConnection#

Paginated collection of UserCallout. See Standard connection fields for the fields available on every connection.

UserContributionCalendar#

A user's contribution calendar: the profile page's activity heatmap for the past year.

Fields#

Name Type Description
days [UserContributionDay!]! Days with at least one contribution, oldest first.
timezone String! Identifier of the timezone the days are counted in: the user's timezone, or the instance default if the user has not set one.
totalCount Int! Total number of contributions in the past year.
utcOffset Int! Offset of timezone from UTC, in seconds, as of the request.

UserContributionDay#

One day with at least one contribution on a user's contribution calendar.

Fields#

Name Type Description
count Int! Number of contributions on the day.
date Date! Date of the contributions, in the user's timezone.

UserCore#

Core representation of a GitLab user.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

UserCoreConnection#

Paginated collection of UserCore. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

UserDuoStatus#

Represents the Duo status for a user.

Fields#

Name Type Description
disabled Boolean! Indicates if the user is disabled for assignment in Duo features.
disabledReason String Reason why the user is disabled for assignment in Duo features.
flowTriggerEvents [AiFlowTriggerEventType!]! List of available flow trigger events for the user in Duo features.

UserGroupCallout#

Fields#

Name Type Description
dismissedAt Time! Date when the callout was dismissed.
featureName UserGroupCalloutFeatureName! Name of the feature that the callout is for.
groupId GroupID! Group id that the callout applies.

UserGroupCalloutConnection#

Paginated collection of UserGroupCallout. See Standard connection fields for the fields available on every connection.

UserMemberRole#

Fields#

Name Type Description
id GlobalID! Global ID of the user member role association.
memberRole MemberRole! Member Role to which the user belongs.
user UserCore! User to which the member role belongs.

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 the user for the merge request.
approved Boolean! Whether the user has approved the merge request.
approvedAt Time Timestamp of when the user approved the merge request. Returns null if the user has not approved it.
canMerge Boolean! Whether the user can merge the merge request.
canUpdate Boolean! Whether the user can update the merge request.
reviewState MergeRequestReviewState State of the review by the user.
reviewed Boolean! Whether the user has provided a review for the merge request.
updatedAt Time Timestamp of when the reviewer was last updated. null for records that have not transitioned state since GitLab 19.2.

Implements: NamespacesLinkPaths

Fields#

Name Type Description
autocompleteAwardEmojisPath String Introduced as an experiment in GitLab 18.6.

Path for autocomplete award emojis.
calendarPath String Introduced as an experiment in GitLab 18.4.

Calendar path for work items.
contributionGuidePath String Namespace contribution guide path.
emailsHelpPagePath String Help page path for emails.
epicsList String Namespace epics_list.
epicsListPath String Introduced as an experiment in GitLab 18.6.

Path to the epics list for the namespace.
groupIssues String Namespace group_issues.
groupPath String Introduced as an experiment in GitLab 18.6.

Full path of the group.
issuesList String Namespace issues_list.
issuesListPath String Introduced as an experiment in GitLab 18.6.

Path to the issues list for the namespace.
issuesSettings String Namespace issues settings path.
labelsFetch String Namespace labels_fetch.
labelsManage String Namespace labels_manage.
markdownHelpPath String Help page path for Markdown.
namespaceFullPath String Introduced as an experiment in GitLab 18.6.

Full path of the namespace (project.namespace.full_path or group full_path).
newCommentTemplate [CommentTemplatePath!] Namespace new_comment_template_paths.
newIssuePath String Introduced as an experiment in GitLab 18.6.

Path to create a new issue.
newProject String Namespace new_project.
newTrialPath String Introduced as an experiment in GitLab 18.6.

New trial path for the namespace.
quickActionsHelpPath String Help page path for quick actions.
register String Namespace register_path.
reportAbuse String Namespace report_abuse.
rssPath String Introduced as an experiment in GitLab 18.4.

RSS path for work items.
signIn String Namespace sign_in_path.
userExportEmail String Introduced as an experiment in GitLab 18.3.

User email for export CSV. Returns null for user namespaces.

UserNamespaceMarkdownPaths#

Implements: MarkdownPaths

Fields#

Name Type Description
autocompleteSourcesPath JSON Supported paths for autocomplete sources for a given namespace.

Arguments for autocompleteSourcesPath:
iid (String)
IID of the work item.
workItemTypeId (String)
ID of the work item type.
markdownPreviewPath String Path for the markdown preview for given namespace.

Arguments for markdownPreviewPath:
iid (String)
IID of the target item for markdown preview.
uploadsPath String Uploads path for a given namespace.

UserNamespaceMetadata#

Implements: NamespaceMetadata

Fields#

Name Type Description
groupId String Introduced as an experiment in GitLab 18.6.

ID of the group. Returns null for user namespaces.
initialSort String Introduced as an experiment in GitLab 18.6.

User preference for initial sort order.
isIssueRepositioningDisabled Boolean Introduced as an experiment in GitLab 18.6.

Whether issue repositioning is disabled for the namespace.
maxAttachmentSize String Introduced as an experiment in GitLab 18.6.

Maximum allowed attachment size (humanized).
showNewWorkItem Boolean Introduced as an experiment in GitLab 18.6.

Whether to show the new work item link.
timeTrackingLimitToHours Boolean Introduced as an experiment in GitLab 18.6.

Time tracking limit to hours setting.

UserPermissionExportUploadUploadRegistry#

Represents the Geo replication and verification state of a user_permission_export_upload_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the UserPermissionExportUploadUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the UserPermissionExportUploadUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this UserPermissionExportUploadUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the UserPermissionExportUploadUploadRegistry.
lastSyncFailure String Error message during sync of the UserPermissionExportUploadUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the UserPermissionExportUploadUploadRegistry.
missingOnPrimary Boolean Indicate if the UserPermissionExportUploadUploadRegistry is missing on primary.
modelRecordId Int ID of the UserPermissionExportUploadUploadRegistry's model record.
retryAt Time Timestamp after which the UserPermissionExportUploadUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the UserPermissionExportUploadUploadRegistry.
state RegistryState Sync state of the UserPermissionExportUploadUploadRegistry.
userPermissionExportUploadUploadId ID! ID of the User Permission Export File Upload.
verificationChecksum String The local checksum of the UserPermissionExportUploadUploadRegistry.
verificationChecksumMismatched String The expected checksum of the UserPermissionExportUploadUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the UserPermissionExportUploadUploadRegistry.
verificationRetryAt Time Timestamp after which the UserPermissionExportUploadUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the UserPermissionExportUploadUploadRegistry.
verificationStartedAt Time Timestamp when the verification of UserPermissionExportUploadUploadRegistry started.
verificationState VerificationStateEnum Verification state of the UserPermissionExportUploadUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the UserPermissionExportUploadUploadRegistry.

UserPermissionExportUploadUploadRegistryConnection#

Paginated collection of UserPermissionExportUploadUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

UserPermissions#

Fields#

Name Type Description
createSnippet Boolean! If true, the user can perform create_snippet on this resource.

UserPreferences#

Fields#

Name Type Description
duoDefaultNamespace Namespace Default namespace context for Duo features when namespace cannot be inferred.
extensionsMarketplaceOptInStatus ExtensionsMarketplaceOptInStatus! Status of the Web IDE Extension Marketplace opt-in for the user.
issuesSort IssueSort Sort order for issue lists.
knowledgeGraphGoverningNamespace Namespace Governing and billing namespace for Orbit.
mergeRequestDashboardListType MergeRequestsDashboardListType Merge request dashboard list rendering type.
mergeRequestDashboardShowDrafts Boolean Show draft merge requests on merge request dashboard.
orbitSettings JSON! Introduced as an experiment in GitLab 19.0.

Orbit agent settings for the user.
organizationGroupsProjectsDisplay OrganizationGroupProjectDisplay! Introduced as an experiment in GitLab 17.2.

Default list view for organization groups and projects.
organizationGroupsProjectsSort OrganizationGroupProjectSort Introduced as an experiment in GitLab 17.2.

Sort order for organization groups and projects.
projectsSort ProjectSort Sort order for projects.
timezone String Introduced as an experiment in GitLab 17.7.

Timezone of the user.
useWorkItemsView Boolean Deprecated in GitLab 19.5. Work item view is always used.
visibilityPipelineIdType VisibilityPipelineIdType Determines whether the pipeline list shows ID or IID.
wikiUseAutoCommitMessage Boolean! Introduced as an experiment in GitLab 18.10.

Whether to skip the commit message modal and use the auto-generated commit message when saving changes to a wiki document.
workItemsDisplaySettings JSON! Display settings for the work item lists.

UserStatus#

Fields#

Name Type Description
availability AvailabilityEnum! User availability status.
clearStatusAt Time Timestamp when the status should be automatically cleared.
disabledForDuoUsage Boolean! Indicates if the user is disabled for assignment in Duo features.
disabledForDuoUsageReason String Reason why the user is disabled for assignment in Duo features.
emoji String String representation of emoji.
message String User status message.
messageHtml String HTML of the user status message.

UserUploadRegistry#

Represents the Geo replication and verification state of a user_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the UserUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the UserUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this UserUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the UserUploadRegistry.
lastSyncFailure String Error message during sync of the UserUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the UserUploadRegistry.
missingOnPrimary Boolean Indicate if the UserUploadRegistry is missing on primary.
modelRecordId Int ID of the UserUploadRegistry's model record.
retryAt Time Timestamp after which the UserUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the UserUploadRegistry.
state RegistryState Sync state of the UserUploadRegistry.
userUploadId ID! ID of the User Upload.
verificationChecksum String The local checksum of the UserUploadRegistry.
verificationChecksumMismatched String The expected checksum of the UserUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the UserUploadRegistry.
verificationRetryAt Time Timestamp after which the UserUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the UserUploadRegistry.
verificationStartedAt Time Timestamp when the verification of UserUploadRegistry started.
verificationState VerificationStateEnum Verification state of the UserUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the UserUploadRegistry.

UserUploadRegistryConnection#

Paginated collection of UserUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

UsersQueuedForRolePromotion#

Represents a Pending Member Approval Queued for Role Promotion.

Fields#

Name Type Description
newAccessLevel AccessLevel Highest New GitLab::Access level requested for the member.
user UserCore User that is associated with the member approval object.

UsersQueuedForRolePromotionConnection#

Paginated collection of UsersQueuedForRolePromotion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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 as an experiment in GitLab 15.6.

Project the value stream belongs to, returns empty if it belongs to a group.
stages [ValueStreamStage!] Value Stream stages.

Arguments for stages:
id (ID)
Value stream stage id.

ValueStreamAnalytics#

Fields#

Name Type Description
aggregationStatus AggregationStatus Shows information about background data collection and aggregation.

ValueStreamAnalyticsDateMetric#

.

Fields#

Name Type Description
date Date Date for the metric.
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.

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.

ValueStreamConnection#

Paginated collection of ValueStream. See Standard connection fields for the fields available on every connection.

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.
endEventHtmlDescription String! HTML description of the end event.
endEventIdentifier ValueStreamStageEvent! End event identifier.
endEventLabel Label Label associated with end event.
hidden Boolean! Whether the stage is hidden.
id AnalyticsCycleAnalyticsStageID! ID of the value stream.
metrics ValueStreamStageMetrics! Aggregated metrics for the given stage.

Arguments for metrics:
assigneeUsernames ([String!])
Usernames of users assigned to the issue or the merge request.
authorUsername (String)
Username of the author of the issue or the merge request.
epicId (ID)
ID of an epic associated with the issues. Using the filter is not supported for stages based on merge requests.
iterationId (ID)
ID of an iteration associated with the issues. Using the filter is not supported for stages based on merge requests.
labelNames ([String!])
Labels applied to the issue or the merge request.
milestoneTitle (String)
Milestone applied to the issue or the merge request.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user.
not (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
projectIds ([ProjectID!])
Filter for projects. Only available for group value streams.
timeframe (Timeframe!)
Aggregation timeframe. Filters the issue or the merge request creation time for FOSS projects, and the end event timestamp for licensed projects or groups.
weight (Int)
Weight applied to the issue. Using the filter is not supported for stages based on merge requests.
name String! Name of the stage.
startEventHtmlDescription String! HTML description of the start event.
startEventIdentifier ValueStreamStageEvent! Start event identifier.
startEventLabel Label Label associated with start event.

ValueStreamStageItems#

Fields#

Name Type Description
duration String Duration of the item on the stage.
durationInMilliseconds BigInt Duration of item on stage in milliseconds.
endEventTimestamp Time When exited the stage.
record Issuable Item record.

ValueStreamStageItemsConnection#

Paginated collection of ValueStreamStageItems. See Standard connection fields for the fields available on every connection.

ValueStreamStageMetrics#

Fields#

Name Type Description
average ValueStreamAnalyticsMetric Average duration in seconds.
count ValueStreamAnalyticsMetric Limited item count. The backend counts maximum 1000 items, for free projects, and maximum 10,000 items for licensed projects or licensed groups.
items ValueStreamStageItemsConnection Introduced as an experiment in GitLab 17.4.

Items in the stage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for items:
sort (ValueStreamStageItemSort)
Sort stage items by criteria.
median ValueStreamAnalyticsMetric Median duration in seconds.
series ValueStreamStageSeries! Introduced as an experiment in GitLab 17.4.

Data series in the value stream stage.

ValueStreamStageSeries#

Fields#

Name Type Description
averageDurations [ValueStreamAnalyticsDateMetric!] Average duration for each day within the given date range.

VirtualRegistriesSetting#

Root group level virtual registries settings.

Fields#

Name Type Description
enabled Boolean! Indicates whether virtual registries are enabled for the group.

VirtualRegistryCleanupPolicy#

Represents a virtual registry cleanup policy.

Fields#

Name Type Description
cadence Int! Introduced as an experiment in GitLab 18.7.

Frequency in days for running the cleanup policy. Valid values: 1, 7, 14, 30, 90.
createdAt Time! Introduced as an experiment in GitLab 18.7.

Timestamp when the cleanup policy was created.
enabled Boolean! Introduced as an experiment in GitLab 18.7.

Whether the cleanup policy is enabled.
failureMessage String Introduced as an experiment in GitLab 18.7.

Error message when the cleanup policy fails.
keepNDaysAfterDownload Int! Introduced as an experiment in GitLab 18.7.

Number of days to keep cached entries after their last download.
lastRunAt Time Introduced as an experiment in GitLab 18.7.

Last time that the virtual registry cleanup policy executed.
lastRunDeletedEntriesCount Int Introduced as an experiment in GitLab 18.7.

Number of entries deleted during the last cleanup run.
lastRunDeletedSize BigInt Introduced as an experiment in GitLab 18.7.

Size in bytes of data deleted during the last cleanup run.
lastRunDetailedMetrics CleanupPolicyLastRunDetailedMetrics Introduced as an experiment in GitLab 18.7.

Detailed metrics from the last cleanup run.
nextRunAt Time Introduced as an experiment in GitLab 18.7.

Next time the virtual registry cleanup policy runs.
notifyOnFailure Boolean! Introduced as an experiment in GitLab 18.7.

Boolean to notify group owners on failed cleanup runs.
notifyOnSuccess Boolean! Introduced as an experiment in GitLab 18.7.

Boolean to notify group owners on successful cleanup runs.
status PolicyStatus! Introduced as an experiment in GitLab 18.7.

Current execution status of the cleanup policy.
updatedAt Time! Introduced as an experiment in GitLab 18.7.

Timestamp when the cleanup policy was last updated.

VulnerabilitiesByAge#

Represents vulnerability metrics by age with filtering and grouping capabilities.

Fields#

Name Type Description
byReportType [VulnerabilityReportTypeCount!] Vulnerability counts grouped by report type.
bySeverity [VulnerabilitySeverityCount!] Vulnerability counts grouped by severity level.
count Int Number of vulnerabilities in the age band.
name String! Age band name ("< 7 days", "7 - 14 days", "15 - 30 days", "31 - 60 days", "61 - 90 days", "91 - 180 days", "> 180 days" ).

VulnerabilitiesByIdentifier#

Represents vulnerability metrics by identifier with filtering.

Fields#

Name Type Description
bySeverity [VulnerabilitySeverityCount!] Vulnerability counts grouped by severity level.
count Int Number of vulnerabilities for the identifier.
name String! Identifier name.
url String URL to the identifier on the MITRE website.

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.

VulnerabilitiesCountByDayConnection#

Paginated collection of VulnerabilitiesCountByDay. See Standard connection fields for the fields available on every connection.

VulnerabilitiesOverTime#

Represents vulnerability metrics over time with filtering and grouping capabilities.

Fields#

Name Type Description
byReportType [VulnerabilityReportTypeCount!] Vulnerability counts grouped by report type.
bySeverity [VulnerabilitySeverityCount!] Vulnerability counts grouped by severity level.
count Int! Total number of vulnerabilities for the date.
date ISO8601Date! Date for the metrics.

VulnerabilitiesOverTimeConnection#

Paginated collection of VulnerabilitiesOverTime. See Standard connection fields for the fields available on every connection.

VulnerabilitiesPerSeverity#

Represents vulnerability counts grouped by severity level.

Fields#

Name Type Description
critical VulnerabilitySeverityCount Number of CRITICAL severity vulnerabilities.
high VulnerabilitySeverityCount Number of HIGH severity vulnerabilities.
info VulnerabilitySeverityCount Number of INFO severity vulnerabilities.
low VulnerabilitySeverityCount Number of LOW severity vulnerabilities.
medium VulnerabilitySeverityCount Number of MEDIUM severity vulnerabilities.
unknown VulnerabilitySeverityCount Number of UNKNOWN severity vulnerabilities.

Vulnerability#

Represents a vulnerability.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
aiResolutionAvailable Boolean Indicates whether the type of vulnerability can be resolved with AI.
aiResolutionEnabled Boolean Indicates whether the specific vulnerability can be resolved with AI.
aiWorkflows VulnerabilityTriggeredWorkflowConnection Introduced as an experiment in GitLab 18.6.

AI workflows triggered for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
archivalInformation VulnerabilityArchivalInformation! Introduced as an experiment in GitLab 17.11.

Indicates whether the vulnerability is about to be archived in the next month.
ascpComponent AscpComponent Introduced as an experiment in GitLab 19.4.

The ASCP component the vulnerability belongs to. Returns null when there is no matchor when the ascp_component_vulnerability_association feature flag is disabled.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
confirmedAt Time Timestamp of when the vulnerability state was changed to confirmed.
confirmedBy UserCore User that confirmed the vulnerability.
cveEnrichment CveEnrichmentType Enrichment (EPSS score and KEV) for CVE vulnerabilities.
cvss [CvssType!]! CVSS information for the vulnerability.
dependencies DependencyConnection! Introduced as an experiment in GitLab 18.2.

Dependencies for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencies:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
dueDate ISO8601Date Vulnerability finding due date.
duoSastVrWorkflowEnabled Boolean Introduced as an experiment in GitLab 19.1.

Indicates whether the SAST vulnerability review workflow is enabled for the project.
externalIssueLinks VulnerabilityExternalIssueLinkConnection! List of external issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
falsePositive Boolean Indicates whether the vulnerability is a false positive.
findingTokenStatus VulnerabilityFindingTokenStatus Status of the secret token associated with this vulnerability.
flags VulnerabilityFlagConnection Introduced as an experiment in GitLab 18.5.

Flags set on the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
hasRemediations Boolean Indicates whether there is a remediation available for the vulnerability.
id ID! GraphQL ID of the vulnerability.
identifiers [VulnerabilityIdentifier!]! Identifiers of the vulnerability.
initialDetectedPipeline Pipeline Introduced as an experiment in GitLab 18.2.

Pipeline where the vulnerability was first detected.
issueLinks VulnerabilityIssueLinkConnection! List of issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issueLinks:
linkType (VulnerabilityIssueLinkType)
Filter issue links by link type.
latestDetectedPipeline Pipeline Introduced as an experiment in GitLab 18.2.

Pipeline where the vulnerability was last detected.
latestFlag VulnerabilityFlag Introduced as an experiment in GitLab 18.5.

Latest flag for the vulnerability.
latestNonClosedMergeRequest MergeRequest Introduced as an experiment in GitLab 19.1.

Latest non-closed merge request linked to fix the vulnerability.
latestSecurityReportFinding PipelineSecurityReportFinding Introduced as an experiment in GitLab 18.4.

Latest security report finding for the vulnerability. On large projects, the field can time out and return null. Clients should check the top-level errors array for timeout errors, even when the HTTP response status is 200.
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.
malware Boolean Indicates whether the vulnerability is associated with a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
mergeRequest MergeRequest Merge request that fixes the vulnerability.
mergeRequests MergeRequestConnection Merge requests that are linked to fix the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
policyAutoDismissed Boolean Introduced as an experiment in GitLab 18.7.

Indicates whether the vulnerability was auto-dismissed by a security policy.
policyViolations PolicyViolations Introduced as an experiment in GitLab 18.6.

Policy violation for the vulnerability.
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.
reachability ReachabilityType Introduced as an experiment in GitLab 17.11.

Reachability status of the vulnerability.
removedFromCode Boolean! Indicates whether the vulnerability is present in the code or not.
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, CONTAINER_SCANNING_FOR_REGISTRY, SARIF, GENERIC). Scan Type in the UI.
representationInformation VulnerabilityRepresentationInformation Introduced as an experiment in GitLab 17.7.

Information about the representation of the vulnerability, such as resolved commit SHA.
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).
severityOverrides SeverityOverrideConnection List of severity changes for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String Title of the vulnerability.
trackedRef SecurityTrackedRef Introduced as an experiment in GitLab 18.10.

Tracked ref (branch or tag) where the vulnerability was detected.
unverified Boolean! Indicates whether the finding was detected without an identified source (untrusted input).
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.
validityDisplayState VulnerabilityValidityDisplayState Introduced as an experiment in GitLab 19.5.

Validity state derived from the token status and current vendor support.
vulnerabilityPath String Path to the vulnerability's details page.
webUrl String URL to the vulnerability's details page.

VulnerabilityArchivalInformation#

Represents vulnerability archival information.

Fields#

Name Type Description
aboutToBeArchived Boolean! Indicates whether the vulnerability is about to be archived in the next month.
expectedToBeArchivedOn Date Date when the vulnerability is expected to be archived.

VulnerabilityArchive#

Represents a vulnerability archive.

Fields#

Name Type Description
archivedRecordsCount Int! Number of records the archive contains.
month Int! Month of the archive, represented as a number from 1 (January) to 12 (December).
year Int! Year of the archive.

VulnerabilityArchiveExportUploadRegistry#

Represents the Geo replication and verification state of a vulnerability_archive_export_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the VulnerabilityArchiveExportUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the VulnerabilityArchiveExportUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this VulnerabilityArchiveExportUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the VulnerabilityArchiveExportUploadRegistry.
lastSyncFailure String Error message during sync of the VulnerabilityArchiveExportUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the VulnerabilityArchiveExportUploadRegistry.
missingOnPrimary Boolean Indicate if the VulnerabilityArchiveExportUploadRegistry is missing on primary.
modelRecordId Int ID of the VulnerabilityArchiveExportUploadRegistry's model record.
retryAt Time Timestamp after which the VulnerabilityArchiveExportUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the VulnerabilityArchiveExportUploadRegistry.
state RegistryState Sync state of the VulnerabilityArchiveExportUploadRegistry.
verificationChecksum String The local checksum of the VulnerabilityArchiveExportUploadRegistry.
verificationChecksumMismatched String The expected checksum of the VulnerabilityArchiveExportUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the VulnerabilityArchiveExportUploadRegistry.
verificationRetryAt Time Timestamp after which the VulnerabilityArchiveExportUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the VulnerabilityArchiveExportUploadRegistry.
verificationStartedAt Time Timestamp when the verification of VulnerabilityArchiveExportUploadRegistry started.
verificationState VerificationStateEnum Verification state of the VulnerabilityArchiveExportUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the VulnerabilityArchiveExportUploadRegistry.
vulnerabilityArchiveExportUploadId ID! ID of the Vulnerability Archive Export Upload.

VulnerabilityArchiveExportUploadRegistryConnection#

Paginated collection of VulnerabilityArchiveExportUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

VulnerabilityAverageScoreFactor#

Risk factor based on average vulnerability score.

Fields#

Name Type Description
factor Float! Introduced as an experiment in GitLab 18.4.

Factor value contributing to the risk score.

VulnerabilityConnection#

Paginated collection of Vulnerability. See Standard connection fields for the fields available on every connection.

VulnerabilityContainerImage#

Represents a container image reported on the related vulnerability.

Fields#

Name Type Description
name String Name of the container image.

VulnerabilityContainerImageConnection#

Paginated collection of VulnerabilityContainerImage. See Standard connection fields for the fields available on every connection.

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.

VulnerabilityDetailCodeFlowNode#

Represents the vulnerability details code flow node item.

Fields#

Name Type Description
description String Description of the field.
fieldName String Name of the field.
fileLocation VulnerabilityDetailFileLocation! Location of the file.
name String Name of the field.
nodeType CodeFlowNodeType! Node Type.

VulnerabilityDetailCodeFlows#

Represents the vulnerability details code flows item.

Fields#

Name Type Description
description String Description of the field.
fieldName String Name of the field.
items [[VulnerabilityDetailCodeFlowNode!]!]! List of flows represented by list of CodeFlowNodeItem.
name String Name of the field.

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 as an experiment in GitLab 16.1.

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 as an experiment in GitLab 16.1.

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.

VulnerabilityEnrichmentConfiguration#

Configuration for the vulnerability enrichment trigger of a triage and remediation scan profile.

Fields#

Name Type Description
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.4.

Whether enrichment runs automatically or on demand.
severityLevel VulnerabilitySeverity Introduced as an experiment in GitLab 19.4.

Minimum vulnerability severity that triggers enrichment.

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.

VulnerabilityExportPartUploadRegistry#

Represents the Geo replication and verification state of a Vulnerability Export Part Upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the VulnerabilityExportPartUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the VulnerabilityExportPartUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this VulnerabilityExportPartUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the VulnerabilityExportPartUploadRegistry.
lastSyncFailure String Error message during sync of the VulnerabilityExportPartUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the VulnerabilityExportPartUploadRegistry.
missingOnPrimary Boolean Indicate if the VulnerabilityExportPartUploadRegistry is missing on primary.
modelRecordId Int ID of the VulnerabilityExportPartUploadRegistry's model record.
retryAt Time Timestamp after which the VulnerabilityExportPartUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the VulnerabilityExportPartUploadRegistry.
state RegistryState Sync state of the VulnerabilityExportPartUploadRegistry.
verificationChecksum String The local checksum of the VulnerabilityExportPartUploadRegistry.
verificationChecksumMismatched String The expected checksum of the VulnerabilityExportPartUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the VulnerabilityExportPartUploadRegistry.
verificationRetryAt Time Timestamp after which the VulnerabilityExportPartUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the VulnerabilityExportPartUploadRegistry.
verificationStartedAt Time Timestamp when the verification of VulnerabilityExportPartUploadRegistry started.
verificationState VerificationStateEnum Verification state of the VulnerabilityExportPartUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the VulnerabilityExportPartUploadRegistry.
vulnerabilityExportPartUploadId ID! ID of the Vulnerability Export Part Upload.

VulnerabilityExportPartUploadRegistryConnection#

Paginated collection of VulnerabilityExportPartUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

VulnerabilityExportUploadRegistry#

Represents the Geo replication and verification state of a Vulnerability Export Upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the VulnerabilityExportUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the VulnerabilityExportUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this VulnerabilityExportUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the VulnerabilityExportUploadRegistry.
lastSyncFailure String Error message during sync of the VulnerabilityExportUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the VulnerabilityExportUploadRegistry.
missingOnPrimary Boolean Indicate if the VulnerabilityExportUploadRegistry is missing on primary.
modelRecordId Int ID of the VulnerabilityExportUploadRegistry's model record.
retryAt Time Timestamp after which the VulnerabilityExportUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the VulnerabilityExportUploadRegistry.
state RegistryState Sync state of the VulnerabilityExportUploadRegistry.
verificationChecksum String The local checksum of the VulnerabilityExportUploadRegistry.
verificationChecksumMismatched String The expected checksum of the VulnerabilityExportUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the VulnerabilityExportUploadRegistry.
verificationRetryAt Time Timestamp after which the VulnerabilityExportUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the VulnerabilityExportUploadRegistry.
verificationStartedAt Time Timestamp when the verification of VulnerabilityExportUploadRegistry started.
verificationState VerificationStateEnum Verification state of the VulnerabilityExportUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the VulnerabilityExportUploadRegistry.
vulnerabilityExportUploadId ID! ID of the Vulnerability Export Upload.

VulnerabilityExportUploadRegistryConnection#

Paginated collection of VulnerabilityExportUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

VulnerabilityExternalIssueLinkConnection#

Paginated collection of VulnerabilityExternalIssueLink. See Standard connection fields for the fields available on every connection.

VulnerabilityFindingTokenStatus#

Represents the status of a secret token found in a vulnerability.

Fields#

Name Type Description
createdAt Time! When the token status was created.
id ID! ID of the finding token status.
lastVerifiedAt Time When the token was last verified with the issuing service.
status VulnerabilityFindingTokenStatusState! Status of the token (unknown, active, inactive).
updatedAt Time! When the token status was last updated.

VulnerabilityFlag#

Represents a flag result for a vulnerability.

Fields#

Name Type Description
confidenceScore Float Introduced as an experiment in GitLab 18.5.

Confidence score of the detection (0.0 to 1.0).
createdAt Time! Timestamp when the detection was created.
description String Reasoning for the raising of the flag on the vulnerability.
id ID! ID of the false positive detection.
origin String Origin of service that raising the flag on the vulnerability.
status VulnerabilityFalsePositiveDetectionStatus Introduced as an experiment in GitLab 18.5.

Status of the false positive detection.
updatedAt Time! Timestamp when the detection was last updated.

VulnerabilityFlagConnection#

Paginated collection of VulnerabilityFlag. See Standard connection fields for the fields available on every connection.

VulnerabilityFunnelStep#

A step in the vulnerability resolution funnel.

Fields#

Name Type Description
canEnable Boolean Whether the current user can enable the setting that would make this step available. Null when there is no single setting the user can act on, such as an aggregated group view.
count Int Count for the step. Null when status is not AVAILABLE.
status VulnerabilityFunnelStepStatus! Whether the step's data can be shown, and if not, why.

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.

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.

VulnerabilityIssueLinkConnection#

Paginated collection of VulnerabilityIssueLink. See Standard connection fields for the fields available on every connection.

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
containerRepositoryUrl String URL of scanned image.
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.

VulnerabilityManagementPolicy#

Represents the vulnerability management policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.

VulnerabilityManagementPolicyAttributesType#

Represents policy fields related to the vulnerability management policy.

Fields#

Name Type Description
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.

VulnerabilityManagementPolicyConnection#

Paginated collection of VulnerabilityManagementPolicy. See Standard connection fields for the fields available on every connection.

VulnerabilityNamespaceStatisticType#

Counts for each vulnerability severity in the group and its subgroups.

Implements: VulnerabilityStatisticInterface

Fields#

Name Type Description
critical Int! Number of vulnerabilities of CRITICAL severity.
high Int! Number of vulnerabilities of HIGH severity.
info Int! Number of vulnerabilities of INFO severity.
low Int! Number of vulnerabilities of LOW severity.
medium Int! Number of vulnerabilities of MEDIUM severity.
namespaceId Int! Namespace ID.
total Int! Total of all vulnerabilities.
unknown Int! Number of vulnerabilities of UNKNOWN severity.
updatedAt Time Date that data was last updated.

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.

VulnerabilityRemediationUploadRegistry#

Represents the Geo replication and verification state of a vulnerability_remediation_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the VulnerabilityRemediationUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the VulnerabilityRemediationUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this VulnerabilityRemediationUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the VulnerabilityRemediationUploadRegistry.
lastSyncFailure String Error message during sync of the VulnerabilityRemediationUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the VulnerabilityRemediationUploadRegistry.
missingOnPrimary Boolean Indicate if the VulnerabilityRemediationUploadRegistry is missing on primary.
modelRecordId Int ID of the VulnerabilityRemediationUploadRegistry's model record.
retryAt Time Timestamp after which the VulnerabilityRemediationUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the VulnerabilityRemediationUploadRegistry.
state RegistryState Sync state of the VulnerabilityRemediationUploadRegistry.
verificationChecksum String The local checksum of the VulnerabilityRemediationUploadRegistry.
verificationChecksumMismatched String The expected checksum of the VulnerabilityRemediationUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the VulnerabilityRemediationUploadRegistry.
verificationRetryAt Time Timestamp after which the VulnerabilityRemediationUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the VulnerabilityRemediationUploadRegistry.
verificationStartedAt Time Timestamp when the verification of VulnerabilityRemediationUploadRegistry started.
verificationState VerificationStateEnum Verification state of the VulnerabilityRemediationUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the VulnerabilityRemediationUploadRegistry.
vulnerabilityRemediationUploadId ID! ID of the Vulnerability Remediation Upload.

VulnerabilityRemediationUploadRegistryConnection#

Paginated collection of VulnerabilityRemediationUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

VulnerabilityReportTypeCount#

Represents a count of vulnerabilities for a specific report type.

Fields#

Name Type Description
count Int! Number of vulnerabilities.
reportType VulnerabilityReportType! Report type.

VulnerabilityRepresentationInformation#

Represents vulnerability information.

Fields#

Name Type Description
resolvedInCommitSha String SHA of the commit where the vulnerability was resolved.

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.

VulnerabilityResolutionFunnel#

Adoption funnel for AI-assisted vulnerability resolution (Critical and High SAST vulnerabilities).

Fields#

Name Type Description
createdMergeRequests VulnerabilityFunnelStep! Subset for which a merge request was created by Duo Agent Platform.
detectedVulnerabilities VulnerabilityFunnelStep! Critical and High SAST vulnerabilities detected in the window.
mergedMergeRequests VulnerabilityFunnelStep! Subset whose resolution merge request has been merged.
truePositives VulnerabilityFunnelStep! Subset confirmed as true positives via AI False Positive Detection.

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.

VulnerabilityScannerConnection#

Paginated collection of VulnerabilityScanner. See Standard connection fields for the fields available on every connection.

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.

VulnerabilitySeverityCount#

Represents a count of vulnerabilities for a specific severity level.

Fields#

Name Type Description
count Int! Number of vulnerabilities.
meanAge Float Average age in days of vulnerabilities since detection.
medianAge Float Median age in days of vulnerabilities since detection.
severity VulnerabilitySeverity! Severity level.

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.
id VulnerabilitiesStateTransitionID! ID of the state transition.
toState VulnerabilityState! State of the vulnerability after transition.

VulnerabilityStateTransitionTypeConnection#

Paginated collection of VulnerabilityStateTransitionType. See Standard connection fields for the fields available on every connection.

VulnerabilityStatisticType#

Counts for each vulnerability severity in the project.

Implements: VulnerabilityStatisticInterface

Fields#

Name Type Description
critical Int! Number of vulnerabilities of CRITICAL severity.
high Int! Number of vulnerabilities of HIGH severity.
info Int! Number of vulnerabilities of INFO severity.
low Int! Number of vulnerabilities of LOW severity.
medium Int! Number of vulnerabilities of MEDIUM severity.
projectId Int! Project ID.
total Int! Total of all vulnerabilities.
unknown Int! Number of vulnerabilities of UNKNOWN severity.
updatedAt Time Date that data was last updated.

VulnerabilityTriggeredWorkflow#

Represents a triggered workflow for a vulnerability.

Fields#

Name Type Description
workflow DuoWorkflow Associated workflow details.
workflowName VulnerabilityWorkflowName! Name of the workflow.

VulnerabilityTriggeredWorkflowConnection#

Paginated collection of VulnerabilityTriggeredWorkflow. See Standard connection fields for the fields available on every connection.

VulnerabilityWorkflowExecution#

Represents a bulk Duo workflow execution.

Fields#

Name Type Description
batchSize Int! Maximum number of vulnerabilities processed per batch.
cancelRequested Boolean! Whether cancellation has been requested.
createdAt Time! Time the execution was created.
currentStage VulnerabilityWorkflowStage Current workflow stage.
endedAt Time Time the execution completed.
executionId ID! Execution identifier.
itemStates [VulnerabilityWorkflowItem!]! Current workflow state for vulnerabilities in the execution.
progress VulnerabilityWorkflowProgress! Current execution progress.
stages [VulnerabilityWorkflowStage!]! Workflow stages in execution order.
startedAt Time Time the execution started.
status VulnerabilityWorkflowStatus! Current execution status.
workflow VulnerabilityDuoWorkflow! Duo workflow being executed.

VulnerabilityWorkflowItem#

Workflow state of a vulnerability.

Fields#

Name Type Description
state VulnerabilityWorkflowItemState! Current workflow state.
vulnerability Vulnerability Vulnerability.

VulnerabilityWorkflowProgress#

Progress information for a bulk Duo workflow execution.

Fields#

Name Type Description
cancelled Int! Number of cancelled vulnerabilities.
completed Int! Number of completed vulnerabilities.
failed Int! Number of failed vulnerabilities.
pending Int! Number of pending vulnerabilities.
percentage Float! Execution completion percentage.
processing Int! Number of vulnerabilities currently being processed.
total Int! Total number of vulnerabilities.

VulnerabilityWorkflowStage#

A stage within a bulk Duo workflow.

Fields#

Name Type Description
name String! Stage name.
order Int! Execution order.

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 that performed the scan.
clusterId ClustersClusterID ID of the cluster integration 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 where the resource resides.

VulnerablePackage#

Represents a vulnerable package. Used in vulnerability dependency data.

Fields#

Name Type Description
name String Name of the vulnerable package.
path String Path of the vulnerable package.

VulnerableProjectsByGrade#

Represents vulnerability letter grades with associated projects.

Fields#

Name Type Description
count Int! Number of projects within the grade.
grade VulnerabilityGrade! Grade based on the highest severity vulnerability present.
projects ProjectConnection! Projects within the grade. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

WebhookCustomHeader#

Fields#

Name Type Description
key String! Custom header name.

WebhookEvent#

Fields#

Name Type Description
createdAt Time! Webhook request time.
executionDuration Float Webhook execution duration in seconds.
id WebHookLogID! Global ID of the webhook event.
internalErrorMessage String Internal error message that occurred while executing the webhook.
oversize Boolean! Whether request data was too large to be executed.
requestData String Data sent in the webhook request.
requestHeaders [WebhookEventHeaderType!] HTTP Headers used in the webhook request.
responseBody String Body of the webhook response.
responseHeaders [WebhookEventHeaderType!] HTTP Headers from the webhook response.
responseStatus String HTTP status of the webhook response.
trigger String Trigger that caused webhook execution.
url String URL used in webhook request.

WebhookEventConnection#

Paginated collection of WebhookEvent. See Standard connection fields for the fields available on every connection.

WebhookEventHeaderType#

Fields#

Name Type Description
name String! HTTP response header name.
value String! HTTP response header value.

WebhookUrlVariable#

Fields#

Name Type Description
key String! URL variable mask that will appear in a masked webhook url in place of its sensitive portion.

WikiPage#

A wiki page.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
awardEmoji AwardEmojiConnection List of emoji reactions associated with the wiki page. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
content String Content of the wiki page.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id WikiPageMetaID! Global ID of the wiki page metadata record.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
slug String URL slug of the wiki page.
subscribed Boolean! Whether the current user is subscribed to notifications on the wiki page.
title String! Wiki page title.
userPermissions WikiPagePermissions! Permissions for the current user on the resource.
webUrl String URL of the object.

WikiPageConnection#

Paginated collection of WikiPage. See Standard connection fields for the fields available on every connection.

WikiPagePermissions#

Fields#

Name Type Description
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.
markNoteAsInternal Boolean! If true, the user can perform mark_note_as_internal on this resource.
readWikiPage Boolean! If true, the user can perform read_wiki_page on this resource.

WorkItem#

Implements: Todoable

Fields#

Name Type Description
archived Boolean! Introduced as an experiment in GitLab 16.5.

Whether the work item belongs to an archived project or group.
author UserCore Introduced as an experiment in GitLab 15.9.

User that created the work item.
availableQuickActions [QuickActionCommand!] Quick actions available to the current user on the work item.
closedAt Time Timestamp of when the work item was closed.
commentTemplatesPaths [CommentTemplatePathType!]! Paths of the comment templates.
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.
duoWorkflowLinks DuoWorkflowWorkItemLinkConnection GitLab Duo Agent Platform sessions linked to the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowLinks:
linkType (DuoWorkflowWorkItemLinkType)
Filter links by their link type.
duplicatedToWorkItemUrl String URL of the work item that the work item is marked as a duplicate of.
externalAuthor String Introduced as an experiment in GitLab 18.8.

Email address of non-GitLab user reporting the issue. For guests, the email address is obfuscated.
features WorkItemFeatures! Introduced as an experiment in GitLab 18.9.

Features of the work item.
hidden Boolean Indicates the work item is hidden because the author has been banned.
id WorkItemID! Global ID of the work item.
iid String! Internal ID of the work item.
imported Boolean! Indicates whether the work item was imported.
lockVersion Int! Lock version of the work item. Incremented each time the work item is updated.
movedToWorkItemUrl String URL of the work item that the work item was moved to.
name String Name or title of the object.
namespace Namespace Introduced as an experiment in GitLab 15.10.

Namespace the work item belongs to.
project Project Introduced as an experiment in GitLab 15.3.

Project the work item belongs to.
promotedToEpicUrl String URL of the epic that the work item has been promoted to.
reference String! Internal reference of the work item. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Boolean option specifying whether the reference should be returned in full.
showPlanUpgradePromotion Boolean! Introduced as an experiment in GitLab 17.11.

Whether to show the promotional message for the work item.
state WorkItemState! State of the work item.
title String! Title of the work item.
titleHtml String HTML rendering of title.
updatedAt Time! Timestamp of when the work item was last updated.
userDiscussionsCount Int! Number of user discussions in the work item.
userPermissions WorkItemPermissions! Permissions for the current user on the resource.
webPath String Web path of the object.
webUrl String URL of the object.
widgets [WorkItemWidget!] Collection of widgets that belong to the work item.

Arguments for widgets:
exceptTypes ([WorkItemWidgetType!])
Except widgets of the given types.
onlyTypes ([WorkItemWidgetType!])
Only widgets of the given types.
workItemType WorkItemType! Type assigned to the work item.

WorkItemAgentPlanQuestion#

Represents a question a workplan flow asked on a work item.

Fields#

Name Type Description
answered Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the thread the question was asked in is resolved.
discussionId DiscussionID! Introduced as an experiment in GitLab 19.5.

Global ID of the thread the question was asked in.
noteId NoteID! Introduced as an experiment in GitLab 19.5.

Global ID of the comment that asked the question.

WorkItemAgentPlanQuestionConnection#

Paginated collection of WorkItemAgentPlanQuestion. See Standard connection fields for the fields available on every connection.

WorkItemClosingMergeRequest#

Fields#

Name Type Description
fromMrDescription Boolean! Whether this merge request link was created by referencing the work item on the merge request description, using the closing pattern.
id MergeRequestIssueID! Global ID of the closing merge request association.
mergeRequest MergeRequest Related merge request.

WorkItemClosingMergeRequestConnection#

Paginated collection of WorkItemClosingMergeRequest. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int Number of merge requests that close the work item on merge.

WorkItemConnection#

Paginated collection of WorkItem. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

WorkItemDateFieldValue#

Implements: WorkItemCustomFieldValue

Fields#

Name Type Description
customField CustomField! Custom field associated with the custom field value.
value Date Date value of the custom field.

WorkItemDecision#

Represents a decision recorded in the decision log of a work item.

Fields#

Name Type Description
archivedAt Time Introduced as an experiment in GitLab 19.5.

Timestamp when the decision was archived.
author UserCore Introduced as an experiment in GitLab 19.4.

User who raised the decision.
description String Introduced as an experiment in GitLab 19.4.

Context of the decision.
discussionId DiscussionID Introduced as an experiment in GitLab 19.4.

Global ID of the originating discussion thread.
id WorkItemsDecisionID! Introduced as an experiment in GitLab 19.4.

Global ID of the decision.
noteUrl String Introduced as an experiment in GitLab 19.4.

URL of the comment that resolved the decision.
options WorkItemDecisionOptionConnection Introduced as an experiment in GitLab 19.4.

Candidate options of the decision. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
resolutionRationale String Introduced as an experiment in GitLab 19.4.

Reasoning given when the decision was resolved.
resolvedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp when the decision was resolved.
resolvedBy UserCore Introduced as an experiment in GitLab 19.4.

User who resolved the decision.
resolvingNoteId NoteID Introduced as an experiment in GitLab 19.4.

Global ID of the comment that resolved the decision.
sourceLink String Introduced as an experiment in GitLab 19.4.

URL of the comment, discussion, or external resource that prompted the decision. Present only on manually created decisions.
state WorkItemDecisionState! Introduced as an experiment in GitLab 19.5.

State of the decision.
title String Introduced as an experiment in GitLab 19.4.

Question being decided. May be absent for decisions recorded as already resolved at creation.

WorkItemDecisionConnection#

Paginated collection of WorkItemDecision. See Standard connection fields for the fields available on every connection.

WorkItemDecisionOption#

Represents a candidate option of a work item decision.

Fields#

Name Type Description
content String! Introduced as an experiment in GitLab 19.4.

Content of the decision option.
description String Introduced as an experiment in GitLab 19.4.

Reasoning behind the decision option.
id WorkItemsDecisionOptionID! Introduced as an experiment in GitLab 19.4.

Global ID of the decision option.
recommended Boolean! Introduced as an experiment in GitLab 19.4.

Indicates the option is recommended by GitLab Duo.
selected Boolean! Introduced as an experiment in GitLab 19.4.

Indicates the option was selected when the decision was resolved.

WorkItemDecisionOptionConnection#

Paginated collection of WorkItemDecisionOption. See Standard connection fields for the fields available on every connection.

WorkItemDescriptionTemplate#

Fields#

Name Type Description
category String Category of description template.
content String Content of Description Template.
name String Name of Description Template.
projectId Int ID of the description template project.

WorkItemDescriptionTemplateConnection#

Paginated collection of WorkItemDescriptionTemplate. See Standard connection fields for the fields available on every connection.

WorkItemFeatures#

Fields#

Name Type Description
agentPlan WorkItemWidgetAgentPlan Agent plan widget of the work item. Returns null if the widget is not available for the work item.
aiSession WorkItemWidgetAiSession Ai session widget of the work item. Returns null if the widget is not available for the work item.
assignees WorkItemWidgetAssignees Assignees widget of the work item. Returns null if the widget is not available for the work item.
awardEmoji WorkItemWidgetAwardEmoji Award emoji widget of the work item. Returns null if the widget is not available for the work item.
color WorkItemWidgetColor Color widget of the work item. Returns null if the widget is not available for the work item.
crmContacts WorkItemWidgetCrmContacts Crm contacts widget of the work item. Returns null if the widget is not available for the work item.
currentUserTodos WorkItemWidgetCurrentUserTodos Current user todos widget of the work item. Returns null if the widget is not available for the work item.
customFields WorkItemWidgetCustomFields Custom fields widget of the work item. Returns null if the widget is not available for the work item.
decisionLog WorkItemWidgetDecisionLog Decision log widget of the work item. Returns null if the widget is not available for the work item.
description WorkItemWidgetDescription Description widget of the work item. Returns null if the widget is not available for the work item.
designs WorkItemWidgetDesigns Designs widget of the work item. Returns null if the widget is not available for the work item.
development WorkItemWidgetDevelopment Development widget of the work item. Returns null if the widget is not available for the work item.
emailParticipants WorkItemWidgetEmailParticipants Email participants widget of the work item. Returns null if the widget is not available for the work item.
errorTracking WorkItemWidgetErrorTracking Error tracking widget of the work item. Returns null if the widget is not available for the work item.
escalationPolicy WorkItemWidgetEscalationPolicy Escalation policy widget of the work item. Returns null if the widget is not available for the work item.
escalationStatus WorkItemWidgetEscalationStatus Escalation status widget of the work item. Returns null if the widget is not available for the work item.
healthStatus WorkItemWidgetHealthStatus Health status widget of the work item. Returns null if the widget is not available for the work item.
hierarchy WorkItemWidgetHierarchy Hierarchy widget of the work item. Returns null if the widget is not available for the work item.
iteration WorkItemWidgetIteration Iteration widget of the work item. Returns null if the widget is not available for the work item.
labels WorkItemWidgetLabels Labels widget of the work item. Returns null if the widget is not available for the work item.
linkedItems WorkItemWidgetLinkedItems Linked items widget of the work item. Returns null if the widget is not available for the work item.
linkedResources WorkItemWidgetLinkedResources Linked resources widget of the work item. Returns null if the widget is not available for the work item.
milestone WorkItemWidgetMilestone Milestone widget of the work item. Returns null if the widget is not available for the work item.
notes WorkItemWidgetNotes Notes widget of the work item. Returns null if the widget is not available for the work item.
notifications WorkItemWidgetNotifications Notifications widget of the work item. Returns null if the widget is not available for the work item.
participants WorkItemWidgetParticipants Participants widget of the work item. Returns null if the widget is not available for the work item.
progress WorkItemWidgetProgress Progress widget of the work item. Returns null if the widget is not available for the work item.
requirementLegacy WorkItemWidgetRequirementLegacy Requirement legacy widget of the work item. Returns null if the widget is not available for the work item.
severity WorkItemWidgetSeverity Severity widget of the work item. Returns null if the widget is not available for the work item.
startAndDueDate WorkItemWidgetStartAndDueDate Start and due date widget of the work item. Returns null if the widget is not available for the work item.
status WorkItemWidgetStatus Status widget of the work item. Returns null if the widget is not available for the work item.
testReports WorkItemWidgetTestReports Test reports widget of the work item. Returns null if the widget is not available for the work item.
timeTracking WorkItemWidgetTimeTracking Time tracking widget of the work item. Returns null if the widget is not available for the work item.
verificationStatus WorkItemWidgetVerificationStatus Verification status widget of the work item. Returns null if the widget is not available for the work item.
vulnerabilities WorkItemWidgetVulnerabilities Vulnerabilities widget of the work item. Returns null if the widget is not available for the work item.
weight WorkItemWidgetWeight Weight widget of the work item. Returns null if the widget is not available for the work item.

WorkItemLifecycle#

Represents a lifecycle for work items.

Fields#

Name Type Description
defaultClosedStatus WorkItemStatus Introduced as an experiment in GitLab 18.1.

Default closed status of the lifecycle.
defaultDuplicateStatus WorkItemStatus Introduced as an experiment in GitLab 18.1.

Default duplicate status of the lifecycle.
defaultOpenStatus WorkItemStatus Introduced as an experiment in GitLab 18.1.

Default open status of the lifecycle.
id GlobalID Introduced as an experiment in GitLab 18.1.

ID of the lifecycle.
name String Introduced as an experiment in GitLab 18.1.

Name of the lifecycle.
statusCounts [WorkItemStatusCount!] Introduced as an experiment in GitLab 18.4.

Work item counts by status for the lifecycle.
statuses [WorkItemStatus!] Introduced as an experiment in GitLab 18.1.

All available statuses of the lifecycle.
workItemTypes [WorkItemType!] Introduced as an experiment in GitLab 18.1.

Work item types associated to the lifecycle.

WorkItemLifecycleConnection#

Paginated collection of WorkItemLifecycle. See Standard connection fields for the fields available on every connection.

WorkItemLinkedResource#

Fields#

Name Type Description
url String! URL of resource.

WorkItemLinkedResourceConnection#

Paginated collection of WorkItemLinkedResource. See Standard connection fields for the fields available on every connection.

WorkItemMoveTarget#

Valid target work item types and a suggested target for moving work items of a given source type to a different namespace.

Fields#

Name Type Description
sourceType WorkItemType! Source work item type the suggestion is computed for.
suggestedTargetType WorkItemType Recommended target work item type in the destination namespace. Matches by global ID first (covers system-defined and converted custom types across namespaces), then falls back to matching by name. Returns null when no clear match exists; callers should let the user pick manually.
validTargetTypes [WorkItemType!]! Work item types in the destination namespace that the source type can be moved into. Includes the destination type that equals the source by global ID (if present) and the source type's conversion targets that exist in the destination namespace.

WorkItemNumberFieldValue#

Implements: WorkItemCustomFieldValue

Fields#

Name Type Description
customField CustomField! Custom field associated with the custom field value.
value Float Number value of the custom field.

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.
blockedWorkItems Boolean If true, the user can perform blocked_work_items on the work item.
cloneWorkItem Boolean! If true, the user can perform clone_work_item 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.
markNoteAsInternal Boolean! If true, the user can perform mark_note_as_internal on this resource.
moveWorkItem Boolean! If true, the user can perform move_work_item on this resource.
readWorkItem Boolean! If true, the user can perform read_work_item on this resource.
reportSpam Boolean! If true, the user can perform report_spam on this resource.
setWorkItemMetadata Boolean! If true, the user can perform set_work_item_metadata on this resource.
summarizeComments Boolean! If true, the user can perform summarize_comments on this resource.
updateWorkItem Boolean! If true, the user can perform update_work_item on this resource.

WorkItemRelatedBranch#

Fields#

Name Type Description
comparePath String Path to comparison of branch to default branch.
name String! Name of the branch.
pipelineStatus DetailedStatus Status of pipeline for the branch.

WorkItemRelatedBranchConnection#

Paginated collection of WorkItemRelatedBranch. See Standard connection fields for the fields available on every connection.

WorkItemSavedViewFilterWarningType#

Fields#

Name Type Description
field String! Name of the field associated with the warning.
message String! Message associated with the warning.

WorkItemSavedViewType#

Fields#

Name Type Description
author UserCore Author of the saved view.
description String Description of the saved view.
displaySettings JSON Display settings associated with the saved view.
filterWarnings [WorkItemSavedViewFilterWarningType!] Warnings associated with the filter values. This field can only be resolved for one saved view in any single request.
filters JSON Filters associated with the saved view. This field can only be resolved for one saved view in any single request.
id WorkItemsSavedViewsSavedViewID! ID of the saved view.
isPrivate Boolean! Whether the saved view is private.
lastUpdatedBy UserCore Introduced as an experiment in GitLab 18.10.

User who last updated the saved view.
name String! Name of the saved view.
namespaceId TypesNamespaceID! ID of the namespace of the saved view.
private Boolean! Deprecated in GitLab 18.10. Replaced by isPrivate field.
shareUrl String! URL to auto subscribe users to the view.
sort WorkItemSort Sort option associated with the saved view.
subscribed Boolean! Whether the current user is subscribed to the saved view.
updatedAt Time! Timestamp of when the saved view was last updated.
userPermissions SavedViewPermissions! Permissions for the current user on the resource.
workItems WorkItemConnection Introduced as an experiment in GitLab 18.8.

Work items associated with the saved view. This field can only be resolved for one saved view in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

WorkItemSavedViewTypeConnection#

Paginated collection of WorkItemSavedViewType. See Standard connection fields for the fields available on every connection.

WorkItemSelectFieldValue#

Implements: WorkItemCustomFieldValue

Fields#

Name Type Description
customField CustomField! Custom field associated with the custom field value.
selectedOptions [CustomFieldSelectOption!] Selected options of the custom field.

WorkItemSettings#

Work item settings for a namespace.

Fields#

Name Type Description
customizableTypeVisibility Boolean! Whether namespace admins can configure per-type work item visibility.

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.

WorkItemStatus#

Represents status.

Fields#

Name Type Description
category WorkItemStatusCategoryEnum Introduced as an experiment in GitLab 18.1.

Category of the status.
color String Introduced as an experiment in GitLab 17.11.

Color of the status.
description String Introduced as an experiment in GitLab 18.1.

Description of the status.
iconName String Introduced as an experiment in GitLab 17.11.

Icon name of the status.
id GlobalID Introduced as an experiment in GitLab 17.11.

ID of the status.
name String Introduced as an experiment in GitLab 17.11.

Name of the status.
position Int Introduced as an experiment in GitLab 17.11.

Position of the status within its category.

WorkItemStatusConnection#

Paginated collection of WorkItemStatus. See Standard connection fields for the fields available on every connection.

WorkItemStatusCount#

Represents a status with its work item count.

Fields#

Name Type Description
count String Introduced as an experiment in GitLab 18.4.

Work item count for the status. Shows "999+" when count exceeds 999.
status WorkItemStatus! Introduced as an experiment in GitLab 18.4.

Status of the work items.

WorkItemTextFieldValue#

Implements: WorkItemCustomFieldValue

Fields#

Name Type Description
customField CustomField! Custom field associated with the custom field value.
value String Text value of the custom field.

WorkItemTimelog#

Fields#

Name Type Description
id ID! Internal ID of the timelog.
note Note Note where the quick action was executed to add the logged time.
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.

WorkItemTimelogConnection#

Paginated collection of WorkItemTimelog. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
totalSpentTime BigInt! Total time spent in seconds.

WorkItemType#

Fields#

Name Type Description
archived Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is archived.
canPromoteToObjective Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type can be promoted to an objective.
canUserCreateItems Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is creatable by the API.
enabled Boolean! Introduced as an experiment in GitLab 18.9.

Indicates whether the work item type is enabled.
enabledByDefaultForNewNamespaces Boolean! Introduced as an experiment in GitLab 19.0.

Whether the work item type is enabled by default when new child namespaces are created.
iconName String Icon name of the work item type.
id WorkItemsTypeID! Global ID of the work item type.
isConfigurable Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is configurable.
isFilterableBoardView Boolean! Introduced as an experiment in GitLab 18.10.

Indicates whether the work item type is filterable in board view.
isFilterableListView Boolean! Introduced as an experiment in GitLab 18.10.

Indicates whether the work item type is filterable in list view.
isGroupWorkItemType Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type belongs only to a group.
isIncidentManagement Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is for incident management.
isServiceDesk Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is for service desk.
name String! Name of the work item type.
showProjectSelector Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type should show the project selector.
supportedConversionTypes [WorkItemType!] Introduced as an experiment in GitLab 17.8.

Supported conversion types for the work item type.
supportsMoveAction Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type can be moved or not.
supportsRoadmapView Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type supports roadmap view.
unavailableWidgetsOnConversion [WorkItemWidgetDefinition!] Widgets that will be lost when converting from source work item type to target work item type.

Arguments for unavailableWidgetsOnConversion:
target (WorkItemsTypeID!)
Target work item type to convert to.
useIssueView Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type uses the issue view instead of work item view.
visibleInSettings Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type should be visible in the settings page.
widgetDefinitions [WorkItemWidgetDefinition!] Introduced as an experiment in GitLab 16.7.

Available widgets for the work item type.

WorkItemTypeConnection#

Paginated collection of WorkItemType. See Standard connection fields for the fields available on every connection.

WorkItemTypeCountsByState#

Represents work item counts for the work item type.

Fields#

Name Type Description
countsByState WorkItemStateCountsType! Total number of work items for the represented states.
workItemType WorkItemType! Work item type.

WorkItemTypeDepthLimitReachedByType#

Represents Depth limit reached for the allowed work item type.

Fields#

Name Type Description
depthLimitReached Boolean! Indicates if maximum allowed depth has been reached for the descendant type.
workItemType WorkItemType! Work item type.

WorkItemTypeIconDefinition#

Represents an available icon for work item types.

Fields#

Name Type Description
label String! Human-readable screen reader label for the icon.
name String! Name of the icon.

WorkItemTypesUserPreference#

Fields#

Name Type Description
displaySettings JSON Display settings for the work item lists.
namespace Namespace! Namespace for the user preference.
sort WorkItemSort Sort order for work item lists.
workItemType WorkItemType Type assigned to the work item.

WorkItemWidgetAgentPlan#

Represents an agent plan widget.

Implements: WorkItemWidget

Fields#

Name Type Description
aiPlanningEnabled Boolean! Indicates whether AI planning is enabled for the work item.
content String Content of the agent plan. This field can only be resolved for one work item in any single request.
contentHtml String GitLab Flavored Markdown rendering of content. This field can only be resolved for one work item in any single request.
generationStatus WorkItemAgentPlanGenerationStatus Introduced as an experiment in GitLab 19.4.

Status of the asynchronous workplan generation flow for the work item. Reflects the most recent workplan/v1 Duo Agent Platform workflow, if any; creation of that workflow is currently gated by the duo_workplan_async_flow feature flag.
openQuestionsCount Int Introduced as an experiment in GitLab 19.5.

Number of questions asked by workplan flows whose thread is not resolved, across every run on the work item. Null when no workplan flow has run on the work item. Only available when the duo_workplan_async_flow feature flag is enabled. This field can only be resolved for one work item in any single request.
questions WorkItemAgentPlanQuestionConnection Introduced as an experiment in GitLab 19.5.

Questions asked by workplan flows, across every run on the work item, oldest first. Null when no workplan flow has run on the work item. Only available when the duo_workplan_async_flow feature flag is enabled. This field can only be resolved for one work item in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
readinessScore Int Introduced as an experiment in GitLab 19.3.

Readiness score of the agent plan (0-100). Null when the score is not yet available. Only available when the workplan_score feature flag is enabled.
readinessScoreFeedback String Introduced as an experiment in GitLab 19.4.

Markdown feedback explaining the readiness score. Null when no feedback is available. Only available when the workplan_score feature flag is enabled. This field can only be resolved for one work item in any single request.
readinessScoreFeedbackHtml String Introduced as an experiment in GitLab 19.4.

GitLab Flavored Markdown rendering of readiness_score_feedback. Only available when the workplan_score feature flag is enabled. This field can only be resolved for one work item in any single request.
type WorkItemWidgetType Widget type.

WorkItemWidgetAiSession#

Represents an AI session widget.

Implements: WorkItemWidget

Fields#

Name Type Description
duoWorkflows DuoWorkflowConnection Duo Workflow sessions associated with the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetAssignees#

Represents an assignees widget.

Implements: WorkItemWidget

Fields#

Name Type Description
allowsMultipleAssignees Boolean Deprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use workitemWidgetDefinitionAssignees.allowsMultipleAssignees instead.
assignees UserCoreConnection Assignees of the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
canInviteMembers Boolean! Deprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use workitemWidgetDefinitionAssignees.canInviteMembers instead.
type WorkItemWidgetType Widget type.

WorkItemWidgetAwardEmoji#

Represents the emoji reactions widget.

Implements: WorkItemWidget

Fields#

Name Type Description
awardEmoji AwardEmojiConnection Emoji reactions on the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
downvotes Int! Number of downvotes the work item has received.
newCustomEmojiPath String Path to create a new custom emoji.
type WorkItemWidgetType Widget type.
upvotes Int! Number of upvotes the work item has received.

WorkItemWidgetColor#

Represents a color widget.

Implements: WorkItemWidget

Fields#

Name Type Description
color String Color of the Work Item.
textColor String Text color generated for the Work Item.
type WorkItemWidgetType Widget type.

WorkItemWidgetCrmContacts#

Represents CRM contacts widget.

Implements: WorkItemWidget

Fields#

Name Type Description
contacts CustomerRelationsContactConnection Collection of CRM contacts associated with the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
contactsAvailable Boolean! Indicates whether contacts are available to be associated with the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetCurrentUserTodos#

Represents a todos widget.

Implements: CurrentUserTodos, WorkItemWidget

Fields#

Name Type Description
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
type WorkItemWidgetType Widget type.

WorkItemWidgetCustomFields#

Represents a custom fields widget.

Implements: WorkItemWidget

Fields#

Name Type Description
customFieldValues [WorkItemCustomFieldValue!] Introduced as an experiment in GitLab 17.9.

Custom field values associated to the work item.

Arguments for customFieldValues:
customFieldIds ([IssuablesCustomFieldID!])
Only return values for the given custom field IDs.
type WorkItemWidgetType Widget type.

WorkItemWidgetDecisionLog#

Represents a decision log widget.

Implements: WorkItemWidget

Fields#

Name Type Description
decisions WorkItemDecisionConnection Introduced as an experiment in GitLab 19.4.

Decisions recorded on the work item. Can be requested once per query; use states to fetch several states in one call. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for decisions:
states ([WorkItemDecisionState!])
Filter decisions by one or more states. Omit to return all states.
type WorkItemWidgetType Widget type.

WorkItemWidgetDefinitionAssignees#

Represents an assignees widget definition.

Implements: WorkItemWidgetDefinition

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.

WorkItemWidgetDefinitionCustomFields#

Represents a custom fields widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
customFieldValues [WorkItemCustomFieldValue!] Introduced as an experiment in GitLab 17.10.

Custom field values associated to the work item.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionGeneric#

Represents a generic widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionHierarchy#

Represents a hierarchy widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
allowedChildTypes WorkItemTypeConnection Allowed child types for the work item type. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
allowedParentTypes WorkItemTypeConnection Allowed parent types for the work item type. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
autoExpandTreeOnMove Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the hierarchy widget should auto expand the tree during move operation.
propagatesMilestone Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the hierarchy widget propagates milestone.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionLabels#

Represents a labels widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
allowsScopedLabels Boolean! Indicates whether scoped labels are available.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionProgress#

Represents a progress widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
showPopover Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether to show the progress popover.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionStartAndDueDate#

Represents a start and due date widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
canRollUp Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the start and due date widget should roll up dates.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionStatus#

Represents a Status widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
allowedStatuses [WorkItemStatus!] Introduced as an experiment in GitLab 17.8.

Allowed statuses for the work item type.
defaultClosedStatus WorkItemStatus Introduced as an experiment in GitLab 18.0.

Default status for the Closed state for given work item type.
defaultOpenStatus WorkItemStatus Introduced as an experiment in GitLab 18.0.

Default status for the Open state for given work item type.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionWeight#

Represents a weight widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
editable Boolean! Deprecated in GitLab 18.11. All work item types with weight widget now support editing.
rollUp Boolean! Deprecated in GitLab 18.11. All work item types with weight widget now support rolled up weight.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDescription#

Represents a description widget.

Implements: WorkItemWidget

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.
taskCompletionStatus TaskCompletionStatus! Task completion status of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetDesigns#

Represents designs widget.

Implements: WorkItemWidget

Fields#

Name Type Description
designCollection DesignCollection Collection of design images associated with the issue.
type WorkItemWidgetType Widget type.

WorkItemWidgetDevelopment#

Represents a development widget.

Implements: WorkItemWidget

Fields#

Name Type Description
closingMergeRequests WorkItemClosingMergeRequestConnection Merge requests that will close the work item when merged. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
closingMergeRequestsCount Int! Number of merge requests that will close the work item when merged.
featureFlags FeatureFlagConnection Feature flags associated with the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
relatedBranches WorkItemRelatedBranchConnection Branches that have referred to the work item, but do not have an associated merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
relatedMergeRequests MergeRequestConnection Introduced as an experiment in GitLab 17.6.

Merge requests where the work item has been mentioned. This field can only be resolved for one work item in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.
willAutoCloseByMergeRequest Boolean! Whether the work item will automatically be closed when a closing merge request is merged.

WorkItemWidgetEmailParticipants#

Represents email participants widget.

Implements: WorkItemWidget

Fields#

Name Type Description
emailParticipants EmailParticipantTypeConnection Collection of email participants associated with the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetErrorTracking#

Represents the error tracking widget.

Implements: WorkItemWidget

Fields#

Name Type Description
identifier BigInt Error tracking issue id.This field can only be resolved for one work item in any single request.
stackTrace ErrorTrackingStackTraceConnection Stack trace details of the error.This field can only be resolved for one work item in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
status ErrorTrackingStatus Response status of error service.This field can only be resolved for one work item in any single request.
type WorkItemWidgetType Widget type.

WorkItemWidgetErrorTrackingStackTraceContext#

Represents details about a line of code of the stack trace.

Fields#

Name Type Description
line String Line of code.
lineNumber Int Line number of code.

WorkItemWidgetEscalationPolicy#

Represents the escalation policy widget.

Implements: WorkItemWidget

Fields#

Name Type Description
escalationPolicy EscalationPolicyType Escalation policy of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetEscalationStatus#

Represents the escalation status widget.

Implements: WorkItemWidget

Fields#

Name Type Description
escalationStatus IssueEscalationStatus Escalation status of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetHealthStatus#

Represents a health status widget.

Implements: WorkItemWidget

Fields#

Name Type Description
healthStatus HealthStatus Health status of the work item.
rolledUpHealthStatus [WorkItemWidgetHealthStatusCount!] Introduced as an experiment in GitLab 17.3.

Rolled up health status of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetHealthStatusCount#

Represents work item counts for the health status.

Fields#

Name Type Description
count Int! Number of work items with the health status.
healthStatus HealthStatus! Health status of the work items.

WorkItemWidgetHierarchy#

Represents a hierarchy widget.

Implements: WorkItemWidget

Fields#

Name Type Description
ancestors WorkItemConnection Ancestors (parents) of the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
children WorkItemConnection Child work items. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for children:
state (WorkItemState)
Current state of the child work items. Returns all states when omitted.
depthLimitReachedByType [WorkItemTypeDepthLimitReachedByType!]! Introduced as an experiment in GitLab 17.4.

Depth limit reached by allowed work item type.
hasChildren Boolean! Indicates if the work item has children.
hasParent Boolean! Indicates if the work item has a parent.
parent WorkItem Parent work item.
rolledUpCountsByType [WorkItemTypeCountsByState!]! Introduced as an experiment in GitLab 17.3.

Counts of descendant work items by work item type and state.
type WorkItemWidgetType Widget type.

WorkItemWidgetIteration#

Represents an iteration widget.

Implements: WorkItemWidget

Fields#

Name Type Description
iteration Iteration Iteration of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetLabels#

Represents the labels widget.

Implements: WorkItemWidget

Fields#

Name Type Description
allowsScopedLabels Boolean Deprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use WorkItemWidgetDefinitionLabels.allowsScopedLabels instead.
labels LabelConnection Labels assigned to the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetLinkedItems#

Represents the linked items widget.

Implements: WorkItemWidget

Fields#

Name Type Description
blocked Boolean Indicates the work item is blocked.
blockedByCount Int Count of items blocking the work item.
blockingCount Int Count of items the work item is blocking.
linkedItems LinkedWorkItemTypeConnection Introduced as an experiment in GitLab 16.3.

Linked items for the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
type WorkItemWidgetType Widget type.

WorkItemWidgetLinkedResources#

Represents the linked resources widget.

Implements: WorkItemWidget

Fields#

Name Type Description
linkedResources WorkItemLinkedResourceConnection Resources for the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetMilestone#

Represents a milestone widget.

Implements: WorkItemWidget

Fields#

Name Type Description
milestone Milestone Milestone of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetNotes#

Represents a notes widget.

Implements: WorkItemWidget

Fields#

Name Type Description
discussionLocked Boolean Discussion lock attribute of the work item.
discussions DiscussionConnection Discussions on this work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for discussions:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
sort (WorkItemDiscussionsSort)
Sort order for the discussions.
notes NoteConnection! Notes on this work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
type WorkItemWidgetType Widget type.

WorkItemWidgetNotifications#

Represents the notifications widget.

Implements: WorkItemWidget

Fields#

Name Type Description
subscribed Boolean! Whether the current user is subscribed to notifications on the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetParticipants#

Represents a participants widget.

Implements: WorkItemWidget

Fields#

Name Type Description
participants UserCoreConnection Participants in the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetProgress#

Represents a progress widget.

Implements: WorkItemWidget

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.

Implements: WorkItemWidget

Fields#

Name Type Description
legacyIid Int Deprecated in GitLab 15.9. Use Work Item IID instead.
type WorkItemWidgetType Widget type.

WorkItemWidgetSeverity#

Represents the severity widget.

Implements: WorkItemWidget

Fields#

Name Type Description
severity IssuableSeverity Severity of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetStartAndDueDate#

Represents a start and due date widget.

Implements: WorkItemWidget

Fields#

Name Type Description
dueDate Date Due date of the work item.
dueDateSourcingMilestone Milestone Indicates which milestone sources the rolled up due date.
dueDateSourcingWorkItem WorkItem Indicates which work_item sources the rolled up due date.
isFixed Boolean! Indicates if the work item is using fixed dates.
rollUp Boolean! Indicates if the work item can use rolled up dates.
startDate Date Start date of the work item.
startDateSourcingMilestone Milestone Indicates which milestone sources the rolled up start date.
startDateSourcingWorkItem WorkItem Indicates which work_item sources the rolled up start date.
type WorkItemWidgetType Widget type.

WorkItemWidgetStatus#

Represents status widget.

Implements: WorkItemWidget

Fields#

Name Type Description
status WorkItemStatus Introduced as an experiment in GitLab 17.11.

Status assigned to work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetTestReports#

Represents a test reports widget.

Implements: WorkItemWidget

Fields#

Name Type Description
testReports TestReportConnection Test reports of the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetTimeTracking#

Represents the time tracking widget on the work item.

Implements: WorkItemWidget

Fields#

Name Type Description
humanReadableAttributes WorkItemWidgetTimeTrackingHumanReadableAttributes Human-readable attributes of the work item.
timeEstimate Int Time estimate of the work item.
timelogs WorkItemTimelogConnection Timelogs on the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
totalTimeSpent Int Total time (in seconds) reported as spent on the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetTimeTrackingHumanReadableAttributes#

Represents a time tracking human readable attributes.

Fields#

Name Type Description
timeEstimate String Human-readable time estimate of the work item.
totalTimeSpent String Human-readable total time reported as spent on the work item.

WorkItemWidgetVerificationStatus#

Represents a verification status widget.

Implements: WorkItemWidget

Fields#

Name Type Description
type WorkItemWidgetType Widget type.
verificationStatus String Introduced as an experiment in GitLab 15.5.

Verification status of the work item.

WorkItemWidgetVulnerabilities#

Represents a vulnerabilities widget.

Implements: WorkItemWidget

Fields#

Name Type Description
relatedVulnerabilities CountableVulnerabilityConnection Introduced as an experiment in GitLab 17.10.

Related vulnerabilities of the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetWeight#

Represents a weight widget.

Implements: WorkItemWidget

Fields#

Name Type Description
rolledUpCompletedWeight Int Introduced as an experiment in GitLab 17.3.

Rolled up weight from closed descendant work items.
rolledUpWeight Int Introduced as an experiment in GitLab 17.2.

Rolled up weight from descendant work items.
type WorkItemWidgetType Widget type.
weight Int Weight of the work item.
widgetDefinition WorkItemWidgetDefinitionWeight Deprecated in GitLab 18.11. All work item types with weight widget now support editing and rolled up weight.

Workspace#

Represents a remote development workspace.

Fields#

Name Type Description
actualState String! Actual state of the workspace.
actualStateUpdatedAt Time! Introduced as an experiment in GitLab 17.11.

Timestamp of the last update to the actual state.
clusterAgent ClusterAgent! Kubernetes agent associated with the workspace.
createdAt Time! Timestamp of when the workspace was created.
deploymentResourceVersion Int Version of the deployment resource for the workspace.
desiredState String! Desired state of the workspace.
desiredStateUpdatedAt Time! Timestamp of the last update to the desired state.
devfile String! Source YAML of the devfile used to configure the workspace.
devfilePath String Path to the devfile used to configure the workspace.
devfileRef String! Deprecated in GitLab 17.8. Field is renamed to project_ref.
devfileWebUrl String Deprecated in GitLab 17.8. Field is not used.
editor String! Deprecated in GitLab 17.5. Field is not used.
forceIncludeAllResources Boolean! Introduced as an experiment in GitLab 17.6.

Forces all resources to be included for the workspaceduring the next reconciliation with the agent.
id RemoteDevelopmentWorkspaceID! Global ID of the workspace.
maxHoursBeforeTermination Int! Deprecated in GitLab 17.9. Field is not used.
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 that contains the devfile for the workspace.
projectRef String! Git reference that contains the devfile used to configure the workspace, and that will be cloned into the workspace.
respondedToAgentAt Time Timestamp of the last response sent to the GitLab agent for Kubernetes for the workspace.
updatedAt Time! Timestamp of the last update to any mutable workspace property.
url String! URL of the workspace.
user UserCore! Owner of the workspace.
workspaceVariables WorkspaceVariableConnection Introduced as an experiment in GitLab 17.9.

User defined variables associated with the workspace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
workspacesAgentConfigVersion Int! Introduced as an experiment in GitLab 17.6.

Version of the associated WorkspacesAgentConfig for the workspace.

WorkspaceConnection#

Paginated collection of Workspace. See Standard connection fields for the fields available on every connection.

WorkspaceResources#

Resource specifications of the workspace container.

Fields#

Name Type Description
limits ResourceQuotas Limits for the requested container resources of a workspace.
requests ResourceQuotas Requested resources for the container of a workspace.

WorkspaceVariable#

Represents a remote development workspace variable.

Fields#

Name Type Description
createdAt Time! Timestamp of when the workspace variable was created.
id RemoteDevelopmentWorkspaceVariableID! Global ID of the workspace variable.
key String Name of the workspace variable.
updatedAt Time! Timestamp of when the workspace variable was updated.
value String Value of the workspace variable.
variableType WorkspaceVariableType Type of the workspace variable.

WorkspaceVariableConnection#

Paginated collection of WorkspaceVariable. See Standard connection fields for the fields available on every connection.

WorkspacesAgentConfig#

Represents a workspaces agent config.

Fields#

Name Type Description
allowPrivilegeEscalation Boolean! Allow privilege escalation.
annotations [KubernetesAnnotation!]! Annotations to apply to Kubernetes objects.
clusterAgent ClusterAgent! Cluster agent that the workspaces agent config belongs to.
createdAt Time! Timestamp of when the workspaces agent config was created.
defaultResourcesPerWorkspaceContainer WorkspaceResources! Introduced as an experiment in GitLab 17.9.

Default cpu and memory resources of the workspace container.
defaultRuntimeClass String! Default Kubernetes RuntimeClass.
dnsZone String! DNS zone where workspaces are available.
enabled Boolean! Indicates whether remote development is enabled for the GitLab agent.
gitlabWorkspacesProxyNamespace String! Namespace where gitlab-workspaces-proxy is installed.
id RemoteDevelopmentWorkspacesAgentConfigID! Global ID of the workspaces agent config.
imagePullSecrets [ImagePullSecrets!]! Introduced as an experiment in GitLab 17.9.

Kubernetes secrets to pull private images for a workspace.
labels [KubernetesLabel!]! Labels to apply to Kubernetes objects.
maxResourcesPerWorkspace WorkspaceResources! Introduced as an experiment in GitLab 17.9.

Maximum cpu and memory resources of the workspace.
networkPolicyEgress [NetworkPolicyEgress!]! Introduced as an experiment in GitLab 17.9.

IP CIDR range specifications for egress destinations from a workspace.
networkPolicyEnabled Boolean! Whether the network policy of the workspaces agent config is enabled.
projectId ID ID of the project that the workspaces agent config belongs to.
updatedAt Time! Timestamp of the last update to any mutable workspaces agent config property.
useKubernetesUserNamespaces Boolean! Indicates whether to use user namespaces in Kubernetes.
workspacesPerUserQuota Int! Maximum number of workspaces per user.
workspacesQuota Int! Maximum number of workspaces for the GitLab agent.

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

Implements: CommitSignature

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.

agentPlatformMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
clickDuoAgenticSubscriptionExpiredLearnMoreSessionEventCount Int Total count of click_duo_agentic_subscription_expired_learn_more event.
clickDuoAgenticSubscriptionExpiredUpgradeSessionEventCount Int Total count of click_duo_agentic_subscription_expired_upgrade event.
createdSessionEventCount Int Total count of agent_platform_session_created event.
droppedSessionEventCount Int Total count of agent_platform_session_dropped event.
finishedSessionEventCount Int Total count of agent_platform_session_finished event.
flowMetrics [AgentPlatformFlowMetric!] Aggregated flow metrics for Duo Agent Platform.

Arguments for flowMetrics:
sort (FlowTypeSort)
Sort results by flow type.
resumedSessionEventCount Int Total count of agent_platform_session_resumed event.
startedSessionEventCount Int Total count of agent_platform_session_started event.
stoppedSessionEventCount Int Total count of agent_platform_session_stopped event.
userFlowCounts AgentPlatformUserFlowCountConnection Aggregated count of flows per user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
viewDuoAgenticSubscriptionExpiredEmptyStateSessionEventCount Int Total count of view_duo_agentic_subscription_expired_empty_state event.

agentPlatformUserMetrics#

Agent Platform user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
agentPlatformSessionCreatedEventCount Int Total count of agent_platform_session_created event.
agentPlatformSessionDroppedEventCount Int Total count of agent_platform_session_dropped event.
agentPlatformSessionFinishedEventCount Int Total count of agent_platform_session_finished event.
agentPlatformSessionResumedEventCount Int Total count of agent_platform_session_resumed event.
agentPlatformSessionStartedEventCount Int Total count of agent_platform_session_started event.
agentPlatformSessionStoppedEventCount Int Total count of agent_platform_session_stopped event.
clickDuoAgenticSubscriptionExpiredLearnMoreEventCount Int Total count of click_duo_agentic_subscription_expired_learn_more event.
clickDuoAgenticSubscriptionExpiredUpgradeEventCount Int Total count of click_duo_agentic_subscription_expired_upgrade event.
lastDuoActivityOn Date Date of the last Agent Platform activity for the user.
totalEventCount Int Total count of all Agent Platform events for the user.
viewDuoAgenticSubscriptionExpiredEmptyStateEventCount Int Total count of view_duo_agentic_subscription_expired_empty_state event.

aiCatalogUserMetrics#

Ai Catalog user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Ai Catalog activity for the user.
restoreAiCatalogItemEventCount Int Total count of restore_ai_catalog_item event.
totalEventCount Int Total count of all Ai Catalog events for the user.

chatUserMetrics#

Chat user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
completeDuoChatResponseEventCount Int Total count of complete_duo_chat_response event.
lastDuoActivityOn Date Date of the last Chat activity for the user.
reportDuoChatTokenUsageEventCount Int Total count of report_duo_chat_token_usage event.
requestDuoChatResponseEventCount Int Total count of request_duo_chat_response event.
toolFailedDuoChatEventCount Int Total count of tool_failed_duo_chat event.
toolSucceededDuoChatEventCount Int Total count of tool_succeeded_duo_chat event.
totalEventCount Int Total count of all Chat events for the user.

codeReviewMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
assignDuoSuggestedReviewerEventCount Int Total count of assign_duo_suggested_reviewer event.
createDuoSuggestedReviewersEventCount Int Total count of create_duo_suggested_reviewers event.
encounterDuoCodeReviewErrorDuringReviewEventCount Int Total count of encounter_duo_code_review_error_during_review event.
excludedFilesFromDuoCodeReviewEventCount Int Total count of excluded_files_from_duo_code_review event.
findNoIssuesDuoCodeReviewAfterReviewEventCount Int Total count of find_no_issues_duo_code_review_after_review event.
findNothingToReviewDuoCodeReviewOnMrEventCount Int Total count of find_nothing_to_review_duo_code_review_on_mr event.
postCommentDuoCodeReviewOnDiffEventCount Int Total count of post_comment_duo_code_review_on_diff event.
publishDuoCodeReviewCommentsEventCount Int Total count of publish_duo_code_review_comments event.
reactThumbsDownOnDuoCodeReviewCommentEventCount Int Total count of react_thumbs_down_on_duo_code_review_comment event.
reactThumbsUpOnDuoCodeReviewCommentEventCount Int Total count of react_thumbs_up_on_duo_code_review_comment event.
requestReviewDuoCodeReviewOnMrByAuthorEventCount Int Total count of request_review_duo_code_review_on_mr_by_author event.
requestReviewDuoCodeReviewOnMrByNonAuthorEventCount Int Total count of request_review_duo_code_review_on_mr_by_non_author event.

codeReviewUserMetrics#

Code Review user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
assignDuoSuggestedReviewerEventCount Int Total count of assign_duo_suggested_reviewer event.
createDuoSuggestedReviewersEventCount Int Total count of create_duo_suggested_reviewers event.
encounterDuoCodeReviewErrorDuringReviewEventCount Int Total count of encounter_duo_code_review_error_during_review event.
excludedFilesFromDuoCodeReviewEventCount Int Total count of excluded_files_from_duo_code_review event.
findNoIssuesDuoCodeReviewAfterReviewEventCount Int Total count of find_no_issues_duo_code_review_after_review event.
findNothingToReviewDuoCodeReviewOnMrEventCount Int Total count of find_nothing_to_review_duo_code_review_on_mr event.
lastDuoActivityOn Date Date of the last Code Review activity for the user.
postCommentDuoCodeReviewOnDiffEventCount Int Total count of post_comment_duo_code_review_on_diff event.
publishDuoCodeReviewCommentsEventCount Int Total count of publish_duo_code_review_comments event.
reactThumbsDownOnDuoCodeReviewCommentEventCount Int Total count of react_thumbs_down_on_duo_code_review_comment event.
reactThumbsUpOnDuoCodeReviewCommentEventCount Int Total count of react_thumbs_up_on_duo_code_review_comment event.
requestReviewDuoCodeReviewOnMrByAuthorEventCount Int Total count of request_review_duo_code_review_on_mr_by_author event.
requestReviewDuoCodeReviewOnMrByNonAuthorEventCount Int Total count of request_review_duo_code_review_on_mr_by_non_author event.
totalEventCount Int Total count of all Code Review events for the user.

codeSuggestionMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
acceptedCount Int Total count of code suggestions accepted.
acceptedLinesOfCode Int Sum of lines of code from code suggestions accepted.
contributorsCount Int Number of code contributors who used GitLab Duo Code Suggestions features.
ideNames [String!] List of IDE names with at least one suggestion shown or accepted.
languages [String!] List of languages with at least one suggestion shown or accepted.
shownCount Int Total count of code suggestions shown.
shownLinesOfCode Int Sum of lines of code from code suggestions shown.

codeSuggestionsUserMetrics#

Code Suggestions user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
codeSuggestionAcceptedInIdeEventCount Int Total count of code_suggestion_accepted_in_ide event.
codeSuggestionDirectAccessTokenRefreshEventCount Int Total count of code_suggestion_direct_access_token_refresh event.
codeSuggestionRejectedInIdeEventCount Int Total count of code_suggestion_rejected_in_ide event.
codeSuggestionShownInIdeEventCount Int Total count of code_suggestion_shown_in_ide event.
codeSuggestionsRequestedEventCount Int Total count of code_suggestions_requested event.
lastDuoActivityOn Date Date of the last Code Suggestions activity for the user.
totalEventCount Int Total count of all Code Suggestions events for the user.

duoChatMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
completeDuoChatResponseEventCount Int Total count of complete_duo_chat_response event.
reportDuoChatTokenUsageEventCount Int Total count of report_duo_chat_token_usage event.
requestDuoChatResponseEventCount Int Total count of request_duo_chat_response event.
toolFailedDuoChatEventCount Int Total count of tool_failed_duo_chat event.
toolSucceededDuoChatEventCount Int Total count of tool_succeeded_duo_chat event.

duoMessagingUserMetrics#

Duo Messaging user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
aiDuoMessagingFeedbackSubmittedEventCount Int Total count of ai_duo_messaging_feedback_submitted event.
lastDuoActivityOn Date Date of the last Duo Messaging activity for the user.
totalEventCount Int Total count of all Duo Messaging events for the user.
triggerSlackDuoEventCount Int Total count of trigger_slack_duo event.

duoWorkflowUserMetrics#

Duo Workflow user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
duoWorkflowWorkloadCompletedEventCount Int Total count of duo_workflow_workload_completed event.
lastDuoActivityOn Date Date of the last Duo Workflow activity for the user.
totalEventCount Int Total count of all Duo Workflow events for the user.

explainCodeUserMetrics#

Explain Code user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
explainCodeEventCount Int Total count of explain_code event.
lastDuoActivityOn Date Date of the last Explain Code activity for the user.
totalEventCount Int Total count of all Explain Code events for the user.

explainVulnerabilityUserMetrics#

Explain Vulnerability user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
explainVulnerabilityEventCount Int Total count of explain_vulnerability event.
lastDuoActivityOn Date Date of the last Explain Vulnerability activity for the user.
totalEventCount Int Total count of all Explain Vulnerability events for the user.

featureDiscoveryUserMetrics#

Feature Discovery user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Feature Discovery activity for the user.
resolveFeatureDiscoverySearchEventCount Int Total count of resolve_feature_discovery_search event.
totalEventCount Int Total count of all Feature Discovery events for the user.

fixCodeUserMetrics#

Fix Code user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
fixCodeEventCount Int Total count of fix_code event.
lastDuoActivityOn Date Date of the last Fix Code activity for the user.
totalEventCount Int Total count of all Fix Code events for the user.

fixPipelineUserMetrics#

Fix Pipeline user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
fixPipelineSuggestionAppliedEventCount Int Total count of fix_pipeline_suggestion_applied event.
fixPipelineSuggestionPostedEventCount Int Total count of fix_pipeline_suggestion_posted event.
lastDuoActivityOn Date Date of the last Fix Pipeline activity for the user.
totalEventCount Int Total count of all Fix Pipeline events for the user.

generateMergeCommitMessageUserMetrics#

Generate Merge Commit Message user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
generateMergeCommitMessageEventCount Int Total count of generate_merge_commit_message event.
lastDuoActivityOn Date Date of the last Generate Merge Commit Message activity for the user.
totalEventCount Int Total count of all Generate Merge Commit Message events for the user.

mcpMetrics#

Model Context Protocol metrics. Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
finishMcpToolCallEventCount Int Total count of finish_mcp_tool_call event.
startMcpToolCallEventCount Int Total count of start_mcp_tool_call event.

mcpUserMetrics#

MCP user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
finishMcpToolCallEventCount Int Total count of finish_mcp_tool_call event.
lastDuoActivityOn Date Date of the last MCP activity for the user.
startMcpToolCallEventCount Int Total count of start_mcp_tool_call event.
totalEventCount Int Total count of all MCP events for the user.

refactorCodeUserMetrics#

Refactor Code user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Refactor Code activity for the user.
refactorCodeEventCount Int Total count of refactor_code event.
totalEventCount Int Total count of all Refactor Code events for the user.

requestDuoVulnerabilityResolutionUserMetrics#

Request Duo Vulnerability Resolution user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Request Duo Vulnerability Resolution activity for the user.
requestDuoVulnerabilityResolutionEventCount Int Total count of request_duo_vulnerability_resolution event.
totalEventCount Int Total count of all Request Duo Vulnerability Resolution events for the user.

summarizeNewMergeRequestUserMetrics#

Summarize New Merge Request user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Summarize New Merge Request activity for the user.
summarizeNewMergeRequestEventCount Int Total count of summarize_new_merge_request event.
totalEventCount Int Total count of all Summarize New Merge Request events for the user.

summarizeReviewUserMetrics#

Summarize Review user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Summarize Review activity for the user.
summarizeReviewEventCount Int Total count of summarize_review event.
totalEventCount Int Total count of all Summarize Review events for the user.

troubleshootJobMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
troubleshootJobEventCount Int Total count of troubleshoot_job event.

troubleshootJobUserMetrics#

Troubleshoot Job user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Troubleshoot Job activity for the user.
totalEventCount Int Total count of all Troubleshoot Job events for the user.
troubleshootJobEventCount Int Total count of troubleshoot_job event.

writeTestsUserMetrics#

Write Tests user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Write Tests activity for the user.
totalEventCount Int Total count of all Write Tests events for the user.
writeTestsEventCount Int Total count of write_tests event.

Connections and pagination#

Some fields return a connection: a paginated list of items that follows the Relay cursor connections specification. Because every connection shares the same pagination fields and arguments, they are documented here once rather than repeated for every connection field.

Standard connection fields#

Every connection type has the following fields:

Field Type Description
nodes [Item] The items in the current page. The item type depends on the connection.
edges [Edge] The edges. Each edge wraps a node and a cursor.
pageInfo PageInfo! Pagination information.

Every edge type has the following fields:

Field Type Description
node Item The item at the end of the edge. The item type depends on the connection.
cursor String! A cursor for use in pagination.

Some connections and edges have additional fields specific to their type. These are documented individually in each connection or edge section above.

Pagination arguments#

All connection fields accept the following optional pagination arguments:

Name Type Description
after String Returns the items that come after the specified cursor.
before String Returns the items that come before the specified cursor.
first Int Returns the first n items from the list.
last Int Returns the last n items from the list.

Querying a connection#

The following example queries the projects field, which returns a ProjectConnection. It shows the pagination arguments in use and annotates each part of the response with its type:

{
  projects(
    first: 10        # optional - return at most 10 items
    after: "abc123"  # optional - start after this cursor (from a previous endCursor)
  ) {                # ProjectConnection
    pageInfo {       # PageInfo
      hasNextPage    # Boolean - true if more pages follow
      endCursor      # String - pass as `after:` to fetch the next page
    }
    nodes {          # [Project] - the items on this page
      id
      name
    }
    edges {          # [ProjectEdge] - the same items, each with a cursor
      cursor         # String - cursor for this specific item
      node {         # Project
        id
        name
      }
    }
  }
}

To fetch the next page, pass the endCursor value from pageInfo as the after argument. Use last and before to paginate in reverse.

GraphQL API 객체

GitLab v19.5
원문 보기

요약

An object is a GraphQL type with fields. Deprecated items are planned to be removed in a future release. Represents the Geo replication and verification state of a abuse_report_upload.

An object is a GraphQL type with fields.

Warning

Deprecated items are planned to be removed in a future release. For more information, see the GitLab deprecation process.

AbuseReport#

An abuse report.

Fields#

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

AbuseReportUploadRegistry#

Represents the Geo replication and verification state of a abuse_report_upload.

Fields#

Name Type Description
abuseReportUploadId ID! ID of the Abuse Report Upload.
checksumMismatch Boolean Indicate if the checksums of the AbuseReportUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AbuseReportUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AbuseReportUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AbuseReportUploadRegistry.
lastSyncFailure String Error message during sync of the AbuseReportUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AbuseReportUploadRegistry.
missingOnPrimary Boolean Indicate if the AbuseReportUploadRegistry is missing on primary.
modelRecordId Int ID of the AbuseReportUploadRegistry's model record.
retryAt Time Timestamp after which the AbuseReportUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AbuseReportUploadRegistry.
state RegistryState Sync state of the AbuseReportUploadRegistry.
verificationChecksum String The local checksum of the AbuseReportUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AbuseReportUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AbuseReportUploadRegistry.
verificationRetryAt Time Timestamp after which the AbuseReportUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AbuseReportUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AbuseReportUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AbuseReportUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AbuseReportUploadRegistry.

AbuseReportUploadRegistryConnection#

Paginated collection of AbuseReportUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

AccessLevel#

Represents the access level of a relationship between a User and object that it is related to.

Fields#

Name Type Description
humanAccess String Human-readable display name for the access level.
integerValue Int Integer number of the access level.
stringValue AccessLevelEnum Enum string of the the 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.

AccessLevelDeployKeyConnection#

Paginated collection of AccessLevelDeployKey. See Standard connection fields for the fields available on every connection.

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.

AccessTokenGranularScope#

Granular scope applied to an access token.

Fields#

Name Type Description
access AccessTokenGranularScopeAccess! Access configured on a granular scope.
group Group Group of the granular scope, when the scope targets a specific group.
namespace Namespace Namespace of the granular scope.
permissions [AccessTokenPermission!] List of permissions of a granular scope.
project Project Project of the granular scope, when the scope targets a specific project.

AccessTokenLegacyScope#

Legacy scope applied to an access token.

Fields#

Name Type Description
value String! Value of the scope.

AccessTokenPermission#

Permission that belongs to a granular scope.

Fields#

Name Type Description
action String! Action of the permission.
boundaries [PermissionBoundary!]! List of resource types that the permission can be applied to.
category String! Permission category.
categoryName String! Display name of the permission category.
description String! Description of the permission.
name String! Name of the permission.
resource String! Resource of the permission.
resourceDescription String! Description of the resource.
resourceName String! Display name of the resource.

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.
uniqueUsers UserCoreConnection! Unique users who have received the achievement. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp the achievement was last updated.
userAchievements UserAchievementConnection Recipients for the achievement. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

AchievementConnection#

Paginated collection of Achievement. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AchievementUploadRegistry#

Represents the Geo replication and verification state of an achievement_upload.

Fields#

Name Type Description
achievementUploadId ID! ID of the Achievement Upload.
checksumMismatch Boolean Indicate if the checksums of the AchievementUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AchievementUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AchievementUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AchievementUploadRegistry.
lastSyncFailure String Error message during sync of the AchievementUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AchievementUploadRegistry.
missingOnPrimary Boolean Indicate if the AchievementUploadRegistry is missing on primary.
modelRecordId Int ID of the AchievementUploadRegistry's model record.
retryAt Time Timestamp after which the AchievementUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AchievementUploadRegistry.
state RegistryState Sync state of the AchievementUploadRegistry.
verificationChecksum String The local checksum of the AchievementUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AchievementUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AchievementUploadRegistry.
verificationRetryAt Time Timestamp after which the AchievementUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AchievementUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AchievementUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AchievementUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AchievementUploadRegistry.

AchievementUploadRegistryConnection#

Paginated collection of AchievementUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ActiveTrial#

Active trial information.

Fields#

Name Type Description
endDate ISO8601Date Trial end date.
startDate ISO8601Date Trial start date.

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.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
addOnAssignments UserAddOnAssignmentConnection Introduced as an experiment in GitLab 16.4.

Add-on purchase assignments for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for addOnAssignments:
addOnPurchaseIds ([GitlabSubscriptionsAddOnPurchaseID!]!)
Global IDs of the add on purchases to find assignments for.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
lastDuoActivityOn Date Date of the last Duo activity of the user. Refreshed on any GitLab Duo activity.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

AddOnUserConnection#

Paginated collection of AddOnUser. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AdminDuoAvailabilityLockedAncestor#

The ancestor group that introduced an admin-locked GitLab Duo availability override.

Fields#

Name Type Description
fullPath String! Full path of the locking ancestor group.
id GroupID! Global ID of the locking ancestor group.

AdminDuoAvailabilityLockedAncestorConnection#

Paginated collection of AdminDuoAvailabilityLockedAncestor. See Standard connection fields for the fields available on every connection.

AdminDuoAvailabilityNamespace#

A group with its resolved GitLab Duo availability, for the admin override list.

Fields#

Name Type Description
adminLocked Boolean! Whether this group is the introducer of an admin-locked override. False on descendants that merely inherit a locking value.
duoAvailability DuoAvailability! Effective GitLab Duo availability: the group own override if set, otherwise the inherited value.
fullPath String! Full path of the group.
id GroupID! Global ID of the group.
inheritedValue DuoAvailability! GitLab Duo availability the group resolves to from its nearest ancestor override, or the instance default, ignoring the group own override.
lockedByAncestor AdminDuoAvailabilityLockedAncestor Nearest strict ancestor that introduced an admin lock, or null when the group is not locked by an ancestor.
name String! Name of the group.

AdminDuoAvailabilityNamespaceConnection#

Paginated collection of AdminDuoAvailabilityNamespace. See Standard connection fields for the fields available on every connection.

AdminMemberRole#

Represents an admin member role.

Implements: CustomRoleInterface, RoleInterface

Fields#

Name Type Description
createdAt Time! Timestamp of when the member role was created.
description String Role description.
detailsPath String Introduced as an experiment in GitLab 17.4.

URL path to the role details webpage.
editPath String! Introduced as an experiment in GitLab 16.11.

Web UI path to edit the custom role.
enabledPermissions CustomizableAdminPermissionConnection! Introduced as an experiment in GitLab 17.7.

Array of all permissions enabled for the custom role. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Role ID.
ldapAdminRoleLinks LdapAdminRoleLinkConnection Introduced as an experiment in GitLab 18.1.

LDAP admin role sync configurations that will assign the admin member role. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Role name.
usersCount Int Introduced as an experiment in GitLab 17.5.

Number of users who have been directly assigned the admin member role.

AdminMemberRoleConnection#

Paginated collection of AdminMemberRole. See Standard connection fields for the fields available on every connection.

AgentConfiguration#

Configuration details for an Agent.

Fields#

Name Type Description
agentName String Name of the agent.

AgentConfigurationConnection#

Paginated collection of AgentConfiguration. See Standard connection fields for the fields available on every connection.

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.

AgentPlatformFlowMetric#

Agent platform aggregated metrics by flow type.

Fields#

Name Type Description
completionRate Float Completion rate as a percentage.
flowType String! Type of the flow.
medianExecutionTime Float Median flow execution time in seconds.
sessionsCount Int! Total number of sessions, equivalent to the count of the agent_platform_session_created event.
usersCount Int! Number of unique users.

AgentPlatformSessionsAggregationResponse#

Response for AgentPlatformSessions aggregation engine.

Fields#

Name Type Description
completionRate Float Session completion rate.
dimensions AgentPlatformSessionsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
duration AgentPlatformSessionsAggregationResponseDurationMetrics Aggregated duration metrics.
durationQuantile Float Session duration quantile in seconds.

Arguments for durationQuantile:
quantile (Float)
featuresCount Int Number of unique features (flow types).
finishedCount Int Number of finished sessions.
meanDuration Float Average session duration in seconds.
totalCount Int Total number of sessions.
usersCount Int Number of unique users.

AgentPlatformSessionsAggregationResponseConnection#

Paginated collection of AgentPlatformSessionsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

AgentPlatformSessionsAggregationResponseDimensions#

Response dimensions for AgentPlatformSessions aggregation engine.

Fields#

Name Type Description
createdEventAt Date Session creation date.

Arguments for createdEventAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
flowType String Type of session.
project Project Project the session ran in.
user UserCore Session owner.

AgentPlatformSessionsAggregationResponseDurationMetrics#

Aggregated duration metrics for AgentPlatformSessions aggregation engine.

Fields#

Name Type Description
max Int Maximum session duration in seconds.
mean Float Mean session duration in seconds.
min Int Minimum session duration in seconds.
quantile Float Quantile of session duration in seconds.

Arguments for quantile:
quantile (Float)
sum Float Sum of session duration in seconds.

AgentPlatformSessionsAggregationScope#

Aggregation scope for AgentPlatformSessions. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated AgentPlatformSessionsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
featuresCountFrom (Int)
Filter by the number of unique features. The features_count metric must also be requested when using this filter. Start of the range.
featuresCountTo (Int)
Filter by the number of unique features. The features_count metric must also be requested when using this filter. End of the range.
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

AgentPlatformUserFlowCount#

Agent platform flow counts aggergated per user.

Fields#

Name Type Description
flowType String! Type of the flow.
sessionsCount Int! Total number of flow sessions.
user UserCore User who triggered the flow.

AgentPlatformUserFlowCountConnection#

Paginated collection of AgentPlatformUserFlowCount. See Standard connection fields for the fields available on every connection.

AgentVersionWarning#

Version-related warning for a connected Agent.

Fields#

Name Type Description
message String Warning message related to the version.
type String Warning type related to the version.

AgentWarning#

Warning object for a connected Agent.

Fields#

Name Type Description
version AgentVersionWarning Agent warning related to the version.

AggregationStatus#

Fields#

Name Type Description
enabled Boolean! Whether background aggregation is enabled or disabled. For downgraded, non-licensed groups and projects the field is false.
estimatedNextUpdateAt Time Estimated time when the next incremental update will happen.
lastUpdateAt Time Last incremental update time.

AiAdditionalContext#

Additional context for AI message.

Fields#

Name Type Description
category AiAdditionalContextCategory! Category of the additional context.
content String! Content of the additional context.
id ID! ID of the additional context.
metadata JSON Metadata of the additional context.

AiAuditEvent#

Audit event recorded for a GitLab Duo Agent Platform session.

Fields#

Name Type Description
author UserCore User who triggered the audit event.
createdAt Time! Timestamp of when the audit event was created.
details JSON Event-specific details payload.
eventName String Name of the audit event.
humanAuthor UserCore Human user on whose behalf the audit event was triggered, present only for composite-identity sessions where a service account acts on behalf of a human.
id ID! ID of the audit event.
ipAddress String IP address recorded for the audit event.
sessionId AiGovernanceSessionID Global ID of the AI governance session the event belongs to.
workflowId ID ID of the Duo Agent Platform session the event belongs to. Null for events from external agents.

AiAuditEventConnection#

Paginated collection of AiAuditEvent. See Standard connection fields for the fields available on every connection.

AiCatalogAgent#

An AI catalog agent.

Implements: AiCatalogItem

Fields#

Name Type Description
configurationForGroup AiCatalogItemConsumer Introduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProject AiCatalogItemConsumer Introduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAt Time! Timestamp of when the item was created.
description String! Description of the item.
descriptionHtml String GitLab Flavored Markdown rendering of description.
effectiveVersion AiCatalogItemVersion Introduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundational Boolean! Whether the item is a foundational item.
foundationalAgentReference String Introduced as an experiment in GitLab 19.2.

Foundational agent reference.
foundationalFlowReference String Foundational flow reference.
id ID! ID of the item.
isEnabledInManagedByProject Boolean! Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemType AiCatalogItemType! Type of the item.
last30DayUsageCount Int! Number of projects using the item in the last 30 days.
latestVersion AiCatalogItemVersion Latest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
name String! Name of the item.
project Project Project for the item.
public Boolean! Deprecated in GitLab 19.3. Use visibility.
softDeleted Boolean Indicates if the item has been soft deleted.
softDeletedAt Time Timestamp of when the item was soft deleted.
starCount Int! Number of stars for the item.
starred Boolean! Whether the current user has starred the item.
updatedAt Time! Timestamp of when the item was updated.
userPermissions AiCatalogItemPermissions! Permissions for the current user on the resource.
verificationLevel AiCatalogItemVerificationLevel! Verification level of the item.
versions AiCatalogItemVersionConnection Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibility AiCatalogItemVisibility! Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPath String Introduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogAgentVersion#

An AI catalog agent version.

Implements: AiCatalogItemVersion

Fields#

Name Type Description
createdAt Time! Timestamp of when the item version was created.
createdBy UserCore User that created the item version.
deprecated Boolean! Indicates the item version has been deprecated by the author.
humanVersionName String Human-friendly name of the item version. In the form v1.0.0-draft.
id ID! ID of the item version.
item AiCatalogItem! Item the version belongs to.
mcpServers AiCatalogMcpServerConnection Introduced as an experiment in GitLab 18.10.

MCP servers associated with the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
mcpTools [String!] Introduced as an experiment in GitLab 18.11.

List of MCP tools enabled for the agent.
released Boolean! Indicates the item version is released.
releasedAt Time Timestamp of when the item version was released.
systemPrompt String System prompt for the agent.
tools AiCatalogBuiltInToolConnection! List of GitLab tools enabled for the agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp of when the item version was updated.
userPrompt String User prompt for the agent.
versionName String Version name of the item version.

AiCatalogBuiltInTool#

An AI catalog built-in tool.

Fields#

Name Type Description
description String! Description of the built-in tool.
id AiCatalogBuiltInToolID! Global ID of the built-in tool.
name String! Name of the built-in tool.
title String! Title of the built-in tool.

AiCatalogBuiltInToolConnection#

Paginated collection of AiCatalogBuiltInTool. See Standard connection fields for the fields available on every connection.

AiCatalogCustomAndFoundationalItemConnection#

Paginated collection of AiCatalogCustomAndFoundationalItem. See Standard connection fields for the fields available on every connection.

AiCatalogFlow#

An AI catalog flow.

Implements: AiCatalogItem

Fields#

Name Type Description
acceptsTriggerGoal Boolean! Introduced as an experiment in GitLab 19.5.

Whether a flow trigger for the flow can carry a configured goal.
configurationForGroup AiCatalogItemConsumer Introduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProject AiCatalogItemConsumer Introduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAt Time! Timestamp of when the item was created.
description String! Description of the item.
descriptionHtml String GitLab Flavored Markdown rendering of description.
effectiveVersion AiCatalogItemVersion Introduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundational Boolean! Whether the item is a foundational item.
foundationalFlowReference String Foundational flow reference.
id ID! ID of the item.
isEnabledInManagedByProject Boolean! Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemType AiCatalogItemType! Type of the item.
last30DayUsageCount Int! Number of projects using the item in the last 30 days.
latestVersion AiCatalogItemVersion Latest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
name String! Name of the item.
project Project Project for the item.
public Boolean! Deprecated in GitLab 19.3. Use visibility.
softDeleted Boolean Indicates if the item has been soft deleted.
softDeletedAt Time Timestamp of when the item was soft deleted.
starCount Int! Number of stars for the item.
starred Boolean! Whether the current user has starred the item.
updatedAt Time! Timestamp of when the item was updated.
userPermissions AiCatalogItemPermissions! Permissions for the current user on the resource.
verificationLevel AiCatalogItemVerificationLevel! Verification level of the item.
versions AiCatalogItemVersionConnection Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibility AiCatalogItemVisibility! Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPath String Introduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogFlowVersion#

An AI catalog flow version.

Implements: AiCatalogItemVersion

Fields#

Name Type Description
createdAt Time! Timestamp of when the item version was created.
createdBy UserCore User that created the item version.
definition String YAML definition of the flow.
deprecated Boolean! Indicates the item version has been deprecated by the author.
humanVersionName String Human-friendly name of the item version. In the form v1.0.0-draft.
id ID! ID of the item version.
item AiCatalogItem! Item the version belongs to.
released Boolean! Indicates the item version is released.
releasedAt Time Timestamp of when the item version was released.
updatedAt Time! Timestamp of when the item version was updated.
versionName String Version name of the item version.

AiCatalogItemConnection#

Paginated collection of AiCatalogItem. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogItemConsumer#

An AI catalog item configuration.

Fields#

Name Type Description
consumerKind AiCatalogItemConsumerKind! Type of configured catalog item.
enabled Boolean Indicates if the configuration item is enabled.
flowTrigger AiFlowTriggerType Deprecated in GitLab 19.4. Use flowTriggers.
flowTriggers [AiFlowTriggerType!] Introduced as an experiment in GitLab 19.4.

Triggers associated with the configured catalog item.
group Group Group in which the catalog item is configured.
id ID! ID of the configuration item.
item AiCatalogItem Configuration catalog item.
organization Organization Organization in which the catalog item is configured.
parentItemConsumer AiCatalogItemConsumer Parent item consumer associated with the configured catalog item.
pinnedItemVersion AiCatalogItemVersion Resolved item version according to the pinnedVersionPrefix.This field can only be resolved for 20 AiCatalogItemConsumers in any single request.
pinnedVersionPrefix AiCatalogPinnedVersion Version the item is pinned to, in the format n.n.n.
project Project Project in which the catalog item is configured.
serviceAccount UserCore Service account associated with the item consumer.
userPermissions AiCatalogItemConsumerPermissions! Permissions for the current user on the resource.
webPath String Web path of the catalog item consumer configuration page.

AiCatalogItemConsumerConnection#

Paginated collection of AiCatalogItemConsumer. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogItemConsumerPermissions#

Check permissions for the current user on an AI catalog item consumer.

Fields#

Name Type Description
adminAiCatalogItemConsumer Boolean! If true, the user can perform admin_ai_catalog_item_consumer on this resource.
executeAiCatalogItem Boolean! If true, the user can perform execute_ai_catalog_item on this resource.
readAiCatalogItemConsumer Boolean! If true, the user can perform read_ai_catalog_item_consumer on this resource.

AiCatalogItemPermissions#

Check permissions for the current user on an AI catalog item.

Fields#

Name Type Description
adminAiCatalogItem Boolean! If true, the user can perform admin_ai_catalog_item on this resource.
forceHardDeleteAiCatalogItem Boolean! If true, the user can perform force_hard_delete_ai_catalog_item on this resource.
readAiCatalogItem Boolean! If true, the user can perform read_ai_catalog_item on this resource.
reportAiCatalogItem Boolean! If true, the user can perform report_ai_catalog_item on this resource.

AiCatalogItemVersionConnection#

Paginated collection of AiCatalogItemVersion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiCatalogMcpServer#

An MCP (Model Context Protocol) server.

Fields#

Name Type Description
authType AiCatalogMcpServerAuthType! Authentication type for the MCP server.
blockStatus AiCatalogMcpServerBlockStatus! Block status of the MCP server for the given group or project (kill-switch state). Provide exactly one of groupFullPath or projectFullPath.

Arguments for blockStatus:
groupFullPath (ID)
Full path of the group to resolve the block status for.
projectFullPath (ID)
Full path of the project to resolve the block status for.
createdAt Time! Timestamp when the MCP server was created.
currentUserConnected Boolean! Whether the current user has connected to the MCP server.
description String Description of the MCP server.
homepageUrl String Homepage URL of the MCP server.
id ID! ID of the MCP server.
name String! Name of the MCP server.
oauthClientId String OAuth client ID for the MCP server.
organization Organization! Organization that owns the MCP server.
transport AiCatalogMcpServerTransport! Transport type for the MCP server.
updatedAt Time! Timestamp when the MCP server was last updated.
url String! URL of the MCP server.

AiCatalogMcpServerConnection#

Paginated collection of AiCatalogMcpServer. See Standard connection fields for the fields available on every connection.

AiCatalogMcpTool#

An MCP tool dynamically discovered from the GitLab MCP server.

Fields#

Name Type Description
description String Description of the MCP tool.
icons [AiCatalogMcpToolIcon!]! Icons advertised for the MCP tool, per the MCP spec icons field.
name ID! Machine-readable name of the MCP tool.
title String! Human-readable title of the MCP tool.

AiCatalogMcpToolConnection#

Paginated collection of AiCatalogMcpTool. See Standard connection fields for the fields available on every connection.

AiCatalogMcpToolIcon#

An icon advertised for an MCP tool, per the MCP spec icons field.

Fields#

Name Type Description
mimeType String! MIME type of the icon image.
src String! URL to the icon image.
theme String Theme the icon is intended for: "light" or "dark".

AiCatalogSkill#

An AI catalog skill. The repository pointer fields resolve against the latest item version.

Implements: AiCatalogItem

Fields#

Name Type Description
authorName String Introduced as an experiment in GitLab 19.5.

Git author name of the commit that last changed the published SKILL.md.
blobSha String Introduced as an experiment in GitLab 19.5.

Git object ID of the published SKILL.md blob.
commitSha String Introduced as an experiment in GitLab 19.5.

Commit that last changed the published SKILL.md.
configurationForGroup AiCatalogItemConsumer Introduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProject AiCatalogItemConsumer Introduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAt Time! Timestamp of when the item was created.
description String! Description of the item.
descriptionHtml String GitLab Flavored Markdown rendering of description.
directory String Introduced as an experiment in GitLab 19.5.

Directory of the skill. Co-located resources live alongside SKILL.md.
effectiveVersion AiCatalogItemVersion Introduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundational Boolean! Whether the item is a foundational item.
foundationalFlowReference String Foundational flow reference.
gitRef String Introduced as an experiment in GitLab 19.5.

Git reference the skill was published from.
id ID! ID of the item.
isEnabledInManagedByProject Boolean! Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemType AiCatalogItemType! Type of the item.
last30DayUsageCount Int! Number of projects using the item in the last 30 days.
latestVersion AiCatalogItemVersion Latest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
name String! Name of the item.
path String Introduced as an experiment in GitLab 19.5.

Path of the SKILL.md file in the project repository.
project Project Project for the item.
public Boolean! Deprecated in GitLab 19.3. Use visibility.
softDeleted Boolean Indicates if the item has been soft deleted.
softDeletedAt Time Timestamp of when the item was soft deleted.
starCount Int! Number of stars for the item.
starred Boolean! Whether the current user has starred the item.
updatedAt Time! Timestamp of when the item was updated.
userPermissions AiCatalogItemPermissions! Permissions for the current user on the resource.
verificationLevel AiCatalogItemVerificationLevel! Verification level of the item.
versions AiCatalogItemVersionConnection Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibility AiCatalogItemVisibility! Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPath String Introduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogSkillVersion#

An AI catalog skill version.

Implements: AiCatalogItemVersion

Fields#

Name Type Description
authorName String Introduced as an experiment in GitLab 19.5.

Git author name of the commit that last changed SKILL.md for the item version.
blobSha String Introduced as an experiment in GitLab 19.5.

Git object ID of the SKILL.md blob for the item version.
commitSha String Introduced as an experiment in GitLab 19.5.

Commit that last changed SKILL.md for the item version.
createdAt Time! Timestamp of when the item version was created.
createdBy UserCore User that created the item version.
deprecated Boolean! Indicates the item version has been deprecated by the author.
gitRef String Introduced as an experiment in GitLab 19.5.

Git reference the skill version was published from.
humanVersionName String Human-friendly name of the item version. In the form v1.0.0-draft.
id ID! ID of the item version.
item AiCatalogItem! Item the version belongs to.
path String Introduced as an experiment in GitLab 19.5.

Path of the SKILL.md file in the project repository.
released Boolean! Indicates the item version is released.
releasedAt Time Timestamp of when the item version was released.
updatedAt Time! Timestamp of when the item version was updated.
versionName String Version name of the item version.

AiCatalogThirdPartyFlow#

An AI catalog third party flow.

Implements: AiCatalogItem

Fields#

Name Type Description
acceptsTriggerGoal Boolean! Introduced as an experiment in GitLab 19.5.

Whether a flow trigger for the flow can carry a configured goal.
configurationForGroup AiCatalogItemConsumer Introduced as an experiment in GitLab 18.7.

Item configuration for the given group.

Arguments for configurationForGroup:
groupId (GroupID!)
Global ID of the group to return the item configuration of.
configurationForProject AiCatalogItemConsumer Introduced as an experiment in GitLab 18.6.

Item configuration for the given project.

Arguments for configurationForProject:
projectId (ProjectID!)
Global ID of the project to return the item configuration of.
createdAt Time! Timestamp of when the item was created.
description String! Description of the item.
descriptionHtml String GitLab Flavored Markdown rendering of description.
effectiveVersion AiCatalogItemVersion Introduced as an experiment in GitLab 19.3.

Version of the item in effect for the given namespace, falling back to the latest version when none is in effect. In a project namespace, resolves to the project configuration pinned version when enabled, otherwise the latest version. In a group namespace, resolves to the group configuration pinned version when enabled, otherwise the latest version. In the global namespace, always resolves to the latest version.

Arguments for effectiveVersion:
groupId (GroupID)
Global ID of the group to return the effective version for.
projectId (ProjectID)
Global ID of the project to return the effective version for.
foundational Boolean! Whether the item is a foundational item.
foundationalFlowReference String Foundational flow reference.
id ID! ID of the item.
isEnabledInManagedByProject Boolean! Whether the item is enabled in the project it is managed by. This field can only be resolved for one AiCatalogItem in any single request.
itemType AiCatalogItemType! Type of the item.
last30DayUsageCount Int! Number of projects using the item in the last 30 days.
latestVersion AiCatalogItemVersion Latest version of the item.

Arguments for latestVersion:
released (Boolean)
Return the latest released version.
name String! Name of the item.
project Project Project for the item.
public Boolean! Deprecated in GitLab 19.3. Use visibility.
softDeleted Boolean Indicates if the item has been soft deleted.
softDeletedAt Time Timestamp of when the item was soft deleted.
starCount Int! Number of stars for the item.
starred Boolean! Whether the current user has starred the item.
updatedAt Time! Timestamp of when the item was updated.
userPermissions AiCatalogItemPermissions! Permissions for the current user on the resource.
verificationLevel AiCatalogItemVerificationLevel! Verification level of the item.
versions AiCatalogItemVersionConnection Versions of the item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
visibility AiCatalogItemVisibility! Introduced as an experiment in GitLab 19.2.

Visibility of the item in the catalog.
webPath String Introduced as an experiment in GitLab 19.4.

Web path of the item in the AI catalog.

AiCatalogThirdPartyFlowVersion#

An AI catalog third party flow version.

Implements: AiCatalogItemVersion

Fields#

Name Type Description
createdAt Time! Timestamp of when the item version was created.
createdBy UserCore User that created the item version.
definition String! YAML definition of the third party flow.
deprecated Boolean! Indicates the item version has been deprecated by the author.
humanVersionName String Human-friendly name of the item version. In the form v1.0.0-draft.
id ID! ID of the item version.
item AiCatalogItem! Item the version belongs to.
released Boolean! Indicates the item version is released.
releasedAt Time Timestamp of when the item version was released.
updatedAt Time! Timestamp of when the item version was updated.
versionName String Version name of the item version.

AiChatQuestionCategory#

Category of suggested questions for GitLab Duo Chat.

Fields#

Name Type Description
contextual Boolean! Indicates whether the questions are about the resource on the current page. At most one category is contextual, and the agent category, when present, is returned before it.
key String! Stable identifier of the category. agent for the agent category, the current page type for contextual categories, for example merge_request or blob, and the topic for static ones, for example security.
questions [String!]! Suggested questions in the category.
title String! Display title of the category, for example the name of the selected agent or the reference of the current resource.

AiConversationsThread#

Conversation thread of the AI feature.

Fields#

Name Type Description
conversationType AiConversationsThreadsConversationType! Conversation type of the thread.
createdAt Time! Created date of the thread.
id ID! ID of the thread.
lastUpdatedAt Time! Last updated date of the thread.
title String Title of the thread.

AiConversationsThreadConnection#

Paginated collection of AiConversationsThread. See Standard connection fields for the fields available on every connection.

AiFeatureSetting#

Duo Chat feature setting.

Fields#

Name Type Description
allowList AiModelSelectionAllowList Introduced as an experiment in GitLab 19.1.

Model selection allowlist for the feature. Returns null when the current user cannot read the allowlist or when the feature does not support one.
compatibleLlms [String!] LLMs Compatible with the feature.
defaultGitlabModel AiModelSelectionOfferedModel GitLab model selected for use with the AI feature.
feature String! Identifier for the AI feature.
gitlabModel AiModelSelectionOfferedModel GitLab model selected for use with the AI feature.
mainFeature String Displayed name of the main feature.
provider String! Humanized name for the AI feature, e.g "Code Completion".
releaseState String Current release state of the feature.
selfHostedModel AiSelfHostedModel Self-hosted model selected for use with the AI feature.
title String Displayed AI feature name.
validGitlabModels AiModelSelectionOfferedModelConnection! Valid GitLab managed models for the feature. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
validModels AiSelfHostedModelConnection! Compatible self-hosted models for the feature. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

AiFeatureSettingConnection#

Paginated collection of AiFeatureSetting. See Standard connection fields for the fields available on every connection.

AiFlowCapability#

A capability the instance advertises for Duo Agent Platform flows.

Fields#

Name Type Description
metadata JSON Arbitrary JSON-encoded metadata associated with the capability.
name String! Name of the capability.

AiFlowScheduleLastRun#

Details of the most recent execution attempt of a flow schedule.

Fields#

Name Type Description
error String Error message from the most recent failed execution.
ranAt Time Timestamp of the most recent execution attempt.
status String Status of the most recent execution attempt.

AiFlowScheduleType#

Represents a cron-based schedule for an AI flow trigger.

Fields#

Name Type Description
active Boolean! Indicates the schedule is active.
consecutiveFailureCount Int! Number of consecutive execution failures.
createdAt Time! Timestamp of when the flow schedule was created.
cron String! Cron expression defining the schedule frequency.
cronTimezone String! IANA timezone for the cron expression.
description String! Description of the flow schedule.
flowTrigger AiFlowTriggerType! Flow trigger the schedule executes.
id AiFlowScheduleID! Global ID of the flow schedule.
lastRun AiFlowScheduleLastRun Details of the most recent execution attempt, or null if the schedule has never run.
nextRunAt Time Timestamp of the next scheduled execution.
project Project! Project of the flow schedule.
updatedAt Time! Timestamp of when the flow schedule was last updated.

AiFlowScheduleTypeConnection#

Paginated collection of AiFlowScheduleType. See Standard connection fields for the fields available on every connection.

AiFlowTriggerType#

Represents an AI flow trigger.

Fields#

Name Type Description
active Boolean! Introduced as an experiment in GitLab 19.4.

Indicates whether the flow trigger is active. Inactive triggers do not run automatically.
aiCatalogItemConsumer AiCatalogItemConsumer AI catalog item consumer associated with the trigger.
configPath String Path to the configuration file for the trigger.
configUrl String Web URL to the configuration file for the trigger.
createdAt Time! Timestamp of when the flow trigger was created.
description String! Description of the flow trigger.
eventTypes [Int!]! List of events that triggers the flow.
filter JSON Introduced as an experiment in GitLab 18.11.

Filter conditions for the AI flow trigger.
flowSchedules AiFlowScheduleTypeConnection Introduced as an experiment in GitLab 19.4.

Cron-based schedules associated with the flow trigger. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
goals JSON! Introduced as an experiment in GitLab 19.5.

Goals for the AI flow trigger, keyed by event type.
id ID! ID of the flow trigger.
precondition JSON Introduced as an experiment in GitLab 18.11.

Enforced filter conditions from the foundational flow definition.
project Project! Project of the flow trigger.
updatedAt Time! Timestamp of when the flow trigger was last updated.
user UserCore Service account of the flow trigger.

AiFlowTriggerTypeConnection#

Paginated collection of AiFlowTriggerType. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiFlowsMetadata#

Metadata describing Duo Agent Platform flow capabilities available to the caller.

Fields#

Name Type Description
capabilities [AiFlowCapability!]! List of capabilities the instance advertises for Duo Agent Platform flows.

AiFoundationalChatAgent#

Core Agent available for GitLab features.

Fields#

Name Type Description
avatarUrl String Avatar URL of the foundational chat agent.
description String! Description of the agent.
flowConfig AiFoundationalChatAgentFlowConfig Flow versioning parameters used when starting a workflow for this agent. Null for agents that resolve versioning elsewhere (e.g. AI Catalog-backed agents).
id AiFoundationalChatAgentID! Global ID of the foundational chat agent.
name String! Name of the agent.
reference String! Reference ID of the agent.
referenceWithVersion String Versioned reference of the agent.
selectableInChat Boolean! Whether the agent is selectable in the chat agent selection UI.
systemPrompt String System prompt for the agent.
tools [AiCatalogBuiltInTool!]! List of built-in tools enabled for the agent.
version String Version of the agent.
visibility AiCatalogItemVisibility! Visibility of the agent in the catalog.

AiFoundationalChatAgentConnection#

Paginated collection of AiFoundationalChatAgent. See Standard connection fields for the fields available on every connection.

AiFoundationalChatAgentFlowConfig#

Flow versioning parameters for a foundational chat agent.

Fields#

Name Type Description
flowConfigId String Flow config ID sent to the Duo Workflow Service.
flowConfigSchemaVersion String Flow config schema version sent to the Duo Workflow Service.
flowVersion String Flow version sent to the Duo Workflow Service.

AiGovernanceConnectedAgent#

Registered external agents of one type, with their session activity.

Fields#

Name Type Description
activeCount Int! Registered machines whose identity has not been revoked.
agentType String! External agent type, for example claude-code.
identityCount Int! Registered machines of the agent type, revoked ones included.
lastSessionAt Time When a machine of the agent type last opened a session, across all time.
revokedCount Int! Registered machines whose identity was revoked.
sessionCount Int! Sessions opened by these machines in the selected timeframe.
userCount Int! Distinct users with a registered machine of the agent type.

AiGovernanceKpi#

Aggregated KPI for the AI governance dashboard.

Fields#

Name Type Description
count Int Count in the selected timeframe.
cumulativeTrend [AiGovernanceKpiTrendPoint!] Introduced as an experiment in GitLab 19.4.

Running totals across the selected timeframe: each bucket is the total as of the end of that bucket, seeded with the 30 days before the timeframe. Agents count from the bucket of their first session in that period onward, so the series is monotonic and its last point can exceed count.
previousCount Int Count in the preceding timeframe of equal length.
trend [AiGovernanceKpiTrendPoint!] Bucketed counts across the selected timeframe. Each bucket is computed independently, so for distinct-count KPIs such as agents the buckets do not sum to count: an agent active on several days is counted once per day here and once in the total.

AiGovernanceKpiTrendPoint#

Single bucket of an AI governance KPI trend series.

Fields#

Name Type Description
bucketStart Time! Timestamp of the start of the bucket.
count Int! Count of items in the bucket.

AiGovernanceMetrics#

Aggregated AI governance dashboard metrics.

Fields#

Name Type Description
agents AiGovernanceKpi Distinct AI agent instances with sessions in the timeframe. Chat conversations are not counted.
connectedAgents [AiGovernanceConnectedAgent!] Registered external (Connected) agents by type, ordered by registered machines. Empty when agentClass is INTERNAL_DAP.

Arguments for connectedAgents:
limit (Int)
Number of agent types to return. Defaults to 5, maximum 20.
sessionDistribution AiGovernanceSessionDistribution Introduced as an experiment in GitLab 19.5.

Sessions and distinct developers in the timeframe, split by agent or flow type. Empty when ClickHouse is not enabled for analytics. Returns null when the ai_governance_dashboard_charts feature flag is disabled.
sessions AiGovernanceKpi AI sessions in the timeframe, including Duo Chat conversations.
toolCalls AiGovernanceKpi Introduced as an experiment in GitLab 19.5.

Tools invoked by AI agents in the timeframe. Counts every invocation, not distinct tools. Returns null when the ai_governance_tool_calls feature flag is disabled or when ClickHouse is not enabled.
topProjects [AiGovernanceProjectActivity!] Projects with the most AI sessions in the timeframe, ordered by session count. Sessions attached to a namespace rather than a project are not counted.

Arguments for topProjects:
limit (Int)
Number of projects to return. Defaults to 5, maximum 20.
topUsers [AiGovernanceUserActivity!] Users with the most AI sessions in the timeframe, ordered by session count.

Arguments for topUsers:
limit (Int)
Number of users to return. Defaults to 5, maximum 20.

AiGovernanceProjectActivity#

AI session activity in a single project.

Fields#

Name Type Description
project Project Project the sessions ran in. Resolves to null when the current user cannot read the project.
sessionCount Int Number of AI sessions in the project in the selected timeframe.

AiGovernanceSession#

AI session recorded for AI governance, from GitLab Duo or an external agent.

Fields#

Name Type Description
agentType String Type of the agent that ran the session, for example claude-code. Values differ between sources.
auditEvents AiAuditEventConnection Audit events recorded for the session. Returns no events for GitLab Duo sessions delivered through a private messaging integration. This field can only be resolved for one session in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
auditEventsCount Int Number of audit events recorded for the session.
downloadPath String Path to download the session artifact as a JSON file. Null for sessions from sources other than GitLab Duo.
flowType String Flow type of the session, for example chat. Values differ between sources.
id AiGovernanceSessionID! Global ID of the session.
project Project Project the session belongs to. Null for namespace-scoped sessions, or when the current user cannot read the project.
sessionId String ID of the session in its source. For GitLab Duo sessions, the Duo workflow ID. For other sources, the session ID from the external agent.
sessionStartedAt Time! Timestamp of when the session started.
source AiGovernanceSessionSource! Source that recorded the session.
triggeredBy UserCore User who initiated the session.
webPath String Path of the session page. Null for sessions from sources other than GitLab Duo, and for GitLab Duo sessions without a project.

AiGovernanceSessionConnection#

Paginated collection of AiGovernanceSession. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

AiGovernanceSessionDistribution#

AI sessions and developers in the timeframe, split by agent or flow type.

Fields#

Name Type Description
slices [AiGovernanceSessionDistributionSlice!]! Slices ordered by developers, then sessions, then name. Returns the top 10. Missing names are reported as unknown.
totalDevelopers Int! Number of distinct developers with sessions in the timeframe, across all slices.
totalSessions Int! Number of sessions in the timeframe, across all slices.

AiGovernanceSessionDistributionSlice#

AI sessions and developers for one agent or flow type.

Fields#

Name Type Description
developers Int! Number of distinct developers with sessions in the slice.
name String! Name of the slice. Version-less flow type for INTERNAL_DAP, agent type for EXTERNAL. For ALL, gitlab_duo for GitLab Duo sessions and agent type for external sessions.
sessions Int! Number of sessions in the slice.

AiGovernanceToolCall#

AI agent tool usage aggregated for the AI governance dashboard.

Fields#

Name Type Description
count Int! Number of tool invocations in the selected timeframe.
toolName String! Name of the tool.

AiGovernanceToolCallsByRisk#

AI agent tool calls grouped by risk level.

Fields#

Name Type Description
approximate Boolean! Whether the counts leave out some tools because the namespace used more distinct tools than are read.
slices [AiGovernanceToolCallsRiskSlice!]! Tool calls per risk level, in the order READ, WRITE, DESTROY, UNCLASSIFIED. Risk levels with no calls have a count of zero.
total Int! Total number of tool invocations in the selected timeframe.

AiGovernanceToolCallsReport#

Top tools invoked by AI agents, with a flag marking approximate counts.

Fields#

Name Type Description
approximate Boolean! Indicates whether counts were capped and are approximate.
byRisk AiGovernanceToolCallsByRisk Introduced as an experiment in GitLab 19.5.

Tool calls grouped by risk level. Computed only when selected.
nodes [AiGovernanceToolCall!]! Tools invoked in the selected timeframe, ordered by invocation count.

AiGovernanceToolCallsRiskSlice#

Number of AI agent tool calls at one risk level.

Fields#

Name Type Description
count Int! Number of tool invocations at the risk level in the selected timeframe.
risk AiGovernanceToolRisk! Risk level of the tools.

AiGovernanceUserActivity#

AI session activity of a single user.

Fields#

Name Type Description
sessionCount Int Number of AI sessions the user started in the selected timeframe.
user UserCore User the sessions belong to.

AiInstanceUsageData#

Instance wide usage data for events stored in either PostgreSQL (default) or ClickHouse (when configured). Data retention: three months in PostgreSQL, indefinite in ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
all AiInstanceUsageEventConnection All Duo usage events. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for all:
endDate (Date)
End date for the date range. Default is the current day.
events ([AiUsageEventType!])
Filters by events.
startDate (Date)
Start date for the date range. Default is 7 days before the current date.
userIds ([UserID!])
Filters by users.

AiInstanceUsageEvent#

Fields#

Name Type Description
event AiUsageEventType! Type of the event.
extras JSON Associated event context data.
namespacePath String Namespace hierarchy for Namespace or ProjectNamespace associated with the event.
timestamp Time! When the event happened.
user UserCore! User associated with the event.

AiInstanceUsageEventConnection#

Paginated collection of AiInstanceUsageEvent. See Standard connection fields for the fields available on every connection.

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.
threadId AiConversationThreadID Global ID of the existing thread for the Chat conversation.
timestamp Time! Message creation timestamp.
type AiMessageType Message type.

AiMessageConnection#

Paginated collection of AiMessage. See Standard connection fields for the fields available on every connection.

AiMessageExtras#

Extra metadata for AI message.

Fields#

Name Type Description
additionalContext [AiAdditionalContext!] Additional context for the message.
hasFeedback Boolean Whether the user has provided feedback for the message.
sources [JSON!] Sources used to form the message.

AiMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
agentPlatform agentPlatformMetrics Duo Agent Platform metrics.

Arguments for agentPlatform:
flowTypes ([String!])
List of flow types to filter.
not (AgentPlatformMetricsNotInput)
Negation filters.
chat duoChatMetrics Duo Chat metrics.
codeContributorsCount Int Number of code contributors.
codeReview codeReviewMetrics Code review metrics.
codeSuggestions codeSuggestionMetrics Code suggestions metrics.

Arguments for codeSuggestions:
ideNames ([String!])
Filter code suggestion metrics by one or more IDE names.
languages ([String!])
Filter code suggestion metrics by one or more languages.
codeSuggestionsAcceptedCount Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
codeSuggestionsContributorsCount Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
codeSuggestionsShownCount Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
duoChatContributorsCount Int Number of contributors who used GitLab Duo Chat features.
duoUsedCount Int Number of contributors who used any GitLab Duo feature.
mcp mcpMetrics Model Context Protocol metrics.
rootCauseAnalysisUsersCount Int Number of users using troubleshoot within a failed pipeline.
troubleshoot troubleshootJobMetrics Troubleshoot job metrics.

AiModelSelectionAllowList#

Model selection allowlist for an AI feature.

Fields#

Name Type Description
enabled Boolean! Whether the model selection allowlist is enabled for the feature.
models AiModelSelectionAllowListModelConnection! All GitLab-managed models offered for the feature with their effective allowlist state. Includes both allowed and disallowed models so callers can render a complete allowlist UI. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

AiModelSelectionAllowListModel#

GitLab-managed model row in the model selection allowlist for a feature.

Fields#

Name Type Description
allowed Boolean! Whether the model is allowed for this feature under the effective allowlist. The currently chosen/default model for the feature is implicitly allowed and is therefore true even when the allowlist is enabled and the model is not in the stored allowlist refs.
costIndicator String Introduced as an experiment in GitLab 18.7.

Presentational cost indicator for model usage, e.g "$", "$$", "$$$".
currentlyChosenModelForFeature Boolean! Whether this model is the currently chosen/default model for the feature. This is the admin-chosen model when set, otherwise the GitLab default model from definitions.
modelDescription String Introduced as an experiment in GitLab 18.7.

Brief description of the model, e.g "Fast, cost-effective responses".
modelProvider String Introduced as an experiment in GitLab 18.6.

Provider for the model, e.g "OpenAI".
name String! Humanized name for the offered model, e.g "Chat GPT 4o".
ref String! Identifier for the offered model.

AiModelSelectionAllowListModelConnection#

Paginated collection of AiModelSelectionAllowListModel. See Standard connection fields for the fields available on every connection.

AiModelSelectionNamespaceFeatureSetting#

Model Selection feature setting for namespaces.

Fields#

Name Type Description
allowList AiModelSelectionAllowList Introduced as an experiment in GitLab 19.1.

Model selection allowlist for the feature. Returns null when the current user cannot read the allowlist or when the feature does not support one.
defaultModel AiModelSelectionOfferedModel LLMs Compatible with the feature.
feature String! Identifier for the AI feature.
mainFeature String Displayed name of the main feature.
namespace Group! Namespace that the feature setting is set for.
selectableModels [AiModelSelectionOfferedModel!]! LLMs Compatible with the feature.
selectedModel AiModelSelectionOfferedModel Identifier of the current model selected.
title String Displayed AI feature name.

AiModelSelectionNamespaceFeatureSettingConnection#

Paginated collection of AiModelSelectionNamespaceFeatureSetting. See Standard connection fields for the fields available on every connection.

AiModelSelectionOfferedModel#

Model offered for Model Selection.

Fields#

Name Type Description
costIndicator String Introduced as an experiment in GitLab 18.7.

Presentational cost indicator for model usage, e.g "$", "$$", "$$$".
modelDescription String Introduced as an experiment in GitLab 18.7.

Brief description of the model, e.g "Fast, cost-effective responses".
modelProvider String Introduced as an experiment in GitLab 18.6.

Provider for the model, e.g "OpenAI".
name String! Humanized name for the offered model, e.g "Chat GPT 4o".
ref String! Identifier for the offered model.
requiresPaidCredits Boolean Introduced as an experiment in GitLab 19.5.

Whether GitLab Credits must be purchased before the current user can use this model.

AiModelSelectionOfferedModelConnection#

Paginated collection of AiModelSelectionOfferedModel. See Standard connection fields for the fields available on every connection.

AiNamespaceSettings#

Fields#

Name Type Description
aiCatalogRestrictedToGroupHierarchy Boolean! Indicates whether the AI Catalog is restricted to items within the top-level group's hierarchy.
duoWorkflowMcpEnabled Boolean! Indicates whether the namespace has MCP enabled.
promptInjectionProtectionLevel PromptInjectionProtectionLevel! Level of prompt injection protection for the namespace.
webSearchEnabled Boolean! Indicates whether web search is allowed in GitLab Duo Chat for the namespace.

AiSelfHostedModel#

Self-hosted LLM servers.

Fields#

Name Type Description
apiToken String Optional API key for the self-hosted model server.
createdAt Time! Timestamp of creation.
endpoint String Endpoint of the self-hosted model server.
featureSettings AiFeatureSettingConnection AI feature settings using the self-hosted model. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
hasApiToken Boolean! Indicates if an API key is set for the self-hosted model server.
iamRole String IAM role ARN that the AI Gateway assumes when calling Amazon Bedrock.
id AiSelfHostedModelID! ID of the self-hosted model server.
identifier String Identifier for 3rd party model provider.
model String! AI model deployed.
modelDisplayName String! Display name of the AI model deployed.
name String! Deployment name of the self-hosted model.
provider AiSelfHostedModelProvider! Provider for the self-hosted model.
releaseState AiSelfHostedModelReleaseState! GitLab release status of the model.
updatedAt Time Timestamp of last update.

AiSelfHostedModelConnection#

Paginated collection of AiSelfHostedModel. See Standard connection fields for the fields available on every connection.

AiSuggestedReviewer#

AI-recommended reviewer for a merge request.

Fields#

Name Type Description
approvalRule ApprovalRule Approval rule the user was suggested as a reviewer for.
createdAt Time! Timestamp of when the suggestion was created.
id ID! ID of the suggested reviewer.
reason String Model rationale for recommending the user.
user UserCore User recommended as a reviewer.

AiSuggestedReviewerConnection#

Paginated collection of AiSuggestedReviewer. See Standard connection fields for the fields available on every connection.

AiToolRule#

A governance rule for an AI agent tool.

Fields#

Name Type Description
actionType AiToolActionType! Action type categorisation for the tool.
backgroundAccess AiBackgroundToolPermission Introduced as an experiment in GitLab 19.3.

Effective permission mode for the background-flow surface, after applying group and project rules and the default.
category String! Display category for the tool. For example, GitLab Read, Files, and Commands.
configuredAccess AiToolRuleAccess! Introduced as an experiment in GitLab 19.5.

Permission modes set at the requested scope: the project when a project path is given, otherwise the namespace. A null mode is not set at that scope.
defaultAccess AiToolRuleAccess! Introduced as an experiment in GitLab 19.5.

Permission modes that apply when no rule is set.
id ID! Tool name. Used as stable identifier. Always the tool name string and never a database ID.
localAccess AiToolPermission Effective permission mode for local or IDE surface, after applying group and project rules and the default.
name String! Name of the tool as registered in the tool registry.
source AiToolSource! Source of the tool. Either "gitlab" or "mcp".
webAccess AiToolPermission Effective permission mode for web surface, after applying group and project rules and the default.

AiToolRuleAccess#

Permission modes of an AI tool rule for each surface.

Fields#

Name Type Description
backgroundAccess AiBackgroundToolPermission Permission mode for the background-flow surface.
localAccess AiToolPermission Permission mode for the local or IDE surface.
webAccess AiToolPermission Permission mode for the web surface.

AiToolRuleConnection#

Paginated collection of AiToolRule. See Standard connection fields for the fields available on every connection.

AiUsageData#

Usage data for events stored in either PostgreSQL (default) or ClickHouse (when configured). Data retention: three months in PostgreSQL, indefinite in ClickHouse. Requires a personal access token. Works only on top-level groups. Premium and Ultimate only.

Fields#

Name Type Description
all AiUsageEventConnection All Duo usage events. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for all:
endDate (Date)
End date for the date range. Default is the current day.
events ([AiUsageEventType!])
Filters by events.
startDate (Date)
Start date for the date range. Default is 7 days before the current date.
userIds ([UserID!])
Filters by users.
codeSuggestionEvents CodeSuggestionEventConnection Events related to code suggestions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for codeSuggestionEvents:
endDate (Date)
End date for the date range. Default is the current day.
events ([AiUsageEventType!])
Filters by events.
startDate (Date)
Start date for the date range. Default is 7 days before the current date.
userIds ([UserID!])
Filters by users.

AiUsageEvent#

Fields#

Name Type Description
event AiUsageEventType! Type of the event.
timestamp Time! When the event happened.
user UserCore! User associated with the event.

AiUsageEventConnection#

Paginated collection of AiUsageEvent. See Standard connection fields for the fields available on every connection.

AiUserMetrics#

Pre-aggregated per-user metrics for GitLab Code Suggestions and GitLab Duo Chat. Requires ClickHouse to be enabled. Premium or Ultimate only.

Fields#

Name Type Description
agentPlatform agentPlatformUserMetrics Agent Platform metrics for the user.
aiCatalog aiCatalogUserMetrics Ai Catalog metrics for the user.
chat chatUserMetrics Chat metrics for the user.
codeReview codeReviewUserMetrics Code Review metrics for the user.
codeSuggestions codeSuggestionsUserMetrics Code Suggestions metrics for the user.
codeSuggestionsAcceptedCount Int Deprecated in GitLab 18.7. Use codeSuggestions.codeSuggestionAcceptedInIdeEventCount instead.
duoChatInteractionsCount Int Deprecated in GitLab 18.7. Use chat.requestDuoChatResponseEventCount instead.
duoMessaging duoMessagingUserMetrics Duo Messaging metrics for the user.
duoWorkflow duoWorkflowUserMetrics Duo Workflow metrics for the user.
explainCode explainCodeUserMetrics Explain Code metrics for the user.
explainVulnerability explainVulnerabilityUserMetrics Explain Vulnerability metrics for the user.
featureDiscovery featureDiscoveryUserMetrics Feature Discovery metrics for the user.
fixCode fixCodeUserMetrics Fix Code metrics for the user.
fixPipeline fixPipelineUserMetrics Fix Pipeline metrics for the user.
generateMergeCommitMessage generateMergeCommitMessageUserMetrics Generate Merge Commit Message metrics for the user.
lastDuoActivityOn Date Date of the last Duo activity across all features for the user.
mcp mcpUserMetrics Mcp metrics for the user.
refactorCode refactorCodeUserMetrics Refactor Code metrics for the user.
requestDuoVulnerabilityResolution requestDuoVulnerabilityResolutionUserMetrics Request Duo Vulnerability Resolution metrics for the user.
summarizeNewMergeRequest summarizeNewMergeRequestUserMetrics Summarize New Merge Request metrics for the user.
summarizeReview summarizeReviewUserMetrics Summarize Review metrics for the user.
totalEventCount Int Total count of all tracked events for the user.
troubleshootJob troubleshootJobUserMetrics Deprecated in GitLab 19.1. Legacy troubleshoot job metrics for the user (event ID 7 only). For current GitLab Duo Agent Platform-based troubleshoot jobs, use agentPlatformSessions with flow_type = 'fix_pipeline/v1'.
user AddOnUser User associated with metrics.
writeTests writeTestsUserMetrics Write Tests metrics for the user.

AiUserMetricsConnection#

Paginated collection of AiUserMetrics. See Standard connection fields for the fields available on every connection.

AiVectorizableFileUploadRegistry#

Represents the Geo replication and verification state of an ai_vectorizable_file_upload.

Fields#

Name Type Description
aiVectorizableFileUploadId ID! ID of the AI Vectorizable File Upload.
checksumMismatch Boolean Indicate if the checksums of the AiVectorizableFileUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AiVectorizableFileUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AiVectorizableFileUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AiVectorizableFileUploadRegistry.
lastSyncFailure String Error message during sync of the AiVectorizableFileUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AiVectorizableFileUploadRegistry.
missingOnPrimary Boolean Indicate if the AiVectorizableFileUploadRegistry is missing on primary.
modelRecordId Int ID of the AiVectorizableFileUploadRegistry's model record.
retryAt Time Timestamp after which the AiVectorizableFileUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AiVectorizableFileUploadRegistry.
state RegistryState Sync state of the AiVectorizableFileUploadRegistry.
verificationChecksum String The local checksum of the AiVectorizableFileUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AiVectorizableFileUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AiVectorizableFileUploadRegistry.
verificationRetryAt Time Timestamp after which the AiVectorizableFileUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AiVectorizableFileUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AiVectorizableFileUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AiVectorizableFileUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AiVectorizableFileUploadRegistry.

AiVectorizableFileUploadRegistryConnection#

Paginated collection of AiVectorizableFileUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

AiXrayReport#

Fields#

Name Type Description
language String! Language of the x-ray report.

AiXrayReportConnection#

Paginated collection of AiXrayReport. See Standard connection fields for the fields available on every connection.

AlertManagementAlert#

Describes an alert from the project's Alert Management.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
assignees UserCoreConnection Assignees of the alert. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
endedAt Time Timestamp the alert ended.
environment Environment Environment for the alert.
eventCount Int Number of events of the alert.
hosts [String!] List of hosts the alert came from.
id ID! ID of the alert.
iid String! Internal ID of the alert.
issue Issue Issue attached to the alert.
issueIid String Deprecated in GitLab 13.10. Use issue field.
metricsDashboardUrl String Deprecated in GitLab 16.0. Returns no data. Underlying feature was removed in 16.0.
monitoringTool String Monitoring tool the alert came from.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
prometheusAlert PrometheusAlert Deprecated in GitLab 17.3. Returns no data. Underlying feature was removed in 16.0.
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.
todos TodoConnection To-do items of the current user for the alert. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
updatedAt Time Timestamp the alert was last updated.
webUrl String! URL of the alert.

AlertManagementAlertConnection#

Paginated collection of AlertManagementAlert. See Standard connection fields for the fields available on every connection.

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.

Implements: AlertManagementIntegration

Fields#

Name Type Description
active Boolean Whether the endpoint is currently accepting alerts.
apiUrl String Deprecated in GitLab 18.2. Feature removed in 16.0.
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.

AlertManagementHttpIntegrationConnection#

Paginated collection of AlertManagementHttpIntegration. See Standard connection fields for the fields available on every connection.

AlertManagementIntegrationConnection#

Paginated collection of AlertManagementIntegration. See Standard connection fields for the fields available on every connection.

AlertManagementMetricImageUploadRegistry#

Represents the Geo replication and verification state of a alert_management_metric_image_upload.

Fields#

Name Type Description
alertManagementMetricImageUploadId ID! ID of the Alert Management Metric Image Upload.
checksumMismatch Boolean Indicate if the checksums of the AlertManagementMetricImageUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AlertManagementMetricImageUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AlertManagementMetricImageUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AlertManagementMetricImageUploadRegistry.
lastSyncFailure String Error message during sync of the AlertManagementMetricImageUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AlertManagementMetricImageUploadRegistry.
missingOnPrimary Boolean Indicate if the AlertManagementMetricImageUploadRegistry is missing on primary.
modelRecordId Int ID of the AlertManagementMetricImageUploadRegistry's model record.
retryAt Time Timestamp after which the AlertManagementMetricImageUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AlertManagementMetricImageUploadRegistry.
state RegistryState Sync state of the AlertManagementMetricImageUploadRegistry.
verificationChecksum String The local checksum of the AlertManagementMetricImageUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AlertManagementMetricImageUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AlertManagementMetricImageUploadRegistry.
verificationRetryAt Time Timestamp after which the AlertManagementMetricImageUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AlertManagementMetricImageUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AlertManagementMetricImageUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AlertManagementMetricImageUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AlertManagementMetricImageUploadRegistry.

AlertManagementMetricImageUploadRegistryConnection#

Paginated collection of AlertManagementMetricImageUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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#

DEPRECATED - Use AlertManagementHttpIntegration directly An endpoint and credentials used to accept Prometheus alerts for a project.

Implements: AlertManagementIntegration

Fields#

Name Type Description
active Boolean Whether the endpoint is currently accepting alerts.
apiUrl String Deprecated in GitLab 18.2. Feature removed in 16.0.
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.

Implements: AmazonS3ConfigurationInterface

Fields#

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
active Boolean! Active status of the destination.
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.

AmazonS3ConfigurationTypeConnection#

Paginated collection of AmazonS3ConfigurationType. See Standard connection fields for the fields available on every connection.

Analytics#

ClickHouse-based analytics endpoints aggregating data across groups and projects. Data can be delayed by 10 minutes.

Fields#

Name Type Description
agentPlatformSessions AgentPlatformSessionsAggregationScope Aggregation engine for GitLab Duo Agent Platform sessions usage.

Arguments for agentPlatformSessions:
createdEventAtFrom (Time)
Filter by session creation timestamp. Start of the range.
createdEventAtTo (Time)
Filter by session creation timestamp. End of the range.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
flowType ([String!])
Filter by one or many flow types.
flowTypeNot ([String!])
Exclude one or many flow types. Maximum is 100.
projectId ([String!])
Filter by one or many project Global IDs.
projectIdNot ([String!])
Exclude one or many project Global IDs. Sessions not scoped to a project are returned, because they store 0 rather than NULL. Maximum is 100.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Maximum is 100.
contributions ContributionsAggregationScope Introduced as an experiment in GitLab 19.0.

Aggregation engine for contribution analytics. Requires Siphon replication to be enabled on the instance.

Arguments for contributions:
authorId ([String!])
Filter by one or many author Global IDs.
authorIdNot ([String!])
Exclude one or many author Global IDs. Maximum is 100.
createdAtFrom (Time)
Filter by contribution timestamp. Start of the range.
createdAtTo (Time)
Filter by contribution timestamp. End of the range.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
deployments DeploymentsAggregationScope Introduced as an experiment in GitLab 19.0.

Aggregation engine for deployment analytics. Requires Siphon replication to be enabled on the instance.

Arguments for deployments:
createdAtFrom (Time)
Filter by deployment creation timestamp. Start of the range.
createdAtTo (Time)
Filter by deployment creation timestamp. End of the range.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
environmentId ([String!])
Filter by one or many environment Global IDs.
environmentIdNot ([String!])
Exclude one or many environment Global IDs. Maximum is 100.
finishedAtFrom (Time)
Filter by deployment finish timestamp. Start of the range.
finishedAtTo (Time)
Filter by deployment finish timestamp. End of the range.
ref ([String!])
Filter by one or many deployment refs.
refNot ([String!])
Exclude one or many deployment refs. Maximum is 100.
status ([String!])
Filter by one or many deployment statuses.
statusNot ([String!])
Exclude one or many deployment statuses. Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Deployments with no triggering user are excluded as well. Maximum is 100.
duoCodeSuggestions DuoCodeSuggestionsAggregationScope Aggregation engine for GitLab Duo Code Suggestions usage.

Arguments for duoCodeSuggestions:
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
ideName ([String!])
Filter by IDE name.
ideNameNot ([String!])
Exclude one or many IDE names. Maximum is 100.
language ([String!])
Filter by suggestion language.
languageNot ([String!])
Exclude one or many suggestion languages. Maximum is 100.
timestampFrom (Time)
Filter by suggestion timestamp. Start of the range.
timestampTo (Time)
Filter by suggestion timestamp. End of the range.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Maximum is 100.
duoUsageEvents DuoUsageEventsAggregationScope Aggregation engine for GitLab Duo AI usage events.

Arguments for duoUsageEvents:
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
event ([String!])
Filter by one or many events.
eventNot ([String!])
Exclude one or many events. Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
feature ([String!])
Filter by one or many features.
featureNot ([String!])
Exclude one or many features. Events with no recognized feature are excluded as well. Maximum is 100.
flowType ([String!])
Filter by one or many Duo Agent Platform flow types.
flowTypeNot ([String!])
Exclude one or many Duo Agent Platform flow types. Returns only Duo Agent Platform events, because events from elsewhere have no flow type. Maximum is 100.
groupId ([String!])
Filter by one or many group Global IDs, including events from their descendants.
timestampFrom (Time)
Filter by event timestamp. Start of the range.
timestampTo (Time)
Filter by event timestamp. End of the range.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Maximum is 100.
duoWorkflows DuoWorkflowsAggregationScope Introduced as an experiment in GitLab 19.4.

Aggregation engine for GitLab Duo Agent Platform flows. Requires Siphon replication to be enabled on the instance.

Arguments for duoWorkflows:
activeDaysFrom (Int)
Filter by the number of distinct days the user created flows in the selected period. Start of the range.
activeDaysTo (Int)
Filter by the number of distinct days the user created flows in the selected period. End of the range.
createdAtFrom (Time)
Filter by flow creation timestamp. Start of the range.
createdAtTo (Time)
Filter by flow creation timestamp. End of the range.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
flowTypesUsedFrom (Int)
Filter by the number of distinct flow types the user ran in the selected period. Start of the range.
flowTypesUsedTo (Int)
Filter by the number of distinct flow types the user ran in the selected period. End of the range.
groupId ([String!])
Filter by one or many group Global IDs, including flows from their descendants.
modelUsed ([String!])
Filter by one or many models.
modelUsedNot ([String!])
Exclude one or many models. Flows with no attributed model are stored as an empty string, so pass one to exclude them. Maximum is 100.
projectId ([String!])
Filter by one or many project Global IDs.
projectIdNot ([String!])
Exclude one or many project Global IDs. Flows created at namespace level are excluded as well. Maximum is 100.
status ([String!])
Filter by one or many flow statuses (created, running, finished, failed, ...).
statusNot ([String!])
Exclude one or many flow statuses (created, running, finished, failed, ...). Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Maximum is 100.
workflowDefinition ([String!])
Filter by one or many flow types.
workflowDefinitionNot ([String!])
Exclude one or many flow types. Maximum is 100.
mergeRequests MergeRequestsAggregationScope Introduced as an experiment in GitLab 19.2.

Aggregation engine for merge request analytics. Requires Siphon replication to be enabled on the instance.

Arguments for mergeRequests:
authorId ([String!])
Filter by one or many author Global IDs.
authorIdNot ([String!])
Exclude one or many author Global IDs. Merge requests with no author are excluded as well. Maximum is 100.
createdAtFrom (Time)
Filter by merge request creation timestamp. Start of the range.
createdAtTo (Time)
Filter by merge request creation timestamp. End of the range.
createdByDuo ([Boolean!])
Filter by whether the merge request was created by a GitLab Duo Agent Platform session.
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
metricMergedAtFrom (Time)
Filter by merge timestamp. Start of the range.
metricMergedAtTo (Time)
Filter by merge timestamp. End of the range.
stateId ([String!])
Filter by one or many states (opened, closed, merged, locked).
stateIdNot ([String!])
Exclude one or many states (opened, closed, merged, locked). Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
targetBranch ([String!])
Filter by one or many target branches.
targetBranchNot ([String!])
Exclude one or many target branches. Maximum is 100.
pipelines PipelinesAggregationScope Introduced as an experiment in GitLab 19.2.

Aggregation engine for CI pipeline analytics. Requires Siphon replication to be enabled on the instance.

Arguments for pipelines:
descendantsScope (AggregationScopeInput)
Child groups and projects to aggregate data for. Not supported at project level.
finishedAtFrom (Time)
Filter by pipeline finish timestamp. Start of the range.
finishedAtTo (Time)
Filter by pipeline finish timestamp. End of the range.
ref ([String!])
Filter by one or many pipeline refs.
refNot ([String!])
Exclude one or many pipeline refs. Pipelines with no ref are excluded as well. Maximum is 100.
source ([String!])
Filter by one or many pipeline sources.
sourceNot ([String!])
Exclude one or many pipeline sources. Pipelines with no source are excluded as well. Unrecognized values are ignored, so a list with none recognized excludes nothing. Maximum is 100.
startedAtFrom (Time)
Filter by pipeline start timestamp. Start of the range.
startedAtTo (Time)
Filter by pipeline start timestamp. End of the range.
status ([String!])
Filter by one or many pipeline statuses.
statusNot ([String!])
Exclude one or many pipeline statuses. Maximum is 100.
userId ([String!])
Filter by one or many user Global IDs.
userIdNot ([String!])
Exclude one or many user Global IDs. Pipelines with no triggering user are excluded as well. Maximum is 100.

AnalyzerGroupStatusType#

Counts for each analyzer status in the group and subgroups.

Fields#

Name Type Description
analyzerType AnalyzerTypeForStatus! Analyzer type.
failure Int! Number of projects where analyzer_type failed to execute.
namespaceId Int! Namespace ID.
notConfigured Int! Number of projects where analyzer_type is not configured.
stale Int! Number of projects where analyzer_type has not run in three consecutive pipelines in the default branch.
success Int! Number of projects where analyzer_type completed successfully.
totalProjectsCount Int! Total number of projects descending from the group.
updatedAt ISO8601DateTime! Timestamp of when the status was last updated.

AnalyzerProjectStatusType#

Analyzer status (success/fail) for projects.

Fields#

Name Type Description
analyzerType AnalyzerTypeForStatus! Analyzer type.
buildId JobID Build ID.
lastCall Time! Last time analyzer was called.
projectId Int! Project ID.
source AnalyzerSourceEnum Introduced as an experiment in GitLab 19.0.

Source of the build associated with the analyzer status.
status AnalyzerStatusEnum! Analyzer status.
updatedAt ISO8601DateTime! Timestamp of when the status was last updated.

AncestorType#

Fields#

Name Type Description
name String Name of the ancestor.
version String Version of the ancestor.

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.

AppearanceUploadRegistry#

Represents the Geo replication and verification state of an appearance_upload.

Fields#

Name Type Description
appearanceUploadId ID! ID of the Appearance Upload.
checksumMismatch Boolean Indicate if the checksums of the AppearanceUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the AppearanceUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this AppearanceUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the AppearanceUploadRegistry.
lastSyncFailure String Error message during sync of the AppearanceUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the AppearanceUploadRegistry.
missingOnPrimary Boolean Indicate if the AppearanceUploadRegistry is missing on primary.
modelRecordId Int ID of the AppearanceUploadRegistry's model record.
retryAt Time Timestamp after which the AppearanceUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the AppearanceUploadRegistry.
state RegistryState Sync state of the AppearanceUploadRegistry.
verificationChecksum String The local checksum of the AppearanceUploadRegistry.
verificationChecksumMismatched String The expected checksum of the AppearanceUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the AppearanceUploadRegistry.
verificationRetryAt Time Timestamp after which the AppearanceUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the AppearanceUploadRegistry.
verificationStartedAt Time Timestamp when the verification of AppearanceUploadRegistry started.
verificationState VerificationStateEnum Verification state of the AppearanceUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the AppearanceUploadRegistry.

AppearanceUploadRegistryConnection#

Paginated collection of AppearanceUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ApprovalPolicy#

Represents the approval policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
actionApprovers [PolicyApproversType!] Multiple approvers action.
allGroupApprovers [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
deprecatedProperties [String!] Introduced as an experiment in GitLab 16.10.

All deprecated properties in the policy.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
enforcementType PolicyEnforcementType Enforcement type of the policy. Can be "enforce" or "warn".
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.

ApprovalPolicyAttributesType#

Represents policy fields related to the approval policy.

Fields#

Name Type Description
actionApprovers [PolicyApproversType!] Multiple approvers action.
allGroupApprovers [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
deprecatedProperties [String!] Introduced as an experiment in GitLab 16.10.

All deprecated properties in the policy.
enforcementType PolicyEnforcementType Enforcement type of the policy. Can be "enforce" or "warn".
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.
userApprovers [UserCore!] Approvers of the user type.

ApprovalPolicyConnection#

Paginated collection of ApprovalPolicy. See Standard connection fields for the fields available on every connection.

ApprovalProjectRule#

Describes a project approval rule regarding who can approve merge requests.

Fields#

Name Type Description
approvalsRequired Int Number of required approvals.
coverageMinimumThreshold Float Minimum code coverage threshold (0-100). Approval is required if coverage falls below the specified threshold.
eligibleApprovers UserCoreConnection List of users eligible to approve merge requests for the approval rule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id GlobalID! ID of the rule.
name String Name of the rule.
type ApprovalRuleType Type of the rule.

ApprovalProjectRuleConnection#

Paginated collection of ApprovalProjectRule. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commentedBy UserCoreConnection List of users, defined in the rule, who commented on the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
patterns [String!] Introduced as an experiment in GitLab 19.4.

CODEOWNERS patterns grouped into this rule. Returns null when the rule is not a grouped Code Owner rule.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

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.

ArtifactRegistry#

Artifact Registry an organization is activated for.

Fields#

Name Type Description
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the registry was provisioned, presented as the active-since date. null when the status is unknown.
id ID! Introduced as an experiment in GitLab 19.5.

Artifact Registry's UUID for the namespace mapped to the organization. Neither a GitLab namespace nor a GitLab global ID. Pass it as resourceId to the Artifact Registry role mutations. Present even when the status is unknown.
slug String Introduced as an experiment in GitLab 19.4.

Registry slug, Artifact Registry's immutable identifier for the namespace. null when the status is unknown.
statistics ArtifactRegistryNamespaceStatistics Introduced as an experiment in GitLab 19.5.

Namespace-wide Artifact Registry statistics, read as the current user when this field is selected. null on any unresolved read, so an unavailable service or a drifted slug omits the figures rather than raising. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this field is not reached.
status String! Introduced as an experiment in GitLab 19.4.

Status Artifact Registry returned, one of active, suspended, disabled, blocked, deleted, or purged, or unknown when the mapped namespace did not resolve. Deliberately a string rather than an enum so a status Artifact Registry adds within its API version reaches the response instead of raising.
userPermissions ArtifactRegistryNamespacePermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the namespace, read from the namespace details as the user when this field is selected. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.

ArtifactRegistryImage#

Image in an Artifact Registry repository.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.4.

ID of the image in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the image was last pulled. Null when it was never pulled.
manifests ArtifactRegistryManifestConnection Introduced as an experiment in GitLab 19.4.

Manifests of the image, ordered by publication date descending by default. Reads at most 20 rows per page and can be selected for up to 20 images per operation, matching the images page size. Returns null for an image that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for manifests:
includeReferrers (Boolean)
Introduced as an experiment in GitLab 19.4.

Include referrer manifests in the list. Defaults to false, matching the endpoint.
sort (ArtifactRegistryManifestSort)
Introduced as an experiment in GitLab 19.4.

Sort manifests by the criteria. Defaults to publication date descending.
name String! Introduced as an experiment in GitLab 19.4.

Name of the image.

ArtifactRegistryImageConnection#

Paginated collection of ArtifactRegistryImage. See Standard connection fields for the fields available on every connection.

ArtifactRegistryManifest#

Manifest of a container image in an Artifact Registry repository (Docker and OCI).

Fields#

Name Type Description
architecture String Introduced as an experiment in GitLab 19.5.

CPU architecture an image manifest targets. Null on an index, per value on an image whose config did not carry it, and always null on a remote repository.
artifactType String Introduced as an experiment in GitLab 19.4.

Artifact type of the manifest. Null when the manifest declares none.
childrenCount Int Introduced as an experiment in GitLab 19.5.

Number of platform children of a manifest index. Zero on an image manifest, and always zero on a remote repository. Null on a deployment predating the field.
childrenPreview [ArtifactRegistryManifestPlatform!] Introduced as an experiment in GitLab 19.5.

First ten platform children of a manifest index, child digest ascending, each with its digest and platform triple. Empty on an image manifest and on a remote repository. childrenCount on this type already carries the true total; read the complete children list on the detail type. Null on a deployment predating the field.
createdAt Time Introduced as an experiment in GitLab 19.4.

Time the manifest was pushed. Null if the timestamp is absent or unparseable.
digest String! Introduced as an experiment in GitLab 19.4.

Content-addressable digest of the manifest.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the manifest in Artifact Registry.
mediaType String! Introduced as an experiment in GitLab 19.4.

Media type of the manifest.
os String Introduced as an experiment in GitLab 19.5.

Operating system an image manifest targets. Null on an index, per value on an image whose config did not carry it, and always null on a remote repository.
osVariant String Introduced as an experiment in GitLab 19.5.

CPU variant an image manifest targets. Null on an index, on most images, and always null on a remote repository.
parentsPreview [String!] Introduced as an experiment in GitLab 19.5.

First ten digests of the indexes that reference this manifest, in the order Artifact Registry returns them. Empty when no index references it. The list carries no parent count; read the complete list, and the total in parentsCount, on the detail type. Null on a deployment predating the field.
referrersCount Int Introduced as an experiment in GitLab 19.5.

Number of manifests in the image that name this digest as their subject. Zero when none do, and always zero on a remote repository. Null on a deployment predating the field.
size BigInt! Introduced as an experiment in GitLab 19.4.

Size of the manifest, in bytes. For a hosted repository, the push-time tree total, where an index total already contains its platform children and so does not sum across sibling rows. For a remote repository, the cached manifest's own payload bytes.
subjectDigest String Introduced as an experiment in GitLab 19.4.

Digest of the subject manifest a referrer refers to. Null for a manifest that is not a referrer. Populated on the referrers connection, where every row is a referrer of the manifest it hangs off. On the manifests connection it is null unless the caller passes includeReferrers, which the default omits.
tagsCount Int Introduced as an experiment in GitLab 19.5.

Number of tags pointing at the manifest. Zero when untagged. Null on a deployment predating the field.
tagsPreview [String!] Introduced as an experiment in GitLab 19.5.

First ten tags pointing at the manifest, name ascending. Empty when untagged. tagsCount on this type already carries the true total; read the complete tags list on the detail type. Null on a deployment predating the field.

ArtifactRegistryManifestAnnotation#

OCI annotation of a container manifest in an Artifact Registry repository.

Fields#

Name Type Description
key String! Introduced as an experiment in GitLab 19.5.

Annotation key.
value String! Introduced as an experiment in GitLab 19.5.

Annotation value.

ArtifactRegistryManifestConnection#

Paginated collection of ArtifactRegistryManifest. See Standard connection fields for the fields available on every connection.

ArtifactRegistryManifestDetails#

Single container manifest in an Artifact Registry repository, reached by digest under the image it belongs to (Docker and OCI).

Fields#

Name Type Description
annotations [ArtifactRegistryManifestAnnotation!] Introduced as an experiment in GitLab 19.5.

OCI annotations of the manifest, as key/value pairs. Empty when the manifest carried an empty annotations map, and null when it carried none: the two are kept apart. Always null on a remote repository, where the field is not served.
architecture String Introduced as an experiment in GitLab 19.5.

CPU architecture an image manifest targets. Null on an index, per value on an image whose config did not carry it, and always null on a remote repository.
artifactType String Introduced as an experiment in GitLab 19.4.

Artifact type of the manifest. Null when the manifest declares none.
children [ArtifactRegistryManifestPlatform!] Introduced as an experiment in GitLab 19.5.

Platform children of a manifest index, child digest ascending, each with its digest and platform triple. Empty on an image manifest and on a remote repository. Null on a deployment predating the field.
childrenCount Int Introduced as an experiment in GitLab 19.5.

Number of platform children of a manifest index. Zero on an image manifest, and always zero on a remote repository. Null on a deployment predating the field.
createdAt Time Introduced as an experiment in GitLab 19.4.

Time the manifest was pushed. Null if the timestamp is absent or unparseable.
digest String! Introduced as an experiment in GitLab 19.4.

Content-addressable digest of the manifest.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the manifest in Artifact Registry.
mediaType String! Introduced as an experiment in GitLab 19.4.

Media type of the manifest.
os String Introduced as an experiment in GitLab 19.5.

Operating system an image manifest targets. Null on an index, per value on an image whose config did not carry it, and always null on a remote repository.
osVariant String Introduced as an experiment in GitLab 19.5.

CPU variant an image manifest targets. Null on an index, on most images, and always null on a remote repository.
parentDigests [String!] Introduced as an experiment in GitLab 19.5.

Digests of the indexes that reference this manifest, parent id ascending. Empty when no index references it. Null until Artifact Registry serves the field.
parentsCount Int Introduced as an experiment in GitLab 19.5.

Number of indexes that reference this manifest. Zero when none do. Null until Artifact Registry serves the field.
referrers ArtifactRegistryManifestConnection Introduced as an experiment in GitLab 19.5.

Manifests in the image that name this manifest as their subject, ordered by digest ascending. Reads at most 20 rows per page and can be selected once per operation, counting every selection of the field. Empty on a remote repository. Returns null for a manifest that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
referrersCount Int Introduced as an experiment in GitLab 19.5.

Number of manifests in the image that name this digest as their subject. Zero when none do, and always zero on a remote repository. Null on a deployment predating the field.
size BigInt! Introduced as an experiment in GitLab 19.4.

Size of the manifest, in bytes. For a hosted repository, the push-time tree total, where an index total already contains its platform children and so does not sum across sibling rows. For a remote repository, the cached manifest's own payload bytes.
subjectDigest String Introduced as an experiment in GitLab 19.5.

Digest of the subject manifest this manifest refers to. Null for a manifest that is not a referrer. Populated here even for a referrer, unlike the manifests list, because the detail route serves a referrer row like any other manifest.
tags [String!] Introduced as an experiment in GitLab 19.5.

Tags pointing at the manifest, name ascending. Empty when untagged. A window bounded by container.manifest_max_tags (1,000 by default), so it can stop short of tagsCount. Null on a deployment predating the field.
tagsCount Int Introduced as an experiment in GitLab 19.5.

Number of tags pointing at the manifest. Zero when untagged. Null on a deployment predating the field.

ArtifactRegistryManifestPlatform#

Platform child of a container manifest index in an Artifact Registry repository.

Fields#

Name Type Description
architecture String Introduced as an experiment in GitLab 19.5.

CPU architecture the child targets. Null when the manifest carries none.
digest String! Introduced as an experiment in GitLab 19.5.

Content-addressable digest of the child manifest.
os String Introduced as an experiment in GitLab 19.5.

Operating system the child targets. Null when the manifest carries none.
osVariant String Introduced as an experiment in GitLab 19.5.

CPU variant the child targets. Null when the manifest carries none, which is most images.

ArtifactRegistryMavenPackage#

Maven package in an Artifact Registry repository.

Fields#

Name Type Description
artifactId String! Introduced as an experiment in GitLab 19.3.

Maven artifact ID coordinate of the package.
groupId String! Introduced as an experiment in GitLab 19.3.

Maven group ID coordinate of the package.
id ID! Introduced as an experiment in GitLab 19.3.

ID of the package in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the package was last pulled. Null when it was never pulled.
versions ArtifactRegistryVersionConnection Introduced as an experiment in GitLab 19.4.

Versions of the package, ordered by publication date descending by default. Resolves at most once per package in a page, so one operation reads versions for up to 20 packages. Returns null for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
sort (ArtifactRegistryVersionSort)
Introduced as an experiment in GitLab 19.4.

Sort versions by the criteria. Defaults to publication date descending.

ArtifactRegistryMavenPackageDetails#

A single Maven package in an Artifact Registry repository, returned by the by-ID package read.

Fields#

Name Type Description
artifactId String! Introduced as an experiment in GitLab 19.3.

Maven artifact ID coordinate of the package.
groupId String! Introduced as an experiment in GitLab 19.3.

Maven group ID coordinate of the package.
id ID! Introduced as an experiment in GitLab 19.3.

ID of the package in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the package was last pulled. Null when it was never pulled.
versions ArtifactRegistryVersionConnection Introduced as an experiment in GitLab 19.4.

Versions of the package, ordered by publication date descending by default. Resolves at most once per package in a page, so one operation reads versions for up to 20 packages. Returns null for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
sort (ArtifactRegistryVersionSort)
Introduced as an experiment in GitLab 19.4.

Sort versions by the criteria. Defaults to publication date descending.

ArtifactRegistryMavenVersionFile#

File of a Maven version in an Artifact Registry repository.

Fields#

Name Type Description
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the file was stored. Null until Artifact Registry serializes the Maven file timestamp.
fileName String! Introduced as an experiment in GitLab 19.4.

Name of the file.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the file in Artifact Registry.
md5 String Introduced as an experiment in GitLab 19.4.

MD5 checksum of the file. Null when the deploy stored none.
sha1 String! Introduced as an experiment in GitLab 19.4.

SHA-1 checksum of the file.
sha256 String! Introduced as an experiment in GitLab 19.4.

SHA-256 checksum of the file.
sha512 String! Introduced as an experiment in GitLab 19.4.

SHA-512 checksum of the file.
sizeBytes BigInt! Introduced as an experiment in GitLab 19.4.

Stored size of the file in bytes.

ArtifactRegistryNamespacePermissions#

Per-action permissions Artifact Registry reports for the current user on a namespace.

Fields#

Name Type Description
createRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can create a repository in the namespace.
createRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can add an upstream to the namespace's repositories.
deleteRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can delete repositories of the namespace.
deleteRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can remove an upstream from the namespace's repositories.
readRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can read repositories of the namespace and their metadata.
updateRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can change the settings of the namespace's repositories.
updateRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can change an upstream of the namespace's repositories.

ArtifactRegistryNamespaceStatistics#

Namespace-wide statistics for an Artifact Registry.

Fields#

Name Type Description
deduplicatedSizeBytes BigInt Introduced as an experiment in GitLab 19.5.

Namespace's storage footprint in bytes, counting each distinct blob once.
repositoriesCount BigInt Introduced as an experiment in GitLab 19.5.

Number of active repositories in the namespace, every format and kind.

ArtifactRegistryNpmDistTag#

npm dist-tag of a package in an Artifact Registry repository.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.4.

ID of the dist-tag in Artifact Registry.
name String! Introduced as an experiment in GitLab 19.4.

Name of the dist-tag.
version String! Introduced as an experiment in GitLab 19.4.

Version string the dist-tag points at.
versionId ID! Introduced as an experiment in GitLab 19.4.

Artifact Registry ID of the version the dist-tag points at.

ArtifactRegistryNpmDistTagConnection#

Paginated collection of ArtifactRegistryNpmDistTag. See Standard connection fields for the fields available on every connection.

ArtifactRegistryNpmPackage#

npm package in an Artifact Registry repository.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.3.

ID of the package in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the package was last pulled. Null when it was never pulled.
name String! Introduced as an experiment in GitLab 19.3.

Name of the package, including its scope when it has one.
scope String Introduced as an experiment in GitLab 19.3.

npm scope of the package. Null for an unscoped package.
versions ArtifactRegistryVersionConnection Introduced as an experiment in GitLab 19.4.

Versions of the package, ordered by publication date descending by default. Resolves at most once per package in a page, so one operation reads versions for up to 20 packages. Returns null for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
sort (ArtifactRegistryVersionSort)
Introduced as an experiment in GitLab 19.4.

Sort versions by the criteria. Defaults to publication date descending.
versionsCount Int Introduced as an experiment in GitLab 19.3.

Number of versions of the package. Buffered, so it can lag the version list. Null for a package of a remote repository, which Artifact Registry supplies no count for.

ArtifactRegistryNpmPackageDetails#

A single npm package in an Artifact Registry repository, returned by the by-ID package read; carries the npm dist-tags.

Fields#

Name Type Description
distTags ArtifactRegistryNpmDistTagConnection Introduced as an experiment in GitLab 19.4.

npm dist-tags of the package, ordered by name. Truncates above 100 dist-tags. Can be selected once per operation. null without a read on a remote repository, which Artifact Registry serves no dist-tag rows for. Also null for a package that is gone, and when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Introduced as an experiment in GitLab 19.3.

ID of the package in Artifact Registry.
lastDownloadedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the package was last pulled. Null when it was never pulled.
name String! Introduced as an experiment in GitLab 19.3.

Name of the package, including its scope when it has one.
scope String Introduced as an experiment in GitLab 19.3.

npm scope of the package. Null for an unscoped package.
versions ArtifactRegistryVersionConnection Introduced as an experiment in GitLab 19.4.

Versions of the package, ordered by publication date descending by default. Resolves at most once per package in a page, so one operation reads versions for up to 20 packages. Returns null for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
sort (ArtifactRegistryVersionSort)
Introduced as an experiment in GitLab 19.4.

Sort versions by the criteria. Defaults to publication date descending.
versionsCount Int Introduced as an experiment in GitLab 19.3.

Number of versions of the package. Buffered, so it can lag the version list. Null for a package of a remote repository, which Artifact Registry supplies no count for.

ArtifactRegistryNpmVersionFile#

File of an npm version in an Artifact Registry repository.

Fields#

Name Type Description
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the file was stored. Null on a remote repository, whose cached row carries none.
fileName String! Introduced as an experiment in GitLab 19.4.

Name of the file.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the file in Artifact Registry.
sha256 String! Introduced as an experiment in GitLab 19.4.

SHA-256 checksum of the file.
sizeBytes BigInt! Introduced as an experiment in GitLab 19.4.

Stored size of the file in bytes.

ArtifactRegistryPackageConnection#

Paginated collection of ArtifactRegistryPackage. See Standard connection fields for the fields available on every connection.

ArtifactRegistryRemoteSettings#

Upstream configuration of a remote Artifact Registry repository.

Fields#

Name Type Description
cacheValidityHours Int Introduced as an experiment in GitLab 19.4.

Revalidation window for cached artifacts, in hours. Zero means cached artifacts never revalidate.
credentialsCleared Boolean Introduced as an experiment in GitLab 19.4.

Indicates the update that returned this repository cleared the stored upstream credentials. Null on any other response.
hasCredentials Boolean Introduced as an experiment in GitLab 19.4.

Indicates upstream credentials are stored. Reported in place of the credentials themselves, which are write-only and exposed by no field.
lastHealthCheckedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of the most recent health probe of the upstream. Null until the first probe.
lastHealthStatus ArtifactRegistryHealthStatus Introduced as an experiment in GitLab 19.4.

Health verdict the most recent probe of the upstream stored. UNKNOWN before the first probe, and for a status this schema does not recognize.
metadataCacheValidityHours Int Introduced as an experiment in GitLab 19.4.

Revalidation window for cached metadata, in hours. Null for a format that caches no metadata, such as Docker and OCI.
snapshotMetadataAlwaysRevalidate Boolean Introduced as an experiment in GitLab 19.4.

Indicates snapshot metadata revalidates on every read instead of on the metadata window. Null for a format without snapshot metadata, so non-null only for Maven.
url String Introduced as an experiment in GitLab 19.4.

Base URL of the upstream registry, in the canonical form Artifact Registry stores.

ArtifactRegistryRepository#

Repository in Artifact Registry.

Fields#

Name Type Description
artifactsCount BigInt! Introduced as an experiment in GitLab 19.4.

Number of artifacts the repository holds. Buffered, so it can lag.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of when the repository was created. Null when the time is unknown.
createdBy UserCore Introduced as an experiment in GitLab 19.4.

User who created the repository. Null when the creator is unknown or no longer exists.
description String Introduced as an experiment in GitLab 19.3.

Human-readable description of the repository. Null when unset.
downloadsCount BigInt! Introduced as an experiment in GitLab 19.3.

Number of artifact downloads from the repository. Buffered, so it can lag.
format ArtifactRegistryRepositoryFormat! Introduced as an experiment in GitLab 19.3.

Package format the repository holds.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the repository in Artifact Registry.
kind ArtifactRegistryRepositoryKind! Introduced as an experiment in GitLab 19.3.

How the repository sources its artifacts.
lastUpdatedAt Time Introduced as an experiment in GitLab 19.3.

Time the repository content last changed. Null when the content never changed.
name String! Introduced as an experiment in GitLab 19.3.

Name of the repository, unique within its namespace.
settings ArtifactRegistryRemoteSettings Introduced as an experiment in GitLab 19.3.

Upstream configuration Artifact Registry returned for the repository. Null when it returned none, so null on a hosted or virtual repository.
sizeBytes BigInt! Introduced as an experiment in GitLab 19.3.

Storage the repository occupies, in bytes. Buffered, so it can lag.
updatedBy UserCore Introduced as an experiment in GitLab 19.4.

User who last changed the repository. Null when the editor is unknown or no longer exists.
userPermissions ArtifactRegistryRepositoryPermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the repository. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.
visibility ArtifactRegistryRepositoryVisibility! Introduced as an experiment in GitLab 19.3.

Who can read the repository.

ArtifactRegistryRepositoryConnection#

Paginated collection of ArtifactRegistryRepository. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
userPermissions ArtifactRegistryNamespacePermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the namespace the repositories belong to. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.

ArtifactRegistryRepositoryDetails#

Repository in Artifact Registry, with the packages or images it holds.

Fields#

Name Type Description
artifactsCount BigInt! Introduced as an experiment in GitLab 19.4.

Number of artifacts the repository holds. Buffered, so it can lag.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of when the repository was created. Null when the time is unknown.
createdBy UserCore Introduced as an experiment in GitLab 19.4.

User who created the repository. Null when the creator is unknown or no longer exists.
description String Introduced as an experiment in GitLab 19.3.

Human-readable description of the repository. Null when unset.
downloadsCount BigInt! Introduced as an experiment in GitLab 19.3.

Number of artifact downloads from the repository. Buffered, so it can lag.
format ArtifactRegistryRepositoryFormat! Introduced as an experiment in GitLab 19.3.

Package format the repository holds.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the repository in Artifact Registry.
image ArtifactRegistryImage Introduced as an experiment in GitLab 19.4.

Single container image the repository holds, by Artifact Registry ID. Can be selected once per operation. Returns null for a repository holding packages and for an image that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.

Arguments for image:
id (ID!)
ID of the image in Artifact Registry.
images ArtifactRegistryImageConnection Introduced as an experiment in GitLab 19.4.

Images the repository holds. Can be selected once per operation, so one operation reads images for one repository. Returns null for a virtual repository, for a repository holding packages, and for a repository that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
kind ArtifactRegistryRepositoryKind! Introduced as an experiment in GitLab 19.3.

How the repository sources its artifacts.
lastUpdatedAt Time Introduced as an experiment in GitLab 19.3.

Time the repository content last changed. Null when the content never changed.
manifest ArtifactRegistryManifestDetails Introduced as an experiment in GitLab 19.5.

Single container manifest the repository holds, by digest and the ID of the image it belongs to. Can be selected once per operation, counting every selection of the field. null while the artifact_registry_ui feature flag is off, resolved without a read. Returns null for a repository holding packages, for a manifest that is gone, and for a blank or dot-segment image ID or digest, which resolves without a read. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.

Arguments for manifest:
artifactId (ID!)
ID of the image the manifest belongs to, in Artifact Registry.
digest (String!)
Digest of the manifest in Artifact Registry.
name String! Introduced as an experiment in GitLab 19.3.

Name of the repository, unique within its namespace.
package ArtifactRegistryPackageDetails Introduced as an experiment in GitLab 19.4.

Single package the repository holds, by Artifact Registry ID. Can be selected once per operation. Returns null for a repository holding images and for a package that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.

Arguments for package:
id (ID!)
ID of the package in Artifact Registry.
packages ArtifactRegistryPackageConnection Introduced as an experiment in GitLab 19.3.

Packages the repository holds, ordered by name. Can be selected once per operation, so one operation reads packages for one repository. Returns null for a virtual repository, for a repository holding images, for a repository that is gone, and when Artifact Registry rejects the read. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
settings ArtifactRegistryRemoteSettings Introduced as an experiment in GitLab 19.3.

Upstream configuration Artifact Registry returned for the repository. Null when it returned none, so null on a hosted or virtual repository.
sizeBytes BigInt! Introduced as an experiment in GitLab 19.3.

Storage the repository occupies, in bytes. Buffered, so it can lag.
statistics ArtifactRegistryRepositoryStatistics Introduced as an experiment in GitLab 19.5.

Read-time package or image count of a hosted repository. Can be selected once per operation. Returns null without a read for a remote or virtual repository, and null for a repository that is gone. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.
updatedBy UserCore Introduced as an experiment in GitLab 19.4.

User who last changed the repository. Null when the editor is unknown or no longer exists.
upstreamRepositories [ArtifactRegistryUpstreamRepositoryAssociation!] Introduced as an experiment in GitLab 19.5.

Upstream repositories a virtual repository resolves through, in resolution order. Can be selected once per operation. Returns null for a hosted or remote repository, for a repository that is gone, and when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.
userPermissions ArtifactRegistryRepositoryPermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the repository. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. The parent field returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.
version ArtifactRegistryVersionDetails Introduced as an experiment in GitLab 19.4.

Single version the repository holds, by Artifact Registry ID and the ID of the package it is displayed under. Can be selected once per operation. Returns null for a repository holding images, for a version that is gone, and for a version that belongs to a different package. Also null when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx.

Arguments for version:
artifactId (ID!)
ID of the package the version is displayed under, in Artifact Registry. The version resolves null when it belongs to a different package.
id (ID!)
ID of the version in Artifact Registry.
visibility ArtifactRegistryRepositoryVisibility! Introduced as an experiment in GitLab 19.3.

Who can read the repository.

ArtifactRegistryRepositoryPermissions#

Per-action permissions Artifact Registry reports for the current user on a repository.

Fields#

Name Type Description
createArtifact Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can publish artifacts to the repository.
createRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can add an upstream to the repository.
deleteArtifact Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can delete artifacts from the repository.
deleteRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can delete the repository.
deleteRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can remove an upstream from the repository.
readArtifact Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can read artifacts held by the repository.
readRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can read the repository and its metadata.
updateRepository Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can change the repository's settings.
updateRepositoryUpstream Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the user can change an upstream of the repository.

ArtifactRegistryRepositoryStatistics#

Read-time statistics for a hosted repository in Artifact Registry.

Fields#

Name Type Description
imagesCount BigInt Introduced as an experiment in GitLab 19.5.

Number of images the repository holds, computed at read time. null for a repository holding packages.
packagesCount BigInt Introduced as an experiment in GitLab 19.5.

Number of packages the repository holds, computed at read time. null for a repository holding images.

ArtifactRegistryRoleAssignment#

A direct role assignment. A user, the Artifact Registry role they hold, and the resource it is assigned on. Does not represent inherited access.

Fields#

Name Type Description
assignee UserCore User the role is assigned to.
createdAt Time Time the assignment was created.
resourceId String! UUID of the Artifact Registry resource the role is assigned on.
role ArtifactRegistryRole Assigned Artifact Registry role.

ArtifactRegistryRoleAssignmentConnection#

Paginated collection of ArtifactRegistryRoleAssignment. See Standard connection fields for the fields available on every connection.

ArtifactRegistryUpstreamRepositoryAssociation#

One upstream of a virtual Artifact Registry repository: its position and a summary of the repository it points at.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.5.

ID of the upstream association in Artifact Registry.
position Int! Introduced as an experiment in GitLab 19.5.

1-based resolution position of the upstream, consulted in ascending order.
upstreamRepository ArtifactRegistryUpstreamRepositorySummary! Introduced as an experiment in GitLab 19.5.

Summary of the repository the association points at.

ArtifactRegistryUpstreamRepositorySummary#

Summary of a repository that is an upstream of a virtual Artifact Registry repository.

Fields#

Name Type Description
format ArtifactRegistryRepositoryFormat! Introduced as an experiment in GitLab 19.5.

Package format the upstream repository holds.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the upstream repository in Artifact Registry.
kind ArtifactRegistryUpstreamRepositoryKind Introduced as an experiment in GitLab 19.5.

How the upstream repository sources its artifacts. Artifact Registry returns hosted or remote by contract; a value outside those resolves null alongside a top-level error rather than a badge.
name String! Introduced as an experiment in GitLab 19.5.

Name of the upstream repository.
settings ArtifactRegistryUpstreamRepositorySummarySettings Introduced as an experiment in GitLab 19.5.

Upstream configuration of a remote upstream repository. Null on a hosted upstream, and when the current user cannot read the upstream repository.
sizeBytes BigInt Introduced as an experiment in GitLab 19.5.

Storage the upstream repository occupies, in bytes. Buffered, so it can lag. Null when the current user cannot read the upstream repository.
userPermissions ArtifactRegistryRepositoryPermissions! Introduced as an experiment in GitLab 19.5.

Permissions Artifact Registry grants the current user on the upstream repository. Advisory, because Artifact Registry authorizes every request on its own. Every permission is false when Artifact Registry returned no verdicts. upstreamRepositories returns null when the artifact_registry_ui feature flag is disabled, so this block is not reached.
visibility ArtifactRegistryRepositoryVisibility Introduced as an experiment in GitLab 19.5.

Who can read the upstream repository. Null when the current user cannot read the upstream repository. A value outside this enum resolves null alongside a top-level error.

ArtifactRegistryUpstreamRepositorySummarySettings#

Settings a remote upstream repository shows in the upstream list of a virtual Artifact Registry repository.

Fields#

Name Type Description
lastHealthStatus ArtifactRegistryHealthStatus Introduced as an experiment in GitLab 19.5.

Health verdict the most recent probe of the upstream stored. UNKNOWN before the first probe, and for a status this schema does not recognize.
url String Introduced as an experiment in GitLab 19.5.

Base URL of the upstream registry, in the canonical form Artifact Registry stores.

ArtifactRegistryVersion#

Version of a package in an Artifact Registry repository (Maven and npm).

Fields#

Name Type Description
commitPath String Introduced as an experiment in GitLab 19.4.

Web path to the publishing commit within the resolved project. Null when there is no SHA or project, or the viewer cannot read the project code.
commitSha String Introduced as an experiment in GitLab 19.4.

Commit SHA the version was published from, within the resolved project. Null when there is no SHA or project, or the viewer cannot read the project code.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the version was published. Null when Artifact Registry stored none.
createdBy UserCore Introduced as an experiment in GitLab 19.4.

User who published the version, resolved from the reference Artifact Registry stores. Null when it stored none or the user no longer exists.
distTags [String!]! Introduced as an experiment in GitLab 19.4.

Names of the npm dist-tags bound to the version, in ascending name order. Empty for Maven versions.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the version in Artifact Registry.
project Project Introduced as an experiment in GitLab 19.4.

Project the version was published from, resolved from the reference Artifact Registry stores. Null when it stored none, the project no longer exists, or the viewer cannot see the project.
sizeBytes BigInt Introduced as an experiment in GitLab 19.4.

Stored size of the version in bytes. Null for a Maven version until Artifact Registry serializes the column, and on a remote repository.
version String! Introduced as an experiment in GitLab 19.4.

Version string of the package.

ArtifactRegistryVersionConnection#

Paginated collection of ArtifactRegistryVersion. See Standard connection fields for the fields available on every connection.

ArtifactRegistryVersionDetails#

Single version of a package in an Artifact Registry repository, reached by ID and the package it is displayed under.

Fields#

Name Type Description
commitPath String Introduced as an experiment in GitLab 19.4.

Web path to the publishing commit within the resolved project. Null when there is no SHA or project, or the viewer cannot read the project code.
commitSha String Introduced as an experiment in GitLab 19.4.

Commit SHA the version was published from, within the resolved project. Null when there is no SHA or project, or the viewer cannot read the project code.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp the version was published. Null when Artifact Registry stored none.
createdBy UserCore Introduced as an experiment in GitLab 19.4.

User who published the version, resolved from the reference Artifact Registry stores. Null when it stored none or the user no longer exists.
distTags [String!]! Introduced as an experiment in GitLab 19.4.

Names of the npm dist-tags bound to the version, in ascending name order. Empty for Maven versions.
files ArtifactRegistryVersionFileConnection Introduced as an experiment in GitLab 19.4.

Files the version holds, ordered by file name. Reads at most 20 rows per page and can be selected once per operation. Returns null for a version that is gone, and when Artifact Registry rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, a 5xx, or any other 4xx. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Introduced as an experiment in GitLab 19.4.

ID of the version in Artifact Registry.
project Project Introduced as an experiment in GitLab 19.4.

Project the version was published from, resolved from the reference Artifact Registry stores. Null when it stored none, the project no longer exists, or the viewer cannot see the project.
sizeBytes BigInt Introduced as an experiment in GitLab 19.4.

Stored size of the version in bytes. Null for a Maven version until Artifact Registry serializes the column, and on a remote repository.
statistics ArtifactRegistryVersionStatistics Introduced as an experiment in GitLab 19.5.

Read-time statistics for the version. Hosted repositories only, so null without a read on a virtual or remote repository and on a container repository. Can be selected once per operation. null when Artifact Registry does not serve the statistics route, and when it rejects the read: silently for a 401, 403, or 404, and alongside a top-level error for a 429, any other 5xx, or any other 4xx.
version String! Introduced as an experiment in GitLab 19.4.

Version string of the package.

ArtifactRegistryVersionFileConnection#

Paginated collection of ArtifactRegistryVersionFile. See Standard connection fields for the fields available on every connection.

ArtifactRegistryVersionStatistics#

Read-time statistics for a version in an Artifact Registry repository.

Fields#

Name Type Description
filesCount BigInt Introduced as an experiment in GitLab 19.5.

Number of files the version holds, computed at read time.

AscpComponent#

A logical component of a project identified by ASCP security scanning.

Fields#

Name Type Description
createdAt Time! Timestamp when the component was created.
dependencies AscpComponentConnection! Components the component depends on. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String Description of the component.
expectedUserBehavior String Expected user behavior for the component.
id SecurityAscpComponentID! Global ID of the component.
scan AscpScan! Scan when the component was identified.
securityContext AscpSecurityContext Security context for the component.
subDirectory String! Sub-directory containing the component.
title String! Title of the component.
updatedAt Time! Timestamp when the component was last updated.

AscpComponentConnection#

Paginated collection of AscpComponent. See Standard connection fields for the fields available on every connection.

AscpScan#

An ASCP scan of a project.

Fields#

Name Type Description
baseCommitSha String Base commit SHA for incremental scans.
baseScan AscpScan Reference to the base scan for incremental scans.
commitSha String! Git commit SHA that was scanned.
createdAt Time! Timestamp when the scan was created.
id SecurityAscpScanID! ID of the scan.
scanSequence Int! Sequence number of the scan within the project.
scanType AscpScanType! Type of scan (full or incremental).
updatedAt Time! Timestamp when the scan was last updated.

AscpScanConnection#

Paginated collection of AscpScan. See Standard connection fields for the fields available on every connection.

AscpSecurityContext#

Security context for an ASCP component.

Fields#

Name Type Description
authenticationModel String How users authenticate to the component.
authorizationModel String How access is controlled for the component.
dataSensitivity String Types of sensitive data handled by the component.
id SecurityAscpSecurityContextID! ID of the security context.
scan AscpScan! Scan when the security context was generated.
securityBoundary [AscpSecurityBoundary!]! Security boundaries the component sits on.
securityGuidelines AscpSecurityGuidelineConnection! Security guidelines for the context. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
summary String High-level threat model summary.

AscpSecurityGuideline#

A security guideline for an ASCP component.

Fields#

Name Type Description
businessContext String How to assess business impact if violated.
id SecurityAscpSecurityGuidelineID! ID of the guideline.
legitimateUse String When the operation is expected and acceptable.
name String! Policy name.
operation String! Security-sensitive operation.
securityBoundary String When the operation becomes a security risk.
severityIfViolated AscpSeverity! Severity level if the guideline is violated.

AscpSecurityGuidelineConnection#

Paginated collection of AscpSecurityGuideline. See Standard connection fields for the fields available on every connection.

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.

AuditEvent#

Audit event.

Fields#

Name Type Description
author UserCore User who triggered the event.
createdAt Time! Timestamp when the audit event was created.
details String Additional details of the audit event.
entityId ID ID of the entity.
entityPath String Path of the entity.
entityType String Type of the entity.
eventName String Name of the event.
group Group Group associated with the audit event.
id ID! Audit Event ID.
ipAddress String IP address of the user.
project Project Project associated with the audit event.
targetDetails String Additional details of the target.
targetId ID ID of the target of the audit event.
targetType String Type of the target of the audit event.
user UserCore User associated with the audit event.

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.

AuditEventDefinitionConnection#

Paginated collection of AuditEventDefinition. See Standard connection fields for the fields available on every connection.

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.

Implements: BaseHeaderInterface

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.

AuditEventStreamingHeaderConnection#

Paginated collection of AuditEventStreamingHeader. See Standard connection fields for the fields available on every connection.

AuditEventsStreamingInstanceHeader#

Represents a HTTP header key/value that belongs to an instance level audit streaming destination.

Implements: BaseHeaderInterface

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.

AuditEventsStreamingInstanceHeaderConnection#

Paginated collection of AuditEventsStreamingInstanceHeader. See Standard connection fields for the fields available on every connection.

AutoRemediationConfiguration#

Auto-remediation configuration for a dependency scanning post-processing scan profile.

Fields#

Name Type Description
cooldown Int Minimum number of days after a package is released before it can be used.
enabled Boolean Indicates whether auto-remediation is enabled.
openMergeRequestsLimit Int Maximum number of open merge requests the feature may have open at once.
runnerTags [String!] Runner tags used for auto-remediation jobs.
severityLevel VulnerabilitySeverity Minimum vulnerability severity that triggers an automated upgrade.
upgradePolicy SecurityScanProfileUpgradePolicy Highest version bump allowed when remediating.

AutocompletedUser#

Core representation of a GitLab user.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean! Indicates if the user has composite identity enforcement enabled.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 Merge request state related to the user.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

AvailableModels#

Available models for Duo Agentic Chat.

Fields#

Name Type Description
defaultModel AiModelSelectionOfferedModel Default LLM for Duo Agentic Chat.
pinnedModel AiModelSelectionOfferedModel Pinned model for Duo Agentic Chat if set via feature settings.
selectableModels [AiModelSelectionOfferedModel!] LLMs compatible with Duo Agentic Chat.

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 the emoji.
user UserCore! User who awarded the emoji.

AwardEmojiConnection#

Paginated collection of AwardEmoji. See Standard connection fields for the fields available on every connection.

BaseService#

Implements: Service

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#

Implements: Entry

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! SHA of the entry.
type EntryType! Type of tree entry.
webPath String Web path of the blob.
webUrl String Web URL of the blob.

BlobConnection#

Paginated collection of Blob. See Standard connection fields for the fields available on every connection.

BlobSearch#

Full JSON structure of multi-match results in a single file.

Fields#

Name Type Description
durationS Float Introduced as an experiment in GitLab 18.0.

Duration of the request in seconds.
fileCount Int Introduced as an experiment in GitLab 17.2.

Total number of files with matches.
files [SearchBlobFileType!] Introduced as an experiment in GitLab 17.2.

List of files with matches.
matchCount Int Introduced as an experiment in GitLab 17.2.

Total number of matches.
perPage Int Introduced as an experiment in GitLab 17.2.

Total number of files per page.
searchLevel SearchLevel Introduced as an experiment in GitLab 17.2.

Level of search performed.
searchType SearchType Introduced as an experiment in GitLab 17.2.

Type of search performed.

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.
epics BoardEpicConnection Epics associated with board issues. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for epics:
issueFilters (BoardIssueInput)
Filters applied when selecting issues on the board.
sort (EpicSort)
List epics by sort order.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
lists BoardListConnection Lists of the board. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for lists:
id (ListID)
Find a list by its global ID.
issueFilters (BoardIssueInput)
Filters applied when getting issue metadata in the board list.
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.

BoardConnection#

Paginated collection of Board. See Standard connection fields for the fields available on every connection.

BoardEpic#

Represents an epic on an issue board.

Implements: CurrentUserTodos, Eventable, NoteableInterface, Todoable

Fields#

Name Type Description
ancestors EpicConnection Ancestors (parents) of the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ancestors:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
author UserCore! Author of the epic.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blocked Boolean Indicates the epic is blocked.
blockedByCount Int Count of epics blocking the epic.
blockedByEpics EpicConnection Epics blocking the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingCount Int Count of epics that the epic is blocking.
children EpicConnection Children (sub-epics) of the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for children:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
closedAt Time Timestamp of when the epic was closed.
color String Color of the epic.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
confidential Boolean Indicates if the epic is confidential.
createdAt Time Timestamp of when the epic was created.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
group Group! Group to which the epic belongs.
hasChildren Boolean! Indicates if the epic has children.
hasChildrenWithinTimeframe Boolean! Indicates if the epic has children in the specified timeframe.
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 String! Internal ID of the epic.
issues EpicIssueConnection A list of issues associated with the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
labels LabelConnection Labels assigned to the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems LinkedWorkItemTypeConnection Work items linked to the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedWorkItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
parent Epic Parent epic of the epic.
participants UserCoreConnection List of participants for the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
reference String! Internal reference of the epic. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Indicates if the reference should be returned in full.
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.
title String Title of the epic.
titleHtml String HTML 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.
workItemId WorkItemID! ID of the corresponding work item for a legacy epic.

BoardEpicConnection#

Paginated collection of BoardEpic. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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 the user.
id ID! ID (global ID) of the list.
issues IssueConnection Board issues. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issues:
filters (BoardIssueInput)
Filters applied when selecting issues in the board 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.
status WorkItemStatus Introduced as an experiment in GitLab 18.0.

Status of the list.
title String! Title of the list.
totalIssueWeight BigInt Total weight of all issues in the list, encoded as a string.

BoardListConnection#

Paginated collection of BoardList. See Standard connection fields for the fields available on every connection.

BooleanExpression#

an expression with a boolean value.

Implements: ExpressionInterface

Fields#

Name Type Description
field String! Field the expression applies to.
operator String! Operator of the expression.
value Boolean! Boolean value of the expression.

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.
isGroupLevel Boolean! Introduced as an experiment in GitLab 18.3.

Indicates whether the branch protection rule was created at the group level.
mergeAccessLevels MergeAccessLevelConnection Details about who can merge when the branch is the source branch. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
modificationBlockedByPolicy Boolean! Indicates if a security policy prevents modification.
protectedFromPushBySecurityPolicy Boolean! Indicates if a security policy prevents push or force push.
pushAccessLevels PushAccessLevelConnection Details about who can push when the branch is the source branch. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
unprotectAccessLevels UnprotectAccessLevelConnection Details about who can unprotect the branch. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
warnModificationBlockedByPolicy Boolean! Indicates if a warn mode security policy would prevent modification.
warnProtectedFromPushBySecurityPolicy Boolean! Indicates if a warn mode security policy would prevent push or force push.

BranchRule#

Branch rules configured for a rule target.

Fields#

Name Type Description
approvalRules ApprovalProjectRuleConnection Merge request approval rules configured for the branch rule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
branchProtection BranchProtection Branch protections configured for the branch rule.
createdAt Time Timestamp of when the branch rule was created.
externalStatusChecks ExternalStatusCheckConnection External status checks configured for the branch rule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ProjectsBranchRuleID ID of the branch rule.
isDefault Boolean! Check if the branch rule protects the project's default branch.
isGroupLevel Boolean! Introduced as an experiment in GitLab 19.3.

Indicates whether the branch rule was created at the group level. Unlike the equivalent field on BranchProtection, this field is readable by every user who can read the branch rule.
isProtected Boolean! Check if the branch rule protects access for the branch.
matchingBranchesCount Int! Number of existing branches that match the branch rule.
name String! Name of the branch rule target. Includes wildcards.
squashOption SquashOption Introduced as an experiment in GitLab 17.9.

Default behavior for squashing in merge requests.
updatedAt Time Timestamp of when the branch rule was last updated.

BranchRuleConnection#

Paginated collection of BranchRule. See Standard connection fields for the fields available on every connection.

BulkImportExportUploadUploadRegistry#

Represents the Geo replication and verification state of a bulk_import_export_upload_upload.

Fields#

Name Type Description
bulkImportExportUploadUploadId ID! ID of the bulk import/export archive upload.
checksumMismatch Boolean Indicate if the checksums of the BulkImportExportUploadUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the BulkImportExportUploadUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this BulkImportExportUploadUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the BulkImportExportUploadUploadRegistry.
lastSyncFailure String Error message during sync of the BulkImportExportUploadUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the BulkImportExportUploadUploadRegistry.
missingOnPrimary Boolean Indicate if the BulkImportExportUploadUploadRegistry is missing on primary.
modelRecordId Int ID of the BulkImportExportUploadUploadRegistry's model record.
retryAt Time Timestamp after which the BulkImportExportUploadUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the BulkImportExportUploadUploadRegistry.
state RegistryState Sync state of the BulkImportExportUploadUploadRegistry.
verificationChecksum String The local checksum of the BulkImportExportUploadUploadRegistry.
verificationChecksumMismatched String The expected checksum of the BulkImportExportUploadUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the BulkImportExportUploadUploadRegistry.
verificationRetryAt Time Timestamp after which the BulkImportExportUploadUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the BulkImportExportUploadUploadRegistry.
verificationStartedAt Time Timestamp when the verification of BulkImportExportUploadUploadRegistry started.
verificationState VerificationStateEnum Verification state of the BulkImportExportUploadUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the BulkImportExportUploadUploadRegistry.

BulkImportExportUploadUploadRegistryConnection#

Paginated collection of BulkImportExportUploadUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

BulkToolRuleResult#

Result for a single tool rule update within a bulk operation.

Fields#

Name Type Description
errors [String!]! Errors for the specific tool rule update.
toolId String! Tool name that was processed.
toolRule AiToolRule Updated tool rule, if successful.

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 the day.
completedWeight Int! Total weight of closed issues as of the day.
date ISO8601Date! Date for burnup totals.
scopeCount Int! Number of issues as of the day.
scopeWeight Int! Total weight of issues as of the day.

CarPermissions#

Check user's permission for the car.

Fields#

Name Type Description
deleteMergeTrainCar Boolean! If true, the user can perform delete_merge_train_car on this resource.

CdApplication#

Continuous deployment application.

Fields#

Name Type Description
applicationFlowDefinitions CdApplicationFlowDefinitionConnection Introduced as an experiment in GitLab 19.2.

Flow definitions of the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp of when the application was created.
deployments CdDeploymentConnection Introduced as an experiment in GitLab 19.2.

Deployments actuated by the application, across its most recent rollouts and environments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String Description of the application.
environments CdEnvironmentConnection Introduced as an experiment in GitLab 19.2.

Distinct environments the application has been rolled out to, based on the application's most recent rollouts. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
health CdServiceHealth Introduced as an experiment in GitLab 19.2.

Worst health reported across the application's services, or null when no health has been reported.
id CdApplicationID! Global ID of the application.
lastDeployedAt Time Introduced as an experiment in GitLab 19.2.

Timestamp of the application's most recently finished deployment, among its most recent rollouts.
links CdApplicationLinkConnection Introduced as an experiment in GitLab 19.2.

Links belonging to the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String! Name of the application.
organization Organization Organization the application belongs to.
rollouts CdRolloutConnection Introduced as an experiment in GitLab 19.2.

Rollouts of the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for rollouts:
search (String)
Search rollouts by ID (IID).
statuses ([CdRolloutStatus!])
Filter rollouts by status.
services CdServiceConnection Introduced as an experiment in GitLab 19.2.

Services belonging to the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for services:
search (String)
Search services by name or description.
status CdApplicationStatus Introduced as an experiment in GitLab 19.3.

Current status of the application, derived from its services' worst health and whether it has a rollout in progress, or null when neither applies.
updatedAt Time! Timestamp of when the application was last updated.
userPermissions CdApplicationPermissions Introduced as an experiment in GitLab 19.2.

Permissions of the current user for the application.
versionSets CdVersionSetConnection Introduced as an experiment in GitLab 19.2.

Version sets of the application. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versionSets:
search (String)
Search version sets by name or description.
statuses ([CdVersionSetStatus!])
Filter releases by status.

CdApplicationConnection#

Paginated collection of CdApplication. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdApplicationFlowDefinition#

Continuous deployment application flow definition.

Fields#

Name Type Description
application CdApplication Application the flow definition belongs to.
createdAt Time! Timestamp of when the application flow definition was created.
definition String Introduced as an experiment in GitLab 19.2.

Body of the application flow definition.
definitionSteps [CdDefinitionStep!] Introduced as an experiment in GitLab 19.3.

Top-level nodes of the flow definition's static step tree, computed from its YAML and not persisted. A stage node exposes its nested steps through its own steps field.
id CdApplicationFlowDefinitionID! Global ID of the application flow definition.
updatedAt Time! Timestamp of when the application flow definition was last updated.
version Int! Version of the application flow definition.

CdApplicationFlowDefinitionConnection#

Paginated collection of CdApplicationFlowDefinition. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

Continuous deployment application link.

Fields#

Name Type Description
application CdApplication! Application the link belongs to.
createdAt Time! Timestamp of when the link was created.
id CdApplicationLinkID! Global ID of the link.
linkType CdApplicationLinkType! Type of the link.
name String! Name of the link.
updatedAt Time! Timestamp of when the link was last updated.
url String! URL of the link.

CdApplicationLinkConnection#

Paginated collection of CdApplicationLink. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdApplicationPermissions#

Check permissions for the current user on a continuous deployment application.

Fields#

Name Type Description
createCdApplicationFlowDefinition Boolean! If true, the user can perform create_cd_application_flow_definition on this resource.
createCdApplicationLink Boolean! If true, the user can perform create_cd_application_link on this resource.
createCdRollout Boolean! If true, the user can perform create_cd_rollout on this resource.
createCdService Boolean! If true, the user can perform create_cd_service on this resource.
createCdVersionSet Boolean! If true, the user can perform create_cd_version_set on this resource.
readCdApplication Boolean! If true, the user can perform read_cd_application on this resource.
resolveCdRolloutGate Boolean! If true, the user can perform resolve_cd_rollout_gate on this resource.
updateCdApplication Boolean! If true, the user can perform update_cd_application on this resource.
updateCdService Boolean! If true, the user can perform update_cd_service on this resource.

CdArtifactSource#

Continuous deployment artifact source.

Fields#

Name Type Description
createdAt Time! Timestamp of when the artifact source was created.
id CdArtifactSourceID! Global ID of the artifact source.
name String Name of the artifact source.
service CdService Service the artifact source belongs to.
sourceConfig JSON Configuration of the artifact source, defined by the consuming driver.
sourceRef String Reference of the artifact source.
updatedAt Time! Timestamp of when the artifact source was last updated.
versions CdVersionConnection Introduced as an experiment in GitLab 19.2.

Versions of the artifact source. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

CdArtifactSourceConnection#

Paginated collection of CdArtifactSource. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdDefinitionStep#

Node in a continuous deployment flow definition step tree, computed from its YAML and not persisted.

Fields#

Name Type Description
environment CdEnvironment Environment the step targets, null for steps that target no environment (for example a stage container or a wait step) or that name an environment that does not exist.
name String Name of the step, as defined by the flow definition.
params JSON Step-specific configuration copied from the flow definition (for example wait seconds or canary service weights).
parentPath String Path of the parent step, null for a top-level step.
path String! Position of the step in the flow definition tree (for example "0", "0.1").
stepType String! Type of the step, as defined by the flow definition (for example "com.gitlab.cd.steps.stage" or a deploy driver step type).
steps [CdDefinitionStep!] Nested steps, for a stage step. Empty for any other step type.

CdDeployment#

Continuous deployment deployment.

Fields#

Name Type Description
createdAt Time! Timestamp of when the deployment was created.
deploymentTransitions CdDeploymentTransitionConnection Introduced as an experiment in GitLab 19.2.

Transition journal of the deployment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
finishedAt Time Timestamp of when the deployment finished.
id CdDeploymentID! Global ID of the deployment.
rolloutEnvironment CdRolloutEnvironment Rollout environment the deployment belongs to.
service CdService Service being deployed.
startedAt Time Timestamp of when the deployment started.
state CdDeploymentState! State of the deployment.
updatedAt Time! Timestamp of when the deployment was last updated.

CdDeploymentConnection#

Paginated collection of CdDeployment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdDeploymentTransition#

Continuous deployment deployment transition journal entry.

Fields#

Name Type Description
createdAt Time! Timestamp of when the transition was recorded.
event String! Event that triggered the transition.
fromState CdDeploymentTransitionState! State the deployment transitioned from.
id CdDeploymentTransitionID! Global ID of the deployment transition.
onBehalfOf String Originating principal a composite-identity action was performed on behalf of.
principal String! Identity reference of the principal that triggered the transition, for example user:1234.
reason String Reason for the transition.
toState CdDeploymentTransitionState! State the deployment transitioned to.
triggeredBy String Identifier of what triggered the transition.

CdDeploymentTransitionConnection#

Paginated collection of CdDeploymentTransition. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironment#

Continuous deployment environment.

Fields#

Name Type Description
applications CdEnvironmentApplicationConnection Introduced as an experiment in GitLab 19.3.

Applications with services in the environment, each with its service count in the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
applicationsCount Int! Introduced as an experiment in GitLab 19.3.

Number of applications with services in the environment.
createdAt Time! Timestamp of when the environment was created.
description String Description of the environment.
environmentDriverBindings CdEnvironmentDriverBindingConnection Introduced as an experiment in GitLab 19.2.

Driver bindings of the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
healthStatus CdServiceHealth Introduced as an experiment in GitLab 19.4.

Worst observed service health across the environment. Null when no service health has been reported.
id CdEnvironmentID! Global ID of the environment.
latestFinishedRolloutEnvironment CdRolloutEnvironment Introduced as an experiment in GitLab 19.4.

Most recently finished rollout environment for the environment.
name String! Name of the environment.
organization Organization Organization the environment belongs to.
rolloutEnvironments CdRolloutEnvironmentConnection Introduced as an experiment in GitLab 19.2.

Rollout environments of the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
serviceEnvironmentHealths CdServiceEnvironmentHealthConnection Introduced as an experiment in GitLab 19.2.

Observed service health in the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
servicesCount Int! Introduced as an experiment in GitLab 19.3.

Number of services with observed health in the environment.
tier CdEnvironmentTier! Tier of the environment.
updatedAt Time! Timestamp of when the environment was last updated.

CdEnvironmentApplication#

An application with services in a continuous deployment environment.

Fields#

Name Type Description
application CdApplication Introduced as an experiment in GitLab 19.3.

Application with services in the environment.
serviceEnvironmentHealths CdServiceEnvironmentHealthConnection Introduced as an experiment in GitLab 19.3.

Observed health of the application's services in the environment, each with the versions currently deployed there. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
servicesCount Int! Introduced as an experiment in GitLab 19.3.

Number of the application's services in the environment.

CdEnvironmentApplicationConnection#

Paginated collection of CdEnvironmentApplication. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironmentConnection#

Paginated collection of CdEnvironment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdEnvironmentDriverBinding#

Continuous deployment environment driver binding.

Fields#

Name Type Description
createdAt Time! Timestamp of when the environment driver binding was created.
driverConfig JSON! Introduced as an experiment in GitLab 19.2.

Configuration of the environment driver binding, defined by the driver's own schema.
driverRef String! Reference of the driver.
environment CdEnvironment Environment the driver binding belongs to.
id CdEnvironmentDriverBindingID! Global ID of the environment driver binding.
updatedAt Time! Timestamp of when the environment driver binding was last updated.
version Int! Version of the environment driver binding.

CdEnvironmentDriverBindingConnection#

Paginated collection of CdEnvironmentDriverBinding. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRollout#

Continuous deployment rollout.

Fields#

Name Type Description
application CdApplication Application the rollout belongs to.
applicationFlowDefinition CdApplicationFlowDefinition Introduced as an experiment in GitLab 19.2.

Flow definition the rollout was created from.
awaitingApproval Boolean! Introduced as an experiment in GitLab 19.3.

Indicates whether the rollout has an open approval gate awaiting a decision, derived from its transition journal.
createdAt Time! Timestamp of when the rollout was created.
finishedAt Time Timestamp of when the rollout finished.
gates [CdRolloutGate!] Introduced as an experiment in GitLab 19.4.

Approval gates recorded against the rollout, in the order they were opened, derived from its transition journal.
id CdRolloutID! Global ID of the rollout.
iid Int! Internal ID of the rollout, unique and user-facing within its application.
rolloutEnvironments CdRolloutEnvironmentConnection Introduced as an experiment in GitLab 19.2.

Rollout environments of the rollout. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
rolloutSteps [CdRolloutStep!] Introduced as an experiment in GitLab 19.3.

Top-level nodes of the rollout flow definition tree, in position order. A stage node exposes its nested steps through its own steps field.
rolloutTransitions CdRolloutTransitionConnection Introduced as an experiment in GitLab 19.2.

Transition journal of the rollout. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
startedAt Time Timestamp of when the rollout started.
state CdRolloutState! State of the rollout.
triggeredByUser UserCore Introduced as an experiment in GitLab 19.3.

User who triggered the rollout, derived from its transition journal. Null if the rollout was triggered by a non-user principal (for example, a policy or schedule).
updatedAt Time! Timestamp of when the rollout was last updated.
versionSet CdVersionSet Version set the rollout deploys.
workflowRef String Workflow reference of the rollout.

CdRolloutConnection#

Paginated collection of CdRollout. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutEnvironment#

Continuous deployment rollout environment.

Fields#

Name Type Description
createdAt Time! Timestamp of when the rollout environment was created.
deployments CdDeploymentConnection Introduced as an experiment in GitLab 19.2.

Deployments of the rollout environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
environment CdEnvironment Environment the rollout environment targets.
finishedAt Time Timestamp of when the rollout environment finished.
id CdRolloutEnvironmentID! Global ID of the rollout environment.
position Int! Position of the rollout environment in the rollout sequence.
rollout CdRollout Rollout the rollout environment belongs to.
startedAt Time Timestamp of when the rollout environment started.
state CdRolloutEnvironmentState! State of the rollout environment.
updatedAt Time! Timestamp of when the rollout environment was last updated.

CdRolloutEnvironmentConnection#

Paginated collection of CdRolloutEnvironment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutGate#

Continuous deployment rollout approval gate, derived from its transition journal.

Fields#

Name Type Description
id CdRolloutTransitionID! Global ID of the transition that opened the gate.
name String Label of the gate, derived from the step it was opened for.
reason String Reason the approval was requested for.
resolutionReason String Reason given when the gate was resolved, if any.
resolvedAt Time Timestamp of when the gate was resolved, null while still pending.
resolvedBy UserCore User that resolved the gate, when the resolving principal identifies a user that still exists; null while pending or for other principal kinds.
state CdRolloutGateState! State of the gate.
step CdRolloutStep Rollout step the gate was opened for, null for a gate opened for a non-step reason.

CdRolloutStep#

Node in a continuous deployment rollout flow definition tree.

Fields#

Name Type Description
createdAt Time! Timestamp of when the step was created.
environment CdEnvironment Environment the step targets, null for steps that target no environment (for example a stage container or a wait step).
error String Error message of the step, if it failed.
finishedAt Time Timestamp of when the step finished.
id CdRolloutStepID! Global ID of the rollout step.
name String Name of the step, as defined by the flow definition.
params JSON Step-specific configuration copied from the flow definition (for example wait seconds or canary service weights).
parentPath String Path of the parent step, null for a top-level step.
path String! Position of the step in the flow definition tree (for example "0", "0.1").
startedAt Time Timestamp of when the step started.
state CdRolloutStepState! State of the step.
stepType String! Type of the step, as defined by the flow definition (for example "com.gitlab.cd.steps.stage" or a deploy driver step type).
steps [CdRolloutStep!] Nested steps, for a stage step. Empty for any other step type.
updatedAt Time! Timestamp of when the step was last updated.

CdRolloutTransition#

Continuous deployment rollout transition journal entry.

Fields#

Name Type Description
createdAt Time! Timestamp of when the transition was recorded.
event String! Event that triggered the transition.
fromState CdRolloutTransitionState! State the rollout transitioned from.
id CdRolloutTransitionID! Global ID of the rollout transition.
onBehalfOf String Originating principal a composite-identity action was performed on behalf of.
principal String! Identity reference of the principal that triggered the transition, for example user:1234.
principalUser UserCore Introduced as an experiment in GitLab 19.3.

User that triggered the transition, when the principal identifies a user that still exists; null for other principal kinds or a deleted user.
reason String Reason for the transition.
resolutionReason String Reason given when resolving an approval gate, for an approve/reject transition.
toState CdRolloutTransitionState! State the rollout transitioned to.
triggeredBy String Identifier of what triggered the transition.

CdRolloutTransitionConnection#

Paginated collection of CdRolloutTransition. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdRolloutUpdate#

Live rollout update pushed to the client: new deployment status, and a Duo session to open when one applies.

Fields#

Name Type Description
reason CdRolloutUpdateReason Why Duo should engage for the update (failed or created); null for a plain status update.
rollout CdRollout! Rollout the update is for.
rolloutEnvironment CdRolloutEnvironment Rollout environment whose state changed. Read its state and environment.tier to color the stage dot.
thread AiConversationsThread Duo session to open in the sidebar for the update, when one applies.

CdService#

Continuous deployment service.

Fields#

Name Type Description
application CdApplication! Application the service belongs to.
artifactSources CdArtifactSourceConnection Introduced as an experiment in GitLab 19.2.

Artifact sources of the service. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp of when the service was created.
description String Description of the service.
id CdServiceID! Global ID of the service.
lastDeployedAt Time Introduced as an experiment in GitLab 19.2.

Timestamp of the service's most recently finished deployment.
name String! Name of the service.
serviceEnvironmentHealths CdServiceEnvironmentHealthConnection Introduced as an experiment in GitLab 19.2.

Observed health of the service across environments, ordered from worst to best. Request the first result to get the worst observed health of the service overall. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp of when the service was last updated.

CdServiceConnection#

Paginated collection of CdService. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdServiceEnvironmentHealth#

Observed health of a continuous deployment service in an environment.

Fields#

Name Type Description
createdAt Time! Timestamp of when the service environment health was created.
deployedVersions CdVersionConnection Introduced as an experiment in GitLab 19.3.

Versions of the service currently deployed in this environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
environment CdEnvironment Environment the health belongs to.
health CdServiceHealth! Observed health of the service in the environment.
id CdServiceEnvironmentHealthID! Global ID of the service environment health.
observedAt Time! Timestamp of when the health was observed.
service CdService Service the health belongs to.

CdServiceEnvironmentHealthConnection#

Paginated collection of CdServiceEnvironmentHealth. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersion#

Continuous deployment artifact version.

Fields#

Name Type Description
artifactSource CdArtifactSource Artifact source the version belongs to.
createdAt Time! Timestamp of when the version was created.
digest String Digest of the version.
environments CdEnvironmentConnection Introduced as an experiment in GitLab 19.2.

Distinct environments the version has been deployed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id CdVersionID! Global ID of the version.
name String! Name of the version.
reference String Reference of the version.
updatedAt Time! Timestamp of when the version was last updated.
verified Boolean! Indicates the version was observed being pushed to the artifact source, rather than entered as a free-text name.

CdVersionConnection#

Paginated collection of CdVersion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersionSet#

Continuous deployment version set.

Fields#

Name Type Description
application CdApplication Application the version set belongs to.
author UserCore Introduced as an experiment in GitLab 19.3.

User who created the version set. Null if it was created before author tracking was added.
createdAt Time! Timestamp of when the version set was created.
description String Description of the version set.
entriesDigest String Digest of the version set entries.
id CdVersionSetID! Global ID of the version set.
name String! Name of the version set.
rollouts CdRolloutConnection Introduced as an experiment in GitLab 19.2.

Rollouts of the version set. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for rollouts:
search (String)
Search rollouts by ID (IID).
statuses ([CdRolloutStatus!])
Filter rollouts by status.
status CdVersionSetStatus Introduced as an experiment in GitLab 19.3.

High-level lifecycle status of the release, or null when the release is currently live and has not been superseded or rolled back.
updatedAt Time! Timestamp of when the version set was last updated.
versionSetEntries CdVersionSetEntryConnection Introduced as an experiment in GitLab 19.2.

Entries of the version set. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

CdVersionSetConnection#

Paginated collection of CdVersionSet. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CdVersionSetEntry#

Continuous deployment version set entry.

Fields#

Name Type Description
artifactSource CdArtifactSource Artifact source the entry references.
createdAt Time! Timestamp of when the version set entry was created.
id CdVersionSetEntryID! Global ID of the version set entry.
service CdService Service the entry references.
updatedAt Time! Timestamp of when the version set entry was last updated.
version CdVersion Version the entry references.
versionSet CdVersionSet Version set the entry belongs to.

CdVersionSetEntryConnection#

Paginated collection of CdVersionSetEntry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

CiBuildNeedConnection#

Paginated collection of CiBuildNeed. See Standard connection fields for the fields available on every connection.

CiCatalogBundledResource#

A GitLab-maintained bundled CI/CD catalog resource on the current cell.

Fields#

Name Type Description
description String Introduced as an experiment in GitLab 19.3.

Description of the bundled catalog resource.
fullPath ID Introduced as an experiment in GitLab 19.3.

Full path of the bundled catalog resource (for example, components/sast).
id ID! Introduced as an experiment in GitLab 19.3.

ID of the bundled catalog resource.
latestReleasedAt Time Introduced as an experiment in GitLab 19.3.

Release date of the bundled catalog resource's latest version.
latestVersionName String Introduced as an experiment in GitLab 19.3.

Name of the latest version of the bundled catalog resource (for example, v1.2.3).
name String Introduced as an experiment in GitLab 19.3.

Name of the bundled catalog resource.
serverFqdn String Introduced as an experiment in GitLab 19.3.

FQDN of the GitLab instance that maintains the bundled catalog resource.

CiCatalogBundledResourceConnection#

Paginated collection of CiCatalogBundledResource. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCatalogResource#

Fields#

Name Type Description
archived Boolean Indicates the archived status of the project.
description String Description of the catalog resource.
fullPath ID Introduced as an experiment in GitLab 16.11.

Full project path of the catalog resource.
icon String Icon for the catalog resource.
id ID! ID of the catalog resource.
last30DayUsageCount Int! Introduced as an experiment in GitLab 17.0.

Number of unique projects that used a component from this catalog project in a pipeline by using include:component in the last 30 days.
latestReleasedAt Time Introduced as an experiment in GitLab 16.5.

Release date of the catalog resource's latest version.
name String Name of the catalog resource.
projectComponentUsages CiCatalogResourceProjectUsageConnection Introduced as an experiment in GitLab 18.11.

Projects using components from this catalog resource. Only available to maintainers of the catalog resource project. This field can only be resolved for one catalog resource in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectComponentUsages:
componentName (String)
Filter to projects using a component with this name. Matches across all versions of the catalog resource.
sort (CiCatalogResourceProjectUsageSort)
Sort projects by given criteria.
versionId (CiCatalogResourcesVersionID)
Filter to projects using a specific version of the catalog resource.
versionIds ([CiCatalogResourcesVersionID!])
Returns projects that used one or more specific versions of the catalog resource.
starCount Int! Number of times the catalog resource has been starred.
starrersPath String Relative path to the starrers page for the catalog resource project.
topics [String!] Topics for the catalog resource.
verificationLevel CiCatalogResourceVerificationLevel Verification level of the catalog resource.
versions CiCatalogResourceVersionConnection Versions of the catalog resource. This field can only be resolved for one catalog resource in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
name (String)
Name of the version.
search (String)
Search term to filter versions by name.
visibilityLevel VisibilityLevelsEnum Visibility level of the catalog resource.
webPath String Introduced as an experiment in GitLab 16.1.

Web path of the catalog resource.

CiCatalogResourceComponent#

Fields#

Name Type Description
description String Description of the component.
id CiCatalogResourcesComponentID! ID of the component.
includePath String Path used to include the component.
inputs [CiInputsSpec!] Inputs for the component.
last30DayUsageCount Int Number of unique projects that used this version of the component in a pipeline by using include in the last 30 days.
name String Name of the component.

CiCatalogResourceComponentConnection#

Paginated collection of CiCatalogResourceComponent. See Standard connection fields for the fields available on every connection.

CiCatalogResourceComponentUsage#

Represents a component usage in a project.

Fields#

Name Type Description
lastUsedDate ISO8601Date When the component was last used.
name String Name of the component.
version String Version of the component.

CiCatalogResourceComponentUsageConnection#

Paginated collection of CiCatalogResourceComponentUsage. See Standard connection fields for the fields available on every connection.

CiCatalogResourceComponentUsageDetail#

Details of a project's usage of a component from a catalog resource.

Fields#

Name Type Description
component CiCatalogResourceComponent! Introduced as an experiment in GitLab 18.11.

Component being used.
lastUsedDate ISO8601Date! Introduced as an experiment in GitLab 18.11.

Date when the component was last used by the project.
outdated Boolean! Introduced as an experiment in GitLab 18.11.

Whether the project is using a component version older than the catalog resource latest version.
version CiCatalogResourceVersion Introduced as an experiment in GitLab 18.11.

Version of the component being used.

CiCatalogResourceConnection#

Paginated collection of CiCatalogResource. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCatalogResourceProjectUsage#

A project that uses components from a catalog resource.

Fields#

Name Type Description
componentsUsed [CiCatalogResourceComponentUsageDetail!]! Introduced as an experiment in GitLab 18.11.

List of components from the catalog resource used by the project.
project Project Introduced as an experiment in GitLab 18.11.

Project using the components. Returns null if user cannot access the project.

CiCatalogResourceProjectUsageConnection#

Paginated collection of CiCatalogResourceProjectUsage. See Standard connection fields for the fields available on every connection.

CiCatalogResourceSemver#

Semantic version information for a catalog resource version.

Fields#

Name Type Description
major Int Major version number.
minor Int Minor version number.
patch Int Patch version number.

CiCatalogResourceVersion#

Fields#

Name Type Description
author UserCore User that created the version.
commit Commit Commit associated with the version.
components CiCatalogResourceComponentConnection Components belonging to the catalog resource. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time Timestamp of when the version was created.
id CiCatalogResourcesVersionID! Global ID of the version.
name String Name that uniquely identifies the version within the catalog resource.
path String Relative web path to the version.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.
releasedAt Time Introduced as an experiment in GitLab 16.7.

Timestamp of when the version was released.
semver CiCatalogResourceSemver Semantic version information.

CiCatalogResourceVersionConnection#

Paginated collection of CiCatalogResourceVersion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiCdSettings#

Fields#

Name Type Description
pipelineVariablesDefaultRole String Indicates the default minimum role required to override pipeline variables in the namespace.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the job group.
size Int Size of the job group.

CiConfigGroupConnection#

Paginated collection of CiConfigGroup. See Standard connection fields for the fields available on every connection.

CiConfigGroupV2#

Fields#

Name Type Description
jobs [CiConfigJobV2!] Jobs in group.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

CiConfigJobConnection#

Paginated collection of CiConfigJob. See Standard connection fields for the fields available on every connection.

CiConfigJobRestriction#

Fields#

Name Type Description
refs [String!] Git refs the job restriction applies to.

CiConfigJobV2#

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 [CiConfigNeed!] Builds that must complete before the jobs run.
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.

CiConfigNeed#

Fields#

Name Type Description
name String Name of the need.

CiConfigNeedConnection#

Paginated collection of CiConfigNeed. See Standard connection fields for the fields available on every connection.

CiConfigStage#

Fields#

Name Type Description
groups CiConfigGroupConnection Groups of jobs for the stage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the stage.

CiConfigStageConnection#

Paginated collection of CiConfigStage. See Standard connection fields for the fields available on every connection.

CiConfigStageV2#

Fields#

Name Type Description
groups [CiConfigGroupV2!] Groups of jobs for the stage.
name String Name of the stage.

CiConfigV2#

Fields#

Name Type Description
errors [String!] Linting errors.
includes [CiConfigInclude!] List of included files.
mergedYaml String Merged CI configuration YAML.
stages [CiConfigStageV2!] Stages of the pipeline.
status CiConfigStatus Status of linting, can be either valid or invalid.
warnings [String!] Linting warnings.

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.

CiDedicatedHostedRunnerFilters#

Filter options available for GitLab Dedicated runner usage data.

Fields#

Name Type Description
deletedRunners CiDeletedRunnerConnection List of runner IDs from usage data without associated runner records. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
runners CiRunnerConnection List of unique runners with usage data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
years [Int!] List of years with available usage data.

CiDedicatedHostedRunnerUsage#

Compute usage data for hosted runners on GitLab Dedicated.

Fields#

Name Type Description
billingMonth String! Month of the usage data.
billingMonthIso8601 ISO8601Date! Timestamp of the billing month in ISO 8601 format.
computeMinutes Int! Total compute minutes used across all namespaces. Values are rounded down to the nearest integer.
computeMinutesUsage Float! Total compute minutes used across all namespaces.
durationMinutes Float! Total duration in minutes of runner usage.
durationSeconds Int! Total duration in seconds of runner usage. Values are rounded down to the nearest integer.
rootNamespace NamespaceUnion Namespace associated with the usage data. Null for instance aggregate data.

CiDedicatedHostedRunnerUsageConnection#

Paginated collection of CiDedicatedHostedRunnerUsage. See Standard connection fields for the fields available on every connection.

CiDeletedNamespace#

Reference to a namespace that no longer exists.

Fields#

Name Type Description
id NamespaceID ID of the deleted namespace.

CiDeletedRunner#

Reference to a deleted runner.

Fields#

Name Type Description
id CiRunnerID! Global ID of the deleted runner.

CiDeletedRunnerConnection#

Paginated collection of CiDeletedRunner. See Standard connection fields for the fields available on every connection.

CiDurationStatistics#

Histogram of durations for a group of CI/CD jobs or pipelines.

Fields#

Name Type Description
mean Duration Introduced as an experiment in GitLab 18.7.

Mean (average) duration.
p50 Duration Introduced as an experiment in GitLab 15.8.

50th percentile. 50% of the durations are lower than this value.
p75 Duration Introduced as an experiment in GitLab 15.8.

75th percentile. 75% of the durations are lower than this value.
p90 Duration Introduced as an experiment in GitLab 15.8.

90th percentile. 90% of the durations are lower than this value.
p95 Duration Introduced as an experiment in GitLab 15.8.

95th percentile. 95% of the durations are lower than this value.
p99 Duration Introduced as an experiment in GitLab 15.8.

99th percentile. 99% of the durations are lower than this value.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the job group.
size Int Size of the group.

CiGroupConnection#

Paginated collection of CiGroup. See Standard connection fields for the fields available on every connection.

CiGroupEnvironmentScope#

CI/CD environment scope for a group.

Fields#

Name Type Description
name String Scope name defininig the enviromnments that can use the variable.

CiGroupEnvironmentScopeConnection#

Paginated collection of CiGroupEnvironmentScope. See Standard connection fields for the fields available on every connection.

CiGroupVariable#

CI/CD variables for a group.

Implements: CiVariable

Fields#

Name Type Description
description String Description of the variable.
environmentScope String Scope defining the environments that can use the variable.
hidden Boolean Indicates whether the variable is hidden.
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.

CiGroupVariableConnection#

Paginated collection of CiGroupVariable. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
limit Int! Maximum amount of group CI/CD variables.

CiInputsCondition#

Condition node in rule expression tree.

Fields#

Name Type Description
children [CiInputsCondition!] Child conditions for AND/OR nodes.
field String Input field name for comparison nodes.
operator String! Operator type: equals, not_equals, AND, OR.
value CiInputsValue Expected value for comparison nodes.

CiInputsField#

CI input saved for a pipeline schedule.

Fields#

Name Type Description
name String! Name of the input.
value CiInputsValue Value of the input.

CiInputsFieldConnection#

Paginated collection of CiInputsField. See Standard connection fields for the fields available on every connection.

CiInputsRule#

Conditional rule for dynamic input options.

Fields#

Name Type Description
conditionTree CiInputsCondition Parsed condition tree for frontend eval.
default CiInputsValue Default value when rule matches. Can be a string, array, number, or boolean.
if String Condition expression.
options [CiInputsValue!] Available options when rule matches. Each option can be a string, array, number, or boolean.

CiInputsSpec#

Input for pipeline creation.

Fields#

Name Type Description
default CiInputsValue Default value for the input, if provided.
description String Description of the input.
name String! Name of the input.
options CiInputsValue Possible values that the input can take, if provided.
regex String Regular expression pattern that the input value must match if provided.
required Boolean! Indicates whether the input is required.
rules [CiInputsRule!] Conditional rules for dynamic input options.
type CiInputsType! Input data type.

CiInstanceVariable#

CI/CD variables for a GitLab instance.

Implements: CiVariable

Fields#

Name Type Description
description String Description of the variable.
environmentScope String Deprecated in GitLab 15.3. No longer used, only available for GroupVariableType and ProjectVariableType.
hidden Boolean Indicates whether the variable is hidden.
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.

CiInstanceVariableConnection#

Paginated collection of CiInstanceVariable. See Standard connection fields for the fields available on every connection.

CiJob#

Implements: CiJobInterface

Fields#

Name Type Description
active Boolean! Indicates the job is active.
allowFailure Boolean! Whether the job is allowed to fail.
artifacts CiJobArtifactConnection Artifacts generated by the job. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
exitCode Int Exit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code.
expandedEnvironmentName String Variable-expanded name of the environment the job is configured to deploy to, recorded when the pipeline was created. Null when the job does not declare an environment, or when no name was recorded for it.
failureMessage String Message on why the job failed.
finishedAt Time When a job has finished running.
id JobID ID of the job.
inputs [CiInputsField!] Input values that were used when the job was created or retried. A value is only present in the field if it differs from the default value in the input configuration. This field can only be resolved for one job in any single request.
inputsSpec [CiInputsSpec!] Input specification for the job. Defines the inputs that can be provided when creating or retrying the job. This field can only be resolved for one job in any single request.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the job.
needs CiBuildNeedConnection References to builds that must complete before the jobs run. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipeline PipelineInterface Pipeline the job belongs to.
playPath String Play path of the job.
playable Boolean! Indicates the job can be played.
previousStageJobs CiJobConnection Deprecated in GitLab 19.2. No longer required. Previous stage jobs are now computed on the client side. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
previousStageJobsOrNeeds JobNeedUnionConnection Deprecated in GitLab 16.4. Replaced by previousStageJobs and needs fields. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
retryPath String Retry path of the job.
retryable Boolean! Indicates the job can be retried.
runner CiRunner Runner assigned to execute the job.
runnerManager CiRunnerManager 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.
source String Policy or action that initiated the job. If not set, the value is inherited from the pipeline.
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.

CiJobAnalytics#

CI/CD job analytics data.

Fields#

Name Type Description
name String Job name.
stageName String Stage name.
statistics CiJobAnalyticsStatistics Statistics for the jobs.

CiJobAnalyticsConnection#

Paginated collection of CiJobAnalytics. See Standard connection fields for the fields available on every connection.

CiJobAnalyticsStatistics#

Statistics for CI/CD job analytics.

Fields#

Name Type Description
count BigInt Count of jobs, optionally filtered by status.

Arguments for count:
status (PipelineAnalyticsJobStatus)
Filter job count by status.
durationStatistics CiDurationStatistics Duration statistics for the jobs.
rate Float Percentage of jobs, optionally filtered by status. SUCCESS and FAILED rates use (success + failed) as the denominator; OTHER (canceled or skipped) uses the total job count.

Arguments for rate:
status (PipelineAnalyticsJobStatus)
Filter job rate by status. If not specified, returns 100.0 (representing all jobs).

CiJobArtifact#

Fields#

Name Type Description
downloadPath String URL for downloading the artifact's file.
expireAt Time Expiry date of the artifact.
expired Boolean! Expired state 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.

CiJobArtifactConnection#

Paginated collection of CiJobArtifact. See Standard connection fields for the fields available on every connection.

CiJobConnection#

Paginated collection of CiJob. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

CiJobInterfaceConnection#

Paginated collection of CiJobInterface. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

CiJobMinimalAccess#

Implements: CiJobInterface

Fields#

Name Type Description
active Boolean! Indicates the job is active.
allowFailure Boolean! Whether the job is allowed to fail.
artifacts CiJobArtifactConnection Artifacts generated by the job. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
duration Int Duration of the job in seconds.
erasedAt Time When the job was erased.
exitCode Int Exit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code.
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.
name String Name of the job.
pipeline PipelineInterface Pipeline the job belongs to.
playPath String Play path of the job.
playable Boolean Indicates the job can be played.
project ProjectInterface 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.
retryPath String Retry path of the job.
retryable Boolean Indicates the job can be retried.
runner CiRunner Runner assigned to execute 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.
source String Policy or action that initiated the job. If not set, the value is inherited from the pipeline.
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 job.
webPath String Web path of the job.

CiJobTokenAccessibleGroup#

Group that can access the current project by authenticating with a CI/CD job token.

Fields#

Name Type Description
avatarUrl String Avatar URL of the group.
fullPath ID! Full path of the group.
id ID! ID of the group.
name String! Name of the group.
path String! Path of the group.
webUrl String Web URL of the group.

CiJobTokenAccessibleGroupConnection#

Paginated collection of CiJobTokenAccessibleGroup. See Standard connection fields for the fields available on every connection.

CiJobTokenAccessibleProject#

Project that can access the current project by authenticating with a CI/CD job token.

Fields#

Name Type Description
avatarUrl String URL to avatar image file of the project.
fullPath ID! Full path of the project.
id ID! ID of the project.
name String! Name of the project (without namespace).
path String! Path of the project.
webUrl String Web URL of the project.

CiJobTokenAccessibleProjectConnection#

Paginated collection of CiJobTokenAccessibleProject. See Standard connection fields for the fields available on every connection.

CiJobTokenAuthLog#

Fields#

Name Type Description
lastAuthorizedAt Time! Introduced as an experiment in GitLab 17.6.

Last authorization date time.
originProject CiJobTokenAccessibleProject! Introduced as an experiment in GitLab 17.6.

Origin project.

CiJobTokenAuthLogConnection#

Paginated collection of CiJobTokenAuthLog. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiJobTokenScopeAllowlist#

Fields#

Name Type Description
groupsAllowlist CiJobTokenScopeAllowlistEntryConnection Allowlist of groups that can access the current project by authenticating with a CI/CD job token. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projectsAllowlist CiJobTokenScopeAllowlistEntryConnection Allowlist of projects that can access the current project by authenticating with a CI/CD job token. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

CiJobTokenScopeAllowlistEntry#

Represents an allowlist entry for the CI_JOB_TOKEN.

Fields#

Name Type Description
addedBy UserCore User that added the entry.
autopopulated Boolean Indicates whether the entry is created by the autopopulation process.
createdAt Time! When the entry was created.
defaultPermissions Boolean Indicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
direction String Deprecated in GitLab 18.0. Outbound job token scope is being removed. This field can only be INBOUND.
jobTokenPolicies [CiJobTokenScopePolicies!] Introduced as an experiment in GitLab 17.5.

List of policies for the entry.
sourceProject Project! Project that owns the allowlist entry.
target CiJobTokenScopeTarget Group or project allowed by the entry.

CiJobTokenScopeAllowlistEntryConnection#

Paginated collection of CiJobTokenScopeAllowlistEntry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiJobTokenScopeType#

Fields#

Name Type Description
groupAllowlistAutopopulatedIds [GroupID!]! List of IDs of groups which have been created by the autopopulation process.
groupsAllowlist CiJobTokenAccessibleGroupConnection! Allowlist of groups that can access the current project by authenticating with a CI/CD job token. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupsAllowlistCount Int! Count of groups that can access the current project by authenticating with a CI/CD job token. The count does not include subgroups.
inboundAllowlist CiJobTokenAccessibleProjectConnection! Allowlist of projects that can access the current project by authenticating with a CI/CD job token. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
inboundAllowlistAutopopulatedIds [ProjectID!]! List of IDs of projects which have been created by the autopopulation process.
inboundAllowlistCount Int! Count of projects that can access the current project by authenticating with a CI/CD job token. The count does not include nested projects.
outboundAllowlist ProjectConnection! Deprecated in GitLab 18.0. Outbound job token scope is being removed. Only inbound allowlist is supported. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projects ProjectConnection! Deprecated in GitLab 15.9. The projects attribute is being deprecated. Use outbound_allowlist. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

CiJobTrace#

Fields#

Name Type Description
htmlSummary String! Introduced as an experiment in GitLab 15.11.

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.

Arguments for htmlSummary:
lastLines (Int)
Number of tail lines to return, up to a maximum of 100 lines.

CiJobsStatistics#

Statistics for a group of CI jobs.

Fields#

Name Type Description
queuedDuration CiDurationStatistics Statistics for the amount of time that jobs were waiting to be picked up. The calculation is based on the 100 most recent jobs run by the 5000 most recently created runners in context. If no filter is applied to runners, the calculation uses the 100 most recent jobs globally.

CiManualVariable#

CI/CD variables given to a manual job.

Implements: CiVariable

Fields#

Name Type Description
environmentScope String Deprecated in GitLab 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.

CiManualVariableConnection#

Paginated collection of CiManualVariable. See Standard connection fields for the fields available on every connection.

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 Deprecated in GitLab 19.1. Use ciMinutesProjectMonthlyUsage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
sharedRunnersDuration Int Total duration (in seconds) of shared runners use by the namespace for the month.

CiMinutesNamespaceMonthlyUsageConnection#

Paginated collection of CiMinutesNamespaceMonthlyUsage. See Standard connection fields for the fields available on every connection.

CiMinutesProjectMonthlyUsage#

Fields#

Name Type Description
minutes Int Number of compute minutes used by the project in the month.
project Project Project having the recorded usage.
sharedRunnersDuration Int Total duration (in seconds) of shared runners use by the project for the month.

CiMinutesProjectMonthlyUsageConnection#

Paginated collection of CiMinutesProjectMonthlyUsage. See Standard connection fields for the fields available on every connection.

CiPipelineCreationRequest#

Information about an asynchronous pipeline creation request.

Fields#

Name Type Description
error String Error message if pipeline creation failed.
id String Unique ID of the pipeline creation request.
pipeline Pipeline Pipeline object created by the request.
pipelineId CiPipelineID ID of the created pipeline if creation was successful.
status CiPipelineCreationStatus! Current status of the pipeline creation.
userInitiated Boolean! Indicates whether the pipeline creation was explicitly requested by a user.

CiProjectSubscription#

Fields#

Name Type Description
author UserCore Author of the subscription.
downstreamProject CiSubscriptionsProjectDetails Downstream project of the subscription.When an upstream project's pipeline completes, a pipeline is triggered in the downstream project.
id CiSubscriptionsProjectID Global ID of the subscription.
upstreamProject CiSubscriptionsProjectDetails Upstream project of the subscription.When an upstream project's pipeline completes, a pipeline is triggered in the downstream project.

CiProjectSubscriptionConnection#

Paginated collection of CiProjectSubscription. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiProjectVariable#

CI/CD variables for a project.

Implements: CiVariable

Fields#

Name Type Description
description String Description of the variable.
environmentScope String Scope defining the environments that can use the variable.
hidden Boolean Indicates whether the variable is hidden.
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.

CiProjectVariableConnection#

Paginated collection of CiProjectVariable. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
limit Int! Maximum amount of project CI/CD variables.

CiRunner#

Fields#

Name Type Description
accessLevel CiRunnerAccessLevel! Access level of the runner.
active Boolean! Deprecated in GitLab 14.8. Use paused. This field is the inverse of paused and has no relationship to the runner's job execution status. For more details, see jobExecutionStatus.
adminUrl String Admin URL of the runner. Only available for administrators.
contactedAt Time Timestamp of last contact from the runner.
createdAt Time Timestamp of creation of the runner.
createdBy UserCore User that created the runner.
creationMethod CiRunnerCreationMethod Introduced as an experiment in GitLab 17.0.

Type of runner registration.
creationState CiRunnerCreationState Runner creation state. Used to determine if a runner has been registered and has contacted the GitLab instance.
description String Description of the runner.
editAdminUrl String Admin form URL of the runner. Only available for administrators.
ephemeralAuthenticationToken String Introduced as an experiment in GitLab 15.9.

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 as an experiment in GitLab 15.11.

URL of the registration page of the runner manager. Only available for the creator of the runner for a limited time during registration.
groups GroupInterfaceConnection Groups the runner is associated with. For group runners only. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id CiRunnerID! ID of the runner.
jobCount Int 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. The count only includes jobs on recent CI build partitions.

Arguments for jobCount:
statuses ([CiJobStatus!])
Filter jobs by status.
jobExecutionStatus CiRunnerJobExecutionStatus Job execution status of the runner.
jobs CiJobInterfaceConnection Jobs assigned to the runner. This field can only be resolved for one runner in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobs:
statuses ([CiJobStatus!])
Filter jobs by status.
locked Boolean Indicates the runner is locked.
maintenanceNote String Runner's maintenance notes.
maintenanceNoteHtml String GitLab Flavored Markdown rendering of maintenance_note.
managers CiRunnerManagerConnection Runner managers associated with the runner configuration. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for managers:
status (CiRunnerStatus)
Filter runner managers by status.
systemId (String)
Filter runner managers by system ID.
maximumTimeout Int Maximum timeout (in seconds) for jobs processed by the runner.
ownerProject ProjectInterface Project that owns the runner. For project runners only.
paused Boolean! Indicates the runner is paused and not available to run jobs.
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. The count includes projects that might not be visible to the current user.
projects ProjectConnection Find projects the runner is associated with. For project runners only. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
membership (Boolean)
Return only projects that the current user is a member of.
namespacePath (ID)
Filter projects by their namespace's full path (group or user).
personal (Boolean)
Return only personal projects.
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. Defaults to id_desc, or similarity if search used.
topics ([String!])
Filter projects by topics.
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.
runUntagged Boolean! Indicates the runner is able to run untagged jobs.
runnerType CiRunnerType! Type of the runner.
shortSha String First eight characters of the runner's token used to authenticate new job requests. Used as the runner's unique ID.
status CiRunnerStatus! Status of the runner.
tagList [String!] Tags associated with the runner.
tokenExpiresAt Time Runner token expiration time.
tokenRotationDeadline Time Introduced as an experiment in GitLab 18.10.

Deadline after which token rotation is rejected.
upgradeStatus CiRunnerUpgradeStatus Availability of upgrades for the runner.
userPermissions RunnerPermissions! Permissions for the current user on the resource.

CiRunnerCloudProvisioningStep#

Step used to provision the runner to Google Cloud.

Fields#

Name Type Description
instructions String Instructions to provision the runner.
languageIdentifier String Identifier of the language used for the instructions field. This identifier can be any of the identifiers specified in the list of supported languages and lexers.
title String Title of the step.

CiRunnerConnection#

Paginated collection of CiRunner. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
jobsStatistics CiJobsStatistics Jobs statistics for jobs executed by a collection of runners. Available only to admins.

CiRunnerEdge#

An edge in a connection.

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 the 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 the field in the query. You can use it for projects or groups.

CiRunnerGkeProvisioning#

Information used for GKE runner provisioning.

Fields#

Name Type Description
projectSetupShellScript String Instructions for setting up a Google Cloud project.
provisioningSteps [CiRunnerGkeProvisioningStep!] Steps used to provision a runner in GKE.

Arguments for provisioningSteps:
nodePools ([GoogleCloudNodePool!])
Configuration for the node pools of the runner.
region (GoogleCloudRegion!)
Name of the region to provision the runner in.
runnerToken (String!)
Authentication token of the runner.
zone (GoogleCloudZone!)
Name of the zone to provision the runner in.

CiRunnerGkeProvisioningStep#

Step used to provision the runner to GKE.

Fields#

Name Type Description
instructions String Instructions to provision the runner.
languageIdentifier String Identifier of the language used for the instructions field. This identifier can be any of the identifiers specified in the list of supported languages and lexers.
title String Title of the step.

CiRunnerGoogleCloudProvisioning#

Information used for runner Google Cloud provisioning.

Fields#

Name Type Description
projectSetupShellScript String Instructions for setting up a Google Cloud project.
provisioningSteps [CiRunnerCloudProvisioningStep!] Steps used to provision a runner in the cloud.

Arguments for provisioningSteps:
ephemeralMachineType (GoogleCloudMachineType!)
Name of the machine type to use for running jobs.
region (GoogleCloudRegion!)
Name of the region to provision the runner in.
runnerToken (String)
Authentication token of the runner.
zone (GoogleCloudZone!)
Name of the zone to provision the runner in.

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 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 Availability of upgrades for the runner manager.
version String Version of the runner.

CiRunnerManagerConnection#

Paginated collection of CiRunnerManager. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiRunnerUsage#

Runner usage in minutes.

Fields#

Name Type Description
ciBuildCount BigInt! Amount of builds executed during the selected period. Encoded as a string.
ciDuration BigInt! Number of minutes spent to process jobs during the selected period. Encoded as a string.
ciMinutesUsed BigInt! Deprecated in GitLab 17.5. Use ciDuration.
runner CiRunner Runner that the usage refers to. Null means "Other runners".

CiRunnerUsageByProject#

Runner usage in minutes by project.

Fields#

Name Type Description
ciBuildCount BigInt! Amount of builds executed during the selected period. Encoded as a string.
ciDuration BigInt! Number of minutes spent to process jobs during the selected period. Encoded as a string.
ciMinutesUsed BigInt! Deprecated in GitLab 17.5. Use ciDuration.
project Project Project that the usage refers to. Null means "Other projects".

CiSecureFileRegistry#

Represents the Geo replication and verification state of a ci_secure_file.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the CiSecureFileRegistry do not match on the primary and secondary.
ciSecureFileId ID! ID of the Ci Secure File.
createdAt Time Timestamp when the CiSecureFileRegistry was created.
dataManagementDetailsPath String Path to the data management view for this CiSecureFileRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the CiSecureFileRegistry is missing on primary.
modelRecordId Int ID of the CiSecureFileRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the CiSecureFileRegistry in case of mismatch.
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 of CiSecureFileRegistry started.
verificationState VerificationStateEnum Verification state of the CiSecureFileRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the CiSecureFileRegistry.

CiSecureFileRegistryConnection#

Paginated collection of CiSecureFileRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

CiStage#

Fields#

Name Type Description
detailedStatus DetailedStatus Detailed status of the stage.
groups CiGroupConnection Group of jobs for the stage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! ID of the stage.
jobs CiJobConnection Jobs for the stage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the stage.
status String Status of the pipeline stage.

CiStageConnection#

Paginated collection of CiStage. See Standard connection fields for the fields available on every connection.

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.

CiSubscriptionsProjectConnection#

Paginated collection of CiSubscriptionsProject. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CiSubscriptionsProjectDetails#

Fields#

Name Type Description
id ID! ID of the project.
name ID! Full path of the project.
namespace CiSubscriptionsProjectNamespaceDetails! Namespace of the project.
webUrl String Web URL of the project.

CiSubscriptionsProjectNamespaceDetails#

Fields#

Name Type Description
id ID! ID of the project.
name ID! Full path of the project.

CiTemplate#

GitLab CI/CD configuration template.

Fields#

Name Type Description
content String! Contents of the CI template.
name String! Name of the CI template.

CleanupPolicyLastRunDetailedMetrics#

Represents the metrics of the last run virtual registry cleanup policy.

Fields#

Name Type Description
container CleanupPolicyLastRunUpstreamMetrics Introduced as an experiment in GitLab 18.7.

Last run detail metrics of container.
maven CleanupPolicyLastRunUpstreamMetrics Introduced as an experiment in GitLab 18.7.

Last run detail metrics of maven.

CleanupPolicyLastRunUpstreamMetrics#

Represents the metrics of the last run virtual registry cleanup policy of an upstream.

Fields#

Name Type Description
deletedEntriesCount Int! Introduced as an experiment in GitLab 18.7.

Number of entries deleted.
deletedSize BigInt! Introduced as an experiment in GitLab 18.7.

Size in bytes of data deleted.

CloudConnectorProbeResult#

Fields#

Name Type Description
details JSON Additional details about the probe result.
errors [String!] Full list of errors about the probe result.
message String Additional message or details about the probe result.
name String Name of the probe.
success Boolean Indicates if the probe was successful.

CloudConnectorStatus#

Fields#

Name Type Description
probeResults [CloudConnectorProbeResult!] Results of individual probes run during verification.
success Boolean Indicates if the setup verification was successful.

ClusterAgent#

Fields#

Name Type Description
activityEvents ClusterAgentActivityEventConnection Recent activity for the cluster agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
connections ConnectedAgentConnection Active connections for the cluster agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
isReceptive Boolean Whether the cluster agent is receptive or not.
name String Name of the cluster agent.
project Project Project the cluster agent is associated with.
tokens ClusterAgentTokenConnection Tokens associated with the cluster agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time Timestamp the cluster agent was updated.
urlConfigurations ClusterAgentUrlConfigurationConnection URL configurations for the cluster agent in case it is a receptive agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
userAccessAuthorizations ClusterAgentAuthorizationUserAccess User access config for the cluster agent.
vulnerabilityImages VulnerabilityContainerImageConnection Container images reported on the agent vulnerabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
webPath String Web path of the cluster agent.
workspaces WorkspaceConnection Workspaces associated with the agent. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GlobalIDs.
workspacesAgentConfig WorkspacesAgentConfig Introduced as an experiment in GitLab 17.4.

Workspaces agent config for the cluster agent.

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.

ClusterAgentActivityEventConnection#

Paginated collection of ClusterAgentActivityEvent. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ClusterAgentAuthorizationCiAccess#

Fields#

Name Type Description
agent ClusterAgent Authorized cluster agent.
config JSON Configuration for the authorized project.

ClusterAgentAuthorizationCiAccessConnection#

Paginated collection of ClusterAgentAuthorizationCiAccess. See Standard connection fields for the fields available on every connection.

ClusterAgentAuthorizationUserAccess#

Fields#

Name Type Description
agent ClusterAgent Authorized cluster agent.
config JSON Configuration for the authorized project.

ClusterAgentAuthorizationUserAccessConnection#

Paginated collection of ClusterAgentAuthorizationUserAccess. See Standard connection fields for the fields available on every connection.

ClusterAgentConnection#

Paginated collection of ClusterAgent. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ClusterAgentToken#

Fields#

Name Type Description
clusterAgent ClusterAgent Cluster agent the 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.

ClusterAgentTokenConnection#

Paginated collection of ClusterAgentToken. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ClusterAgentUrlConfiguration#

Fields#

Name Type Description
caCert String CA certificate of the URL configuration. It is used to verify the agent endpoint.
clientCert String Client certificate if JWT authentication is used.
clusterAgent ClusterAgent Cluster agent of the URL configuration.
id ClustersAgentsUrlConfigurationID! Global ID of the URL configuration.
publicKey String Public key if JWT authentication is used.
tlsHost String TLS host of the URL configuration. It is used to verify the server name in the agent endpoint certificate.
url String URL of the URL configuration.

ClusterAgentUrlConfigurationConnection#

Paginated collection of ClusterAgentUrlConfiguration. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

CodeCoverageActivityConnection#

Paginated collection of CodeCoverageActivity. See Standard connection fields for the fields available on every connection.

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.

CodeQualityDegradationConnection#

Paginated collection of CodeQualityDegradation. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

CodeSuggestionEvent#

Fields#

Name Type Description
event AiUsageEventType! Type of the event.
language String Programming language in the context of the suggestion.
suggestionSize String Size of the code suggestion measured in lines of code.
timestamp Time! When the event happened.
uniqueTrackingId String Unique tracking number of sequence of events for one suggestion.
user UserCore! User associated with the event.

CodeSuggestionEventConnection#

Paginated collection of CodeSuggestionEvent. See Standard connection fields for the fields available on every connection.

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.

CommentTemplatePath#

Fields#

Name Type Description
href String! Path of the comment template.
text String! Text used on the template path.

CommentTemplatePathType#

Fields#

Name Type Description
href String! Management link to the comment template.
text String! Name of the comment template scope.

Commit#

Implements: NoteableInterface, Todoable

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.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
diffStats [DiffStats!] Details about which files were changed in the commit. This field can only be resolved for 10 commits in any single request.
diffStatsSummary DiffStatsSummary Summary of which files were changed in the commit. This field can only be resolved for 10 commits in any single request.
diffs [Diff!] Diffs contained within the commit. This field can only be resolved for 10 diffs in any single request.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
fullTitle String Full title of the commit message.
fullTitleHtml String HTML rendering of full_title.
hasAgentSession Boolean! Indicates the commit was authored during a GitLab Duo Agent Platform flow.
id ID! ID (global ID) of the commit.
latestPipeline Pipeline Latest pipeline that determines the commit CI status. Excludes dangling pipelines, such as security policy scans, that do not affect the commit CI status.

Arguments for latestPipeline:
ref (String)
Ref to scope the pipeline to. When provided, returns the latest pipeline for the commit on that ref; otherwise the latest pipeline for the commit across all refs.
message String Raw commit message.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
parentSha String SHA ID of the first parent.
pipelines PipelineConnection Pipelines of the commit ordered latest first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelines:
ids ([ID!])
Filter pipelines by their Global IDs. Maximum 20 IDs per request.
ref (String)
Filter pipelines by the ref they are run for.
refType (RefType)
Type of ref.
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 the date.
updatedBefore (Time)
Pipelines updated before the date.
username (String)
Filter pipelines by the user that triggered the pipeline.
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.
tags [String!] Tag names pointing to the commit.
title String Title of the commit message.
titleHtml String HTML rendering of title.
webPath String! Web path of the commit.
webUrl String! Web URL of the commit.

CommitConnection#

Paginated collection of Commit. See Standard connection fields for the fields available on every connection.

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.
previousBlamePath String Path to blame prior to the change.
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#

Name Type Description
containingBranches CommitParentNames Get branch names containing a given commit.

Arguments for containingBranches:
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.
containingTags CommitParentNames Get tag names containing a given commit.

Arguments for containingTags:
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.
tippingBranches CommitParentNames Get branch names tipping at a given commit.

Arguments for tippingBranches:
limit (Int!)
Number of ref names to return.
tippingTags CommitParentNames Get tag names tipping at a given commit.

Arguments for tippingTags:
limit (Int!)
Number of ref names to return.

ComparedSecurityReport#

Represents compared security report.

Fields#

Name Type Description
added [ComparedSecurityReportFinding!] Introduced as an experiment in GitLab 16.1.

New vulnerability findings.
baseReportCreatedAt Time Time of the base report creation.
baseReportOutOfDate Boolean Indicates whether the base report out of date.
fixed [ComparedSecurityReportFinding!] Introduced as an experiment in GitLab 16.1.

Fixed vulnerability findings.
headReportCreatedAt Time Time of the base report creation.

ComparedSecurityReportFinding#

Represents finding.

Fields#

Name Type Description
aiResolutionEnabled Boolean Introduced as an experiment in GitLab 18.6.

Indicates whether the specific finding can be resolved with AI.
autoSeverityOverride VulnerabilitySeverity Introduced as an experiment in GitLab 18.11.

The severity that will be automatically applied after merge by a severity override policy. Returns null if no severity override policy matches.
description String Description of the vulnerability finding.
details [VulnerabilityDetail!]! Introduced as an experiment in GitLab 17.6.

Details of the vulnerability finding.
foundByPipelineIid String IID of the pipeline.
identifiers [VulnerabilityIdentifier!] Introduced as an experiment in GitLab 16.3.

Identifiers of the vulnerability finding.
location VulnerabilityLocation Introduced as an experiment in GitLab 16.3.

Location of the vulnerability finding.
matchesAutoDismissPolicy Boolean Introduced as an experiment in GitLab 18.9.

Indicates whether the finding matches an auto-dismiss policy.
scanner ComparedSecurityReportScanner Compared report vulnerability scanner.
severity VulnerabilitySeverity Severity of the vulnerability finding.
state VulnerabilityState Finding status.
title String Title of the vulnerability finding.
unverified Boolean! Indicates whether the finding was detected without an identified source (untrusted input).
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
approvalPolicies ScanResultPolicyConnection Approval Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
color String! Hexadecimal representation of compliance framework's label color.
complianceRequirements ComplianceRequirementConnection Compliance requirements of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
default Boolean Default compliance framework for the group.
description String! Description of the compliance framework.
editPath String! Web UI path to edit the compliance framework.
id ID! Compliance framework ID.
name String! Name of the compliance framework.
namespaceId TypesNamespaceID! Namespace ID.
pipelineConfigurationFullPath String Deprecated in GitLab 17.4. Use pipeline execution policies instead.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipelineExecutionSchedulePolicies PipelineExecutionSchedulePolicyConnection Pipeline Execution Schedule Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projects ProjectConnection Projects associated with the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
scanResultPolicies ScanResultPolicyConnection Deprecated in GitLab 19.0. Use approvalPolicies. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
securityPolicies ComplianceFrameworkPolicySummaryConnection All security policies scoped to the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time Timestamp of when the compliance framework was last updated.
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Vulnerability Management Policies of the compliance framework. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

ComplianceFrameworkConnection#

Paginated collection of ComplianceFramework. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ComplianceFrameworkCoverageDetail#

Framework coverage details for a specific compliance framework.

Fields#

Name Type Description
coveredCount Int! Number of projects covered by the framework.
framework ComplianceFramework! Compliance framework associated with the coverage detail.
id ID! ID of the framework.

ComplianceFrameworkCoverageDetailConnection#

Paginated collection of ComplianceFrameworkCoverageDetail. See Standard connection fields for the fields available on every connection.

ComplianceFrameworkCoverageSummary#

Compliance framework Coverage summary for a group.

Fields#

Name Type Description
coveredCount Int! Number of projects covered by at least one framework.
totalProjects Int! Total number of projects in the group.

ComplianceFrameworkPolicySummary#

A security policy scoped to a compliance framework.

Fields#

Name Type Description
hasActiveProjects Boolean! Whether the policy has at least one non-archived assigned project.
name String! Name of the security policy.
source SecurityPolicySource Source of the security policy.
type String Type of the security policy.

ComplianceFrameworkPolicySummaryConnection#

Paginated collection of ComplianceFrameworkPolicySummary. See Standard connection fields for the fields available on every connection.

ComplianceFrameworkTemplate#

Represents a compliance framework template that can be used to create a compliance framework.

Fields#

Name Type Description
color String! Hexadecimal representation of the template's label color.
description String! Description of the compliance framework template.
id ID! Unique identifier of the template.
json String! Full JSON representation of the compliance framework template.
name String! Name of the compliance framework template.
templateVersion Int! Version of the template.

ComplianceFrameworksNeedingAttention#

Compliance framework requiring attention.

Fields#

Name Type Description
framework ComplianceFramework! Compliance framework needing attention.
id ID! ID of the framework needing attention.
projectsCount Int! Number of projects with the framework applied.
requirementsCount Int! Number of requirements in the framework.
requirementsWithoutControls [ComplianceRequirement!] Requirements without controls.

ComplianceFrameworksNeedingAttentionConnection#

Paginated collection of ComplianceFrameworksNeedingAttention. See Standard connection fields for the fields available on every connection.

ComplianceRequirement#

Represents a ComplianceRequirement associated with a ComplianceFramework.

Fields#

Name Type Description
complianceRequirementsControls ComplianceRequirementsControlConnection Compliance controls of the compliance requirement. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String! Description of the compliance requirement.
framework ComplianceFramework Compliance framework associated with the requirement.
id ID! Compliance requirement ID.
name String! Name of the compliance requirement.

ComplianceRequirementConnection#

Paginated collection of ComplianceRequirement. See Standard connection fields for the fields available on every connection.

ComplianceRequirementControl#

Lists down all the possible types of requirement controls.

Fields#

Name Type Description
controlExpressions [ControlExpression!]! List of requirement controls.

ComplianceRequirementsControl#

Represents a ComplianceRequirementsControl associated with a ComplianceRequirement.

Fields#

Name Type Description
complianceRequirement ComplianceRequirement Compliance requirement associated with the control.
controlType String! Type of the compliance control.
expression String Expression of the compliance control.
externalControlName String Name of the external control.
externalUrl String URL of the external control.
id ID! Compliance requirements control ID.
name String! Name of the compliance control.
pingEnabled Boolean! Whether ping is enabled for external controls.

ComplianceRequirementsControlConnection#

Paginated collection of ComplianceRequirementsControl. See Standard connection fields for the fields available on every connection.

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.

ComplianceStandardsAdherenceConnection#

Paginated collection of ComplianceStandardsAdherence. See Standard connection fields for the fields available on every connection.

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.

ComplianceViolationConnection#

Paginated collection of ComplianceViolation. See Standard connection fields for the fields available on every connection.

Component#

A software dependency used by a project.

Fields#

Name Type Description
id SbomComponentID! ID of the dependency.
name String! Name of the dependency.

ComponentVersion#

A software dependency version used by a project.

Fields#

Name Type Description
id SbomComponentVersionID! ID of the dependency version.
version String! Version of the dependency.

ComponentVersionConnection#

Paginated collection of ComponentVersion. See Standard connection fields for the fields available on every connection.

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.

Implements: PackageFileMetadata

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.
warnings [AgentWarning!] Agent warnings list.

ConnectedAgentConnection#

Paginated collection of ConnectedAgent. See Standard connection fields for the fields available on every connection.

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 the container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnum Number of tags to retain.
nameRegex UntrustedRegexp Tags with names matching the regex pattern will expire.
nameRegexKeep UntrustedRegexp Tags with names matching the regex pattern will be preserved.
nextRunAt Time Next time that the container expiration policy will get executed.
olderThan ContainerExpirationPolicyOlderThanEnum Tags older than the given age will expire.
updatedAt Time! Timestamp of when the container expiration policy was updated.

ContainerProtectionAccessLevel#

Represents the most restrictive permissions for a container image tag.

Implements: AccessLevelInterface

Fields#

Name Type Description
immutable Boolean! Returns true when tag rule is for tag immutability. Otherwise, false.
minimumAccessLevelForDelete ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags.
minimumAccessLevelForPush ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags.

ContainerProtectionRepositoryRule#

A container repository protection rule designed to prevent users with a certain access level or lower from altering the container registry.

Fields#

Name Type Description
id ContainerRegistryProtectionRuleID! ID of the container repository protection rule.
minimumAccessLevelForDelete ContainerProtectionRepositoryRuleAccessLevel Introduced as an experiment in GitLab 17.11.

Minimum GitLab access level required to delete container images from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER. Valid only when feature flag container_registry_protected_containers_delete is enabled.
minimumAccessLevelForPush ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
repositoryPathPattern String! Container repository path pattern protected by the protection rule. Must start with the project's full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project's full path.

ContainerProtectionRepositoryRuleConnection#

Paginated collection of ContainerProtectionRepositoryRule. See Standard connection fields for the fields available on every connection.

ContainerProtectionTagRule#

A container repository tag protection rule designed to prevent users with a certain access level or lower from altering the container registry.

Implements: AccessLevelInterface

Fields#

Name Type Description
id ContainerRegistryProtectionTagRuleID! ID of the container repository tag protection rule.
immutable Boolean! Returns true when tag rule is for tag immutability. Otherwise, false.
minimumAccessLevelForDelete ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags.
minimumAccessLevelForPush ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags.
tagNamePattern String! The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.
userPermissions ContainerRegistryProtectionTagRulePermissions! Permissions for the current user on the resource.

ContainerProtectionTagRuleConnection#

Paginated collection of ContainerProtectionTagRule. See Standard connection fields for the fields available on every connection.

ContainerRegistry#

Represents a container virtual registry.

Implements: RegistryInterface

Fields#

Name Type Description
description String Description of the virtual registry.
id ID! ID of the virtual registry.
name String! Name of the virtual registry.
updatedAt Time! Timestamp of when the virtual registry was updated.

ContainerRegistryConnection#

Paginated collection of ContainerRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ContainerRegistryDetails#

Represents container virtual registry details.

Implements: RegistryInterface

Fields#

Name Type Description
description String Description of the virtual registry.
id ID! ID of the virtual registry.
name String! Name of the virtual registry.
registryUpstreams [ContainerRegistryUpstreamWithUpstream!]! Introduced as an experiment in GitLab 18.7.

List of registry upstreams for the container virtual registry.
updatedAt Time! Timestamp of when the virtual registry was updated.

ContainerRegistryProtectionTagRulePermissions#

Fields#

Name Type Description
destroyContainerRegistryProtectionTagRule Boolean! If true, the user can perform destroy_container_registry_protection_tag_rule on this resource.

ContainerRegistryUpstreamWithRegistry#

Represents a container registry upstream and its registry.

Implements: RegistryUpstreamInterface

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
position Int! Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.
registry ContainerRegistry! Introduced as an experiment in GitLab 18.8.

Container registry associated with the upstream registry.

ContainerRegistryUpstreamWithUpstream#

Represents a container virtual registry upstream and its relationship to the upstream.

Implements: RegistryUpstreamInterface

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
position Int! Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.
upstream ContainerUpstream! Introduced as an experiment in GitLab 18.7.

Container upstream associated with the registry upstream.

ContainerRepository#

A container repository.

Fields#

Name Type Description
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! Deprecated in GitLab 17.0. Returns an empty string. This was used for the migration of GitLab.com, which is now complete. Not used by Self-managed instances.
name String! Name of the container repository.
path String! Path of the container repository.
project Project! Project of the container registry.
protectionRuleExists Boolean! Whether any matching container protection rule exists for the container repository.
status ContainerRepositoryStatus Status of the container repository.
tagsCount Int! Number of tags associated with the image.
updatedAt Time! Timestamp when the container repository was updated.
userPermissions ContainerRepositoryPermissions! Permissions for the current user on the resource.

ContainerRepositoryConnection#

Paginated collection of ContainerRepository. See Standard connection fields for the fields available on every connection.

ContainerRepositoryDetails#

Details of a container repository.

Fields#

Name Type Description
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.
lastPublishedAt Time Timestamp when a repository tag was last created or updated. Only present for repositories that had tags created or updated after GitLab 16.11.
location String! URL of the container repository.
manifest String An image manifest from the container repository.

Arguments for manifest:
reference (String!)
Tag name or digest of the manifest.
migrationState String! Deprecated in GitLab 17.0. Returns an empty string. This was used for the migration of GitLab.com, which is now complete. Not used by Self-managed instances.
name String! Name of the container repository.
path String! Path of the container repository.
project Project! Project of the container registry.
protectionRuleExists Boolean! Whether any matching container protection rule exists for the container repository.
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.
tagDetails ContainerRepositoryTagDetails Details for a specific tag in the container repository.

Arguments for tagDetails:
name (String!)
Name of the tag.
tags ContainerRepositoryTagConnection Tags of the container repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for tags:
name (String)
Search by tag name.
referrerType (String)
Comma-separated list of artifact types used to filter referrers. Applies only when referrers is set to true.
referrers (Boolean)
Include tag referrers.
sort (ContainerRepositoryTagSort)
Sort tags by these criteria.
tagsCount Int! Number of tags associated with the image.
updatedAt Time! Timestamp when the container repository was updated.
userPermissions ContainerRepositoryPermissions! Permissions for the current user on the resource.

ContainerRepositoryImageManifest#

A manifest describing a reference to an image.

Fields#

Name Type Description
digest String Digest of the manifest.
mediaType String Media type of the manifest.
platform ContainerRepositoryImagePlatform Platform specifier for the image reference.
size BigInt Size of the manifest in bytes.

ContainerRepositoryImagePlatform#

Description of the target platform for an image.

Fields#

Name Type Description
architecture String CPU architecture of the platform.
os String Operating system of the platform.
osVersion String Operating system version, typically used for Windows images.
variant String CPU variant of the platform.

ContainerRepositoryPermissions#

Fields#

Name Type Description
destroyContainerRepository Boolean! If true, the user can perform destroy_container_image on this resource.

ContainerRepositoryReferrer#

A referrer for a container repository tag.

Fields#

Name Type Description
artifactType String Artifact type of the referrer.
digest String Digest of the referrer.
userPermissions ContainerRepositoryTagPermissions! Permissions for the current user on the resource.

ContainerRepositoryRegistry#

Represents the Geo replication and verification state of an Container Repository.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ContainerRepositoryRegistry do not match on the primary and secondary.
containerRepositoryId ID! ID of the ContainerRepository.
createdAt Time Timestamp when the ContainerRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ContainerRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the ContainerRepositoryRegistry is missing on primary.
modelRecordId Int ID of the ContainerRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the ContainerRepositoryRegistry in case of mismatch.
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 of ContainerRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the ContainerRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ContainerRepositoryRegistry.

ContainerRepositoryRegistryConnection#

Paginated collection of ContainerRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ContainerRepositoryTag#

A tag from a container repository.

Fields#

Name Type Description
createdAt Time Timestamp when the tag was created.
digest String Digest of the tag.
location String! URL of the tag.
mediaType String Media type of the tag.
name String! Name of the tag.
path String! Path of the tag.
protection ContainerProtectionAccessLevel Minimum GitLab access level required to push and delete container image tags. If the value is nil, no minimum access level is enforced. Users with the Developer role or higher can push tags by default.
publishedAt Time Timestamp when the tag was published.
referrers [ContainerRepositoryReferrer!] Referrers for 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.

ContainerRepositoryTagConnection#

Paginated collection of ContainerRepositoryTag. See Standard connection fields for the fields available on every connection.

ContainerRepositoryTagDetails#

Details of a tag within a container repository.

Fields#

Name Type Description
createdAt Time Timestamp when the tag was created.
digest String Digest of the tag.
location String! URL of the tag.
manifests [ContainerRepositoryImageManifest!] Manifests of the index tag. Null for non-index tags.
mediaType String Media type of the tag.
name String! Name of the tag.
path String! Path of the tag.
platform ContainerRepositoryImagePlatform Platform of the image tag. Null for index tags.
publishedAt Time Timestamp when the tag was published.
totalSize BigInt Size of the tag.

ContainerRepositoryTagPermissions#

Fields#

Name Type Description
destroyContainerRepositoryTag Boolean! If true, the user can perform destroy_container_image_tag on this resource.

ContainerTagsExpirationPolicy#

A tag expiration policy using regex patterns to control which images to keep or expire.

Fields#

Name Type Description
cadence ContainerExpirationPolicyCadenceEnum Schedule of the container expiration policy.
createdAt Time Timestamp of when the container expiration policy was created.
enabled Boolean! Indicates whether the container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnum Number of tags to retain.
nameRegex UntrustedRegexp Tags with names matching the regex pattern will expire.
nameRegexKeep UntrustedRegexp Tags with names matching the regex pattern will be preserved.
nextRunAt Time Next time that the container expiration policy will get executed.
olderThan ContainerExpirationPolicyOlderThanEnum Tags older than the given age will expire.
updatedAt Time Timestamp of when the container expiration policy was updated.

ContainerUpstream#

Represents a container upstream registry.

Implements: UpstreamInterface

Fields#

Name Type Description
cacheValidityHours Int! Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
description String Introduced as an experiment in GitLab 18.1.

Description of the upstream registry.
id ID! Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
name String! Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCount Int! Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
url String! Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.
username String Introduced as an experiment in GitLab 18.7.

Username to sign in to the upstream registry.

ContainerUpstreamCacheEntry#

Represents a cache entry for an upstream container registry.

Implements: EntryInterface

Fields#

Name Type Description
contentType String! Introduced as an experiment in GitLab 18.9.

Content type of the cached file.
createdAt Time! Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was created.
downloadedAt Time Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last downloaded.
downloadsCount Int! Introduced as an experiment in GitLab 18.9.

Number of times the entry has been downloaded.
fileMd5 String Introduced as an experiment in GitLab 18.9.

MD5 hash of the cached file.
fileSha1 String! Introduced as an experiment in GitLab 18.9.

SHA1 hash of the cached file.
id String! Introduced as an experiment in GitLab 18.9.

ID of the cache entry.
relativePath String! Introduced as an experiment in GitLab 18.9.

Relative path of the cached entry.
size BigInt! Introduced as an experiment in GitLab 18.9.

Size of the cached file in bytes.
updatedAt Time! Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last updated.
upstreamCheckedAt Time Introduced as an experiment in GitLab 18.9.

Timestamp when the upstream was last checked.
upstreamEtag String Introduced as an experiment in GitLab 18.9.

ETag from the upstream source.

ContainerUpstreamCacheEntryConnection#

Paginated collection of ContainerUpstreamCacheEntry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ContainerUpstreamConnection#

Paginated collection of ContainerUpstream. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ContainerUpstreamDetails#

Represents container upstream details.

Implements: UpstreamInterface

Fields#

Name Type Description
cacheEntries ContainerUpstreamCacheEntryConnection Introduced as an experiment in GitLab 18.9.

Represents cache entries for the upstream container registry. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cacheEntries:
search (String)
Search cache entries by relative path.
cacheValidityHours Int! Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
description String Introduced as an experiment in GitLab 18.1.

Description of the upstream registry.
id ID! Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
name String! Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCount Int! Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
registryUpstreams [ContainerRegistryUpstreamWithRegistry!]! Introduced as an experiment in GitLab 18.8.

Represents the connected upstream registry for an upstream and the upstream position data.
url String! Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.
username String Introduced as an experiment in GitLab 18.7.

Username to sign in to the upstream registry.

ContextPreset#

Presets for GitLab Duo Chat window based on current context.

Fields#

Name Type Description
aiResourceData String Serialized representation of the AI resource in the current context.
questionCategories [AiChatQuestionCategory!] Introduced as an experiment in GitLab 19.4.

Suggested questions grouped by category. Not affected by questionCount.
questions [String!] Array of questions that the user can ask GitLab Duo Chat from the current page.

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.

ContributionAnalyticsContributionConnection#

Paginated collection of ContributionAnalyticsContribution. See Standard connection fields for the fields available on every connection.

ContributionsAggregationResponse#

Response for Contributions aggregation engine.

Fields#

Name Type Description
dimensions ContributionsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
totalCount Int Total number of contributions.
usersCount Int Number of unique contributors.

ContributionsAggregationResponseConnection#

Paginated collection of ContributionsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

ContributionsAggregationResponseDimensions#

Response dimensions for Contributions aggregation engine.

Fields#

Name Type Description
author UserCore Contribution author.
createdAt Date Contribution date.

Arguments for createdAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.

ContributionsAggregationScope#

Aggregation scope for Contributions. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated ContributionsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

ControlExpression#

Represents a control expression.

Fields#

Name Type Description
expression ExpressionValue! Expression details for the control.
id ID! ID for the control.
name String! Name of the control.

CountableVulnerability#

Represents a vulnerability. The connection type is countable.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
aiResolutionAvailable Boolean Indicates whether the type of vulnerability can be resolved with AI.
aiResolutionEnabled Boolean Indicates whether the specific vulnerability can be resolved with AI.
aiWorkflows VulnerabilityTriggeredWorkflowConnection Introduced as an experiment in GitLab 18.6.

AI workflows triggered for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
archivalInformation VulnerabilityArchivalInformation! Introduced as an experiment in GitLab 17.11.

Indicates whether the vulnerability is about to be archived in the next month.
ascpComponent AscpComponent Introduced as an experiment in GitLab 19.4.

The ASCP component the vulnerability belongs to. Returns null when there is no matchor when the ascp_component_vulnerability_association feature flag is disabled.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
confirmedAt Time Timestamp of when the vulnerability state was changed to confirmed.
confirmedBy UserCore User that confirmed the vulnerability.
cveEnrichment CveEnrichmentType Enrichment (EPSS score and KEV) for CVE vulnerabilities.
cvss [CvssType!]! CVSS information for the vulnerability.
dependencies DependencyConnection! Introduced as an experiment in GitLab 18.2.

Dependencies for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencies:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
dueDate ISO8601Date Vulnerability finding due date.
duoSastVrWorkflowEnabled Boolean Introduced as an experiment in GitLab 19.1.

Indicates whether the SAST vulnerability review workflow is enabled for the project.
externalIssueLinks VulnerabilityExternalIssueLinkConnection! List of external issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
falsePositive Boolean Indicates whether the vulnerability is a false positive.
findingTokenStatus VulnerabilityFindingTokenStatus Status of the secret token associated with this vulnerability.
flags VulnerabilityFlagConnection Introduced as an experiment in GitLab 18.5.

Flags set on the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
hasRemediations Boolean Indicates whether there is a remediation available for the vulnerability.
id ID! GraphQL ID of the vulnerability.
identifiers [VulnerabilityIdentifier!]! Identifiers of the vulnerability.
initialDetectedPipeline Pipeline Introduced as an experiment in GitLab 18.2.

Pipeline where the vulnerability was first detected.
issueLinks VulnerabilityIssueLinkConnection! List of issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issueLinks:
linkType (VulnerabilityIssueLinkType)
Filter issue links by link type.
latestDetectedPipeline Pipeline Introduced as an experiment in GitLab 18.2.

Pipeline where the vulnerability was last detected.
latestFlag VulnerabilityFlag Introduced as an experiment in GitLab 18.5.

Latest flag for the vulnerability.
latestNonClosedMergeRequest MergeRequest Introduced as an experiment in GitLab 19.1.

Latest non-closed merge request linked to fix the vulnerability.
latestSecurityReportFinding PipelineSecurityReportFinding Introduced as an experiment in GitLab 18.4.

Latest security report finding for the vulnerability. On large projects, the field can time out and return null. Clients should check the top-level errors array for timeout errors, even when the HTTP response status is 200.
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.
malware Boolean Indicates whether the vulnerability is associated with a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
mergeRequest MergeRequest Merge request that fixes the vulnerability.
mergeRequests MergeRequestConnection Merge requests that are linked to fix the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
policyAutoDismissed Boolean Introduced as an experiment in GitLab 18.7.

Indicates whether the vulnerability was auto-dismissed by a security policy.
policyViolations PolicyViolations Introduced as an experiment in GitLab 18.6.

Policy violation for the vulnerability.
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.
reachability ReachabilityType Introduced as an experiment in GitLab 17.11.

Reachability status of the vulnerability.
removedFromCode Boolean! Indicates whether the vulnerability is present in the code or not.
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, CONTAINER_SCANNING_FOR_REGISTRY, SARIF, GENERIC). Scan Type in the UI.
representationInformation VulnerabilityRepresentationInformation Introduced as an experiment in GitLab 17.7.

Information about the representation of the vulnerability, such as resolved commit SHA.
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).
severityOverrides SeverityOverrideConnection List of severity changes for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String Title of the vulnerability.
trackedRef SecurityTrackedRef Introduced as an experiment in GitLab 18.10.

Tracked ref (branch or tag) where the vulnerability was detected.
unverified Boolean! Indicates whether the finding was detected without an identified source (untrusted input).
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.
validityDisplayState VulnerabilityValidityDisplayState Introduced as an experiment in GitLab 19.5.

Validity state derived from the token status and current vendor support.
vulnerabilityPath String Path to the vulnerability's details page.
webUrl String URL to the vulnerability's details page.

CountableVulnerabilityConnection#

Paginated collection of CountableVulnerability. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CoverageFuzzingCorpus#

Corpus for a coverage fuzzing job.

Fields#

Name Type Description
id AppSecFuzzingCoverageCorpusID! ID of the corpus.
package PackageDetailsType! Package of the corpus.

CoverageFuzzingCorpusConnection#

Paginated collection of CoverageFuzzingCorpus. See Standard connection fields for the fields available on every connection.

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 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.
hasGitlabCreditsAddOn Boolean! Whether the license has an active GitLab Credits add-on.
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.
subscriptionName String Name of the subscription in the Customers Portal.
trial Boolean Indicates if the license is a trial.
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.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
admin Boolean! Indicates if the user is an instance administrator.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
assigneeOrReviewerMergeRequests MergeRequestConnection Merge requests the current user is an assignee or a reviewer of. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assigneeOrReviewerMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assignedReviewStates ([MergeRequestReviewState!])
Reviewer states for merge requests the current user is assigned to.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerReviewStates ([MergeRequestReviewState!])
Reviewer states for the merge requests the current user is a reviewer of.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
codeSuggestionsContexts [String!]! Introduced as an experiment in GitLab 17.9.

List of additional contexts enabled for Code Suggestions.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
creditsUsage GitlabSubscriptionUserCreditsUsage Introduced as an experiment in GitLab 19.4.

GitLab Credits usage for the current user.

Arguments for creditsUsage:
endDate (ISO8601Date)
End date of the usage period to query. Defaults to the end of the current month.
flowTypes ([String!])
Filter usage data by flow type identifiers (for example, ["chat", "code_review"]).
namespacePath (ID!)
Path of the top-level namespace to report usage for.
startDate (ISO8601Date)
Start date of the usage period to query. Defaults to the beginning of the current month.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoChatAvailable Boolean! Introduced as an experiment in GitLab 16.8.

User access to AI chat feature.
duoChatAvailableFeatures [String!]! Introduced as an experiment in GitLab 17.6.

List of available features for AI chat.
duoClassicChatAvailable Boolean! User access to GitLab Duo Chat (non-agentic) feature.
duoCodeSuggestionsAvailable Boolean! Introduced as an experiment in GitLab 16.8.

User access to code suggestions feature.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
importSourceUsers ImportSourceUserConnection Introduced as an experiment in GitLab 19.5.

Completed mappings of source users whose contributions were reassigned to the current user. Returns an empty result if the revoke_import_source_user_reassignment feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
mergeRequestSavedViews MergeRequestSavedViewConnection Introduced as an experiment in GitLab 19.4.

Saved views on the merge request dashboard for the current user. Returns an empty result if the mr_dashboard_saved_views feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
recentlyViewedIssues [Issue!] Introduced as an experiment in GitLab 17.9.

Most-recently viewed issues for the current user.
recentlyViewedItems [RecentlyViewedItem!] Most-recently viewed items for the current user.
recentlyViewedMergeRequests [MergeRequest!] Introduced as an experiment in GitLab 17.10.

Most-recently viewed merge requests for the current user.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
runners CiRunnerConnection Introduced as an experiment in GitLab 18.3.

List all runners the current user manages. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for runners:
active (Boolean)
Deprecated in GitLab 14.8. Renamed. Use paused instead.
assignableToProjectPath (ID)
Path of a project. When set, returns runners that can be assigned to a project, are not locked, and not already assigned to the project.
creatorId (UserID)
Filter runners by creator ID.
creatorUsername (String)
Filter runners by creator username.
ownerFullPath (String)
Introduced as an experiment in GitLab 17.8.

Filter runners by owning project or group.
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)
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'.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workItemPreferences WorkItemTypesUserPreference Introduced as an experiment in GitLab 17.10.

User preferences for the given work item type and namespace.

Arguments for workItemPreferences:
namespacePath (ID!)
Full path of the namespace the work item is created in.
workItemTypeId (WorkItemsTypeID)
Global ID of a work item type.
workItems WorkItemConnection Introduced as an experiment in GitLab 17.10.

Find work items visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItems:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
search (String)
Search query for title or description.
sort (WorkItemSort)
Sort work items by criteria.
state (IssuableState)
Current state of the work item.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

CustomAttribute#

A custom attribute key-value pair. Only available to admins.

Fields#

Name Type Description
key String! Key of the custom attribute.
value String! Value of the custom attribute.

CustomDashboard#

Customizable analytics dashboard.

Implements: CustomDashboardInterface

Fields#

Name Type Description
config JSON! Dashboard layout and widget configuration.
createdAt Time Timestamp when the dashboard was created.
createdBy UserCore User who created the dashboard.
description String Optional summary or purpose of the dashboard.
id ID! Global ID of the custom dashboard.
lockVersion Int! Version used for optimistic concurrency control.
name String! Display name of the dashboard.
namespace Namespace Namespace scope of the dashboard, if any.
organization Organization! Organization that owns the dashboard.
project Project Project scope of the dashboard, if any.
slug String Dashboard url slug.
system Boolean! Whether the dashboard is a built-in GitLab dashboard.
updatedAt Time! Timestamp when the dashboard was last updated.
updatedBy UserCore User who last updated the dashboard.

CustomDashboardInterfaceConnection#

Paginated collection of CustomDashboardInterface. See Standard connection fields for the fields available on every connection.

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.

CustomEmojiConnection#

Paginated collection of CustomEmoji. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

CustomField#

Represents a custom field.

Fields#

Name Type Description
active Boolean! Whether the custom field is active.
createdAt Time! Timestamp when the custom field was created.
createdBy UserCore User that created the custom field.
fieldType CustomFieldType! Type of custom field.
id IssuablesCustomFieldID! Global ID of the custom field.
name String! Name of the custom field.
selectOptions [CustomFieldSelectOption!] Available options for a select field.
updatedAt Time! Timestamp when the custom field was last updated.
updatedBy UserCore User that last updated the custom field.
workItemTypes [WorkItemType!] Work item types that the custom field is available on.

CustomFieldConnection#

Paginated collection of CustomField. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

CustomFieldSelectOption#

Represents a custom field select option.

Fields#

Name Type Description
id IssuablesCustomFieldSelectOptionID! Global ID of the custom field select option.
value String! Value of the custom field select option.

CustomSystemDashboard#

GitLab built-in analytics dashboard (read-only).

Implements: CustomDashboardInterface

Fields#

Name Type Description
config JSON! Dashboard layout and widget configuration.
createdAt Time Timestamp when the dashboard was created.
description String Optional summary or purpose of the dashboard.
id ID! Global ID of the dashboard.
name String! Display name of the dashboard.
slug String Dashboard url slug.
system Boolean! Whether the dashboard is a built-in GitLab dashboard.

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.

CustomerRelationsContactConnection#

Paginated collection of CustomerRelationsContact. See Standard connection fields for the fields available on every connection.

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.

CustomerRelationsOrganizationConnection#

Paginated collection of CustomerRelationsOrganization. See Standard connection fields for the fields available on every connection.

CustomizableAdminPermission#

Fields#

Name Type Description
description String Description of the permission.
name String! Localized name of the permission.
requirements [MemberRoleAdminPermission!] Requirements of the permission.
value MemberRoleAdminPermission! Value of the permission.

CustomizableAdminPermissionConnection#

Paginated collection of CustomizableAdminPermission. See Standard connection fields for the fields available on every connection.

CustomizableDashboard#

Represents a customizable dashboard.

Fields#

Name Type Description
category CustomizableDashboardCategory! Category of dashboard.
configurationProject Project Project which contains the dashboard definition.
description String Description of the dashboard.
errors [String!] Errors on yaml definition.
filters JSON Dashboard global filters.
gridHeight CustomizableDashboardGridHeight Introduced as an experiment in GitLab 18.9.

Grid cell height of the dashboard.
panels CustomizableDashboardPanelConnection Panels shown on the dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
slug String! Slug of the dashboard.
status String Introduced as an experiment in GitLab 17.0.

Status of the dashboard.
title String Title of the dashboard.
userDefined Boolean! Indicates whether the dashboard is user-defined or provided by GitLab.

CustomizableDashboardConnection#

Paginated collection of CustomizableDashboard. See Standard connection fields for the fields available on every connection.

CustomizableDashboardPanel#

Represents a customizable 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.
titleIcon String Icon displayed next to the title of the panel.
tooltip CustomizableDashboardPanelTooltip Tooltip for the panel containing descriptive text and an optional link.
views [CustomizableDashboardPanelView!]! Visualizations the user can switch between within the panel.
visualization CustomizableDashboardVisualization Visualization of the panel.

CustomizableDashboardPanelConnection#

Paginated collection of CustomizableDashboardPanel. See Standard connection fields for the fields available on every connection.

CustomizableDashboardPanelTooltip#

Tooltip for a customizable dashboard panel.

Fields#

Name Type Description
description String! Popover text content. When descriptionLink is provided, must include %{linkStart} and %{linkEnd} placeholders around the link text.
descriptionLink String Optional URL for link insertion in the description between %{linkStart} and %{linkEnd} placeholders.

CustomizableDashboardPanelView#

Represents a view that can be selected within a customizable dashboard panel.

Fields#

Name Type Description
text String Label shown in the segmented control for the view.
visualization CustomizableDashboardVisualization Visualization rendered when the view is selected.

CustomizableDashboardVisualization#

Represents a customizable 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.

CustomizableDashboardVisualizationConnection#

Paginated collection of CustomizableDashboardVisualization. See Standard connection fields for the fields available on every connection.

CustomizableStandardPermission#

Fields#

Name Type Description
availableFor [String!]! Objects the permission is available for.
description String Description of the permission.
enabledForGroupAccessLevels [AccessLevelEnum!] Group access levels from which the permission is allowed.
enabledForProjectAccessLevels [AccessLevelEnum!] Project access levels from which the permission is allowed.
name String! Localized name of the permission.
requirements [MemberRoleStandardPermission!] Requirements of the permission.
value MemberRoleStandardPermission! Value of the permission.

CustomizableStandardPermissionConnection#

Paginated collection of CustomizableStandardPermission. See Standard connection fields for the fields available on every connection.

CveEnrichmentType#

Represents a CVE's Enrichment (EPSS score).

Fields#

Name Type Description
cve String! CVE identifier of relevant vulnerability.
epssScore Float! EPSS score for the CVE.
isKnownExploit Boolean! Whether the CVE appears in the CISA KEV catalog.

CvssType#

Represents a vulnerability's CVSS score.

Fields#

Name Type Description
baseScore Float! Base score of the CVSS.
overallScore Float! Overall score of the CVSS.
severity CvssSeverity! Severity calculated from the overall score.
vector String! CVSS vector string.
vendor String! Vendor who assigned the CVSS score.
version Float! Version of the CVSS.

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 GitLab 15.10. Renamed. Use DastPreScanVerificationStep.checkType instead.
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.

DastProfileConnection#

Paginated collection of DastProfile. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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

DastScannerProfileConnection#

Paginated collection of DastScannerProfile. See Standard connection fields for the fields available on every connection.

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.
optionalVariables [JSON!] Optional variables that can be configured for DAST scans.
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.

DastSiteProfileConnection#

Paginated collection of DastSiteProfile. See Standard connection fields for the fields available on every connection.

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.

DastSiteValidationConnection#

Paginated collection of DastSiteValidation. See Standard connection fields for the fields available on every connection.

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.

Implements: DependencyInterface

Fields#

Name Type Description
componentVersion ComponentVersion Version of the dependency.
dependencyPaths DependencyPathPage Introduced as an experiment in GitLab 18.2.

Ancestor dependency paths for a dependency. Returns null if dependency_graph_graphql feature flag is disabled.

Arguments for dependencyPaths:
after (String)
Fetch paths after the cursor.
before (String)
Fetch paths before the cursor.
limit (Int)
Number of paths to fetch.
hasDependencyPaths Boolean! Introduced as an experiment in GitLab 18.4.

Indicates whether the dependency has any dependency paths.
id GlobalID! ID of the dependency.
licenses [License!] Licenses associated to the dependency.
location Location Information about where the dependency is located.
malware Boolean Introduced as an experiment in GitLab 19.1.

Indicates whether the dependency is a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
name String! Name of the dependency.
packager PackageManager Description of the tool used to manage the dependency.
reachability ReachabilityType Information about reachability of a dependency.
trackedRefsCount Int! Introduced as an experiment in GitLab 19.2.

Number of tracked refs (branches or tags) associated with the dependency.
version String Deprecated in GitLab 18.1. Replaced by component_version.
vulnerabilities VulnerabilityConnection Vulnerabilities associated with the dependency. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilityCount Int! Number of vulnerabilities within the dependency.

DependencyAggregation#

A software dependency aggregation used by a group.

Implements: DependencyInterface

Fields#

Name Type Description
componentVersion ComponentVersion Version of the dependency.
dependencyPaths DependencyPathPage Introduced as an experiment in GitLab 18.2.

Ancestor dependency paths for a dependency. Returns null if dependency_graph_graphql feature flag is disabled.

Arguments for dependencyPaths:
after (String)
Fetch paths after the cursor.
before (String)
Fetch paths before the cursor.
limit (Int)
Number of paths to fetch.
id GlobalID! ID of the dependency.
licenses [License!] Licenses associated to the dependency.
location Location Information about where the dependency is located.
malware Boolean Introduced as an experiment in GitLab 19.1.

Indicates whether the dependency is a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
name String! Name of the dependency.
occurrenceCount Int! Number of occurrences of the dependency across projects.
packager PackageManager Description of the tool used to manage the dependency.
projectCount Int Introduced as an experiment in GitLab 19.2.

Number of projects that use the dependency.
reachability ReachabilityType Information about reachability of a dependency.
version String Deprecated in GitLab 18.1. Replaced by component_version.
vulnerabilities VulnerabilityConnection Vulnerabilities associated with the dependency. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilityCount Int! Number of vulnerabilities within the dependency.

DependencyAggregationConnection#

Paginated collection of DependencyAggregation. See Standard connection fields for the fields available on every connection.

DependencyConnection#

Paginated collection of Dependency. See Standard connection fields for the fields available on every connection.

DependencyFirewallActivitySummary#

Aggregate dependency firewall enforcement activity totals for a group or project.

Fields#

Name Type Description
activeRules Int! Number of active (enabled) dependency firewall rules.
allowed Int! Total allowed (pass-through) enforcement events in the window.
blocked Int! Total blocked enforcement events in the window.
blockingRules Int! Number of active rules in enforce (blocking) mode.
licenseRisksPrevented Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions blocked by license rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
licenseRisksWarnedOnly Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions warned but never blocked by license rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
maliciousPackagesPrevented Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions blocked by malicious-package rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
maliciousPackagesWarnedOnly Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions warned but never blocked by malicious-package rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
totalTriggers Int! Total enforcement events (blocked + warned + allowed) in the window.
vulnerabilitiesPrevented Int Introduced as an experiment in GitLab 19.5.

Number of distinct package versions blocked by vulnerability or risk-severity rules. Counts from from up to now; to does not apply. Null when not available, including for groups.
vulnerabilitiesPreventedBySeverity [DependencyFirewallSeverityCount!] Introduced as an experiment in GitLab 19.5.

Breakdown of prevented packages by their highest carried severity. Sums to the prevented total. Counts from from up to now; to does not apply. Null when not available, including for groups.
warned Int! Total warned enforcement events in the window.
warningRules Int! Number of active rules in warn mode.

DependencyFirewallPolicyAttributesType#

Represents policy fields related to the dependency firewall policy.

Fields#

Name Type Description
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.

DependencyFirewallRuleActivity#

Block and warn enforcement activity for a single dependency firewall policy rule.

Fields#

Name Type Description
activityCount Int! Activity count matching the rule mode: blocks for enforce, warns for warn.
blockedCount Int! Number of blocked enforcement events for the rule in the window.
enabled Boolean! Whether the policy the rule belongs to is enabled.
id SecurityDependencyFirewallPolicyRuleID! Global ID of the dependency firewall policy rule.
lastModified DependencyFirewallRuleLastModified When and by whom the policy the rule belongs to was last modified.
mode PolicyEnforcementType Enforcement mode of the rule.
policyName String Name of the policy the rule belongs to.
ruleType DependencyFirewallRuleType Type of the rule.
scope PolicyScope Scope of the policy the rule belongs to.
source SecurityPolicySource Source of the policy, indicating whether it is inherited from an ancestor group.
sourceRelationship SecurityPolicyRelationType Where the policy is defined relative to the viewed container.
warnedCount Int! Number of warned enforcement events for the rule in the window.

DependencyFirewallRuleLastModified#

When and by whom a dependency firewall policy was last modified.

Fields#

Name Type Description
at Time Timestamp of when the policy was last modified.
by UserCore User who last modified the policy.

DependencyFirewallSeverityCount#

Count of distinct prevented packages at one severity level.

Fields#

Name Type Description
count Int! Number of distinct packages whose highest carried severity matches the severity field.
severity VulnerabilitySeverity! Severity level of the count.

DependencyListExportPartUploadRegistry#

Represents the Geo replication and verification state of a dependency_list_export_part_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyListExportPartUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyListExportPartUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DependencyListExportPartUploadRegistry.
dependencyListExportPartUploadId ID! ID of the Dependency List Export Part Upload.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DependencyListExportPartUploadRegistry.
lastSyncFailure String Error message during sync of the DependencyListExportPartUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DependencyListExportPartUploadRegistry.
missingOnPrimary Boolean Indicate if the DependencyListExportPartUploadRegistry is missing on primary.
modelRecordId Int ID of the DependencyListExportPartUploadRegistry's model record.
retryAt Time Timestamp after which the DependencyListExportPartUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DependencyListExportPartUploadRegistry.
state RegistryState Sync state of the DependencyListExportPartUploadRegistry.
verificationChecksum String The local checksum of the DependencyListExportPartUploadRegistry.
verificationChecksumMismatched String The expected checksum of the DependencyListExportPartUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the DependencyListExportPartUploadRegistry.
verificationRetryAt Time Timestamp after which the DependencyListExportPartUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DependencyListExportPartUploadRegistry.
verificationStartedAt Time Timestamp when the verification of DependencyListExportPartUploadRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyListExportPartUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyListExportPartUploadRegistry.

DependencyListExportPartUploadRegistryConnection#

Paginated collection of DependencyListExportPartUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

DependencyListExportUploadRegistry#

Represents the Geo replication and verification state of a dependency_list_export_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyListExportUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyListExportUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DependencyListExportUploadRegistry.
dependencyListExportUploadId ID! ID of the Dependency List Export Upload.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DependencyListExportUploadRegistry.
lastSyncFailure String Error message during sync of the DependencyListExportUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DependencyListExportUploadRegistry.
missingOnPrimary Boolean Indicate if the DependencyListExportUploadRegistry is missing on primary.
modelRecordId Int ID of the DependencyListExportUploadRegistry's model record.
retryAt Time Timestamp after which the DependencyListExportUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DependencyListExportUploadRegistry.
state RegistryState Sync state of the DependencyListExportUploadRegistry.
verificationChecksum String The local checksum of the DependencyListExportUploadRegistry.
verificationChecksumMismatched String The expected checksum of the DependencyListExportUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the DependencyListExportUploadRegistry.
verificationRetryAt Time Timestamp after which the DependencyListExportUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DependencyListExportUploadRegistry.
verificationStartedAt Time Timestamp when the verification of DependencyListExportUploadRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyListExportUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyListExportUploadRegistry.

DependencyListExportUploadRegistryConnection#

Paginated collection of DependencyListExportUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

DependencyLocation#

Location of a software dependency within a project.

Fields#

Name Type Description
hasDependencyPaths Boolean! Indicates whether the dependency has any dependency paths.
location Location Information about where the dependency is located.
occurrenceId SbomOccurrenceID! Global ID of the SBOM occurrence.
project Project Project containing the dependency.

DependencyLocationConnection#

Paginated collection of DependencyLocation. See Standard connection fields for the fields available on every connection.

DependencyPath#

Ancestor path of a given dependency.

Fields#

Name Type Description
isCyclic Boolean! Indicates if the path is cyclic.
path [DependencyPathPartial!]! Name of the dependency.

DependencyPathEdge#

Edge for a paginated dependency path for SBOM occurrences.

Fields#

Name Type Description
cursor String! Cursor for use in pagination.
node DependencyPath Dependency path node.

DependencyPathPage#

Paginated dependency paths for SBOM occurrences.

Fields#

Name Type Description
edges [DependencyPathEdge!]! List of dependency path edges.
nodes [DependencyPath!]! List of dependency paths.
pageInfo DependencyPathPageInfo! Pagination information for dependency paths.

DependencyPathPageInfo#

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.

DependencyPathPartial#

Ancestor path partial of a given dependency.

Fields#

Name Type Description
name String! Name of 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.

DependencyProxyBlobConnection#

Paginated collection of DependencyProxyBlob. See Standard connection fields for the fields available on every connection.

DependencyProxyBlobRegistry#

Represents the Geo replication and verification state of a dependency_proxy_blob.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyProxyBlobRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyProxyBlobRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DependencyProxyBlobRegistry.
dependencyProxyBlobId ID! ID of the Dependency Proxy Blob.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the DependencyProxyBlobRegistry is missing on primary.
modelRecordId Int ID of the DependencyProxyBlobRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the DependencyProxyBlobRegistry in case of mismatch.
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 of DependencyProxyBlobRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyProxyBlobRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyProxyBlobRegistry.

DependencyProxyBlobRegistryConnection#

Paginated collection of DependencyProxyBlobRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

DependencyProxyManifestConnection#

Paginated collection of DependencyProxyManifest. See Standard connection fields for the fields available on every connection.

DependencyProxyManifestRegistry#

Represents the Geo replication and verification state of a dependency_proxy_manifest.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyProxyManifestRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyProxyManifestRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DependencyProxyManifestRegistry.
dependencyProxyManifestId ID! ID of the Dependency Proxy Manifest.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the DependencyProxyManifestRegistry is missing on primary.
modelRecordId Int ID of the DependencyProxyManifestRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the DependencyProxyManifestRegistry in case of mismatch.
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 of DependencyProxyManifestRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyProxyManifestRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyProxyManifestRegistry.

DependencyProxyManifestRegistryConnection#

Paginated collection of DependencyProxyManifestRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

DependencyProxyPackagesSetting#

Project-level Dependency Proxy for packages settings.

Fields#

Name Type Description
enabled Boolean! Indicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryUrl String URL for the external Maven packages registry.
mavenExternalRegistryUsername String 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.
identity String Identity credential used to authenticate with Docker Hub when pulling images. Can be a username (for password or personal access token (PAT)) or organization name (for organization access token (OAT)).

DependencyScanningConfiguration#

Configuration for a dependency scanning scan profile.

Fields#

Name Type Description
additionalCaCertBundle String Introduced as an experiment in GitLab 19.5.

CA certificate bundle to trust. The bundle is added to the system's certificates and used by other tools during the scan.
apiScanDownloadDelay Int Introduced as an experiment in GitLab 19.5.

Vulnerability scanning API initial delay in seconds before downloading scan results.
apiTimeout Int Introduced as an experiment in GitLab 19.5.

Vulnerability scanning API request timeout in seconds.
disabledResolutionJobs [SecurityScanProfileDependencyResolutionJob!] Introduced as an experiment in GitLab 19.5.

Resolution jobs that are disabled.
enableManifestFallback Boolean Introduced as an experiment in GitLab 19.5.

Whether manifest fallback for dependency scanning is enabled.
enableVulnerabilityScan Boolean Introduced as an experiment in GitLab 19.5.

Whether the vulnerability analysis of generated SBOMs is enabled.
excludedPaths [String!] Introduced as an experiment in GitLab 19.5.

Glob paths excluded from the scan.
gradleCliOpts String Introduced as an experiment in GitLab 19.5.

Additional command-line options passed to Gradle during dependency resolution.
gradleResolutionImage String Introduced as an experiment in GitLab 19.5.

Image used by the Gradle dependency resolution job.
includeDevDependencies Boolean Introduced as an experiment in GitLab 19.5.

Whether development and test dependencies are included when scanning a supported file.
mavenArgs String Introduced as an experiment in GitLab 19.5.

Additional arguments passed to Maven during dependency resolution.
mavenDependencyPluginVersion String Introduced as an experiment in GitLab 19.5.

Version of maven-dependency-plugin used during resolution.
mavenResolutionImage String Introduced as an experiment in GitLab 19.5.

Image used by the Maven dependency resolution job.
maxDepth Int Introduced as an experiment in GitLab 19.5.

Specifies the directory depth the analyzer should scan. A value of -1 scans all directories.
pipDependencyPath String Introduced as an experiment in GitLab 19.5.

Path to install Python packages for analysis.
pipExtraIndexUrl [String!] Introduced as an experiment in GitLab 19.5.

Additional URLs of Python package indexes used in addition to pipIndexUrl.
pipIndexUrl String Introduced as an experiment in GitLab 19.5.

Base URL of the Python Package Index.
pipManifestFileNamePattern String Introduced as an experiment in GitLab 19.5.

Custom pip manifest file name pattern to use for dependency resolution and manifest scanning. The pattern matches file names only, not directory paths.
pipcompileLockfileFileNamePattern String Introduced as an experiment in GitLab 19.5.

Custom pipcompile lockfile file name pattern to use when analyzing. The pattern matches file names only, not directory paths.
pythonResolutionImage String Introduced as an experiment in GitLab 19.5.

Image used by the Python dependency resolution job.
searchIgnoreHiddenDirs Boolean Introduced as an experiment in GitLab 19.5.

Whether hidden directories are ignored when searching for supported files.
secureAnalyzersPrefix String Introduced as an experiment in GitLab 19.5.

Prefix for the container registry from which the analyzer image is pulled.
secureLogLevel SecurityScanProfileSecureLogLevel Introduced as an experiment in GitLab 19.5.

Logging level used by the analyzer.
staticReachabilityEnabled Boolean Introduced as an experiment in GitLab 19.5.

Whether static reachability is enabled.

DependencyTrackedRef#

Ref (branch or tag) where a software dependency appears.

Fields#

Name Type Description
id SecurityProjectTrackedContextID! Global ID of the tracked ref.
isDefault Boolean! Indicates whether the ref is the default branch.
name String! Name of the ref (branch or tag name).
refType SecurityTrackedRefType! Type of the ref (branch or tag).

DependencyTrackedRefConnection#

Paginated collection of DependencyTrackedRef. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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 String 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.
refPath String Path to the 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.
webPath String Web path to the deployment page.

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.

DeploymentConnection#

Paginated collection of Deployment. See Standard connection fields for the fields available on every connection.

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 the git tag.
path String Path for the tag.
webPath String Web path for the tag.

DeploymentsAggregationResponse#

Response for Deployments aggregation engine.

Fields#

Name Type Description
canceledRate Float Deployment canceled rate (out of finished deployments).
deploymentDurationQuantile Float Deployment duration quantile in milliseconds.

Arguments for deploymentDurationQuantile:
quantile (Float)
dimensions DeploymentsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
duration DeploymentsAggregationResponseDurationMetrics Aggregated duration metrics.
failureRate Float Deployment failure rate (out of finished deployments).
successRate Float Deployment success rate (out of finished deployments).
totalCount Int Total number of deployments.

DeploymentsAggregationResponseConnection#

Paginated collection of DeploymentsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

DeploymentsAggregationResponseDimensions#

Response dimensions for Deployments aggregation engine.

Fields#

Name Type Description
createdAt Date Deployment creation date.

Arguments for createdAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
environment Environment Environment ID.
finishedAt Date Deployment finish date.

Arguments for finishedAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
ref String Deployment ref.
status String Deployment status.
user UserCore User who created the deployment. Returns null if there is no recorded creator, or if that user has been deleted.

DeploymentsAggregationResponseDurationMetrics#

Aggregated duration metrics for Deployments aggregation engine.

Fields#

Name Type Description
max Int Maximum deployment duration in seconds.
mean Float Mean deployment duration in seconds.
min Int Minimum deployment duration in seconds.
quantile Float Quantile of deployment duration in seconds.

Arguments for quantile:
quantile (Float)
sum Float Sum of deployment duration in seconds.

DeploymentsAggregationScope#

Aggregation scope for Deployments. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated DeploymentsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

DescriptionVersion#

Fields#

Name Type Description
canDelete Boolean Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deletePath String Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deleted Boolean Deprecated in GitLab 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.
diff String Description diff between versions.

Arguments for diff:
versionId (DescriptionVersionID)
ID of a previous version to compare. If not specified first previous version is used.
diffPath String Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
id DescriptionVersionID! ID of the description version.

Design#

A single design.

Implements: CurrentUserTodos, DesignFields, NoteableInterface, Todoable

Fields#

Name Type Description
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
description String Description of the design.
descriptionHtml String GitLab Flavored Markdown rendering of description.
diffRefs DiffRefs! Diff refs for the design.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
event DesignVersionEvent! How the design was changed in the current version.
filename String! Filename of the design.
fullPath ID! Full path to the design file.
id ID! ID of the 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.
imported Boolean! Indicates whether the design was imported.
importedFrom ImportSource! Import source of the design.
issue Issue! Issue the design belongs to.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
notesCount Int! Total count of user-created notes for the design.
project Project! Project the design belongs to.
versions DesignVersionConnection! All versions related to this design ordered newest first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
earlierOrEqualToId (DesignManagementVersionID)
Global ID of the most recent acceptable version.
earlierOrEqualToSha (String)
SHA256 of the most recent acceptable version.
webUrl String! URL of the design.

DesignAtVersion#

A design pinned to a specific version. The image field reflects the design as of the associated version.

Implements: DesignFields

Fields#

Name Type Description
design Design! Underlying design.
diffRefs DiffRefs! Diff refs for the design.
event DesignVersionEvent! How the design was changed in the current version.
filename String! Filename of the design.
fullPath ID! Full path to the design file.
id ID! ID of the 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 the design.
project Project! Project the design belongs to.
version DesignVersion! Version the design-at-versions is pinned to.

DesignAtVersionConnection#

Paginated collection of DesignAtVersion. See Standard connection fields for the fields available on every connection.

DesignCollection#

A collection of designs.

Fields#

Name Type Description
copyState DesignCollectionCopyState Copy state of the design collection.
design Design Find a specific design.

Arguments for design:
filename (String)
Find a design by its filename.
id (DesignManagementDesignID)
Find a design by its ID.
designAtVersion DesignAtVersion Find a design as of a version.

Arguments for designAtVersion:
id (DesignManagementDesignAtVersionID!)
Global ID of the design at the version.
designs DesignConnection! All designs for the design collection. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for designs:
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.
issue Issue! Issue associated with the design collection.
project Project! Project associated with the design collection.
version DesignVersion A specific version.

Arguments for version:
id (DesignManagementVersionID)
Global ID of the version.
sha (String)
SHA256 of a specific version.
versions DesignVersionConnection! All versions related to all designs, ordered newest first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
earlierOrEqualToId (DesignManagementVersionID)
Global ID of the most recent acceptable version.
earlierOrEqualToSha (String)
SHA256 of the most recent acceptable version.

DesignConnection#

Paginated collection of Design. See Standard connection fields for the fields available on every connection.

DesignManagement#

Fields#

Name Type Description
designAtVersion DesignAtVersion Find a design as of a version.

Arguments for designAtVersion:
id (DesignManagementDesignAtVersionID!)
Global ID of the design at the version.
version DesignVersion Find a version.

Arguments for version:
id (DesignManagementVersionID!)
Global ID of the version.

DesignManagementActionUploadRegistry#

Represents the Geo replication and verification state of a design_management_action_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DesignManagementActionUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DesignManagementActionUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DesignManagementActionUploadRegistry.
designManagementActionUploadId ID! ID of the Design Management Action Upload.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DesignManagementActionUploadRegistry.
lastSyncFailure String Error message during sync of the DesignManagementActionUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DesignManagementActionUploadRegistry.
missingOnPrimary Boolean Indicate if the DesignManagementActionUploadRegistry is missing on primary.
modelRecordId Int ID of the DesignManagementActionUploadRegistry's model record.
retryAt Time Timestamp after which the DesignManagementActionUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DesignManagementActionUploadRegistry.
state RegistryState Sync state of the DesignManagementActionUploadRegistry.
verificationChecksum String The local checksum of the DesignManagementActionUploadRegistry.
verificationChecksumMismatched String The expected checksum of the DesignManagementActionUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the DesignManagementActionUploadRegistry.
verificationRetryAt Time Timestamp after which the DesignManagementActionUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DesignManagementActionUploadRegistry.
verificationStartedAt Time Timestamp when the verification of DesignManagementActionUploadRegistry started.
verificationState VerificationStateEnum Verification state of the DesignManagementActionUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DesignManagementActionUploadRegistry.

DesignManagementActionUploadRegistryConnection#

Paginated collection of DesignManagementActionUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

DesignManagementRepositoryRegistry#

Represents the Geo replication and verification state of a Design Management Repository.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DesignManagementRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DesignManagementRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this DesignManagementRepositoryRegistry.
designManagementRepositoryId ID! ID of the Design Management Repository.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the DesignManagementRepositoryRegistry is missing on primary.
modelRecordId Int ID of the DesignManagementRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the DesignManagementRepositoryRegistry in case of mismatch.
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 of DesignManagementRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the DesignManagementRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DesignManagementRepositoryRegistry.

DesignManagementRepositoryRegistryConnection#

Paginated collection of DesignManagementRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.
designAtVersion DesignAtVersion! A particular design as of this version, provided it is visible at this version.

Arguments for designAtVersion:
designId (DesignManagementDesignID)
ID of a specific design.
filename (String)
Filename of a specific design.
id (DesignManagementDesignAtVersionID)
ID of the DesignAtVersion.
designs DesignConnection! All designs that were changed in the version. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
designsAtVersion DesignAtVersionConnection! All designs that are visible at this version, as of this version. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for designsAtVersion:
filenames ([String!])
Filters designs by their filename.
ids ([DesignManagementDesignID!])
Filters designs by their ID.
id ID! ID of the design version.
sha ID! SHA of the design version.

DesignVersionConnection#

Paginated collection of DesignVersion. See Standard connection fields for the fields available on every connection.

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.
deploymentDetailsPath String Path of the deployment details for the status.
detailsPath String Path of the details for the status.
favicon String Favicon of the status.
group String Deprecated in GitLab 16.4. The group attribute is deprecated. Use name instead.
hasDetails Boolean Indicates if the status has further details.
icon String Deprecated in GitLab 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 GitLab 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.
snapshots DevopsAdoptionSnapshotConnection Data snapshots of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snapshots:
endTimeAfter (Time)
Filter to snapshots with month end after the provided date.
endTimeBefore (Time)
Filter to snapshots with month end before the provided date.

DevopsAdoptionEnabledNamespaceConnection#

Paginated collection of DevopsAdoptionEnabledNamespace. See Standard connection fields for the fields available on every connection.

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.

DevopsAdoptionSnapshotConnection#

Paginated collection of DevopsAdoptionSnapshot. See Standard connection fields for the fields available on every connection.

Diff#

Fields#

Name Type Description
aMode String Old file mode of the file.
bMode String New file mode of the file.
collapsed String File diffs are excluded but can be fetched on request.
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.
tooLarge String File diffs are excluded and cannot be retrieved.

DiffConnection#

Paginated collection of Diff. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
overflow Boolean! Whether files were omitted from the page because it exceeded the diff size limits. Omitted files are absent from nodes and are not flagged with collapsed or too_large.

DiffLine#

A single line of a diff displayed above a diff note.

Fields#

Name Type Description
canReceiveSuggestion Boolean! Indicates whether the line can receive a suggestion.
lineCode String Line code of the diff line.
newLine Int Line number on the HEAD SHA.
oldLine Int Line number on the start SHA.
richText String Syntax-highlighted HTML of the diff line.
text String Raw text of the diff line, including the leading diff sign.
type String Type of the diff line, such as 'new' or 'old'. Null for unchanged context lines.

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 the file.
deletions Int! Number of lines deleted from the 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#

Implements: BaseDiscussionInterface, ResolvableInterface

Fields#

Name Type Description
createdAt Time! Timestamp of the discussion's creation.
id DiscussionID! ID of the discussion.
noteable NoteableType Object which the discussion belongs to.
notes NoteConnection! All notes in the discussion. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
replyId DiscussionID! ID used to reply to the 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.
truncatedDiffLines [DiffLine!] At most 16 highlighted diff lines above the diff note, up to and including the commented line. Null for non-diff discussions.
userPermissions DiscussionPermissions! Permissions for the current user on the resource.

DiscussionConnection#

Paginated collection of Discussion. See Standard connection fields for the fields available on every connection.

DiscussionPermissions#

Fields#

Name Type Description
resolveNote Boolean! If true, the user can perform resolve_note on this resource.

Dora#

All information related to DORA metrics.

Fields#

Name Type Description
metrics [DoraMetric!] DORA metrics for the current group or project.

Arguments for metrics:
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.
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.

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.

DoraPerformanceScoreCountConnection#

Paginated collection of DoraPerformanceScoreCount. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
noDoraDataProjectsCount Int! Count of projects without any DORA scores within the scope.
totalProjectsCount Int! Count of total projects.

DuoCodeSuggestionsAggregationResponse#

Response for DuoCodeSuggestions aggregation engine.

Fields#

Name Type Description
acceptanceRate Float Acceptance rate (accepted / shown).
acceptedCount Int Number of accepted suggestions.
dimensions DuoCodeSuggestionsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
rejectedCount Int Number of rejected suggestions.
shownCount Int Number of shown suggestions.
suggestionSizeSum Int Total suggestions volume.
totalCount Int Total number of suggestions.
usersCount Int Number of unique users.

DuoCodeSuggestionsAggregationResponseConnection#

Paginated collection of DuoCodeSuggestionsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

DuoCodeSuggestionsAggregationResponseDimensions#

Response dimensions for DuoCodeSuggestions aggregation engine.

Fields#

Name Type Description
ideName String IDE name.
language String Programming language.
timestamp Date Suggestion date.

Arguments for timestamp:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
user UserCore User.

DuoCodeSuggestionsAggregationScope#

Aggregation scope for DuoCodeSuggestions. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated DuoCodeSuggestionsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

DuoContextExclusionSettings#

Settings for Duo context exclusion rules.

Fields#

Name Type Description
exclusionRules [String!] List of rules for excluding files from Duo context.

DuoMessage#

A message in a Duo Workflow chat log.

Fields#

Name Type Description
additionalContext [AiAdditionalContext!] Additional context items attached to the message.
alternativeCount Int Introduced as an experiment in GitLab 19.3.

The count of alternative branches for a user message -1 (the currently displayed branch). A thread can have multiple branches when a message is retried, and a new branch is created with the same parent_ts as the message being retried.Returns null on every message, if the dw_read_blobs_graphql feature flag is disabled, or if the session does not store incremental checkpoints.
componentName String Introduced as an experiment in GitLab 19.0.

Component name associated with the message.
content String! Content of the message.
correlationId String Optional client-supplied identifier echoed back to correlate this message with the request that initiated it.
messageId ID Opaque identifier for the message, assigned by the workflow executor.
messageSubType String Introduced as an experiment in GitLab 19.0.

Sub-type of the message, used to discriminate among messages of the same type.
messageType String! Type of the message.
parentTs String Introduced as an experiment in GitLab 19.3.

Identifier of the checkpoint preceding the one that introduced the message, which is the point a client resumes the session from to regenerate it. Returns null if the dw_read_blobs_graphql feature flag is disabled, or if the session does not store incremental checkpoints.
role String Role of the message.
status String Status of the message.
subsessionId String Introduced as an experiment in GitLab 19.0.

Subsession ID associated with the message.
threadTs String Introduced as an experiment in GitLab 19.3.

Identifier of the checkpoint that introduced the message. Returns null if the dw_read_blobs_graphql feature flag is disabled, or if the session does not store incremental checkpoints.
timestamp String Timestamp of the message.
toolInfo String Tool information for the message.

DuoSettings#

GitLab Duo settings.

Fields#

Name Type Description
aiGatewayTimeoutSeconds Int Timeout in seconds for requests to the AI Gateway server.
aiGatewayUrl String Introduced as an experiment in GitLab 17.9.

URL for the local AI Gateway server.
allowAllUnixSockets Boolean Introduced as an experiment in GitLab 19.0.

Whether all Unix sockets are allowed for network access.
allowProjectExtension Boolean Introduced as an experiment in GitLab 19.0.

Whether projects can extend the network access domain allowlist.
duoAgentPlatformServiceUrl String Introduced as an experiment in GitLab 18.4.

URL for local Duo Agent Platform service.
duoCliEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates whether GitLab Duo CLI access is enabled.
duoCoreFeaturesEnabled Boolean Introduced as an experiment in GitLab 18.0.

Indicates whether GitLab Duo Core features are enabled.
includeRecommendedAllowed Boolean Introduced as an experiment in GitLab 19.0.

Whether recommended domains are included in the network access allowlist.
minimumAccessLevelEnableOnProjects AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level required to enable Duo Agent Platform. Returns null if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelExecute AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level required to execute Duo Agent Platform. Returns null if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelExecuteAsync AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level required to execute Duo Agent Platform features in CI/CD. Returns null if dap_instance_customizable_permissions feature flag is disabled.
minimumAccessLevelManage AccessLevelEnum Introduced as an experiment in GitLab 18.7.

Minimum access level required to manage Duo Agent Platform. Returns null if dap_instance_customizable_permissions feature flag is disabled.
selfHostedDuoAgentPlatformServiceSecure Boolean Whether local Duo Agent Platform service uses secure transport (TLS).
updatedAt Time! Introduced as an experiment in GitLab 17.9.

Timestamp of last GitLab Duo setting update.

DuoUsageEventsAggregationResponse#

Response for DuoUsageEvents aggregation engine.

Fields#

Name Type Description
dimensions DuoUsageEventsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
featuresCount Int Number of unique features.
previousPeriodUsersCount Int Number of unique users in the previous period.
returningUsersCount Int Number of users who also used this feature in the previous period.
totalCount Int Total number of events, optionally filtered by event name.

Arguments for totalCount:
event ([String!])
Only count the given events.
usersCount Int Number of unique users.

DuoUsageEventsAggregationResponseConnection#

Paginated collection of DuoUsageEventsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

DuoUsageEventsAggregationResponseDimensions#

Response dimensions for DuoUsageEvents aggregation engine.

Fields#

Name Type Description
event String Event identifier.
feature String Feature identifier.
flowType String Duo Agent Platform flow type; NULL for non-DAP events.
group Group Group at the requested depth of the hierarchy. NULL for events tracked above that depth. Events tracked in a project at that depth bucket by project namespace ID, which also resolves to NULL.

Arguments for group:
depth (Int)
Depth in the group hierarchy, counted from the top-level group. Defaults to 1.
timestamp Date Event date.

Arguments for timestamp:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
user UserCore Event owner.

DuoUsageEventsAggregationScope#

Aggregation scope for DuoUsageEvents. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated DuoUsageEventsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
featuresCountFrom (Int)
Filter by the number of unique features The features_count metric must also be requested when using this filter. Start of the range.
featuresCountTo (Int)
Filter by the number of unique features The features_count metric must also be requested when using this filter. End of the range.
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

DuoWorkflow#

GitLab Duo Agent Platform session.

Implements: Todoable

Fields#

Name Type Description
agentName String Introduced as an experiment in GitLab 18.8.

Name of the agent used for the workflow.
agentPrivilegesNames [String!] Privileges granted to the agent during execution.
aiCatalogItem AiCatalogItem Introduced as an experiment in GitLab 19.4.

AI catalog item (flow or agent definition) that the session ran.
aiCatalogItemVersionId AiCatalogItemVersionID Introduced as an experiment in GitLab 18.4.

ID of the AI catalog item version that triggered the workflow.
allExecutorLogsUrls [String!] List of all the executor logs for the workflow.
allowAgentToRequestUser Boolean Allow the agent to request user input.
allowClientInjectedMcpTools Boolean Introduced as an experiment in GitLab 19.5.

Indicates MCP tools supplied by the client skip the tool call approval gate. Toggled by the dap_allow_client_injected_mcp_tools feature flag; returns false when it is disabled.
archived Boolean Archived due to retention policy.
auditEvents AiAuditEventConnection Introduced as an experiment in GitLab 19.0.

Audit events recorded for the session. Requires read_agent_artifacts on the workflow's project or namespace. Returns no events when the agent_artifacts_page feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp of when the session was created.
environment WorkflowEnvironment Environment, like IDE or web.
firstCheckpoint DuoWorkflowEvent First checkpoint of the session.

Arguments for firstCheckpoint:
checkpointNs (String)
Introduced as an experiment in GitLab 19.3.

LangGraph checkpoint namespace to scope the lookup to. Omit (or pass an empty string) for the session's own top-level checkpoint lineage; used internally to resolve one nested subgraph invocation, e.g. a delegated subagent.
flowMetadataId String Introduced as an experiment in GitLab 19.3.

Identifier of the flow that was executed in the session.
flowMetadataSchemaVersion String Introduced as an experiment in GitLab 19.3.

Schema version of the flow metadata for the session.
flowMetadataVersion String Introduced as an experiment in GitLab 19.3.

Version of the flow that was executed in the session.
goal String Goal of the session.
humanStatus String! Human-readable status of the session.
id ID! ID of the session.
incrementalCheckpointsEnabled Boolean Indicates incremental checkpoints were enabled for the session at creation.
inverseWorkflowLinks DuoWorkflowWorkflowLinkConnection Other sessions that link to the session, for example the sessions restarted from it. On each link, workflow is the other session and linkedWorkflow is the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for inverseWorkflowLinks:
linkType (DuoWorkflowWorkflowLinkType)
Filter links by their link type.
lastExecutorLogsUrl String URL to the latest executor logs of the workflow.
latestCheckpoint DuoWorkflowEvent Latest checkpoint of the session.

Arguments for latestCheckpoint:
checkpointNs (String)
Introduced as an experiment in GitLab 19.3.

LangGraph checkpoint namespace to scope the lookup to. Omit (or pass an empty string) for the session's own top-level checkpoint lineage; used internally to resolve one nested subgraph invocation, e.g. a delegated subagent.
mcpEnabled Boolean Has MCP been enabled for the namespace.
mergeRequest MergeRequest Associated merge request, if any.
mergeRequestLinks DuoWorkflowMergeRequestLinkConnection Merge requests linked to the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequestLinks:
linkType (DuoWorkflowMergeRequestLinkType)
Filter links by their link type.
modelMetadataIdentifier String Introduced as an experiment in GitLab 19.2.

Provider model identifier used for the session.
modelMetadataName String Introduced as an experiment in GitLab 19.2.

Model used for the session.
name String Name or title of the object.
namespace Namespace namespace that the session is in.
namespaceId TypesNamespaceID ID of the namespace.
noteLinks DuoWorkflowNoteLinkConnection Notes linked to the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for noteLinks:
linkType (DuoWorkflowNoteLinkType)
Filter links by their link type.
pipelineLinks DuoWorkflowPipelineLinkConnection Pipelines linked to the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineLinks:
linkType (DuoWorkflowPipelineLinkType)
Filter links by their link type.
preApprovedAgentPrivilegesNames [String!] Privileges pre-approved for the agent during execution.
project Project Project that the session is in.
projectId ProjectID ID of the project.
resourceIid Int IID of the associated resource (issue or merge request).
resourceWebUrl String Web URL of the associated resource (issue or merge request).
sourceLink String Introduced as an experiment in GitLab 19.4.

URL or deep link to the location where the session was triggered from.
sourceType DuoWorkflowSourceType Introduced as an experiment in GitLab 19.4.

Type of source that initiated the session.
stalled Boolean Workflow got created but has no checkpoints.
status DuoWorkflowStatus Status of the session.
statusGroup DuoWorkflowStatusGroup Status group of the flow session.
statusName String Status name of the session.
summary String Summary of the session.
title String Title of the session.
toolCallApprovalMatch DuoWorkflowToolCallApprovalMatch! Introduced as an experiment in GitLab 19.3.

Approval match details for the specified tool call.

Arguments for toolCallApprovalMatch:
toolCallArgs (String!)
JSON-serialized arguments for the tool call.
toolName (String!)
Name of the tool to check.
toolCallApprovals JSON Tools approval per session policy.
toolCallApproved Boolean! Whether the specified tool call is approved for the session.

Arguments for toolCallApproved:
toolCallArgs (String!)
JSON-serialized arguments for the tool call.
toolName (String!)
Name of the tool to check.
updatedAt Time! Timestamp of when the session was last updated.
user UserCore User who created the session.
userId UserID! ID of the user.
userPermissions DuoWorkflowPermissions Permissions of the current user for the workflow.
webSearchEnabled Boolean Introduced as an experiment in GitLab 19.3.

Whether web search is enabled for the session.
webUrl String URL of the session.
workItem WorkItem Associated work item (issue or epic), if any.
workItemLinks DuoWorkflowWorkItemLinkConnection Work items linked to the session. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemLinks:
linkType (DuoWorkflowWorkItemLinkType)
Filter links by their link type.
workflowDefinition String GitLab Duo Agent Platform flow type based on its capabilities.
workflowLinks DuoWorkflowWorkflowLinkConnection Other sessions linked to the session, for example the session it was restarted from. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workflowLinks:
linkType (DuoWorkflowWorkflowLinkType)
Filter links by their link type.

DuoWorkflowAgentPresence#

Agent attribution for an object, such as a note, created by a GitLab Duo Agent Platform session.

Fields#

Name Type Description
agentCatalogWebPath String Web path of the agent in the AI Catalog. Null when the agent has no catalog profile.
agentName String Name of the agent that ran the session.
sessionId AiDuoWorkflowsWorkflowID! Global ID of the session that created the object.
sourceLink String URL or deep link to the location where the session was triggered from. Null unless the current user can read the session.
sourceType DuoWorkflowSourceType Type of source that initiated the session.
triggerSource DuoWorkflowTriggerSource Kind of initiator that started the session.
user UserCore User the session ran as. For triggered sessions, the account the trigger runs with.
userPermissions DuoWorkflowAgentPresencePermissions! Permissions for the current user on the session.

DuoWorkflowAgentPresencePermissions#

Check permissions for the current user on the session that created the object.

Fields#

Name Type Description
readDuoWorkflow Boolean! If true, the user can perform read_duo_workflow on this resource.

DuoWorkflowBranch#

Alternative branch of a Duo Agent Platform session, created by retrying a message.

Fields#

Name Type Description
forkThreadTs String Identifier of the checkpoint to resume the session from to switch to the branch.
messages [DuoMessage!]! Messages the branch added after the point it diverged, oldest first.

DuoWorkflowCheckpointWrite#

A pending write associated with a Duo Workflow checkpoint.

Fields#

Name Type Description
channel String! LangGraph channel the write was made to.
data String! Write data.
id ID! ID of the checkpoint write.
idx Int Index of the write within the task.
task String! LangGraph task identifier the write was made for.
threadTs String! LangGraph thread timestamp identifier the write belongs to.
writeType String! Serialization type of the write data.

DuoWorkflowConnection#

Paginated collection of DuoWorkflow. See Standard connection fields for the fields available on every connection.

DuoWorkflowEnablement#

Duo Agent Platform enablement status checks.

Fields#

Name Type Description
checks [DuoWorkflowEnablementCheck!] Enablement checks.
createDuoWorkflowForCiAllowed Boolean! Introduced as an experiment in GitLab 18.9.

Indicates whether the user can create Duo Workflows for CI in the project.
enabled Boolean! Indicates whether Duo Agent Platform is enabled for current user and the project.
enabledFoundationalFlows [String!] References of the foundational flows enabled for the project, for example "code_review/v1".
foundationalFlowsEnabled Boolean Indicates if Duo Agent Platform foundational flows are enabled for the project.
remoteFlowsEnabled Boolean Indicates if Duo Agent Platform remote flows are enabled for the project.

DuoWorkflowEnablementCheck#

Represents single Duo Agent Platform enablement check.

Fields#

Name Type Description
message String Description of status check.
name String! Name of the status check.
value Boolean! Whether the check was successful or not.

DuoWorkflowEvent#

Events that describe the history and progress of a GitLab Duo Agent Platform session.

Fields#

Name Type Description
checkpoint JsonString Deprecated in GitLab 18.7. Checkpoints are big & contain internal langgraph details.
checkpointNs String Introduced as an experiment in GitLab 19.3.

LangGraph checkpoint namespace this checkpoint belongs to. Blank for the session's own top-level checkpoint lineage; this field only ever surfaces that lineage (via first_checkpoint/latest_checkpoint), never a nested subgraph invocation's own.
checkpointWrites [DuoWorkflowCheckpointWrite!] Introduced as an experiment in GitLab 19.3.

Pending writes associated with the checkpoint, e.g. interrupts awaiting resumption.
compressedCheckpoint String Checkpoint of the event, zlib-compressed and Base64-encoded.
currentThread Int! Introduced as an experiment in GitLab 19.4.

Compaction group this checkpoint belongs to. The writer bumps it on every compaction and resets it when its process restarts, so a client that resumes a session must read it back from here to keep numbering the groups correctly.
duoMessages [DuoMessage!] Messages from the ui_chat_log for the checkpoint.
errors [String!] Message errors.
executionStatus String! Introduced as an experiment in GitLab 17.10.

Granular status of the session's execution.
lastDuoMessage DuoMessage Introduced as an experiment in GitLab 19.3.

Most recent message from the ui_chat_log for the checkpoint. Cheaper than duoMessages for list previews: it reads only the latest message instead of the full chat log.
metadata JsonString Metadata associated with the event.
parentTs String UUID v7 timestamp identifier of the parent message for branched conversations or responses.
threadTs String UUID v7 timestamp identifier for the conversation thread/session in LangGraph state management.
workflowDefinition String GitLab Duo Agent Platform flow type based on its capabilities.
workflowGoal String Goal of the session.
workflowStatus DuoWorkflowStatus Status of the session.

DuoWorkflowEventConnection#

Paginated collection of DuoWorkflowEvent. See Standard connection fields for the fields available on every connection.

Link between a GitLab Duo Agent Platform session and a merge request.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowMergeRequestLinkType! How the merge request relates to the session.
mergeRequest MergeRequest Linked merge request.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowMergeRequestLinkConnection#

Paginated collection of DuoWorkflowMergeRequestLink. See Standard connection fields for the fields available on every connection.

Link between a GitLab Duo Agent Platform session and a note.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowNoteLinkType! How the note relates to the session.
note Note Linked note.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowNoteLinkConnection#

Paginated collection of DuoWorkflowNoteLink. See Standard connection fields for the fields available on every connection.

DuoWorkflowPermissions#

Check permissions for the current user on a Duo workflow.

Fields#

Name Type Description
deleteDuoWorkflow Boolean! If true, the user can perform delete_duo_workflow on this resource.
readDuoWorkflow Boolean! If true, the user can perform read_duo_workflow on this resource.
restartDuoWorkflow Boolean! If true, the user can perform restart_duo_workflow on this resource.
resumeDuoWorkflow Boolean! If true, the user can perform resume_duo_workflow on this resource.
updateDuoWorkflow Boolean! If true, the user can perform update_duo_workflow on this resource.

Link between a GitLab Duo Agent Platform session and a pipeline.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowPipelineLinkType! How the pipeline relates to the session.
pipeline Pipeline Linked pipeline.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowPipelineLinkConnection#

Paginated collection of DuoWorkflowPipelineLink. See Standard connection fields for the fields available on every connection.

DuoWorkflowSessionArtifact#

A Duo Agent Platform session artifact.

Fields#

Name Type Description
agentType String Introduced as an experiment in GitLab 19.4.

Type of the external agent that ran the session, for example claude-code. Null for sessions run on the GitLab Duo Agent Platform.
auditEvents AiAuditEventConnection Audit events recorded for the session. Readable with read_agent_artifacts on the parent group or project; does not require access to the underlying workflow. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
auditEventsCount Int! Number of audit events recorded for the session.
creditsUsed Float Introduced as an experiment in GitLab 19.4.

Total GitLab Credits consumed by the session. Readable with read_agent_artifacts on the parent group or project. Requires ClickHouse to be configured for analytics; ingestion is gated by the duo_workflow_session_credits_ingestion feature flag. Null until credit data has been ingested for the session, including sessions that failed before ingestion.
downloadPath String Path to download the session artifact as a JSON file.
id ID! Global ID of the session, as an Ai::DuoWorkflows::Workflow.
project Project Project the session belongs to.
triggeredBy UserCore User who initiated the session.
webPath String Path of the session.
workflowCreatedAt Time! Timestamp of when the session was created.
workflowDefinition String! Workflow definition type of the session.

DuoWorkflowSessionArtifactConnection#

Paginated collection of DuoWorkflowSessionArtifact. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

DuoWorkflowToolCallApprovalMatch#

Approval match details for a Duo Workflow tool call.

Fields#

Name Type Description
matchType DuoWorkflowToolCallApprovalMatchType Mechanism that produced the match, null when unmatched.
matched Boolean! Indicates the tool call matches a stored approval.
matchedPattern String Glob pattern that produced the match, present only for pattern matches.

Link between a GitLab Duo Agent Platform session and a work item.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowWorkItemLinkType! How the work item relates to the session.
workItem WorkItem Linked work item.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowWorkItemLinkConnection#

Paginated collection of DuoWorkflowWorkItemLink. See Standard connection fields for the fields available on every connection.

Link between a GitLab Duo Agent Platform session and another session.

Fields#

Name Type Description
createdAt Time! Timestamp of when the link was created.
linkType DuoWorkflowWorkflowLinkType! How the linked session relates to the session.
linkedWorkflow DuoWorkflow Session the link points to. For a SOURCE link, the session that was restarted.
workflow DuoWorkflow Linked GitLab Duo Agent Platform session.

DuoWorkflowWorkflowLinkConnection#

Paginated collection of DuoWorkflowWorkflowLink. See Standard connection fields for the fields available on every connection.

DuoWorkflowsAggregationResponse#

Response for DuoWorkflows aggregation engine.

Fields#

Name Type Description
churnedUsersCount Int Number of unique users who ran a flow in the previous period but not in this one.
closedMrCount DuoWorkflowsAggregationResponseClosedMrCountMetrics Aggregated closed_mr_count metrics.
createdMrCount DuoWorkflowsAggregationResponseCreatedMrCountMetrics Aggregated created_mr_count metrics.
creditsPerMergedMrRatio Float Credits used per Duo-created merge request that was later merged.
creditsUsed DuoWorkflowsAggregationResponseCreditsUsedMetrics Aggregated credits_used metrics.
dimensions DuoWorkflowsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
flowTypesCount Int Number of unique flow types.
joinedUsersCount Int Number of unique users who ran a flow in this period but not in the previous one.
mergedMrCount DuoWorkflowsAggregationResponseMergedMrCountMetrics Aggregated merged_mr_count metrics.
openMrCount DuoWorkflowsAggregationResponseOpenMrCountMetrics Aggregated open_mr_count metrics.
previousPeriodUsersCount Int Number of unique users in the previous period.
projectsCount Int Number of unique projects.
returningUsersCount Int Number of unique users who also ran a flow in the previous period.
totalCount Int Total number of flows, optionally filtered by status.

Arguments for totalCount:
status ([String!])
Only count flows with the given statuses (created, running, finished, failed, ...).
usersCount Int Number of unique users.

DuoWorkflowsAggregationResponseClosedMrCountMetrics#

Aggregated closed_mr_count metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Int Maximum number of merge requests created by the flow that were later closed without merging.
mean Float Mean number of merge requests created by the flow that were later closed without merging.
min Int Minimum number of merge requests created by the flow that were later closed without merging.
quantile Float Quantile of number of merge requests created by the flow that were later closed without merging.

Arguments for quantile:
quantile (Float)
sum Float Sum of number of merge requests created by the flow that were later closed without merging.

DuoWorkflowsAggregationResponseConnection#

Paginated collection of DuoWorkflowsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

DuoWorkflowsAggregationResponseCreatedMrCountMetrics#

Aggregated created_mr_count metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Int Maximum number of merge requests created by the flow.
mean Float Mean number of merge requests created by the flow.
min Int Minimum number of merge requests created by the flow.
quantile Float Quantile of number of merge requests created by the flow.

Arguments for quantile:
quantile (Float)
sum Float Sum of number of merge requests created by the flow.

DuoWorkflowsAggregationResponseCreditsUsedMetrics#

Aggregated credits_used metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Float Maximum credits used by the flow.
mean Float Mean credits used by the flow.
min Float Minimum credits used by the flow.
quantile Float Quantile of credits used by the flow.

Arguments for quantile:
quantile (Float)
sum Float Sum of credits used by the flow.

DuoWorkflowsAggregationResponseDimensions#

Response dimensions for DuoWorkflows aggregation engine.

Fields#

Name Type Description
createdAt Date Flow creation date.

Arguments for createdAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
group Group Group at the requested depth of the hierarchy. NULL for flows tracked above that depth. Flows tracked in a project at that depth bucket by project namespace ID, which also resolves to NULL.

Arguments for group:
depth (Int)
Depth in the group hierarchy, counted from the top-level group. Defaults to 1.
model DuoWorkflowsModelMetadata Model used by the flow, resolved to catalog metadata.
modelUsed String Model used by the flow.
project Project Project the flow ran in. Returns null for flows not scoped to a project.
status String Flow status.
user UserCore Flow owner.
userTier String User activity tier, bucketing users by their number of flows in the selected period using the thresholds argument.

Arguments for userTier:
thresholds ([Int!])
Ascending tier boundaries. Values below the first threshold map to tier_0, values at or above the last threshold map to the highest tier.
workflowDefinition String Type of flow.

DuoWorkflowsAggregationResponseMergedMrCountMetrics#

Aggregated merged_mr_count metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Int Maximum number of merge requests created by the flow that were later merged.
mean Float Mean number of merge requests created by the flow that were later merged.
min Int Minimum number of merge requests created by the flow that were later merged.
quantile Float Quantile of number of merge requests created by the flow that were later merged.

Arguments for quantile:
quantile (Float)
sum Float Sum of number of merge requests created by the flow that were later merged.

DuoWorkflowsAggregationResponseOpenMrCountMetrics#

Aggregated open_mr_count metrics for DuoWorkflows aggregation engine.

Fields#

Name Type Description
max Int Maximum number of merge requests created by the flow that are still open.
mean Float Mean number of merge requests created by the flow that are still open.
min Int Minimum number of merge requests created by the flow that are still open.
quantile Float Quantile of number of merge requests created by the flow that are still open.

Arguments for quantile:
quantile (Float)
sum Float Sum of number of merge requests created by the flow that are still open.

DuoWorkflowsAggregationScope#

Aggregation scope for DuoWorkflows. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated DuoWorkflowsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

DuoWorkflowsModelMetadata#

Catalog metadata for a model used by GitLab Duo Agent Platform flows.

Fields#

Name Type Description
hosting DuoWorkflowsModelHosting Where the model is hosted. null for flows with no model attribution.
isDefault Boolean! Whether the model is a configured default for GitLab Duo Agent Platform features.
name String Display name from the model catalog, or the raw value when not in the catalog. null for flows with no model attribution.
provider String Model provider when the catalog identifies it unambiguously.

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.

EgressNodeConnection#

Paginated collection of EgressNode. See Standard connection fields for the fields available on every connection.

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.

EmailConnection#

Paginated collection of Email. See Standard connection fields for the fields available on every connection.

EmailParticipantType#

Fields#

Name Type Description
email String! Email address of the email participant. For guests, the email address is obfuscated.

EmailParticipantTypeConnection#

Paginated collection of EmailParticipantType. See Standard connection fields for the fields available on every connection.

EnabledSecurityScans#

Types of scans enabled on a merge request.

Fields#

Name Type Description
apiFuzzing Boolean! true if there is a Api fuzzing scan in the pipeline.
clusterImageScanning Boolean! true if there is a Cluster image scanning scan in the pipeline.
containerScanning Boolean! true if there is a Container scanning scan in the pipeline.
coverageFuzzing Boolean! true if there is a Coverage fuzzing scan in the pipeline.
dast Boolean! true if there is a Dast scan in the pipeline.
dependencyScanning Boolean! true if there is a Dependency scanning scan in the pipeline.
ready Boolean! Returns true when report processing has been completed.
sarif Boolean! true if there is a Sarif scan in the pipeline.
sast Boolean! true if there is a Sast scan in the pipeline.
secretDetection Boolean! true if there is a Secret detection scan in the pipeline.

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.
autoStopSetting AutoStopSetting Auto stop setting of the environment.
clusterAgent ClusterAgent Cluster agent of the environment.
createdAt Time When the environment was created.
deployFreezes [CiFreezePeriod!] Deployment freeze periods of the environment.
deployments DeploymentConnection Deployments of the environment. This field can only be resolved for one environment in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for deployments:
orderBy (DeploymentsOrderByInput)
Order by a specified field.
statuses ([DeploymentStatus!])
Statuses of the deployments.
deploymentsDisplayCount String Number of deployments in the environment for display. Returns the precise number up to 999, and "999+" for counts exceeding this limit.
description String Description of the environment.
descriptionHtml String GitLab Flavored Markdown rendering of description.
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.
lastDeployment Deployment Last deployment of the environment.

Arguments for lastDeployment:
status (DeploymentStatus!)
Status of the Deployment.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

EnvironmentConnection#

Paginated collection of Environment. See Standard connection fields for the fields available on every connection.

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.

Implements: CurrentUserTodos, Eventable, NoteableInterface, Todoable

Fields#

Name Type Description
ancestors EpicConnection Ancestors (parents) of the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ancestors:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
author UserCore! Author of the epic.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blocked Boolean Indicates the epic is blocked.
blockedByCount Int Count of epics blocking the epic.
blockedByEpics EpicConnection Epics blocking the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingCount Int Count of epics that the epic is blocking.
children EpicConnection Children (sub-epics) of the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for children:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
closedAt Time Timestamp of when the epic was closed.
color String Color of the epic.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
confidential Boolean Indicates if the epic is confidential.
createdAt Time Timestamp of when the epic was created.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
group Group! Group to which the epic belongs.
hasChildren Boolean! Indicates if the epic has children.
hasChildrenWithinTimeframe Boolean! Indicates if the epic has children in the specified timeframe.
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 String! Internal ID of the epic.
issues EpicIssueConnection A list of issues associated with the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
labels LabelConnection Labels assigned to the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems LinkedWorkItemTypeConnection Work items linked to the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedWorkItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
parent Epic Parent epic of the epic.
participants UserCoreConnection List of participants for the epic. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
reference String! Internal reference of the epic. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Indicates if the reference should be returned in full.
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.
title String Title of the epic.
titleHtml String HTML 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.
workItemId WorkItemID! ID of the corresponding work item for a legacy epic.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
lists EpicListConnection Epic board lists. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for lists:
epicFilters (EpicFilters)
Filters applied when getting epic metadata in the epic board list.
id (BoardsEpicListID)
Find an epic board list by ID.
name String Name of the epic board.
webPath String! Web path of the epic board.
webUrl String! Web URL of the epic board.

EpicBoardConnection#

Paginated collection of EpicBoard. See Standard connection fields for the fields available on every connection.

EpicConnection#

Paginated collection of Epic. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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 GitLab 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 GitLab 16.6. Use OpenedIssuesTotal.
openedIssuesTotal BigInt Total weight of opened issues in the 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.

Implements: CurrentUserTodos, NoteableInterface, Todoable

Fields#

Name Type Description
alertManagementAlert AlertManagementAlert Deprecated in GitLab 15.6. Use alert_management_alerts.
alertManagementAlerts AlertManagementAlertConnection Alert Management alerts associated to this issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementAlerts:
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 the criteria.
statuses ([AlertManagementStatus!])
Alerts with the specified statues. For example, [TRIGGERED].
assignees UserCoreConnection Assignees of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
author UserCore! User that created the issue.
availableQuickActions [QuickActionCommand!] Quick actions available to the current user on the issue.
blocked Boolean! Indicates the issue is blocked.
blockedByCount Int Count of issues blocking the issue.
blockedByIssues IssueConnection Issues blocking the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingCount Int! Count of issues the issue is blocking.
closedAsDuplicateOf Issue Issue the issue was closed as a duplicate of.
closedAt Time Timestamp of when the issue was closed.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
customerRelationsContacts CustomerRelationsContactConnection Customer relations contacts of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String Description of the issue.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designCollection DesignCollection Collection of design images associated with the issue.
discussionLocked Boolean! Indicates discussion is locked on the issue.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
downvotes Int! Number of downvotes the issue has received.
dueDate Time Due date of the issue.
emailsDisabled Boolean! Deprecated in GitLab 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 Deprecated in GitLab 17.5. Replaced by WorkItem type.
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 as an experiment in GitLab 16.5.

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 String! Internal ID of the issue.
issuableResourceLinks IssuableResourceLinkConnection Issuable resource links of the incident issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issuableResourceLinks:
incidentId (IssueID!)
ID of the incident.
iteration Iteration Iteration of the issue.
labels LabelConnection Labels of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems LinkedWorkItemTypeConnection Introduced as an experiment in GitLab 17.8.

Work items linked to the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedWorkItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
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.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
participants UserCoreConnection List of participants in the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projectId Int ID of the issue project.
reference String! Internal reference of the issue. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Boolean option specifying whether the reference should be returned in full.
relatedMergeRequests MergeRequestConnection Merge requests related to the issue. This field can only be resolved for one issue in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
relatedVulnerabilities VulnerabilityConnection Related vulnerabilities of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
startDate Time Start date of the issue.
state IssueState! State of the issue.
status WorkItemStatus Introduced as an experiment in GitLab 18.0.

Status 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String! Title of the issue.
titleHtml String HTML 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.
workItemType WorkItemType! Type assigned to the issue.

EpicIssueConnection#

Paginated collection of EpicIssue. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
weight Int! Total weight of issues collection.

EpicList#

Represents an epic board list.

Fields#

Name Type Description
collapsed Boolean Indicates if the list is collapsed for the user.
epics EpicConnection List epics. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for epics:
filters (EpicFilters)
Filters applied when selecting epics in the board list.
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.

EpicListConnection#

Paginated collection of EpicList. See Standard connection fields for the fields available on every connection.

EpicListMetadata#

Represents epic board list metadata.

Fields#

Name Type Description
epicsCount Int Count of epics in the list.
totalWeight Int Introduced as an experiment in GitLab 14.7.

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.
adminEpicRelation Boolean! If true, the user can perform admin_epic_relation 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.

ErrorTrackingStackTrace#

Represents a stack trace.

Fields#

Name Type Description
absolutePath String Absolute path of the stack trace.
columnNumber Int Column number of the stack trace.
context [WorkItemWidgetErrorTrackingStackTraceContext!] Context of the stack trace.
filename String Filename of the stack trace.
function String Name of the function where the error occurred.
lineNumber Int Line number of the stack trace.

ErrorTrackingStackTraceConnection#

Paginated collection of ErrorTrackingStackTrace. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

EscalationPolicyTypeConnection#

Paginated collection of EscalationPolicyType. See Standard connection fields for the fields available on every connection.

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 the event.
createdAt Time! When the event was created.
id ID! ID of the event.
project Project Project of the event.
pushEventPayload PushEventPayload Payload of the push event, when the event represents a push. null for non-push events.
target EventTargetType Target of the event.
updatedAt Time! When the event was updated.

EventConnection#

Paginated collection of Event. See Standard connection fields for the fields available on every connection.

ExternalAuditEventDestination#

Represents an external resource to send audit events to.

Implements: ExternalAuditEventDestinationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

ExternalAuditEventDestinationConnection#

Paginated collection of ExternalAuditEventDestination. See Standard connection fields for the fields available on every connection.

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.
hmac Boolean! Whether or not HMAC secret is enabled for the status check.
id GlobalID! ID of the rule.
name String! Name of the rule.

ExternalStatusCheckConnection#

Paginated collection of ExternalStatusCheck. See Standard connection fields for the fields available on every connection.

FeatureFlag#

Fields#

Name Type Description
active Boolean! Whether the feature flag is active.
id OperationsFeatureFlagID! Global ID of the feature flag.
name String! Name of the feature flag.
path String! Path to feature flag.
reference String! Reference to feature flag.

FeatureFlagConnection#

Paginated collection of FeatureFlag. See Standard connection fields for the fields available on every connection.

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.

FindingDueDatesSetError#

Represents an error encountered while setting due dates for a vulnerability finding.

Fields#

Name Type Description
code String! Machine-readable error code.
findingUuid String UUID of the vulnerability finding associated with the error.
message String! Human-readable error message.

FindingReportsComparer#

Represents security reports comparison for vulnerability findings.

Fields#

Name Type Description
report ComparedSecurityReport Introduced as an experiment in GitLab 16.1.

Compared security report.
status FindingReportsComparerStatus Comparison status.
statusReason String Text explaining the status.

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.

FunctionalVerificationStatus#

Status of a GitLab Duo Agent Platform functional verification check.

Fields#

Name Type Description
message String Message describing the result of the latest failed run.
state FunctionalVerificationState! State of the verification run.
updatedAt Time Timestamp the latest run was last updated at.

GeoNode#

Fields#

Name Type Description
abuseReportUploadRegistries AbuseReportUploadRegistryConnection Introduced as an experiment in GitLab 18.10.

Find Abuse Report Upload registries on this Geo node. Ignored if geo_abuse_report_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for abuseReportUploadRegistries:
ids ([GeoAbuseReportUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
achievementUploadRegistries AchievementUploadRegistryConnection Introduced as an experiment in GitLab 18.11.

Find Achievement Upload registries on this Geo node. Ignored if geo_achievement_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for achievementUploadRegistries:
ids ([GeoAchievementUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
aiVectorizableFileUploadRegistries AiVectorizableFileUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find AI Vectorizable File Upload registries on this Geo node. Ignored if geo_ai_vectorizable_file_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiVectorizableFileUploadRegistries:
ids ([GeoAiVectorizableFileUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
alertManagementMetricImageUploadRegistries AlertManagementMetricImageUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Alert Management Metric Image Upload registries on this Geo node. Ignored if geo_alert_management_metric_image_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementMetricImageUploadRegistries:
ids ([GeoAlertManagementMetricImageUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
appearanceUploadRegistries AppearanceUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Appearance Upload registries on this Geo node. Ignored if geo_appearance_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for appearanceUploadRegistries:
ids ([GeoAppearanceUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
bulkImportExportUploadUploadRegistries BulkImportExportUploadUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find bulk import/export archive upload registries on this Geo node. Ignored if geo_bulk_import_export_upload_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for bulkImportExportUploadUploadRegistries:
ids ([GeoBulkImportExportUploadUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
checksumMismatchReportThreshold Int Number of consecutive checksum mismatches on a secondary before it reports the resource to the primary for self-heal re-verification.
checksumMismatchSelfHealCooldownMinutes Int Minimum time (in minutes) between self-heal re-verification triggers for the same resource on the primary.
ciSecureFileRegistries CiSecureFileRegistryConnection Find Ci Secure File registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ciSecureFileRegistries:
ids ([GeoCiSecureFileRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
containerRepositoriesMaxCapacity Int Maximum concurrency of container repository sync for the secondary node.
containerRepositoryRegistries ContainerRepositoryRegistryConnection Find Container Repository registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for containerRepositoryRegistries:
ids ([GeoContainerRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
dependencyListExportPartUploadRegistries DependencyListExportPartUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Dependency List Export Part Upload registries on this Geo node. Ignored if geo_dependency_list_export_part_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyListExportPartUploadRegistries:
ids ([GeoDependencyListExportPartUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
dependencyListExportUploadRegistries DependencyListExportUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Dependency List Export Upload registries on this Geo node. Ignored if geo_dependency_list_export_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyListExportUploadRegistries:
ids ([GeoDependencyListExportUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
dependencyProxyBlobRegistries DependencyProxyBlobRegistryConnection Introduced as an experiment in GitLab 15.6.

Find Dependency Proxy Blob registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyProxyBlobRegistries:
ids ([GeoDependencyProxyBlobRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
dependencyProxyManifestRegistries DependencyProxyManifestRegistryConnection Find Dependency Proxy Manifest registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyProxyManifestRegistries:
ids ([GeoDependencyProxyManifestRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
designManagementActionUploadRegistries DesignManagementActionUploadRegistryConnection Introduced as an experiment in GitLab 18.11.

Find Design Management Action Upload registries on this Geo node. Ignored if geo_design_management_action_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for designManagementActionUploadRegistries:
ids ([GeoDesignManagementActionUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
designManagementRepositoryRegistries DesignManagementRepositoryRegistryConnection Introduced as an experiment in GitLab 16.1.

Find Design Management Repository registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for designManagementRepositoryRegistries:
ids ([GeoDesignManagementRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
enabled Boolean Indicates whether the Geo node is enabled.
filesMaxCapacity Int Maximum concurrency of LFS/attachment backfill for the secondary node.
groupUploadRegistries GroupUploadRegistryConnection Introduced as an experiment in GitLab 18.11.

Find Group Upload registries on this Geo node. Ignored if geo_group_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groupUploadRegistries:
ids ([GeoGroupUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
groupWikiRepositoryRegistries GroupWikiRepositoryRegistryConnection Find group wiki repository registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groupWikiRepositoryRegistries:
ids ([GeoGroupWikiRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
id ID! ID of the GeoNode.
importExportUploadUploadRegistries ImportExportUploadUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find import/export archive upload registries on this Geo node. Ignored if geo_import_export_upload_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for importExportUploadUploadRegistries:
ids ([GeoImportExportUploadUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
internalUrl String URL defined on the primary node secondary nodes should use to contact it.
issuableMetricImageUploadRegistries IssuableMetricImageUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Issuable Metric Image Upload registries on this Geo node. Ignored if geo_issuable_metric_image_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issuableMetricImageUploadRegistries:
ids ([GeoIssuableMetricImageUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
jobArtifactRegistries JobArtifactRegistryConnection Find Job Artifact registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobArtifactRegistries:
ids ([GeoJobArtifactRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
lfsObjectRegistries LfsObjectRegistryConnection Find LFS object registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for lfsObjectRegistries:
ids ([GeoLfsObjectRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
mergeRequestDiffRegistries MergeRequestDiffRegistryConnection Find merge request diff registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequestDiffRegistries:
ids ([GeoMergeRequestDiffRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
minimumReverificationInterval Int Interval (in days) in which the repository verification is valid. After expiry, it is reverted.
name String Unique identifier for the Geo node.
organizationDetailUploadRegistries OrganizationDetailUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Organization Detail Upload registries on this Geo node. Ignored if geo_organization_detail_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizationDetailUploadRegistries:
ids ([GeoOrganizationDetailUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
packageFileRegistries PackageFileRegistryConnection Package file registries of the GeoNode. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packageFileRegistries:
ids ([GeoPackageFileRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
packagesDebianProjectComponentFileRegistries PackagesDebianProjectComponentFileRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Debian Project Component File registries on this Geo node. Ignored if geo_packages_debian_project_component_file_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packagesDebianProjectComponentFileRegistries:
ids ([GeoPackagesDebianProjectComponentFileRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
packagesHelmMetadataCacheRegistries PackagesHelmMetadataCacheRegistryConnection Find Helm Metadata Cache registries on this Geo node. Ignored if geo_packages_helm_metadata_cache_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packagesHelmMetadataCacheRegistries:
ids ([GeoPackagesHelmMetadataCacheRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
packagesNugetSymbolRegistries PackagesNugetSymbolRegistryConnection Find Packages::Nuget::Symbols registries on this Geo node. Ignored if geo_packages_nuget_symbol_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packagesNugetSymbolRegistries:
ids ([GeoPackagesNugetSymbolRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
pagesDeploymentRegistries PagesDeploymentRegistryConnection Find Pages Deployment registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pagesDeploymentRegistries:
ids ([GeoPagesDeploymentRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
personalSnippetUploadRegistries PersonalSnippetUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Personal Snippet Upload registries on this Geo node. Ignored if geo_personal_snippet_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalSnippetUploadRegistries:
ids ([GeoPersonalSnippetUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
pipelineArtifactRegistries PipelineArtifactRegistryConnection Find pipeline artifact registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineArtifactRegistries:
ids ([GeoPipelineArtifactRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
primary Boolean Indicates whether the Geo node is the primary.
projectImportExportRelationExportUploadUploadRegistries ProjectImportExportRelationExportUploadUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find Relation Export File Upload registries on this Geo node. Ignored if geo_project_import_export_relation_export_upload_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectImportExportRelationExportUploadUploadRegistries:
ids ([GeoProjectImportExportRelationExportUploadUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
projectRepositoryRegistries ProjectRepositoryRegistryConnection Find Project registries on this Geo node. Ignored if geo_project_repository_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectRepositoryRegistries:
ids ([GeoProjectRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
projectTopicUploadRegistries ProjectTopicUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Project Topic Upload registries on this Geo node. Ignored if geo_project_topic_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectTopicUploadRegistries:
ids ([GeoProjectTopicUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
projectUploadRegistries ProjectUploadRegistryConnection Introduced as an experiment in GitLab 18.10.

Find Project Upload registries on this Geo node. Ignored if geo_project_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectUploadRegistries:
ids ([GeoProjectUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
projectWikiRepositoryRegistries ProjectWikiRepositoryRegistryConnection Find Project Wiki Repository registries on this Geo node. Ignored if geo_project_wiki_repository_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectWikiRepositoryRegistries:
ids ([GeoProjectWikiRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
reposMaxCapacity Int Maximum concurrency of repository backfill for the secondary node.
selectiveSyncNamespaces NamespaceConnection Namespaces that should be synced, if selective_sync_type == namespaces. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
snippetRepositoryRegistries SnippetRepositoryRegistryConnection Find snippet repository registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippetRepositoryRegistries:
ids ([GeoSnippetRepositoryRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
syncObjectStorage Boolean Indicates if the secondary node will replicate blobs in Object Storage.
terraformStateVersionRegistries TerraformStateVersionRegistryConnection Find terraform state version registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for terraformStateVersionRegistries:
ids ([GeoTerraformStateVersionRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
uploadRegistries UploadRegistryConnection Find Upload registries on this Geo node. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for uploadRegistries:
ids ([GeoUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
url String User-facing URL for the Geo node.
userPermissionExportUploadUploadRegistries UserPermissionExportUploadUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find User Permission Export File Upload registries on this Geo node. Ignored if geo_user_permission_export_upload_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userPermissionExportUploadUploadRegistries:
ids ([GeoUserPermissionExportUploadUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
userUploadRegistries UserUploadRegistryConnection Introduced as an experiment in GitLab 18.11.

Find User Upload registries on this Geo node. Ignored if geo_user_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userUploadRegistries:
ids ([GeoUserUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
verificationMaxCapacity Int Maximum concurrency of repository verification for the secondary node.
vulnerabilityArchiveExportUploadRegistries VulnerabilityArchiveExportUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find Vulnerability Archive Export Upload registries on this Geo node. Ignored if geo_vulnerability_archive_export_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityArchiveExportUploadRegistries:
ids ([GeoVulnerabilityArchiveExportUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
vulnerabilityExportPartUploadRegistries VulnerabilityExportPartUploadRegistryConnection Introduced as an experiment in GitLab 19.1.

Find Vulnerability Export Part Upload registries on this Geo node. Ignored if geo_vulnerability_export_part_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityExportPartUploadRegistries:
ids ([GeoVulnerabilityExportPartUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
vulnerabilityExportUploadRegistries VulnerabilityExportUploadRegistryConnection Introduced as an experiment in GitLab 19.0.

Find Vulnerability Export Upload registries on this Geo node. Ignored if geo_vulnerability_export_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityExportUploadRegistries:
ids ([GeoVulnerabilityExportUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.
vulnerabilityRemediationUploadRegistries VulnerabilityRemediationUploadRegistryConnection Introduced as an experiment in GitLab 19.2.

Find Vulnerability Remediation Upload registries on this Geo node. Ignored if geo_vulnerability_remediation_upload_replication feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityRemediationUploadRegistries:
ids ([GeoVulnerabilityRemediationUploadRegistryID!])
Filters registries by their ID.
keyword (String)
Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState (ReplicationStateEnum)
Filters registries by their replication state.
sort (GeoRegistrySort)
Sort registries by given criteria.
verificationState (VerificationStateEnum)
Filters registries by their verification state.

GitlabInstanceFeatureFlag#

A feature flag for the GitLab instance.

Fields#

Name Type Description
enabled Boolean! Indicates whether the GitLab instance feature flag is enabled or not.
name String! Name of the GitLab instance feature flag.

GitlabSubscriptionBudgetCapUserOverride#

Per-user budget cap override.

Fields#

Name Type Description
cap Float! Budget cap amount for the user.
capEnabled Boolean! Whether the budget cap is enabled for the user.
createdAt Time When the override was created.
updatedAt Time When the override was last updated.
user UserCore GitLab user the override applies to.

GitlabSubscriptionBudgetCapUserOverrideConnection#

Paginated collection of GitlabSubscriptionBudgetCapUserOverride. See Standard connection fields for the fields available on every connection.

GitlabSubscriptionBudgetCaps#

Budget cap controls for a subscription.

Fields#

Name Type Description
flatUserCap Float Default per-user budget cap applied to all users.
flatUserCapEnabled Boolean Whether the flat per-user budget cap is enabled.
subscriptionCap Float Maximum budget cap for the subscription.
subscriptionCapEnabled Boolean Whether the subscription-level budget cap is enabled.
userOverrides GitlabSubscriptionBudgetCapUserOverrideConnection Per-user budget cap overrides. CDot returns a maximum of 20 overrides per page. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userOverrides:
userIds ([UserID!])
Filter overrides to specific users.

GitlabSubscriptionDailyUsage#

Describes daily the usage of GitLab Credits.

Fields#

Name Type Description
creditsUsed Float! GitLab Credits consumed on the date.
date ISO8601Date! Date when credits were used.

GitlabSubscriptionHistory#

Describes the subscription history of a given namespace.

Fields#

Name Type Description
changeType SubscriptionHistoryChangeType Indicates what type of change in the subscription has happened.
createdAt Time Timestamp of the subscription history entry creation.
endDate Time Subscription end date.
maxSeatsUsed Int Maximum seats used in subscription.
seats Int Seats purchased in subscription.
seatsInUse Int Seats being used in subscription.
startDate Time Subscription start date.

GitlabSubscriptionHistoryConnection#

Paginated collection of GitlabSubscriptionHistory. See Standard connection fields for the fields available on every connection.

GitlabSubscriptionMonthlyCommitment#

Describes the usage of GitLab Credits for the subscription's monthly commitment.

Fields#

Name Type Description
creditsUsed Float Total of GitLab Credits consumed from the subscription's monthly commitment.
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily usage of the subscription's monthly commitment.
totalCredits Float Total of GitLab Credits allocated as a subscription's monthly commitment.

GitlabSubscriptionMonthlyWaiver#

GitLab Credits used from the Monthly Waiver allocation.

Fields#

Name Type Description
creditsUsed Float GitLab Credits used from the Monthly Waiver allocation.
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily usage of the Monthly Waiver allocation.
totalCredits Float Total of GitLab Credits allocated as Monthly Waiver.

GitlabSubscriptionOverage#

Describes the overage of consumables for the subscription.

Fields#

Name Type Description
creditsUsed Float Overage consumed by the subscription.
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily overage usage.
isAllowed Boolean Whether GitLab Credits overage is allowed for the subscription.

GitlabSubscriptionPaidTierTrial#

Describes paid tier trial information for the subscription.

Fields#

Name Type Description
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily usage of the subscription's paid tier trial.
isActive Boolean! Indicates whether the subscription is currently in a paid tier trial for GitLab Credits.

GitlabSubscriptionUsage#

Describes the usage of consumables under the subscription.

Fields#

Name Type Description
budgetCaps GitlabSubscriptionBudgetCaps Budget cap controls for the subscription.
canAcceptOverageTerms Boolean! Indicates whether the subscription is currently eligible to accept overage terms.
creditsUsed Float Total credits used for the subscription.
dailyAverage Float Average daily credits used for the subscription.
dailyUsage [GitlabSubscriptionDailyUsage!] Daily usage for the subscription.

Arguments for dailyUsage:
limit (Int)
Maximum number of daily usage entries to return. Defaults to every day in the date range.
sort (DailyUsageSort)
Sort daily usage entries by the selected criteria.
dapPromoEnabled Boolean! Indicates whether the Duo AI promo (DAP) is enabled for the subscription.
enabled Boolean! Indicates if the Customer Portal GitLab Credits API is enabled.
endDate ISO8601Date End date of the period covered by the usage data.
isOutdatedClient Boolean Indicates if the GitLab instance has an outdated API contract with the Customer Portal.
lastEventTransactionAt ISO8601DateTime Date and time when the last usage event resulted in a wallet transaction.
monthlyCommitment GitlabSubscriptionMonthlyCommitment Monthly commitment usage for the subscription.
monthlyWaiver GitlabSubscriptionMonthlyWaiver Monthly waiver usage for the subscription.
nonBillableUsage [GitlabSubscriptionUsageNonBillableUsage!] GitLab Credits usage that was not billed, grouped by product and skip reason. Not included in creditsUsed or dailyUsage. Null when the usage cannot be read.
overage GitlabSubscriptionOverage Overage statistics.
overageTermsAccepted Boolean! Indicates whether overage terms have been accepted for the subscription.
paidTierTrial GitlabSubscriptionPaidTierTrial! Paid tier trial data for the subscription.
products [GitlabSubscriptionUsageProduct!] All supported products with their associated flow types.
purchaseCreditsPath String URL to purchase GitLab Credits.
startDate ISO8601Date Start date of the period covered by the usage data.
subscriptionPortalUsageDashboardUrl String Full URL to the GitLab Credits usage dashboard in the Customer Portal.
usersUsage GitlabSubscriptionUsageUsersUsage Consumption usage for users under the subscription.

GitlabSubscriptionUsageBlockedStatus#

Describes the blocked status of a user under the subscription budget cap.

Fields#

Name Type Description
blocked Boolean! Whether the user is blocked from using credits due to reaching their cap.
capType GitlabSubscriptionUsageBlockedCapType Type of cap that caused the block. Null when not blocked.

GitlabSubscriptionUsageFlowTypeInfo#

Information about a GitLab Credits flow type.

Fields#

Name Type Description
id String! Identifier for the flow type, used for filtering.
title String! Display name for the flow type.

GitlabSubscriptionUsageNonBillableUsage#

GitLab Credits usage that was not billed, for one product and skip reason.

Fields#

Name Type Description
dailyUsage [GitlabSubscriptionDailyUsage!]! Daily non-billable GitLab Credits for the product and skip reason.
productId String! Identifier of the product the usage belongs to. Matches GitlabSubscriptionUsageProduct.id.
skipReason String Reason the usage was not billed, as recorded on the usage event. Null when the event has no recorded reason.
totalCreditsUsed Float! Total non-billable GitLab Credits for the product and skip reason in the date range.

GitlabSubscriptionUsageProduct#

A product with GitLab Credits usage.

Fields#

Name Type Description
creditsUsed Float Total GitLab Credits consumed for the product.
flowTypes [GitlabSubscriptionUsageProductFlowType!]! Flow types belonging to the product.
id String! Identifier for the product.
title String! Display name for the product.

GitlabSubscriptionUsageProductFlowType#

A flow type within a product for GitLab Credits usage.

Fields#

Name Type Description
id String! Identifier for the flow type.
title String! Display name for the flow type.

GitlabSubscriptionUsageUser#

Describes the user with their usage data.

Fields#

Name Type Description
avatarUrl String URL of the user's avatar.
blockedStatus GitlabSubscriptionUsageBlockedStatus Blocked status of the user under the subscription budget cap.
entityType String Type of consumer for the user usage.
events GitlabSubscriptionUsageUserEventConnection Billable events from the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
flowTypes ([String])
Filter events by one or more flow type IDs.
id UserID! Global ID of the user.
name String! Human-readable name of the user.
usage GitlabSubscriptionUsageUserUsage Usage of consumables for a user under the subscription.
usedFlowTypes [GitlabSubscriptionUsageFlowTypeInfo!] Flow types used by the user during the billing period.
username String! Username of the user. Unique within the instance of GitLab.

GitlabSubscriptionUsageUserConnection#

Paginated collection of GitlabSubscriptionUsageUser. See Standard connection fields for the fields available on every connection.

GitlabSubscriptionUsageUserEvent#

Describes a usage event for the subscription.

Fields#

Name Type Description
creditsUsed Float GitLab Credits consumed on the date.
eventType String Event type.
flowType String User-friendly display name for the event flow type.
location GitlabSubscriptionUsageEventLocation Event location: project or namespace.
locationId GlobalID Global ID of the event location. Populated even when the referenced record is deleted or not visible to the user, unlike location. When both fields are present, they identify the same record.
sessionLink String URL of the agent session associated with the event.
timestamp ISO8601DateTime Date and time of the event.

GitlabSubscriptionUsageUserEventConnection#

Paginated collection of GitlabSubscriptionUsageUserEvent. See Standard connection fields for the fields available on every connection.

GitlabSubscriptionUsageUserUsage#

Describes the usage of consumables for a user under the subscription.

Fields#

Name Type Description
creditsUsed Float GitLab Credits used by the user.
monthlyCommitmentCreditsUsed Float Monthly Commitment GitLab Credits used by the user.
monthlyWaiverCreditsUsed Float Monthly Waiver GitLab Credits used by the user.
overageCreditsUsed Float Overage GitLab Credits used by the user.
paidTierTrialCreditsUsed Float Paid Tier Trial GitLab Credits used by the user.
totalCredits Float Total GitLab Credits available for the user.
totalCreditsUsed Float Total GitLab Credits used by the user across all wallets.

GitlabSubscriptionUsageUsersUsage#

Describes the usage of consumables by users under the subscription.

Fields#

Name Type Description
creditsUsed Float GitLab Credits used by consumers of the subscription.
dailyUsage [GitlabSubscriptionDailyUsage!] Array of daily usage of GitLab Credits.
totalActiveUsers Int Total number of users with usage in the subscription.
totalUsersUsingCredits Int Total number of users consuming GitLab Credits from their included allocation.
totalUsersUsingMonthlyCommitment Int Total number of users consuming GitLab Credits from the subscription monthly commitment.
totalUsersUsingOverage Int Total number of users consuming overage.
users GitlabSubscriptionUsageUserConnection List of users with their usage data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for users:
searchQuery (String)
Filter users with a matching name, username, or email. Ignored when username is provided or when sorting by total credits used.
sort (GitlabSubscriptionUsageUserSort)
Sort users by the criteria.
username (String)
Username of the User.

GitlabSubscriptionUserCreditsUsage#

GitLab Credits usage for the current user.

Fields#

Name Type Description
blockedStatus GitlabSubscriptionUsageBlockedStatus Blocked status of the current user under the subscription budget cap.
creditsUsed Float Total GitLab Credits consumed by the current user.
dailyUsage [GitlabSubscriptionUserCreditsUsageDailyUsage!] Daily GitLab Credits usage for the current user.
enabled Boolean! Indicates if the Customer Portal GitLab Credits API is enabled.
endDate ISO8601Date End date of the period covered by the usage data.
isOutdatedClient Boolean Indicates if the GitLab instance has an outdated API contract with the Customer Portal.
products [GitlabSubscriptionUserCreditsUsageProduct!] All supported products with their associated flow types.
startDate ISO8601Date Start date of the period covered by the usage data.
usedFlowTypes [GitlabSubscriptionUsageFlowTypeInfo!] Flow types the current user consumed credits under during the period.

GitlabSubscriptionUserCreditsUsageDailyUsage#

Daily GitLab Credits usage for the current user.

Fields#

Name Type Description
creditsUsed Float! GitLab Credits consumed by the current user on the date.
date ISO8601Date! Date when credits were used.

GitlabSubscriptionUserCreditsUsageProduct#

A product with its flow types.

Fields#

Name Type Description
flowTypes [GitlabSubscriptionUsageFlowTypeInfo!]! Flow types belonging to the product.
id String! Identifier for the product.
title String! Display name for the product.

GitlabTrialUsage#

Describes the usage and details of a trial subscription.

Fields#

Name Type Description
activeTrial ActiveTrial Active trial information if the subscription has an active trial.
usersUsage TrialUsage Trial usage statistics for users.

GitlabTrialUsageUser#

Describes the user with their trial usage data.

Fields#

Name Type Description
avatarUrl String URL of the user's avatar.
id UserID! Global ID of the user.
name String! Human-readable name of the user.
usage GitlabTrialUsageUserUsage Credit usage for a user during a trial.
username String! Username of the user. Unique within the instance of GitLab.

GitlabTrialUsageUserConnection#

Paginated collection of GitlabTrialUsageUser. See Standard connection fields for the fields available on every connection.

GitlabTrialUsageUserUsage#

Describes any credit usage for a user during a trial.

Fields#

Name Type Description
creditsUsed Float GitLab Credits consumed by the user during a trial.
totalCredits Float Total GitLab Credits available to the user during a trial.

GoogleCloudArtifactRegistryArtifactConnection#

Paginated collection of GoogleCloudArtifactRegistryArtifact. See Standard connection fields for the fields available on every connection.

GoogleCloudArtifactRegistryDockerImage#

Represents a docker artifact of Google Artifact Registry.

Fields#

Name Type Description
digest String! Image's digest.
image String! Image's name.
name String! Unique image name.
tags [String!] Tags attached to the image.
updateTime Time Time when the image was last updated.
uploadTime Time Time when the image was uploaded.
uri String! Google Cloud URI to access the image.

GoogleCloudArtifactRegistryDockerImageDetails#

Represents details about docker artifact of Google Artifact Registry.

Fields#

Name Type Description
artifactRegistryImageUrl String! Google Cloud URL to access the image.
buildTime Time Time when the image was built.
digest String! Image's digest.
image String! Image's name.
imageSizeBytes String Calculated size of the image.
location String! Location of the Artifact Registry repository.
mediaType String Media type of the image.
name String! Unique image name.
projectId String! ID of the Google Cloud project.
repository String! Repository on the Google Artifact Registry.
tags [String!] Tags attached to the image.
updateTime Time Time when the image was last updated.
uploadTime Time Time when the image was uploaded.
uri String! Google Cloud URI to access the image.

GoogleCloudArtifactRegistryRepository#

Represents a repository of Google Artifact Registry.

Fields#

Name Type Description
artifactRegistryRepositoryUrl String! Google Cloud URL to access the repository.
artifacts GoogleCloudArtifactRegistryArtifactConnection Google Artifact Registry repository artifacts. Returns null if GitLab.com feature is unavailable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for artifacts:
sort (GoogleCloudArtifactRegistryArtifactsSort)
Criteria to sort artifacts by.
projectId String! ID of the Google Cloud project.
repository String! Repository on the Google Artifact Registry.

GoogleCloudLoggingConfigurationType#

Stores Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Implements: GoogleCloudLoggingConfigurationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
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.

GoogleCloudLoggingConfigurationTypeConnection#

Paginated collection of GoogleCloudLoggingConfigurationType. See Standard connection fields for the fields available on every connection.

GovernPolicy#

Policy stored in the policy store.

Fields#

Name Type Description
actions [JSON!] Introduced as an experiment in GitLab 19.4.

Actions of the policy.
createdAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of when the policy was created.
description String Introduced as an experiment in GitLab 19.4.

Description of the policy.
id Int! Introduced as an experiment in GitLab 19.4.

ID of the policy.
lifecycleState String Introduced as an experiment in GitLab 19.4.

Lifecycle state of the policy.
mode String Introduced as an experiment in GitLab 19.4.

Enforcement mode of the policy.
name String! Introduced as an experiment in GitLab 19.4.

Name of the policy.
namespaceId Int Introduced as an experiment in GitLab 19.4.

ID of the namespace the policy is scoped to. Null for organization-wide policies.
organizationId Int! Introduced as an experiment in GitLab 19.4.

ID of the organization the policy belongs to.
policyRego String Introduced as an experiment in GitLab 19.4.

Rego program merged from the compiled rules. Null when the rules cannot be merged.
policyScope JSON Introduced as an experiment in GitLab 19.4.

Scope of the policy.
rules [JSON!] Introduced as an experiment in GitLab 19.4.

Rules of the policy.
scopeDimensions [String!] Introduced as an experiment in GitLab 19.4.

Dotted context paths scopeRego reads to decide whether the policy applies. Null when scopeRego was authored directly instead of compiled from policyScope.
scopeRego String Introduced as an experiment in GitLab 19.4.

Rego expression scoping the policy. Mutually exclusive with policyScope.
triggerType String! Introduced as an experiment in GitLab 19.4.

Trigger the policy responds to.
updatedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp of when the policy was last updated.
version Int Introduced as an experiment in GitLab 19.4.

Version of the policy.

GovernPolicyConnection#

Paginated collection of GovernPolicy. See Standard connection fields for the fields available on every connection.

GovernPolicyEvaluation#

Recorded evaluation of a policy stored in the policy store.

Fields#

Name Type Description
environmentId Int Introduced as an experiment in GitLab 19.4.

ID of the environment the evaluation ran for. Null when the evaluation was not scoped to an environment.
evaluatedAt Time! Introduced as an experiment in GitLab 19.4.

Timestamp of when the policy was evaluated.
id GovernPolicyEvaluationID! Introduced as an experiment in GitLab 19.4.

Global ID of the evaluation.
mode GovernPolicyEvaluationMode! Introduced as an experiment in GitLab 19.4.

Enforcement mode of the policy at the time of the evaluation.
policyId Int! Introduced as an experiment in GitLab 19.4.

ID of the policy that was evaluated.
policyVersion Int! Introduced as an experiment in GitLab 19.4.

Version of the policy at the time of the evaluation.
projectId Int Introduced as an experiment in GitLab 19.4.

ID of the project the evaluation ran for. Null when the evaluation was not scoped to a project.
triggerType GovernPolicyEvaluationTriggerType! Introduced as an experiment in GitLab 19.4.

Trigger that started the evaluation.
userId Int Introduced as an experiment in GitLab 19.4.

ID of the user whose operation triggered the evaluation. Null when the evaluation was not triggered by a user.
verdict GovernPolicyEvaluationVerdict! Introduced as an experiment in GitLab 19.4.

Verdict the evaluation produced.
violations [GovernPolicyViolation!] Introduced as an experiment in GitLab 19.4.

Violations the evaluation produced.

GovernPolicyEvaluationConnection#

Paginated collection of GovernPolicyEvaluation. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

GovernPolicyViolation#

Violation a policy evaluation produced.

Fields#

Name Type Description
createdAt Time! Introduced as an experiment in GitLab 19.4.

Timestamp of when the violation was recorded.
details JSON Introduced as an experiment in GitLab 19.4.

Details of the violation.
id GovernPolicyViolationID! Introduced as an experiment in GitLab 19.4.

Global ID of the violation.

GpgSignature#

GPG signature for a signed commit.

Implements: CommitSignature

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#

Implements: GroupInterface, Todoable

Fields#

Name Type Description
achievements AchievementConnection Achievements for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for achievements:
ids ([AchievementsAchievementID!])
Filter achievements by IDs.
achievementsPath String Path for the namespace's achievements. Returns null if the namespace is not a group.
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.
addOnEligibleUsers AddOnUserConnection Introduced as an experiment in GitLab 16.5.

Users in the namespace hierarchy that add-ons are applicable for. This only applies to root namespaces. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for addOnEligibleUsers:
addOnPurchaseIds ([GitlabSubscriptionsAddOnPurchaseID!]!)
Global IDs of the add on purchases to find assignments for.
addOnType (GitlabSubscriptionsAddOnType!)
Type of add on to filter the eligible users by.
filterByAssignedSeat (String)
Filter users list by assigned seat.
search (String)
Search the user list.
sort (GitlabSubscriptionsUserSort)
Sort the user list.
additionalPurchasedStorageSize Float Additional storage purchased for the root namespace in bytes.
adminEditPath String Admin path for editing group. Only available to admins.
adminShowPath String Admin path of the group. Only available to admins.
aiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events are stored for the group.
aiDomainSettings StringConnection Introduced as an experiment in GitLab 19.0.

List of allowed or denied domains for AI features. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiDomainSettings:
domainSettingType (AiDomainSettingType!)
Type of domain setting to retrieve.
search (String)
Filter domains by substring match.
aiGovernanceMetrics AiGovernanceMetrics Introduced as an experiment in GitLab 19.3.

Aggregated AI governance dashboard metrics. Returns null when the ai_governance_dashboard feature flag is disabled.

Arguments for aiGovernanceMetrics:
agentClass (AiGovernanceAgentClass)
Agent class to segment the metrics by. Defaults to ALL.
timeframe (AiGovernanceMetricsTimeframe)
Time window for the metrics. Defaults to LAST_7_DAYS.
aiGovernanceSessions AiGovernanceSessionConnection Introduced as an experiment in GitLab 19.5.

AI sessions for the group, from GitLab Duo and external agents. Returns no sessions when the ai_governance_sessions_api feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiGovernanceSessions:
agentClass (AiGovernanceAgentClass)
Filter sessions by agent class. Defaults to all agent classes.
flowType (String)
Filter by flow type.
id (AiGovernanceSessionID)
Global ID of the session.
not (AiGovernanceSessionNegatedFilterInput)
Negated filter conditions.
projectPath (String)
Filter by project full path.
sessionStartedAfter (Time)
Return sessions started at or after the timestamp.
sessionStartedBefore (Time)
Return sessions started at or before the timestamp.
triggeredByUserId (UserID)
Filter to sessions triggered by the user with the given global ID.
aiGovernanceToolCalls AiGovernanceToolCallsReport Introduced as an experiment in GitLab 19.5.

Top tools invoked by AI agents, with invocation counts. Returns null when the ai_governance_dashboard or ai_governance_tool_calls feature flag is disabled or when ClickHouse is not enabled.

Arguments for aiGovernanceToolCalls:
agentClass (AiGovernanceAgentClass)
Agent class to segment the tool calls by. Defaults to ALL.
timeframe (AiGovernanceMetricsTimeframe)
Time window for the tool calls. Defaults to LAST_7_DAYS.
aiMetrics AiMetrics Introduced as an experiment in GitLab 16.11.

AI-related metrics.

Arguments for aiMetrics:
endDate (Date)
Date range to end at. Default is the end of current month.
startDate (Date)
Date range to start from. Default is the beginning of current month.
aiSettings AiNamespaceSettings Introduced as an experiment in GitLab 18.8.

AI settings for the namespace.
aiUsageData AiUsageData Introduced as an experiment in GitLab 17.5.

AI-related data.
aiUserMetrics AiUserMetricsConnection Introduced as an experiment in GitLab 17.5.

AI-related user metrics. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiUserMetrics:
endDate (Date)
Date range to end at. Default is the end of current month. ClickHouse needs to be enabled when passing this param.
sort (AiUserMetricsSort)
Sort AI user metrics.
startDate (Date)
Date range to start from. Default is the beginning of current month. ClickHouse needs to be enabled when passing this param.
allowStaleRunnerPruning Boolean! Indicates whether to regularly prune stale group runners. Defaults to false.
amazonS3Configurations AmazonS3ConfigurationTypeConnection Deprecated in GitLab 18.10. Use externalAuditEventStreamingDestinations with amazonS3 category instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
analytics Analytics Introduced as an experiment in GitLab 18.11.

Group analytics aggregation endpoints.
analyzerStatuses [AnalyzerGroupStatusType!] Status for all analyzers in the group.
approvalPolicies ApprovalPolicyConnection Approval Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for approvalPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
archived Boolean Indicates if the group or any ancestor is archived.
autoDevopsEnabled Boolean Indicates whether Auto DevOps is enabled for all projects within the group.
autocompleteUsers [AutocompletedUser!] Search users for autocompletion.

Arguments for autocompleteUsers:
search (String)
Query to search users by name, username, or public email.
availableFeatures NamespaceAvailableFeatures! Introduced as an experiment in GitLab 18.3.

Features available on the namespace.
availableSecurityScanProfiles [ScanProfileType!] Introduced as an experiment in GitLab 18.8.

Security scan profiles available for the group.

Arguments for availableSecurityScanProfiles:
gitlabRecommended (Boolean)
Filter scan profiles by GitLab Recommended.
type (SecurityScanProfileType)
Filter scan profiles by type.
avatarUrl String Avatar URL of the group.
billableMembersCount Int Number of billable users in the group.

Arguments for billableMembersCount:
requestedHostedPlan (String)
Plan from which to get billable members.
board Board A single board of the group.

Arguments for board:
id (BoardID!)
ID of the board.
boards BoardConnection Boards of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for boards:
id (BoardID)
Find a board by its ID.
builtInProjectTemplatesEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates whether built-in project templates are available for new projects in the group.
canPushInitialCommit Boolean! Introduced as an experiment in GitLab 18.11.

Whether the current user can push the initial commit to the default branch of new projects in the namespace.
ciCdSettings CiCdSettings Introduced as an experiment in GitLab 17.9.

Namespace CI/CD settings for the namespace.
ciQueueingHistory QueueingDelayHistory Time taken for CI jobs to be picked up by this group's runners by percentile. Available to users with Maintainer role for the group. Enable the ClickHouse database backend to use this query.

Arguments for ciQueueingHistory:
fromTime (Time)
Start of the requested time. Defaults to three hours ago.
toTime (Time)
End of the requested time. Defaults to the current time.
ciVariables CiGroupVariableConnection List of the group's CI/CD variables. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ciVariables:
sort (CiVariableSort)
Sort order of results.
clusterAgents ClusterAgentConnection Cluster agents associated with projects in the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for clusterAgents:
hasRemoteDevelopmentAgentConfig (Boolean)
Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled (Boolean)
Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities (Boolean)
Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig (Boolean)
Returns only cluster agents which have an associated workspaces agent config.
codeCoverageActivities CodeCoverageActivityConnection Represents the code coverage activity for this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for codeCoverageActivities:
startDate (Date!)
First day for which to fetch code coverage activity (maximum time window is set to 90 days).
complianceFrameworkCoverageSummary ComplianceFrameworkCoverageSummary Introduced as an experiment in GitLab 18.1.

Summary of compliance framework coverage in a group and its subgroups.
complianceFrameworks ComplianceFrameworkConnection Compliance frameworks available to projects in this namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceFrameworks:
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.
sort (ComplianceFrameworkSort)
Sort compliance frameworks by the criteria.
complianceFrameworksCoverageDetails ComplianceFrameworkCoverageDetailConnection Introduced as an experiment in GitLab 18.1.

Detailed compliance framework coverage for each framework in the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
complianceFrameworksNeedingAttention ComplianceFrameworksNeedingAttentionConnection Introduced as an experiment in GitLab 18.2.

Frameworks missing either project assignments or requirements definitions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
complianceRequirementControlCoverage RequirementControlCoverage Introduced as an experiment in GitLab 18.1.

Compliance control status summary showing count of passed, failed, and pending controls.
complianceRequirementCoverage RequirementCoverage Introduced as an experiment in GitLab 18.2.

Compliance requirement coverage statistics for the group.
componentVersions ComponentVersionConnection! Introduced as an experiment in GitLab 18.0.

Find software dependency versions by component name. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for componentVersions:
componentName (String!)
Name of the SBoM component.
components [Component!] Introduced as an experiment in GitLab 17.5.

Find software dependencies by name.

Arguments for components:
name (String)
Entire name or part of the name.
contactStateCounts ContactStateCounts Counts of contacts by state for the group.

Arguments for contactStateCounts:
search (String)
Search term to find contacts with.
state (CustomerRelationsContactState)
State of the contacts to search for.
contacts CustomerRelationsContactConnection Find contacts of this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contacts:
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.
containerRepositories ContainerRepositoryConnection Container repositories of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for containerRepositories:
name (String)
Filter the container repositories by their name.
sort (ContainerRepositorySort)
Sort container repositories by the criteria.
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.
contributions ContributionAnalyticsContributionConnection Provides the aggregated contributions by users within the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributions:
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.
createdAt Time Timestamp of the group creation.
crossProjectPipelineAvailable Boolean! Indicates if the cross_project_pipeline feature is available for the namespace.
customAttributes [CustomAttribute!] Custom attributes of the group. Only available to admins.
customEmoji CustomEmojiConnection Custom emoji in this namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customEmoji:
includeAncestorGroups (Boolean)
Includes custom emoji from parent groups.
customField CustomField Introduced as an experiment in GitLab 17.6.

A custom field configured for the group.

Arguments for customField:
id (IssuablesCustomFieldID!)
Global ID of the custom field.
customFields CustomFieldConnection Introduced as an experiment in GitLab 17.5.

Custom fields configured for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customFields:
active (Boolean)
Filter for active fields. If false, excludes active fields. If true, returns only active fields.
fieldType (CustomFieldType)
Filter for selected field type.
search (String)
Search query for custom field name.
workItemTypeId (WorkItemsTypeID)
Filter custom fields associated to the given work item type.
customizableDashboardVisualizations CustomizableDashboardVisualizationConnection Visualizations of the group or associated configuration project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customizableDashboardVisualizations:
slug (String)
Slug of the visualization to return.
customizableDashboards CustomizableDashboardConnection Customizable dashboards for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customizableDashboards:
category (CustomizableDashboardCategory)
Find by dashboard type.
slug (String)
Find by dashboard slug.
dataTransfer GroupDataTransfer Data transfer data point for a specific period. This is mocked data under a development feature flag.

Arguments for dataTransfer:
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.
dependencies DependencyConnection Software dependencies used by projects under this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencies:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
dependencyAggregations DependencyAggregationConnection Introduced as an experiment in GitLab 18.0.

Software dependencies used by projects under this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyAggregations:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
projectCountMax (Int)
Filter dependencies by maximum project count.
projectCountMin (Int)
Filter dependencies by minimum project count.
projectIds ([ProjectID!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by projects within the group.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
dependencyFirewallActivitySummary DependencyFirewallActivitySummary Introduced as an experiment in GitLab 19.3.

Aggregate dependency firewall activity totals for the group. Available behind the dependency_firewall_phase1 feature flag.

Arguments for dependencyFirewallActivitySummary:
from (Date)
Start date (inclusive) of the activity window. Defaults to 7 days ago.
to (Date)
End date (inclusive) of the activity window. Defaults to the current date.
dependencyFirewallRuleActivity [DependencyFirewallRuleActivity!] Introduced as an experiment in GitLab 19.3.

Dependency firewall per-rule block and warn activity for the group. Available behind the dependency_firewall_phase1 feature flag.

Arguments for dependencyFirewallRuleActivity:
from (Date)
Start date (inclusive) of the activity window. Defaults to 7 days ago.
to (Date)
End date (inclusive) of the activity window. Defaults to the current date.
dependencyLocations DependencyLocationConnection Introduced as an experiment in GitLab 19.1.

Locations of a software dependency across projects under this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyLocations:
componentVersionId (SbomComponentVersionID!)
Global ID of the component version to find locations for.
search (String)
Filter locations by file path.
dependencyProxyBlobCount Int! Number of dependency proxy blobs cached in the group.
dependencyProxyBlobs DependencyProxyBlobConnection Dependency Proxy blobs. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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 GitLab 16.1. Use dependencyProxyTotalSizeBytes.
descendantGroups GroupConnection List of descendant groups of this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for descendantGroups:
archived (Boolean)
Filters archived groups.
ids ([ID!])
Filter groups by IDs.
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.
sort (GroupSort)
Sort groups by given criteria.
descendantGroupsCount Int! Count of direct descendant groups of the group.
description String Description of the namespace.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designatedAsCsp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the namespace is designated to centrally manage security policies.
dora GroupDora Group's DORA metrics.
doraPerformanceScoreCounts DoraPerformanceScoreCountConnection Group's DORA scores for all projects by DORA key metric for the last complete month. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for doraPerformanceScoreCounts:
projectFilters (DoraProjectFilterInput)
Filter DORA metric results by project attributes.
duoAutoModeEnabled Boolean Introduced as an experiment in GitLab 19.5.

Indicates whether Duo Agent Platform auto mode is enabled for the group.
duoFeaturesEnabled Boolean Introduced as an experiment in GitLab 16.10.

Indicates whether GitLab Duo features are enabled for the group.
duoSettingsPath String Introduced as an experiment in GitLab 18.9.

Path of the group Duo settings page.
duoWorkflowSessionArtifacts DuoWorkflowSessionArtifactConnection Introduced as an experiment in GitLab 19.1.

Duo Agent Platform session artifacts for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowSessionArtifacts:
agentClass (AiGovernanceAgentClass)
Filter sessions by agent class. Defaults to all agent classes.
not (DuoWorkflowSessionArtifactNegatedFilterInput)
Negated filter conditions.
projectPath (String)
Filter by project full path.
triggeredByUserId (UserID)
Filter to sessions triggered by the user with the given global ID.
workflowCreatedAfter (Time)
Return sessions created after the timestamp.
workflowCreatedBefore (Time)
Return sessions created before the timestamp.
workflowDefinition (String)
Filter by workflow definition.
workflowId (AiDuoWorkflowsWorkflowID)
Filter to a single session by its workflow (session) global ID.
editPath String! Path for editing group.
emailsDisabled Boolean Indicates if a group has email notifications disabled.
emailsEnabled Boolean Indicates if a group has email notifications enabled.
enforceFreeUserCap Boolean Indicates whether the group has limited users for a free plan.
environmentScopes CiGroupEnvironmentScopeConnection Environment scopes of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for environmentScopes:
name (String)
Name of the environment scope.
search (String)
Search query for environment scope name.
epic Epic Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide.

Arguments for epic:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
epicBoard EpicBoard Deprecated in GitLab 17.5. Replaced by WorkItem type.

Arguments for epicBoard:
id (BoardsEpicBoardID!)
Find an epic board by ID.
epicBoards EpicBoardConnection Deprecated in GitLab 17.5. Replaced by WorkItem type. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
epics EpicConnection Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for epics:
authorUsername (String)
Filter epics by author.
confidential (Boolean)
Filter epics by given confidentiality.
createdAfter (Time)
Epics created after the date.
createdBefore (Time)
Epics created before the date.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
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)
List of arguments with inclusive OR.
search (String)
Search query for title or description.
sort (EpicSort)
List epics by sort order.
state (EpicState)
Filter epics by state.
subscribed (SubscriptionStatus)
Epics the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe.
topLevelHierarchyOnly (Boolean)
Filter epics with a top-level hierarchy.
updatedAfter (Time)
Epics updated after the date.
updatedBefore (Time)
Epics updated before the date.
epicsEnabled Boolean Deprecated in GitLab 17.5. Replaced by WorkItem type. For more information, see migration guide.
externalAuditEventDestinations ExternalAuditEventDestinationConnection Deprecated in GitLab 18.10. Use externalAuditEventStreamingDestinations instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
externalAuditEventStreamingDestinations GroupAuditEventStreamingDestinationConnection Introduced as an experiment in GitLab 16.11.

External destinations that receive audit events belonging to the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
flowMetrics GroupValueStreamAnalyticsFlowMetrics Introduced as an experiment in GitLab 15.10.

Flow metrics for value stream analytics.
fullName String Full name of the group.
fullPath ID! Full path of the group.
gitlabSubscriptionsPreviewBillableUserChange PreviewBillableUserChange Preview Billable User Changes.

Arguments for gitlabSubscriptionsPreviewBillableUserChange:
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.
googleCloudLoggingConfigurations GoogleCloudLoggingConfigurationTypeConnection Deprecated in GitLab 18.10. Use externalAuditEventStreamingDestinations with gcpLogging category instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupMembers GroupMemberConnection A membership of a user within this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groupMembers:
accessLevels ([AccessLevelEnum!])
Filter members by the given access levels.
enterprise (Boolean)
Filter members by enterprise users.
ids ([ID!])
List of group members IDs.
relations ([GroupMemberRelation!])
Filter members by the given member relations.
search (String)
Search query.
sort (MemberSort)
sort query.
groupMembersCount Int! Count of direct members of the group.
id ID ID of the group.
importSourceUsers ImportSourceUserConnection Introduced as an experiment in GitLab 17.2.

Import source users of the namespace. This field can only be resolved for one namespace in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for importSourceUsers:
search (String)
Query to search mappings by name or username of users on source instance.
sort (SourceUserSort)
Sort mapping of users on source instance to users on destination instance by the criteria.
statuses ([ImportSourceUserStatus!])
Filter mapping of users on source instance to users on destination instance by status.
isLinkedToSubscription Boolean Indicates if group is linked to a subscription.
isSelfArchived Boolean Indicates if the group is archived.
isSelfDeletionInProgress Boolean! Introduced as an experiment in GitLab 18.2.

Indicates if group deletion is in progress.
isSelfDeletionScheduled Boolean! Introduced as an experiment in GitLab 18.2.

Indicates if group deletion is scheduled.
issues IssueConnection Issues for projects in this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issues:
assigneeId (String)
ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername (String)
Deprecated in GitLab 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 the date.
closedBefore (Time)
Issues closed before the date.
confidential (Boolean)
Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter (Time)
Issues created after the date.
createdBefore (Time)
Issues created before the date.
crmContactId (String)
ID of a contact assigned to the issues.
crmOrganizationId (String)
ID of an organization assigned to the issues.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter (Time)
Return issues due on or after the given time.
dueBefore (Time)
Return issues due on or before the given time.
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 GitLab 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 the issue.
milestoneTitle ([String])
Milestone applied to the 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 the criteria.
state (IssuableState)
Current state of the issue.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Issues the current user is subscribed to.
types ([IssueType!])
Filter issues by the given issue types.
updatedAfter (Time)
Issues updated after the date.
updatedBefore (Time)
Issues updated before the date.
weight (String)
Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter issues by work item type global IDs.
iterationCadences IterationCadenceConnection Find iteration cadences. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for iterationCadences:
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 the 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.
iterations IterationConnection Find iterations. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for iterations:
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 GitLab 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
knowledgeGraphAvailable Boolean! Introduced as an experiment in GitLab 19.0.

Indicates whether the Knowledge Graph can be enabled for the namespace.
knowledgeGraphEnabled Boolean! Introduced as an experiment in GitLab 18.10.

Indicates whether the Knowledge Graph is enabled for the namespace.
label Label Label available on the group.

Arguments for label:
title (String!)
Title of the label.
labels LabelConnection Labels available on this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for labels:
archived (Boolean)
Filters archived labels. Defaults to false.
fuzzySearch (Boolean)
Match searchTerm fuzzily: labels match when they contain the searched characters in order, but not necessarily contiguously (for example, bugu matches bug::ux). Ignored if using title, or if the fuzzy_label_search feature flag is disabled.
includeAncestorGroups (Boolean)
Include labels from ancestor groups.
includeDescendantGroups (Boolean)
Include labels from descendant groups.
onlyGroupLabels (Boolean)
Include only group level labels.
searchIn ([LabelSearchFieldList!]!)
Specify which fields to search in. Ignored if using title.
searchTerm (String)
Search term to find labels with.
title (String)
Exact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.
lfsEnabled Boolean Indicates if Large File Storage (LFS) is enabled for namespace.
licensedFeatureAvailability LicensedFeatureAvailability! Introduced as an experiment in GitLab 18.11.

Check whether a licensed feature is available.

Arguments for licensedFeatureAvailability:
feature (LicensedFeature!)
Feature to check availability for (for example, EPICS).
licensedFeatures NamespaceAvailableFeatures! Introduced as an experiment in GitLab 18.1.

Licensed features available on the namespace.
lifecycleTemplates [WorkItemLifecycle!] Introduced as an experiment in GitLab 18.4.

Lifecycle templates available to the namespace.
lifecycles WorkItemLifecycleConnection Introduced as an experiment in GitLab 18.1.

Lifecycles of work items available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkPaths NamespacesLinkPaths Introduced as an experiment in GitLab 18.1.

Namespace relevant paths to create links on the UI.
lockAiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events storage is enforced for all subgroups and projects.
lockBuiltInProjectTemplatesEnabled Boolean Introduced as an experiment in GitLab 19.0.

Indicates if the built-in project templates enabled setting is enforced for all subgroups.
lockDuoAutoModeEnabled Boolean Introduced as an experiment in GitLab 19.5.

Indicates if the Duo Agent Platform auto mode setting is enforced for all subgroups.
lockDuoFeaturesEnabled Boolean Introduced as an experiment in GitLab 16.10.

Indicates if the GitLab Duo features enabled setting is enforced for all subgroups.
lockMathRenderingLimitsEnabled Boolean Indicates if math rendering limits are locked for all descendant groups.
lockToolApprovalForSessionEnabled Boolean Introduced as an experiment in GitLab 18.11.

Indicates if the tool approval for session setting is enforced for all subgroups.
markdownPaths MarkdownPaths Introduced as an experiment in GitLab 18.1.

Namespace relevant paths to create markdown links on the UI.
markedForDeletion Boolean! Introduced as an experiment in GitLab 18.2.

Indicates if group or any ancestor is scheduled to be deleted.
markedForDeletionOn Time Introduced as an experiment in GitLab 16.11.

Date when group was scheduled to be deleted.
mathRenderingLimitsEnabled Boolean Indicates if math rendering limits are used for the group.
maxAccessLevel AccessLevel! Maximum access level of the current user in the group.
memberRoles MemberRoleConnection Introduced as an experiment in GitLab 16.5.

Custom roles available for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for memberRoles:
assignable (Boolean)
Filter for member roles the current user can assign.
id (MemberRoleID)
Global ID of the member role to look up.
ids ([MemberRoleID!])
Global IDs of the member role to look up.
orderBy (MemberRolesOrderBy)
Ordering column. Default is NAME.
sort (SortDirectionEnum)
Ordering column. Default is ASC.
mentionsDisabled Boolean Indicates if a group is disabled from getting mentioned.
mergeRequestViolations ComplianceViolationConnection Compliance violations reported on merge requests merged within the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequestViolations:
filters (ComplianceViolationInput)
Filters applied when retrieving compliance violations.
sort (ComplianceViolationSort)
List compliance violations by sort order.
mergeRequests MergeRequestConnection Merge requests for projects in this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, 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 merge requests from archived projects.
includeSubgroups (Boolean)
Include merge requests belonging to subgroups.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
mergeRequestsEnabled Boolean! Introduced as an experiment in GitLab 18.3.

Indicates if merge requests are enabled for the namespace.
metadata NamespaceMetadata Introduced as an experiment in GitLab 18.6.

Metadata information for the namespace.
milestones MilestoneConnection Milestones of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for milestones:
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 the criteria.
state (MilestoneStateEnum)
Filter milestones by state.
timeframe (Timeframe)
List items overlapping the given timeframe.
title (String)
Title of the milestone.
name String Name of the group.
namespaceSettings NamespaceSettings Namespace settings for the namespace.
orbit OrbitNamespace Introduced as an experiment in GitLab 19.5.

Orbit data of the group. Returns null when Orbit is not available to the current user.
orbitAccess OrbitAccess Introduced as an experiment in GitLab 19.5.

Orbit access state of the top-level group. Returns null when the user cannot read the Orbit setting of the group. This field can only be resolved for one group in any single request.
orbitTrial OrbitTrial Introduced as an experiment in GitLab 19.5.

Orbit trial state of the top-level group. Returns null when the CustomersDot request fails. This field can be resolved for at most 10 groups in any single request.
organizationEditPath String Introduced as an experiment in GitLab 17.1.

Path for editing group at the organization level.
organizationStateCounts OrganizationStateCounts Counts of organizations by status for the group.

Arguments for organizationStateCounts:
search (String)
Search term to find organizations with.
state (CustomerRelationsOrganizationState)
State of the organizations to search for.
organizations CustomerRelationsOrganizationConnection Find organizations of this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
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.
packageSettings PackageSettings Package settings for the namespace.
packages PackageConnection Packages of the group. This field can only be resolved for one group in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packages:
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 the criteria.
status (PackageStatus)
Filter a package by status.
pagesDeployments PagesDeploymentConnection List of the namespaces's Pages Deployments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pagesDeployments:
active (Boolean)
Filter by active or inactive state.
sort (Sort)
Sort results.
versioned (Boolean)
Filter deployments that are versioned or unversioned.
parent Group Parent group.
path String! Path of the namespace.
pendingMemberApprovals MemberApprovalConnection Pending member promotions of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pendingMembers PendingMemberInterfaceConnection Introduced as an experiment in GitLab 16.6.

A pending membership of a user within this group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
permanentDeletionDate String Introduced as an experiment in GitLab 16.11.

For groups pending deletion, returns the group's scheduled deletion date. For groups not pending deletion, returns a theoretical date based on current settings if marked for deletion today.
pipelineAnalytics PipelineAnalytics Pipeline analytics.

Arguments for pipelineAnalytics:
fromTime (Time)
Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref (String)
Branch that triggered the pipeline.
source (CiPipelineSources)
Source of the pipeline.
subgroupFullPaths ([String!])
Introduced as an experiment in GitLab 18.11.

Full paths of subgroups to filter by. Only applies when querying pipeline analytics for a group (maximum is 10).
toTime (Time)
End of the requested time (in UTC). Defaults to the pipelines started before the current date.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
pipelineExecutionSchedulePolicies PipelineExecutionSchedulePolicyConnection Pipeline Execution Schedule Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionSchedulePolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
plan NamespacePlan Introduced as an experiment in GitLab 18.2.

Subscription plan associated with the namespace.
policyStore PolicyStore Introduced as an experiment in GitLab 19.4.

Policy store catalogs. Returns null when the policy store experiment is not active for the group.
projectComplianceRequirementsStatus ProjectComplianceRequirementStatusConnection Introduced as an experiment in GitLab 17.10.

Compliance statuses for the projects in a group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectComplianceRequirementsStatus:
filters (GroupProjectRequirementComplianceStatusInput)
Filters applied when retrieving compliance requirement statuses.
orderBy (ProjectComplianceRequirementStatusOrderBy)
Field used to sort compliance requirement statuses.
projectComplianceStandardsAdherence ComplianceStandardsAdherenceConnection Compliance standards adherence for the projects in a group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectComplianceStandardsAdherence:
filters (ComplianceStandardsAdherenceInput)
Filters applied when retrieving compliance standards adherence.
projectComplianceViolations ProjectComplianceViolationConnection Introduced as an experiment in GitLab 18.1.

Compliance violations for the projects in a group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectComplianceViolations:
filters (ProjectComplianceViolationFilterInput)
Filters applied when retrieving compliance violations.
projectCreationLevel String Permission level required to create projects in the group.
projectStatistics NamespaceProjectStatistics Introduced as an experiment in GitLab 18.2.

Statistics of the projects in the group. Only available from Query.groups.
projects ProjectConnection! Projects within this namespace. Returns projects from the parent group if namespace is project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
archivedOnly (Boolean)
Return only archived projects.
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.
includeArchived (Boolean)
Include also archived projects.
includeSiblingProjects (Boolean)
Introduced as an experiment in GitLab 17.2.

Include also projects from parent group.
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 the criteria.
withIssuesEnabled (Boolean)
Return only projects with issues enabled.
withMergeRequestsEnabled (Boolean)
Return only projects with merge requests enabled.
withNamespaceDomainPages (Boolean)
Return only projects that use the namespace domain for pages projects.
projectsCount Int! Count of direct projects in the group.
recentIssueBoards BoardConnection List of recently visited boards of the group. Maximum size is 4. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
releases ReleaseConnection Releases belonging to projects in the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for releases:
sort (GroupReleaseSort)
Sort group releases by given criteria.
remoteDevelopmentClusterAgents ClusterAgentConnection Deprecated in GitLab 17.8. Use workspacesClusterAgents. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for remoteDevelopmentClusterAgents:
filter (NamespaceClusterAgentFilter!)
Filter the types of cluster agents to return.
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 the group are required to set up two-factor authentication.
rootNamespace Namespace! Top-level namespace of the namespace.
rootStorageStatistics RootStorageStatistics Aggregated storage statistics of the namespace. Only available for root namespaces.
runnerCloudProvisioning CiRunnerCloudProvisioning Introduced as an experiment in GitLab 16.10.

Information used for provisioning the runner on a cloud provider. Returns null if the GitLab instance is not a SaaS instance.

Arguments for runnerCloudProvisioning:
cloudProjectId (GoogleCloudProject!)
Identifier of the cloud project.
provider (CiRunnerCloudProvider!)
Identifier of the cloud provider.
runners CiRunnerConnection Find runners visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for runners:
active (Boolean)
Deprecated in GitLab 14.8. Renamed. Use paused instead.
creatorId (UserID)
Filter runners by creator ID.
creatorUsername (String)
Filter runners by creator username.
membership (CiRunnerMembershipFilter)
Control which runners to include in the results.
ownerFullPath (String)
Introduced as an experiment in GitLab 17.8.

Filter runners by owning project or group.
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)
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'.
savedReplies GroupSavedReplyConnection Saved replies available to the group. This field can only be resolved for one group in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for savedReplies:
includeAncestorGroups (Boolean)
Include saved replies from parent groups.
savedReply GroupSavedReply Saved reply in the group. This field can only be resolved for one group in any single request.

Arguments for savedReply:
id (GroupsSavedReplyID!)
Global ID of a saved reply.
savedViews WorkItemSavedViewTypeConnection Introduced as an experiment in GitLab 18.7.

Saved views associated with the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for savedViews:
id (WorkItemsSavedViewsSavedViewID)
ID of the saved view. Required when requesting work_items, filters, or filter_warnings fields.
search (String)
Search query for saved view name or description.
sort (WorkItemsSavedViewsSort)
Sort work items by criteria. Default is ID.
subscribedOnly (Boolean)
Whether to return only saved views subscribed to by the current user.
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanExecutionPolicies:
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.
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
scanResultPolicies ScanResultPolicyConnection Deprecated in GitLab 16.9. Use approvalPolicies. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanResultPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
secretsManagerEntitlement SecretsManagerEntitlement Introduced as an experiment in GitLab 19.2.

Secrets Manager entitlement for the top-level group. Returns null for non-root groups, INELIGIBLE when unresolvable.
securityCategories [SecurityCategory!] Security categories for the group.
securityMetrics SecurityMetrics Introduced as an experiment in GitLab 18.2.

Security metrics.This feature is currently under development and not yet available for general use.

Arguments for securityMetrics:
projectId ([ID!])
Filter by project IDs in a group or an organization. This argument is ignored when we are querying for a project.
reportType ([VulnerabilityReportType!])
Filter by report types.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 18.8.

Filter by security attributes. Up to 20 filters.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref IDs. This argument is ignored when querying for a group. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
securityPolicies SecurityPolicyTypeConnection Introduced as an experiment in GitLab 18.1.

List of security policies configured for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicies:
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship.
type (PolicyType)
Filter policies by type.
securityPolicyProject Project Security policy project assigned to the namespace.
securityPolicyProjectSuggestions ProjectConnection Security policy project suggestions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicyProjectSuggestions:
onlyLinked (Boolean)
Whether to suggest only projects already linked as security policy projects.
search (String!)
Search query for projects' full paths.
securityPostureCounters SecurityPostureCounters Introduced as an experiment in GitLab 19.0.

Security posture counters for the group.
shareWithGroupLock Boolean Indicates if sharing a project with another group within the group is prevented.
sharedGroups GroupConnection List of shared groups this group was invited to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for sharedGroups:
search (String)
Search for a specific group.
sort (GroupSort)
Order by name, created at, updated at, path, id or similarity if searching.
sharedProjects ProjectConnection List of shared projects this group was invited to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for sharedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query, which can be for the project name, a path, or a description.
sort (String)
Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc. Defaults to id_desc, or similarity if search used.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.
sidebar NamespaceSidebar Introduced as an experiment in GitLab 17.6.

Data needed to render the sidebar for the namespace.
standardRole StandardRole Introduced as an experiment in GitLab 17.6.

Finds a single default role for the group. Available only for SaaS.

Arguments for standardRole:
accessLevel ([MemberAccessLevel!])
Access level or levels to filter by.
standardRoles StandardRoleConnection Introduced as an experiment in GitLab 17.4.

Default roles available for the group. Available only for SaaS. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for standardRoles:
accessLevel ([MemberAccessLevel!])
Access level or levels to filter by.
stats GroupStats Group statistics.
statuses WorkItemStatusConnection Introduced as an experiment in GitLab 18.1.

Statuses of work items available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for statuses:
ids ([WorkItemsStatusesStatusID!])
Filter statuses by ID. A max of 70 can be provided.
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.
subscribedSavedViewLimit Int! Introduced as an experiment in GitLab 18.8.

Maximum number of subscribed saved views allowed on the namespace.
subscriptionHistory GitlabSubscriptionHistoryConnection Introduced as an experiment in GitLab 17.3.

Find subscription history records. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
targetedMessages [TargetedMessage!] Introduced as an experiment in GitLab 18.7.

Targeted messages for the namespace.
timelogCategories TimeTrackingTimelogCategoryConnection Introduced as an experiment in GitLab 15.3.

Timelog categories for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
timelogs TimelogConnection! Time logged on issues and merge requests in the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
toolApprovalForSessionEnabled Boolean Introduced as an experiment in GitLab 18.11.

Indicates whether tool approval for session is enabled for the group.
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.
transferInProgress Boolean! Introduced as an experiment in GitLab 19.3.

Indicates if the group is currently being transferred.
triageAndRemediationCoverageCounters TriageAndRemediationCoverageCounters Introduced as an experiment in GitLab 19.5.

Triage and remediation coverage counters for the group, for a given trigger type.

Arguments for triageAndRemediationCoverageCounters:
triggerType (ScanProfileTriggerType!)
Trigger type to count coverage for.
twoFactorGracePeriod Int Time before two-factor authentication is enforced.
updatedAt Time Timestamp of when the group was last updated.
userPermissions GroupPermissions! Permissions for the current user on the resource.
valueStreamAnalytics ValueStreamAnalytics Information about Value Stream Analytics within the group.
valueStreamDashboardUsageOverview ValueStreamDashboardCount Introduced as an experiment in GitLab 16.4.

Aggregated usage counts within the group.

Arguments for valueStreamDashboardUsageOverview:
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).
valueStreams ValueStreamConnection Value streams available to the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for valueStreams:
id (ID)
Value stream id.
virtualRegistriesCleanupPolicy VirtualRegistryCleanupPolicy Introduced as an experiment in GitLab 18.7.

Virtual registries cleanup policy of the group. Returns null if the maven_virtual_registry feature flag is disabled.
virtualRegistriesContainerRegistries ContainerRegistryConnection Introduced as an experiment in GitLab 18.7.

Container virtual registries registered to the group. Returns null if the container_virtual_registries feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
virtualRegistriesContainerUpstreams ContainerUpstreamConnection Introduced as an experiment in GitLab 18.7.

Container upstreams registered to the group. Returns null if the container_virtual_registries feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for virtualRegistriesContainerUpstreams:
upstreamName (String)
Search upstreams by name.
virtualRegistriesPackagesMavenRegistries MavenRegistryConnection Introduced as an experiment in GitLab 18.6.

Maven virtual registries registered to the group. Returns null if the maven_virtual_registry feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
virtualRegistriesPackagesMavenUpstreams MavenUpstreamConnection Introduced as an experiment in GitLab 18.6.

Maven upstream registries registered to the group. Returns null if the maven_virtual_registry feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for virtualRegistriesPackagesMavenUpstreams:
upstreamName (String)
Search upstreams by name.
virtualRegistriesSetting VirtualRegistriesSetting Introduced as an experiment in GitLab 18.5.

Virtual registries settings for the group. Returns null if the maven_virtual_registry feature flag is disabled.
visibility String Visibility of the namespace.
vulnerabilities VulnerabilityConnection Vulnerabilities reported on the projects in the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilities:
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities which have been auto dismissed by security policies. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
sort (VulnerabilitySort)
List vulnerabilities by sort order.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.10.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured and advanced vulnerability management set up.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.9.

Filter by tracked ref scope. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by validity check.
vulnerabilitiesCountByDay VulnerabilitiesCountByDayConnection The historical number of vulnerabilities per day for the projects in the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilitiesCountByDay:
endDate (ISO8601Date!)
Last day for which to fetch vulnerability history.
startDate (ISO8601Date!)
First day for which to fetch vulnerability history.
vulnerabilityGrades [VulnerableProjectsByGrade!] Represents vulnerable project counts for each grade.

Arguments for vulnerabilityGrades:
includeSubgroups (Boolean)
Include grades belonging to subgroups.
letterGrade (VulnerabilityGrade)
Filter the response by given letter grade.
vulnerabilityIdentifierSearch [String!] Search for vulnerabilities by identifier.

Arguments for vulnerabilityIdentifierSearch:
name (String!)
Search identifier by name. Substring or partial match search is supported and argument should be greater than 3 characters.
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Introduced as an experiment in GitLab 17.7.

Vulnerability Management Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityManagementPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
vulnerabilityNamespaceStatistic VulnerabilityNamespaceStatisticType Counts for each vulnerability severity in the group and its subgroups.
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilitySeveritiesCount VulnerabilitySeveritiesCount Counts for each vulnerability severity in the group and its subgroups.

Arguments for vulnerabilitySeveritiesCount:
capped (Boolean)
Default value is false. When set to true, the count returned for each severity is capped at a maximum of 1001. Ignored when used along with any argument that requires advanced vulnerability management.
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Introduced as an experiment in GitLab 17.7.

Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Filter by policy auto dismissed. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by scanner.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref scope. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by token status.
webBasedCommitSigningEnabled Boolean! Introduced as an experiment in GitLab 18.2.

Indicates whether web-based commit signing is enabled for the group.
webPath String! Web path of the group.
webUrl String! Web URL of the group.
webhook GroupHook Introduced as an experiment in GitLab 18.5.

A single group webhook.

Arguments for webhook:
id (GroupHookID!)
ID of the group webhook.
wikiPages WikiPageConnection Introduced as an experiment in GitLab 19.2.

Wiki pages of the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
workItem WorkItem Find a work item by IID directly associated with the group.

Arguments for workItem:
iid (String!)
IID of the work item.
workItemDescriptionTemplates WorkItemDescriptionTemplateConnection Introduced as an experiment in GitLab 17.6.

Work item description templates available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemDescriptionTemplates:
name (String)
Deprecated in GitLab 17.9. name and project ID are both required for fetching, use DescriptionTemplateContentInputType instead.
search (String)
Deprecated in GitLab 17.8. search on template names is performed on the FE only.
workItemMoveTargets [WorkItemMoveTarget!] Introduced as an experiment in GitLab 19.1.

Valid target work item types and a suggested default for moving work items of given source types into this namespace.

Arguments for workItemMoveTargets:
sourceFullPath (String!)
Full path of the source namespace. For example, gitlab-org/gitlab-foss.
sourceTypeIds ([WorkItemsTypeID!]!)
Global IDs of the source work item types to compute move targets for. A maximum of 50 IDs can be provided.
workItemSettings WorkItemSettings Introduced as an experiment in GitLab 19.0.

Work item settings for the group.
workItemStateCounts WorkItemStateCountsType Counts of work items by state for the namespace.

Arguments for workItemStateCounts:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
excludeGroupWorkItems (Boolean)
Introduced as an experiment in GitLab 18.4.

Exclude group-level work items within the group and its descendants. Ignored for project namespaces.
excludeProjects (Boolean)
Introduced as an experiment in GitLab 17.5.

Exclude work items from projects within the group. Ignored for project namespaces.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeAncestors (Boolean)
Include work items from ancestor groups. Ignored for project namespaces.
includeArchived (Boolean)
Introduced as an experiment in GitLab 18.5.

Return work items from archived projects. Ignored for project namespaces.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
includeDescendants (Boolean)
Include work items from descendant groups and projects. Ignored for project namespaces.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe. Ignored for project namespaces.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemTypes WorkItemTypeConnection Work item types available to the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemTypes:
name (IssueType)
Deprecated in GitLab 19.0. Name-based filtering is no longer supported with introduction of configurable work item types in 19.0.
onlyAvailable (Boolean)
Introduced as an experiment in GitLab 18.6.

When true, returns only the available work item types for the current user. This experimental field will be removed in 19.0. Use canUserCreateItems and isFilterableListView fields from the WorkItemTypes API instead.
workItems WorkItemConnection Work items that belong to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItems:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
excludeGroupWorkItems (Boolean)
Introduced as an experiment in GitLab 18.4.

Exclude group-level work items within the group and its descendants. Ignored for project namespaces.
excludeProjects (Boolean)
Introduced as an experiment in GitLab 17.5.

Exclude work items from projects within the group. Ignored for project namespaces.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeAncestors (Boolean)
Include work items from ancestor groups. Ignored for project namespaces.
includeArchived (Boolean)
Introduced as an experiment in GitLab 18.5.

Return work items from archived projects. Ignored for project namespaces.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
includeDescendants (Boolean)
Include work items from descendant groups and projects. Ignored for project namespaces.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe. Ignored for project namespaces.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemsWidgets [String!] Introduced as an experiment in GitLab 18.2.

List of available widgets for the given work items.

Arguments for workItemsWidgets:
ids ([WorkItemsTypeID!]!)
Global ID array of work items types to fetch available widgets for. A max of 100 IDs can be provided at a time.
union (Boolean!)
When true, returns the union of widgets across all work item types. When false, returns only widgets common to all work item types.
workspacesClusterAgents ClusterAgentConnection Introduced as an experiment in GitLab 17.8.

Cluster agents in the namespace with workspaces capabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspacesClusterAgents:
filter (NamespaceClusterAgentFilter!)
Filter the types of cluster agents to return.

GroupAuditEventNamespaceFilter#

Represents a subgroup or project filter that belongs to a group level external audit event streaming destination.

Fields#

Name Type Description
externalStreamingDestination GroupAuditEventStreamingDestination! Destination to which the filter belongs.
id ID! ID of the filter.
namespace Namespace! Group or project namespace the filter belongs to.

GroupAuditEventStreamingDestination#

Represents an external destination to stream group level audit events.

Implements: AuditEventStreamingDestinationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
category String! Category of the external destination to send audit events to.
config JSON! Config of the external destination.
eventTypeFilters [String!]! List of event type filters added for streaming.
group Group! Group to which the destination belongs.
id ID! ID of the destination.
name String! Name of the external destination to send audit events to.
namespaceFilters [GroupAuditEventNamespaceFilter!] List of subgroup or project filters for the destination.
secretToken String! Secret token for the destination, will be non-empty value only for http category.

GroupAuditEventStreamingDestinationConnection#

Paginated collection of GroupAuditEventStreamingDestination. See Standard connection fields for the fields available on every connection.

GroupConnection#

Paginated collection of Group. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

GroupDataTransfer#

Fields#

Name Type Description
egressNodes EgressNodeConnection Data nodes. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

GroupDora#

All information related to group DORA metrics.

Fields#

Name Type Description
metrics [DoraMetric!] DORA metrics for the current group or project.

Arguments for metrics:
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.
startDate (Date)
Date range to start from. Default is 3 months ago.
projects ProjectConnection! Projects within this group with at least 1 DORA metric for given period. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
archivedOnly (Boolean)
Return only archived projects.
complianceFrameworkFilters (ComplianceFrameworkFilters)
Filters applied when selecting a compliance framework.
endDate (Date!)
Date range to end DORA lookup at.
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.
includeArchived (Boolean)
Include also archived projects.
includeSiblingProjects (Boolean)
Introduced as an experiment in GitLab 17.2.

Include also projects from parent group.
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 the criteria.
startDate (Date!)
Date range to start DORA lookup from.
withIssuesEnabled (Boolean)
Return only projects with issues enabled.
withMergeRequestsEnabled (Boolean)
Return only projects with merge requests enabled.
withNamespaceDomainPages (Boolean)
Return only projects that use the namespace domain for pages projects.

GroupHook#

Fields#

Name Type Description
alertStatus WebhookAlertStatus! Auto-disabling status of the webhook.
branchFilterStrategy WebhookBranchFilterStrategy! Strategy for filtering push events by branch name.
confidentialIssuesEvents Boolean! Whether the webhook is triggered on confidential issues events.
confidentialNoteEvents Boolean! Whether the webhook is triggered on confidential note events.
createdAt Time! Timestamp of when the webhook was created.
customHeaders [WebhookCustomHeader!] List of custom header names for the webhook.
customWebhookTemplate String Custom payload template for the webhook request body.
deploymentEvents Boolean! Whether the webhook is triggered on deployment events.
description String Description of the webhook.
disabledUntil Time Timestamp when the webhook will be automatically re-enabled if temporarily disabled.
emojiEvents Boolean! Whether the webhook is triggered on emoji events.
enableSslVerification Boolean Whether SSL verification is done when triggering the webhook.
featureFlagEvents Boolean! Whether the webhook is triggered on feature flag events.
id GroupHookID! ID of the webhook.
issuesEvents Boolean! Whether the webhook is triggered on issues events.
jobEvents Boolean! Whether the webhook is triggered on job events.
memberEvents Boolean! Whether the webhook is triggered on member events.
mergeRequestsEvents Boolean! Whether the webhook is triggered on merge request events.
milestoneEvents Boolean! Whether the webhook is triggered on milestone events.
name String Name of the webhook.
noteEvents Boolean! Whether the webhook is triggered on note events.
pipelineEvents Boolean! Whether the webhook is triggered on pipeline events.
projectEvents Boolean! Whether the webhook is triggered on project events.
pushEvents Boolean! Whether the webhook is triggered on push events.
pushEventsBranchFilter String Trigger hook on push events for matching branches only.
releasesEvents Boolean! Whether the webhook is triggered on releases events.
resourceAccessTokenEvents Boolean! Whether the webhook is triggered on resource access token events.
signingTokenPresent Boolean! Whether an HMAC signing token is configured for webhook-signature header generation.
subgroupEvents Boolean! Whether the webhook is triggered on subgroup events.
tagPushEvents Boolean! Whether the webhook is triggered on tag push events.
tokenPresent Boolean! Whether a secret token is configured for X-Gitlab-Token header validation.
url String! URL of the webhook.
urlVariables [WebhookUrlVariable!] List of URL variable masks to hide sensitive portions of the webhook URL.
vulnerabilityEvents Boolean! Whether the webhook is triggered on vulnerability events.
webhookEvent WebhookEvent A single webhook event.

Arguments for webhookEvent:
id (WebHookLogID!)
ID of the webhook event.
timestampRange (TimestampRange)
Filter for webhook events within a range of timestamps. Defaults to events within the last seven days.
webhookEvents WebhookEventConnection List of recent webhook events. This field can only be resolved for one webhook in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for webhookEvents:
timestampRange (TimestampRange)
Filter for webhook events within a range of timestamps. Defaults to events within the last seven days.
wikiPageEvents Boolean! Whether the webhook is triggered on wiki page events.

GroupInterfaceConnection#

Paginated collection of GroupInterface. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

GroupMember#

Represents a Group Membership.

Implements: MemberInterface

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.
mergeRequestInteraction UserMergeRequestInteraction Find a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
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 GroupMemberPermissions! Permissions for the current user on the resource.

GroupMemberConnection#

Paginated collection of GroupMember. See Standard connection fields for the fields available on every connection.

GroupMemberPermissions#

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.
removeGroup Boolean! If true, the user can perform remove_group on this resource.
viewEditPage Boolean! If true, the user can perform view_edit_page on this resource.

GroupMinimalAccess#

Limited group data accessible to users without full group read access (e.g. non-members with READ_ADMIN_CICD admin custom role).

Implements: GroupInterface

Fields#

Name Type Description
avatarUrl String Avatar URL of the group.
fullName String! Full name of the group.
fullPath ID! Full path of the group.
id ID! ID of the group.
name String! Name of the group.
userPermissions GroupPermissions! Permissions for the current user on the resource.
webUrl String Web URL of the group.

Implements: NamespacesLinkPaths

Fields#

Name Type Description
autocompleteAwardEmojisPath String Introduced as an experiment in GitLab 18.6.

Path for autocomplete award emojis.
calendarPath String Introduced as an experiment in GitLab 18.4.

Calendar path for work items.
contributionGuidePath String Namespace contribution guide path.
emailsHelpPagePath String Help page path for emails.
epicsList String Namespace epics_list.
epicsListPath String Introduced as an experiment in GitLab 18.6.

Path to the epics list for the namespace.
groupIssues String Namespace group_issues.
groupPath String Introduced as an experiment in GitLab 18.6.

Full path of the group.
issuesList String Namespace issues_list.
issuesListPath String Introduced as an experiment in GitLab 18.6.

Path to the issues list for the namespace.
issuesSettings String Namespace issues settings path.
labelsFetch String Namespace labels_fetch.
labelsManage String Namespace labels_manage.
markdownHelpPath String Help page path for Markdown.
namespaceFullPath String Introduced as an experiment in GitLab 18.6.

Full path of the namespace (project.namespace.full_path or group full_path).
newCommentTemplate [CommentTemplatePath!] Namespace new_comment_template_paths.
newIssuePath String Introduced as an experiment in GitLab 18.6.

Path to create a new issue.
newProject String Namespace new_project.
newTrialPath String Introduced as an experiment in GitLab 18.6.

New trial path for the namespace.
quickActionsHelpPath String Help page path for quick actions.
register String Namespace register_path.
reportAbuse String Namespace report_abuse.
rssPath String Introduced as an experiment in GitLab 18.4.

RSS path for work items.
signIn String Namespace sign_in_path.
userExportEmail String Introduced as an experiment in GitLab 18.3.

User email for export CSV. Returns null for user namespaces.

GroupNamespaceMarkdownPaths#

Implements: MarkdownPaths

Fields#

Name Type Description
autocompleteSourcesPath JSON Supported paths for autocomplete sources for a given namespace.

Arguments for autocompleteSourcesPath:
iid (String)
IID of the work item.
workItemTypeId (String)
ID of the work item type.
markdownPreviewPath String Path for the markdown preview for given namespace.

Arguments for markdownPreviewPath:
iid (String)
IID of the target item for markdown preview.
uploadsPath String Uploads path for a given namespace.

GroupNamespaceMetadata#

Implements: NamespaceMetadata

Fields#

Name Type Description
groupId String Introduced as an experiment in GitLab 18.6.

ID of the group. Returns null for user namespaces.
hasProjects Boolean Introduced as an experiment in GitLab 18.6.

Whether the group has any projects.
initialSort String Introduced as an experiment in GitLab 18.6.

User preference for initial sort order.
isIssueRepositioningDisabled Boolean Introduced as an experiment in GitLab 18.6.

Whether issue repositioning is disabled for the namespace.
maxAttachmentSize String Introduced as an experiment in GitLab 18.6.

Maximum allowed attachment size (humanized).
showNewWorkItem Boolean Introduced as an experiment in GitLab 18.6.

Whether to show the new work item link.
timeTrackingLimitToHours Boolean Introduced as an experiment in GitLab 18.6.

Time tracking limit to hours setting.

GroupPermissions#

Fields#

Name Type Description
adminAiCatalogItemConsumer Boolean! If true, the user can perform admin_ai_catalog_item_consumer on this resource.
adminAllResources Boolean! If true, the user is an instance administrator.
adminIssue Boolean! If true, the user can perform admin_issue on this resource.
adminWorkItemLifecycle Boolean! If true, the user can perform admin_work_item_lifecycle on this resource.
applySecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform apply_security_scan_profiles on this resource. Attaching a profile is authorized per project, so this ability is evaluated on this resource rather than on the root ancestor.
archiveGroup Boolean! If true, the user can perform archive_group on this resource.
canLeave Boolean! If true, the user can leave this group.
changeGroup Boolean! If true, the user can perform change_group on this resource.
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.
createSecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform create_security_scan_profiles on the top-level namespace of this resource. Security scan profiles belong to the top-level namespace, so this ability is evaluated on the root ancestor rather than on this resource.
deleteSecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform delete_security_scan_profiles on the top-level namespace of this resource. Security scan profiles belong to the top-level namespace, so this ability is evaluated on the root ancestor rather than on this resource.
generateDescription Boolean! If true, the user can perform generate_description on this resource.
readCrmContact Boolean! If true, the user can perform read_crm_contact on this resource.
readCrmOrganization Boolean! If true, the user can perform read_crm_organization on this resource.
readCycleAnalytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_cycle_analytics on this resource.
readDora4Analytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_dora4_analytics on this resource.
readGroup Boolean! If true, the user can perform read_group on this resource.
readOrbitTrial Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_orbit_trial on this resource.
readProAiAnalytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_pro_ai_analytics on this resource.
readRunnerCloudProvisioningInfo Boolean! Introduced as an experiment in GitLab 18.8.

If true, the user can perform read_runner_cloud_provisioning_info on this resource.
readSecurityResource Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_security_resource on this resource.
readSecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform read_security_scan_profiles on the top-level namespace of this resource. Security scan profiles belong to the top-level namespace, so this ability is evaluated on the root ancestor rather than on this resource.
removeGroup Boolean! If true, the user can perform remove_group on this resource.
startOrbitTrial Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform start_orbit_trial on this resource.
updateSecurityScanProfiles Boolean! Introduced as an experiment in GitLab 19.4.

If true, the user can perform update_security_scan_profiles on the top-level namespace of this resource. Security scan profiles belong to the top-level namespace, so this ability is evaluated on the root ancestor rather than on this resource.
viewEditPage Boolean! If true, the user can perform view_edit_page 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.

GroupSavedReply#

Fields#

Name Type Description
content String! Content of the saved reply.
id GroupsSavedReplyID! Global ID of the group-level saved reply.
name String! Name of the saved reply.

GroupSavedReplyConnection#

Paginated collection of GroupSavedReply. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

GroupSecret#

Represents a group secret.

Fields#

Name Type Description
createdAt Time Timestamp when the secret creation started.
description String Description of the group secret.
environment String! Environments that can access the secret.
group Group! Group the secret belongs to.
metadataVersion Int Current metadata version of the group secret.
name String! Name of the group secret.
protected Boolean! Whether the secret is only accessible from protected branches.
rotationInfo SecretRotationInfo Rotation configuration for the secret.
status SecretStatus! Computed lifecycle status of the secret, based on timestamps.

GroupSecretConnection#

Paginated collection of GroupSecret. See Standard connection fields for the fields available on every connection.

GroupSecretsManager#

Representation of a group secrets manager.

Fields#

Name Type Description
group Group! Group the secrets manager belongs to.
readOnly Boolean! Introduced as an experiment in GitLab 19.4.

Whether the instance is in strict read-only mode (Geo secondary or maintenance mode). No secrets or permissions can be created, updated, or deleted while it is true.
status GroupSecretsManagerStatus Status of the group secrets manager.
userPermissions GroupSecretsManagerPermissions! Permissions for the current user on the resource.
writeDenialReason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.5.

Reason the Secrets Manager entitlement does not allow secrets or their permissions to be created or updated. Null when it allows them.

GroupSecretsManagerPermissions#

Permissions the current user has on a group secrets manager.

Fields#

Name Type Description
createSecrets Boolean! Indicates the user can create secrets in this group secrets manager.
deleteSecrets Boolean! Indicates the user can delete secrets in this group secrets manager.
readMetadata Boolean! Indicates the user can read secret metadata in this group secrets manager.
updateSecrets Boolean! Indicates the user can update secrets in this group secrets manager.

GroupSecretsPermission#

Representation of a group secrets permission.

Fields#

Name Type Description
actions [SecretsManagementAction!]! Actions that can be performed on secrets.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
grantedBy UserCore User who created the Secret Permission.
group Group! Group the secret permission belong to.
principal Principal! Who is provided access to. For eg: User/Role/MemberRole.

GroupSecretsPermissionConnection#

Paginated collection of GroupSecretsPermission. See Standard connection fields for the fields available on every connection.

GroupSecurityPolicySource#

Represents the source of a security policy belonging to a group.

Fields#

Name Type Description
inherited Boolean! Indicates whether the 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.

GroupUploadRegistry#

Represents the Geo replication and verification state of a group_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the GroupUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the GroupUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this GroupUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
groupUploadId ID! ID of the Group Upload.
id ID! ID of the GroupUploadRegistry.
lastSyncFailure String Error message during sync of the GroupUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the GroupUploadRegistry.
missingOnPrimary Boolean Indicate if the GroupUploadRegistry is missing on primary.
modelRecordId Int ID of the GroupUploadRegistry's model record.
retryAt Time Timestamp after which the GroupUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the GroupUploadRegistry.
state RegistryState Sync state of the GroupUploadRegistry.
verificationChecksum String The local checksum of the GroupUploadRegistry.
verificationChecksumMismatched String The expected checksum of the GroupUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the GroupUploadRegistry.
verificationRetryAt Time Timestamp after which the GroupUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the GroupUploadRegistry.
verificationStartedAt Time Timestamp when the verification of GroupUploadRegistry started.
verificationState VerificationStateEnum Verification state of the GroupUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the GroupUploadRegistry.

GroupUploadRegistryConnection#

Paginated collection of GroupUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

GroupValueStreamAnalyticsFlowMetrics#

Exposes aggregated value stream flow metrics.

Fields#

Name Type Description
cycleTime ValueStreamAnalyticsMetric Median time from first commit to issue closed.

Arguments for cycleTime:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
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.
deploymentCount ValueStreamAnalyticsMetric Number of production deployments in the given period.

Arguments for deploymentCount:
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.
issueCount ValueStreamAnalyticsMetric Number of issues opened in the given period.

Arguments for issueCount:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
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.
issuesCompletedCount ValueStreamAnalyticsMetric Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Arguments for issuesCompletedCount:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
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.
leadTime ValueStreamAnalyticsMetric Median time from when the issue was created to when it was closed.

Arguments for leadTime:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
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.
timeToMerge ValueStreamAnalyticsMetric Median time from merge request creation to merge request merged.

Arguments for timeToMerge:
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
checksumMismatch Boolean Indicate if the checksums of the GroupWikiRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the GroupWikiRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this GroupWikiRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the GroupWikiRepositoryRegistry is missing on primary.
modelRecordId Int ID of the GroupWikiRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the GroupWikiRepositoryRegistry in case of mismatch.
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 of GroupWikiRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the GroupWikiRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the GroupWikiRepositoryRegistry.

GroupWikiRepositoryRegistryConnection#

Paginated collection of GroupWikiRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.
previousPath String Path to the file in the commit's first parent.
span Int! Number of contiguous lines which the blame spans for the commit group.

HelmFileMetadata#

Helm file metadata.

Implements: PackageFileMetadata

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.

ImagePullSecrets#

Fields#

Name Type Description
name String! Name of the Kubernetes image pull secret.
namespace String! Namespace of the kubernetes image pull secret.

ImportExportUploadUploadRegistry#

Represents the Geo replication and verification state of an import/export archive upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ImportExportUploadUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ImportExportUploadUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ImportExportUploadUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ImportExportUploadUploadRegistry.
importExportUploadUploadId ID! ID of the import/export archive upload.
lastSyncFailure String Error message during sync of the ImportExportUploadUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ImportExportUploadUploadRegistry.
missingOnPrimary Boolean Indicate if the ImportExportUploadUploadRegistry is missing on primary.
modelRecordId Int ID of the ImportExportUploadUploadRegistry's model record.
retryAt Time Timestamp after which the ImportExportUploadUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ImportExportUploadUploadRegistry.
state RegistryState Sync state of the ImportExportUploadUploadRegistry.
verificationChecksum String The local checksum of the ImportExportUploadUploadRegistry.
verificationChecksumMismatched String The expected checksum of the ImportExportUploadUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the ImportExportUploadUploadRegistry.
verificationRetryAt Time Timestamp after which the ImportExportUploadUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ImportExportUploadUploadRegistry.
verificationStartedAt Time Timestamp when the verification of ImportExportUploadUploadRegistry started.
verificationState VerificationStateEnum Verification state of the ImportExportUploadUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ImportExportUploadUploadRegistry.

ImportExportUploadUploadRegistryConnection#

Paginated collection of ImportExportUploadUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ImportSourceUser#

Fields#

Name Type Description
createdAt Time! Timestamp of when the source user was created.
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.
importType ImportSource! Name of the importer.
namespace Namespace Namespace the contributions were imported to.
placeholderUser UserCore Placeholder user associated with the import source user.
reassignToUser UserCore User that contributions are reassigned to.
reassignedByUser UserCore User that did the reassignment.
reassignmentError String Error message if reassignment failed.
sourceHostname String! Source instance hostname.
sourceName String Name of user in the source instance.
sourceUserIdentifier String! ID of the user in the source instance.
sourceUsername String Username of user in the source instance.
status ImportSourceUserStatus! Status of the mapping.

ImportSourceUserConnection#

Paginated collection of ImportSourceUser. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
shifts IncidentManagementOncallShiftConnection Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for shifts:
endTime (Time!)
End of timeframe to include shifts for. Cannot exceed one month after start.
startTime (Time!)
Start of timeframe to include shifts for.
startsAt Time Start date of the on-call rotation.

IncidentManagementOncallRotationConnection#

Paginated collection of IncidentManagementOncallRotation. See Standard connection fields for the fields available on every connection.

IncidentManagementOncallSchedule#

Describes an incident management on-call schedule.

Fields#

Name Type Description
description String Description of the on-call schedule.
iid String! Internal ID of the on-call schedule.
name String! Name of the on-call schedule.
oncallUsers [UserCore!]
rotation IncidentManagementOncallRotation On-call rotation for the on-call schedule.

Arguments for rotation:
id (IncidentManagementOncallRotationID!)
ID of the on-call rotation.
rotations IncidentManagementOncallRotationConnection! On-call rotations for the on-call schedule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
timezone String! Time zone of the on-call schedule.

IncidentManagementOncallScheduleConnection#

Paginated collection of IncidentManagementOncallSchedule. See Standard connection fields for the fields available on every connection.

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.

IncidentManagementOncallShiftConnection#

Paginated collection of IncidentManagementOncallShift. See Standard connection fields for the fields available on every connection.

InheritedCiVariable#

CI/CD variables a project inherits from its parent group and ancestors.

Fields#

Name Type Description
description String Description of the variable.
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.
hidden Boolean Indicates whether the variable is hidden.
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.

InheritedCiVariableConnection#

Paginated collection of InheritedCiVariable. See Standard connection fields for the fields available on every connection.

InstanceAmazonS3ConfigurationType#

Stores instance level Amazon S3 configurations for audit event streaming.

Implements: AmazonS3ConfigurationInterface

Fields#

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
active Boolean! Active status of the destination.
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.

InstanceAmazonS3ConfigurationTypeConnection#

Paginated collection of InstanceAmazonS3ConfigurationType. See Standard connection fields for the fields available on every connection.

InstanceAuditEventNamespaceFilter#

Represents a subgroup or project filter that belongs to an instance level external audit event streaming destination.

Fields#

Name Type Description
externalStreamingDestination InstanceAuditEventStreamingDestination! Destination to which the filter belongs.
id ID! ID of the filter.
namespace Namespace! Group or project namespace the filter belongs to.

InstanceAuditEventStreamingDestination#

Represents an external destination to stream instance level audit events.

Implements: AuditEventStreamingDestinationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
category String! Category of the external destination to send audit events to.
config JSON! Config of the external destination.
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.
namespaceFilters [InstanceAuditEventNamespaceFilter!] List of subgroup or project filters for the destination.
secretToken String! Secret token for the destination, will be non-empty value only for http category.

InstanceAuditEventStreamingDestinationConnection#

Paginated collection of InstanceAuditEventStreamingDestination. See Standard connection fields for the fields available on every connection.

InstanceExternalAuditEventDestination#

Represents an external resource to send instance audit events to.

Implements: ExternalAuditEventDestinationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

InstanceExternalAuditEventDestinationConnection#

Paginated collection of InstanceExternalAuditEventDestination. See Standard connection fields for the fields available on every connection.

InstanceGoogleCloudLoggingConfigurationType#

Stores instance level Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Implements: GoogleCloudLoggingConfigurationInterface

Fields#

Name Type Description
active Boolean! Active status of the destination.
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.

InstanceGoogleCloudLoggingConfigurationTypeConnection#

Paginated collection of InstanceGoogleCloudLoggingConfigurationType. See Standard connection fields for the fields available on every connection.

InstanceSecurityDashboard#

Fields#

Name Type Description
clusterAgents ClusterAgentConnection Cluster agents associated with projects selected in the Instance Security Dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for clusterAgents:
hasRemoteDevelopmentAgentConfig (Boolean)
Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled (Boolean)
Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities (Boolean)
Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig (Boolean)
Returns only cluster agents which have an associated workspaces agent config.
projects ProjectConnection! Projects selected in Instance Security Dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
search (String)
Search query, which can be for the project name, a path, or a description.
vulnerabilityGrades [VulnerableProjectsByGrade!]! Represents vulnerable project counts for each grade.

Arguments for vulnerabilityGrades:
letterGrade (VulnerabilityGrade)
Filter the response by given letter grade.
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilitySeveritiesCount VulnerabilitySeveritiesCount Counts for each vulnerability severity from projects selected in Instance Security Dashboard.

Arguments for vulnerabilitySeveritiesCount:
capped (Boolean)
Default value is false. When set to true, the count returned for each severity is capped at a maximum of 1001. Ignored when used along with any argument that requires advanced vulnerability management.
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Introduced as an experiment in GitLab 17.7.

Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Filter by policy auto dismissed. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by scanner.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref scope. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by token status.

IntegerExpression#

An expression with an integer value.

Implements: ExpressionInterface

Fields#

Name Type Description
field String! Field the expression applies to.
operator String! Operator of the expression.
value Int! Integer value of the expression.

IntegrationExclusion#

An integration to override the level settings of instance specific integrations.

Fields#

Name Type Description
group Group Group that has been excluded from the instance specific integration.
project Project Project that has been excluded from the instance specific integration.

IntegrationExclusionConnection#

Paginated collection of IntegrationExclusion. See Standard connection fields for the fields available on every connection.

IssuableMetricImageUploadRegistry#

Represents the Geo replication and verification state of a issuable_metric_image_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the IssuableMetricImageUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the IssuableMetricImageUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this IssuableMetricImageUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the IssuableMetricImageUploadRegistry.
issuableMetricImageUploadId ID! ID of the Issuable Metric Image Upload.
lastSyncFailure String Error message during sync of the IssuableMetricImageUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the IssuableMetricImageUploadRegistry.
missingOnPrimary Boolean Indicate if the IssuableMetricImageUploadRegistry is missing on primary.
modelRecordId Int ID of the IssuableMetricImageUploadRegistry's model record.
retryAt Time Timestamp after which the IssuableMetricImageUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the IssuableMetricImageUploadRegistry.
state RegistryState Sync state of the IssuableMetricImageUploadRegistry.
verificationChecksum String The local checksum of the IssuableMetricImageUploadRegistry.
verificationChecksumMismatched String The expected checksum of the IssuableMetricImageUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the IssuableMetricImageUploadRegistry.
verificationRetryAt Time Timestamp after which the IssuableMetricImageUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the IssuableMetricImageUploadRegistry.
verificationStartedAt Time Timestamp when the verification of IssuableMetricImageUploadRegistry started.
verificationState VerificationStateEnum Verification state of the IssuableMetricImageUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the IssuableMetricImageUploadRegistry.

IssuableMetricImageUploadRegistryConnection#

Paginated collection of IssuableMetricImageUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

IssuableResourceLinkConnection#

Paginated collection of IssuableResourceLink. See Standard connection fields for the fields available on every connection.

Issue#

Implements: CurrentUserTodos, NoteableInterface, Todoable

Fields#

Name Type Description
alertManagementAlert AlertManagementAlert Deprecated in GitLab 15.6. Use alert_management_alerts.
alertManagementAlerts AlertManagementAlertConnection Alert Management alerts associated to this issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementAlerts:
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 the criteria.
statuses ([AlertManagementStatus!])
Alerts with the specified statues. For example, [TRIGGERED].
assignees UserCoreConnection Assignees of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
author UserCore! User that created the issue.
availableQuickActions [QuickActionCommand!] Quick actions available to the current user on the issue.
blocked Boolean! Indicates the issue is blocked.
blockedByCount Int Count of issues blocking the issue.
blockedByIssues IssueConnection Issues blocking the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingCount Int! Count of issues the issue is blocking.
closedAsDuplicateOf Issue Issue the issue was closed as a duplicate of.
closedAt Time Timestamp of when the issue was closed.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
customerRelationsContacts CustomerRelationsContactConnection Customer relations contacts of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
description String Description of the issue.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designCollection DesignCollection Collection of design images associated with the issue.
discussionLocked Boolean! Indicates discussion is locked on the issue.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
downvotes Int! Number of downvotes the issue has received.
dueDate Time Due date of the issue.
emailsDisabled Boolean! Deprecated in GitLab 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 Deprecated in GitLab 17.5. Replaced by WorkItem type.
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 as an experiment in GitLab 16.5.

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 String! Internal ID of the issue.
issuableResourceLinks IssuableResourceLinkConnection Issuable resource links of the incident issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issuableResourceLinks:
incidentId (IssueID!)
ID of the incident.
iteration Iteration Iteration of the issue.
labels LabelConnection Labels of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems LinkedWorkItemTypeConnection Introduced as an experiment in GitLab 17.8.

Work items linked to the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedWorkItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
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.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
participants UserCoreConnection List of participants in the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
projectId Int ID of the issue project.
reference String! Internal reference of the issue. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Boolean option specifying whether the reference should be returned in full.
relatedMergeRequests MergeRequestConnection Merge requests related to the issue. This field can only be resolved for one issue in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
relatedVulnerabilities VulnerabilityConnection Related vulnerabilities of the issue. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
startDate Time Start date of the issue.
state IssueState! State of the issue.
status WorkItemStatus Introduced as an experiment in GitLab 18.0.

Status 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String! Title of the issue.
titleHtml String HTML 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.
workItemType WorkItemType! Type assigned to the issue.

IssueConnection#

Paginated collection of Issue. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
weight Int! Total weight of issues collection.

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.
adminIssueRelation Boolean! If true, the user can perform admin_issue_relation on this resource.
cloneIssue Boolean! If true, the user can perform clone_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.
moveDesign Boolean! If true, the user can perform move_design on this resource.
moveIssue Boolean! If true, the user can perform move_issue 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.

Implements: TimeboxReportInterface

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.
group Group! Group of the iteration.
id ID! ID of the iteration.
iid String! Internal ID of the iteration.
iterationCadence IterationCadence! Cadence of the iteration.
report TimeboxReport Historically accurate report about the timebox.

Arguments for report:
fullPath (String)
Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.
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.

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 the cadence.
id IterationsCadenceID! Global ID of the iteration cadence.
iterationsInAdvance Int Number of future iterations to schedule in addition to the current one.
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.

IterationCadenceConnection#

Paginated collection of IterationCadence. See Standard connection fields for the fields available on every connection.

IterationConnection#

Paginated collection of Iteration. See Standard connection fields for the fields available on every connection.

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.

JiraImportConnection#

Paginated collection of JiraImport. See Standard connection fields for the fields available on every connection.

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.

JiraProjectConnection#

Paginated collection of JiraProject. See Standard connection fields for the fields available on every connection.

JiraService#

Implements: Service

Fields#

Name Type Description
active Boolean Indicates if the service is active.
projects JiraProjectConnection List of all Jira projects fetched through Jira REST API. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
name (String)
Project name or key.
serviceType ServiceType Type of the service.
type String Class name of the service.

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.
checksumMismatch Boolean Indicate if the checksums of the JobArtifactRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the JobArtifactRegistry was created.
dataManagementDetailsPath String Path to the data management view for this JobArtifactRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the JobArtifactRegistry is missing on primary.
modelRecordId Int ID of the JobArtifactRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the JobArtifactRegistry in case of mismatch.
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 of JobArtifactRegistry started.
verificationState VerificationStateEnum Verification state of the JobArtifactRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the JobArtifactRegistry.

JobArtifactRegistryConnection#

Paginated collection of JobArtifactRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

JobNeedUnionConnection#

Paginated collection of JobNeedUnion. See Standard connection fields for the fields available on every connection.

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 GitLab Relay (KAS) is enabled.
externalK8sProxyUrl String URL used by the Kubernetes tooling to communicate with the KAS Kubernetes API proxy.
externalUrl String URL used by the agents to communicate with the server.
version String KAS version.

Key#

Represents an SSH key.

Implements: Todoable

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.
name String Name or title of the object.
title String! Title of the key.
webUrl String URL of the object.

KubernetesAnnotation#

Annotation to apply to associated Kubernetes objects of a workspace.

Fields#

Name Type Description
key String! Key of the annotation.
value String! Value of the annotation.

KubernetesLabel#

Label to apply to associated Kubernetes objects of a workspace.

Fields#

Name Type Description
key String! Key of the label.
value String! Value of the label.

Label#

Implements: LabelInterface

Fields#

Name Type Description
archived Boolean! Indicates the label is archived.
color String! Background color of the label.
createdAt Time! When the label was created.
description String Description of the label (Markdown rendered as HTML for caching).
descriptionHtml String GitLab Flavored Markdown rendering of description.
id LabelID! Global ID of the label.
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 the label was last updated.

LabelConnection#

Paginated collection of Label. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

Represents an instance-level LDAP link.

Fields#

Name Type Description
adminMemberRole AdminMemberRole! Custom admin member role.
cn String Common Name (CN) of the LDAP group.
createdAt Time! Timestamp of when the role link was created.
filter String Search filter for the LDAP group.
id ID! ID of the LDAP link.
lastSuccessfulSyncAt Time Timestamp of the last successful sync.
provider LdapProvider! LDAP provider for the LDAP link.
syncEndedAt Time Timestamp of when the last sync ended.
syncError String Error message if the sync has failed.
syncStartedAt Time Timestamp of when the last sync started.
syncStatus LdapAdminRoleSyncStatus Status of the last sync.

LdapAdminRoleLinkConnection#

Paginated collection of LdapAdminRoleLink. See Standard connection fields for the fields available on every connection.

LdapProvider#

Represents a LDAP provider.

Fields#

Name Type Description
id String ID of the LDAP provider.
label String Display name of the LDAP provider.

LfsObjectRegistry#

Represents the Geo sync and verification state of an LFS object.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the LfsObjectRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the LfsObjectRegistry was created.
dataManagementDetailsPath String Path to the data management view for this LfsObjectRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the LfsObjectRegistry is missing on primary.
modelRecordId Int ID of the LfsObjectRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the LfsObjectRegistry in case of mismatch.
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 of LfsObjectRegistry started.
verificationState VerificationStateEnum Verification state of the LfsObjectRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the LfsObjectRegistry.

LfsObjectRegistryConnection#

Paginated collection of LfsObjectRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

License#

Fields#

Name Type Description
name String! Name of the license.
policyViolations [PolicyDismissal!] Policy dismissals associated with the license for the dependency.
spdxIdentifier String Name of the SPDX identifier.
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 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.

LicenseHistoryEntryConnection#

Paginated collection of LicenseHistoryEntry. See Standard connection fields for the fields available on every connection.

LicensedFeatureAvailability#

Represents the availability of a licensed feature for a namespace or project.

Fields#

Name Type Description
available Boolean! Whether the feature is available on the current plan.
requiredPlan String The minimum plan required to access this feature. Returns null if the required plan cannot be determined.

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.
workItemState WorkItemState! State of the linked work item.

LinkedWorkItemTypeConnection#

Paginated collection of LinkedWorkItemType. See Standard connection fields for the fields available on every connection.

Location#

Fields#

Name Type Description
ancestors [AncestorType!] Ancestors of the dependency.
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.
topLevel Boolean Is top level dependency.

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.

Represents links to perform actions on the model.

Fields#

Name Type Description
showPath String Path to the details page of the model.

Represents links to perform actions on the model version.

Fields#

Name Type Description
importPath String File upload path for the machine learning model.
packagePath String Path to the package of the model version.
showPath String Path to the details page of the model version.

MavenLocalUpstream#

Represents a Maven local upstream registry.

Fields#

Name Type Description
cacheValidityHours Int! Introduced as an experiment in GitLab 19.5.

Time before the cache expires for the local upstream registry.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the local upstream registry.
localGroup MavenLocalUpstreamTargetGroup Introduced as an experiment in GitLab 19.5.

Group the local upstream registry serves packages from. Null when the local upstream registry targets a project, or when the user cannot read the group.
localProject MavenLocalUpstreamTargetProject Introduced as an experiment in GitLab 19.5.

Project the local upstream registry serves packages from. Null when the local upstream registry targets a group, or when the user cannot read the project.
metadataCacheValidityHours Int! Introduced as an experiment in GitLab 19.5.

Time before the cache expires for Maven metadata.
name String! Introduced as an experiment in GitLab 19.5.

Name of the local upstream registry.

MavenLocalUpstreamTargetGroup#

Group a Maven local upstream registry serves packages from.

Fields#

Name Type Description
fullPath ID! Introduced as an experiment in GitLab 19.5.

Full path of the group.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the group.
webUrl String Introduced as an experiment in GitLab 19.5.

Web URL of the group.

MavenLocalUpstreamTargetProject#

Project a Maven local upstream registry serves packages from.

Fields#

Name Type Description
fullPath ID! Introduced as an experiment in GitLab 19.5.

Full path of the project.
id ID! Introduced as an experiment in GitLab 19.5.

ID of the project.
webUrl String Introduced as an experiment in GitLab 19.5.

Web URL of the project.

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.

MavenRegistry#

Represents a Maven virtual registry.

Implements: RegistryInterface

Fields#

Name Type Description
description String Description of the virtual registry.
id ID! ID of the virtual registry.
name String! Name of the virtual registry.
updatedAt Time! Timestamp of when the virtual registry was updated.

MavenRegistryConnection#

Paginated collection of MavenRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MavenRegistryDetails#

Represents Maven virtual registry details.

Implements: RegistryInterface

Fields#

Name Type Description
description String Description of the virtual registry.
id ID! ID of the virtual registry.
name String! Name of the virtual registry.
registryUpstreams [MavenRegistryUpstreamWithUpstream!]! Introduced as an experiment in GitLab 18.7.

List of registry upstreams for the Maven virtual registry.
updatedAt Time! Timestamp of when the virtual registry was updated.

MavenRegistryUpstreamWithRegistry#

Represents a Maven virtual registry upstream and its relationship to the registry.

Implements: RegistryUpstreamInterface

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
position Int! Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.
registry MavenRegistry! Introduced as an experiment in GitLab 18.6.

Maven registry associated with the registry upstream.

MavenRegistryUpstreamWithUpstream#

Represents a Maven virtual registry upstream and its relationship to the upstream.

Implements: RegistryUpstreamInterface

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 18.2.

ID of the registry upstream.
position Int! Introduced as an experiment in GitLab 18.2.

Position of the upstream registry in an ordered list.
targetUpstream MavenTargetUpstream Introduced as an experiment in GitLab 19.5.

Maven remote or local upstream associated with the registry upstream.
upstream MavenUpstream! Introduced as an experiment in GitLab 18.7.

Maven upstream associated with the registry upstream.

MavenUpstream#

Represents a Maven upstream registry.

Implements: UpstreamInterface

Fields#

Name Type Description
cacheValidityHours Int! Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
description String Introduced as an experiment in GitLab 18.1.

Description of the upstream registry.
id ID! Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
metadataCacheValidityHours Int! Introduced as an experiment in GitLab 18.4.

Time before the cache expires for Maven metadata.
name String! Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCount Int! Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
rulesCount Int! Introduced as an experiment in GitLab 18.10.

Total number of rules for the upstream.
url String! Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.
username String Introduced as an experiment in GitLab 18.1.

Username to sign in to the upstream registry.

MavenUpstreamCacheEntry#

Represents a cache entry for a Maven upstream.

Implements: EntryInterface

Fields#

Name Type Description
contentType String! Introduced as an experiment in GitLab 18.9.

Content type of the cached file.
createdAt Time! Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was created.
downloadedAt Time Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last downloaded.
downloadsCount Int! Introduced as an experiment in GitLab 18.9.

Number of times the entry has been downloaded.
fileMd5 String Introduced as an experiment in GitLab 18.9.

MD5 hash of the cached file.
fileSha1 String! Introduced as an experiment in GitLab 18.9.

SHA1 hash of the cached file.
id String! Introduced as an experiment in GitLab 18.9.

ID of the cache entry.
relativePath String! Introduced as an experiment in GitLab 18.9.

Relative path of the cached entry.
size BigInt! Introduced as an experiment in GitLab 18.9.

Size of the cached file in bytes.
updatedAt Time! Introduced as an experiment in GitLab 18.9.

Timestamp when the cache entry was last updated.
upstreamCheckedAt Time Introduced as an experiment in GitLab 18.9.

Timestamp when the upstream was last checked.
upstreamEtag String Introduced as an experiment in GitLab 18.9.

ETag from the upstream source.

MavenUpstreamCacheEntryConnection#

Paginated collection of MavenUpstreamCacheEntry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MavenUpstreamConnection#

Paginated collection of MavenUpstream. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MavenUpstreamDetails#

Represents Maven upstream registry details.

Implements: UpstreamInterface

Fields#

Name Type Description
allowRules [MavenUpstreamRule!]! Introduced as an experiment in GitLab 18.10.

Allow rules for the upstream.
cacheEntries MavenUpstreamCacheEntryConnection Introduced as an experiment in GitLab 18.7.

Represents cache entries for the upstream. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cacheEntries:
search (String)
Search cache entries by relative path.
cacheValidityHours Int! Introduced as an experiment in GitLab 18.1.

Time before the cache expires for the upstream registry.
denyRules [MavenUpstreamRule!]! Introduced as an experiment in GitLab 18.10.

Deny rules for the upstream.
description String Introduced as an experiment in GitLab 18.1.

Description of the upstream registry.
id ID! Introduced as an experiment in GitLab 18.1.

ID of the upstream registry.
metadataCacheValidityHours Int! Introduced as an experiment in GitLab 18.4.

Time before the cache expires for Maven metadata.
name String! Introduced as an experiment in GitLab 18.1.

Name of the upstream registry.
registriesCount Int! Introduced as an experiment in GitLab 18.6.

Number of registries using the upstream.
registryUpstreams [MavenRegistryUpstreamWithRegistry!]! Introduced as an experiment in GitLab 18.2.

Represents the upstream registry for the upstream which contains the position data.
rulesCount Int! Introduced as an experiment in GitLab 18.10.

Total number of rules for the upstream.
url String! Introduced as an experiment in GitLab 18.1.

URL of the upstream registry.
username String Introduced as an experiment in GitLab 18.1.

Username to sign in to the upstream registry.

MavenUpstreamRule#

Represents a Maven upstream rule.

Implements: RuleInterface

Fields#

Name Type Description
createdAt Time! When the rule was created.
id VirtualRegistriesPackagesMavenUpstreamRuleID! Global ID of the rule.
pattern String! Pattern for the rule.
patternType MavenUpstreamPatternType! Type of pattern (WILDCARD or REGEX).
targetCoordinate MavenUpstreamTargetCoordinate! Target coordinate for the rule.

MemberApproval#

Represents a Member Approval queued for role promotion.

Fields#

Name Type Description
createdAt Time Timestamp when the member approval was created.
member MemberInterface Member associated with the member approval object.
memberRoleId ID ID of the member role.
newAccessLevel AccessLevel New GitLab::Access level requested for the member.
oldAccessLevel AccessLevel Existing GitLab::Access level for the member.
requestedBy UserCore User who requested the member promotion.
reviewedBy UserCore User who reviewed the member promotion.
status String Status for the member approval request (approved, denied, pending).
updatedAt Time Timestamp when the member approval was last updated.
user UserCore User that is associated with the member approval object.

MemberApprovalConnection#

Paginated collection of MemberApproval. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MemberInterfaceConnection#

Paginated collection of MemberInterface. See Standard connection fields for the fields available on every connection.

MemberRole#

Represents a member role.

Implements: CustomRoleInterface, RoleInterface

Fields#

Name Type Description
baseAccessLevel AccessLevel! Introduced as an experiment in GitLab 16.5.

Base access level for the custom role.
createdAt Time! Timestamp of when the member role was created.
dependentSecurityPolicies [ApprovalPolicy!] Array of security policies dependent on the custom role.
description String Role description.
detailsPath String Introduced as an experiment in GitLab 17.4.

URL path to the role details webpage.
editPath String! Introduced as an experiment in GitLab 16.11.

Web UI path to edit the custom role.
enabledPermissions CustomizableStandardPermissionConnection! Introduced as an experiment in GitLab 16.5.

Array of all permissions enabled for the custom role. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Role ID.
membersCount Int Introduced as an experiment in GitLab 17.3.

Number of times the role has been directly assigned to a group or project member.
name String Role name.
usersCount Int Introduced as an experiment in GitLab 17.5.

Number of users who have been directly assigned the role in at least one group or project.

MemberRoleConnection#

Paginated collection of MemberRole. See Standard connection fields for the fields available on every connection.

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 the access level.
group AccessLevelGroup Group associated with the access level.
memberRole MemberRole Custom role associated with the access level.
user AccessLevelUser User associated with the access level.

MergeAccessLevelConnection#

Paginated collection of MergeAccessLevel. See Standard connection fields for the fields available on every connection.

MergeRequest#

Implements: CurrentUserTodos, NoteableInterface, Todoable

Fields#

Name Type Description
aiSuggestedReviewers AiSuggestedReviewerConnection Introduced as an experiment in GitLab 19.4.

AI-recommended reviewers for the merge request. Returns null unless the recommend reviewers flow is enabled for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
allowCollaboration Boolean Indicates if members of the target project can push to the fork.
allowsMultipleAssignees Boolean! Allows assigning multiple users to a merge request.
allowsMultipleReviewers Boolean! Allows assigning multiple reviewers to a merge request.
approvalState MergeRequestApprovalState! Information relating to rules that must be satisfied to merge the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
assignees MergeRequestAssigneeConnection Assignees of the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
author MergeRequestAuthor User who created the 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.
availableQuickActions [QuickActionCommand!] Quick actions available to the current user on the merge request.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
blockingMergeRequests BlockingMergeRequests Introduced as an experiment in GitLab 16.5.

Merge requests that block another merge request from merging.
changeRequesters UserCoreConnection Users that have requested changes to the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
closedAt Time Timestamp of when the merge request was closed, null if not closed.
codequalityReportsComparer CodequalityReportsComparer Code quality reports comparison reported on the merge request.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitCount Int Number of commits in the merge request.
commits CommitConnection Merge request commits. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitsWithoutMergeCommits CommitConnection Merge request commits excluding merge commits. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
committers UserCoreConnection Users who have added commits to the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
conflictFiles [MergeRequestConflict!] Introduced as an experiment in GitLab 19.4.

Files with conflicts that prevent the merge request from being merged, including raw Git conflict markers. Null unless the merge request cannot be merged and the current user can push to the source branch. This field can only be resolved once per request.
conflictStatus MergeRequestConflictStatus Introduced as an experiment in GitLab 19.4.

Why conflict files are or are not available. Use alongside conflictFiles to distinguish permission errors, unchecked mergeability, and missing branches.
conflicts Boolean! Indicates if the merge request has conflicts.
createdAt Time! Timestamp of when the merge request was created.
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
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.
diffRefs DiffRefs References of the base SHA, the head SHA, and the start SHA for the merge request.
diffStats [DiffStats!] Details about which files were changed in the merge request.

Arguments for diffStats:
path (String)
Specific file path.
diffStatsSummary DiffStatsSummary Summary of which files were changed in the merge request.
diffs DiffConnection Introduced as an experiment in GitLab 19.4.

Diffs of the merge request, including per-file patch text. Files whose content is omitted because they exceed size limits are reported with the collapsed or too_large flags. When a page exceeds the diff size limits, later files are omitted entirely and the connection overflow field is set. Supports forward-only pagination. This field can only be resolved 10 times in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for diffs:
expanded (Boolean)
Return full patch text even for files that would otherwise be collapsed for size.
discussionLocked Boolean! Indicates if comments on the merge request are locked to members only.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
discussionsWithActivity DiscussionConnection! Introduced as an experiment in GitLab 19.2.

Discussions on the merge request, including synthetic system notes generated from resource events such as label, milestone, and state changes. Supports forward-only pagination. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for discussionsWithActivity:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
sort (WorkItemDiscussionsSort)
Sort order for the discussions.
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.
duoDependencyBumpBreakingChangesAvailable Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether the GitLab Duo resolve dependency bump breaking changes flow can be triggered for the merge request.
duoWorkflowLinks DuoWorkflowMergeRequestLinkConnection GitLab Duo Agent Platform sessions linked to the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowLinks:
linkType (DuoWorkflowMergeRequestLinkType)
Filter links by their link type.
duoWorkflows DuoWorkflowConnection Introduced as an experiment in GitLab 18.10.

Duo Workflow sessions associated with the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
findingReportsComparer FindingReportsComparer Introduced as an experiment in GitLab 16.1.

Vulnerability finding reports comparison reported on the merge request.

Arguments for findingReportsComparer:
reportType (ComparableSecurityReportType!)
Filter vulnerability findings by report type.
scanMode (ScanModeEnum)
Filter results by scan mode.
forceRemoveSourceBranch Boolean Indicates if the project settings will lead to source branch deletion after merge.
groupedApprovalsLeft Int Introduced as an experiment in GitLab 19.4.

Number of approvals left, counting Code Owner rules that share a section and approvers as a single rule.
groupedApprovalsRequired Int Introduced as an experiment in GitLab 19.4.

Number of approvals required, counting Code Owner rules that share a section and approvers as a single rule.
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.
hidden Boolean Indicates the merge request is hidden because the author has been banned.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkedWorkItems [MergeRequestLinkedWorkItem!] Deprecated in GitLab 19.2. Use workItemRelations instead.

Arguments for linkedWorkItems:
types ([MergeRequestWorkItemLinkType!])
Filter by link types. Returns all types if not specified.
mergeAfter Time Date after which the merge request can be merged.
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 as an experiment in GitLab 16.2.

Diff versions of a merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
mergeStatus String Deprecated in GitLab 14.0. Renamed. Use MergeRequest.mergeStatusEnum instead.
mergeStatusEnum MergeStatus Merge status of the merge request.
mergeTrainCar MergeTrainCar Introduced as an experiment in GitLab 17.2.

Represents the merge request in a merge train.
mergeTrainIndex Int Deprecated in GitLab 17.4. Use index on MergeTrains::CarType instead.
mergeTrainsCount Int Deprecated in GitLab 17.4. Use count from cars connection on MergeTrains::TrainType instead.
mergeUser UserCore User who merged the merge request or set it to auto-merge.
mergeWhenPipelineSucceeds Boolean Deprecated in GitLab 17.11. Renamed. Use MergeRequest.autoMergeEnabled instead.
mergeabilityChecks [MergeRequestMergeabilityCheck!]! Introduced as an experiment in GitLab 16.5.

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.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
participants MergeRequestParticipantConnection Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipelineCreationRequests [CiPipelineCreationRequest!]! Pipeline creation requests for the merge request.
pipelines PipelineConnection Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelines:
ids ([ID!])
Filter pipelines by their Global IDs. Maximum 20 IDs per request.
ref (String)
Filter pipelines by the ref they are run for.
refType (RefType)
Type of ref.
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 the date.
updatedBefore (Time)
Pipelines updated before the date.
username (String)
Filter pipelines by the user that triggered the pipeline.
policiesOverridingApprovalSettings [PolicyApprovalSettingsOverride!] Approval settings that are overridden by the policies for the merge request.
policyBypassStatuses [PolicyBypassStatus!] Introduced as an experiment in GitLab 18.5.

List of bypass settings for security policies.
policyViolations PolicyViolationDetails Policy violations reported on the merge request.
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.
reference String! Internal reference of the merge request. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Boolean option specifying whether the reference should be returned in full.
resolvableDiscussionsCount Int Number of user discussions that are resolvable in the merge request.
resolvedDiscussionsCount Int Number of user discussions that are resolved in the merge request.
resourceLabelEvents MergeRequestResourceLabelEventConnection Label events of the merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for resourceLabelEvents:
labelId (LabelID)
Global ID of the label to filter the label events.
retargeted Boolean Indicates if merge request was retargeted.
reviewers MergeRequestReviewerConnection Users from whom a review has been requested. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
riskAssessment MergeRequestRiskAssessment Introduced as an experiment in GitLab 19.4.

Risk assessment for the merge request. Ultimate only.
securityAutoFix Boolean Deprecated in GitLab 16.11. Security Auto Fix experiment feature was removed. It was always hidden behind security_auto_fix feature flag.
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.
squashReadOnly Boolean! Indicates if squashReadOnly is enabled.
stack [MergeRequest!] Other open merge requests in the same stack as this merge request, ordered from the top of the stack to the bottom. Returns null if this merge request is not part of a stack, or if the stack contains more than 20 merge requests.
state MergeRequestState! State of the merge request.
subscribed Boolean! Indicates if the currently logged in user is subscribed to the merge request.
suggestedReviewers SuggestedReviewersType Suggested reviewers for merge request.
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.
targetBranchPath String Path to the target branch of the merge request.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String! Title of the merge request.
titleHtml String HTML 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.
webPath String! Web path of the merge request.
webUrl String Web URL of the merge request.
workItemRelations MergeRequestWorkItemRelationConnection Relations between this merge request and work items (closing or mentioned). This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemRelations:
types ([MergeRequestWorkItemLinkType!])
Filter by link types. Returns all types if not specified.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

MergeRequestAssignee#

A user assigned to a merge request.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

MergeRequestAssigneeConnection#

Paginated collection of MergeRequestAssignee. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MergeRequestAuthor#

The author of the merge request.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

MergeRequestConflict#

File with conflicts in a merge request that cannot be merged.

Fields#

Name Type Description
content String Raw content of the conflicting file, including Git conflict markers. Returns null for files with unsupported encodings (binary, non-UTF-8).
ourPath String Path of the conflicting file on the source branch.
theirPath String Path of the conflicting file on the target branch.

MergeRequestConnection#

Paginated collection of MergeRequest. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
totalTimeToMerge Float Total sum of time to merge, in seconds, for the collection of merge requests.

MergeRequestDiff#

A diff version of a merge request.

Fields#

Name Type Description
createdAt Time! Timestamp of when the diff was created.
updatedAt Time! Timestamp of when the diff was updated.

MergeRequestDiffConnection#

Paginated collection of MergeRequestDiff. See Standard connection fields for the fields available on every connection.

MergeRequestDiffRegistry#

Represents the Geo sync and verification state of a Merge Request diff.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the MergeRequestDiffRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the MergeRequestDiffRegistry was created.
dataManagementDetailsPath String Path to the data management view for this MergeRequestDiffRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the MergeRequestDiffRegistry is missing on primary.
modelRecordId Int ID of the MergeRequestDiffRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the MergeRequestDiffRegistry in case of mismatch.
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 of MergeRequestDiffRegistry started.
verificationState VerificationStateEnum Verification state of the MergeRequestDiffRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the MergeRequestDiffRegistry.

MergeRequestDiffRegistryConnection#

Paginated collection of MergeRequestDiffRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MergeRequestExternalIssue#

An external issue referenced by a merge request.

Fields#

Name Type Description
reference String! Reference of the external issue (e.g. JIRA-123).
title String Title of the external issue.
webUrl String URL of the external issue on the external tracker.

MergeRequestLinkedWorkItem#

A work item linked to a merge request.

Fields#

Name Type Description
externalIssue MergeRequestExternalIssue Linked external issue.
linkType MergeRequestWorkItemLinkType! Type of relationship between the merge request and work item.
workItem WorkItem Linked work item.

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.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

MergeRequestParticipantConnection#

Paginated collection of MergeRequestParticipant. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

MergeRequestResourceLabelEvent#

Label event on a merge request.

Fields#

Name Type Description
action ResourceLabelEventAction! Action of the label event.
createdAt Time! Timestamp of when the label event was created.
id ResourceLabelEventID! Global ID of the label event.
label Label Label associated with the event. Null if the label was deleted.
user UserCore User who triggered the event.

MergeRequestResourceLabelEventConnection#

Paginated collection of MergeRequestResourceLabelEvent. See Standard connection fields for the fields available on every connection.

MergeRequestReviewer#

A user assigned to a merge request as a reviewer.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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 the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

MergeRequestReviewerConnection#

Paginated collection of MergeRequestReviewer. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MergeRequestRiskAssessment#

Risk assessment for a merge request.

Fields#

Name Type Description
assessedAt Time When the assessment completed.
confidence Int Confidence in the score, from 0 to 100. Derived from how much of the change could be measured and whether the signals agreed.
confidenceTier MergeRequestRiskConfidenceTier Tier derived from the confidence score.
contributingSignals [MergeRequestRiskContributingSignal!]! What each signal contributed to the score.
domainTags [String!]! Risk domains the change touches, used to route specialist review.
duoWorkflowId Int ID of the Duo workflow session that produced the assessment.
missingSignals [MergeRequestRiskMissingSignal!]! Signals that could not be measured, which is why confidence may be low.
rationale String Plain-language explanation of the assessment.
risk Int Risk score from 0 to 100.
riskTier MergeRequestRiskTier Tier derived from the risk score.
stale Boolean! Whether the merge request has changed since it was assessed. Assessment runs once, so this is a notice rather than a trigger to re-run.
status MergeRequestRiskAssessmentStatus! Status of the assessment.

MergeRequestRiskContributingSignal#

Contribution a single signal made to a merge request risk score.

Fields#

Name Type Description
contribution Float! Points the signal added to the overall score.
detail String Human-readable explanation of the contribution.
label String Human-readable name of the signal or claim. Null when the key matches neither a registered signal nor a risk domain.
signal String! Name of the signal or claim.

MergeRequestRiskMissingSignal#

A signal that could not be measured for a merge request risk assessment.

Fields#

Name Type Description
label String Human-readable name of the signal or claim. Null when the key matches neither a registered signal nor a risk domain.
signal String! Name of the signal or claim.

MergeRequestSavedView#

Saved view on the merge request dashboard.

Fields#

Name Type Description
filters JSON! Merge request filters stored in the saved view.
id MergeRequestsSavedViewID! Global ID of the saved view.
name String! Name of the saved view.
userPermissions MergeRequestSavedViewPermissions! Permissions for the current user on the resource.

MergeRequestSavedViewConnection#

Paginated collection of MergeRequestSavedView. See Standard connection fields for the fields available on every connection.

MergeRequestSavedViewPermissions#

Check permissions for the current user on a merge request saved view.

Fields#

Name Type Description
deleteSavedView Boolean! If true, the user can perform delete_saved_view on this resource.
updateSavedView Boolean! If true, the user can perform update_saved_view on this resource.

MergeRequestWorkItemRelation#

A relation between a merge request and a work item.

Fields#

Name Type Description
fromMrDescription Boolean! Whether the relation was derived from a closing pattern in the merge request description.
id MergeRequestIssueID! Global ID of the merge request to work item relation.
linkType MergeRequestWorkItemLinkType! Type of relationship between the merge request and the work item.
workItem WorkItem Related work item.

MergeRequestWorkItemRelationConnection#

Paginated collection of MergeRequestWorkItemRelation. See Standard connection fields for the fields available on every connection.

MergeRequestsAggregationResponse#

Response for MergeRequests aggregation engine.

Fields#

Name Type Description
acceptanceRate Float Share of merge requests that were merged.
dimensions MergeRequestsAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
throughputCount Int Number of merged merge requests.
timeToMerge MergeRequestsAggregationResponseTimeToMergeMetrics Aggregated time_to_merge metrics.
timeToMergeQuantile Float Time to merge quantile in milliseconds.

Arguments for timeToMergeQuantile:
quantile (Float)
Quantile level between 0.0 and 1.0 (e.g. 0.5 for median).
totalCount Int Total number of merge requests.

MergeRequestsAggregationResponseConnection#

Paginated collection of MergeRequestsAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

MergeRequestsAggregationResponseDimensions#

Response dimensions for MergeRequests aggregation engine.

Fields#

Name Type Description
author UserCore Merge request author.
createdAt Date Merge request creation date.

Arguments for createdAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
createdByDuo Boolean Whether the merge request was created by a GitLab Duo session.
metricMergedAt Date Merge request merge date.

Arguments for metricMergedAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
stateId String Merge request state.
targetBranch String Target branch of the merge request.

MergeRequestsAggregationResponseTimeToMergeMetrics#

Aggregated time_to_merge metrics for MergeRequests aggregation engine.

Fields#

Name Type Description
max Int Maximum time to merge in seconds.
mean Float Mean time to merge in seconds.
min Int Minimum time to merge in seconds.
quantile Float Quantile of time to merge in seconds.

Arguments for quantile:
quantile (Float)
sum Float Sum of time to merge in seconds.

MergeRequestsAggregationScope#

Aggregation scope for MergeRequests. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated MergeRequestsAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

MergeTrain#

Represents a set of cars/merge_requests queued for merging.

Fields#

Name Type Description
cars MergeTrainCarConnection! Introduced as an experiment in GitLab 17.1.

Cars queued in the train. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cars:
activityStatus (MergeTrainStatus!)
Filter by the high-level status of the cars. Defaults to ACTIVE.
targetBranch String! Target branch of the car's merge request.

MergeTrainCar#

MergeTrainCar represents an attempt to merge a merge requestusing merge trains.

Fields#

Name Type Description
createdAt Time! Timestamp of when the car was created.
duration Int Duration of the car.
id MergeTrainsCarID! Global ID of the car.
index Int Zero-based position of the car in the merge train. Returns null if the car is not active in a merge train.
mergeRequest MergeRequest! Merge request the car contains.
mergedAt Time Timestamp of when the car was merged.
pipeline Pipeline Pipeline of the car.
status CarStatus! Status of the car.
targetBranch String! Target branch of the car's merge request.
targetProject Project! Project the car's MR targets.
updatedAt Time! Timestamp of when the car was last updated.
user UserCore! Creator of the car (user who added the merge request to the train).
userPermissions CarPermissions! Permissions for the current user on the resource.

MergeTrainCarConnection#

Paginated collection of MergeTrainCar. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

MergeTrainConnection#

Paginated collection of MergeTrain. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

Metadata#

Fields#

Name Type Description
enterprise Boolean! Enterprise edition.
featureFlags [GitlabInstanceFeatureFlag!]! Introduced as an experiment in GitLab 17.4.

Feature flags for the GitLab instance. External API consumers should read the feature flag guidance before using this field.

Arguments for featureFlags:
names ([String!]!)
Names of the feature flags to lookup (maximum of 20).
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 String! 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.

Implements: TimeboxReportInterface

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.
group Group Group of the milestone.
groupMilestone Boolean! Indicates if milestone is at group level.
id ID! ID of the milestone.
iid ID! Internal ID of the milestone.
project Project Project of the milestone.
projectMilestone Boolean! Indicates if milestone is at project level.
releases ReleaseConnection Releases associated with the milestone. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
report TimeboxReport Historically accurate report about the timebox.

Arguments for report:
fullPath (String)
Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.
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.
upcoming Boolean! Upcoming state of the milestone (a milestone is upcoming when the start date is in the future). Defaults to false when start date has not been set.
updatedAt Time! Timestamp of last milestone update.
webPath String! Web path of the milestone.

MilestoneConnection#

Paginated collection of Milestone. See Standard connection fields for the fields available on every connection.

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.
ciJob CiJob CI information about the job that created the candidate.
createdAt Time! Date of creation.
creator UserCore User that created the candidate.
eid String! MLflow uuid for the candidate.
id MlCandidateID! ID of the candidate.
iid Int! IID of the candidate scoped to project.
metadata MlCandidateMetadataConnection! Metadata entries for the candidate. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
metrics MlCandidateMetricConnection! Metrics for the candidate. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name of the candidate.
params MlCandidateParamConnection! Parameters for the candidate. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
status String Candidate status.

MlCandidateConnection#

Paginated collection of MlCandidate. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlCandidateMetadata#

Metadata for a candidate in the model registry.

Fields#

Name Type Description
id MlCandidateMetadataID! ID of the metadata.
name String Name of the metadata entry.
value String! Value set for the metadata entry.

MlCandidateMetadataConnection#

Paginated collection of MlCandidateMetadata. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlCandidateMetric#

Metric for a candidate in the model registry.

Fields#

Name Type Description
id MlCandidateMetricID! ID of the metric.
name String Name of the metric.
step Int! Step at which the metric was measured.
value Float! Value set for the metric.

MlCandidateMetricConnection#

Paginated collection of MlCandidateMetric. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlCandidateParam#

Parameter for a candidate in the model registry.

Fields#

Name Type Description
id MlCandidateParamID! ID of the parameter.
name String Name of the parameter.
value String! Value set for the parameter.

MlCandidateParamConnection#

Paginated collection of MlCandidateParam. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlExperiment#

Machine learning experiment in model experiments.

Fields#

Name Type Description
candidateCount Int! Number of candidates in the experiment.
candidates MlCandidateConnection Candidates of the experiment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp of when the experiment was created.
creator UserCore User who created the experiment.
id MlExperimentID! ID of the experiment.
modelId MlModelID ID of the model.
name String! Name of the experiment.
path String! Web URL of the experiment.
updatedAt Time! Timestamp of when the experiment was updated.

MlExperimentConnection#

Paginated collection of MlExperiment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlModel#

Machine learning model in the model registry.

Fields#

Name Type Description
_links MLModelLinks! Map of links to perform actions on the model.
author UserCore User that created the model.
candidateCount Int Count of candidates in the model.
candidates MlCandidateConnection Version candidates of the model. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Date of creation.
defaultExperimentPath String Path to default experiment page for the model.
description String Description of the model.
descriptionHtml String GitLab Flavored Markdown rendering of description.
id MlModelID! ID of the model.
latestVersion MlModelVersion Latest version of the model.
name String! Name of the model.
version MlModelVersion Version of the model.

Arguments for version:
modelVersionId (MlModelVersionID)
Id of the version to be fetched.
versionCount Int Count of versions in the model.
versions MlModelVersionConnection Versions of the model. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for versions:
orderBy (MlModelVersionsOrderBy)
Ordering column. Default is created_at.
sort (SortDirectionEnum)
Ordering column. Default is desc.
version (String)
Search for versions where the name includes the string.

MlModelConnection#

Paginated collection of MlModel. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MlModelVersion#

Version of a machine learning model.

Fields#

Name Type Description
_links MLModelVersionLinks! Map of links to perform actions on the model version.
artifactsCount Int Number of files in the package.
author UserCore User that created the model version.
candidate MlCandidate! Metrics, params and metadata for the model version.
createdAt Time! Date of creation.
description String Description of the version.
descriptionHtml String GitLab Flavored Markdown rendering of description.
id MlModelVersionID! ID of the model version.
packageId PackagesPackageID! Package for model version artifacts.
version String! Name of the version.

MlModelVersionConnection#

Paginated collection of MlModelVersion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

MttrOverTimeBucket#

Mean time to remediation for a single weekly (Monday to Sunday) bucket, with optional breakdowns by severity and report type.

Fields#

Name Type Description
byReportType [MttrOverTimeByReportType!]! Remediation metrics for the bucket broken down by report type.
bySeverity [MttrOverTimeBySeverity!]! Remediation metrics for the bucket broken down by severity.
count Int! Number of vulnerabilities remediated in the bucket. Denominator of the MTTR average.
endDate ISO8601Date! End of the weekly bucket (Sunday). Capped at the current date, so the most recent bucket may be partial.
mttr Float Mean time to remediation, in days (sumDays / count). Null when no vulnerabilities were remediated in the bucket.
startDate ISO8601Date! Start of the weekly bucket (Monday).
sumDays Float! Sum of remediation time, in days, across vulnerabilities remediated in the bucket. Numerator of the MTTR average.

MttrOverTimeByReportType#

Mean time to remediation for a single report type within a weekly bucket.

Fields#

Name Type Description
count Int! Number of vulnerabilities of the report type remediated in the bucket.
mttr Float Mean time to remediation for the report type, in days (sumDays / count). Null when the count is 0.
reportType VulnerabilityReportType! Report type the breakdown applies to.
sumDays Float! Sum of remediation time, in days, across vulnerabilities of the report type remediated in the bucket.

MttrOverTimeBySeverity#

Mean time to remediation for a single severity within a weekly bucket.

Fields#

Name Type Description
count Int! Number of vulnerabilities of the severity remediated in the bucket.
mttr Float Mean time to remediation for the severity, in days (sumDays / count). Null when the count is 0.
severity VulnerabilitySeverity! Severity the breakdown applies to.
sumDays Float! Sum of remediation time, in days, across vulnerabilities of the severity remediated in the bucket.

Namespace#

Implements: Todoable

Fields#

Name Type Description
achievements AchievementConnection Achievements for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for achievements:
ids ([AchievementsAchievementID!])
Filter achievements by IDs.
achievementsPath String Path for the namespace's achievements. Returns null if the namespace is not a group.
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.
addOnEligibleUsers AddOnUserConnection Introduced as an experiment in GitLab 16.5.

Users in the namespace hierarchy that add-ons are applicable for. This only applies to root namespaces. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for addOnEligibleUsers:
addOnPurchaseIds ([GitlabSubscriptionsAddOnPurchaseID!]!)
Global IDs of the add on purchases to find assignments for.
addOnType (GitlabSubscriptionsAddOnType!)
Type of add on to filter the eligible users by.
filterByAssignedSeat (String)
Filter users list by assigned seat.
search (String)
Search the user list.
sort (GitlabSubscriptionsUserSort)
Sort the user list.
additionalPurchasedStorageSize Float Additional storage purchased for the root namespace in bytes.
aiDomainSettings StringConnection Introduced as an experiment in GitLab 19.0.

List of allowed or denied domains for AI features. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiDomainSettings:
domainSettingType (AiDomainSettingType!)
Type of domain setting to retrieve.
search (String)
Filter domains by substring match.
aiSettings AiNamespaceSettings Introduced as an experiment in GitLab 18.8.

AI settings for the namespace.
approvalPolicies ApprovalPolicyConnection Approval Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for approvalPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
availableFeatures NamespaceAvailableFeatures! Introduced as an experiment in GitLab 18.3.

Features available on the namespace.
avatarUrl String URL to avatar image file of the namespace.
canPushInitialCommit Boolean! Introduced as an experiment in GitLab 18.11.

Whether the current user can push the initial commit to the default branch of new projects in the namespace.
ciCdSettings CiCdSettings Introduced as an experiment in GitLab 17.9.

Namespace CI/CD settings for the namespace.
complianceFrameworks ComplianceFrameworkConnection Compliance frameworks available to projects in this namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceFrameworks:
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.
sort (ComplianceFrameworkSort)
Sort compliance frameworks by the criteria.
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.
customFields CustomFieldConnection Introduced as an experiment in GitLab 17.10.

Custom fields configured for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customFields:
active (Boolean)
Filter for active fields. If false, excludes active fields. If true, returns only active fields.
fieldType (CustomFieldType)
Filter for selected field type.
search (String)
Search query for custom field name.
workItemTypeId (WorkItemsTypeID)
Filter custom fields associated to the given work item type.
description String Description of the namespace.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designatedAsCsp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the namespace is designated to centrally manage security policies.
fullName String! Full name of the namespace.
fullPath ID! Full path of the namespace.
id ID! ID of the namespace.
importSourceUsers ImportSourceUserConnection Introduced as an experiment in GitLab 17.2.

Import source users of the namespace. This field can only be resolved for one namespace in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for importSourceUsers:
search (String)
Query to search mappings by name or username of users on source instance.
sort (SourceUserSort)
Sort mapping of users on source instance to users on destination instance by the criteria.
statuses ([ImportSourceUserStatus!])
Filter mapping of users on source instance to users on destination instance by status.
lfsEnabled Boolean Indicates if Large File Storage (LFS) is enabled for namespace.
licensedFeatureAvailability LicensedFeatureAvailability! Introduced as an experiment in GitLab 18.11.

Check whether a licensed feature is available.

Arguments for licensedFeatureAvailability:
feature (LicensedFeature!)
Feature to check availability for (for example, EPICS).
licensedFeatures NamespaceAvailableFeatures! Introduced as an experiment in GitLab 18.1.

Licensed features available on the namespace.
lifecycleTemplates [WorkItemLifecycle!] Introduced as an experiment in GitLab 18.4.

Lifecycle templates available to the namespace.
lifecycles WorkItemLifecycleConnection Introduced as an experiment in GitLab 18.1.

Lifecycles of work items available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
linkPaths NamespacesLinkPaths Introduced as an experiment in GitLab 18.1.

Namespace relevant paths to create links on the UI.
markdownPaths MarkdownPaths Introduced as an experiment in GitLab 18.1.

Namespace relevant paths to create markdown links on the UI.
mergeRequestsEnabled Boolean! Introduced as an experiment in GitLab 18.3.

Indicates if merge requests are enabled for the namespace.
metadata NamespaceMetadata Introduced as an experiment in GitLab 18.6.

Metadata information for the namespace.
name String! Name of the namespace.
namespaceSettings NamespaceSettings Namespace settings for the namespace.
packageSettings PackageSettings Package settings for the namespace.
pagesDeployments PagesDeploymentConnection List of the namespaces's Pages Deployments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pagesDeployments:
active (Boolean)
Filter by active or inactive state.
sort (Sort)
Sort results.
versioned (Boolean)
Filter deployments that are versioned or unversioned.
path String! Path of the namespace.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
pipelineExecutionSchedulePolicies PipelineExecutionSchedulePolicyConnection Pipeline Execution Schedule Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionSchedulePolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
plan NamespacePlan Introduced as an experiment in GitLab 18.2.

Subscription plan associated with the namespace.
projects ProjectConnection! Projects within this namespace. Returns projects from the parent group if namespace is project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
archivedOnly (Boolean)
Return only archived projects.
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.
includeArchived (Boolean)
Include also archived projects.
includeSiblingProjects (Boolean)
Introduced as an experiment in GitLab 17.2.

Include also projects from parent group.
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 the criteria.
withIssuesEnabled (Boolean)
Return only projects with issues enabled.
withMergeRequestsEnabled (Boolean)
Return only projects with merge requests enabled.
withNamespaceDomainPages (Boolean)
Return only projects that use the namespace domain for pages projects.
remoteDevelopmentClusterAgents ClusterAgentConnection Deprecated in GitLab 17.8. Use workspacesClusterAgents. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for remoteDevelopmentClusterAgents:
filter (NamespaceClusterAgentFilter!)
Filter the types of cluster agents to return.
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.
rootNamespace Namespace! Top-level namespace of the namespace.
rootStorageStatistics RootStorageStatistics Aggregated storage statistics of the namespace. Only available for root namespaces.
savedViews WorkItemSavedViewTypeConnection Introduced as an experiment in GitLab 18.7.

Saved views associated with the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for savedViews:
id (WorkItemsSavedViewsSavedViewID)
ID of the saved view. Required when requesting work_items, filters, or filter_warnings fields.
search (String)
Search query for saved view name or description.
sort (WorkItemsSavedViewsSort)
Sort work items by criteria. Default is ID.
subscribedOnly (Boolean)
Whether to return only saved views subscribed to by the current user.
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanExecutionPolicies:
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.
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
scanResultPolicies ScanResultPolicyConnection Deprecated in GitLab 16.9. Use approvalPolicies. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanResultPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
securityPolicies SecurityPolicyTypeConnection Introduced as an experiment in GitLab 18.1.

List of security policies configured for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicies:
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship.
type (PolicyType)
Filter policies by type.
securityPolicyProject Project Security policy project assigned to the namespace.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.
sidebar NamespaceSidebar Introduced as an experiment in GitLab 17.6.

Data needed to render the sidebar for the namespace.
statuses WorkItemStatusConnection Introduced as an experiment in GitLab 18.1.

Statuses of work items available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for statuses:
ids ([WorkItemsStatusesStatusID!])
Filter statuses by ID. A max of 70 can be provided.
storageSizeLimit Float The storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement.
subscribedSavedViewLimit Int! Introduced as an experiment in GitLab 18.8.

Maximum number of subscribed saved views allowed on the namespace.
subscriptionHistory GitlabSubscriptionHistoryConnection Introduced as an experiment in GitLab 17.3.

Find subscription history records. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
targetedMessages [TargetedMessage!] Introduced as an experiment in GitLab 18.7.

Targeted messages for the namespace.
timelogCategories TimeTrackingTimelogCategoryConnection Introduced as an experiment in GitLab 15.3.

Timelog categories for the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
userPermissions NamespacePermissions! Permissions for the current user on the resource.
visibility String Visibility of the namespace.
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Introduced as an experiment in GitLab 17.7.

Vulnerability Management Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityManagementPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
webPath String Path of the namespace relative to the instance root.
webUrl String URL of the namespace.
workItem WorkItem Introduced as an experiment in GitLab 16.10.

Find a work item by IID directly associated with the namespace (project or group).

Arguments for workItem:
iid (String!)
IID of the work item.
workItemDescriptionTemplates WorkItemDescriptionTemplateConnection Introduced as an experiment in GitLab 17.6.

Work item description templates available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemDescriptionTemplates:
name (String)
Deprecated in GitLab 17.9. name and project ID are both required for fetching, use DescriptionTemplateContentInputType instead.
search (String)
Deprecated in GitLab 17.8. search on template names is performed on the FE only.
workItemMoveTargets [WorkItemMoveTarget!] Introduced as an experiment in GitLab 19.1.

Valid target work item types and a suggested default for moving work items of given source types into this namespace.

Arguments for workItemMoveTargets:
sourceFullPath (String!)
Full path of the source namespace. For example, gitlab-org/gitlab-foss.
sourceTypeIds ([WorkItemsTypeID!]!)
Global IDs of the source work item types to compute move targets for. A maximum of 50 IDs can be provided.
workItemSettings WorkItemSettings Introduced as an experiment in GitLab 19.0.

Work item settings for the namespace.
workItemStateCounts WorkItemStateCountsType Introduced as an experiment in GitLab 18.3.

Counts of work items by state for the namespace (project or group). Returns null for user namespaces.

Arguments for workItemStateCounts:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
excludeGroupWorkItems (Boolean)
Introduced as an experiment in GitLab 18.4.

Exclude group-level work items within the group and its descendants. Ignored for project namespaces.
excludeProjects (Boolean)
Introduced as an experiment in GitLab 17.5.

Exclude work items from projects within the group. Ignored for project namespaces.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeAncestors (Boolean)
Include work items from ancestor groups. Ignored for project namespaces.
includeArchived (Boolean)
Introduced as an experiment in GitLab 18.5.

Return work items from archived projects. Ignored for project namespaces.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
includeDescendants (Boolean)
Include work items from descendant groups and projects. Ignored for project namespaces.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe. Ignored for project namespaces.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemTypes WorkItemTypeConnection Introduced as an experiment in GitLab 17.2.

Work item types available to the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemTypes:
name (IssueType)
Deprecated in GitLab 19.0. Name-based filtering is no longer supported with introduction of configurable work item types in 19.0.
onlyAvailable (Boolean)
Introduced as an experiment in GitLab 18.6.

When true, returns only the available work item types for the current user. This experimental field will be removed in 19.0. Use canUserCreateItems and isFilterableListView fields from the WorkItemTypes API instead.
workItems WorkItemConnection Introduced as an experiment in GitLab 18.1.

Work items that belong to the namespace (project or group). Returns null for user namespaces. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItems:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
excludeGroupWorkItems (Boolean)
Introduced as an experiment in GitLab 18.4.

Exclude group-level work items within the group and its descendants. Ignored for project namespaces.
excludeProjects (Boolean)
Introduced as an experiment in GitLab 17.5.

Exclude work items from projects within the group. Ignored for project namespaces.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeAncestors (Boolean)
Include work items from ancestor groups. Ignored for project namespaces.
includeArchived (Boolean)
Introduced as an experiment in GitLab 18.5.

Return work items from archived projects. Ignored for project namespaces.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
includeDescendants (Boolean)
Include work items from descendant groups and projects. Ignored for project namespaces.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
timeframe (Timeframe)
List items overlapping the given timeframe. Ignored for project namespaces.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemsWidgets [String!] Introduced as an experiment in GitLab 18.2.

List of available widgets for the given work items.

Arguments for workItemsWidgets:
ids ([WorkItemsTypeID!]!)
Global ID array of work items types to fetch available widgets for. A max of 100 IDs can be provided at a time.
union (Boolean!)
When true, returns the union of widgets across all work item types. When false, returns only widgets common to all work item types.
workspacesClusterAgents ClusterAgentConnection Introduced as an experiment in GitLab 17.8.

Cluster agents in the namespace with workspaces capabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspacesClusterAgents:
filter (NamespaceClusterAgentFilter!)
Filter the types of cluster agents to return.

NamespaceAvailableFeatures#

Fields#

Name Type Description
hasBlockedIssuesFeature Boolean! Introduced as an experiment in GitLab 18.3.

Whether blocked issues are enabled for the namespace.
hasCustomFieldsFeature Boolean! Introduced as an experiment in GitLab 18.3.

Whether custom fields are enabled for the namespace.
hasDesignManagementFeature Boolean! Introduced as an experiment in GitLab 18.6.

Whether design management is enabled for the namespace.
hasDuoRemoteFlowsFeature Boolean! Introduced as an experiment in GitLab 18.6.

Whether Duo remote flows are enabled for the namespace.
hasEpicsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether epics are enabled for the namespace.
hasGroupBulkEditFeature Boolean! Introduced as an experiment in GitLab 18.3.

Whether group bulk edit is enabled for the namespace.
hasIssuableHealthStatusFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether issuable health status is enabled for the namespace.
hasIssueWeightsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether issue weights are enabled for the namespace.
hasIterationsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether iterations are enabled for the namespace.
hasLinkedItemsEpicsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether linked items epics are enabled for the namespace.
hasOkrsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether OKRs are enabled for the namespace.
hasQualityManagementFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether quality management is enabled for the namespace.
hasScopedLabelsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether scoped labels are enabled for the namespace.
hasSubepicsFeature Boolean! Introduced as an experiment in GitLab 18.1.

Whether subepics are enabled for the namespace.
hasWorkItemStatusFeature Boolean! Introduced as an experiment in GitLab 18.3.

Whether work item statuses are enabled for the namespace.

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 the namespace should be periodically pruned.
namespace Namespace Namespace the CI/CD settings belong to.

NamespaceClusterAgentMapping#

Represents a namespace-cluster-agent mapping.

Fields#

Name Type Description
clusterAgentId ClustersAgentID! Global ID of the cluster agent.
createdAt Time! Timestamp when the namespace-cluster-agent mapping was created.
creatorId UserID! Global ID of the creator.
id RemoteDevelopmentNamespaceClusterAgentMappingID! Global ID of the namespace-cluster-agent mapping.
namespaceId NamespaceID! Global ID of the namespace.
updatedAt Time! Timestamp when the namespace-cluster-agent mapping was last updated.

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.

NamespaceCommitEmailConnection#

Paginated collection of NamespaceCommitEmail. See Standard connection fields for the fields available on every connection.

NamespaceConnection#

Paginated collection of Namespace. See Standard connection fields for the fields available on every connection.

NamespacePermissions#

Fields#

Name Type Description
adminIssue Boolean! If true, the user can perform admin_issue on this resource.
adminLabel Boolean! If true, the user can perform admin_label on this resource.
adminProject Boolean! If true, the user can perform admin_project on this resource.
bulkAdminEpic Boolean! If true, the user can perform bulk_admin_epic on this resource.
createEpic Boolean! If true, the user can perform create_epic on this resource.
createLabel Boolean! If true, the user can perform create_label on this resource.
createProjects Boolean! If true, the user can perform create_projects on this resource.
createSavedView Boolean! If true, the user can perform create_saved_view on this resource.
createWorkItem Boolean! If true, the user can perform create_work_item on this resource.
generateDescription Boolean! If true, the user can perform generate_description on this resource.
importIssues Boolean! If true, the user can perform import_issues on this resource.
importWorkItems Boolean! If true, the user can perform import_work_items on this resource.
readCrmContact Boolean! If true, the user can read CRM contacts.
readCrmOrganization Boolean! If true, the user can read CRM organizations.
readNamespace Boolean! If true, the user can perform read_namespace on this resource.
setNewWorkItemMetadata Boolean! If true, the user can set work item metadata for new work items.

NamespacePlan#

Represents a subscription plan.

Fields#

Name Type Description
isPaid Boolean True if plan is paid.
name String Name of the plan.
title String Title of the plan.

NamespaceProjectStatistics#

Fields#

Name Type Description
buildArtifactsSize Float Build artifacts size of the project in bytes.
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/CD 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.

NamespaceSettings#

Settings for the namespace.

Fields#

Name Type Description
stepUpAuthRequiredOauthProvider String OAuth provider required for step-up authentication.

NamespaceSidebar#

Fields#

Name Type Description
openEpicsCount Int Number of open epics of the namespace.
openIssuesCount Int Number of open issues of the namespace.
openMergeRequestsCount Int Number of open merge requests of the namespace.
openWorkItemsCount Int Introduced as an experiment in GitLab 18.11.

Number of open work items in the namespace (limited to 10,000).

NamespaceWorkItemChangesPayload#

Fields#

Name Type Description
action WorkItemChangeAction! Introduced as an experiment in GitLab 19.3.

Action that triggered the change event.
workItemId WorkItemID! Introduced as an experiment in GitLab 19.3.

Global ID of the work item that changed.

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.

NestedEnvironmentConnection#

Paginated collection of NestedEnvironment. See Standard connection fields for the fields available on every connection.

NetworkPolicyEgress#

Fields#

Name Type Description
allow String! IP range to allow traffic from.
except [String!] List of IP ranges to exclude from the allow range.

Note#

Implements: BaseNoteInterface, ResolvableInterface

Fields#

Name Type Description
agentPresence DuoWorkflowAgentPresence Introduced as an experiment in GitLab 19.5.

Agent attribution for a note posted by a GitLab Duo Agent Platform session. Available to anyone who can read the note; userPermissions.readDuoWorkflow tells whether the session itself can be opened. Returns null when no session posted the note or when the agent_presence_consolidation feature flag is disabled.
author UserCore User who wrote the note.
authorIsContributor Boolean Indicates whether the note author is a contributor.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the note. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
body String! Content of the note.
bodyFirstLineHtml String! First line of the note content.
bodyHtml String GitLab Flavored Markdown rendering of the content of the note.
createdAt Time! Timestamp of the note creation.
discussion Discussion Discussion the note is a part of.
duoCreatedSession DuoWorkflow GitLab Duo Agent Platform session that created the note.
duoTriggeredSession DuoWorkflow Duo Agent Platform session triggered by the note. Returns nil for system notes or when no triggered session exists.
duoWorkflowLinks DuoWorkflowNoteLinkConnection GitLab Duo Agent Platform sessions linked to the note. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowLinks:
linkType (DuoWorkflowNoteLinkType)
Filter links by their link type.
externalAuthor String Email address of non-GitLab user adding the note. For guests, the email address is obfuscated.
id NoteID! ID of the note.
imported Boolean Indicates whether the note was imported.
internal Boolean Indicates if the 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.
noteableId Int Noteable ID which the note belongs to.
noteableType String! Noteable type which the note belongs to.
position DiffPosition Position of the 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.
suggestions SuggestionConnection Suggested changes contained in the note. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
system Boolean! Indicates whether the 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 the note in the Web UI.
userPermissions NotePermissions! Permissions for the current user on the resource.

NoteConnection#

Paginated collection of Note. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

ObservabilityLog#

ObservabilityLog represents a connection between an issue and a log entry.

Fields#

Name Type Description
fingerprint String! Log fingerprint of the log.
issue Issue! Issue associated with the log.
serviceName String! Service name of the log.
severityNumber Int! Severity number of the log.
timestamp ISO8601DateTime! Timestamp of the log.
traceIdentifier String! Trace identifier of the log.

ObservabilityLogConnection#

Paginated collection of ObservabilityLog. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ObservabilityMetric#

ObservabilityMetric represents a connection between an issue and a metric.

Fields#

Name Type Description
issue Issue Issues that the metric is attributed to.
name String! Name of the metric.
type String! OpenTelemetry metric type of the metric.

ObservabilityMetricConnection#

Paginated collection of ObservabilityMetric. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ObservabilityTrace#

ObservabilityTrace represents a connection between an issue and a trace.

Fields#

Name Type Description
issue Issue! Issue associated with the trace.
traceIdentifier String! Identifier of the trace.

ObservabilityTraceConnection#

Paginated collection of ObservabilityTrace. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

OncallParticipantTypeConnection#

Paginated collection of OncallParticipantType. See Standard connection fields for the fields available on every connection.

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.

OrbitAccess#

Orbit access state of a group.

Fields#

Name Type Description
reason OrbitAccessReason Introduced as an experiment in GitLab 19.5.

Cause of the access state when it has more than one cause. Null when the state has a single cause.
state OrbitAccessState! Introduced as an experiment in GitLab 19.5.

Access state of the group for Orbit.
trial OrbitTrial Introduced as an experiment in GitLab 19.5.

Orbit trial of the group. Null when the group is not in the trial flow.
turnOnDenialReason OrbitTurnOnDenialReason Introduced as an experiment in GitLab 19.5.

Reason the user cannot turn Orbit on. Null when turning on is allowed or Orbit is already on.

OrbitIndexingDomain#

Indexing status of one Orbit domain.

Fields#

Name Type Description
name String! Name of the domain.
phase OrbitIndexingPhase Indexing phase of the domain.

OrbitIndexingProjects#

Indexing progress of the projects in a group or project.

Fields#

Name Type Description
gaps Int Number of projects that are not indexed.
indexed Int Number of indexed projects.
totalKnown Int Number of projects known to Orbit.

OrbitIndexingStatus#

Indexing status of a group or project in Orbit.

Fields#

Name Type Description
domains [OrbitIndexingDomain!] Indexing status of each domain.
phase OrbitIndexingPhase Indexing phase of the group or project.
projects OrbitIndexingProjects Indexing progress of the projects in the group or project.

OrbitItemCountDomain#

Number of indexed items in one Orbit domain.

Fields#

Name Type Description
entities [OrbitItemCountEntity!] Number of indexed items of each entity in the domain.
name String! Name of the domain.

OrbitItemCountEntity#

Number of indexed items of one Orbit entity.

Fields#

Name Type Description
count BigInt Number of indexed items of the entity.
name String! Name of the entity.

OrbitItemCounts#

Number of indexed items of a group or project in Orbit.

Fields#

Name Type Description
domains [OrbitItemCountDomain!] Number of indexed items in each domain.

OrbitNamespace#

Orbit data of a group or project.

Fields#

Name Type Description
enabledAt Time Introduced as an experiment in GitLab 19.5.

When Orbit was turned on for the top-level group. Null for subgroups, projects, and when Orbit is off.
indexingStatus OrbitIndexingStatus Indexing status of the group or project.
itemCounts OrbitItemCounts Number of indexed items in the group or project. This field can be resolved for only one group or project in any single request.

OrbitTrial#

Orbit trial of a top-level group, as reported by CustomersDot.

Fields#

Name Type Description
credits OrbitTrialCredits Introduced as an experiment in GitLab 19.5.

Credits of the trial.
expiresOn Date Introduced as an experiment in GitLab 19.5.

Last day of the trial, in UTC. Null before a trial starts.
offer OrbitTrialOffer Introduced as an experiment in GitLab 19.6.

Terms of a new trial. Null unless the group can start one and CustomersDot sends valid terms.
state OrbitTrialState! Introduced as an experiment in GitLab 19.5.

State of the trial.

OrbitTrialCredits#

Credits of an Orbit trial.

Fields#

Name Type Description
remaining Float Introduced as an experiment in GitLab 19.5.

Number of trial credits remaining.
total Float Introduced as an experiment in GitLab 19.5.

Number of credits the trial started with.

OrbitTrialOffer#

Terms of a new Orbit trial, as offered by CustomersDot.

Fields#

Name Type Description
durationDays Int Introduced as an experiment in GitLab 19.6.

Number of days a new trial lasts.
initialCredits Float Introduced as an experiment in GitLab 19.6.

Number of free credits a new trial starts with.

Organization#

Fields#

Name Type Description
analytics Analytics Introduced as an experiment in GitLab 19.3.

Analytics aggregation endpoints scoped to groups and projects of the organization.
artifactRegistry ArtifactRegistry Introduced as an experiment in GitLab 19.4.

Artifact Registry the organization is activated for. Returns null when the organization has no registry, or when the artifact_registry_ui feature flag is disabled.
artifactRegistryRepositories ArtifactRegistryRepositoryConnection Introduced as an experiment in GitLab 19.3.

Artifact Registry repositories in the organization. Returns null when the artifact_registry_ui feature flag is disabled. Raises a resource-not-available error when the organization is not activated for Artifact Registry, where artifactRegistry returns null instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for artifactRegistryRepositories:
format (ArtifactRegistryRepositoryFormat)
Introduced as an experiment in GitLab 19.3.

Return only repositories holding the given package format.
formats ([ArtifactRegistryRepositoryFormat!])
Introduced as an experiment in GitLab 19.5.

Return only repositories holding one of the given package formats.
kind (ArtifactRegistryRepositoryKind)
Introduced as an experiment in GitLab 19.3.

Return only repositories sourcing their artifacts the given way.
kinds ([ArtifactRegistryRepositoryKind!])
Introduced as an experiment in GitLab 19.5.

Return only repositories sourcing their artifacts one of the given ways.
sort (ArtifactRegistryRepositorySort)
Introduced as an experiment in GitLab 19.3.

Sort repositories by the criteria.
artifactRegistryRepository ArtifactRegistryRepositoryDetails Introduced as an experiment in GitLab 19.3.

Single Artifact Registry repository in the organization, by name. Returns null when not found or when the artifact_registry_ui feature flag is disabled. Raises a resource-not-available error when the organization is not activated for Artifact Registry, where artifactRegistry returns null instead.

Arguments for artifactRegistryRepository:
name (String!)
Name of the repository to read, unique within its namespace.
avatarUrl String Introduced as an experiment in GitLab 16.7.

Avatar URL of the organization.
cdApplication CdApplication Introduced as an experiment in GitLab 19.2.

Continuous deployment application in the organization.

Arguments for cdApplication:
id (CdApplicationID!)
Global ID of the application.
cdApplications CdApplicationConnection Introduced as an experiment in GitLab 19.1.

Continuous deployment applications in the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cdApplications:
search (String)
Search applications by name or description.
status (CdApplicationStatus)
Filter applications by status. Returns applications whose most-urgent status matches the given value.
cdAvailableAgents ClusterAgentConnection Introduced as an experiment in GitLab 19.2.

GitLab agents for Kubernetes available in the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
cdAvailableDeployDrivers [String!] Introduced as an experiment in GitLab 19.2.

Reference of continuous deployment deploy drivers available in the organization.
cdEnvironment CdEnvironment Introduced as an experiment in GitLab 19.2.

Continuous deployment environment in the organization.

Arguments for cdEnvironment:
id (CdEnvironmentID!)
Global ID of the environment.
cdEnvironmentTiers [CdEnvironmentTier!] Introduced as an experiment in GitLab 19.2.

Continuous deployment environment tiers available in the organization.
cdEnvironments CdEnvironmentConnection Introduced as an experiment in GitLab 19.1.

Continuous deployment environments in the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for cdEnvironments:
applicationId (CdApplicationID)
Filter environments to those where the application has services deployed.
search (String)
Search environments by name or description.
status (CdEnvironmentStatus)
Filter environments by status. An environment can match more than one status.
tier (CdEnvironmentTier)
Filter environments by tier.
cdRollout CdRollout Introduced as an experiment in GitLab 19.2.

Continuous deployment rollout in the organization.

Arguments for cdRollout:
id (CdRolloutID!)
Global ID of the rollout.
cdService CdService Introduced as an experiment in GitLab 19.2.

Continuous deployment service in the organization.

Arguments for cdService:
id (CdServiceID!)
Global ID of the service.
cdVersionSet CdVersionSet Introduced as an experiment in GitLab 19.2.

Continuous deployment version set in the organization.

Arguments for cdVersionSet:
id (CdVersionSetID!)
Global ID of the version set.
description String Introduced as an experiment in GitLab 16.7.

Description of the organization.
descriptionHtml String Introduced as an experiment in GitLab 16.7.

GitLab Flavored Markdown rendering of description.
groups GroupConnection! Introduced as an experiment in GitLab 16.4.

Groups within this organization that the user has access to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
active (Boolean)
When nil (default value), returns all groups. When true, returns only groups that are not pending deletion. When false, only returns groups that are pending deletion.
aimedForDeletion (Boolean)
Filter groups that are marked for deletion.
allAvailable (Boolean)
When true, returns all accessible groups. When false, returns only groups where the user is a member. Unauthenticated requests always return all public groups. The owned_only argument takes precedence.
ids ([ID!])
Filter groups by IDs.
includeSubgroups (Boolean)
Include descendant groups of the group given in parentPath. Ignored unless parentPath is also provided.
markedForDeletionOn (Date)
Date when the group was marked for deletion.
not (BaseGroupsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
ownedOnly (Boolean)
Only include groups where the current user has an owner role.
parentPath (ID)
Full path of the parent group.
search (String)
Search query for group name or group full path.
sort (String)
Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc. Use similarity to rank results by closeness to search. similarity applies only when search is given and results are already scoped to the current user's memberships, such as with ownedOnly: true or allAvailable: false. Filtering by visibilityLevel to public or internal groups only disables similarity, because the results are then no longer scoped by membership. Results fall back to id_desc when similarity does not apply.
topLevelOnly (Boolean)
Only include top-level groups.
visibilityLevel (VisibilityLevelsEnum)
Filter groups by visibility level.
withKnowledgeGraphEnabled (Boolean)
Introduced as an experiment in GitLab 18.10.

Return only groups with Knowledge Graph enabled.
id ID! Introduced as an experiment in GitLab 16.4.

ID of the organization.
name String! Introduced as an experiment in GitLab 16.4.

Name of the organization.
organizationUsers OrganizationUserConnection! Introduced as an experiment in GitLab 16.4.

Users with access to the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizationUsers:
search (String)
Search query for the name, username, or public email of the user. Partial matches require at least 3 characters.
path String! Introduced as an experiment in GitLab 16.4.

Path of the organization.
policyStore PolicyStore Introduced as an experiment in GitLab 19.4.

Policy store catalogs. Returns null when the policy store experiment is not active for the organization.
projects ProjectConnection! Introduced as an experiment in GitLab 16.8.

Projects within this organization that the user has access to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
aimedForDeletion (Boolean)
Return only projects marked for deletion.
archived (ProjectArchived)
Filter projects by archived status.
duoLicensedFeature (DuoLicensedFeature)
Introduced as an experiment in GitLab 18.11.

Include only projects eligible for the specified GitLab Duo licensed feature. Results are automatically filtered to projects where the user has the Maintainer or Owner role.
fullPaths ([String!])
Filter projects by full paths. You cannot provide more than 50 full paths.
ids ([ID!])
Filter projects by IDs.
includeHidden (Boolean)
Include hidden projects.
lastRepositoryCheckFailed (Boolean)
Return only projects where the last repository check failed. Only available for administrators.
markedForDeletionOn (Date)
Date when the project was marked for deletion.
membership (Boolean)
Return only projects that the current user is a member of.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
namespacePath (ID)
Filter projects by their namespace's full path (group or user).
notAimedForDeletion (Boolean)
Exclude projects that are marked for deletion.
personal (Boolean)
Return only personal projects.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
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. Defaults to id_desc, or similarity if search used.
topics ([String!])
Filter projects by topics.
trending (Boolean)
Deprecated in GitLab 18.8. No longer functional. Underlying feature was removed in 19.0.
visibilityLevel (VisibilityLevelsEnum)
Filter projects by visibility level.
withIssuesEnabled (Boolean)
Return only projects with issues enabled.
withMergeRequestsEnabled (Boolean)
Return only projects with merge requests enabled.
rootPath String! Introduced as an experiment in GitLab 18.5.

Root path in the context of the organization.
securityMetrics SecurityMetrics Introduced as an experiment in GitLab 19.3.

Security metrics aggregated across the organization. Available only when the organization_security_dashboard feature flag is enabled. This feature is currently under development and not yet available for general use.

Arguments for securityMetrics:
projectId ([ID!])
Filter by project IDs in a group or an organization. This argument is ignored when we are querying for a project.
reportType ([VulnerabilityReportType!])
Filter by report types.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 18.8.

Filter by security attributes. Up to 20 filters.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref IDs. This argument is ignored when querying for a group. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
softDeletedAt Time Introduced as an experiment in GitLab 19.1.

Timestamp when the organization was soft-deleted.Visible to admins and organization owners only.
state OrganizationState! Introduced as an experiment in GitLab 19.0.

State of the organization.
uuid String! Introduced as an experiment in GitLab 19.2.

Globally unique identifier (UUID) of the organization.
visibility OrganizationVisibility Visibility of the organization.
webPath String! Introduced as an experiment in GitLab 19.0.

Web path of the organization.
webUrl String! Introduced as an experiment in GitLab 16.6.

Web URL of the organization.
workItemSettings WorkItemSettings Introduced as an experiment in GitLab 19.0.

Work item settings for the organization.
workItemTypes WorkItemTypeConnection Introduced as an experiment in GitLab 18.10.

Work item types available to the organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemTypes:
name (IssueType)
Deprecated in GitLab 19.0. Name-based filtering is no longer supported with introduction of configurable work item types in 19.0.
onlyAvailable (Boolean)
Introduced as an experiment in GitLab 18.6.

When true, returns only the available work item types for the current user. This experimental field will be removed in 19.0. Use canUserCreateItems and isFilterableListView fields from the WorkItemTypes API instead.
workspacesClusterAgents ClusterAgentConnection Introduced as an experiment in GitLab 17.10.

Cluster agents in the organization with workspaces capabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspacesClusterAgents:
filter (OrganizationClusterAgentFilter!)
Filter the types of cluster agents to return.

OrganizationConnection#

Paginated collection of Organization. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

OrganizationDetailUploadRegistry#

Represents the Geo replication and verification state of an organization_detail_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the OrganizationDetailUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the OrganizationDetailUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this OrganizationDetailUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the OrganizationDetailUploadRegistry.
lastSyncFailure String Error message during sync of the OrganizationDetailUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the OrganizationDetailUploadRegistry.
missingOnPrimary Boolean Indicate if the OrganizationDetailUploadRegistry is missing on primary.
modelRecordId Int ID of the OrganizationDetailUploadRegistry's model record.
organizationDetailUploadId ID! ID of the Organization Detail Upload.
retryAt Time Timestamp after which the OrganizationDetailUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the OrganizationDetailUploadRegistry.
state RegistryState Sync state of the OrganizationDetailUploadRegistry.
verificationChecksum String The local checksum of the OrganizationDetailUploadRegistry.
verificationChecksumMismatched String The expected checksum of the OrganizationDetailUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the OrganizationDetailUploadRegistry.
verificationRetryAt Time Timestamp after which the OrganizationDetailUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the OrganizationDetailUploadRegistry.
verificationStartedAt Time Timestamp when the verification of OrganizationDetailUploadRegistry started.
verificationState VerificationStateEnum Verification state of the OrganizationDetailUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the OrganizationDetailUploadRegistry.

OrganizationDetailUploadRegistryConnection#

Paginated collection of OrganizationDetailUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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
accessLevel OrganizationUserAccess Introduced as an experiment in GitLab 16.11.

Access level of the user in the organization.
badges [OrganizationUserBadge!] Introduced as an experiment in GitLab 16.4.

Badges describing the user within the organization.
id ID! Introduced as an experiment in GitLab 16.4.

ID of the organization user.
isLastOwner Boolean Introduced as an experiment in GitLab 16.11.

Whether the user is the last owner of the organization.
user UserCore! Introduced as an experiment in GitLab 16.4.

User that is associated with the organization.
userPermissions OrganizationUserPermissions! Permissions for the current user on the resource.

OrganizationUserAccess#

Represents the access level of a relationship between a User and Organization that it is related to.

Fields#

Name Type Description
integerValue Int Introduced as an experiment in GitLab 16.11.

Integer representation of access level.
stringValue OrganizationUserAccessLevel Introduced as an experiment in GitLab 16.11.

String representation of access level.

OrganizationUserBadge#

An organization user badge.

Fields#

Name Type Description
text String! Badge text.
variant String! Badge variant.

OrganizationUserConnection#

Paginated collection of OrganizationUser. See Standard connection fields for the fields available on every connection.

OrganizationUserPermissions#

Fields#

Name Type Description
adminOrganization Boolean! If true, the user can perform admin_organization on this resource.
deleteOrganizationUser Boolean! If true, the user can perform delete_organization_user on this resource.

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.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
project Project! Project where the package is stored.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
status PackageStatus! Package status.
statusMessage String Status message.
tags PackageTagConnection Package tags. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
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.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
status PackageStatus! Package status.
statusMessage String Status message.
tags PackageTagConnection Package tags. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Date of most recent update.
userPermissions PackagePermissions! Permissions for the current user on the resource.
version String Version string.

PackageBaseConnection#

Paginated collection of PackageBase. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

PackageConnection#

Paginated collection of Package. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

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.

PackageDependencyLinkConnection#

Paginated collection of PackageDependencyLink. See Standard connection fields for the fields available on every connection.

PackageDetailsType#

Represents a package details in the Package Registry.

Fields#

Name Type Description
_links PackageLinks! Map of links to perform actions on the package.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id PackagesPackageID! ID of the package.
lastDownloadedAt Time Last time that a file of the 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
packageType PackageTypeEnum! Package type.
pipelines PipelineConnection Pipelines that built the package. Max page size 20. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
project Project! Project where the package is stored.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

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.

PackageFileConnection#

Paginated collection of PackageFile. See Standard connection fields for the fields available on every connection.

PackageFileRegistry#

Represents the Geo sync and verification state of a package file.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackageFileRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackageFileRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PackageFileRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the PackageFileRegistry is missing on primary.
modelRecordId Int ID of the PackageFileRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the PackageFileRegistry in case of mismatch.
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 of PackageFileRegistry started.
verificationState VerificationStateEnum Verification state of the PackageFileRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackageFileRegistry.

PackageFileRegistryConnection#

Paginated collection of PackageFileRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

Represents links to perform actions on the package.

Fields#

Name Type Description
webPath String Path to the package details page.

PackageMetadataAdvisory#

Represents a security advisory from package metadata sources.

Fields#

Name Type Description
advisoryXid String! External ID of the advisory.
createdAt Time! Timestamp when the advisory was created.
cve String CVE identifier if applicable.
cvssV2 String CVSS v2 vector string.
cvssV3 String CVSS v3 vector string.
description String Description of the advisory.
id ID! ID of the advisory.
identifiers [PackageMetadataAdvisoryIdentifier!]! Additional identifiers for the advisory.
publishedDate Date! Date when the advisory was published.
sourceXid PackageMetadataAdvisorySource! Source of the advisory.
title String Title of the advisory.
updatedAt Time! Timestamp when the advisory was last updated.
urls [String!] Related URLs for the advisory.

PackageMetadataAdvisoryConnection#

Paginated collection of PackageMetadataAdvisory. See Standard connection fields for the fields available on every connection.

PackageMetadataAdvisoryIdentifier#

Represents an identifier for a package metadata advisory.

Fields#

Name Type Description
name String! Human-readable name of the identifier.
type String! Type of identifier (for example, CVE, CWE, OSVDB, USN).
url String URL of the identifier's documentation.
value String! Value of the identifier, for matching purposes.

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
auditEventsEnabled Boolean! Indicates whether audit events are created when publishing or deleting a package in the namespace (Premium and Ultimate only).
genericDuplicateExceptionRegex UntrustedRegexp When generic_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When generic_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
genericDuplicatesAllowed Boolean! Indicates whether duplicate generic packages are allowed for the 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.
lockRubygemsPackageRequestsForwarding Boolean! Indicates whether RubyGems package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegex UntrustedRegexp When maven_duplicates_allowed is false, you can publish duplicate packages with names or versions that match this regex. When maven_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
mavenDuplicatesAllowed Boolean! Indicates whether duplicate Maven packages are allowed for the namespace.
mavenPackageRequestsForwarding Boolean Indicates whether Maven package forwarding is allowed for the 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 the 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 or versions that match this regex. When nuget_duplicates_allowed is true, duplicate packages with names or versions that match this regex are rejected.
nugetDuplicatesAllowed Boolean! Indicates whether duplicate NuGet packages are allowed for the namespace.
nugetSymbolServerEnabled Boolean! Indicates whether the NuGet symbol server is enabled for the namespace.
pypiPackageRequestsForwarding Boolean Indicates whether PyPI package forwarding is allowed for the namespace.
pypiPackageRequestsForwardingLocked Boolean! Indicates whether PyPI package forwarding settings are locked by a parent namespace.
rubygemsPackageRequestsForwarding Boolean Indicates whether RubyGems package forwarding is allowed for the namespace.
rubygemsPackageRequestsForwardingLocked Boolean! Indicates whether RubyGems package forwarding settings are locked by a parent namespace.
terraformModuleDuplicateExceptionRegex UntrustedRegexp When terraform_module_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. When terraform_module_duplicates_allowed is true, duplicate packages with names that match this regex are rejected.
terraformModuleDuplicatesAllowed Boolean! Indicates whether duplicate Terraform packages are allowed for the 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.

PackageTagConnection#

Paginated collection of PackageTag. See Standard connection fields for the fields available on every connection.

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 the packages cleanup policy will be executed.

PackagesDebianProjectComponentFileRegistry#

Represents the Geo replication and verification state of a packages_debian_project_component_file.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackagesDebianProjectComponentFileRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackagesDebianProjectComponentFileRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PackagesDebianProjectComponentFileRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PackagesDebianProjectComponentFileRegistry.
lastSyncFailure String Error message during sync of the PackagesDebianProjectComponentFileRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PackagesDebianProjectComponentFileRegistry.
missingOnPrimary Boolean Indicate if the PackagesDebianProjectComponentFileRegistry is missing on primary.
modelRecordId Int ID of the PackagesDebianProjectComponentFileRegistry's model record.
packagesDebianProjectComponentFileId ID! ID of the Packages::Debian::ProjectComponentFile.
retryAt Time Timestamp after which the PackagesDebianProjectComponentFileRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PackagesDebianProjectComponentFileRegistry.
state RegistryState Sync state of the PackagesDebianProjectComponentFileRegistry.
verificationChecksum String The local checksum of the PackagesDebianProjectComponentFileRegistry.
verificationChecksumMismatched String The expected checksum of the PackagesDebianProjectComponentFileRegistry in case of mismatch.
verificationFailure String Error message during verification of the PackagesDebianProjectComponentFileRegistry.
verificationRetryAt Time Timestamp after which the PackagesDebianProjectComponentFileRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PackagesDebianProjectComponentFileRegistry.
verificationStartedAt Time Timestamp when the verification of PackagesDebianProjectComponentFileRegistry started.
verificationState VerificationStateEnum Verification state of the PackagesDebianProjectComponentFileRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackagesDebianProjectComponentFileRegistry.

PackagesDebianProjectComponentFileRegistryConnection#

Paginated collection of PackagesDebianProjectComponentFileRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

PackagesHelmMetadataCacheRegistry#

Represents the Geo replication and verification state of a packages_helm_metadata_cache.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackagesHelmMetadataCacheRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackagesHelmMetadataCacheRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PackagesHelmMetadataCacheRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PackagesHelmMetadataCacheRegistry.
lastSyncFailure String Error message during sync of the PackagesHelmMetadataCacheRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PackagesHelmMetadataCacheRegistry.
missingOnPrimary Boolean Indicate if the PackagesHelmMetadataCacheRegistry is missing on primary.
modelRecordId Int ID of the PackagesHelmMetadataCacheRegistry's model record.
packagesHelmMetadataCacheId ID! ID of the Helm Metadata Cache.
retryAt Time Timestamp after which the PackagesHelmMetadataCacheRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PackagesHelmMetadataCacheRegistry.
state RegistryState Sync state of the PackagesHelmMetadataCacheRegistry.
verificationChecksum String The local checksum of the PackagesHelmMetadataCacheRegistry.
verificationChecksumMismatched String The expected checksum of the PackagesHelmMetadataCacheRegistry in case of mismatch.
verificationFailure String Error message during verification of the PackagesHelmMetadataCacheRegistry.
verificationRetryAt Time Timestamp after which the PackagesHelmMetadataCacheRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PackagesHelmMetadataCacheRegistry.
verificationStartedAt Time Timestamp when the verification of PackagesHelmMetadataCacheRegistry started.
verificationState VerificationStateEnum Verification state of the PackagesHelmMetadataCacheRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackagesHelmMetadataCacheRegistry.

PackagesHelmMetadataCacheRegistryConnection#

Paginated collection of PackagesHelmMetadataCacheRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

PackagesNugetSymbolRegistry#

Represents the Geo replication and verification state of a packages_nuget_symbol.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackagesNugetSymbolRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackagesNugetSymbolRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PackagesNugetSymbolRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PackagesNugetSymbolRegistry.
lastSyncFailure String Error message during sync of the PackagesNugetSymbolRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PackagesNugetSymbolRegistry.
missingOnPrimary Boolean Indicate if the PackagesNugetSymbolRegistry is missing on primary.
modelRecordId Int ID of the PackagesNugetSymbolRegistry's model record.
packagesNugetSymbolId ID! ID of the Packages::Nuget::Symbol.
retryAt Time Timestamp after which the PackagesNugetSymbolRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PackagesNugetSymbolRegistry.
state RegistryState Sync state of the PackagesNugetSymbolRegistry.
verificationChecksum String The local checksum of the PackagesNugetSymbolRegistry.
verificationChecksumMismatched String The expected checksum of the PackagesNugetSymbolRegistry in case of mismatch.
verificationFailure String Error message during verification of the PackagesNugetSymbolRegistry.
verificationRetryAt Time Timestamp after which the PackagesNugetSymbolRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PackagesNugetSymbolRegistry.
verificationStartedAt Time Timestamp when the verification of PackagesNugetSymbolRegistry started.
verificationState VerificationStateEnum Verification state of the PackagesNugetSymbolRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackagesNugetSymbolRegistry.

PackagesNugetSymbolRegistryConnection#

Paginated collection of PackagesNugetSymbolRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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! Global ID of the package protection rule.
minimumAccessLevelForDelete PackagesProtectionRuleAccessLevelForDelete Introduced as an experiment in GitLab 17.10.

Minimum GitLab access required to delete packages from the package registry. Valid values include OWNER or ADMIN. If the value is nil, the default minimum access level is MAINTAINER. Available only when feature flag packages_protected_packages_delete is enabled.
minimumAccessLevelForPush PackagesProtectionRuleAccessLevel Minimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
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, PYPI.

PackagesProtectionRuleConnection#

Paginated collection of PackagesProtectionRule. See Standard connection fields for the fields available on every connection.

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.

PagesDeployment#

Represents a pages deployment.

Fields#

Name Type Description
active Boolean! Whether the deployment is currently active.
ciBuildId ID ID of the CI build that created the deployment.
createdAt ISO8601DateTime! Time the deployment was created.
deletedAt ISO8601DateTime Time the deployment was deleted.
expiresAt ISO8601DateTime Time the deployment will expire.
fileCount Int Number of files that were published with the deployment.
id ID! ID of the Pages Deployment.
pathPrefix String URL path Prefix that points to the deployment.
project Project! Project the deployment belongs to.
rootDirectory String Path within the build assets that functions as the root directory for Pages sites.
size BigInt Size of the storage used.
updatedAt ISO8601DateTime! Time the deployment was last updated.
url String! Publicly accessible URL of the deployment.

PagesDeploymentConnection#

Paginated collection of PagesDeployment. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

PagesDeploymentRegistry#

Represents the Geo replication and verification state of a pages_deployment.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PagesDeploymentRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PagesDeploymentRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PagesDeploymentRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the PagesDeploymentRegistry is missing on primary.
modelRecordId Int ID of the PagesDeploymentRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the PagesDeploymentRegistry in case of mismatch.
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 of PagesDeploymentRegistry started.
verificationState VerificationStateEnum Verification state of the PagesDeploymentRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PagesDeploymentRegistry.

PagesDeploymentRegistryConnection#

Paginated collection of PagesDeploymentRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

PathLock#

Represents a file or directory in the project repository that has been locked.

Fields#

Name Type Description
createdAt Time! Timestamp of when the path was locked.
id PathLockID! ID of the path lock.
path String Locked path.
user UserCore User that has locked the path.
userPermissions PathLockPermissions! Permissions for the current user on the resource.

PathLockConnection#

Paginated collection of PathLock. See Standard connection fields for the fields available on every connection.

PathLockPermissions#

Fields#

Name Type Description
destroyPathLock Boolean! If true, the user can perform destroy_path_lock on this resource.

PendingGroupMember#

Represents a Pending Group Membership.

Implements: MemberInterface, PendingMemberInterface

Fields#

Name Type Description
accessLevel AccessLevel GitLab::Access level.
approved Boolean Whether the pending member has been approved.
avatarUrl String URL to avatar image file of the pending member.
createdAt Time Date and time the membership was created.
createdBy UserCore User that authorized membership.
email String Public email of the pending member.
expiresAt Time Date and time the membership expires.
id ID! ID of the member.
invited Boolean Whether the pending member has been invited.
mergeRequestInteraction UserMergeRequestInteraction Find a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
name String Name of the pending member.
updatedAt Time Date and time the membership was last updated.
user UserCore User that is associated with the member object.
username String Username of the pending member.
webUrl String Web URL of the pending member.

PendingMemberInterfaceConnection#

Paginated collection of PendingMemberInterface. See Standard connection fields for the fields available on every connection.

PendingProjectMember#

Represents a Pending Project Membership.

Implements: MemberInterface, PendingMemberInterface

Fields#

Name Type Description
accessLevel AccessLevel GitLab::Access level.
approved Boolean Whether the pending member has been approved.
avatarUrl String URL to avatar image file of the pending member.
createdAt Time Date and time the membership was created.
createdBy UserCore User that authorized membership.
email String Public email of the pending member.
expiresAt Time Date and time the membership expires.
id ID! ID of the member.
invited Boolean Whether the pending member has been invited.
mergeRequestInteraction UserMergeRequestInteraction Find a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
name String Name of the pending member.
updatedAt Time Date and time the membership was last updated.
user UserCore User that is associated with the member object.
username String Username of the pending member.
webUrl String Web URL of the pending member.

PersonalAccessToken#

Personal access token.

Fields#

Name Type Description
active Boolean! Whether the personal access token is active.
createdAt Time! Timestamp of when the personal access token was created.
description String Description of the personal access token.
expiresAt Date Date of when the personal access token expires.
granular Boolean! Whether the personal access token is granular.
id ID! ID of the personal access token.
lastUsedAt Time Timestamp of when the personal access token was last used.
lastUsedIps [String!]! Five most recent unique IP addresses that authenticated with the personal access token.
name String! Name of the personal access token.
revoked Boolean! Whether the personal access token has been revoked.
scopes [PersonalAccessTokenScope!]! List of scopes applied to a personal access token.
sudo Boolean! Whether the personal access token can impersonate other users with sudo.

PersonalAccessTokenConnection#

Paginated collection of PersonalAccessToken. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

PersonalSnippetUploadRegistry#

Represents the Geo replication and verification state of a personal_snippet_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PersonalSnippetUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PersonalSnippetUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PersonalSnippetUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PersonalSnippetUploadRegistry.
lastSyncFailure String Error message during sync of the PersonalSnippetUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PersonalSnippetUploadRegistry.
missingOnPrimary Boolean Indicate if the PersonalSnippetUploadRegistry is missing on primary.
modelRecordId Int ID of the PersonalSnippetUploadRegistry's model record.
personalSnippetUploadId ID! ID of the Personal Snippet Upload.
retryAt Time Timestamp after which the PersonalSnippetUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PersonalSnippetUploadRegistry.
state RegistryState Sync state of the PersonalSnippetUploadRegistry.
verificationChecksum String The local checksum of the PersonalSnippetUploadRegistry.
verificationChecksumMismatched String The expected checksum of the PersonalSnippetUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the PersonalSnippetUploadRegistry.
verificationRetryAt Time Timestamp after which the PersonalSnippetUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PersonalSnippetUploadRegistry.
verificationStartedAt Time Timestamp when the verification of PersonalSnippetUploadRegistry started.
verificationState VerificationStateEnum Verification state of the PersonalSnippetUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PersonalSnippetUploadRegistry.

PersonalSnippetUploadRegistryConnection#

Paginated collection of PersonalSnippetUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

Pipeline#

Implements: PipelineInterface

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commit Commit Git commit of the pipeline.
commitAuthorGravatar String Gravatar URL of the author of the pipeline's commit.
commitAuthorName String Name of the author of the pipeline's commit.
commitPath String Path to the commit that triggered the pipeline.
commitTitle String Title of the pipeline's commit.
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, PIPELINE_EXECUTION_POLICY_FORCED, SECURITY_SCAN_PROFILES_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 Latest pipelines triggered by the pipeline. Pipelines from trigger jobs that have since been retried are excluded. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
duoWorkflowLinks DuoWorkflowPipelineLinkConnection GitLab Duo Agent Platform sessions linked to the pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowLinks:
linkType (DuoWorkflowPipelineLinkType)
Filter links by their link type.
duoWorkflows DuoWorkflowConnection Introduced as an experiment in GitLab 19.3.

Duo Workflow sessions associated with the pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
duration Int Duration of the pipeline in seconds.
enabledPartialSecurityScans EnabledSecurityScans! Introduced as an experiment in GitLab 18.3.

Partial scans present in the pipeline and its descendents for each report type.
enabledSecurityScans EnabledSecurityScans! Introduced as an experiment in GitLab 18.3.

Security scans present in the pipeline and its descendents for each report type.
errorMessages PipelineMessageConnection Pipeline error messages. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
failedJobsCount Int! Number of failed jobs in the pipeline, including trigger jobs and external jobs.
failureReason String Reason why the pipeline failed.
finishedAt Time Timestamp of the pipeline's completion.
hasManualActions Boolean! Indicates if the pipeline has manual actions.
hasScheduledActions Boolean! Indicates if the pipeline has scheduled actions.
id ID! ID of the pipeline.
iid String! Internal ID of the pipeline.
job CiJob Specific job in the pipeline, either by name or ID.

Arguments for job:
id (JobID)
ID of the job.
name (String)
Name of the job.
jobArtifacts [CiJobArtifact!] Job artifacts of the pipeline.
jobs CiJobConnection Jobs belonging to the pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobs:
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.
latest Boolean! If the pipeline is the latest one or not.
manualVariables PipelineManualVariableConnection CI/CD variables added to a manual pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
mergeRequest MergeRequest 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.
pipelineSchedule PipelineSchedule Pipeline schedule that triggered the pipeline.
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! Reference text from the presenter.
retryable Boolean! Specifies if a pipeline's jobs can be retried.
securityReportFinding PipelineSecurityReportFinding Vulnerability finding reported on the pipeline.

Arguments for securityReportFinding:
uuid (String!)
UUID of the security report finding.
securityReportFindings PipelineSecurityReportFindingConnection Vulnerability findings reported on the pipeline. By default all the states except dismissed are included in the response. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityReportFindings:
reportType ([String!])
Filter vulnerability findings by report type.
scanner ([String!])
Filter vulnerability findings by Scanner.externalId.
severity ([String!])
Filter vulnerability findings by severity.
sort (PipelineSecurityReportFindingSort)
List vulnerability findings by sort order.
state ([VulnerabilityState!])
Filter vulnerability findings by state.
securityReportSummary SecurityReportSummary Vulnerability and scanned resource counts for each security scanner of the pipeline.
sha String SHA of the pipeline's commit.

Arguments for sha:
format (ShaFormat)
Format of the SHA.
source String Source of the pipeline.
sourceJob CiJob Job where pipeline was triggered from.
stages CiStageConnection Stages of the pipeline. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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, CANCELING, SKIPPED, MANUAL, SCHEDULED).
stuck Boolean! If the pipeline is stuck.
testReportSummary TestReportSummary! Summary of the test report generated by the pipeline.
testSuite TestSuite A specific test suite in a pipeline test report.

Arguments for testSuite:
buildIds ([ID!]!)
IDs of the builds used to run the test suite.
totalJobs Int! Total number of jobs in the pipeline.
trigger Boolean! If the pipeline was created by a Trigger request.
triggeredByPath String Path that triggered the pipeline.
troubleshootJobWithAi Boolean! If the user can troubleshoot jobs of a pipeline.
type String! Type of the pipeline.
updatedAt Time! Timestamp of the pipeline's last activity.
upstream Pipeline Pipeline that triggered the pipeline.
user UserCore Pipeline user.
userPermissions PipelinePermissions! Permissions for the current user on the resource.
usesNeeds Boolean Indicates if the pipeline has jobs with needs dependencies.
warningMessages PipelineMessageConnection Pipeline warning messages. Always empty for pipelines created in 19.5 and later due to database concerns. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
warnings Boolean! Indicates if a pipeline has warnings.
yamlErrorMessages String Pipeline YAML errors.
yamlErrors Boolean! If the pipeline has YAML errors.

PipelineAnalytics#

Fields#

Name Type Description
aggregate PipelineAnalyticsPeriod Introduced as an experiment in GitLab 17.5.

Pipeline analytics for the specified filter.
monthPipelinesLabels [String!] Labels for the monthly pipeline count. Only available for projects.
monthPipelinesSuccessful [Int!] Total monthly successful pipeline count. Only available for projects.
monthPipelinesTotals [Int!] Total monthly pipeline count. Only available for projects.
pipelineTimesLabels [String!] Pipeline times labels. Only available for projects.
pipelineTimesValues [Int!] Pipeline times. Only available for projects.
timeSeries [PipelineAnalyticsPeriod!] Introduced as an experiment in GitLab 17.9.

Pipeline analytics shown over time based on the specified filter. Data is aggregated in UTC, with adaptive resolution: hourly for 7-day windows or less, daily for longer periods.

Arguments for timeSeries:
period (AnalyticsAggregationPeriod!)
Periodicity of aggregated data.
weekPipelinesLabels [String!] Labels for the weekly pipeline count. Only available for projects.
weekPipelinesSuccessful [Int!] Total weekly successful pipeline count. Only available for projects.
weekPipelinesTotals [Int!] Total weekly pipeline count. Only available for projects.
yearPipelinesLabels [String!] Labels for the yearly pipeline count. Only available for projects.
yearPipelinesSuccessful [Int!] Total yearly successful pipeline count. Only available for projects.
yearPipelinesTotals [Int!] Total yearly pipeline count. Only available for projects.

PipelineAnalyticsPeriod#

Fields#

Name Type Description
count BigInt Introduced as an experiment in GitLab 17.5.

Pipeline count, optionally filtered by status.

Arguments for count:
status (PipelineAnalyticsJobStatus!)
Filter pipeline totals by status. If not specified, totals for all pipeline statuses are returned.
durationStatistics CiDurationStatistics Introduced as an experiment in GitLab 17.5.

Pipeline duration statistics.
label Date Introduced as an experiment in GitLab 17.5.

Data point label (UTC time).

PipelineArtifactRegistry#

Represents the Geo sync and verification state of a pipeline artifact.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PipelineArtifactRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PipelineArtifactRegistry was created.
dataManagementDetailsPath String Path to the data management view for this PipelineArtifactRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the PipelineArtifactRegistry is missing on primary.
modelRecordId Int ID of the PipelineArtifactRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the PipelineArtifactRegistry in case of mismatch.
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 of PipelineArtifactRegistry started.
verificationState VerificationStateEnum Verification state of the PipelineArtifactRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PipelineArtifactRegistry.

PipelineArtifactRegistryConnection#

Paginated collection of PipelineArtifactRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

PipelineConnection#

Paginated collection of Pipeline. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

PipelineExecutionPolicy#

Represents the pipeline execution policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyBlobFilePath String! Path to the policy file in the project.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.
warnings [String!]! Warnings associated with the policy.
yaml String! YAML definition of the policy.

PipelineExecutionPolicyAttributesType#

Represents policy fields related to the pipeline execution policy.

Fields#

Name Type Description
policyBlobFilePath String! Path to the policy file in the project.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
warnings [String!]! Warnings associated with the policy.

PipelineExecutionPolicyConnection#

Paginated collection of PipelineExecutionPolicy. See Standard connection fields for the fields available on every connection.

PipelineExecutionProjectSchedule#

Represents a project schedule for a pipeline execution policy.

Fields#

Name Type Description
cron String! Cron expression for the schedule.
cronTimezone String! Timezone for the cron schedule.
id SecurityPipelineExecutionProjectScheduleID! ID of the schedule record.
nextRunAt Time Timestamp of the next scheduled run.
project Project! Project the scheduled pipeline will run for.
snoozedUntil Time Timestamp until which the schedule is snoozed.
timeWindowSeconds Int! Time window in seconds for distributing pipeline runs.

PipelineExecutionProjectScheduleConnection#

Paginated collection of PipelineExecutionProjectSchedule. See Standard connection fields for the fields available on every connection.

PipelineExecutionSchedulePolicy#

Represents the pipeline execution schedule policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyBlobFilePath String! Path to the policy file in the project.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope of the policy.
schedulePipelines PolicySchedulePipelineConnection Introduced as an experiment in GitLab 19.0.

Pipelines created by this scheduled policy. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
scheduleTimeWindowSeconds Int Introduced as an experiment in GitLab 19.1.

Time window in seconds from the first schedule of the policy.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
upcomingSchedules PipelineExecutionProjectScheduleConnection Introduced as an experiment in GitLab 19.1.

Upcoming scheduled runs for this policy. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp of when the policy YAML was last updated.
warnings [String!]! Warnings associated with the policy.
yaml String! YAML definition of the policy.

PipelineExecutionSchedulePolicyConnection#

Paginated collection of PipelineExecutionSchedulePolicy. See Standard connection fields for the fields available on every connection.

PipelineExecutionScheduledPolicyAttributesType#

Represents policy fields related to the pipeline execution scheduled policy.

Fields#

Name Type Description
policyBlobFilePath String! Path to the policy file in the project.
scheduleTimeWindowSeconds Int Introduced as an experiment in GitLab 19.1.

Time window in seconds from the first schedule of the policy.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
warnings [String!]! Warnings associated with the policy.

PipelineManualVariable#

CI/CD variables added to a manual pipeline.

Fields#

Name Type Description
id ID! ID of the variable.
key String Name of the variable.
value String Value of the variable.

PipelineManualVariableConnection#

Paginated collection of PipelineManualVariable. See Standard connection fields for the fields available on every connection.

PipelineMessage#

Fields#

Name Type Description
content String! Content of the pipeline message.
id ID! ID of the pipeline message.

PipelineMessageConnection#

Paginated collection of PipelineMessage. See Standard connection fields for the fields available on every connection.

PipelineMinimalAccess#

Implements: PipelineInterface

Fields#

Name Type Description
commit Commit Git commit of the pipeline.
id ID! ID of the pipeline.
iid String Internal ID of the pipeline.
path String Relative path to the pipeline's page.
project ProjectInterface Project the pipeline belongs to.
user UserCore Pipeline user.

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.
inputs CiInputsFieldConnection Introduced as an experiment in GitLab 17.10.

Inputs configured for the pipeline schedule. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

PipelineScheduleConnection#

Paginated collection of PipelineSchedule. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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

PipelineScheduleStatusCount#

Counts of pipeline schedules by status.

Fields#

Name Type Description
active Int! Number of active pipeline schedules.
inactive Int! Number of inactive pipeline schedules.
total Int! Total number of pipeline schedules.

PipelineScheduleVariable#

Implements: CiVariable

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.

PipelineScheduleVariableConnection#

Paginated collection of PipelineScheduleVariable. See Standard connection fields for the fields available on every connection.

PipelineSecurityReportFinding#

Represents vulnerability finding of a security report on the pipeline.

Fields#

Name Type Description
aiResolutionAvailable Boolean Indicates whether the type of finding can be resolved with AI.
aiResolutionEnabled Boolean Indicates whether the specific finding can be resolved with AI.
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.
findingTokenStatus VulnerabilityFindingTokenStatus Status of the secret token associated with this finding.
identifiers [VulnerabilityIdentifier!]! Identifiers of the vulnerability finding.
issueLinks VulnerabilityIssueLinkConnection List of issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
originalSeverity VulnerabilitySeverity Severity of the vulnerability finding before any overrides.
project Project Project on which the vulnerability finding was found.
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.
severityOverrides SeverityOverrideConnection List of severity changes for the vulnerability finding. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
solution String Solution for resolving the security report finding.
solutionHtml String GitLab Flavored Markdown rendering of solution.
state VulnerabilityState Finding status.
stateComment String Comment for the state of the security report finding.
title String Title of the vulnerability finding.
unverified Boolean! Indicates whether the finding was detected without an identified source (untrusted input).
userPermissions PipelineSecurityReportFindingPermissions! Permissions for the current user on the resource.
uuid String UUIDv5 digest based on the vulnerability's report type, primary identifier, location, fingerprint, project identifier.
validityDisplayState VulnerabilityValidityDisplayState Introduced as an experiment in GitLab 19.5.

Validity state derived from the token status and current vendor support.
vulnerability Vulnerability Vulnerability related to the security report finding.

PipelineSecurityReportFindingConnection#

Paginated collection of PipelineSecurityReportFinding. See Standard connection fields for the fields available on every connection.

PipelineSecurityReportFindingPermissions#

Check permissions for the current user on a vulnerability finding.

Fields#

Name Type Description
adminVulnerability Boolean! If true, the user can perform admin_vulnerability on this resource.
createIssue Boolean! If true, the user can perform create_issue on this resource.

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.
expiresAt Time Timestamp of when the pipeline trigger token expires.
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.

PipelineTriggerConnection#

Paginated collection of PipelineTrigger. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

PipelinesAggregationResponse#

Response for Pipelines aggregation engine.

Fields#

Name Type Description
dimensions PipelinesAggregationResponseDimensions Aggregation dimensions. Every selected dimension will be used for aggregation.
duration PipelinesAggregationResponseDurationMetrics Aggregated duration metrics.
durationQuantile Float Pipeline duration quantile in seconds.

Arguments for durationQuantile:
quantile (Float)
outcomeRate Float Rate of pipelines with the given status among completed pipelines.

Arguments for outcomeRate:
status ([String!])
totalCount Int Total number of pipelines, optionally filtered by source or status.

Arguments for totalCount:
source ([String!])
Only count pipelines with the given sources.
status ([String!])
Only count pipelines with the given statuses.

PipelinesAggregationResponseConnection#

Paginated collection of PipelinesAggregationResponse. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total number of aggregated rows.

PipelinesAggregationResponseDimensions#

Response dimensions for Pipelines aggregation engine.

Fields#

Name Type Description
finishedAt Date Pipeline finish date.

Arguments for finishedAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
project Project Project.
ref String Pipeline ref.
source String Pipeline source.
startedAt Date Pipeline start date.

Arguments for startedAt:
granularity (String)
Date granularity: daily, weekly, monthly, or a fixed number of days between 1d and 399d (for example 30d).
origin (Time)
Anchor for fixed-day granularities: buckets start at this timestamp and repeat every N days. Only valid with a fixed-day granularity.
status String Pipeline status.
user UserCore User who triggered the pipeline.

PipelinesAggregationResponseDurationMetrics#

Aggregated duration metrics for Pipelines aggregation engine.

Fields#

Name Type Description
max Int Maximum pipeline duration in seconds.
mean Float Mean pipeline duration in seconds.
min Int Minimum pipeline duration in seconds.
quantile Float Quantile of pipeline duration in seconds.

Arguments for quantile:
quantile (Float)
sum Float Sum of pipeline duration in seconds.

PipelinesAggregationScope#

Aggregation scope for Pipelines. Apply ordering and pagination on the aggregation.

Fields#

Name Type Description
aggregated PipelinesAggregationResponseConnection Aggregated data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aggregated:
orderBy ([AggregationOrder!])
Sorting order list for the aggregated data.

PolicyAnyMergeRequestViolation#

Represents policy violation for any_merge_request report_type.

Fields#

Name Type Description
commits JSON List of unsigned commits causing the violation. If policy targets any commits, it returns true.
name String! Represents the policy name.

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.

PolicyApprovalSettingsOverride#

Represents the approval settings of merge request overridden by a policy.

Fields#

Name Type Description
editPath String Introduced as an experiment in GitLab 17.8.

Path to edit the policy.
name String Introduced as an experiment in GitLab 17.8.

Policy name.
settings JSON! Overridden project approval settings.

PolicyApproversType#

Multiple approvers action.

Fields#

Name Type Description
allGroups [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
roles [MemberAccessLevelName!] Approvers of the role type. Users belonging to these role(s) alone will be approvers.
users [UserCore!] Approvers of the user type.

PolicyBypassStatus#

Represents bypass status of a merge request for a security policy.

Fields#

Name Type Description
allowBypass Boolean! Indicates if bypass is allowed for the policy.
bypassed Boolean! Indicates if the policy has been bypassed.
id ID! ID of the security policy.
name String! Name of the security policy.

PolicyComparisonPipeline#

Represents the source and target pipelines used for comparison in the policy evaluation.

Fields#

Name Type Description
reportType ApprovalReportType! Represents the report_type for which the pipeline IDs were evaluated.
source [CiPipelineID!] Represents the list of pipeline GIDs for the source branch.
target [CiPipelineID!] Represents the list of pipeline GIDs for the target branch.

PolicyDismissal#

Represents a policy dismissal for a security finding or license occurrence.

Fields#

Name Type Description
id ID! ID of the policy dismissal.
securityPolicy SecurityPolicy Security policy associated with the dismissal.

PolicyError#

Represents an error that can occur during policy evaluation.

Fields#

Name Type Description
data JSON Represents the error-specific data.
error PolicyViolationErrorType! Represents error code.
message String! Represents the error message.
reportType ApprovalReportType! Represents the report type.

PolicyLicenseScanningViolation#

Represents policy violation for license_scanning report_type.

Fields#

Name Type Description
dependencies [String!]! List of dependencies using the violated license.
license String! License name.
url String URL of the license.

PolicyProjectCreated#

Response of security policy creation.

Fields#

Name Type Description
errorMessage String Deprecated in GitLab 17.5. Use errors instead.
errors [String!] Error messages in case status is :error.
project Project Security Policy Project that was created.
status PolicyProjectCreatedStatus Status of the creation of the security policy project.

PolicyScanFindingViolation#

Represents policy violation for scan_finding report_type.

Fields#

Name Type Description
location JSON Location of the finding determined by the scanner.
name String Represents the name of the finding.
path String Represents the URL path to the finding.
reportType VulnerabilityReportType! Represents the report type.
severity VulnerabilitySeverity Severity of the finding.

PolicySchedulePipeline#

Represents a pipeline created by a scheduled security policy.

Fields#

Name Type Description
createdAt Time! Timestamp when the pipeline was triggered by the schedule.
id SecurityPolicySchedulePipelineID! ID of the policy schedule pipeline record.
pipeline Pipeline! Pipeline created by the scheduled policy.
project Project! Project the pipeline was created for.

PolicySchedulePipelineConnection#

Paginated collection of PolicySchedulePipeline. See Standard connection fields for the fields available on every connection.

PolicyScheduleTestRun#

Represents a test run for a scheduled pipeline execution policy.

Fields#

Name Type Description
completed Boolean! Whether the test run has completed.
createdAt Time! Timestamp when the test run was created.
duration Int Duration of the test run in seconds.
errorMessage String Error message if the test run failed.
finishedAt Time Timestamp when the test run finished.
id SecurityScheduledPipelineExecutionPolicyTestRunID! ID of the test run.
pipeline Pipeline Pipeline created by the test run.
project Project! Project the test run was executed on.
startedAt Time Timestamp when the test run started.
state PolicyScheduleTestRunState! State of the test run.

PolicyScheduleTestRunConnection#

Paginated collection of PolicyScheduleTestRun. See Standard connection fields for the fields available on every connection.

PolicyScope#

Fields#

Name Type Description
complianceFrameworks ComplianceFrameworkConnection! Compliance Frameworks linked to the policy. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingApplicationAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.0.

Application security attributes that the policy does not apply to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingArchivedProjects Boolean! Boolean indicating whether archived projects are excluded from the policy.
excludingBusinessImpactAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 18.11.

Business Impact security attributes that the policy does not apply to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingBusinessUnitAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.1.

Business Unit security attributes that the policy does not apply to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingExposureAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.1.

Exposure security attributes that the policy does not apply to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingGroups GroupConnection! Groups to which the policy should not be applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
excludingPersonalProjects Boolean! Boolean indicating whether personal projects are excluded from the policy.
excludingProjects ProjectConnection! Projects to which the policy should not be applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingApplicationAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.0.

Application security attributes that the policy applies to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingBusinessImpactAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 18.11.

Business Impact security attributes that the policy applies to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingBusinessUnitAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.1.

Business Unit security attributes that the policy applies to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingExposureAttributes SecurityAttributeConnection! Introduced as an experiment in GitLab 19.1.

Exposure security attributes that the policy applies to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingGroups GroupConnection! Groups to which the policy should be applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
includingProjects ProjectConnection! Projects to which the policy should be applied. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
matchMode PolicyScopeMatchMode! Introduced as an experiment in GitLab 18.10.

Specifies how multiple policy scope conditions are combined.

PolicyStore#

Catalogs available when creating a policy in the policy store.

Fields#

Name Type Description
actions [PolicyStoreAction!]! Introduced as an experiment in GitLab 19.4.

Actions available when creating a policy in the policy store.
policies GovernPolicyConnection Introduced as an experiment in GitLab 19.4.

Policies stored in the policy store for the organization or group. For a group, organization-wide, ancestor, and descendant groups' policies are included. Only first and after are supported; page with pageInfo.endCursor. Cursor offsets are capped at 100000, so policies past that window cannot be paged. The ids argument cannot be combined with pagination arguments. Returns null when the current user cannot read the policies of the container. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for policies:
ids ([Int!])
Introduced as an experiment in GitLab 19.4.

Return only the policies with these IDs. Unknown IDs are ignored; an empty list returns no policies. Maximum is 1000 IDs.
triggerType (String)
Introduced as an experiment in GitLab 19.4.

Return only the policies that respond to this trigger. Valid values are the ids in the policy store triggers catalog.
policyEvaluations GovernPolicyEvaluationConnection Introduced as an experiment in GitLab 19.4.

Recorded evaluations of the policies stored in the policy store for the organization or group, newest first. For a group, only evaluations of the group's own policies are returned. Returns null when the current user cannot read the policies of the container. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for policyEvaluations:
evaluatedAfter (Time)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations that ran at or after the given timestamp.
evaluatedBefore (Time)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations that ran at or before the given timestamp.
mode (GovernPolicyEvaluationMode)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations that ran in the given enforcement mode.
policyId (Int)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations of the policy with the given ID.
verdict (GovernPolicyEvaluationVerdict)
Introduced as an experiment in GitLab 19.4.

Return only the evaluations that produced the given verdict.
rules [PolicyStoreRule!]! Introduced as an experiment in GitLab 19.4.

Rule kinds available when creating a policy in the policy store.
triggers [PolicyStoreTrigger!]! Introduced as an experiment in GitLab 19.4.

Triggers available when creating a policy in the policy store.

PolicyStoreAction#

Action available when creating a policy in the policy store.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.4.

Identifier of the action.
name String! Introduced as an experiment in GitLab 19.4.

Human-readable name of the action.

PolicyStoreRole#

A role that can be assigned in a policy action.

Fields#

Name Type Description
id String! Introduced as an experiment in GitLab 19.4.

Unique identifier for the role.
name String! Introduced as an experiment in GitLab 19.4.

Human-readable name of the role.

PolicyStoreRule#

Rule kind available when creating a policy in the policy store.

Fields#

Name Type Description
id ID! Introduced as an experiment in GitLab 19.4.

Identifier of the rule kind.
name String! Introduced as an experiment in GitLab 19.4.

Human-readable name of the rule kind.

PolicyStoreTrigger#

Trigger available when creating a policy in the policy store.

Fields#

Name Type Description
availableRoles [PolicyStoreRole!]! Introduced as an experiment in GitLab 19.4.

Roles available for the trigger type.
id ID! Introduced as an experiment in GitLab 19.4.

Identifier of the trigger.
name String! Introduced as an experiment in GitLab 19.4.

Human-readable name of the trigger.

PolicyViolationDetails#

Represents the details of merge request approval policy violations.

Fields#

Name Type Description
anyMergeRequest [PolicyAnyMergeRequestViolation!]! Represents the violations of any_merge_request rules.
comparisonPipelines [PolicyComparisonPipeline!]! Represents the pipelines used for comparison in the policy evaluation.
errors [PolicyError!]! Represents the policy errors.
licenseScanning [PolicyLicenseScanningViolation!]! Represents the violations of license_scanning rules.
newScanFinding [PolicyScanFindingViolation!]! Represents the newly detected violations of scan_finding rules.
policies [PolicyViolationInfo!]! Information about policies that were violated.
previousScanFinding [PolicyScanFindingViolation!]! Represents the violations of scan_finding rules for previously existing vulnerabilities.
violationsCount Int! Total count of violations.

PolicyViolationInfo#

Represents generic policy violation information.

Fields#

Name Type Description
dismissed Boolean! Represents if a warn mode policy violation was dismissed.
enforcementType PolicyEnforcementType! Represents the enforcement type of the violated policy.
name String! Represents the name of the violated policy.
reportType ApprovalReportType! Represents the report type.
securityPolicyId ID Represents the violated security policy id.
status PolicyViolationStatus Represents the status of the violated policy.

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.

Principal#

Representation of who is provided access to. For eg: User/Role/MemberRole.

Fields#

Name Type Description
id ID! ID of the principal (User, MemberRole, Role).
type PrincipalType! Name of the principal (User, MemberRole, Role).
user UserCore User who is provided access to.
userRoleId String RoleID of the user.

Project#

Implements: ProjectInterface, Todoable

Fields#

Name Type Description
actualRepositorySizeLimit Float Size limit for the repository in bytes.
adminEditPath String Admin path for editing project. Only available to admins.
adminShowPath String Admin path of the project. Only available to admins.
agentConfigurations AgentConfigurationConnection Agent configurations defined by the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
aiCatalogItem AiCatalogItem Introduced as an experiment in GitLab 18.5.

AI Catalog item of the project.

Arguments for aiCatalogItem:
id (AiCatalogItemID!)
Global ID of the catalog item to find.
showSoftDeleted (Boolean)
Whether to show the item if it has been soft-deleted. Defaults to false.
aiCatalogItemConsumerForItem AiCatalogItemConsumer Introduced as an experiment in GitLab 19.0.

AI Catalog item configuration for the given item in the project.

Arguments for aiCatalogItemConsumerForItem:
id (AiCatalogItemID!)
Global ID of the catalog item to return the configuration of.
aiCatalogItems AiCatalogItemConnection! Introduced as an experiment in GitLab 18.6.

AI Catalog items of the project. This field can be resolved for only one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiCatalogItems:
allAvailable (Boolean)
Include public items from the AI Catalog.
enabled (Boolean)
Include only items that are enabled or disabled in the project.
itemTypes ([AiCatalogItemType!])
Types of items to retrieve.
search (String)
Search items by name and description.
sort (AiCatalogItemsSort)
Sort order of items.
aiFlowTriggers AiFlowTriggerTypeConnection Introduced as an experiment in GitLab 18.3.

AI flow triggers of the project. This field can only be resolved for one project per request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiFlowTriggers:
ids ([AiFlowTriggerID!])
Filter AI flow triggers by IDs.
aiGovernanceMetrics AiGovernanceMetrics Introduced as an experiment in GitLab 19.3.

Aggregated AI governance dashboard metrics. Returns null when the ai_governance_dashboard feature flag is disabled.

Arguments for aiGovernanceMetrics:
agentClass (AiGovernanceAgentClass)
Agent class to segment the metrics by. Defaults to ALL.
timeframe (AiGovernanceMetricsTimeframe)
Time window for the metrics. Defaults to LAST_7_DAYS.
aiGovernanceSessions AiGovernanceSessionConnection Introduced as an experiment in GitLab 19.5.

AI sessions for the project, from GitLab Duo and external agents. Returns no sessions when the ai_governance_sessions_api feature flag is disabled. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiGovernanceSessions:
agentClass (AiGovernanceAgentClass)
Filter sessions by agent class. Defaults to all agent classes.
flowType (String)
Filter by flow type.
id (AiGovernanceSessionID)
Global ID of the session.
not (AiGovernanceSessionNegatedFilterInput)
Negated filter conditions.
sessionStartedAfter (Time)
Return sessions started at or after the timestamp.
sessionStartedBefore (Time)
Return sessions started at or before the timestamp.
triggeredByUserId (UserID)
Filter to sessions triggered by the user with the given global ID.
aiGovernanceToolCalls AiGovernanceToolCallsReport Introduced as an experiment in GitLab 19.5.

Top tools invoked by AI agents, with invocation counts. Returns null when the ai_governance_dashboard or ai_governance_tool_calls feature flag is disabled or when ClickHouse is not enabled.

Arguments for aiGovernanceToolCalls:
agentClass (AiGovernanceAgentClass)
Agent class to segment the tool calls by. Defaults to ALL.
timeframe (AiGovernanceMetricsTimeframe)
Time window for the tool calls. Defaults to LAST_7_DAYS.
aiMetrics AiMetrics Introduced as an experiment in GitLab 16.11.

AI-related metrics.

Arguments for aiMetrics:
endDate (Date)
Date range to end at. Default is the end of current month.
startDate (Date)
Date range to start from. Default is the beginning of current month.
aiUsageData AiUsageData Introduced as an experiment in GitLab 17.5.

AI-related data.
aiUserMetrics AiUserMetricsConnection Introduced as an experiment in GitLab 17.5.

AI-related user metrics. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for aiUserMetrics:
endDate (Date)
Date range to end at. Default is the end of current month. ClickHouse needs to be enabled when passing this param.
sort (AiUserMetricsSort)
Sort AI user metrics.
startDate (Date)
Date range to start from. Default is the beginning of current month. ClickHouse needs to be enabled when passing this param.
aiXrayReports AiXrayReportConnection! Introduced as an experiment in GitLab 17.8.

X-ray reports of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
alertManagementAlert AlertManagementAlert A single Alert Management alert of the project.

Arguments for alertManagementAlert:
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 the criteria.
statuses ([AlertManagementStatus!])
Alerts with the specified statues. For example, [TRIGGERED].
alertManagementAlertStatusCounts AlertManagementAlertStatusCountsType Counts of alerts by status for the project.

Arguments for alertManagementAlertStatusCounts:
assigneeUsername (String)
Username of a user assigned to the issue.
search (String)
Search query for title, description, service, or monitoring_tool.
alertManagementAlerts AlertManagementAlertConnection Alert Management alerts of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementAlerts:
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 the criteria.
statuses ([AlertManagementStatus!])
Alerts with the specified statues. For example, [TRIGGERED].
alertManagementHttpIntegrations AlertManagementHttpIntegrationConnection HTTP Integrations which can receive alerts for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementHttpIntegrations:
id (AlertManagementHttpIntegrationID)
ID of the integration.
types ([AlertManagementIntegrationType!])
Types of integrations to return. Default is [HTTP].
alertManagementIntegrations AlertManagementIntegrationConnection Deprecated in GitLab 18.2. Use alertManagementHttpIntegrations. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for alertManagementIntegrations:
id (GlobalID)
ID of the integration.
alertManagementPayloadFields [AlertManagementPayloadAlertField!] Extract alert fields from payload for custom mapping.

Arguments for alertManagementPayloadFields:
payloadExample (String!)
Sample payload for extracting alert fields for custom mappings.
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.
allowsMultipleMergeRequestAssignees Boolean! Project allows assigning multiple users to a merge request.
allowsMultipleMergeRequestReviewers Boolean! Project allows assigning multiple reviewers to a merge request.
analytics Analytics Introduced as an experiment in GitLab 18.11.

Project analytics aggregation endpoints.
analyzerStatuses [AnalyzerProjectStatusType!] Status for all analyzers in the project.
apiFuzzingCiConfiguration ApiFuzzingCiConfiguration API fuzzing configuration for the project.
approvalPolicies ApprovalPolicyConnection Approval Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for approvalPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
archived Boolean Indicates if the project or any ancestor is archived.
ascpComponents AscpComponentConnection Introduced as an experiment in GitLab 18.11.

ASCP business components in the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ascpComponents:
subDirectory (String)
Filter by exact sub-directory path.
title (String)
Filter by component title (case-insensitive partial match).
ascpScans AscpScanConnection Introduced as an experiment in GitLab 18.10.

ASCP security scans for this project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ascpScans:
scanType (AscpScanType)
Filter by scan type.
autocloseReferencedIssues Boolean Indicates if issues referenced by merge requests and commits within the default branch are closed automatically.
autocompleteUsers [AutocompletedUser!] Search users for autocompletion.

Arguments for autocompleteUsers:
search (String)
Query to search users by name, username, or public email.
availableDeployKeys AccessLevelDeployKeyConnection List of available deploy keys. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for availableDeployKeys:
titleQuery (String)
Term by which to search deploy key titles.
avatarUrl String Avatar URL of the project.
board Board A single board of the project.

Arguments for board:
id (BoardID!)
ID of the board.
boards BoardConnection Boards of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for boards:
id (BoardID)
Find a board by its ID.
branchRules BranchRuleConnection Branch rules configured for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for branchRules:
buildMissing (Boolean)
Return unpersisted custom branch rules.
ciAccessAuthorizedAgents ClusterAgentAuthorizationCiAccessConnection Authorized cluster agents for the project through ci_access keyword. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciCdSettings ProjectCiCdSetting CI/CD settings for the project.
ciConfigPathOrDefault String! Path of the CI configuration file. Returns an empty string if the user does not have permission to read the repository.
ciConfigVariables [CiConfigVariable!] Introduced as an experiment in GitLab 15.3.

CI/CD config variable.

Arguments for ciConfigVariables:
failOnCacheMiss (Boolean)
Whether to throw an error if cache is not ready.
ref (String!)
Ref.
ciDownstreamProjectSubscriptions CiProjectSubscriptionConnection Introduced as an experiment in GitLab 17.6.

Pipeline subscriptions where this project is the upstream project.When this project's pipeline completes, a pipeline is triggered in the downstream project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciJobTokenAuthLogs CiJobTokenAuthLogConnection Introduced as an experiment in GitLab 17.6.

The CI Job Tokens authorization logs. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciJobTokenScope CiJobTokenScopeType The CI Job Tokens scope of access.
ciJobTokenScopeAllowlist CiJobTokenScopeAllowlist Introduced as an experiment in GitLab 17.6.

List of CI job token scopes where the project is the source.
ciPipelineCreationInputs [CiInputsSpec!] Introduced as an experiment in GitLab 17.10.

Inputs to create a pipeline.

Arguments for ciPipelineCreationInputs:
failOnCacheMiss (Boolean)
Whether to throw an error for a cache miss.
ref (String!)
Ref where to create the pipeline.
ciPipelineCreationRequest CiPipelineCreationRequest Introduced as an experiment in GitLab 17.9.

Get information about an asynchronous pipeline creation request.

Arguments for ciPipelineCreationRequest:
requestId (String!)
ID of the pipeline creation request.
ciSubscribedProjects CiSubscriptionsProjectConnection Deprecated in GitLab 17.6. Use ciDownstreamProjectSubscriptions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciSubscriptionsProjects CiSubscriptionsProjectConnection Deprecated in GitLab 17.6. Use ciUpstreamProjectSubscriptions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciTemplate CiTemplate Find a single CI/CD template by name.

Arguments for ciTemplate:
name (String!)
Name of the CI/CD template to search for. Template must be formatted as Name.gitlab-ci.yml.
ciUpstreamProjectSubscriptions CiProjectSubscriptionConnection Introduced as an experiment in GitLab 17.6.

Pipeline subscriptions where this project is the downstream project.When an upstream project's pipeline completes, a pipeline is triggered in the downstream project (this project). This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
ciVariables CiProjectVariableConnection List of the project's CI/CD variables. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for ciVariables:
sort (CiVariableSort)
Sort order of results.
clusterAgent ClusterAgent Find a single cluster agent by name.

Arguments for clusterAgent:
hasRemoteDevelopmentAgentConfig (Boolean)
Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled (Boolean)
Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities (Boolean)
Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig (Boolean)
Returns only cluster agents which have an associated workspaces agent config.
name (String!)
Name of the cluster agent.
clusterAgents ClusterAgentConnection Cluster agents associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for clusterAgents:
hasRemoteDevelopmentAgentConfig (Boolean)
Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled (Boolean)
Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities (Boolean)
Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig (Boolean)
Returns only cluster agents which have an associated workspaces agent config.
codeCoverageSummary CodeCoverageSummary Code coverage summary associated with the project.
commitReferences CommitReferences Introduced as an experiment in GitLab 16.0.

Get tag names containing a given commit.

Arguments for commitReferences:
commitSha (String!)
Project commit SHA identifier. For example, 287774414568010855642518513f085491644061.
complianceControlStatus ProjectComplianceControlStatusTypeConnection Introduced as an experiment in GitLab 17.11.

Compliance control statuses for a project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceControlStatus:
filters (ProjectComplianceControlStatusInput)
Filters applied when retrieving compliance control statuses for the project.
complianceFrameworks ComplianceFrameworkConnection Compliance frameworks associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceFrameworks:
sort (ComplianceFrameworkSort)
Sort compliance frameworks by the criteria.
complianceRequirementStatuses ProjectComplianceRequirementStatusConnection Introduced as an experiment in GitLab 18.0.

Compliance requirement statuses for a project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceRequirementStatuses:
filters (ProjectRequirementComplianceStatusInput)
Filters applied when retrieving compliance requirement statuses.
orderBy (ProjectComplianceRequirementStatusOrderBy)
Field used to sort compliance requirement statuses.
complianceStandardsAdherence ComplianceStandardsAdherenceConnection Compliance standards adherence for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for complianceStandardsAdherence:
filters (ComplianceStandardsProjectAdherenceInput)
Filters applied when retrieving compliance standards adherence.
componentUsages CiCatalogResourceComponentUsageConnection Component(s) used by the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
componentVersions ComponentVersionConnection! Introduced as an experiment in GitLab 17.10.

Find software dependency versions by component name. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for componentVersions:
componentName (String!)
Name of the SBoM component.
components [Component!] Introduced as an experiment in GitLab 17.9.

Find software dependencies by name.

Arguments for components:
name (String)
Entire name or part of the name.
containerExpirationPolicy ContainerExpirationPolicy Deprecated in GitLab 17.5. Use container_tags_expiration_policy.
containerProtectionRepositoryRules ContainerProtectionRepositoryRuleConnection Container protection rules for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
containerProtectionTagRules ContainerProtectionTagRuleConnection Container repository tag protection rules for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
containerRegistryEnabled Boolean Indicates if Container registry is enabled for the current user.
containerRepositories ContainerRepositoryConnection Container repositories of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for containerRepositories:
name (String)
Filter the container repositories by their name.
sort (ContainerRepositorySort)
Sort container repositories by the criteria.
containerRepositoriesCount Int! Number of container repositories in the project.
containerScanningForRegistryEnabled Boolean Indicates whether container scanning for registry is enabled or not for the project. Returns null if unauthorized.
containerTagsExpirationPolicy ContainerTagsExpirationPolicy Container tags expiration policy of the project.
corpuses CoverageFuzzingCorpusConnection Find corpuses of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time Timestamp of the project creation.
customAttributes [CustomAttribute!] Custom attributes of the project. Only available to admins.
customizableDashboardVisualizations CustomizableDashboardVisualizationConnection Introduced as an experiment in GitLab 16.1.

Visualizations of the project or associated configuration project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customizableDashboardVisualizations:
slug (String)
Slug of the visualization to return.
customizableDashboards CustomizableDashboardConnection Introduced as an experiment in GitLab 15.6.

Customizable dashboards for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for customizableDashboards:
category (CustomizableDashboardCategory)
Find by dashboard type.
slug (String)
Find by dashboard slug.
dastProfile DastProfile DAST Profile associated with the project.

Arguments for dastProfile:
hasDastProfileSchedule (Boolean)
Filter DAST Profiles by whether or not they have a schedule.
id (DastProfileID!)
ID of the DAST Profile.
dastProfiles DastProfileConnection DAST Profiles associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dastProfiles:
hasDastProfileSchedule (Boolean)
Filter DAST Profiles by whether or not they have a schedule.
dastScannerProfiles DastScannerProfileConnection DAST scanner profiles associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
dastSiteProfile DastSiteProfile DAST Site Profile associated with the project.

Arguments for dastSiteProfile:
id (DastSiteProfileID!)
ID of the site profile.
dastSiteProfiles DastSiteProfileConnection DAST Site Profiles associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
dastSiteValidations DastSiteValidationConnection DAST Site Validations associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dastSiteValidations:
normalizedTargetUrls ([String!])
Normalized URL of the target to be scanned.
status (DastSiteValidationStatusEnum)
Status of the site validation.
dataTransfer ProjectDataTransfer Data transfer data point for a specific period. This is mocked data under a development feature flag.

Arguments for dataTransfer:
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.
defaultMergeRequestTarget Project Default target project of merge requests created from the project. For a fork, this is the upstream project when the fork can target it, and the fork itself otherwise. Returns null when the target project is not visible to the current user.
dependencies DependencyConnection Software dependencies used by the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencies:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
dependencyFirewallActivitySummary DependencyFirewallActivitySummary Introduced as an experiment in GitLab 19.3.

Aggregate dependency firewall activity totals for the project. Available behind the dependency_firewall_phase1 feature flag. This field can be resolved for only one project in any single request.

Arguments for dependencyFirewallActivitySummary:
from (Date)
Start date (inclusive) of the activity window. Defaults to 7 days ago.
to (Date)
End date (inclusive) of the activity window. Defaults to the current date.
dependencyFirewallRuleActivity [DependencyFirewallRuleActivity!] Introduced as an experiment in GitLab 19.3.

Dependency firewall per-rule block and warn activity for the project. Available behind the dependency_firewall_phase1 feature flag.

Arguments for dependencyFirewallRuleActivity:
from (Date)
Start date (inclusive) of the activity window. Defaults to 7 days ago.
to (Date)
End date (inclusive) of the activity window. Defaults to the current date.
dependencyPaths DependencyPathPage Introduced as an experiment in GitLab 17.10.

Ancestor dependency paths for a dependency used by the project. Returns null if dependency_graph_graphql feature flag is disabled.

Arguments for dependencyPaths:
after (String)
Fetch paths after the cursor.
before (String)
Fetch paths before the cursor.
limit (Int)
Number of paths to fetch.
occurrence (SbomOccurrenceID!)
Dependency path for occurrence.
dependencyProxyPackagesSetting DependencyProxyPackagesSetting 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.
dependencyTrackedRefs DependencyTrackedRefConnection Introduced as an experiment in GitLab 19.3.

Refs (branches or tags) where a software dependency appears. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencyTrackedRefs:
componentVersionId (SbomComponentVersionID!)
Global ID of the component version to find refs for.
search (String)
Filter refs by name.
deployment Deployment Details of the deployment of the project.

Arguments for deployment:
iid (ID!)
Project-level internal ID of the Deployment.
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.
duoAgenticChatAvailable Boolean Introduced as an experiment in GitLab 18.1.

User access to Duo agentic Chat feature.
duoContextExclusionSettings DuoContextExclusionSettings Introduced as an experiment in GitLab 18.2.

Settings for excluding files from Duo context.
duoDependencyBumpBreakingChangesAvailable Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether the GitLab Duo resolve dependency bump breaking changes flow can be triggered for the project.
duoFeaturesEnabled Boolean Introduced as an experiment in GitLab 16.9.

Indicates whether GitLab Duo features are enabled for the project.
duoMcpServersCount Int Introduced as an experiment in GitLab 19.4.

Number of distinct MCP servers used by the project's configured agents. Resolved on request only, because it reads the configured agents and their versions.
duoWorkflowEvents DuoWorkflowEventConnection Checkpoints for GitLab Duo Agent Platform flows, for all users (remote flows only). Returns only the latest checkpoint by default. Use first and after to page through history. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowEvents:
workflowId (AiDuoWorkflowsWorkflowID!)
Array of request IDs to fetch.
duoWorkflowRunnerAvailable Boolean Introduced as an experiment in GitLab 19.3.

Indicates whether the project has a runner that can pick up GitLab Duo Agent Platform workloads. Resolved on request only, because it queries the project's runners and their managers.
duoWorkflowSessionArtifacts DuoWorkflowSessionArtifactConnection Introduced as an experiment in GitLab 19.1.

Duo Agent Platform session artifacts for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowSessionArtifacts:
agentClass (AiGovernanceAgentClass)
Filter sessions by agent class. Defaults to all agent classes.
not (DuoWorkflowSessionArtifactNegatedFilterInput)
Negated filter conditions.
triggeredByUserId (UserID)
Filter to sessions triggered by the user with the given global ID.
workflowCreatedAfter (Time)
Return sessions created after the timestamp.
workflowCreatedBefore (Time)
Return sessions created before the timestamp.
workflowDefinition (String)
Filter by workflow definition.
workflowId (AiDuoWorkflowsWorkflowID)
Filter to a single session by its workflow (session) global ID.
duoWorkflowStatusCheck DuoWorkflowEnablement Introduced as an experiment in GitLab 17.7.

Indicates whether Duo Agent Platform is enabled for the project.
duoWorkflowUsableRunnerType String Introduced as an experiment in GitLab 19.3.

Runner type (instance_type, group_type, or project_type) of the runner that can pick up GitLab Duo Agent Platform workloads, or null when none can. Shares its runner scan with duoWorkflowRunnerAvailable when both are requested.
duoWorkflowWorkflows DuoWorkflowConnection GitLab Duo Agent Platform flows for a project, for all users (remote flows only). This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowWorkflows:
environment (WorkflowEnvironment)
Environment, for example, IDE or web.
excludeSourceTypes ([DuoWorkflowSourceType!])
Introduced as an experiment in GitLab 19.5.

Source types to exclude. Sessions with no recorded source type are never excluded.
excludeTypes ([String!])
Types of flows to exclude (for example, ["software_development", "chat"]).
ids ([AiDuoWorkflowsWorkflowID!])
Filter flows by a list of IDs.
projectId (ProjectID)
Global ID of the project that contains the flows.
projectPath (ID)
Full path of the project that contains the flows.
search (String)
Flow title or goal to search for.
sort (DuoWorkflowsWorkflowSort)
Sort flows by the criteria.
statusGroup (DuoWorkflowStatusGroup)
Status group to filter flow sessions by.
statuses ([DuoWorkflowStatus!])
Exact statuses to filter flow sessions by. Cannot be combined with statusGroup.
type (String)
Type of flow to filter by (for example, software_development or foundational_chat_agents).
updatedAfter (ISO8601DateTime)
Filters flows updated after a given date.
workflowId (AiDuoWorkflowsWorkflowID)
Flow ID to filter by.
editPath String! Path for editing project.
environment Environment A single environment of the project.

Arguments for environment:
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.
environments EnvironmentConnection Environments of the project. This field can only be resolved for one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for environments:
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.
exploreCatalogPath String Introduced as an experiment in GitLab 17.6.

Path to the project catalog resource.
flowMetrics ProjectValueStreamAnalyticsFlowMetrics Introduced as an experiment in GitLab 15.10.

Flow metrics for value stream analytics.
forkDetails ForkDetails Introduced as an experiment in GitLab 15.7.

Details of the fork project compared to its upstream project.

Arguments for forkDetails:
ref (String)
Ref of the fork. Default value is HEAD.
forkTargets NamespaceConnection Namespaces in which the current user can fork the project into. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for forkTargets:
search (String)
Search query for path or name.
forkedFrom Project Project the project was forked from.
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.
gitlabSubscriptionsPreviewBillableUserChange PreviewBillableUserChange Preview Billable User Changes.

Arguments for gitlabSubscriptionsPreviewBillableUserChange:
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.
googleCloudArtifactRegistryRepository GoogleCloudArtifactRegistryRepository Introduced as an experiment in GitLab 16.10.

Google Artifact Registry repository. Returns null if the GitLab instance is not a SaaS instance.
grafanaIntegration GrafanaIntegration Deprecated in GitLab 18.3. Feature was removed in 16.0. Always returns null.
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.
incidentManagementEscalationPolicies EscalationPolicyTypeConnection Incident Management escalation policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for incidentManagementEscalationPolicies:
name (String)
Fuzzy search by escalation policy name.
incidentManagementEscalationPolicy EscalationPolicyType Incident Management escalation policy of the project.

Arguments for incidentManagementEscalationPolicy:
id (IncidentManagementEscalationPolicyID!)
ID of the escalation policy.
name (String)
Fuzzy search by escalation policy name.
incidentManagementOncallSchedules IncidentManagementOncallScheduleConnection Incident Management On-call schedules of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for incidentManagementOncallSchedules:
iids ([ID!])
IIDs of on-call schedules.
incidentManagementTimelineEvent TimelineEventType Incident Management Timeline event associated with the incident.

Arguments for incidentManagementTimelineEvent:
id (IncidentManagementTimelineEventID!)
ID of the timeline event.
incidentId (IssueID!)
ID of the incident.
incidentManagementTimelineEventTags [TimelineEventTagType!] Timeline event tags for the project.
incidentManagementTimelineEvents TimelineEventTypeConnection Incident Management Timeline events associated with the incident. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for incidentManagementTimelineEvents:
incidentId (IssueID!)
ID of the incident.
inheritedCiVariables InheritedCiVariableConnection List of CI/CD variables the project inherited from its parent group and ancestors. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for inheritedCiVariables:
sort (CiGroupVariablesSort)
Sort variables by the criteria.
isCatalogResource Boolean Introduced as an experiment in GitLab 15.11.

Indicates if a project is a catalog resource.
isForked Boolean! Project is forked.
isPublished Boolean Introduced as an experiment in GitLab 18.6.

Indicates if a project's catalog resource is published.
isSelfArchived Boolean Introduced as an experiment in GitLab 18.6.

Indicates if the project is archived.
isSelfDeletionInProgress Boolean! Introduced as an experiment in GitLab 18.3.

Indicates if project deletion is in progress.
isSelfDeletionScheduled Boolean! Introduced as an experiment in GitLab 18.3.

Indicates if project deletion is scheduled.
issue Issue A single issue of the project.

Arguments for issue:
assigneeId (String)
ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername (String)
Deprecated in GitLab 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 the date.
closedBefore (Time)
Issues closed before the date.
confidential (Boolean)
Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter (Time)
Issues created after the date.
createdBefore (Time)
Issues created before the date.
crmContactId (String)
ID of a contact assigned to the issues.
crmOrganizationId (String)
ID of an organization assigned to the issues.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter (Time)
Return issues due on or after the given time.
dueBefore (Time)
Return issues due on or before the given time.
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 GitLab 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 the issue.
milestoneTitle ([String])
Milestone applied to the 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 the criteria.
state (IssuableState)
Current state of the issue.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Issues the current user is subscribed to.
types ([IssueType!])
Filter issues by the given issue types.
updatedAfter (Time)
Issues updated after the date.
updatedBefore (Time)
Issues updated before the date.
weight (String)
Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter issues by work item type global IDs.
issueStatusCounts IssueStatusCountsType Counts of issues by status for the project.

Arguments for issueStatusCounts:
assigneeId (String)
ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername (String)
Deprecated in GitLab 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 the date.
closedBefore (Time)
Issues closed before the date.
confidential (Boolean)
Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter (Time)
Issues created after the date.
createdBefore (Time)
Issues created before the date.
crmContactId (String)
ID of a contact assigned to the issues.
crmOrganizationId (String)
ID of an organization assigned to the issues.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter (Time)
Return issues due on or after the given time.
dueBefore (Time)
Return issues due on or before the given time.
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 the issue.
milestoneTitle ([String])
Milestone applied to the 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Issues the current user is subscribed to.
types ([IssueType!])
Filter issues by the given issue types.
updatedAfter (Time)
Issues updated after the date.
updatedBefore (Time)
Issues updated before the date.
weight (String)
Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter issues by work item type global IDs.
issues IssueConnection Issues of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issues:
assigneeId (String)
ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assigneeUsername (String)
Deprecated in GitLab 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 the date.
closedBefore (Time)
Issues closed before the date.
confidential (Boolean)
Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
createdAfter (Time)
Issues created after the date.
createdBefore (Time)
Issues created before the date.
crmContactId (String)
ID of a contact assigned to the issues.
crmOrganizationId (String)
ID of an organization assigned to the issues.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter (Time)
Return issues due on or after the given time.
dueBefore (Time)
Return issues due on or before the given time.
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 GitLab 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 the issue.
milestoneTitle ([String])
Milestone applied to the 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 the criteria.
state (IssuableState)
Current state of the issue.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Issues the current user is subscribed to.
types ([IssueType!])
Filter issues by the given issue types.
updatedAfter (Time)
Issues updated after the date.
updatedBefore (Time)
Issues updated before the date.
weight (String)
Weight applied to the issue, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter issues by work item type global IDs.
issuesAccessLevel ProjectFeatureAccess Access level required for issues access.
issuesEnabled Boolean Indicates if Issues are enabled for the current user.
iterationCadences IterationCadenceConnection Find iteration cadences. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for iterationCadences:
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 the 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.
iterations IterationConnection Find iterations. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for iterations:
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 GitLab 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
jiraImportStatus String Status of Jira import background job of the project.
jiraImports JiraImportConnection Jira imports into the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
job CiJob One job belonging to the project, selected by ID.

Arguments for job:
id (JobID!)
ID of the job.
jobAnalytics CiJobAnalyticsConnection Introduced as an experiment in GitLab 18.5.

CI/CD job analytics for the project. Returns an error if ClickHouse is not configured. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobAnalytics:
fromTime (Time)
Start of the requested time (in UTC). Defaults to the pipelines started in the past week. Cannot be earlier than 180 days ago.
nameSearch (String)
Search by name of the pipeline jobs. Supports partial matches.
ref (String)
Branch that triggered the pipeline.
sort (CiJobAnalyticsSort)
Sort order for the results.
source (CiPipelineSources)
Source of the pipeline.
toTime (Time)
End of the requested time (in UTC). Defaults to the pipelines started before the current date.
jobs CiJobConnection Jobs of a project. This field can only be resolved for one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for jobs:
kind (CiJobKind)
Filter jobs by kind.
name (String)
Introduced as an experiment in GitLab 17.11.

Filter jobs by name.
pipelineIid (String)
Filter jobs by the internal pipeline ID (iid).
sources ([CiJobSource!])
Introduced as an experiment in GitLab 17.7.

Filter jobs by source.
statuses ([CiJobStatus!])
Filter jobs by status.
withArtifacts (Boolean)
Filter by artifacts presence.
jobsEnabled Boolean Indicates if CI/CD pipeline jobs are enabled for the current user.
label Label Label available on the project.

Arguments for label:
title (String!)
Title of the label.
labels LabelConnection Labels available on this project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for labels:
archived (Boolean)
Filters archived labels. Defaults to false.
fuzzySearch (Boolean)
Match searchTerm fuzzily: labels match when they contain the searched characters in order, but not necessarily contiguously (for example, bugu matches bug::ux). Ignored if using title, or if the fuzzy_label_search feature flag is disabled.
includeAncestorGroups (Boolean)
Include labels from ancestor groups.
searchIn ([LabelSearchFieldList!]!)
Specify which fields to search in. Ignored if using title.
searchTerm (String)
Search term to find labels with.
title (String)
Exact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.
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.
licensedFeatureAvailability LicensedFeatureAvailability! Introduced as an experiment in GitLab 18.11.

Check whether a licensed feature is available.

Arguments for licensedFeatureAvailability:
feature (LicensedFeature!)
Feature to check availability for (for example, SECURITY_DASHBOARD).
markedForDeletion Boolean Introduced as an experiment in GitLab 18.1.

Indicates if the project or any ancestor is scheduled for deletion.
markedForDeletionOn Time Introduced as an experiment in GitLab 16.10.

Date when project was scheduled to be deleted.
maxAccessLevel AccessLevel! Maximum access level of the current user in the project.
memberRoles MemberRoleConnection Introduced as an experiment in GitLab 16.5.

Member roles available for the group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for memberRoles:
assignable (Boolean)
Filter for member roles the current user can assign.
id (MemberRoleID)
Global ID of the member role to look up.
ids ([MemberRoleID!])
Global IDs of the member role to look up.
orderBy (MemberRolesOrderBy)
Ordering column. Default is NAME.
sort (SortDirectionEnum)
Ordering column. Default is ASC.
mergeCommitTemplate String Template used to create merge commit message in merge requests.
mergeRequest MergeRequest A single merge request of the project.

Arguments for mergeRequest:
iid (String!)
IID of the merge request, for example 1.
mergeRequestTitleRegex String Regex used to validate the title of merge requests.
mergeRequestTitleRegexDescription String Description of the regex used to validate the title of merge requests.
mergeRequestViolations ComplianceViolationConnection Compliance violations reported on merge requests merged within the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequestViolations:
filters (ComplianceViolationProjectInput)
Filters applied when retrieving compliance violations.
sort (ComplianceViolationSort)
List compliance violations by sort order.
mergeRequests MergeRequestConnection Merge requests of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
mergeRequestsAccessLevel ProjectFeatureAccess Access level required for merge requests access.
mergeRequestsDefaultTargetSelf Boolean Indicates if merge requests of a forked project target the fork itself by default instead of the upstream project.
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.
mergeTrains MergeTrainConnection Introduced as an experiment in GitLab 17.1.

Merge trains available to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mergeTrains:
status (MergeTrainStatus)
Filter merge trains by a specific status.
targetBranches ([String!])
Filter merge trains by a list of target branches.
milestones MilestoneConnection Milestones of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for milestones:
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 the criteria.
state (MilestoneStateEnum)
Filter milestones by state.
timeframe (Timeframe)
List items overlapping the given timeframe.
title (String)
Title of the milestone.
mlExperiments MlExperimentConnection Find machine learning experiments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mlExperiments:
name (String)
Search for names that include the string.
orderBy (MlModelsOrderBy)
Ordering column. Default is created_at.
sort (SortDirectionEnum)
Ordering direction. Default is desc.
mlModels MlModelConnection Introduced as an experiment in GitLab 16.8.

Finds machine learning models. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for mlModels:
name (String)
Search for names that include the string.
orderBy (MlModelsOrderBy)
Ordering column. Default is created_at.
sort (SortDirectionEnum)
Ordering column. Default is desc.
name String! Name of the project without the namespace.
nameWithNamespace String! Name of the project including the namespace.
namespace Namespace Namespace of the project.
nestedEnvironments NestedEnvironmentConnection Environments for this project with nested folders, can only be resolved for one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for nestedEnvironments:
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.
observabilityLogsLinks ObservabilityLogConnection Introduced as an experiment in GitLab 17.4.

Logs attached to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for observabilityLogsLinks:
fingerprint (String)
Fingerprint of the log.
serviceName (String)
Service name of the log.
severityNumber (Int)
Severity number of the log.
timestamp (ISO8601DateTime)
Log timestamp of the log.
traceIdentifier (String)
Trace id of the log.
observabilityMetricsLinks ObservabilityMetricConnection Introduced as an experiment in GitLab 17.4.

Metrics attached to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for observabilityMetricsLinks:
name (String)
Name of the metric.
type (OpenTelemetryMetricType)
Type of the metric.
observabilityTracesLinks ObservabilityTraceConnection Introduced as an experiment in GitLab 17.4.

Traces attached to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for observabilityTracesLinks:
traceIdentifier (String)
Identifier of the trace.
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.
orbit OrbitNamespace Introduced as an experiment in GitLab 19.5.

Orbit data of the project. Returns null when Orbit is not available to the current user.
organizationEditPath String Introduced as an experiment in GitLab 16.11.

Path for editing project at the organization level.
packages PackageConnection Packages of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for packages:
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 the criteria.
status (PackageStatus)
Filter a package by status.
packagesCleanupPolicy PackagesCleanupPolicy Packages cleanup policy for the project.
packagesProtectionRules PackagesProtectionRuleConnection Introduced as an experiment in GitLab 16.6.

Packages protection rules for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pagesDeployments PagesDeploymentConnection List of the project's Pages Deployments. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pagesDeployments:
active (Boolean)
Filter by active or inactive state.
sort (Sort)
Sort results.
versioned (Boolean)
Filter deployments that are versioned or unversioned.
pagesForceHttps Boolean! Project's Pages site redirects unsecured connections to HTTPS.
pagesUseUniqueDomain Boolean! Project's Pages site uses a unique subdomain.
path String! Path of the project.
pathLocks PathLockConnection The project's path locks. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pendingMemberApprovals MemberApprovalConnection Pending member promotions of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
permanentDeletionDate String Introduced as an experiment in GitLab 16.11.

For projects pending deletion, returns the project's scheduled deletion date. For projects not pending deletion, returns a theoretical date based on current settings if marked for deletion today.
pipeline Pipeline Pipeline of the project. If no arguments are provided, returns the latest pipeline for the head commit on the default branch.

Arguments for pipeline:
id (CiPipelineID)
Global ID of the Pipeline. For example, "gid://gitlab/Ci::Pipeline/314".
iid (ID)
IID of the Pipeline. For example, "1".
sha (String)
SHA of the Pipeline. For example, "dyd0f15ay83993f5ab66k927w28673882x99100b".
pipelineAnalytics PipelineAnalytics Pipeline analytics.

Arguments for pipelineAnalytics:
fromTime (Time)
Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref (String)
Branch that triggered the pipeline.
source (CiPipelineSources)
Source of the pipeline.
subgroupFullPaths ([String!])
Introduced as an experiment in GitLab 18.11.

Full paths of subgroups to filter by. Only applies when querying pipeline analytics for a group (maximum is 10).
toTime (Time)
End of the requested time (in UTC). Defaults to the pipelines started before the current date.
pipelineCounts PipelineCounts Pipeline counts of the project.

Arguments for pipelineCounts:
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.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
pipelineExecutionSchedulePolicies PipelineExecutionSchedulePolicyConnection Pipeline Execution Schedule Policies of the namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineExecutionSchedulePolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
pipelineScheduleStatusCounts PipelineScheduleStatusCount Counts of pipeline schedules by status.
pipelineSchedules PipelineScheduleConnection Pipeline schedules of the project. This field can only be resolved for one project per request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelineSchedules:
ids ([ID!])
Filter pipeline schedules by IDs.
sort (PipelineScheduleSort)
List pipeline schedules by sort order. Default is id_desc.
status (PipelineScheduleStatus)
Filter pipeline schedules by active status.
pipelineTriggers PipelineTriggerConnection Introduced as an experiment in GitLab 16.3.

List of pipeline trigger tokens. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipelines PipelineConnection Pipelines of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for pipelines:
ids ([ID!])
Filter pipelines by their Global IDs. Maximum 20 IDs per request.
ref (String)
Filter pipelines by the ref they are run for.
refType (RefType)
Type of ref.
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 the date.
updatedBefore (Time)
Pipelines updated before the date.
username (String)
Filter pipelines by the user that triggered the pipeline.
preReceiveSecretDetectionEnabled Boolean Indicates whether secret push protection is on or not for the project.
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.
projectMembers MemberInterfaceConnection Members of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for projectMembers:
accessLevels ([AccessLevelEnum!])
Filter members by the given access levels.
ids ([ID!])
List of project members IDs.
relations ([ProjectMemberRelation!])
Filter members by the given member relations.
search (String)
Search query.
sort (MemberSort)
sort query.
userTypes ([UserType!])
Introduced as an experiment in GitLab 18.3.

Filter by user type.
projectPlanLimits ProjectPlanLimits Introduced as an experiment in GitLab 16.9.

Plan limits for the current project.
protectableBranches [String!] Introduced as an experiment in GitLab 16.9.

List of unprotected branches, ignoring any wildcard branch rules.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
release Release A single release of the project.

Arguments for release:
tagName (String!)
Name of the tag associated to the release.
releases ReleaseConnection Releases of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for releases:
sort (ReleaseSort)
Sort releases by given criteria.
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.
requirement Requirement Find a single requirement.

Arguments for requirement:
authorUsername ([String!])
Filter requirements by author username.
iid (ID)
Deprecated in GitLab 15.8. Use work_item_iid instead.
iids ([ID!])
Deprecated in GitLab 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].
requirementStatesCount RequirementStatesCount Number of requirements for the project by their state.
requirements RequirementConnection Find requirements. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for requirements:
authorUsername ([String!])
Filter requirements by author username.
iid (ID)
Deprecated in GitLab 15.8. Use work_item_iid instead.
iids ([ID!])
Deprecated in GitLab 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].
rootGroup Group Top-level group of the project.
runnerCloudProvisioning CiRunnerCloudProvisioning Introduced as an experiment in GitLab 16.9.

Information used for provisioning the runner on a cloud provider. Returns null if the GitLab instance is not a SaaS instance.

Arguments for runnerCloudProvisioning:
cloudProjectId (GoogleCloudProject!)
Identifier of the cloud project.
provider (CiRunnerCloudProvider!)
Identifier of the cloud provider.
runners CiRunnerConnection Find runners visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for runners:
active (Boolean)
Deprecated in GitLab 14.8. Renamed. Use paused instead.
creatorId (UserID)
Filter runners by creator ID.
creatorUsername (String)
Filter runners by creator username.
ownerFullPath (String)
Introduced as an experiment in GitLab 17.8.

Filter runners by owning project or group.
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)
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'.
sastCiConfiguration SastCiConfiguration SAST CI configuration for the project.
savedReplies ProjectSavedReplyConnection Saved replies available to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply ProjectSavedReply Saved reply in the project.

Arguments for savedReply:
id (ProjectsSavedReplyID!)
Global ID of a saved reply.
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanExecutionPolicies:
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.
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
scanProfileStatuses [ScanProfileProjectStatus!] Introduced as an experiment in GitLab 19.0.

Scan profile statuses for the project.
scanResultPolicies ScanResultPolicyConnection Deprecated in GitLab 16.9. Use approvalPolicies. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for scanResultPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
secretPushProtectionEnabled Boolean Indicates whether secret push protection is on or not for the project.
securityAttributes SecurityAttributeConnection Introduced as an experiment in GitLab 18.5.

Security attributes linked to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
securityConfigurationPath String Path to project's security configuration.
securityDashboardPath String Path to project's security dashboard.
securityExclusion ProjectSecurityExclusion Introduced as an experiment in GitLab 17.4.

A single security exclusion of a project.

Arguments for securityExclusion:
active (Boolean)
Filter entries by active status.
id (SecurityProjectSecurityExclusionID!)
ID of the project security exclusion.
scanner (ExclusionScannerEnum)
Filter entries by scanner.
type (ExclusionTypeEnum)
Filter entries by exclusion type.
securityExclusions ProjectSecurityExclusionConnection Introduced as an experiment in GitLab 17.4.

Security exclusions of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityExclusions:
active (Boolean)
Filter entries by active status.
scanner (ExclusionScannerEnum)
Filter entries by scanner.
type (ExclusionTypeEnum)
Filter entries by exclusion type.
securityMetrics SecurityMetrics Introduced as an experiment in GitLab 18.3.

Security metrics.This feature is currently under development and not yet available for general use.

Arguments for securityMetrics:
projectId ([ID!])
Filter by project IDs in a group or an organization. This argument is ignored when we are querying for a project.
reportType ([VulnerabilityReportType!])
Filter by report types.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 18.8.

Filter by security attributes. Up to 20 filters.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref IDs. This argument is ignored when querying for a group. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
securityPolicies SecurityPolicyTypeConnection Introduced as an experiment in GitLab 18.1.

All security policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicies:
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship.
type (PolicyType)
Filter policies by type.
securityPolicyEligibleProjects ProjectConnection Introduced as an experiment in GitLab 19.0.

All projects eligible for policy scope selection when this project is used as a Security Policy Project. Includes projects from root ancestors of all linked groups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicyEligibleProjects:
ids ([ProjectID!])
Filter eligible projects by global IDs (used to hydrate already-selected projects). A maximum of 100 IDs can be provided.
search (String)
Search query for project name or path.
securityPolicyPipelineMustSucceed Boolean Introduced as an experiment in GitLab 18.11.

Indicates that all security policy pipelines must succeed before merge requests can be merged.
securityPolicyProject Project Security policy project assigned to the project, absent if assigned to a parent group.
securityPolicyProjectLinkedGroups GroupConnection Groups linked to the project, when used as Security Policy Project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicyProjectLinkedGroups:
ids ([ID!])
Filter groups by IDs.
search (String)
Search query for groups.
topLevelOnly (Boolean)
Only include top-level groups.
securityPolicyProjectLinkedNamespaces NamespaceConnection Deprecated in GitLab 17.4. Renamed. Use security_policy_project_linked_groups instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
securityPolicyProjectLinkedProjects ProjectConnection Projects linked to the project, when used as Security Policy Project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
securityPolicyProjectSuggestions ProjectConnection Security policy project suggestions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityPolicyProjectSuggestions:
onlyLinked (Boolean)
Whether to suggest only projects already linked as security policy projects.
search (String!)
Search query for projects' full paths.
securityScanProfiles [ScanProfileType!] Introduced as an experiment in GitLab 18.7.

Security scan profiles attached to the project.
securityScanners SecurityScanners Information about security analyzers used in the project.
securityTrackedRefs SecurityTrackedRefConnection Introduced as an experiment in GitLab 18.8.

Refs tracked for security vulnerabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for securityTrackedRefs:
state (SecurityTrackedRefState)
Filter by tracking state. Values: "TRACKED", "UNTRACKED". Returns all refs if not specified.
securityTrainingProviders [ProjectSecurityTraining!] List of security training providers for the project.

Arguments for securityTrainingProviders:
onlyEnabled (Boolean)
Filter the list by only enabled security trainings.
securityTrainingUrls [SecurityTrainingUrl!] Security training URLs for the enabled training providers of the project.

Arguments for securityTrainingUrls:
filename (String)
Filename to filter security training URLs by programming language.
identifierExternalIds ([String!]!)
List of external IDs of vulnerability identifiers.
sentryDetailedError SentryDetailedError Detailed version of a Sentry error on the project.

Arguments for sentryDetailedError:
id (GitlabErrorTrackingDetailedErrorID!)
ID of the Sentry issue.
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.
services ServiceConnection Project services. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for services:
active (Boolean)
Indicates if the integration is active.
type (ServiceType)
Type of integration.
sharedRunnersEnabled Boolean Indicates if shared runners are enabled for the project.
snippets SnippetConnection Snippets of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
snippetsEnabled Boolean Indicates if Snippets are enabled for the current user.
sourcedMergeRequests MergeRequestConnection Merge requests that have this project as their source, including merge requests targeting other projects. Ordered by ID in descending order. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for sourcedMergeRequests:
sourceBranches ([String!]!)
Array of source branch names (maximum is 100). 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 the state.
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 GitLab 13.12. Use topics.
targetBranchRules ProjectTargetBranchRuleConnection Target branch rules of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
terraformState TerraformState Find a single Terraform state by name.

Arguments for terraformState:
name (String!)
Name of the Terraform state.
terraformStateProtectionRules TerraformStateProtectionRuleConnection Introduced as an experiment in GitLab 18.11.

Terraform state protection rules for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
terraformStates TerraformStateConnection Terraform states associated with the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
timelogCategories TimeTrackingTimelogCategoryConnection Introduced as an experiment in GitLab 15.3.

Timelog categories for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
timelogs TimelogConnection Time logged on issues and merge requests in the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
topics [String!] List of project topics.
trackingKey String Introduced as an experiment in GitLab 16.0.

Tracking key assigned to the project.
transferInProgress Boolean! Introduced as an experiment in GitLab 19.3.

Indicates if the project is currently being transferred.
triageAndRemediationCoverage TriageAndRemediationCoverage Introduced as an experiment in GitLab 19.5.

Triage and remediation capability coverage for the project.
unprotectedBranches StringConnection Introduced as an experiment in GitLab 19.4.

Paginated list of unprotected branches, ignoring any wildcard branch rules. Supports forward-only pagination with first and after. This field can only be resolved for one project in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for unprotectedBranches:
search (String)
Search query to filter branch names (case-insensitive).
updatedAt Time Timestamp of when the project was last updated.
userAccessAuthorizedAgents ClusterAgentAuthorizationUserAccessConnection Authorized cluster agents for the project through user_access keyword. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
userPermissions ProjectPermissions! Permissions for the current user on the resource.
valueStreamAnalytics ValueStreamAnalytics Information about Value Stream Analytics within the project.
valueStreamDashboardUsageOverview ValueStreamDashboardCount Introduced as an experiment in GitLab 17.2.

Aggregated usage counts within the project.

Arguments for valueStreamDashboardUsageOverview:
identifier (ValueStreamDashboardProjectLevelMetric!)
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).
valueStreams ValueStreamConnection Value streams available to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for valueStreams:
id (ID)
Value stream id.
visibility String Visibility of the project.
visibleForks ProjectConnection Introduced as an experiment in GitLab 15.10.

Visible forks of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for visibleForks:
minimumAccessLevel (AccessLevelEnum)
Minimum access level.
vulnerabilities VulnerabilityConnection Vulnerabilities reported on the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilities:
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities which have been auto dismissed by security policies. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
sort (VulnerabilitySort)
List vulnerabilities by sort order.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.10.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured and advanced vulnerability management set up.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.9.

Filter by tracked ref scope. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by validity check.
vulnerabilitiesCountByDay VulnerabilitiesCountByDayConnection The historical number of vulnerabilities per day for the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilitiesCountByDay:
endDate (ISO8601Date!)
Last day for which to fetch vulnerability history.
startDate (ISO8601Date!)
First day for which to fetch vulnerability history.
vulnerabilityArchives [VulnerabilityArchive!] Introduced as an experiment in GitLab 17.9.

All vulnerability archives of the project.
vulnerabilityIdentifierSearch [String!] Search for vulnerabilities by identifier.

Arguments for vulnerabilityIdentifierSearch:
name (String!)
Search identifier by name. Substring or partial match search is supported and argument should be greater than 3 characters.
vulnerabilityImages VulnerabilityContainerImageConnection Container images reported on the project vulnerabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Introduced as an experiment in GitLab 17.5.

Vulnerability Management Policies of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilityManagementPolicies:
deduplicatePolicies (Boolean)
Remove duplicate policies when the same policy is applied via multiple routes.
includeUnscoped (Boolean)
Filter policies that are scoped to the project.
relationship (SecurityPolicyRelationType)
Filter policies by the given policy relationship. Default is DIRECT.
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the project vulnerabilities. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilitySeveritiesCount VulnerabilitySeveritiesCount Counts for each vulnerability severity in the project.

Arguments for vulnerabilitySeveritiesCount:
capped (Boolean)
Default value is false. When set to true, the count returned for each severity is capped at a maximum of 1001. Ignored when used along with any argument that requires advanced vulnerability management.
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.
falsePositive (Boolean)
Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution (Boolean)
Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution.
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.
identifierName (String)
Introduced as an experiment in GitLab 17.7.

Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
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.
malware (Boolean)
Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen ([VulnerabilityOwaspTop10!])
Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 ([VulnerabilityOwasp2021Top10!])
Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 ([VulnerabilityOwasp2025Top10!])
Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed (Boolean)
Introduced as an experiment in GitLab 18.8.

Filter by policy auto dismissed. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId ([ID!])
Filter vulnerabilities by project.
reachability (ReachabilityType)
Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType ([VulnerabilityReportType!])
Filter vulnerabilities by report type.
scanner ([String!])
Filter vulnerabilities by scanner.
scannerId ([VulnerabilitiesScannerID!])
Filter vulnerabilities by scanner ID.
securityAttributesFilters ([AttributeFilterInput!])
Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
state ([VulnerabilityState!])
Filter vulnerabilities by state.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 18.11.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 18.11.

Filter by tracked ref scope. To use this argument, you must have advanced search configured, advanced vulnerability management set up and vulnerabilities_across_contexts feature flag enabled.
validityCheck ([VulnerabilityFindingTokenStatusState!])
Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by token status.
vulnerabilityStatistic VulnerabilityStatisticType Counts for each vulnerability severity in the project.
vulnerabilityWorkflowExecution VulnerabilityWorkflowExecution Introduced as an experiment in GitLab 19.3.

Returns a vulnerability workflow execution.

Arguments for vulnerabilityWorkflowExecution:
executionId (String)
Execution identifier. When omitted, returns the latest execution.
workflow (VulnerabilityDuoWorkflow!)
Duo workflow associated with the execution.
webBasedCommitSigningEnabled Boolean! Introduced as an experiment in GitLab 18.9.

Indicates whether web-based commit signing is enabled for the project.
webPath String! Web path of the project.
webUrl String Web URL of the project.
webhook ProjectHook Introduced as an experiment in GitLab 18.5.

A single project webhook.

Arguments for webhook:
id (ProjectHookID!)
ID of the project webhook.
wikiEnabled Boolean Indicates if Wikis are enabled for the current user.
wikiPages WikiPageConnection Introduced as an experiment in GitLab 19.2.

Wiki pages of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
workItemStateCounts WorkItemStateCountsType Introduced as an experiment in GitLab 16.7.

Counts of work items by state for the project.

Arguments for workItemStateCounts:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.
workItemTypes WorkItemTypeConnection Work item types available to the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItemTypes:
name (IssueType)
Deprecated in GitLab 19.0. Name-based filtering is no longer supported with introduction of configurable work item types in 19.0.
onlyAvailable (Boolean)
Introduced as an experiment in GitLab 18.6.

When true, returns only the available work item types for the current user. This experimental field will be removed in 19.0. Use canUserCreateItems and isFilterableListView fields from the WorkItemTypes API instead.
workItems WorkItemConnection Introduced as an experiment in GitLab 15.1.

Work items of the project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workItems:
assigneeUsernames ([String!])
Usernames of users assigned to the work item (maximum is 100 usernames).
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername (String)
Filter work items by author username.
closedAfter (Time)
Work items closed after the date.
closedBefore (Time)
Work items closed before the date.
confidential (Boolean)
Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter (Time)
Work items created after the timestamp.
createdBefore (Time)
Work items created before the timestamp.
crmContactId (String)
Filter by ID of CRM contact.
crmOrganizationId (String)
Filter by ID of CRM contact organization.
customField ([WorkItemWidgetCustomFieldFilterInputType!])
Introduced as an experiment in GitLab 17.10.

Filter by custom fields (maximum is 100 fields).
dueAfter (Time)
Work items due after the timestamp.
dueBefore (Time)
Work items due before the timestamp.
healthStatusFilter (HealthStatusFilter)
Health status of the work item, "none" and "any" values are supported.
hierarchyFilters (HierarchyFilterInput)
Introduced as an experiment in GitLab 18.3.

Filtering options related to the work item hierarchy.
ids ([WorkItemID!])
Filter by global IDs of work items (maximum is 100 IDs).
iid (String)
IID of the work item. For example, "1".
iids ([String!])
List of IIDs of work items. For example, ["1", "2"] (maximum is 100 IIDs).
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeDescendantWorkItems (Boolean)
Introduced as an experiment in GitLab 18.3.

Whether to include work items of descendant parents when filtering by parent_ids.
iterationCadenceId ([IterationsCadenceID!])
Filter by a list of iteration cadence IDs (maximum is 100 IDs).
iterationId ([ID])
List of iteration Global IDs applied to the issue (maximum is 100 IDs).
iterationWildcardId (IterationWildcardId)
Filter by iteration ID wildcard.
labelName ([String!])
Labels applied to the work item (maximum is 100 labels).
milestoneTitle ([String!])
Milestone applied to the work item (maximum is 100 milestones).
milestoneWildcardId (MilestoneWildcardId)
Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not (NegatedWorkItemFilterInput)
Negated work item arguments.
or (UnionedWorkItemFilterInput)
List of arguments with inclusive OR.
parentIds ([WorkItemID!])
Filter work items by global IDs of their parent items (maximum is 100 IDs).
parentWildcardId (WorkItemParentWildcardId)
Introduced as an experiment in GitLab 18.5.

Filter by parent ID wildcard. Incompatible with parentIds.
releaseTag ([String!])
Release tag associated with the work item's milestone (maximum is 100 tags). Ignored when parent is a group.
releaseTagWildcardId (ReleaseTagWildcardId)
Filter by release tag wildcard.
requirementLegacyWidget (RequirementLegacyFilterInput)
Deprecated in GitLab 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.
status (WorkItemWidgetStatusFilterInput)
Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed (SubscriptionStatus)
Work items the current user is subscribed to.
types ([IssueType!])
Filter work items by the given work item types.
updatedAfter (Time)
Work items updated after the timestamp.
updatedBefore (Time)
Work items updated before the timestamp.
verificationStatusWidget (VerificationStatusFilterInput)
Input for verification status widget filter.
weight (String)
Weight applied to the work item, "none" and "any" values are supported.
weightWildcardId (WeightWildcardId)
Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds ([WorkItemsTypeID!])
Filter work items by work item type global IDs.

ProjectCiCdSetting#

Fields#

Name Type Description
crossProjectPushForJobTokenAllowed Boolean Indicates the ability to push to this repository using a job token from an allowlisted project.
displayPipelineVariables Boolean Indicates whether pipeline variables can be displayed in the UI.
groupRunnersEnabled Boolean Indicates whether group runners are enabled for the project.
inboundJobTokenScopeEnabled Boolean Indicates whether CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabled Boolean Indicates whether CI/CD job tokens generated in this project have restricted access to other projects.
keepLatestArtifact Boolean Indicates whether the latest artifact should be kept for the project.
maxPipelinesPerMergeTrain Int Maximum number of parallel pipelines per merge train. When null, the plan limit applies.
mergePipelinesEnabled Boolean Indicates whether merged results pipelines are enabled.
mergeTrainEnforcement MergeTrainEnforcement! Merge train enforcement level for the project.
mergeTrainsEnabled Boolean Whether merge trains are enabled.
mergeTrainsSkipTrainAllowed Boolean! Whether merge immediately is allowed for merge trains.
pipelineVariablesMinimumOverrideRole String! Minimum role required to set variables when creating a pipeline or running a job.
project Project Project the CI/CD settings belong to.
pushRepositoryForJobTokenAllowed Boolean Indicates the ability to push to the original project repository using a job token.
resourceGroupDefaultProcessMode ResourceGroupsProcessMode Default process mode for resource groups.
skipBranchPipelinesForMrs Boolean Indicates whether branch pipelines are skipped if a merge request is open.

ProjectComplianceControlStatusType#

Compliance control status for a project.

Fields#

Name Type Description
complianceRequirementsControl ComplianceRequirementsControl! Control of the compliance status.
id ID! Compliance control status ID.
status ProjectComplianceControlStatus! Compliance status of the project for the control.
updatedAt Time! Timestamp when the control status was last updated.

ProjectComplianceControlStatusTypeConnection#

Paginated collection of ProjectComplianceControlStatusType. See Standard connection fields for the fields available on every connection.

ProjectComplianceRequirementStatus#

Compliance requirement status for a project.

Fields#

Name Type Description
complianceFramework ComplianceFramework! Framework of the compliance status.
complianceRequirement ComplianceRequirement! Requirement of the compliance status.
failCount Int! Total no. of failed compliance controls for the requirement.
id ID! Compliance requirement status ID.
passCount Int! Total no. of passed compliance controls for the requirement.
pendingCount Int! Total no. of pending compliance controls for the requirement.
project Project! Project of the compliance status.
updatedAt Time! Timestamp when the requirement status was last updated.

ProjectComplianceRequirementStatusConnection#

Paginated collection of ProjectComplianceRequirementStatus. See Standard connection fields for the fields available on every connection.

ProjectComplianceViolation#

Compliance violation for a project.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
auditEvent AuditEvent! Audit event related to the violation.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
complianceControl ComplianceRequirementsControl! Compliance control of the violation.
createdAt Time! Timestamp when the violation was detected.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id ID! Compliance violation ID.
issues IssueConnection Project issues linked to the violation. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
project Project! Project of the compliance violation.
status ComplianceViolationStatus! Compliance violation status of the project.
webUrl String URL of the object.

ProjectComplianceViolationConnection#

Paginated collection of ProjectComplianceViolation. See Standard connection fields for the fields available on every connection.

ProjectConnection#

Paginated collection of Project. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ProjectDataTransfer#

Fields#

Name Type Description
egressNodes EgressNodeConnection Data nodes. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

ProjectHook#

Fields#

Name Type Description
alertStatus WebhookAlertStatus! Auto-disabling status of the webhook.
branchFilterStrategy WebhookBranchFilterStrategy! Strategy for filtering push events by branch name.
confidentialIssuesEvents Boolean! Whether the webhook is triggered on confidential issues events.
confidentialNoteEvents Boolean! Whether the webhook is triggered on confidential note events.
createdAt Time! Timestamp of when the webhook was created.
customHeaders [WebhookCustomHeader!] List of custom header names for the webhook.
customWebhookTemplate String Custom payload template for the webhook request body.
deploymentEvents Boolean! Whether the webhook is triggered on deployment events.
description String Description of the webhook.
disabledUntil Time Timestamp when the webhook will be automatically re-enabled if temporarily disabled.
emojiEvents Boolean! Whether the webhook is triggered on emoji events.
enableSslVerification Boolean Whether SSL verification is done when triggering the webhook.
featureFlagEvents Boolean! Whether the webhook is triggered on feature flag events.
id ProjectHookID! ID of the webhook.
issuesEvents Boolean! Whether the webhook is triggered on issues events.
jobEvents Boolean! Whether the webhook is triggered on job events.
mergeRequestsEvents Boolean! Whether the webhook is triggered on merge request events.
milestoneEvents Boolean! Whether the webhook is triggered on milestone events.
name String Name of the webhook.
noteEvents Boolean! Whether the webhook is triggered on note events.
pipelineEvents Boolean! Whether the webhook is triggered on pipeline events.
pushEvents Boolean! Whether the webhook is triggered on push events.
pushEventsBranchFilter String Trigger hook on push events for matching branches only.
releasesEvents Boolean! Whether the webhook is triggered on releases events.
resourceAccessTokenEvents Boolean! Whether the webhook is triggered on resource access token events.
signingTokenPresent Boolean! Whether an HMAC signing token is configured for webhook-signature header generation.
tagPushEvents Boolean! Whether the webhook is triggered on tag push events.
tokenPresent Boolean! Whether a secret token is configured for X-Gitlab-Token header validation.
url String! URL of the webhook.
urlVariables [WebhookUrlVariable!] List of URL variable masks to hide sensitive portions of the webhook URL.
vulnerabilityEvents Boolean! Whether the webhook is triggered on vulnerability events.
webhookEvent WebhookEvent A single webhook event.

Arguments for webhookEvent:
id (WebHookLogID!)
ID of the webhook event.
timestampRange (TimestampRange)
Filter for webhook events within a range of timestamps. Defaults to events within the last seven days.
webhookEvents WebhookEventConnection List of recent webhook events. This field can only be resolved for one webhook in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for webhookEvents:
timestampRange (TimestampRange)
Filter for webhook events within a range of timestamps. Defaults to events within the last seven days.
wikiPageEvents Boolean! Whether the webhook is triggered on wiki page events.

ProjectImportExportRelationExportUploadUploadRegistry#

Represents the Geo replication and verification state of a relation export file upload project_import_export_relation_export_upload_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ProjectImportExportRelationExportUploadUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectImportExportRelationExportUploadUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectImportExportRelationExportUploadUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ProjectImportExportRelationExportUploadUploadRegistry.
lastSyncFailure String Error message during sync of the ProjectImportExportRelationExportUploadUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ProjectImportExportRelationExportUploadUploadRegistry.
missingOnPrimary Boolean Indicate if the ProjectImportExportRelationExportUploadUploadRegistry is missing on primary.
modelRecordId Int ID of the ProjectImportExportRelationExportUploadUploadRegistry's model record.
projectImportExportRelationExportUploadUploadId ID! ID of the Relation Export File Upload.
retryAt Time Timestamp after which the ProjectImportExportRelationExportUploadUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ProjectImportExportRelationExportUploadUploadRegistry.
state RegistryState Sync state of the ProjectImportExportRelationExportUploadUploadRegistry.
verificationChecksum String The local checksum of the ProjectImportExportRelationExportUploadUploadRegistry.
verificationChecksumMismatched String The expected checksum of the ProjectImportExportRelationExportUploadUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the ProjectImportExportRelationExportUploadUploadRegistry.
verificationRetryAt Time Timestamp after which the ProjectImportExportRelationExportUploadUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ProjectImportExportRelationExportUploadUploadRegistry.
verificationStartedAt Time Timestamp when the verification of ProjectImportExportRelationExportUploadUploadRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectImportExportRelationExportUploadUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectImportExportRelationExportUploadUploadRegistry.

ProjectImportExportRelationExportUploadUploadRegistryConnection#

Paginated collection of ProjectImportExportRelationExportUploadUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ProjectInterfaceConnection#

Paginated collection of ProjectInterface. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ProjectMember#

Represents a Project Membership.

Implements: MemberInterface

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.
mergeRequestInteraction UserMergeRequestInteraction Find a merge request.

Arguments for mergeRequestInteraction:
id (MergeRequestID!)
Global ID of the merge request.
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.

ProjectMemberConnection#

Paginated collection of ProjectMember. See Standard connection fields for the fields available on every connection.

ProjectMinimalAccess#

Implements: ProjectInterface

Fields#

Name Type Description
avatarUrl String Avatar URL of the project.
description String Short description of the project.
fullPath ID! Full path of the project.
id ID! ID of the project.
name String! Name of the project without the namespace.
nameWithNamespace String! Name of the project including the namespace.
userPermissions ProjectPermissions! Permissions for the current user on the resource.
webUrl String Web URL of the project.

Implements: NamespacesLinkPaths

Fields#

Name Type Description
autocompleteAwardEmojisPath String Introduced as an experiment in GitLab 18.6.

Path for autocomplete award emojis.
calendarPath String Introduced as an experiment in GitLab 18.4.

Calendar path for work items.
contributionGuidePath String Namespace contribution guide path.
emailsHelpPagePath String Help page path for emails.
epicsList String Namespace epics_list.
epicsListPath String Introduced as an experiment in GitLab 18.6.

Path to the epics list for the namespace.
exportCsvPath String Introduced as an experiment in GitLab 18.6.

CSV export endpoint for work items.
groupIssues String Namespace group_issues.
groupPath String Introduced as an experiment in GitLab 18.6.

Full path of the group.
issuesList String Namespace issues_list.
issuesListPath String Introduced as an experiment in GitLab 18.6.

Path to the issues list for the namespace.
issuesSettings String Namespace issues settings path.
labelsFetch String Namespace labels_fetch.
labelsManage String Namespace labels_manage.
markdownHelpPath String Help page path for Markdown.
namespaceFullPath String Introduced as an experiment in GitLab 18.6.

Full path of the namespace (project.namespace.full_path or group full_path).
newCommentTemplate [CommentTemplatePath!] Namespace new_comment_template_paths.
newIssuePath String Introduced as an experiment in GitLab 18.6.

Path to create a new issue.
newProject String Namespace new_project.
newTrialPath String Introduced as an experiment in GitLab 18.6.

New trial path for the namespace.
newWorkItemEmailAddress String Email address that can be used to create a new work item in this project. Returns null if incoming email is not configured. More details on how to configure incoming email is in this documentation.
projectImportJiraPath String JIRA import path.
quickActionsHelpPath String Help page path for quick actions.
register String Namespace register_path.
releasesPath String Project releases path.
reportAbuse String Namespace report_abuse.
rssPath String Introduced as an experiment in GitLab 18.4.

RSS path for work items.
signIn String Namespace sign_in_path.
userExportEmail String Introduced as an experiment in GitLab 18.3.

User email for export CSV. Returns null for user namespaces.

ProjectNamespaceMarkdownPaths#

Implements: MarkdownPaths

Fields#

Name Type Description
autocompleteSourcesPath JSON Supported paths for autocomplete sources for a given namespace.

Arguments for autocompleteSourcesPath:
iid (String)
IID of the work item.
workItemTypeId (String)
ID of the work item type.
markdownPreviewPath String Path for the markdown preview for given namespace.

Arguments for markdownPreviewPath:
iid (String)
IID of the target item for markdown preview.
uploadsPath String Uploads path for a given namespace.

ProjectNamespaceMetadata#

Implements: NamespaceMetadata

Fields#

Name Type Description
defaultBranch String Introduced as an experiment in GitLab 18.6.

Default branch of the project.
groupId String Introduced as an experiment in GitLab 18.6.

ID of the group. Returns null for user namespaces.
initialSort String Introduced as an experiment in GitLab 18.6.

User preference for initial sort order.
isIssueRepositioningDisabled Boolean Introduced as an experiment in GitLab 18.6.

Whether issue repositioning is disabled for the namespace.
maxAttachmentSize String Introduced as an experiment in GitLab 18.6.

Maximum allowed attachment size (humanized).
showNewWorkItem Boolean Introduced as an experiment in GitLab 18.6.

Whether to show the new work item link.
timeTrackingLimitToHours Boolean Introduced as an experiment in GitLab 18.6.

Time tracking limit to hours setting.

ProjectPermissions#

Fields#

Name Type Description
adminAiCatalogItem Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform admin_ai_catalog_item on this resource.
adminAiCatalogItemConsumer Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform admin_ai_catalog_item_consumer on this resource.
adminAllResources Boolean! If true, the user is an instance administrator.
adminIssue Boolean! If true, the user can perform admin_issue on this resource.
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.
adminWorkItemLifecycle Boolean! If true, the user can perform admin_work_item_lifecycle on this resource.
archiveProject Boolean! If true, the user can perform archive_project on this resource.
canLeave Boolean! If true, the user can leave this project.
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.
createAiCatalogItemConsumer Boolean! Introduced as an experiment in GitLab 19.3.

If true, the user can enable an AI catalog item in this project by creating an item consumer.
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.
createPathLock Boolean! If true, the user can perform create_path_lock 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.
createWorkItem Boolean! If true, the user can perform create_work_item 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.
generateDescription Boolean! If true, the user can perform generate_description on this resource.
importIssues Boolean! If true, the user can perform import_issues on this resource.
manageAiFlowTriggers Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform manage_ai_flow_triggers on this resource.
moveDesign Boolean! If true, the user can perform move_design 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.
readAiCatalogItem Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform read_ai_catalog_item on this resource.
readAiCatalogItemConsumer Boolean! Introduced as an experiment in GitLab 18.3.

If true, the user can perform read_ai_catalog_item_consumer on this resource.
readCommitStatus Boolean! If true, the user can perform read_commit_status on this resource.
readCrmContact Boolean! If true, the user can perform read_crm_contact on this resource.
readCrmOrganization Boolean! If true, the user can perform read_crm_organization 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.
readDora4Analytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_dora4_analytics 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.
readPathLocks Boolean! If true, the user can perform read_path_locks on this resource.
readProAiAnalytics Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_pro_ai_analytics on this resource.
readProject Boolean! If true, the user can perform read_project on this resource.
readProjectComponentUsages Boolean! Introduced as an experiment in GitLab 19.0.

If true, the user can perform read_project_component_usages on this resource.
readProjectMember Boolean! If true, the user can perform read_project_member on this resource.
readRunnerCloudProvisioningInfo Boolean! Introduced as an experiment in GitLab 18.8.

If true, the user can perform read_runner_cloud_provisioning_info on this resource.
readSecurityResource Boolean! Introduced as an experiment in GitLab 19.5.

If true, the user can perform read_security_resource 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.
updateDesign Boolean! If true, the user can perform update_design 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.
viewEditPage Boolean! If true, the user can perform view_edit_page on this resource.

ProjectPlanLimits#

Plan limits for the current project.

Fields#

Name Type Description
ciPipelineSchedules Int Maximum number of pipeline schedules allowed per project.

ProjectRepositoryRegistry#

Represents the Geo replication and verification state of a project repository.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ProjectRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the ProjectRepositoryRegistry is missing on primary.
modelRecordId Int ID of the ProjectRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the ProjectRepositoryRegistry in case of mismatch.
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 of ProjectRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectRepositoryRegistry.

ProjectRepositoryRegistryConnection#

Paginated collection of ProjectRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ProjectSavedReply#

Fields#

Name Type Description
content String! Content of the saved reply.
id ProjectsSavedReplyID! Global ID of the project-level saved reply.
name String! Name of the saved reply.

ProjectSavedReplyConnection#

Paginated collection of ProjectSavedReply. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ProjectSecret#

Representation of a project secret.

Fields#

Name Type Description
branch String! Branches that can access the secret.
createdAt Time Timestamp when the secret creation started.
description String Description of the project secret.
environment String! Environments that can access the secret.
metadataVersion Int Current metadata version of the project secret.
name String! Name of the project secret.
project Project! Project the secret belongs to.
rotationInfo SecretRotationInfo Rotation configuration for the secret.
status SecretStatus! Computed lifecycle status of the secret, based on timestamps.

ProjectSecretConnection#

Paginated collection of ProjectSecret. See Standard connection fields for the fields available on every connection.

ProjectSecretsManager#

Representation of a project secrets manager.

Fields#

Name Type Description
project Project! Project the secrets manager belong to.
readOnly Boolean! Introduced as an experiment in GitLab 19.4.

Whether the instance is in strict read-only mode (Geo secondary or maintenance mode). No secrets or permissions can be created, updated, or deleted while it is true.
status ProjectSecretsManagerStatus Status of the project secrets manager.
userPermissions ProjectSecretsManagerPermissions! Permissions for the current user on the resource.
writeDenialReason SecretsManagerWriteDenialReason Introduced as an experiment in GitLab 19.5.

Reason the Secrets Manager entitlement does not allow secrets or their permissions to be created or updated. Null when it allows them.

ProjectSecretsManagerPermissions#

Permissions the current user has on a project secrets manager.

Fields#

Name Type Description
createSecrets Boolean! Indicates the user can create secrets in this project secrets manager.
deleteSecrets Boolean! Indicates the user can delete secrets in this project secrets manager.
readMetadata Boolean! Indicates the user can read secret metadata in this project secrets manager.
updateSecrets Boolean! Indicates the user can update secrets in this project secrets manager.

ProjectSecretsPermission#

Representation of a project secrets permission.

Fields#

Name Type Description
actions [SecretsManagementAction!]! Actions that can be performed on secrets.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
grantedBy UserCore User who created the Secret Permission.
principal Principal! Who is provided access to. For eg: User/Role/MemberRole.
project Project! Project the secrets permission belongs to.

ProjectSecretsPermissionConnection#

Paginated collection of ProjectSecretsPermission. See Standard connection fields for the fields available on every connection.

ProjectSecurityExclusion#

Represents a project-level security scanner exclusion.

Fields#

Name Type Description
active Boolean! Whether the exclusion is active.
createdAt Time! Timestamp of when the exclusion was created.
description String Optional description for the exclusion.
id SecurityProjectSecurityExclusionID! ID of the exclusion.
scanner ExclusionScannerEnum! Security scanner the exclusion will be used for.
type ExclusionTypeEnum! Type of the exclusion.
updatedAt Time! Timestamp of when the exclusion was updated.
value String! Value of the exclusion.

ProjectSecurityExclusionConnection#

Paginated collection of ProjectSecurityExclusion. See Standard connection fields for the fields available on every connection.

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.

ProjectSetting#

Fields#

Name Type Description
aiAuditEventsStorageEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether AI audit events are stored for the project.
duoAutoModeEnabled Boolean Indicates whether Duo Agent Platform auto mode is enabled for the project.
duoContextExclusionSettings DuoContextExclusionSettings Settings for excluding files from Duo context.
duoFeaturesEnabled Boolean Indicates whether GitLab Duo features are enabled for the project.
project Project Project the settings belong to.
toolApprovalForSessionEnabled Boolean Indicates whether tool approval for Duo Workflow sessions is enabled for the project.
webBasedCommitSigningEnabled Boolean! Introduced as an experiment in GitLab 18.2.

Indicates whether web-based commit signing is enabled for the project.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.6.

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 as an experiment in GitLab 16.2.

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 as an experiment in GitLab 16.6.

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.

ProjectTargetBranchRule#

Fields#

Name Type Description
createdAt Time! Timestamp of when the target branch rule was created.
id ProjectsTargetBranchRuleID! ID of the target branch rule.
name String! Name of the target branch rule.
targetBranch String! Target branch for the target branch rule.

ProjectTargetBranchRuleConnection#

Paginated collection of ProjectTargetBranchRule. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

ProjectTopicUploadRegistry#

Represents the Geo replication and verification state of a project_topic_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ProjectTopicUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectTopicUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectTopicUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ProjectTopicUploadRegistry.
lastSyncFailure String Error message during sync of the ProjectTopicUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ProjectTopicUploadRegistry.
missingOnPrimary Boolean Indicate if the ProjectTopicUploadRegistry is missing on primary.
modelRecordId Int ID of the ProjectTopicUploadRegistry's model record.
projectTopicUploadId ID! ID of the Project Topic Upload.
retryAt Time Timestamp after which the ProjectTopicUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ProjectTopicUploadRegistry.
state RegistryState Sync state of the ProjectTopicUploadRegistry.
verificationChecksum String The local checksum of the ProjectTopicUploadRegistry.
verificationChecksumMismatched String The expected checksum of the ProjectTopicUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the ProjectTopicUploadRegistry.
verificationRetryAt Time Timestamp after which the ProjectTopicUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ProjectTopicUploadRegistry.
verificationStartedAt Time Timestamp when the verification of ProjectTopicUploadRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectTopicUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectTopicUploadRegistry.

ProjectTopicUploadRegistryConnection#

Paginated collection of ProjectTopicUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ProjectUploadRegistry#

Represents the Geo replication and verification state of a project_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ProjectUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ProjectUploadRegistry.
lastSyncFailure String Error message during sync of the ProjectUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ProjectUploadRegistry.
missingOnPrimary Boolean Indicate if the ProjectUploadRegistry is missing on primary.
modelRecordId Int ID of the ProjectUploadRegistry's model record.
projectUploadId ID! ID of the Project Upload.
retryAt Time Timestamp after which the ProjectUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ProjectUploadRegistry.
state RegistryState Sync state of the ProjectUploadRegistry.
verificationChecksum String The local checksum of the ProjectUploadRegistry.
verificationChecksumMismatched String The expected checksum of the ProjectUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the ProjectUploadRegistry.
verificationRetryAt Time Timestamp after which the ProjectUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ProjectUploadRegistry.
verificationStartedAt Time Timestamp when the verification of ProjectUploadRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectUploadRegistry.

ProjectUploadRegistryConnection#

Paginated collection of ProjectUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

ProjectValueStreamAnalyticsFlowMetrics#

Exposes aggregated value stream flow metrics.

Fields#

Name Type Description
cycleTime ValueStreamAnalyticsMetric Median time from first commit to issue closed.

Arguments for cycleTime:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
to (Time!)
Timestamp marking the end date and time.
weight (Int)
Weight applied to the issue.
deploymentCount ValueStreamAnalyticsMetric Number of production deployments in the given period.

Arguments for deploymentCount:
from (Time!)
Timestamp marking the start date and time.
to (Time!)
Timestamp marking the end date and time.
issueCount ValueStreamAnalyticsMetric Number of issues opened in the given period.

Arguments for issueCount:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
to (Time!)
Timestamp marking the end date and time.
weight (Int)
Weight applied to the issue.
issuesCompletedCount ValueStreamAnalyticsMetric Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Arguments for issuesCompletedCount:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
to (Time!)
Timestamp marking the end date and time.
weight (Int)
Weight applied to the issue.
leadTime ValueStreamAnalyticsMetric Median time from when the issue was created to when it was closed.

Arguments for leadTime:
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 (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
to (Time!)
Timestamp marking the end date and time.
weight (Int)
Weight applied to the issue.
timeToMerge ValueStreamAnalyticsMetric Median time from merge request creation to merge request merged.

Arguments for timeToMerge:
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
checksumMismatch Boolean Indicate if the checksums of the ProjectWikiRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the ProjectWikiRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this ProjectWikiRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the ProjectWikiRepositoryRegistry is missing on primary.
modelRecordId Int ID of the ProjectWikiRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the ProjectWikiRepositoryRegistry in case of mismatch.
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 of ProjectWikiRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the ProjectWikiRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ProjectWikiRepositoryRegistry.

ProjectWikiRepositoryRegistryConnection#

Paginated collection of ProjectWikiRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
deployAccessLevels ProtectedEnvironmentDeployAccessLevelConnection Which group, user, or role is allowed to execute deployments to the environment. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

ProtectedEnvironmentApprovalRuleConnection#

Paginated collection of ProtectedEnvironmentApprovalRule. See Standard connection fields for the fields available on every connection.

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.
canApprove Boolean Indicates whether a user is authorized to approve.
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.

ProtectedEnvironmentConnection#

Paginated collection of ProtectedEnvironment. See Standard connection fields for the fields available on every connection.

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.

ProtectedEnvironmentDeployAccessLevelConnection#

Paginated collection of ProtectedEnvironmentDeployAccessLevel. See Standard connection fields for the fields available on every connection.

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 the access level.
deployKey AccessLevelDeployKey Deploy key assigned to the access level.
group AccessLevelGroup Group associated with the access level.
memberRole MemberRole Custom role associated with the access level.
user AccessLevelUser User associated with the access level.

PushAccessLevelConnection#

Paginated collection of PushAccessLevel. See Standard connection fields for the fields available on every connection.

PushEventCommit#

Commit details associated with a push event.

Fields#

Name Type Description
count Int! Number of commits in the push.
from String SHA of the ref tip before the push. null when the ref was created.
title String Title of the most recent commit in the push.
to String SHA of the ref tip after the push. null when the ref was removed.

PushEventPayload#

Represents the payload of a push event.

Fields#

Name Type Description
action String! Action performed on the ref. One of created, removed, or pushed.
commit PushEventCommit! Commit details for the push.
ref PushEventRef! Ref (branch or tag) involved in the push.

PushEventRef#

Ref (branch or tag) involved in a push event.

Fields#

Name Type Description
count Int Number of refs pushed when more than one ref was pushed at once.
name String Name of the ref (branch or tag) that was pushed.
type String! Type of the ref. One of branch or tag.

PushRules#

Represents rules that commit pushes must follow.

Fields#

Name Type Description
authorEmailRegex String All commit author emails must match the regular expression.
branchNameRegex String All branch names must match the regular expression.
commitCommitterCheck Boolean! Only allow commits where the committer email matches a verified GitLab user email.
commitCommitterNameCheck Boolean! Only allow commits where the author name matches the GitLab user name.
commitMessageNegativeRegex String No commit message is allowed to match the regular expression.
commitMessageRegex String All commit messages must match the regular expression.
denyDeleteTag Boolean Deny deleting a tag with git push.
fileNameRegex String All committed filenames must not match the regular expression.
maxFileSize Int Maximum file size (MB).
memberCheck Boolean Restrict commits by author (email) to existing GitLab users.
preventSecrets Boolean GitLab rejects any files that are likely to contain secrets.
rejectNonDcoCommits Boolean! Reject commit when it is not DCO certified.
rejectUnsignedCommits Boolean! Reject commit when it is not signed through GPG.

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 50th percentile. 50% of the durations are lower than this value.
p75 Duration 75th percentile. 75% of the durations are lower than this value.
p90 Duration 90th percentile. 90% of the durations are lower than this value.
p95 Duration 95th percentile. 95% of the durations are lower than this value.
p99 Duration 99th percentile. 99% of the durations are lower than this value.
time Time! Start of the time interval.

QuickActionCommand#

A quick action available to the current user on a noteable.

Fields#

Name Type Description
aliases [String!]! Aliases that also invoke the command.
description String Description of what the command does.
icon String Name of the icon associated with the command.
name String! Primary name of the command, rendered as /name.
params [String!]! Parameter hints shown after the command.
warning String Warning about side effects of running the command.

QuickActionsStatus#

Fields#

Name Type Description
commandNames [String!] Quick action command names.
commandsOnly Boolean Returns true if only quick action commands were in the note.
errorMessages [String!] Error messages from quick actions that failed to apply.
messages [String!] Response messages from quick actions.

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.

RecentlyViewedItem#

Fields#

Name Type Description
item RecentlyViewedItemUnion! Recently viewed item.
viewedAt Time! When the item was last viewed.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
historicalRelease Boolean Indicates the release is a historical release.
id ReleaseID! Global ID of the release.
links ReleaseLinks Links of the release.
milestones MilestoneConnection Milestones associated to the release. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

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.

ReleaseAssetLinkConnection#

Paginated collection of ReleaseAssetLink. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
sources ReleaseSourceConnection Sources of the release. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

ReleaseConnection#

Paginated collection of Release. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

ReleaseEvidenceConnection#

Paginated collection of ReleaseEvidence. See Standard connection fields for the fields available on every connection.

Fields#

Name Type Description
closedIssuesUrl String HTTP URL of the issues page, filtered by the release and state=closed.
closedMergeRequestsUrl String HTTP URL of the merge request page, filtered by the 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 the release and state=merged.
openedIssuesUrl String HTTP URL of the issues page, filtered by the release and state=open.
openedMergeRequestsUrl String HTTP URL of the merge request page, filtered by the 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.

ReleaseSourceConnection#

Paginated collection of ReleaseSource. See Standard connection fields for the fields available on every connection.

Repository#

Fields#

Name Type Description
blobs RepositoryBlobConnection Blobs contained within the repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for blobs:
paths ([String!]!)
Array of desired blob paths. When requesting multiple blobs the total size is limited to 20 MiB.
ref (String)
Commit ref to get the blobs from. Default value is HEAD.
refType (RefType)
Type of ref.
branchCount Int! Number of branches in the repository.
branchNames [String!] Names of branches available in this repository that match the search pattern.

Arguments for branchNames:
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.
codeOwnersPath String Path to CODEOWNERS file in a ref.

Arguments for codeOwnersPath:
ref (String)
Name of the ref.
commit Commit Commit from the repository.

Arguments for commit:
ref (String!)
Commit reference (SHA, branch name, or tag name).
commitCount Int! Number of commits in the default branch of the repository.
commits CommitConnection Introduced as an experiment in GitLab 18.4.

List of commits from the repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for commits:
author (String)
Name or email of the author.
committedAfter (Time)
Commits created after an ISO8601 formatted time or date.
committedBefore (Time)
Commits created before an ISO8601 formatted time or date.
firstParent (Boolean)
Follow only the first parent of merge commits.
order (CommitOrder)
Order the commits are returned in. Defaults to reverse chronological.
path (String)
File path to filter commits by.
query (UntrustedRegexp)
Regular expression to filter the commits.
ref (String!)
Branch or tag to search for commits.
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.
lastCommit Commit The last commit made in the repository for the given path and ref.

Arguments for lastCommit:
path (String)
Path to get the last commit for. Default value is the root of the repository.
ref (String)
Commit ref to get the last commit for. Default value is HEAD.
refType (RefType)
Type of ref.
paginatedTree TreeConnection Paginated tree of the repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for paginatedTree:
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.
rootRef String Default branch of the repository.
tagCount Int! Number of tags in the repository.
tags TagConnection Introduced as an experiment in GitLab 19.5.

Tags in the repository. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for tags:
search (String)
Filter tags by name. Supports ^ for prefix, $ for suffix, and * as a wildcard.
sort (TagSort)
Sort tags by the criteria. Defaults to UPDATED_DESC.
tree Tree Tree of the repository.

Arguments for tree:
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.
validateCodeownerFile RepositoryCodeownerValidation Shows linting errors in the CODEOWNER file of the repository.

Arguments for validateCodeownerFile:
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.
base64EncodedBlob String Introduced as an experiment in GitLab 17.1.

Content of blob is encoded base64. Returns null if the unicode_escaped_data feature flag is disabled.
blame Blame Introduced as an experiment in GitLab 16.3.

Blob blame.

Arguments for blame:
fromLine (Int)
Range starting from the line. Cannot be less than 1 or greater than to_line.
ignoreRevs (Boolean)
Enable to ignore revisions in the .git-ignore-revs-file when fetching the blame.
toLine (Int)
Range ending on the line. Cannot be smaller than from_line or greater than or equal to from_line + the maximum line range cap (1000 when blame_line_range_cap_1000 is enabled, 100 otherwise).
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.
canModifyBlobWithWebIde Boolean! Whether the current user can modify the blob with Web IDE.
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 the blob using a forked project.
forkAndViewPath String Web path to view the blob using a forked project.
gitpodBlobUrl String URL to the blob within Ona.
historyPath String Web path to blob history page.
id ID! ID of the blob.
ideEditPath String Web path to edit the blob in the Web IDE.
ideForkAndEditPath String Web path to edit the 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.
showDuoWorkflowAction Boolean Indicator to show Duo Agent Platform action.
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.

RepositoryBlobConnection#

Paginated collection of RepositoryBlob. See Standard connection fields for the fields available on every connection.

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 String! Deprecated in GitLab 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.
testReports TestReportConnection Test reports of the requirement. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for testReports:
sort (Sort)
List test reports by sort order.
title String Title of the requirement.
titleHtml String HTML rendering of title.
updatedAt Time! Timestamp of when the requirement was last updated.
userPermissions RequirementPermissions! Permissions for the current user on the resource.
workItemIid String! Work item IID of the requirement, will replace current IID as identifier soon.

RequirementConnection#

Paginated collection of Requirement. See Standard connection fields for the fields available on every connection.

RequirementControlCoverage#

Compliance control coverage statistics across all requirements.

Fields#

Name Type Description
failed Int! Number of controls that failed compliance checks.
passed Int! Number of controls that passed compliance checks.
pending Int! Number of controls pending evaluation.

RequirementCoverage#

Coverage statistics requirements.

Fields#

Name Type Description
failed Int! Count of failed requirements.
passed Int! Count of passed requirements.
pending Int! Count of pending requirements.

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.

ResourceQuotas#

Resource quotas of a workspace.

Fields#

Name Type Description
cpu String! Number of cpu cores.
memory String! Bytes of memory.

RiskFactors#

Risk factors contributing to the total risk score.

Fields#

Name Type Description
vulnerabilitiesAverageScore VulnerabilityAverageScoreFactor Introduced as an experiment in GitLab 18.4.

Factor based on average vulnerability score.

RiskScore#

Total risk score information.

Fields#

Name Type Description
byProject RiskScoreByProjectConnection Introduced as an experiment in GitLab 18.4.

Risk scores grouped by project. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
factors RiskFactors Introduced as an experiment in GitLab 18.4.

Risk factors contributing to the score.
projectCount Int Introduced as an experiment in GitLab 18.5.

Total number of projects with risk scores.
rating RiskRating! Introduced as an experiment in GitLab 18.4.

Overall risk rating.
score Float! Introduced as an experiment in GitLab 18.4.

Overall risk score.

RiskScoreByProject#

Risk score information for a specific project.

Fields#

Name Type Description
project Project Introduced as an experiment in GitLab 18.4.

Risk score belongs to the project.
rating RiskRating Introduced as an experiment in GitLab 18.4.

Risk rating for the project.
score Float Introduced as an experiment in GitLab 18.4.

Risk score for the project.

RiskScoreByProjectConnection#

Paginated collection of RiskScoreByProject. See Standard connection fields for the fields available on every connection.

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 as an experiment in GitLab 16.2.

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

RunnerArchitectureConnection#

Paginated collection of RunnerArchitecture. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
humanReadableName String! Human readable name of the runner platform.
name String! Name slug of the runner platform.

RunnerPlatformConnection#

Paginated collection of RunnerPlatform. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
global SastCiConfigurationEntityConnection List of global entities related to SAST configuration. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pipeline SastCiConfigurationEntityConnection List of pipeline entities related to SAST configuration. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

SastCiConfigurationAnalyzersEntityConnection#

Paginated collection of SastCiConfigurationAnalyzersEntity. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
size SastUiComponentSize Size of the UI component.
type String Type of the field value.
value String Current value of the entity.

SastCiConfigurationEntityConnection#

Paginated collection of SastCiConfigurationEntity. See Standard connection fields for the fields available on every connection.

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.

SastCiConfigurationOptionsEntityConnection#

Paginated collection of SastCiConfigurationOptionsEntity. See Standard connection fields for the fields available on every connection.

SastConfiguration#

Configuration for a SAST scan profile.

Fields#

Name Type Description
advancedSastPartialScan SecurityScanProfileAdvancedSastPartialScan Introduced as an experiment in GitLab 19.4.

Controls GitLab Advanced SAST diff-based scanning.
analyzerImageTag String Introduced as an experiment in GitLab 19.4.

Tag of the analyzer image to use.
excludedAnalyzers [String!] Introduced as an experiment in GitLab 19.4.

Analyzers excluded from the scan.
excludedPaths [String!] Introduced as an experiment in GitLab 19.4.

Glob paths excluded from the scan.
gitlabAdvSastIncrScan Boolean Introduced as an experiment in GitLab 19.4.

Whether GitLab Advanced SAST incremental scanning is enabled.
imageSuffix SecurityScanProfileImageSuffix Introduced as an experiment in GitLab 19.4.

Suffix appended to the analyzer image name.
secureAnalyzersPrefix String Introduced as an experiment in GitLab 19.4.

Prefix for the container registry from which the analyzer image is pulled.

SastFalsePositiveConfiguration#

Configuration for the SAST false positive detection trigger of a triage and remediation scan profile.

Fields#

Name Type Description
cweClasses [String!] Introduced as an experiment in GitLab 19.4.

CWE identifiers false positive detection is restricted to.
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.4.

Whether false positive detection runs automatically or on demand.
severityLevel VulnerabilitySeverity Introduced as an experiment in GitLab 19.4.

Minimum vulnerability severity that triggers false positive detection.

SastVulnerabilityResolutionConfiguration#

Configuration for the SAST vulnerability resolution trigger of a triage and remediation scan profile.

Fields#

Name Type Description
cweClasses [String!] Introduced as an experiment in GitLab 19.4.

CWE identifiers resolution is restricted to.
falsePositiveConfidence SecurityScanProfileFalsePositiveConfidence Introduced as an experiment in GitLab 19.4.

False positive assessment a finding must carry to be resolved.
openMergeRequestsLimit Int Introduced as an experiment in GitLab 19.4.

Maximum number of open merge requests resolution may have at once. Null means no limit.
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.4.

Whether resolution runs automatically or on demand.
severityLevel VulnerabilitySeverity Introduced as an experiment in GitLab 19.4.

Minimum vulnerability severity that triggers a resolution attempt.

SavedReply#

Fields#

Name Type Description
content String! Content of the saved reply.
id UsersSavedReplyID! Global ID of the user saved reply.
name String! Name of the saved reply.

SavedReplyConnection#

Paginated collection of SavedReply. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

SavedViewPermissions#

Check permissions for the current user on a saved view.

Fields#

Name Type Description
deleteSavedView Boolean! If true, the user can perform delete_saved_view on this resource.
readSavedView Boolean! If true, the user can perform read_saved_view on this resource.
updateSavedView Boolean! If true, the user can perform update_saved_view on this resource.
updateSavedViewVisibility Boolean! If true, the user can perform update_saved_view_visibility on this resource.

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.

ScanConnection#

Paginated collection of Scan. See Standard connection fields for the fields available on every connection.

ScanExecutionPolicy#

Represents the scan execution policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
deprecatedProperties [String!] Introduced as an experiment in GitLab 17.3.

All deprecated properties in the policy.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.

ScanExecutionPolicyAttributesType#

Represents policy fields related to the scan execution policy.

Fields#

Name Type Description
deprecatedProperties [String!] Introduced as an experiment in GitLab 17.3.

All deprecated properties in the policy.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.

ScanExecutionPolicyConnection#

Paginated collection of ScanExecutionPolicy. See Standard connection fields for the fields available on every connection.

ScanProfileProjectStatus#

Status of a scan profile for a project.

Fields#

Name Type Description
buildId JobID ID of the last CI job that updated the status.
consecutiveFailureCount Int! Number of consecutive failed scans.
consecutiveSuccessCount Int! Number of consecutive successful scans.
lastScanAt Time Timestamp of the last profile-triggered scan.
scanProfile ScanProfileType! Scan profile associated with the status.
status ScanProfileStatus! Computed display status: NOT_CONFIGURED, PENDING, ACTIVE, WARNING, FAILED, or STALE.

ScanProfileTriggerSetting#

A scan profile trigger and its effective configuration.

Fields#

Name Type Description
configuration ScanProfileConfiguration Effective configuration for the trigger. Null for scan types without a typed configuration.
triggerType ScanProfileTriggerType! Type of the trigger.

ScanProfileType#

A scan profile.

Fields#

Name Type Description
configuration JSON! Introduced as an experiment in GitLab 19.2.

Configuration object of the scan profile.
createdAt ISO8601DateTime! Timestamp of when the scan profile was created.
description String! Description of the security scan profile.
gitlabRecommended Boolean! Indicates whether the scan profile is a default profile.
id SecurityScanProfileID Global ID of the security scan profile.
name String! Name of the security scan profile.
projectCount Int! Introduced as an experiment in GitLab 19.5.

Number of projects the scan profile is attached to, excluding archived projects.
scanType SecurityScanProfileType! Scan profile type.
triggerSettings [ScanProfileTriggerSetting!]! Introduced as an experiment in GitLab 19.3.

Trigger settings, including effective configuration, for the scan profile.
triggers [ScanProfileTriggerType!]! Introduced as an experiment in GitLab 18.10.

Trigger types for the scan profile.
updatedAt ISO8601DateTime! Timestamp of when the scan profile was last updated.

ScanResultPolicy#

Represents the scan result policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
actionApprovers [PolicyApproversType!] Multiple approvers action.
allGroupApprovers [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
deprecatedProperties [String!] Introduced as an experiment in GitLab 16.10.

All deprecated properties in the policy.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
enforcementType PolicyEnforcementType Enforcement type of the policy. Can be "enforce" or "warn".
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.

ScanResultPolicyConnection#

Paginated collection of ScanResultPolicy. See Standard connection fields for the fields available on every connection.

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.

ScannedResourceConnection#

Paginated collection of ScannedResource. See Standard connection fields for the fields available on every connection.

SearchBlobChunk#

JSON structure of a matched chunk.

Fields#

Name Type Description
lines [SearchBlobLine!] Introduced as an experiment in GitLab 17.2.

Path of the file.
matchCountInChunk Int Introduced as an experiment in GitLab 17.2.

Number of matches in the chunk.

SearchBlobFileType#

JSON structure of a file with matches.

Fields#

Name Type Description
blameUrl String Introduced as an experiment in GitLab 17.2.

Blame URL of the file.
chunks [SearchBlobChunk!] Introduced as an experiment in GitLab 17.2.

Maximum matches per file.
fileUrl String Introduced as an experiment in GitLab 17.2.

URL of the file.
language String Introduced as an experiment in GitLab 17.8.

Language of the file.
matchCount Int Introduced as an experiment in GitLab 17.2.

Matches per file up to a max of 50 chunks. Default is 3.
matchCountTotal Int Introduced as an experiment in GitLab 17.2.

Total number of matches per file.
path String Introduced as an experiment in GitLab 17.2.

Path of the file.
projectPath String Introduced as an experiment in GitLab 17.2.

Full path of the project.

SearchBlobLine#

JSON structure of each line in a matched chunk.

Fields#

Name Type Description
highlights [[Int!]!] Introduced as an experiment in GitLab 17.8.

Column numbers of the first and last highlighted characters on a line.
lineNumber Int Introduced as an experiment in GitLab 17.2.

Line number of the blob.
text String Introduced as an experiment in GitLab 17.2.

Text content of the blob.

SecondarySecurityFeature#

Secondary security feature information.

Fields#

Name Type Description
configurationText String! Display text for configuring the secondary feature.
description String! Description of what the secondary feature does.
name String! Name of the secondary feature.
type String! Type identifier for the secondary feature.

SecretDetectionConfiguration#

Configuration for a secret detection scan profile.

Fields#

Name Type Description
excludedPaths [String!] Glob paths excluded from the scan.
historicScan Boolean Indicates whether to scan the full Git history instead of only the current state.
imageSuffix SecurityScanProfileImageSuffix Suffix appended to the analyzer image name.
logOptions String Options passed to git log to control the commit range scanned.
rulesetGitReference String Git reference of the remote ruleset configuration to use.
secureAnalyzersPrefix String Prefix for the container registry from which the analyzer image is pulled.

SecretDetectionFalsePositiveConfiguration#

Configuration for the secret detection false positive detection trigger of a triage and remediation scan profile.

Fields#

Name Type Description
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.4.

Whether false positive detection runs automatically or on demand.
severityLevel VulnerabilitySeverity Introduced as an experiment in GitLab 19.4.

Minimum vulnerability severity that triggers false positive detection.

SecretPermission#

Representation of a secret permission.

Fields#

Name Type Description
actions [SecretsManagementAction!]! Actions that can be performed on secrets.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
grantedBy UserCore User who created the Secret Permission.
permissions String! Permissions to be provided. ['create', 'update', 'read', 'delete'].
principal Principal! Who is provided access to. For eg: User/Role/MemberRole.
project Project! Project the secret permission belong to.

SecretPermissionConnection#

Paginated collection of SecretPermission. See Standard connection fields for the fields available on every connection.

SecretRotationInfo#

Rotation configuration and status for a secret.

Fields#

Name Type Description
createdAt Time! When the rotation configuration was created.
lastReminderAt Time When the last rotation reminder was sent.
nextReminderAt Time! When the next rotation reminder will be sent.
rotationIntervalDays Int! Number of days between rotation reminders.
status SecretRotationStatus! Current rotation status.
updatedAt Time! When the rotation configuration was last updated.

SecretsManagerEnrollment#

Representation of a Secrets Manager namespace enrollment.

Fields#

Name Type Description
beta Boolean! Introduced as an experiment in GitLab 19.3.

Indicates the enrollment is part of the free beta cohort.
namespace Namespace! Namespace the enrollment belongs to.

SecretsManagerEntitlement#

Secrets Manager entitlement for a top-level group, or for the instance on GitLab Self-Managed.

Fields#

Name Type Description
betaProgramEnded Boolean Introduced as an experiment in GitLab 19.4.

Indicates whether the free-beta program has ended for the namespace. Set only when state is TRIAL_ELIGIBLE; null otherwise.
betaWindowEligible Boolean Introduced as an experiment in GitLab 19.4.

Indicates whether the namespace joined Secrets Manager during the free beta and keeps beta access until the beta program ends. True only when state is TRIAL_ELIGIBLE or INELIGIBLE; false or null otherwise.
blockedReason SecretsManagerEntitlementBlockedReason Introduced as an experiment in GitLab 19.2.

Reason the entitlement is blocked; null when state is not BLOCKED.
creditsRemaining Float Introduced as an experiment in GitLab 19.2.

Number of trial credits remaining.
creditsTotal Float Introduced as an experiment in GitLab 19.2.

Initial trial credit allocation for the current trial period.
gracePeriodEndDate Date Last day of the read-only grace period, inclusive. Set only when blockedReason is GRACE; null otherwise.
offlineFlexLicense Boolean Introduced as an experiment in GitLab 19.5.

Indicates whether the offline license is a GitLab Flex license, whose usage consumes GitLab Credits. Null unless state is OFFLINE_PAID.
offlineLicense Boolean Introduced as an experiment in GitLab 19.4.

Indicates whether the instance license is not an online cloud license, so no Secrets Manager trial can be started. Null on GitLab.com.
onDemandEnabled Boolean Introduced as an experiment in GitLab 19.2.

Indicates whether on-demand purchasing is enabled for the namespace.
state SecretsManagerEntitlementState! Introduced as an experiment in GitLab 19.2.

Resolved entitlement state.
trialExpiresAt Time Introduced as an experiment in GitLab 19.2.

Timestamp when the Secrets Manager trial expires.
trialStartedAt Time Introduced as an experiment in GitLab 19.2.

Timestamp when the Secrets Manager trial started.

SecretsManagerInstanceEnrollment#

Representation of a Secrets Manager instance enrollment.

Fields#

Name Type Description
beta Boolean! Introduced as an experiment in GitLab 19.3.

Indicates the instance enrollment is part of the free beta cohort.
enrolled Boolean! Introduced as an experiment in GitLab 19.3.

Indicates Secrets Manager is enrolled at the instance level.

SecurityAttribute#

A security attribute.

Fields#

Name Type Description
color Color! Color of the security attribute.
description String Description of the security attribute.
editableState SecurityCategoryEditableState! Editable state of the security attribute.
id SecurityAttributeID! Global ID of the security attribute.
name String! Name of the security attribute.
securityCategory SecurityCategory! Security category the attribute belongs to.

SecurityAttributeConnection#

Paginated collection of SecurityAttribute. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

SecurityCategory#

A security category.

Fields#

Name Type Description
description String Description of the security category.
editableState SecurityCategoryEditableState! Editable state of the security category.
id SecurityCategoryID! Global ID of the security category.
multipleSelection Boolean! Whether multiple attributes can be selected.
name String! Name of the security category.
securityAttributes [SecurityAttribute!] Security attributes belonging to the category.
templateType SecurityCategoryTemplateType Template type for predefined categories.

SecurityConfiguration#

Security configuration data for a project.

Fields#

Name Type Description
autoDevopsEnabled Boolean Whether Auto DevOps is enabled for the project.
autoDevopsHelpPagePath String Path to Auto DevOps help documentation.
autoDevopsPath String Path to Auto DevOps settings.
canApplyProfiles Boolean! Whether the current user can apply security profiles.
canEnableAutoDevops Boolean! Whether the current user can enable Auto DevOps.
canEnableSpp Boolean Deprecated in GitLab 18.11. Automatic enablement of Secret Push Protection for public GitLab.com projects has been discontinued.
canManageAttributes Boolean! Whether the current user can manage security attributes.
canReadAttributes Boolean! Whether the current user can read security attributes.
containerScanningForRegistryEnabled Boolean Whether container scanning for registry is enabled.
features [SecurityScanFeature!]! List of security scan features and their configuration status.
gitlabCiHistoryPath String Path to the GitLab CI configuration file history.
gitlabCiPresent Boolean! Whether a GitLab CI configuration file exists in the project.
groupFullPath String Full path of the root ancestor group.
groupManageAttributesPath String Path to manage group security attributes.
helpPagePath String Path to application security help documentation.
isGitlabCom Boolean Deprecated in GitLab 18.11. Automatic enablement of Secret Push Protection for public GitLab.com projects has been discontinued.
latestPipelinePath String Path to the latest pipeline on the default branch.
licenseConfigurationSource String Source of license configuration.
licenseScanningForCyclonedxEnabled Boolean Whether license scanning for CycloneDX SBOM files is enabled.
maxTrackedRefs Int Maximum number of refs that can be tracked for security scanning.
secretDetectionConfigurationPath String Path to secret detection configuration.
secretPushProtectionAvailable Boolean! Whether secret push protection is available for projects in the instance.
secretPushProtectionEnabled Boolean Whether secret push protection is enabled for the project.
secretPushProtectionEnforced Boolean Whether secret push protection is automatically enforced for all projects in the instance.
secretPushProtectionLicensed Boolean Deprecated in GitLab 18.11. Automatic enablement of Secret Push Protection for public GitLab.com projects has been discontinued.
securityScanProfilesLicensed Boolean! Whether the project has a license for security scan profiles.
securityTrainingEnabled Boolean! Whether security training is available for the project.
upgradePath String Path to upgrade security features.
userIsProjectAdmin Boolean! Whether the current user has admin permissions for security testing.
validityChecksAvailable Boolean Whether secret detection validity checks are available.
validityChecksEnabled Boolean Whether secret detection validity checks are enabled.
vulnerabilityArchiveExportPath String Path to export vulnerability archives via API.
vulnerabilityTrainingDocsPath String Path to vulnerability training documentation.

SecurityFeature#

Security feature information for a scan type.

Fields#

Name Type Description
anchor String Anchor link for the security feature.
configurationHelpPath String Path to configuration help documentation.
description String! Description of what the security feature does.
helpPath String! Path to help documentation for the security feature.
name String! Full name of the security feature.
secondary SecondarySecurityFeature Secondary feature information.
shortName String Short name of the security feature.
type String! Type identifier for the security feature.

SecurityFindingTokenStatus#

Represents the status of a secret token found in a security finding.

Fields#

Name Type Description
createdAt Time! When the token status was created.
id ID! ID of the finding token status.
lastVerifiedAt Time When the token was last verified with the issuing service.
status VulnerabilityFindingTokenStatusState! Status of the token (unknown, active, inactive).
updatedAt Time! When the token status was last updated.

SecurityMetrics#

Represents security metrics.

Fields#

Name Type Description
mttrOverTime [MttrOverTimeBucket!] Introduced as an experiment in GitLab 19.5.

Weekly mean time to remediation (MTTR) of vulnerabilities. Each week only counts vulnerabilities detected no earlier than 90 days before the week starts, so a week's MTTR is at most about 97 days. Returns null unless the security_dashboard_mttr_chart feature flag is enabled. This feature is currently under development and not yet available for general use.

Arguments for mttrOverTime:
endDate (ISO8601Date!)
End date of the time range. Snapped forward to the end of its week (Sunday), capped at the current date. The most recent week may be partial. The range can span at most 12 weeks.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
startDate (ISO8601Date!)
Start date of the time range. Snapped back to the start of its week (Monday) so results align to full Monday to Sunday buckets.
riskScore RiskScore Introduced as an experiment in GitLab 18.4.

Total risk score information. This feature is currently under development and not yet available for general use.
vulnerabilitiesByAge [VulnerabilitiesByAge!] Introduced as an experiment in GitLab 18.9.

Vulnerability age statistics based on predefined age bands. See VulnerabilitiesByAge for details. This feature is currently under development and not yet available for general use.

Arguments for vulnerabilitiesByAge:
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
vulnerabilitiesByIdentifier [VulnerabilitiesByIdentifier!] Introduced as an experiment in GitLab 18.10.

Vulnerability identifier statistics with filtering. This feature is currently under development and not yet available for general use.

Arguments for vulnerabilitiesByIdentifier:
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
vulnerabilitiesOverTime VulnerabilitiesOverTimeConnection Vulnerability metrics over time with filtering and grouping capabilities. This feature is currently under development and not yet available for general use. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for vulnerabilitiesOverTime:
endDate (ISO8601Date!)
End date for the vulnerability metrics time range. The end date should be within 31 days from the start date.
severity ([VulnerabilitySeverity!])
Filter vulnerabilities by severity.
startDate (ISO8601Date!)
Start date for the vulnerability metrics time range.
vulnerabilitiesPerSeverity VulnerabilitiesPerSeverity Count of open vulnerabilities per severity level. This feature is currently under development and not yet available for general use.

Arguments for vulnerabilitiesPerSeverity:
endDate (ISO8601Date)
Introduced as an experiment in GitLab 18.3.

End date for the vulnerability metrics time range. Optional.
startDate (ISO8601Date)
Introduced as an experiment in GitLab 18.3.

Start date for the vulnerability metrics time range. Optional.
vulnerabilityResolutionFunnel VulnerabilityResolutionFunnel Introduced as an experiment in GitLab 19.2.

Adoption funnel for AI-assisted vulnerability resolution. This feature is currently under development and not yet available for general use.

Arguments for vulnerabilityResolutionFunnel:
endDate (ISO8601Date!)
End date of the detection window (inclusive).
startDate (ISO8601Date!)
Start date of the detection window (inclusive).

SecurityPolicy#

Represents a security policy.

Fields#

Name Type Description
id ID! ID of the security policy.
name String! Name of the security policy.

SecurityPolicyType#

Represents the security policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
linkedProjectsCount Int Introduced as an experiment in GitLab 19.1.

Number of projects linked to this policy. Does not account for policy_scope filtering.
name String! Name of the policy.
policyAttributes PolicyAttributesUnion! Attributes specific to the policy type.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope of the policy.
testRuns PolicyScheduleTestRunConnection Introduced as an experiment in GitLab 18.10.

Test runs for this security policy. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type String Description of the policy type.
updatedAt Time! Timestamp of when the policy YAML was last updated.
yaml String! YAML definition of the policy.

SecurityPolicyTypeConnection#

Paginated collection of SecurityPolicyType. See Standard connection fields for the fields available on every connection.

SecurityPolicyValidationError#

Security policy validation error.

Fields#

Name Type Description
field String! Error field.
index Int Index of the errored action.
level String! Error level.
message String! Error message.
title String Error title.

SecurityPostureCounters#

Aggregated security posture counters for a namespace.

Fields#

Name Type Description
total Int! Introduced as an experiment in GitLab 19.5.

Total number of unarchived projects in the namespace.
withFailures Int! Introduced as an experiment in GitLab 19.0.

Number of unarchived projects with at least one failed scan.
withScanners Int! Introduced as an experiment in GitLab 19.0.

Number of unarchived projects with at least one security scanner configured.
withStale Int! Introduced as an experiment in GitLab 19.0.

Number of unarchived projects with at least one stale scan.
withTriageCoverage Int Introduced as an experiment in GitLab 19.5.

Count of unarchived projects in the group with at least one triage and remediation trigger enabled.

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.
containerScanningForRegistry SecurityReportSummarySection Aggregated counts for the container_scanning_for_registry 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.
sarif SecurityReportSummarySection Aggregated counts for the sarif 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
vulnerabilitiesCount Int Total number of vulnerabilities.

SecurityScanFeature#

Security scan feature configuration.

Fields#

Name Type Description
available Boolean! Whether the security scan is available for the project.
canEnableByMergeRequest Boolean! Whether the security scan can be enabled via merge request.
canUserConfigure Boolean! Whether the current user can configure the security scan.
configurationPath String Path to configure the security scan.
configured Boolean! Whether the security scan is configured for the project.
metaInfoPath String Path to additional information about the security scan.
onDemandAvailable Boolean! Whether on-demand scanning is available for the scan type.
securityFeatures SecurityFeature Additional security features specific to the scan type.
type String! Type of security scan (e.g., sast, dast, secret_detection).

SecurityScanProfileVariable#

A configuration variable that a scan profile of a given type can set.

Fields#

Name Type Description
envVar String CI/CD variable the configuration field is passed to the scan as.
key String! Name of the configuration field, as used in the scan profile configuration input.

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.

SecurityTrackedRef#

Represents a ref (branch or tag) tracked for security vulnerabilities.

Fields#

Name Type Description
commit Commit Latest commit on the ref.
id ID! Global ID of the tracked ref.
isDefault Boolean! Whether the ref is the default branch.
isProtected Boolean! Whether the ref is protected.
name String! Name of the ref (branch or tag name).
refType SecurityTrackedRefType! Type of the ref being tracked.
state SecurityTrackedRefState! Current tracking state of the ref.
trackedAt Time! When tracking was enabled for the ref.
vulnerabilitiesCount Int! Count of open vulnerabilities on the ref.

SecurityTrackedRefConnection#

Paginated collection of SecurityTrackedRef. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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
detailedError SentryDetailedError Detailed version of a Sentry error on the project.

Arguments for detailedError:
id (GitlabErrorTrackingDetailedErrorID!)
ID of the Sentry issue.
errorStackTrace SentryErrorStackTrace Stack Trace of Sentry Error.

Arguments for errorStackTrace:
id (GitlabErrorTrackingDetailedErrorID!)
ID of the Sentry issue.
errors SentryErrorConnection Collection of Sentry Errors. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for errors:
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.
externalUrl String External URL for Sentry.

SentryErrorConnection#

Paginated collection of SentryError. See Standard connection fields for the fields available on every connection.

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.

ServiceConnection#

Paginated collection of Service. See Standard connection fields for the fields available on every connection.

SeverityOverride#

Represents a vulnerability severity override.

Fields#

Name Type Description
author UserCore! User who changed the severity.
createdAt Time Time of severity change.
newSeverity VulnerabilitySeverity! New severity of the vulnerability.
originalSeverity VulnerabilitySeverity! Original severity of the vulnerability.

SeverityOverrideConnection#

Paginated collection of SeverityOverride. See Standard connection fields for the fields available on every connection.

SlashCommand#

Duo Chat slash command.

Fields#

Name Type Description
description String! Description of what the slash command does.
name String! Name of the slash command.
shouldSubmit Boolean! Indicates whether the command should be submitted automatically when clicked.

Snippet#

Represents a snippet entry.

Implements: NoteableInterface

Fields#

Name Type Description
author UserCore Owner of the snippet.
blobs SnippetBlobConnection Snippet blobs. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for blobs:
paths ([String!])
Paths of the blobs.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
createdAt Time! Timestamp the snippet was created.
description String Description of the snippet.
descriptionHtml String GitLab Flavored Markdown rendering of description.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
imported Boolean! Indicates whether the snippet was imported.
importedFrom ImportSource! Import source of the snippet.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
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.
titleHtml String HTML rendering of title.
updatedAt Time! Timestamp the 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.

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.

SnippetBlobConnection#

Paginated collection of SnippetBlob. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
hasUnretrievableBlobs Boolean! Indicates if the snippet has unretrievable blobs.

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.

SnippetConnection#

Paginated collection of Snippet. See Standard connection fields for the fields available on every connection.

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
checksumMismatch Boolean Indicate if the checksums of the SnippetRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the SnippetRepositoryRegistry was created.
dataManagementDetailsPath String Path to the data management view for this SnippetRepositoryRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the SnippetRepositoryRegistry is missing on primary.
modelRecordId Int ID of the SnippetRepositoryRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the SnippetRepositoryRegistry in case of mismatch.
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 of SnippetRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the SnippetRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the SnippetRepositoryRegistry.

SnippetRepositoryRegistryConnection#

Paginated collection of SnippetRepositoryRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

SpdxLicense#

SPDX license entry from the SPDX licence catalogue.

Fields#

Name Type Description
name String! Full name of the license.
spdxIdentifier String! SPDX identifier of the license.
url String URL to the SPDX license page.

SquashOption#

Squash option overrides for a protected branch.

Fields#

Name Type Description
helpText String! Help text for the squash option.
option String! Human-readable description of the squash option.

SshSignature#

SSH signature for a signed commit.

Implements: CommitSignature

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.

StandardRole#

Represents a standard role.

Implements: RoleInterface

Fields#

Name Type Description
accessLevel Int! Access level as a number.
description String Role description.
detailsPath String Introduced as an experiment in GitLab 17.4.

URL path to the role details webpage.
id ID! Role ID.
name String Role name.

StandardRoleConnection#

Paginated collection of StandardRole. See Standard connection fields for the fields available on every connection.

StandardsAdherenceChecksStatus#

Progress of standards adherence checks.

Fields#

Name Type Description
checksCompleted Int! Number of adherence checks successfully completed.
startedAt Time! UTC timestamp when the adherence checks scan was started.
totalChecks Int! Number of adherence checks multiplied by the number of projects in the group.

StatusAction#

Fields#

Name Type Description
buttonTitle String Title for the button, for example: Retry the job.
confirmationMessage String Introduced as an experiment in GitLab 17.0.

Custom confirmation message for a manual 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.

StringConnection#

Paginated collection of String. See Standard connection fields for the fields available on every connection.

StringExpression#

an expression with a string value.

Implements: ExpressionInterface

Fields#

Name Type Description
field String! Field the expression applies to.
operator String! Operator of the expression.
value String! String value of the expression.

Submodule#

Implements: Entry

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! SHA of the entry.
treeUrl String Tree URL for the sub-module.
type EntryType! Type of tree entry.
webUrl String Web URL for the sub-module.

SubmoduleConnection#

Paginated collection of Submodule. See Standard connection fields for the fields available on every connection.

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.

SubscriptionFutureEntryConnection#

Paginated collection of SubscriptionFutureEntry. See Standard connection fields for the fields available on every connection.

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.

Suggestion#

Fields#

Name Type Description
applied Boolean! Indicates whether the suggestion has been applied.
fromContent String! Original content being replaced by the suggestion.
fromLine Int! First line number of the change being suggested.
id SuggestionID! ID of the suggestion.
toContent String! Content suggested as the replacement.
toLine Int! Last line number of the change being suggested.

SuggestionConnection#

Paginated collection of Suggestion. See Standard connection fields for the fields available on every connection.

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.

Tag#

Fields#

Name Type Description
commit Commit Commit for the tag.
message String Tagging message.
name String! Name of the tag.

TagConnection#

Paginated collection of Tag. See Standard connection fields for the fields available on every connection.

TargetedMessage#

Represents a targeted message.

Fields#

Name Type Description
id ID! ID of the targeted message.
roles [Int!]! Roles targeted by the message. Empty array means all roles.
targetType String! Type of the targeted message (e.g., banner_page_level).

TaskCompletionStatus#

Completion status of tasks.

Fields#

Name Type Description
completedCount Int! Number of completed tasks.
count Int! Number of total tasks.

TerraformModuleMetadata#

Terraform module metadata.

Fields#

Name Type Description
createdAt Time! Timestamp of when the metadata was created.
fields TerraformModuleMetadataFields! Fields of the metadata.
id PackagesTerraformModuleMetadatumID! ID of the metadata.
updatedAt Time! Timestamp of when the metadata was last updated.

TerraformModuleMetadataDependencies#

Terraform module metadata dependencies.

Fields#

Name Type Description
modules [TerraformModuleMetadataDependency!] Modules of the module.
providers [TerraformModuleMetadataDependency!] Providers of the module.

TerraformModuleMetadataDependency#

Terraform module metadata dependency.

Fields#

Name Type Description
name String! Name of the dependency.
source String Source of the dependency.
version String Version of the dependency.

TerraformModuleMetadataExample#

Terraform module metadata example.

Implements: TerraformModuleMetadataSharedFields

Fields#

Name Type Description
inputs [TerraformModuleMetadataInput!] Inputs of the module.
name String! Name of the example.
outputs [TerraformModuleMetadataOutput!] Outputs of the module.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.

TerraformModuleMetadataFields#

Terraform module metadata fields type.

Fields#

Name Type Description
examples [TerraformModuleMetadataExample!] Examples of the module.
root TerraformModuleMetadataRoot! Root module.
submodules [TerraformModuleMetadataSubmodule!] Submodules of the module.

TerraformModuleMetadataInput#

Terraform module metadata input type.

Fields#

Name Type Description
default String Default value of the input.
description String Description of the input.
name String! Name of the input.
type String! Type of the input.

TerraformModuleMetadataOutput#

Terraform module metadata output.

Fields#

Name Type Description
description String Description of the output field.
name String! Name of the output field.

TerraformModuleMetadataRoot#

Metadata for Terraform root module.

Implements: TerraformModuleMetadataSharedFields

Fields#

Name Type Description
dependencies TerraformModuleMetadataDependencies Dependencies of the module.
inputs [TerraformModuleMetadataInput!] Inputs of the module.
outputs [TerraformModuleMetadataOutput!] Outputs of the module.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.
resources [String!] Resources of the module.

TerraformModuleMetadataSubmodule#

Terraform module metadata submodule.

Implements: TerraformModuleMetadataSharedFields

Fields#

Name Type Description
dependencies TerraformModuleMetadataDependencies Dependencies of the submodule.
inputs [TerraformModuleMetadataInput!] Inputs of the module.
name String! Name of the submodule.
outputs [TerraformModuleMetadataOutput!] Outputs of the module.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.
resources [String!] Resources of the submodule.

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.
permanentDeletionAt Time Introduced as an experiment in GitLab 19.5.

Timestamp of when the state will be permanently deleted, if it is scheduled for deletion.
protectionRuleExists Boolean! Introduced as an experiment in GitLab 19.0.

Whether a protection rule exists for the Terraform state.
updatedAt Time! Timestamp the Terraform state was updated.
versions TerraformStateVersionConnection Versions of the Terraform state, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

TerraformStateConnection#

Paginated collection of TerraformState. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

TerraformStateProtectionRule#

A protection rule for Terraform state backends, controlling who can write to a state based on project role and request source.

Fields#

Name Type Description
allowedFrom TerraformStateProtectionRuleAllowedFrom! Introduced as an experiment in GitLab 18.11.

Restriction on the source of write requests. ANYWHERE allows all sources, CI_ONLY requires a CI job token, CI_ON_PROTECTED_BRANCH_ONLY requires a CI job on a protected branch.
id TerraformStateProtectionRuleID! Introduced as an experiment in GitLab 18.11.

Global ID of the Terraform state protection rule.
minimumAccessLevelForWrite TerraformStateProtectionRuleAccessLevel! Introduced as an experiment in GitLab 18.11.

Minimum GitLab access level required to perform write operations on the Terraform state. Valid values include DEVELOPER, MAINTAINER, OWNER, or ADMIN.
stateName String! Introduced as an experiment in GitLab 18.11.

Terraform state name protected by the rule.

TerraformStateProtectionRuleConnection#

Paginated collection of TerraformStateProtectionRule. See Standard connection fields for the fields available on every connection.

TerraformStateVersion#

Fields#

Name Type Description
createdAt Time! Timestamp the version was created.
createdByUser UserCore User that created the version.
downloadPath String URL for downloading the version's JSON file.
id ID! ID of the Terraform state version.
job CiJob Job that created the version.
serial Int Serial number of the version.
updatedAt Time! Timestamp the version was updated.

TerraformStateVersionConnection#

Paginated collection of TerraformStateVersion. See Standard connection fields for the fields available on every connection.

TerraformStateVersionRegistry#

Represents the Geo sync and verification state of a terraform state version.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the TerraformStateVersionRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the TerraformStateVersionRegistry was created.
dataManagementDetailsPath String Path to the data management view for this TerraformStateVersionRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the TerraformStateVersionRegistry is missing on primary.
modelRecordId Int ID of the TerraformStateVersionRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the TerraformStateVersionRegistry in case of mismatch.
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 of TerraformStateVersionRegistry started.
verificationState VerificationStateEnum Verification state of the TerraformStateVersionRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the TerraformStateVersionRegistry.

TerraformStateVersionRegistryConnection#

Paginated collection of TerraformStateVersionRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

TestCaseConnection#

Paginated collection of TestCase. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

TestReportConnection#

Paginated collection of TestReport. See Standard connection fields for the fields available on every connection.

TestReportSummary#

Test report for a pipeline.

Fields#

Name Type Description
testSuites TestSuiteSummaryConnection! Test suites belonging to a pipeline test report. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.

TestSuiteSummaryConnection#

Paginated collection of TestSuiteSummary. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

TimeTrackingTimelogCategoryConnection#

Paginated collection of TimeTrackingTimelogCategory. See Standard connection fields for the fields available on every connection.

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.

TimelineEventTagTypeConnection#

Paginated collection of TimelineEventTagType. See Standard connection fields for the fields available on every connection.

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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
updatedAt Time! Timestamp when the event updated.
updatedByUser UserCore User that updated the timeline event.

TimelineEventTypeConnection#

Paginated collection of TimelineEventType. See Standard connection fields for the fields available on every connection.

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.

TimelogConnection#

Paginated collection of Timelog. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
totalSpentTime BigInt! Total time spent in seconds.

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 the to-do item.
body String! Body of the to-do item.
createdAt Time! Timestamp the to-do item was created.
group Group Group the to-do item is associated with.
id ID! ID of the to-do item.
memberAccessType String Access type of access request to-do items.
note Note Note which created the to-do item.
project Project Project the to-do item is associated with.
snoozedUntil Time Time until when the todo is snoozed.
state TodoStateEnum! State of the to-do item.
target Todoable! Deprecated in GitLab 17.4. Under certain circumstances, the target field on a to-do item can be null. The GraphQL schema currently declares target field as non-nullable. Use the new target_entity field instead.
targetEntity Todoable Target of the to-do item.
targetType TodoTargetEnum! Target type of the to-do item.
targetUrl String URL of the to-do item target.
transferFailedRetryUrl String URL that retries a transfer-failed to-do item.
transferFailureReason String Reason the transfer failed, for a transfer-failed to-do item.

TodoConnection#

Paginated collection of Todo. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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.

TopicConnection#

Paginated collection of Topic. See Standard connection fields for the fields available on every connection.

Tree#

Fields#

Name Type Description
blobs BlobConnection! Blobs of the tree. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
lastCommit Commit Last commit for the tree.

Arguments for lastCommit:
path (String)
Path to get the last commit for. Default value is the root of the repository.
ref (String)
Commit ref to get the last commit for. Default value is HEAD.
refType (RefType)
Type of ref.
permalinkPath String Introduced as an experiment in GitLab 17.11.

Web path to tree permalink. The permalinkPath field returns a string that represents the web path to a specific version of a directory, identified by its commit SHA. Use this path to create permanent links to directories at specific points in your repository's history.
submodules SubmoduleConnection! Sub-modules of the tree. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
trees TreeEntryConnection! Trees of the tree. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

TreeConnection#

Paginated collection of Tree. See Standard connection fields for the fields available on every connection.

TreeEntry#

Represents a directory.

Implements: Entry

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! SHA of 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).

TreeEntryConnection#

Paginated collection of TreeEntry. See Standard connection fields for the fields available on every connection.

TriageAndRemediationCapability#

A triage and remediation capability and its coverage state for a project.

Fields#

Name Type Description
enabled Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the capability is attached to the project.
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.5.

Run mode for the capability.
triggerType ScanProfileTriggerType! Introduced as an experiment in GitLab 19.5.

Trigger type the capability applies to.

TriageAndRemediationCoverage#

Triage and remediation capability coverage for a project.

Fields#

Name Type Description
capabilities [TriageAndRemediationCapability!]! Introduced as an experiment in GitLab 19.5.

Triage and remediation capabilities and their coverage state, one entry per trigger type.

TriageAndRemediationCoverageCounters#

Triage and remediation coverage counters for a namespace, for a given trigger type.

Fields#

Name Type Description
autoCount Int! Introduced as an experiment in GitLab 19.5.

Count of unarchived projects in the group where the trigger type is attached and set to automatic.
enabledCount Int! Introduced as an experiment in GitLab 19.5.

Count of unarchived projects in the group where the trigger type is attached.

TrialUsage#

Trial usage statistics.

Fields#

Name Type Description
creditsUsed Float Total credits used during a trial.
totalUsersUsingCredits Int Number of users who have used credits during a trial.
users GitlabTrialUsageUserConnection List of users with their trial usage data. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for users:
username (String)
Username of the User.

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 the access level.
group AccessLevelGroup Group associated with the access level.
memberRole MemberRole Custom role associated with the access level.
user AccessLevelUser User associated with the access level.

UnprotectAccessLevelConnection#

Paginated collection of UnprotectAccessLevel. See Standard connection fields for the fields available on every connection.

UploadRegistry#

Represents the Geo replication and verification state of an upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the UploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the UploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this UploadRegistry.
fileId ID! ID of the Upload.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
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.
missingOnPrimary Boolean Indicate if the UploadRegistry is missing on primary.
modelRecordId Int ID of the UploadRegistry's model record.
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.
verificationChecksumMismatched String The expected checksum of the UploadRegistry in case of mismatch.
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 of UploadRegistry started.
verificationState VerificationStateEnum Verification state of the UploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the UploadRegistry.

UploadRegistryConnection#

Paginated collection of UploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

UsageTrendsMeasurementConnection#

Paginated collection of UsageTrendsMeasurement. See Standard connection fields for the fields available on every connection.

UserAchievement#

Fields#

Name Type Description
achievement Achievement! Achievement awarded.
awardMessage String Message associated with the awarded achievement.
awardMessageHtml String GitLab Flavored Markdown rendering of award_message.
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.
showOnProfile Boolean! Indicates whether or not the achievement is shown on the profile.
updatedAt Time! Timestamp the achievement was last updated.
user UserCore! Achievement recipient.

UserAchievementConnection#

Paginated collection of UserAchievement. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

UserAddOnAssignment#

An assignment of an AddOnPurchase to a User.

Fields#

Name Type Description
addOnPurchase AddOnPurchase! Add-on purchase the user is assigned to.

UserAddOnAssignmentConnection#

Paginated collection of UserAddOnAssignment. See Standard connection fields for the fields available on every connection.

UserCallout#

Fields#

Name Type Description
dismissedAt Time Date when the callout was dismissed.
featureName UserCalloutFeatureNameEnum Name of the feature that the callout is for.

UserCalloutConnection#

Paginated collection of UserCallout. See Standard connection fields for the fields available on every connection.

UserContributionCalendar#

A user's contribution calendar: the profile page's activity heatmap for the past year.

Fields#

Name Type Description
days [UserContributionDay!]! Days with at least one contribution, oldest first.
timezone String! Identifier of the timezone the days are counted in: the user's timezone, or the instance default if the user has not set one.
totalCount Int! Total number of contributions in the past year.
utcOffset Int! Offset of timezone from UTC, in seconds, as of the request.

UserContributionDay#

One day with at least one contribution on a user's contribution calendar.

Fields#

Name Type Description
count Int! Number of contributions on the day.
date Date! Date of the contributions, in the user's timezone.

UserCore#

Core representation of a GitLab user.

Implements: Todoable, User

Fields#

Name Type Description
active Boolean Indicates if the user is active.
assignedMergeRequests MergeRequestConnection Merge requests assigned to the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for assignedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
authoredMergeRequests MergeRequestConnection Merge requests authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for authoredMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
includeAssigned (Boolean)
Include merge requests the user is assigned to.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
reviewerUsername (String)
Username of the reviewer.
reviewerWildcardId (ReviewerWildcardId)
Filter by reviewer presence. Incompatible with reviewerUsername.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commitEmail String User's default commit email.
compositeIdentityEnforced Boolean Indicates if composite identity is enforced for the user.
contributedProjects ProjectConnection Projects the user has contributed to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for contributedProjects:
active (Boolean)
Filters by projects that are not archived and not marked for deletion.
includePersonal (Boolean)
Include personal projects.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
Sort contributed projects.
contributionCalendar UserContributionCalendar Introduced as an experiment in GitLab 19.5.

Contribution calendar of the user: the profile page activity heatmap for the past year. Null when the current user cannot read the profile.
createdAt Time Timestamp of when the user was created.
customAttributes [CustomAttribute!] Custom attributes of the user. Only available to admins.
discord String Discord ID of the user.
duoStatus UserDuoStatus Duo status for the user.
email String Deprecated in GitLab 13.7. Renamed. Use User.publicEmail instead.
emails EmailConnection User's email addresses. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
events EventConnection Activity events visible to the current user, most recent first. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for events:
filter (UserEventFilter)
Filter events by type. Defaults to all events.
github String GitHub profile name of the user.
gitpodEnabled Boolean Whether Ona is enabled at the user level.
groupCallouts UserGroupCalloutConnection User callouts that belong to the user per group. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
groups GroupConnection Groups where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for groups:
permissionScope (GroupPermission)
Filter by permissions the user has on groups.
search (String)
Search by group name or path.
soloOwned (Boolean)
When true, returns only groups in the current organization where the user is the sole owner.
sort (GroupSort)
Sort groups by given criteria.
human Boolean Indicates if the user is a regular user.
id UserID! Global 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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
organization String Who the user represents or works for.
organizations OrganizationConnection Introduced as an experiment in GitLab 16.6.

Organizations where the user has access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for organizations:
excludeDefault (Boolean)
Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
search (String)
Search query, which can be for the organization name or a path.
soloOwned (Boolean)
When true, returns only organizations solely owned by the user.
state (OrganizationState)
Introduced as an experiment in GitLab 19.1.

Filter organizations by state.
personalAccessTokens PersonalAccessTokenConnection Introduced as an experiment in GitLab 18.6.

Personal access tokens of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for personalAccessTokens:
createdAfter (Time)
Filter personal access tokens created after the timestamp.
createdBefore (Time)
Filter personal access tokens created before the timestamp.
expiresAfter (Date)
Filter personal access tokens that expire after the specified date.
expiresBefore (Date)
Filter personal access tokens that expire before the specified date.
id (PersonalAccessTokenID)
Filter personal access tokens by ID.
lastUsedAfter (Time)
Filter personal access tokens last used after the timestamp.
lastUsedBefore (Time)
Filter personal access tokens last used before the timestamp.
revoked (Boolean)
Filter personal access tokens by their revoked status.
search (String)
Query to search personal access tokens by name.
sort (AccessTokenSort)
Sort personal access tokens by the given criteria. Default is expires_at_asc.
state (AccessTokenState)
Filter personal access tokens by state.
preferencesGitpodPath String Web path to the Ona section within user preferences.
profileEnableGitpodPath String Web path to enable Ona for the user.
projectCount Int Project count for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
pronouns String Pronouns of the user.
publicEmail String User's public email.
reviewRequestedMergeRequests MergeRequestConnection Merge requests assigned to the user for review. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for reviewRequestedMergeRequests:
approvedBy ([String!])
Usernames of the approvers.
approver ([String!])
Usernames of possible approvers.
assigneeUsername (String)
Username of the assignee.
assigneeUsernames ([String!])
Usernames of users assigned to the merge request.
assigneeWildcardId (AssigneeWildcardId)
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername (String)
Username of the author.
blobPath (String)
Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter (Time)
Merge requests closed after the date.
closedBefore (Time)
Merge requests closed before the date.
createdAfter (Time)
Merge requests created after the timestamp.
createdBefore (Time)
Merge requests created before the timestamp.
deployedAfter (Time)
Merge requests deployed after the timestamp.
deployedBefore (Time)
Merge requests deployed before the timestamp.
deploymentId (String)
ID of the deployment.
draft (Boolean)
Limit result to draft merge requests.
environmentName (String)
Environment merge requests have been deployed to.
groupId (GroupID)
The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername (String)
Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids ([String!])
Array of IIDs of merge requests, for example [1, 2].
in ([IssuableSearchableField!])
Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived (Boolean)
Merge requests from archived projects.
labelName ([String])
Labels applied to the merge request.
labels ([String!])
Deprecated in GitLab 17.1. Use labelName.
mergedAfter (Time)
Merge requests merged after the date.
mergedBefore (Time)
Merge requests merged before the date.
mergedBy (String)
Username of the merger.
milestoneTitle (String)
Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId (MilestoneWildcardId)
Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji (String)
Filter by your reaction emoji.
not (MergeRequestsResolverNegatedParams)
List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or (UnionedMergeRequestFilterInput)
List of arguments with inclusive OR.
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.
releaseTag (String)
Filter by release tag.
reviewState (MergeRequestReviewState)
Reviewer state of the merge request.
reviewStates ([MergeRequestReviewState!])
Reviewer states of the merge request.
search (String)
Search query for title or description.
sort (MergeRequestSort)
Sort merge requests by the 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 the state.
subscribed (SubscriptionStatus)
Merge requests the current user is subscribed to.
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 the timestamp.
updatedBefore (Time)
Merge requests updated before the timestamp.
savedReplies SavedReplyConnection Saved replies authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
savedReply SavedReply Saved reply authored by the user.

Arguments for savedReply:
id (UsersSavedReplyID!)
ID of a saved reply.
snippets SnippetConnection Snippets authored by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for snippets:
ids ([SnippetID!])
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type (TypeEnum)
Type of snippet.
visibility (VisibilityScopesEnum)
Visibility of the snippet.
starredProjects ProjectConnection Projects starred by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for starredProjects:
active (Boolean)
Filters by projects that are not archived and not scheduled for deletion.
minAccessLevel (AccessLevelEnum)
Return only projects where current user has at least the specified access level.
programmingLanguageName (String)
Filter projects by programming language name (case insensitive). For example: css or ruby.
search (String)
Search query.
sort (ProjectSort)
List starred projects by sort order.
state UserState! State of the user.
status UserStatus User status.
timelogs TimelogConnection Time logged by the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for timelogs:
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.
todos TodoConnection To-do items of the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for todos:
action ([TodoActionEnum!])
Action to be filtered.
authorId ([ID!])
ID of an author.
groupId ([ID!])
ID of a group.
isSnoozed (Boolean)
Whether the to-do item is snoozed.
projectId ([ID!])
ID of a project.
sort (TodoSort)
Sort todos by given criteria.
state ([TodoStateEnum!])
State of the todo.
type ([TodoTargetEnum!])
Type of the todo.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userAchievements UserAchievementConnection Achievements for the user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for userAchievements:
includeHidden (Boolean)
Indicates whether or not achievements hidden from the profile should be included in the result.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.
workspaces WorkspaceConnection Workspaces owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for workspaces:
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 GitLab 16.7. Use actual_states instead.
projectIds ([ProjectID!])
Filter workspaces by project GlobalIDs.

UserCoreConnection#

Paginated collection of UserCore. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

UserDuoStatus#

Represents the Duo status for a user.

Fields#

Name Type Description
disabled Boolean! Indicates if the user is disabled for assignment in Duo features.
disabledReason String Reason why the user is disabled for assignment in Duo features.
flowTriggerEvents [AiFlowTriggerEventType!]! List of available flow trigger events for the user in Duo features.

UserGroupCallout#

Fields#

Name Type Description
dismissedAt Time! Date when the callout was dismissed.
featureName UserGroupCalloutFeatureName! Name of the feature that the callout is for.
groupId GroupID! Group id that the callout applies.

UserGroupCalloutConnection#

Paginated collection of UserGroupCallout. See Standard connection fields for the fields available on every connection.

UserMemberRole#

Fields#

Name Type Description
id GlobalID! Global ID of the user member role association.
memberRole MemberRole! Member Role to which the user belongs.
user UserCore! User to which the member role belongs.

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 the user for the merge request.
approved Boolean! Whether the user has approved the merge request.
approvedAt Time Timestamp of when the user approved the merge request. Returns null if the user has not approved it.
canMerge Boolean! Whether the user can merge the merge request.
canUpdate Boolean! Whether the user can update the merge request.
reviewState MergeRequestReviewState State of the review by the user.
reviewed Boolean! Whether the user has provided a review for the merge request.
updatedAt Time Timestamp of when the reviewer was last updated. null for records that have not transitioned state since GitLab 19.2.

Implements: NamespacesLinkPaths

Fields#

Name Type Description
autocompleteAwardEmojisPath String Introduced as an experiment in GitLab 18.6.

Path for autocomplete award emojis.
calendarPath String Introduced as an experiment in GitLab 18.4.

Calendar path for work items.
contributionGuidePath String Namespace contribution guide path.
emailsHelpPagePath String Help page path for emails.
epicsList String Namespace epics_list.
epicsListPath String Introduced as an experiment in GitLab 18.6.

Path to the epics list for the namespace.
groupIssues String Namespace group_issues.
groupPath String Introduced as an experiment in GitLab 18.6.

Full path of the group.
issuesList String Namespace issues_list.
issuesListPath String Introduced as an experiment in GitLab 18.6.

Path to the issues list for the namespace.
issuesSettings String Namespace issues settings path.
labelsFetch String Namespace labels_fetch.
labelsManage String Namespace labels_manage.
markdownHelpPath String Help page path for Markdown.
namespaceFullPath String Introduced as an experiment in GitLab 18.6.

Full path of the namespace (project.namespace.full_path or group full_path).
newCommentTemplate [CommentTemplatePath!] Namespace new_comment_template_paths.
newIssuePath String Introduced as an experiment in GitLab 18.6.

Path to create a new issue.
newProject String Namespace new_project.
newTrialPath String Introduced as an experiment in GitLab 18.6.

New trial path for the namespace.
quickActionsHelpPath String Help page path for quick actions.
register String Namespace register_path.
reportAbuse String Namespace report_abuse.
rssPath String Introduced as an experiment in GitLab 18.4.

RSS path for work items.
signIn String Namespace sign_in_path.
userExportEmail String Introduced as an experiment in GitLab 18.3.

User email for export CSV. Returns null for user namespaces.

UserNamespaceMarkdownPaths#

Implements: MarkdownPaths

Fields#

Name Type Description
autocompleteSourcesPath JSON Supported paths for autocomplete sources for a given namespace.

Arguments for autocompleteSourcesPath:
iid (String)
IID of the work item.
workItemTypeId (String)
ID of the work item type.
markdownPreviewPath String Path for the markdown preview for given namespace.

Arguments for markdownPreviewPath:
iid (String)
IID of the target item for markdown preview.
uploadsPath String Uploads path for a given namespace.

UserNamespaceMetadata#

Implements: NamespaceMetadata

Fields#

Name Type Description
groupId String Introduced as an experiment in GitLab 18.6.

ID of the group. Returns null for user namespaces.
initialSort String Introduced as an experiment in GitLab 18.6.

User preference for initial sort order.
isIssueRepositioningDisabled Boolean Introduced as an experiment in GitLab 18.6.

Whether issue repositioning is disabled for the namespace.
maxAttachmentSize String Introduced as an experiment in GitLab 18.6.

Maximum allowed attachment size (humanized).
showNewWorkItem Boolean Introduced as an experiment in GitLab 18.6.

Whether to show the new work item link.
timeTrackingLimitToHours Boolean Introduced as an experiment in GitLab 18.6.

Time tracking limit to hours setting.

UserPermissionExportUploadUploadRegistry#

Represents the Geo replication and verification state of a user_permission_export_upload_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the UserPermissionExportUploadUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the UserPermissionExportUploadUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this UserPermissionExportUploadUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the UserPermissionExportUploadUploadRegistry.
lastSyncFailure String Error message during sync of the UserPermissionExportUploadUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the UserPermissionExportUploadUploadRegistry.
missingOnPrimary Boolean Indicate if the UserPermissionExportUploadUploadRegistry is missing on primary.
modelRecordId Int ID of the UserPermissionExportUploadUploadRegistry's model record.
retryAt Time Timestamp after which the UserPermissionExportUploadUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the UserPermissionExportUploadUploadRegistry.
state RegistryState Sync state of the UserPermissionExportUploadUploadRegistry.
userPermissionExportUploadUploadId ID! ID of the User Permission Export File Upload.
verificationChecksum String The local checksum of the UserPermissionExportUploadUploadRegistry.
verificationChecksumMismatched String The expected checksum of the UserPermissionExportUploadUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the UserPermissionExportUploadUploadRegistry.
verificationRetryAt Time Timestamp after which the UserPermissionExportUploadUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the UserPermissionExportUploadUploadRegistry.
verificationStartedAt Time Timestamp when the verification of UserPermissionExportUploadUploadRegistry started.
verificationState VerificationStateEnum Verification state of the UserPermissionExportUploadUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the UserPermissionExportUploadUploadRegistry.

UserPermissionExportUploadUploadRegistryConnection#

Paginated collection of UserPermissionExportUploadUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

UserPermissions#

Fields#

Name Type Description
createSnippet Boolean! If true, the user can perform create_snippet on this resource.

UserPreferences#

Fields#

Name Type Description
duoDefaultNamespace Namespace Default namespace context for Duo features when namespace cannot be inferred.
extensionsMarketplaceOptInStatus ExtensionsMarketplaceOptInStatus! Status of the Web IDE Extension Marketplace opt-in for the user.
issuesSort IssueSort Sort order for issue lists.
knowledgeGraphGoverningNamespace Namespace Governing and billing namespace for Orbit.
mergeRequestDashboardListType MergeRequestsDashboardListType Merge request dashboard list rendering type.
mergeRequestDashboardShowDrafts Boolean Show draft merge requests on merge request dashboard.
orbitSettings JSON! Introduced as an experiment in GitLab 19.0.

Orbit agent settings for the user.
organizationGroupsProjectsDisplay OrganizationGroupProjectDisplay! Introduced as an experiment in GitLab 17.2.

Default list view for organization groups and projects.
organizationGroupsProjectsSort OrganizationGroupProjectSort Introduced as an experiment in GitLab 17.2.

Sort order for organization groups and projects.
projectsSort ProjectSort Sort order for projects.
timezone String Introduced as an experiment in GitLab 17.7.

Timezone of the user.
useWorkItemsView Boolean Deprecated in GitLab 19.5. Work item view is always used.
visibilityPipelineIdType VisibilityPipelineIdType Determines whether the pipeline list shows ID or IID.
wikiUseAutoCommitMessage Boolean! Introduced as an experiment in GitLab 18.10.

Whether to skip the commit message modal and use the auto-generated commit message when saving changes to a wiki document.
workItemsDisplaySettings JSON! Display settings for the work item lists.

UserStatus#

Fields#

Name Type Description
availability AvailabilityEnum! User availability status.
clearStatusAt Time Timestamp when the status should be automatically cleared.
disabledForDuoUsage Boolean! Indicates if the user is disabled for assignment in Duo features.
disabledForDuoUsageReason String Reason why the user is disabled for assignment in Duo features.
emoji String String representation of emoji.
message String User status message.
messageHtml String HTML of the user status message.

UserUploadRegistry#

Represents the Geo replication and verification state of a user_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the UserUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the UserUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this UserUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the UserUploadRegistry.
lastSyncFailure String Error message during sync of the UserUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the UserUploadRegistry.
missingOnPrimary Boolean Indicate if the UserUploadRegistry is missing on primary.
modelRecordId Int ID of the UserUploadRegistry's model record.
retryAt Time Timestamp after which the UserUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the UserUploadRegistry.
state RegistryState Sync state of the UserUploadRegistry.
userUploadId ID! ID of the User Upload.
verificationChecksum String The local checksum of the UserUploadRegistry.
verificationChecksumMismatched String The expected checksum of the UserUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the UserUploadRegistry.
verificationRetryAt Time Timestamp after which the UserUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the UserUploadRegistry.
verificationStartedAt Time Timestamp when the verification of UserUploadRegistry started.
verificationState VerificationStateEnum Verification state of the UserUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the UserUploadRegistry.

UserUploadRegistryConnection#

Paginated collection of UserUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

UsersQueuedForRolePromotion#

Represents a Pending Member Approval Queued for Role Promotion.

Fields#

Name Type Description
newAccessLevel AccessLevel Highest New GitLab::Access level requested for the member.
user UserCore User that is associated with the member approval object.

UsersQueuedForRolePromotionConnection#

Paginated collection of UsersQueuedForRolePromotion. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

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 as an experiment in GitLab 15.6.

Project the value stream belongs to, returns empty if it belongs to a group.
stages [ValueStreamStage!] Value Stream stages.

Arguments for stages:
id (ID)
Value stream stage id.

ValueStreamAnalytics#

Fields#

Name Type Description
aggregationStatus AggregationStatus Shows information about background data collection and aggregation.

ValueStreamAnalyticsDateMetric#

.

Fields#

Name Type Description
date Date Date for the metric.
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.

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.

ValueStreamConnection#

Paginated collection of ValueStream. See Standard connection fields for the fields available on every connection.

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.
endEventHtmlDescription String! HTML description of the end event.
endEventIdentifier ValueStreamStageEvent! End event identifier.
endEventLabel Label Label associated with end event.
hidden Boolean! Whether the stage is hidden.
id AnalyticsCycleAnalyticsStageID! ID of the value stream.
metrics ValueStreamStageMetrics! Aggregated metrics for the given stage.

Arguments for metrics:
assigneeUsernames ([String!])
Usernames of users assigned to the issue or the merge request.
authorUsername (String)
Username of the author of the issue or the merge request.
epicId (ID)
ID of an epic associated with the issues. Using the filter is not supported for stages based on merge requests.
iterationId (ID)
ID of an iteration associated with the issues. Using the filter is not supported for stages based on merge requests.
labelNames ([String!])
Labels applied to the issue or the merge request.
milestoneTitle (String)
Milestone applied to the issue or the merge request.
myReactionEmoji (String)
Filter by reaction emoji applied by the current user.
not (NegatedValueStreamAnalyticsIssuableFilterInput)
Argument used for adding negated filters.
projectIds ([ProjectID!])
Filter for projects. Only available for group value streams.
timeframe (Timeframe!)
Aggregation timeframe. Filters the issue or the merge request creation time for FOSS projects, and the end event timestamp for licensed projects or groups.
weight (Int)
Weight applied to the issue. Using the filter is not supported for stages based on merge requests.
name String! Name of the stage.
startEventHtmlDescription String! HTML description of the start event.
startEventIdentifier ValueStreamStageEvent! Start event identifier.
startEventLabel Label Label associated with start event.

ValueStreamStageItems#

Fields#

Name Type Description
duration String Duration of the item on the stage.
durationInMilliseconds BigInt Duration of item on stage in milliseconds.
endEventTimestamp Time When exited the stage.
record Issuable Item record.

ValueStreamStageItemsConnection#

Paginated collection of ValueStreamStageItems. See Standard connection fields for the fields available on every connection.

ValueStreamStageMetrics#

Fields#

Name Type Description
average ValueStreamAnalyticsMetric Average duration in seconds.
count ValueStreamAnalyticsMetric Limited item count. The backend counts maximum 1000 items, for free projects, and maximum 10,000 items for licensed projects or licensed groups.
items ValueStreamStageItemsConnection Introduced as an experiment in GitLab 17.4.

Items in the stage. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for items:
sort (ValueStreamStageItemSort)
Sort stage items by criteria.
median ValueStreamAnalyticsMetric Median duration in seconds.
series ValueStreamStageSeries! Introduced as an experiment in GitLab 17.4.

Data series in the value stream stage.

ValueStreamStageSeries#

Fields#

Name Type Description
averageDurations [ValueStreamAnalyticsDateMetric!] Average duration for each day within the given date range.

VirtualRegistriesSetting#

Root group level virtual registries settings.

Fields#

Name Type Description
enabled Boolean! Indicates whether virtual registries are enabled for the group.

VirtualRegistryCleanupPolicy#

Represents a virtual registry cleanup policy.

Fields#

Name Type Description
cadence Int! Introduced as an experiment in GitLab 18.7.

Frequency in days for running the cleanup policy. Valid values: 1, 7, 14, 30, 90.
createdAt Time! Introduced as an experiment in GitLab 18.7.

Timestamp when the cleanup policy was created.
enabled Boolean! Introduced as an experiment in GitLab 18.7.

Whether the cleanup policy is enabled.
failureMessage String Introduced as an experiment in GitLab 18.7.

Error message when the cleanup policy fails.
keepNDaysAfterDownload Int! Introduced as an experiment in GitLab 18.7.

Number of days to keep cached entries after their last download.
lastRunAt Time Introduced as an experiment in GitLab 18.7.

Last time that the virtual registry cleanup policy executed.
lastRunDeletedEntriesCount Int Introduced as an experiment in GitLab 18.7.

Number of entries deleted during the last cleanup run.
lastRunDeletedSize BigInt Introduced as an experiment in GitLab 18.7.

Size in bytes of data deleted during the last cleanup run.
lastRunDetailedMetrics CleanupPolicyLastRunDetailedMetrics Introduced as an experiment in GitLab 18.7.

Detailed metrics from the last cleanup run.
nextRunAt Time Introduced as an experiment in GitLab 18.7.

Next time the virtual registry cleanup policy runs.
notifyOnFailure Boolean! Introduced as an experiment in GitLab 18.7.

Boolean to notify group owners on failed cleanup runs.
notifyOnSuccess Boolean! Introduced as an experiment in GitLab 18.7.

Boolean to notify group owners on successful cleanup runs.
status PolicyStatus! Introduced as an experiment in GitLab 18.7.

Current execution status of the cleanup policy.
updatedAt Time! Introduced as an experiment in GitLab 18.7.

Timestamp when the cleanup policy was last updated.

VulnerabilitiesByAge#

Represents vulnerability metrics by age with filtering and grouping capabilities.

Fields#

Name Type Description
byReportType [VulnerabilityReportTypeCount!] Vulnerability counts grouped by report type.
bySeverity [VulnerabilitySeverityCount!] Vulnerability counts grouped by severity level.
count Int Number of vulnerabilities in the age band.
name String! Age band name ("< 7 days", "7 - 14 days", "15 - 30 days", "31 - 60 days", "61 - 90 days", "91 - 180 days", "> 180 days" ).

VulnerabilitiesByIdentifier#

Represents vulnerability metrics by identifier with filtering.

Fields#

Name Type Description
bySeverity [VulnerabilitySeverityCount!] Vulnerability counts grouped by severity level.
count Int Number of vulnerabilities for the identifier.
name String! Identifier name.
url String URL to the identifier on the MITRE website.

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.

VulnerabilitiesCountByDayConnection#

Paginated collection of VulnerabilitiesCountByDay. See Standard connection fields for the fields available on every connection.

VulnerabilitiesOverTime#

Represents vulnerability metrics over time with filtering and grouping capabilities.

Fields#

Name Type Description
byReportType [VulnerabilityReportTypeCount!] Vulnerability counts grouped by report type.
bySeverity [VulnerabilitySeverityCount!] Vulnerability counts grouped by severity level.
count Int! Total number of vulnerabilities for the date.
date ISO8601Date! Date for the metrics.

VulnerabilitiesOverTimeConnection#

Paginated collection of VulnerabilitiesOverTime. See Standard connection fields for the fields available on every connection.

VulnerabilitiesPerSeverity#

Represents vulnerability counts grouped by severity level.

Fields#

Name Type Description
critical VulnerabilitySeverityCount Number of CRITICAL severity vulnerabilities.
high VulnerabilitySeverityCount Number of HIGH severity vulnerabilities.
info VulnerabilitySeverityCount Number of INFO severity vulnerabilities.
low VulnerabilitySeverityCount Number of LOW severity vulnerabilities.
medium VulnerabilitySeverityCount Number of MEDIUM severity vulnerabilities.
unknown VulnerabilitySeverityCount Number of UNKNOWN severity vulnerabilities.

Vulnerability#

Represents a vulnerability.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
aiResolutionAvailable Boolean Indicates whether the type of vulnerability can be resolved with AI.
aiResolutionEnabled Boolean Indicates whether the specific vulnerability can be resolved with AI.
aiWorkflows VulnerabilityTriggeredWorkflowConnection Introduced as an experiment in GitLab 18.6.

AI workflows triggered for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
archivalInformation VulnerabilityArchivalInformation! Introduced as an experiment in GitLab 17.11.

Indicates whether the vulnerability is about to be archived in the next month.
ascpComponent AscpComponent Introduced as an experiment in GitLab 19.4.

The ASCP component the vulnerability belongs to. Returns null when there is no matchor when the ascp_component_vulnerability_association feature flag is disabled.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
confirmedAt Time Timestamp of when the vulnerability state was changed to confirmed.
confirmedBy UserCore User that confirmed the vulnerability.
cveEnrichment CveEnrichmentType Enrichment (EPSS score and KEV) for CVE vulnerabilities.
cvss [CvssType!]! CVSS information for the vulnerability.
dependencies DependencyConnection! Introduced as an experiment in GitLab 18.2.

Dependencies for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for dependencies:
componentIds ([SbomComponentID!])
Filter dependencies by component IDs.
componentNames ([String!])
Filter dependencies by component names.
componentVersions ([String!])
Filter dependencies by component versions.
licenses ([String!])
Introduced as an experiment in GitLab 19.2.

Filter dependencies by SPDX license identifiers.
malware (Boolean)
Filter dependencies by malware status. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
notComponentVersions ([String!])
Introduced as an experiment in GitLab 18.1.

Filter dependencies to exclude the specified component versions.
packageManagers ([PackageManager!])
Filter dependencies by package managers.
policyViolations ([PolicyViolations!])
Introduced as an experiment in GitLab 18.7.

Filter by security policy violations. Cannot be combined with the malware argument.
sort (DependencySort)
Sort dependencies by given criteria.
sourceTypes ([SbomSourceType!])
Filter dependencies by source type.
trackedRefIds ([SecurityProjectTrackedContextID!])
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref IDs. Only available when the vulnerabilities_across_contexts feature flag is enabled.
trackedRefsScope (SecurityTrackedRefScope)
Introduced as an experiment in GitLab 19.0.

Filter dependencies by tracked ref scope. Only available when the vulnerabilities_across_contexts feature flag is enabled.
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 the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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.
dueDate ISO8601Date Vulnerability finding due date.
duoSastVrWorkflowEnabled Boolean Introduced as an experiment in GitLab 19.1.

Indicates whether the SAST vulnerability review workflow is enabled for the project.
externalIssueLinks VulnerabilityExternalIssueLinkConnection! List of external issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
falsePositive Boolean Indicates whether the vulnerability is a false positive.
findingTokenStatus VulnerabilityFindingTokenStatus Status of the secret token associated with this vulnerability.
flags VulnerabilityFlagConnection Introduced as an experiment in GitLab 18.5.

Flags set on the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
hasRemediations Boolean Indicates whether there is a remediation available for the vulnerability.
id ID! GraphQL ID of the vulnerability.
identifiers [VulnerabilityIdentifier!]! Identifiers of the vulnerability.
initialDetectedPipeline Pipeline Introduced as an experiment in GitLab 18.2.

Pipeline where the vulnerability was first detected.
issueLinks VulnerabilityIssueLinkConnection! List of issue links related to the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for issueLinks:
linkType (VulnerabilityIssueLinkType)
Filter issue links by link type.
latestDetectedPipeline Pipeline Introduced as an experiment in GitLab 18.2.

Pipeline where the vulnerability was last detected.
latestFlag VulnerabilityFlag Introduced as an experiment in GitLab 18.5.

Latest flag for the vulnerability.
latestNonClosedMergeRequest MergeRequest Introduced as an experiment in GitLab 19.1.

Latest non-closed merge request linked to fix the vulnerability.
latestSecurityReportFinding PipelineSecurityReportFinding Introduced as an experiment in GitLab 18.4.

Latest security report finding for the vulnerability. On large projects, the field can time out and return null. Clients should check the top-level errors array for timeout errors, even when the HTTP response status is 200.
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.
malware Boolean Indicates whether the vulnerability is associated with a malware package. Returns true if a malware package is identified. Returns false if the package is not a malware package.
mergeRequest MergeRequest Merge request that fixes the vulnerability.
mergeRequests MergeRequestConnection Merge requests that are linked to fix the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
policyAutoDismissed Boolean Introduced as an experiment in GitLab 18.7.

Indicates whether the vulnerability was auto-dismissed by a security policy.
policyViolations PolicyViolations Introduced as an experiment in GitLab 18.6.

Policy violation for the vulnerability.
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.
reachability ReachabilityType Introduced as an experiment in GitLab 17.11.

Reachability status of the vulnerability.
removedFromCode Boolean! Indicates whether the vulnerability is present in the code or not.
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, CONTAINER_SCANNING_FOR_REGISTRY, SARIF, GENERIC). Scan Type in the UI.
representationInformation VulnerabilityRepresentationInformation Introduced as an experiment in GitLab 17.7.

Information about the representation of the vulnerability, such as resolved commit SHA.
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).
severityOverrides SeverityOverrideConnection List of severity changes for the vulnerability. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
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. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
title String Title of the vulnerability.
trackedRef SecurityTrackedRef Introduced as an experiment in GitLab 18.10.

Tracked ref (branch or tag) where the vulnerability was detected.
unverified Boolean! Indicates whether the finding was detected without an identified source (untrusted input).
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.
validityDisplayState VulnerabilityValidityDisplayState Introduced as an experiment in GitLab 19.5.

Validity state derived from the token status and current vendor support.
vulnerabilityPath String Path to the vulnerability's details page.
webUrl String URL to the vulnerability's details page.

VulnerabilityArchivalInformation#

Represents vulnerability archival information.

Fields#

Name Type Description
aboutToBeArchived Boolean! Indicates whether the vulnerability is about to be archived in the next month.
expectedToBeArchivedOn Date Date when the vulnerability is expected to be archived.

VulnerabilityArchive#

Represents a vulnerability archive.

Fields#

Name Type Description
archivedRecordsCount Int! Number of records the archive contains.
month Int! Month of the archive, represented as a number from 1 (January) to 12 (December).
year Int! Year of the archive.

VulnerabilityArchiveExportUploadRegistry#

Represents the Geo replication and verification state of a vulnerability_archive_export_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the VulnerabilityArchiveExportUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the VulnerabilityArchiveExportUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this VulnerabilityArchiveExportUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the VulnerabilityArchiveExportUploadRegistry.
lastSyncFailure String Error message during sync of the VulnerabilityArchiveExportUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the VulnerabilityArchiveExportUploadRegistry.
missingOnPrimary Boolean Indicate if the VulnerabilityArchiveExportUploadRegistry is missing on primary.
modelRecordId Int ID of the VulnerabilityArchiveExportUploadRegistry's model record.
retryAt Time Timestamp after which the VulnerabilityArchiveExportUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the VulnerabilityArchiveExportUploadRegistry.
state RegistryState Sync state of the VulnerabilityArchiveExportUploadRegistry.
verificationChecksum String The local checksum of the VulnerabilityArchiveExportUploadRegistry.
verificationChecksumMismatched String The expected checksum of the VulnerabilityArchiveExportUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the VulnerabilityArchiveExportUploadRegistry.
verificationRetryAt Time Timestamp after which the VulnerabilityArchiveExportUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the VulnerabilityArchiveExportUploadRegistry.
verificationStartedAt Time Timestamp when the verification of VulnerabilityArchiveExportUploadRegistry started.
verificationState VerificationStateEnum Verification state of the VulnerabilityArchiveExportUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the VulnerabilityArchiveExportUploadRegistry.
vulnerabilityArchiveExportUploadId ID! ID of the Vulnerability Archive Export Upload.

VulnerabilityArchiveExportUploadRegistryConnection#

Paginated collection of VulnerabilityArchiveExportUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

VulnerabilityAverageScoreFactor#

Risk factor based on average vulnerability score.

Fields#

Name Type Description
factor Float! Introduced as an experiment in GitLab 18.4.

Factor value contributing to the risk score.

VulnerabilityConnection#

Paginated collection of Vulnerability. See Standard connection fields for the fields available on every connection.

VulnerabilityContainerImage#

Represents a container image reported on the related vulnerability.

Fields#

Name Type Description
name String Name of the container image.

VulnerabilityContainerImageConnection#

Paginated collection of VulnerabilityContainerImage. See Standard connection fields for the fields available on every connection.

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.

VulnerabilityDetailCodeFlowNode#

Represents the vulnerability details code flow node item.

Fields#

Name Type Description
description String Description of the field.
fieldName String Name of the field.
fileLocation VulnerabilityDetailFileLocation! Location of the file.
name String Name of the field.
nodeType CodeFlowNodeType! Node Type.

VulnerabilityDetailCodeFlows#

Represents the vulnerability details code flows item.

Fields#

Name Type Description
description String Description of the field.
fieldName String Name of the field.
items [[VulnerabilityDetailCodeFlowNode!]!]! List of flows represented by list of CodeFlowNodeItem.
name String Name of the field.

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 as an experiment in GitLab 16.1.

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 as an experiment in GitLab 16.1.

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.

VulnerabilityEnrichmentConfiguration#

Configuration for the vulnerability enrichment trigger of a triage and remediation scan profile.

Fields#

Name Type Description
runMode SecurityScanProfileRunMode Introduced as an experiment in GitLab 19.4.

Whether enrichment runs automatically or on demand.
severityLevel VulnerabilitySeverity Introduced as an experiment in GitLab 19.4.

Minimum vulnerability severity that triggers enrichment.

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.

VulnerabilityExportPartUploadRegistry#

Represents the Geo replication and verification state of a Vulnerability Export Part Upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the VulnerabilityExportPartUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the VulnerabilityExportPartUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this VulnerabilityExportPartUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the VulnerabilityExportPartUploadRegistry.
lastSyncFailure String Error message during sync of the VulnerabilityExportPartUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the VulnerabilityExportPartUploadRegistry.
missingOnPrimary Boolean Indicate if the VulnerabilityExportPartUploadRegistry is missing on primary.
modelRecordId Int ID of the VulnerabilityExportPartUploadRegistry's model record.
retryAt Time Timestamp after which the VulnerabilityExportPartUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the VulnerabilityExportPartUploadRegistry.
state RegistryState Sync state of the VulnerabilityExportPartUploadRegistry.
verificationChecksum String The local checksum of the VulnerabilityExportPartUploadRegistry.
verificationChecksumMismatched String The expected checksum of the VulnerabilityExportPartUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the VulnerabilityExportPartUploadRegistry.
verificationRetryAt Time Timestamp after which the VulnerabilityExportPartUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the VulnerabilityExportPartUploadRegistry.
verificationStartedAt Time Timestamp when the verification of VulnerabilityExportPartUploadRegistry started.
verificationState VerificationStateEnum Verification state of the VulnerabilityExportPartUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the VulnerabilityExportPartUploadRegistry.
vulnerabilityExportPartUploadId ID! ID of the Vulnerability Export Part Upload.

VulnerabilityExportPartUploadRegistryConnection#

Paginated collection of VulnerabilityExportPartUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

VulnerabilityExportUploadRegistry#

Represents the Geo replication and verification state of a Vulnerability Export Upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the VulnerabilityExportUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the VulnerabilityExportUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this VulnerabilityExportUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the VulnerabilityExportUploadRegistry.
lastSyncFailure String Error message during sync of the VulnerabilityExportUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the VulnerabilityExportUploadRegistry.
missingOnPrimary Boolean Indicate if the VulnerabilityExportUploadRegistry is missing on primary.
modelRecordId Int ID of the VulnerabilityExportUploadRegistry's model record.
retryAt Time Timestamp after which the VulnerabilityExportUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the VulnerabilityExportUploadRegistry.
state RegistryState Sync state of the VulnerabilityExportUploadRegistry.
verificationChecksum String The local checksum of the VulnerabilityExportUploadRegistry.
verificationChecksumMismatched String The expected checksum of the VulnerabilityExportUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the VulnerabilityExportUploadRegistry.
verificationRetryAt Time Timestamp after which the VulnerabilityExportUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the VulnerabilityExportUploadRegistry.
verificationStartedAt Time Timestamp when the verification of VulnerabilityExportUploadRegistry started.
verificationState VerificationStateEnum Verification state of the VulnerabilityExportUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the VulnerabilityExportUploadRegistry.
vulnerabilityExportUploadId ID! ID of the Vulnerability Export Upload.

VulnerabilityExportUploadRegistryConnection#

Paginated collection of VulnerabilityExportUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

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.

VulnerabilityExternalIssueLinkConnection#

Paginated collection of VulnerabilityExternalIssueLink. See Standard connection fields for the fields available on every connection.

VulnerabilityFindingTokenStatus#

Represents the status of a secret token found in a vulnerability.

Fields#

Name Type Description
createdAt Time! When the token status was created.
id ID! ID of the finding token status.
lastVerifiedAt Time When the token was last verified with the issuing service.
status VulnerabilityFindingTokenStatusState! Status of the token (unknown, active, inactive).
updatedAt Time! When the token status was last updated.

VulnerabilityFlag#

Represents a flag result for a vulnerability.

Fields#

Name Type Description
confidenceScore Float Introduced as an experiment in GitLab 18.5.

Confidence score of the detection (0.0 to 1.0).
createdAt Time! Timestamp when the detection was created.
description String Reasoning for the raising of the flag on the vulnerability.
id ID! ID of the false positive detection.
origin String Origin of service that raising the flag on the vulnerability.
status VulnerabilityFalsePositiveDetectionStatus Introduced as an experiment in GitLab 18.5.

Status of the false positive detection.
updatedAt Time! Timestamp when the detection was last updated.

VulnerabilityFlagConnection#

Paginated collection of VulnerabilityFlag. See Standard connection fields for the fields available on every connection.

VulnerabilityFunnelStep#

A step in the vulnerability resolution funnel.

Fields#

Name Type Description
canEnable Boolean Whether the current user can enable the setting that would make this step available. Null when there is no single setting the user can act on, such as an aggregated group view.
count Int Count for the step. Null when status is not AVAILABLE.
status VulnerabilityFunnelStepStatus! Whether the step's data can be shown, and if not, why.

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.

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.

VulnerabilityIssueLinkConnection#

Paginated collection of VulnerabilityIssueLink. See Standard connection fields for the fields available on every connection.

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
containerRepositoryUrl String URL of scanned image.
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.

VulnerabilityManagementPolicy#

Represents the vulnerability management policy.

Implements: OrchestrationPolicy

Fields#

Name Type Description
csp Boolean! Introduced as an experiment in GitLab 18.1.

Indicates whether the policy comes from a centralized security policy group.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
id SecurityPolicyID Introduced as an experiment in GitLab 18.11.

ID of the policy. Returns null if the policy has not been synced to the database yet.
name String! Name of the policy.
policyConfigurationId SecurityOrchestrationPolicyConfigurationID Introduced as an experiment in GitLab 18.11.

ID of the policy configuration the policy belongs to.
policyScope PolicyScope Scope 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.

VulnerabilityManagementPolicyAttributesType#

Represents policy fields related to the vulnerability management policy.

Fields#

Name Type Description
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.

VulnerabilityManagementPolicyConnection#

Paginated collection of VulnerabilityManagementPolicy. See Standard connection fields for the fields available on every connection.

VulnerabilityNamespaceStatisticType#

Counts for each vulnerability severity in the group and its subgroups.

Implements: VulnerabilityStatisticInterface

Fields#

Name Type Description
critical Int! Number of vulnerabilities of CRITICAL severity.
high Int! Number of vulnerabilities of HIGH severity.
info Int! Number of vulnerabilities of INFO severity.
low Int! Number of vulnerabilities of LOW severity.
medium Int! Number of vulnerabilities of MEDIUM severity.
namespaceId Int! Namespace ID.
total Int! Total of all vulnerabilities.
unknown Int! Number of vulnerabilities of UNKNOWN severity.
updatedAt Time Date that data was last updated.

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.

VulnerabilityRemediationUploadRegistry#

Represents the Geo replication and verification state of a vulnerability_remediation_upload.

Fields#

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the VulnerabilityRemediationUploadRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the VulnerabilityRemediationUploadRegistry was created.
dataManagementDetailsPath String Path to the data management view for this VulnerabilityRemediationUploadRegistry.
forceToRedownload Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the VulnerabilityRemediationUploadRegistry.
lastSyncFailure String Error message during sync of the VulnerabilityRemediationUploadRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the VulnerabilityRemediationUploadRegistry.
missingOnPrimary Boolean Indicate if the VulnerabilityRemediationUploadRegistry is missing on primary.
modelRecordId Int ID of the VulnerabilityRemediationUploadRegistry's model record.
retryAt Time Timestamp after which the VulnerabilityRemediationUploadRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the VulnerabilityRemediationUploadRegistry.
state RegistryState Sync state of the VulnerabilityRemediationUploadRegistry.
verificationChecksum String The local checksum of the VulnerabilityRemediationUploadRegistry.
verificationChecksumMismatched String The expected checksum of the VulnerabilityRemediationUploadRegistry in case of mismatch.
verificationFailure String Error message during verification of the VulnerabilityRemediationUploadRegistry.
verificationRetryAt Time Timestamp after which the VulnerabilityRemediationUploadRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the VulnerabilityRemediationUploadRegistry.
verificationStartedAt Time Timestamp when the verification of VulnerabilityRemediationUploadRegistry started.
verificationState VerificationStateEnum Verification state of the VulnerabilityRemediationUploadRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the VulnerabilityRemediationUploadRegistry.
vulnerabilityRemediationUploadId ID! ID of the Vulnerability Remediation Upload.

VulnerabilityRemediationUploadRegistryConnection#

Paginated collection of VulnerabilityRemediationUploadRegistry. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Returns the number of items in the connection up to a limit. If the number is greater than the limit, returns limit + 1.

Arguments for count:
limit (Int)
Limit value to be applied to the count query. Default is 1000.

VulnerabilityReportTypeCount#

Represents a count of vulnerabilities for a specific report type.

Fields#

Name Type Description
count Int! Number of vulnerabilities.
reportType VulnerabilityReportType! Report type.

VulnerabilityRepresentationInformation#

Represents vulnerability information.

Fields#

Name Type Description
resolvedInCommitSha String SHA of the commit where the vulnerability was resolved.

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.

VulnerabilityResolutionFunnel#

Adoption funnel for AI-assisted vulnerability resolution (Critical and High SAST vulnerabilities).

Fields#

Name Type Description
createdMergeRequests VulnerabilityFunnelStep! Subset for which a merge request was created by Duo Agent Platform.
detectedVulnerabilities VulnerabilityFunnelStep! Critical and High SAST vulnerabilities detected in the window.
mergedMergeRequests VulnerabilityFunnelStep! Subset whose resolution merge request has been merged.
truePositives VulnerabilityFunnelStep! Subset confirmed as true positives via AI False Positive Detection.

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.

VulnerabilityScannerConnection#

Paginated collection of VulnerabilityScanner. See Standard connection fields for the fields available on every connection.

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.

VulnerabilitySeverityCount#

Represents a count of vulnerabilities for a specific severity level.

Fields#

Name Type Description
count Int! Number of vulnerabilities.
meanAge Float Average age in days of vulnerabilities since detection.
medianAge Float Median age in days of vulnerabilities since detection.
severity VulnerabilitySeverity! Severity level.

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.
id VulnerabilitiesStateTransitionID! ID of the state transition.
toState VulnerabilityState! State of the vulnerability after transition.

VulnerabilityStateTransitionTypeConnection#

Paginated collection of VulnerabilityStateTransitionType. See Standard connection fields for the fields available on every connection.

VulnerabilityStatisticType#

Counts for each vulnerability severity in the project.

Implements: VulnerabilityStatisticInterface

Fields#

Name Type Description
critical Int! Number of vulnerabilities of CRITICAL severity.
high Int! Number of vulnerabilities of HIGH severity.
info Int! Number of vulnerabilities of INFO severity.
low Int! Number of vulnerabilities of LOW severity.
medium Int! Number of vulnerabilities of MEDIUM severity.
projectId Int! Project ID.
total Int! Total of all vulnerabilities.
unknown Int! Number of vulnerabilities of UNKNOWN severity.
updatedAt Time Date that data was last updated.

VulnerabilityTriggeredWorkflow#

Represents a triggered workflow for a vulnerability.

Fields#

Name Type Description
workflow DuoWorkflow Associated workflow details.
workflowName VulnerabilityWorkflowName! Name of the workflow.

VulnerabilityTriggeredWorkflowConnection#

Paginated collection of VulnerabilityTriggeredWorkflow. See Standard connection fields for the fields available on every connection.

VulnerabilityWorkflowExecution#

Represents a bulk Duo workflow execution.

Fields#

Name Type Description
batchSize Int! Maximum number of vulnerabilities processed per batch.
cancelRequested Boolean! Whether cancellation has been requested.
createdAt Time! Time the execution was created.
currentStage VulnerabilityWorkflowStage Current workflow stage.
endedAt Time Time the execution completed.
executionId ID! Execution identifier.
itemStates [VulnerabilityWorkflowItem!]! Current workflow state for vulnerabilities in the execution.
progress VulnerabilityWorkflowProgress! Current execution progress.
stages [VulnerabilityWorkflowStage!]! Workflow stages in execution order.
startedAt Time Time the execution started.
status VulnerabilityWorkflowStatus! Current execution status.
workflow VulnerabilityDuoWorkflow! Duo workflow being executed.

VulnerabilityWorkflowItem#

Workflow state of a vulnerability.

Fields#

Name Type Description
state VulnerabilityWorkflowItemState! Current workflow state.
vulnerability Vulnerability Vulnerability.

VulnerabilityWorkflowProgress#

Progress information for a bulk Duo workflow execution.

Fields#

Name Type Description
cancelled Int! Number of cancelled vulnerabilities.
completed Int! Number of completed vulnerabilities.
failed Int! Number of failed vulnerabilities.
pending Int! Number of pending vulnerabilities.
percentage Float! Execution completion percentage.
processing Int! Number of vulnerabilities currently being processed.
total Int! Total number of vulnerabilities.

VulnerabilityWorkflowStage#

A stage within a bulk Duo workflow.

Fields#

Name Type Description
name String! Stage name.
order Int! Execution order.

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 that performed the scan.
clusterId ClustersClusterID ID of the cluster integration 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 where the resource resides.

VulnerablePackage#

Represents a vulnerable package. Used in vulnerability dependency data.

Fields#

Name Type Description
name String Name of the vulnerable package.
path String Path of the vulnerable package.

VulnerableProjectsByGrade#

Represents vulnerability letter grades with associated projects.

Fields#

Name Type Description
count Int! Number of projects within the grade.
grade VulnerabilityGrade! Grade based on the highest severity vulnerability present.
projects ProjectConnection! Projects within the grade. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

WebhookCustomHeader#

Fields#

Name Type Description
key String! Custom header name.

WebhookEvent#

Fields#

Name Type Description
createdAt Time! Webhook request time.
executionDuration Float Webhook execution duration in seconds.
id WebHookLogID! Global ID of the webhook event.
internalErrorMessage String Internal error message that occurred while executing the webhook.
oversize Boolean! Whether request data was too large to be executed.
requestData String Data sent in the webhook request.
requestHeaders [WebhookEventHeaderType!] HTTP Headers used in the webhook request.
responseBody String Body of the webhook response.
responseHeaders [WebhookEventHeaderType!] HTTP Headers from the webhook response.
responseStatus String HTTP status of the webhook response.
trigger String Trigger that caused webhook execution.
url String URL used in webhook request.

WebhookEventConnection#

Paginated collection of WebhookEvent. See Standard connection fields for the fields available on every connection.

WebhookEventHeaderType#

Fields#

Name Type Description
name String! HTTP response header name.
value String! HTTP response header value.

WebhookUrlVariable#

Fields#

Name Type Description
key String! URL variable mask that will appear in a masked webhook url in place of its sensitive portion.

WikiPage#

A wiki page.

Implements: NoteableInterface, Todoable

Fields#

Name Type Description
awardEmoji AwardEmojiConnection List of emoji reactions associated with the wiki page. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
commenters UserCoreConnection! All commenters on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
content String Content of the wiki page.
discussions DiscussionConnection! All discussions on the noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
id WikiPageMetaID! Global ID of the wiki page metadata record.
name String Name or title of the object.
notes NoteConnection! All notes on this noteable. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
slug String URL slug of the wiki page.
subscribed Boolean! Whether the current user is subscribed to notifications on the wiki page.
title String! Wiki page title.
userPermissions WikiPagePermissions! Permissions for the current user on the resource.
webUrl String URL of the object.

WikiPageConnection#

Paginated collection of WikiPage. See Standard connection fields for the fields available on every connection.

WikiPagePermissions#

Fields#

Name Type Description
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.
markNoteAsInternal Boolean! If true, the user can perform mark_note_as_internal on this resource.
readWikiPage Boolean! If true, the user can perform read_wiki_page on this resource.

WorkItem#

Implements: Todoable

Fields#

Name Type Description
archived Boolean! Introduced as an experiment in GitLab 16.5.

Whether the work item belongs to an archived project or group.
author UserCore Introduced as an experiment in GitLab 15.9.

User that created the work item.
availableQuickActions [QuickActionCommand!] Quick actions available to the current user on the work item.
closedAt Time Timestamp of when the work item was closed.
commentTemplatesPaths [CommentTemplatePathType!]! Paths of the comment templates.
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.
duoWorkflowLinks DuoWorkflowWorkItemLinkConnection GitLab Duo Agent Platform sessions linked to the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for duoWorkflowLinks:
linkType (DuoWorkflowWorkItemLinkType)
Filter links by their link type.
duplicatedToWorkItemUrl String URL of the work item that the work item is marked as a duplicate of.
externalAuthor String Introduced as an experiment in GitLab 18.8.

Email address of non-GitLab user reporting the issue. For guests, the email address is obfuscated.
features WorkItemFeatures! Introduced as an experiment in GitLab 18.9.

Features of the work item.
hidden Boolean Indicates the work item is hidden because the author has been banned.
id WorkItemID! Global ID of the work item.
iid String! Internal ID of the work item.
imported Boolean! Indicates whether the work item was imported.
lockVersion Int! Lock version of the work item. Incremented each time the work item is updated.
movedToWorkItemUrl String URL of the work item that the work item was moved to.
name String Name or title of the object.
namespace Namespace Introduced as an experiment in GitLab 15.10.

Namespace the work item belongs to.
project Project Introduced as an experiment in GitLab 15.3.

Project the work item belongs to.
promotedToEpicUrl String URL of the epic that the work item has been promoted to.
reference String! Internal reference of the work item. Returned in shortened format by default.

Arguments for reference:
full (Boolean)
Boolean option specifying whether the reference should be returned in full.
showPlanUpgradePromotion Boolean! Introduced as an experiment in GitLab 17.11.

Whether to show the promotional message for the work item.
state WorkItemState! State of the work item.
title String! Title of the work item.
titleHtml String HTML rendering of title.
updatedAt Time! Timestamp of when the work item was last updated.
userDiscussionsCount Int! Number of user discussions in the work item.
userPermissions WorkItemPermissions! Permissions for the current user on the resource.
webPath String Web path of the object.
webUrl String URL of the object.
widgets [WorkItemWidget!] Collection of widgets that belong to the work item.

Arguments for widgets:
exceptTypes ([WorkItemWidgetType!])
Except widgets of the given types.
onlyTypes ([WorkItemWidgetType!])
Only widgets of the given types.
workItemType WorkItemType! Type assigned to the work item.

WorkItemAgentPlanQuestion#

Represents a question a workplan flow asked on a work item.

Fields#

Name Type Description
answered Boolean! Introduced as an experiment in GitLab 19.5.

Indicates the thread the question was asked in is resolved.
discussionId DiscussionID! Introduced as an experiment in GitLab 19.5.

Global ID of the thread the question was asked in.
noteId NoteID! Introduced as an experiment in GitLab 19.5.

Global ID of the comment that asked the question.

WorkItemAgentPlanQuestionConnection#

Paginated collection of WorkItemAgentPlanQuestion. See Standard connection fields for the fields available on every connection.

WorkItemClosingMergeRequest#

Fields#

Name Type Description
fromMrDescription Boolean! Whether this merge request link was created by referencing the work item on the merge request description, using the closing pattern.
id MergeRequestIssueID! Global ID of the closing merge request association.
mergeRequest MergeRequest Related merge request.

WorkItemClosingMergeRequestConnection#

Paginated collection of WorkItemClosingMergeRequest. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int Number of merge requests that close the work item on merge.

WorkItemConnection#

Paginated collection of WorkItem. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.

WorkItemDateFieldValue#

Implements: WorkItemCustomFieldValue

Fields#

Name Type Description
customField CustomField! Custom field associated with the custom field value.
value Date Date value of the custom field.

WorkItemDecision#

Represents a decision recorded in the decision log of a work item.

Fields#

Name Type Description
archivedAt Time Introduced as an experiment in GitLab 19.5.

Timestamp when the decision was archived.
author UserCore Introduced as an experiment in GitLab 19.4.

User who raised the decision.
description String Introduced as an experiment in GitLab 19.4.

Context of the decision.
discussionId DiscussionID Introduced as an experiment in GitLab 19.4.

Global ID of the originating discussion thread.
id WorkItemsDecisionID! Introduced as an experiment in GitLab 19.4.

Global ID of the decision.
noteUrl String Introduced as an experiment in GitLab 19.4.

URL of the comment that resolved the decision.
options WorkItemDecisionOptionConnection Introduced as an experiment in GitLab 19.4.

Candidate options of the decision. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
resolutionRationale String Introduced as an experiment in GitLab 19.4.

Reasoning given when the decision was resolved.
resolvedAt Time Introduced as an experiment in GitLab 19.4.

Timestamp when the decision was resolved.
resolvedBy UserCore Introduced as an experiment in GitLab 19.4.

User who resolved the decision.
resolvingNoteId NoteID Introduced as an experiment in GitLab 19.4.

Global ID of the comment that resolved the decision.
sourceLink String Introduced as an experiment in GitLab 19.4.

URL of the comment, discussion, or external resource that prompted the decision. Present only on manually created decisions.
state WorkItemDecisionState! Introduced as an experiment in GitLab 19.5.

State of the decision.
title String Introduced as an experiment in GitLab 19.4.

Question being decided. May be absent for decisions recorded as already resolved at creation.

WorkItemDecisionConnection#

Paginated collection of WorkItemDecision. See Standard connection fields for the fields available on every connection.

WorkItemDecisionOption#

Represents a candidate option of a work item decision.

Fields#

Name Type Description
content String! Introduced as an experiment in GitLab 19.4.

Content of the decision option.
description String Introduced as an experiment in GitLab 19.4.

Reasoning behind the decision option.
id WorkItemsDecisionOptionID! Introduced as an experiment in GitLab 19.4.

Global ID of the decision option.
recommended Boolean! Introduced as an experiment in GitLab 19.4.

Indicates the option is recommended by GitLab Duo.
selected Boolean! Introduced as an experiment in GitLab 19.4.

Indicates the option was selected when the decision was resolved.

WorkItemDecisionOptionConnection#

Paginated collection of WorkItemDecisionOption. See Standard connection fields for the fields available on every connection.

WorkItemDescriptionTemplate#

Fields#

Name Type Description
category String Category of description template.
content String Content of Description Template.
name String Name of Description Template.
projectId Int ID of the description template project.

WorkItemDescriptionTemplateConnection#

Paginated collection of WorkItemDescriptionTemplate. See Standard connection fields for the fields available on every connection.

WorkItemFeatures#

Fields#

Name Type Description
agentPlan WorkItemWidgetAgentPlan Agent plan widget of the work item. Returns null if the widget is not available for the work item.
aiSession WorkItemWidgetAiSession Ai session widget of the work item. Returns null if the widget is not available for the work item.
assignees WorkItemWidgetAssignees Assignees widget of the work item. Returns null if the widget is not available for the work item.
awardEmoji WorkItemWidgetAwardEmoji Award emoji widget of the work item. Returns null if the widget is not available for the work item.
color WorkItemWidgetColor Color widget of the work item. Returns null if the widget is not available for the work item.
crmContacts WorkItemWidgetCrmContacts Crm contacts widget of the work item. Returns null if the widget is not available for the work item.
currentUserTodos WorkItemWidgetCurrentUserTodos Current user todos widget of the work item. Returns null if the widget is not available for the work item.
customFields WorkItemWidgetCustomFields Custom fields widget of the work item. Returns null if the widget is not available for the work item.
decisionLog WorkItemWidgetDecisionLog Decision log widget of the work item. Returns null if the widget is not available for the work item.
description WorkItemWidgetDescription Description widget of the work item. Returns null if the widget is not available for the work item.
designs WorkItemWidgetDesigns Designs widget of the work item. Returns null if the widget is not available for the work item.
development WorkItemWidgetDevelopment Development widget of the work item. Returns null if the widget is not available for the work item.
emailParticipants WorkItemWidgetEmailParticipants Email participants widget of the work item. Returns null if the widget is not available for the work item.
errorTracking WorkItemWidgetErrorTracking Error tracking widget of the work item. Returns null if the widget is not available for the work item.
escalationPolicy WorkItemWidgetEscalationPolicy Escalation policy widget of the work item. Returns null if the widget is not available for the work item.
escalationStatus WorkItemWidgetEscalationStatus Escalation status widget of the work item. Returns null if the widget is not available for the work item.
healthStatus WorkItemWidgetHealthStatus Health status widget of the work item. Returns null if the widget is not available for the work item.
hierarchy WorkItemWidgetHierarchy Hierarchy widget of the work item. Returns null if the widget is not available for the work item.
iteration WorkItemWidgetIteration Iteration widget of the work item. Returns null if the widget is not available for the work item.
labels WorkItemWidgetLabels Labels widget of the work item. Returns null if the widget is not available for the work item.
linkedItems WorkItemWidgetLinkedItems Linked items widget of the work item. Returns null if the widget is not available for the work item.
linkedResources WorkItemWidgetLinkedResources Linked resources widget of the work item. Returns null if the widget is not available for the work item.
milestone WorkItemWidgetMilestone Milestone widget of the work item. Returns null if the widget is not available for the work item.
notes WorkItemWidgetNotes Notes widget of the work item. Returns null if the widget is not available for the work item.
notifications WorkItemWidgetNotifications Notifications widget of the work item. Returns null if the widget is not available for the work item.
participants WorkItemWidgetParticipants Participants widget of the work item. Returns null if the widget is not available for the work item.
progress WorkItemWidgetProgress Progress widget of the work item. Returns null if the widget is not available for the work item.
requirementLegacy WorkItemWidgetRequirementLegacy Requirement legacy widget of the work item. Returns null if the widget is not available for the work item.
severity WorkItemWidgetSeverity Severity widget of the work item. Returns null if the widget is not available for the work item.
startAndDueDate WorkItemWidgetStartAndDueDate Start and due date widget of the work item. Returns null if the widget is not available for the work item.
status WorkItemWidgetStatus Status widget of the work item. Returns null if the widget is not available for the work item.
testReports WorkItemWidgetTestReports Test reports widget of the work item. Returns null if the widget is not available for the work item.
timeTracking WorkItemWidgetTimeTracking Time tracking widget of the work item. Returns null if the widget is not available for the work item.
verificationStatus WorkItemWidgetVerificationStatus Verification status widget of the work item. Returns null if the widget is not available for the work item.
vulnerabilities WorkItemWidgetVulnerabilities Vulnerabilities widget of the work item. Returns null if the widget is not available for the work item.
weight WorkItemWidgetWeight Weight widget of the work item. Returns null if the widget is not available for the work item.

WorkItemLifecycle#

Represents a lifecycle for work items.

Fields#

Name Type Description
defaultClosedStatus WorkItemStatus Introduced as an experiment in GitLab 18.1.

Default closed status of the lifecycle.
defaultDuplicateStatus WorkItemStatus Introduced as an experiment in GitLab 18.1.

Default duplicate status of the lifecycle.
defaultOpenStatus WorkItemStatus Introduced as an experiment in GitLab 18.1.

Default open status of the lifecycle.
id GlobalID Introduced as an experiment in GitLab 18.1.

ID of the lifecycle.
name String Introduced as an experiment in GitLab 18.1.

Name of the lifecycle.
statusCounts [WorkItemStatusCount!] Introduced as an experiment in GitLab 18.4.

Work item counts by status for the lifecycle.
statuses [WorkItemStatus!] Introduced as an experiment in GitLab 18.1.

All available statuses of the lifecycle.
workItemTypes [WorkItemType!] Introduced as an experiment in GitLab 18.1.

Work item types associated to the lifecycle.

WorkItemLifecycleConnection#

Paginated collection of WorkItemLifecycle. See Standard connection fields for the fields available on every connection.

WorkItemLinkedResource#

Fields#

Name Type Description
url String! URL of resource.

WorkItemLinkedResourceConnection#

Paginated collection of WorkItemLinkedResource. See Standard connection fields for the fields available on every connection.

WorkItemMoveTarget#

Valid target work item types and a suggested target for moving work items of a given source type to a different namespace.

Fields#

Name Type Description
sourceType WorkItemType! Source work item type the suggestion is computed for.
suggestedTargetType WorkItemType Recommended target work item type in the destination namespace. Matches by global ID first (covers system-defined and converted custom types across namespaces), then falls back to matching by name. Returns null when no clear match exists; callers should let the user pick manually.
validTargetTypes [WorkItemType!]! Work item types in the destination namespace that the source type can be moved into. Includes the destination type that equals the source by global ID (if present) and the source type's conversion targets that exist in the destination namespace.

WorkItemNumberFieldValue#

Implements: WorkItemCustomFieldValue

Fields#

Name Type Description
customField CustomField! Custom field associated with the custom field value.
value Float Number value of the custom field.

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.
blockedWorkItems Boolean If true, the user can perform blocked_work_items on the work item.
cloneWorkItem Boolean! If true, the user can perform clone_work_item 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.
markNoteAsInternal Boolean! If true, the user can perform mark_note_as_internal on this resource.
moveWorkItem Boolean! If true, the user can perform move_work_item on this resource.
readWorkItem Boolean! If true, the user can perform read_work_item on this resource.
reportSpam Boolean! If true, the user can perform report_spam on this resource.
setWorkItemMetadata Boolean! If true, the user can perform set_work_item_metadata on this resource.
summarizeComments Boolean! If true, the user can perform summarize_comments on this resource.
updateWorkItem Boolean! If true, the user can perform update_work_item on this resource.

WorkItemRelatedBranch#

Fields#

Name Type Description
comparePath String Path to comparison of branch to default branch.
name String! Name of the branch.
pipelineStatus DetailedStatus Status of pipeline for the branch.

WorkItemRelatedBranchConnection#

Paginated collection of WorkItemRelatedBranch. See Standard connection fields for the fields available on every connection.

WorkItemSavedViewFilterWarningType#

Fields#

Name Type Description
field String! Name of the field associated with the warning.
message String! Message associated with the warning.

WorkItemSavedViewType#

Fields#

Name Type Description
author UserCore Author of the saved view.
description String Description of the saved view.
displaySettings JSON Display settings associated with the saved view.
filterWarnings [WorkItemSavedViewFilterWarningType!] Warnings associated with the filter values. This field can only be resolved for one saved view in any single request.
filters JSON Filters associated with the saved view. This field can only be resolved for one saved view in any single request.
id WorkItemsSavedViewsSavedViewID! ID of the saved view.
isPrivate Boolean! Whether the saved view is private.
lastUpdatedBy UserCore Introduced as an experiment in GitLab 18.10.

User who last updated the saved view.
name String! Name of the saved view.
namespaceId TypesNamespaceID! ID of the namespace of the saved view.
private Boolean! Deprecated in GitLab 18.10. Replaced by isPrivate field.
shareUrl String! URL to auto subscribe users to the view.
sort WorkItemSort Sort option associated with the saved view.
subscribed Boolean! Whether the current user is subscribed to the saved view.
updatedAt Time! Timestamp of when the saved view was last updated.
userPermissions SavedViewPermissions! Permissions for the current user on the resource.
workItems WorkItemConnection Introduced as an experiment in GitLab 18.8.

Work items associated with the saved view. This field can only be resolved for one saved view in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

WorkItemSavedViewTypeConnection#

Paginated collection of WorkItemSavedViewType. See Standard connection fields for the fields available on every connection.

WorkItemSelectFieldValue#

Implements: WorkItemCustomFieldValue

Fields#

Name Type Description
customField CustomField! Custom field associated with the custom field value.
selectedOptions [CustomFieldSelectOption!] Selected options of the custom field.

WorkItemSettings#

Work item settings for a namespace.

Fields#

Name Type Description
customizableTypeVisibility Boolean! Whether namespace admins can configure per-type work item visibility.

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.

WorkItemStatus#

Represents status.

Fields#

Name Type Description
category WorkItemStatusCategoryEnum Introduced as an experiment in GitLab 18.1.

Category of the status.
color String Introduced as an experiment in GitLab 17.11.

Color of the status.
description String Introduced as an experiment in GitLab 18.1.

Description of the status.
iconName String Introduced as an experiment in GitLab 17.11.

Icon name of the status.
id GlobalID Introduced as an experiment in GitLab 17.11.

ID of the status.
name String Introduced as an experiment in GitLab 17.11.

Name of the status.
position Int Introduced as an experiment in GitLab 17.11.

Position of the status within its category.

WorkItemStatusConnection#

Paginated collection of WorkItemStatus. See Standard connection fields for the fields available on every connection.

WorkItemStatusCount#

Represents a status with its work item count.

Fields#

Name Type Description
count String Introduced as an experiment in GitLab 18.4.

Work item count for the status. Shows "999+" when count exceeds 999.
status WorkItemStatus! Introduced as an experiment in GitLab 18.4.

Status of the work items.

WorkItemTextFieldValue#

Implements: WorkItemCustomFieldValue

Fields#

Name Type Description
customField CustomField! Custom field associated with the custom field value.
value String Text value of the custom field.

WorkItemTimelog#

Fields#

Name Type Description
id ID! Internal ID of the timelog.
note Note Note where the quick action was executed to add the logged time.
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.

WorkItemTimelogConnection#

Paginated collection of WorkItemTimelog. See Standard connection fields for the fields available on every connection.

Extra fields#

This connection has additional fields beyond the standard connection fields.

Name Type Description
count Int! Total count of collection. Returns limit + 1 for counts greater than the limit.

Arguments for count:
limit (Int)
Limit applied to the count query, returns limit + 1. When not provided, returns the exact count.
totalSpentTime BigInt! Total time spent in seconds.

WorkItemType#

Fields#

Name Type Description
archived Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is archived.
canPromoteToObjective Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type can be promoted to an objective.
canUserCreateItems Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is creatable by the API.
enabled Boolean! Introduced as an experiment in GitLab 18.9.

Indicates whether the work item type is enabled.
enabledByDefaultForNewNamespaces Boolean! Introduced as an experiment in GitLab 19.0.

Whether the work item type is enabled by default when new child namespaces are created.
iconName String Icon name of the work item type.
id WorkItemsTypeID! Global ID of the work item type.
isConfigurable Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is configurable.
isFilterableBoardView Boolean! Introduced as an experiment in GitLab 18.10.

Indicates whether the work item type is filterable in board view.
isFilterableListView Boolean! Introduced as an experiment in GitLab 18.10.

Indicates whether the work item type is filterable in list view.
isGroupWorkItemType Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type belongs only to a group.
isIncidentManagement Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is for incident management.
isServiceDesk Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type is for service desk.
name String! Name of the work item type.
showProjectSelector Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type should show the project selector.
supportedConversionTypes [WorkItemType!] Introduced as an experiment in GitLab 17.8.

Supported conversion types for the work item type.
supportsMoveAction Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type can be moved or not.
supportsRoadmapView Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type supports roadmap view.
unavailableWidgetsOnConversion [WorkItemWidgetDefinition!] Widgets that will be lost when converting from source work item type to target work item type.

Arguments for unavailableWidgetsOnConversion:
target (WorkItemsTypeID!)
Target work item type to convert to.
useIssueView Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type uses the issue view instead of work item view.
visibleInSettings Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the work item type should be visible in the settings page.
widgetDefinitions [WorkItemWidgetDefinition!] Introduced as an experiment in GitLab 16.7.

Available widgets for the work item type.

WorkItemTypeConnection#

Paginated collection of WorkItemType. See Standard connection fields for the fields available on every connection.

WorkItemTypeCountsByState#

Represents work item counts for the work item type.

Fields#

Name Type Description
countsByState WorkItemStateCountsType! Total number of work items for the represented states.
workItemType WorkItemType! Work item type.

WorkItemTypeDepthLimitReachedByType#

Represents Depth limit reached for the allowed work item type.

Fields#

Name Type Description
depthLimitReached Boolean! Indicates if maximum allowed depth has been reached for the descendant type.
workItemType WorkItemType! Work item type.

WorkItemTypeIconDefinition#

Represents an available icon for work item types.

Fields#

Name Type Description
label String! Human-readable screen reader label for the icon.
name String! Name of the icon.

WorkItemTypesUserPreference#

Fields#

Name Type Description
displaySettings JSON Display settings for the work item lists.
namespace Namespace! Namespace for the user preference.
sort WorkItemSort Sort order for work item lists.
workItemType WorkItemType Type assigned to the work item.

WorkItemWidgetAgentPlan#

Represents an agent plan widget.

Implements: WorkItemWidget

Fields#

Name Type Description
aiPlanningEnabled Boolean! Indicates whether AI planning is enabled for the work item.
content String Content of the agent plan. This field can only be resolved for one work item in any single request.
contentHtml String GitLab Flavored Markdown rendering of content. This field can only be resolved for one work item in any single request.
generationStatus WorkItemAgentPlanGenerationStatus Introduced as an experiment in GitLab 19.4.

Status of the asynchronous workplan generation flow for the work item. Reflects the most recent workplan/v1 Duo Agent Platform workflow, if any; creation of that workflow is currently gated by the duo_workplan_async_flow feature flag.
openQuestionsCount Int Introduced as an experiment in GitLab 19.5.

Number of questions asked by workplan flows whose thread is not resolved, across every run on the work item. Null when no workplan flow has run on the work item. Only available when the duo_workplan_async_flow feature flag is enabled. This field can only be resolved for one work item in any single request.
questions WorkItemAgentPlanQuestionConnection Introduced as an experiment in GitLab 19.5.

Questions asked by workplan flows, across every run on the work item, oldest first. Null when no workplan flow has run on the work item. Only available when the duo_workplan_async_flow feature flag is enabled. This field can only be resolved for one work item in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
readinessScore Int Introduced as an experiment in GitLab 19.3.

Readiness score of the agent plan (0-100). Null when the score is not yet available. Only available when the workplan_score feature flag is enabled.
readinessScoreFeedback String Introduced as an experiment in GitLab 19.4.

Markdown feedback explaining the readiness score. Null when no feedback is available. Only available when the workplan_score feature flag is enabled. This field can only be resolved for one work item in any single request.
readinessScoreFeedbackHtml String Introduced as an experiment in GitLab 19.4.

GitLab Flavored Markdown rendering of readiness_score_feedback. Only available when the workplan_score feature flag is enabled. This field can only be resolved for one work item in any single request.
type WorkItemWidgetType Widget type.

WorkItemWidgetAiSession#

Represents an AI session widget.

Implements: WorkItemWidget

Fields#

Name Type Description
duoWorkflows DuoWorkflowConnection Duo Workflow sessions associated with the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetAssignees#

Represents an assignees widget.

Implements: WorkItemWidget

Fields#

Name Type Description
allowsMultipleAssignees Boolean Deprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use workitemWidgetDefinitionAssignees.allowsMultipleAssignees instead.
assignees UserCoreConnection Assignees of the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
canInviteMembers Boolean! Deprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use workitemWidgetDefinitionAssignees.canInviteMembers instead.
type WorkItemWidgetType Widget type.

WorkItemWidgetAwardEmoji#

Represents the emoji reactions widget.

Implements: WorkItemWidget

Fields#

Name Type Description
awardEmoji AwardEmojiConnection Emoji reactions on the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
downvotes Int! Number of downvotes the work item has received.
newCustomEmojiPath String Path to create a new custom emoji.
type WorkItemWidgetType Widget type.
upvotes Int! Number of upvotes the work item has received.

WorkItemWidgetColor#

Represents a color widget.

Implements: WorkItemWidget

Fields#

Name Type Description
color String Color of the Work Item.
textColor String Text color generated for the Work Item.
type WorkItemWidgetType Widget type.

WorkItemWidgetCrmContacts#

Represents CRM contacts widget.

Implements: WorkItemWidget

Fields#

Name Type Description
contacts CustomerRelationsContactConnection Collection of CRM contacts associated with the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
contactsAvailable Boolean! Indicates whether contacts are available to be associated with the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetCurrentUserTodos#

Represents a todos widget.

Implements: CurrentUserTodos, WorkItemWidget

Fields#

Name Type Description
currentUserTodos TodoConnection! To-do items for the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for currentUserTodos:
state (TodoStateEnum)
State of the to-do items.
type WorkItemWidgetType Widget type.

WorkItemWidgetCustomFields#

Represents a custom fields widget.

Implements: WorkItemWidget

Fields#

Name Type Description
customFieldValues [WorkItemCustomFieldValue!] Introduced as an experiment in GitLab 17.9.

Custom field values associated to the work item.

Arguments for customFieldValues:
customFieldIds ([IssuablesCustomFieldID!])
Only return values for the given custom field IDs.
type WorkItemWidgetType Widget type.

WorkItemWidgetDecisionLog#

Represents a decision log widget.

Implements: WorkItemWidget

Fields#

Name Type Description
decisions WorkItemDecisionConnection Introduced as an experiment in GitLab 19.4.

Decisions recorded on the work item. Can be requested once per query; use states to fetch several states in one call. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for decisions:
states ([WorkItemDecisionState!])
Filter decisions by one or more states. Omit to return all states.
type WorkItemWidgetType Widget type.

WorkItemWidgetDefinitionAssignees#

Represents an assignees widget definition.

Implements: WorkItemWidgetDefinition

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.

WorkItemWidgetDefinitionCustomFields#

Represents a custom fields widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
customFieldValues [WorkItemCustomFieldValue!] Introduced as an experiment in GitLab 17.10.

Custom field values associated to the work item.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionGeneric#

Represents a generic widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionHierarchy#

Represents a hierarchy widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
allowedChildTypes WorkItemTypeConnection Allowed child types for the work item type. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
allowedParentTypes WorkItemTypeConnection Allowed parent types for the work item type. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
autoExpandTreeOnMove Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the hierarchy widget should auto expand the tree during move operation.
propagatesMilestone Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the hierarchy widget propagates milestone.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionLabels#

Represents a labels widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
allowsScopedLabels Boolean! Indicates whether scoped labels are available.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionProgress#

Represents a progress widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
showPopover Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether to show the progress popover.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionStartAndDueDate#

Represents a start and due date widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
canRollUp Boolean Introduced as an experiment in GitLab 18.8.

Indicates whether the start and due date widget should roll up dates.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionStatus#

Represents a Status widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
allowedStatuses [WorkItemStatus!] Introduced as an experiment in GitLab 17.8.

Allowed statuses for the work item type.
defaultClosedStatus WorkItemStatus Introduced as an experiment in GitLab 18.0.

Default status for the Closed state for given work item type.
defaultOpenStatus WorkItemStatus Introduced as an experiment in GitLab 18.0.

Default status for the Open state for given work item type.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDefinitionWeight#

Represents a weight widget definition.

Implements: WorkItemWidgetDefinition

Fields#

Name Type Description
editable Boolean! Deprecated in GitLab 18.11. All work item types with weight widget now support editing.
rollUp Boolean! Deprecated in GitLab 18.11. All work item types with weight widget now support rolled up weight.
type WorkItemWidgetType! Widget type.

WorkItemWidgetDescription#

Represents a description widget.

Implements: WorkItemWidget

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.
taskCompletionStatus TaskCompletionStatus! Task completion status of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetDesigns#

Represents designs widget.

Implements: WorkItemWidget

Fields#

Name Type Description
designCollection DesignCollection Collection of design images associated with the issue.
type WorkItemWidgetType Widget type.

WorkItemWidgetDevelopment#

Represents a development widget.

Implements: WorkItemWidget

Fields#

Name Type Description
closingMergeRequests WorkItemClosingMergeRequestConnection Merge requests that will close the work item when merged. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
closingMergeRequestsCount Int! Number of merge requests that will close the work item when merged.
featureFlags FeatureFlagConnection Feature flags associated with the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
relatedBranches WorkItemRelatedBranchConnection Branches that have referred to the work item, but do not have an associated merge request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
relatedMergeRequests MergeRequestConnection Introduced as an experiment in GitLab 17.6.

Merge requests where the work item has been mentioned. This field can only be resolved for one work item in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.
willAutoCloseByMergeRequest Boolean! Whether the work item will automatically be closed when a closing merge request is merged.

WorkItemWidgetEmailParticipants#

Represents email participants widget.

Implements: WorkItemWidget

Fields#

Name Type Description
emailParticipants EmailParticipantTypeConnection Collection of email participants associated with the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetErrorTracking#

Represents the error tracking widget.

Implements: WorkItemWidget

Fields#

Name Type Description
identifier BigInt Error tracking issue id.This field can only be resolved for one work item in any single request.
stackTrace ErrorTrackingStackTraceConnection Stack trace details of the error.This field can only be resolved for one work item in any single request. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
status ErrorTrackingStatus Response status of error service.This field can only be resolved for one work item in any single request.
type WorkItemWidgetType Widget type.

WorkItemWidgetErrorTrackingStackTraceContext#

Represents details about a line of code of the stack trace.

Fields#

Name Type Description
line String Line of code.
lineNumber Int Line number of code.

WorkItemWidgetEscalationPolicy#

Represents the escalation policy widget.

Implements: WorkItemWidget

Fields#

Name Type Description
escalationPolicy EscalationPolicyType Escalation policy of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetEscalationStatus#

Represents the escalation status widget.

Implements: WorkItemWidget

Fields#

Name Type Description
escalationStatus IssueEscalationStatus Escalation status of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetHealthStatus#

Represents a health status widget.

Implements: WorkItemWidget

Fields#

Name Type Description
healthStatus HealthStatus Health status of the work item.
rolledUpHealthStatus [WorkItemWidgetHealthStatusCount!] Introduced as an experiment in GitLab 17.3.

Rolled up health status of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetHealthStatusCount#

Represents work item counts for the health status.

Fields#

Name Type Description
count Int! Number of work items with the health status.
healthStatus HealthStatus! Health status of the work items.

WorkItemWidgetHierarchy#

Represents a hierarchy widget.

Implements: WorkItemWidget

Fields#

Name Type Description
ancestors WorkItemConnection Ancestors (parents) of the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
children WorkItemConnection Child work items. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for children:
state (WorkItemState)
Current state of the child work items. Returns all states when omitted.
depthLimitReachedByType [WorkItemTypeDepthLimitReachedByType!]! Introduced as an experiment in GitLab 17.4.

Depth limit reached by allowed work item type.
hasChildren Boolean! Indicates if the work item has children.
hasParent Boolean! Indicates if the work item has a parent.
parent WorkItem Parent work item.
rolledUpCountsByType [WorkItemTypeCountsByState!]! Introduced as an experiment in GitLab 17.3.

Counts of descendant work items by work item type and state.
type WorkItemWidgetType Widget type.

WorkItemWidgetIteration#

Represents an iteration widget.

Implements: WorkItemWidget

Fields#

Name Type Description
iteration Iteration Iteration of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetLabels#

Represents the labels widget.

Implements: WorkItemWidget

Fields#

Name Type Description
allowsScopedLabels Boolean Deprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use WorkItemWidgetDefinitionLabels.allowsScopedLabels instead.
labels LabelConnection Labels assigned to the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetLinkedItems#

Represents the linked items widget.

Implements: WorkItemWidget

Fields#

Name Type Description
blocked Boolean Indicates the work item is blocked.
blockedByCount Int Count of items blocking the work item.
blockingCount Int Count of items the work item is blocking.
linkedItems LinkedWorkItemTypeConnection Introduced as an experiment in GitLab 16.3.

Linked items for the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for linkedItems:
filter (WorkItemRelatedLinkType)
Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
type WorkItemWidgetType Widget type.

WorkItemWidgetLinkedResources#

Represents the linked resources widget.

Implements: WorkItemWidget

Fields#

Name Type Description
linkedResources WorkItemLinkedResourceConnection Resources for the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetMilestone#

Represents a milestone widget.

Implements: WorkItemWidget

Fields#

Name Type Description
milestone Milestone Milestone of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetNotes#

Represents a notes widget.

Implements: WorkItemWidget

Fields#

Name Type Description
discussionLocked Boolean Discussion lock attribute of the work item.
discussions DiscussionConnection Discussions on this work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for discussions:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
sort (WorkItemDiscussionsSort)
Sort order for the discussions.
notes NoteConnection! Notes on this work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Arguments for notes:
filter (NotesFilterType)
Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
type WorkItemWidgetType Widget type.

WorkItemWidgetNotifications#

Represents the notifications widget.

Implements: WorkItemWidget

Fields#

Name Type Description
subscribed Boolean! Whether the current user is subscribed to notifications on the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetParticipants#

Represents a participants widget.

Implements: WorkItemWidget

Fields#

Name Type Description
participants UserCoreConnection Participants in the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetProgress#

Represents a progress widget.

Implements: WorkItemWidget

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.

Implements: WorkItemWidget

Fields#

Name Type Description
legacyIid Int Deprecated in GitLab 15.9. Use Work Item IID instead.
type WorkItemWidgetType Widget type.

WorkItemWidgetSeverity#

Represents the severity widget.

Implements: WorkItemWidget

Fields#

Name Type Description
severity IssuableSeverity Severity of the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetStartAndDueDate#

Represents a start and due date widget.

Implements: WorkItemWidget

Fields#

Name Type Description
dueDate Date Due date of the work item.
dueDateSourcingMilestone Milestone Indicates which milestone sources the rolled up due date.
dueDateSourcingWorkItem WorkItem Indicates which work_item sources the rolled up due date.
isFixed Boolean! Indicates if the work item is using fixed dates.
rollUp Boolean! Indicates if the work item can use rolled up dates.
startDate Date Start date of the work item.
startDateSourcingMilestone Milestone Indicates which milestone sources the rolled up start date.
startDateSourcingWorkItem WorkItem Indicates which work_item sources the rolled up start date.
type WorkItemWidgetType Widget type.

WorkItemWidgetStatus#

Represents status widget.

Implements: WorkItemWidget

Fields#

Name Type Description
status WorkItemStatus Introduced as an experiment in GitLab 17.11.

Status assigned to work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetTestReports#

Represents a test reports widget.

Implements: WorkItemWidget

Fields#

Name Type Description
testReports TestReportConnection Test reports of the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetTimeTracking#

Represents the time tracking widget on the work item.

Implements: WorkItemWidget

Fields#

Name Type Description
humanReadableAttributes WorkItemWidgetTimeTrackingHumanReadableAttributes Human-readable attributes of the work item.
timeEstimate Int Time estimate of the work item.
timelogs WorkItemTimelogConnection Timelogs on the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
totalTimeSpent Int Total time (in seconds) reported as spent on the work item.
type WorkItemWidgetType Widget type.

WorkItemWidgetTimeTrackingHumanReadableAttributes#

Represents a time tracking human readable attributes.

Fields#

Name Type Description
timeEstimate String Human-readable time estimate of the work item.
totalTimeSpent String Human-readable total time reported as spent on the work item.

WorkItemWidgetVerificationStatus#

Represents a verification status widget.

Implements: WorkItemWidget

Fields#

Name Type Description
type WorkItemWidgetType Widget type.
verificationStatus String Introduced as an experiment in GitLab 15.5.

Verification status of the work item.

WorkItemWidgetVulnerabilities#

Represents a vulnerabilities widget.

Implements: WorkItemWidget

Fields#

Name Type Description
relatedVulnerabilities CountableVulnerabilityConnection Introduced as an experiment in GitLab 17.10.

Related vulnerabilities of the work item. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
type WorkItemWidgetType Widget type.

WorkItemWidgetWeight#

Represents a weight widget.

Implements: WorkItemWidget

Fields#

Name Type Description
rolledUpCompletedWeight Int Introduced as an experiment in GitLab 17.3.

Rolled up weight from closed descendant work items.
rolledUpWeight Int Introduced as an experiment in GitLab 17.2.

Rolled up weight from descendant work items.
type WorkItemWidgetType Widget type.
weight Int Weight of the work item.
widgetDefinition WorkItemWidgetDefinitionWeight Deprecated in GitLab 18.11. All work item types with weight widget now support editing and rolled up weight.

Workspace#

Represents a remote development workspace.

Fields#

Name Type Description
actualState String! Actual state of the workspace.
actualStateUpdatedAt Time! Introduced as an experiment in GitLab 17.11.

Timestamp of the last update to the actual state.
clusterAgent ClusterAgent! Kubernetes agent associated with the workspace.
createdAt Time! Timestamp of when the workspace was created.
deploymentResourceVersion Int Version of the deployment resource for the workspace.
desiredState String! Desired state of the workspace.
desiredStateUpdatedAt Time! Timestamp of the last update to the desired state.
devfile String! Source YAML of the devfile used to configure the workspace.
devfilePath String Path to the devfile used to configure the workspace.
devfileRef String! Deprecated in GitLab 17.8. Field is renamed to project_ref.
devfileWebUrl String Deprecated in GitLab 17.8. Field is not used.
editor String! Deprecated in GitLab 17.5. Field is not used.
forceIncludeAllResources Boolean! Introduced as an experiment in GitLab 17.6.

Forces all resources to be included for the workspaceduring the next reconciliation with the agent.
id RemoteDevelopmentWorkspaceID! Global ID of the workspace.
maxHoursBeforeTermination Int! Deprecated in GitLab 17.9. Field is not used.
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 that contains the devfile for the workspace.
projectRef String! Git reference that contains the devfile used to configure the workspace, and that will be cloned into the workspace.
respondedToAgentAt Time Timestamp of the last response sent to the GitLab agent for Kubernetes for the workspace.
updatedAt Time! Timestamp of the last update to any mutable workspace property.
url String! URL of the workspace.
user UserCore! Owner of the workspace.
workspaceVariables WorkspaceVariableConnection Introduced as an experiment in GitLab 17.9.

User defined variables associated with the workspace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
workspacesAgentConfigVersion Int! Introduced as an experiment in GitLab 17.6.

Version of the associated WorkspacesAgentConfig for the workspace.

WorkspaceConnection#

Paginated collection of Workspace. See Standard connection fields for the fields available on every connection.

WorkspaceResources#

Resource specifications of the workspace container.

Fields#

Name Type Description
limits ResourceQuotas Limits for the requested container resources of a workspace.
requests ResourceQuotas Requested resources for the container of a workspace.

WorkspaceVariable#

Represents a remote development workspace variable.

Fields#

Name Type Description
createdAt Time! Timestamp of when the workspace variable was created.
id RemoteDevelopmentWorkspaceVariableID! Global ID of the workspace variable.
key String Name of the workspace variable.
updatedAt Time! Timestamp of when the workspace variable was updated.
value String Value of the workspace variable.
variableType WorkspaceVariableType Type of the workspace variable.

WorkspaceVariableConnection#

Paginated collection of WorkspaceVariable. See Standard connection fields for the fields available on every connection.

WorkspacesAgentConfig#

Represents a workspaces agent config.

Fields#

Name Type Description
allowPrivilegeEscalation Boolean! Allow privilege escalation.
annotations [KubernetesAnnotation!]! Annotations to apply to Kubernetes objects.
clusterAgent ClusterAgent! Cluster agent that the workspaces agent config belongs to.
createdAt Time! Timestamp of when the workspaces agent config was created.
defaultResourcesPerWorkspaceContainer WorkspaceResources! Introduced as an experiment in GitLab 17.9.

Default cpu and memory resources of the workspace container.
defaultRuntimeClass String! Default Kubernetes RuntimeClass.
dnsZone String! DNS zone where workspaces are available.
enabled Boolean! Indicates whether remote development is enabled for the GitLab agent.
gitlabWorkspacesProxyNamespace String! Namespace where gitlab-workspaces-proxy is installed.
id RemoteDevelopmentWorkspacesAgentConfigID! Global ID of the workspaces agent config.
imagePullSecrets [ImagePullSecrets!]! Introduced as an experiment in GitLab 17.9.

Kubernetes secrets to pull private images for a workspace.
labels [KubernetesLabel!]! Labels to apply to Kubernetes objects.
maxResourcesPerWorkspace WorkspaceResources! Introduced as an experiment in GitLab 17.9.

Maximum cpu and memory resources of the workspace.
networkPolicyEgress [NetworkPolicyEgress!]! Introduced as an experiment in GitLab 17.9.

IP CIDR range specifications for egress destinations from a workspace.
networkPolicyEnabled Boolean! Whether the network policy of the workspaces agent config is enabled.
projectId ID ID of the project that the workspaces agent config belongs to.
updatedAt Time! Timestamp of the last update to any mutable workspaces agent config property.
useKubernetesUserNamespaces Boolean! Indicates whether to use user namespaces in Kubernetes.
workspacesPerUserQuota Int! Maximum number of workspaces per user.
workspacesQuota Int! Maximum number of workspaces for the GitLab agent.

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

Implements: CommitSignature

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.

agentPlatformMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
clickDuoAgenticSubscriptionExpiredLearnMoreSessionEventCount Int Total count of click_duo_agentic_subscription_expired_learn_more event.
clickDuoAgenticSubscriptionExpiredUpgradeSessionEventCount Int Total count of click_duo_agentic_subscription_expired_upgrade event.
createdSessionEventCount Int Total count of agent_platform_session_created event.
droppedSessionEventCount Int Total count of agent_platform_session_dropped event.
finishedSessionEventCount Int Total count of agent_platform_session_finished event.
flowMetrics [AgentPlatformFlowMetric!] Aggregated flow metrics for Duo Agent Platform.

Arguments for flowMetrics:
sort (FlowTypeSort)
Sort results by flow type.
resumedSessionEventCount Int Total count of agent_platform_session_resumed event.
startedSessionEventCount Int Total count of agent_platform_session_started event.
stoppedSessionEventCount Int Total count of agent_platform_session_stopped event.
userFlowCounts AgentPlatformUserFlowCountConnection Aggregated count of flows per user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.
viewDuoAgenticSubscriptionExpiredEmptyStateSessionEventCount Int Total count of view_duo_agentic_subscription_expired_empty_state event.

agentPlatformUserMetrics#

Agent Platform user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
agentPlatformSessionCreatedEventCount Int Total count of agent_platform_session_created event.
agentPlatformSessionDroppedEventCount Int Total count of agent_platform_session_dropped event.
agentPlatformSessionFinishedEventCount Int Total count of agent_platform_session_finished event.
agentPlatformSessionResumedEventCount Int Total count of agent_platform_session_resumed event.
agentPlatformSessionStartedEventCount Int Total count of agent_platform_session_started event.
agentPlatformSessionStoppedEventCount Int Total count of agent_platform_session_stopped event.
clickDuoAgenticSubscriptionExpiredLearnMoreEventCount Int Total count of click_duo_agentic_subscription_expired_learn_more event.
clickDuoAgenticSubscriptionExpiredUpgradeEventCount Int Total count of click_duo_agentic_subscription_expired_upgrade event.
lastDuoActivityOn Date Date of the last Agent Platform activity for the user.
totalEventCount Int Total count of all Agent Platform events for the user.
viewDuoAgenticSubscriptionExpiredEmptyStateEventCount Int Total count of view_duo_agentic_subscription_expired_empty_state event.

aiCatalogUserMetrics#

Ai Catalog user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Ai Catalog activity for the user.
restoreAiCatalogItemEventCount Int Total count of restore_ai_catalog_item event.
totalEventCount Int Total count of all Ai Catalog events for the user.

chatUserMetrics#

Chat user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
completeDuoChatResponseEventCount Int Total count of complete_duo_chat_response event.
lastDuoActivityOn Date Date of the last Chat activity for the user.
reportDuoChatTokenUsageEventCount Int Total count of report_duo_chat_token_usage event.
requestDuoChatResponseEventCount Int Total count of request_duo_chat_response event.
toolFailedDuoChatEventCount Int Total count of tool_failed_duo_chat event.
toolSucceededDuoChatEventCount Int Total count of tool_succeeded_duo_chat event.
totalEventCount Int Total count of all Chat events for the user.

codeReviewMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
assignDuoSuggestedReviewerEventCount Int Total count of assign_duo_suggested_reviewer event.
createDuoSuggestedReviewersEventCount Int Total count of create_duo_suggested_reviewers event.
encounterDuoCodeReviewErrorDuringReviewEventCount Int Total count of encounter_duo_code_review_error_during_review event.
excludedFilesFromDuoCodeReviewEventCount Int Total count of excluded_files_from_duo_code_review event.
findNoIssuesDuoCodeReviewAfterReviewEventCount Int Total count of find_no_issues_duo_code_review_after_review event.
findNothingToReviewDuoCodeReviewOnMrEventCount Int Total count of find_nothing_to_review_duo_code_review_on_mr event.
postCommentDuoCodeReviewOnDiffEventCount Int Total count of post_comment_duo_code_review_on_diff event.
publishDuoCodeReviewCommentsEventCount Int Total count of publish_duo_code_review_comments event.
reactThumbsDownOnDuoCodeReviewCommentEventCount Int Total count of react_thumbs_down_on_duo_code_review_comment event.
reactThumbsUpOnDuoCodeReviewCommentEventCount Int Total count of react_thumbs_up_on_duo_code_review_comment event.
requestReviewDuoCodeReviewOnMrByAuthorEventCount Int Total count of request_review_duo_code_review_on_mr_by_author event.
requestReviewDuoCodeReviewOnMrByNonAuthorEventCount Int Total count of request_review_duo_code_review_on_mr_by_non_author event.

codeReviewUserMetrics#

Code Review user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
assignDuoSuggestedReviewerEventCount Int Total count of assign_duo_suggested_reviewer event.
createDuoSuggestedReviewersEventCount Int Total count of create_duo_suggested_reviewers event.
encounterDuoCodeReviewErrorDuringReviewEventCount Int Total count of encounter_duo_code_review_error_during_review event.
excludedFilesFromDuoCodeReviewEventCount Int Total count of excluded_files_from_duo_code_review event.
findNoIssuesDuoCodeReviewAfterReviewEventCount Int Total count of find_no_issues_duo_code_review_after_review event.
findNothingToReviewDuoCodeReviewOnMrEventCount Int Total count of find_nothing_to_review_duo_code_review_on_mr event.
lastDuoActivityOn Date Date of the last Code Review activity for the user.
postCommentDuoCodeReviewOnDiffEventCount Int Total count of post_comment_duo_code_review_on_diff event.
publishDuoCodeReviewCommentsEventCount Int Total count of publish_duo_code_review_comments event.
reactThumbsDownOnDuoCodeReviewCommentEventCount Int Total count of react_thumbs_down_on_duo_code_review_comment event.
reactThumbsUpOnDuoCodeReviewCommentEventCount Int Total count of react_thumbs_up_on_duo_code_review_comment event.
requestReviewDuoCodeReviewOnMrByAuthorEventCount Int Total count of request_review_duo_code_review_on_mr_by_author event.
requestReviewDuoCodeReviewOnMrByNonAuthorEventCount Int Total count of request_review_duo_code_review_on_mr_by_non_author event.
totalEventCount Int Total count of all Code Review events for the user.

codeSuggestionMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
acceptedCount Int Total count of code suggestions accepted.
acceptedLinesOfCode Int Sum of lines of code from code suggestions accepted.
contributorsCount Int Number of code contributors who used GitLab Duo Code Suggestions features.
ideNames [String!] List of IDE names with at least one suggestion shown or accepted.
languages [String!] List of languages with at least one suggestion shown or accepted.
shownCount Int Total count of code suggestions shown.
shownLinesOfCode Int Sum of lines of code from code suggestions shown.

codeSuggestionsUserMetrics#

Code Suggestions user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
codeSuggestionAcceptedInIdeEventCount Int Total count of code_suggestion_accepted_in_ide event.
codeSuggestionDirectAccessTokenRefreshEventCount Int Total count of code_suggestion_direct_access_token_refresh event.
codeSuggestionRejectedInIdeEventCount Int Total count of code_suggestion_rejected_in_ide event.
codeSuggestionShownInIdeEventCount Int Total count of code_suggestion_shown_in_ide event.
codeSuggestionsRequestedEventCount Int Total count of code_suggestions_requested event.
lastDuoActivityOn Date Date of the last Code Suggestions activity for the user.
totalEventCount Int Total count of all Code Suggestions events for the user.

duoChatMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
completeDuoChatResponseEventCount Int Total count of complete_duo_chat_response event.
reportDuoChatTokenUsageEventCount Int Total count of report_duo_chat_token_usage event.
requestDuoChatResponseEventCount Int Total count of request_duo_chat_response event.
toolFailedDuoChatEventCount Int Total count of tool_failed_duo_chat event.
toolSucceededDuoChatEventCount Int Total count of tool_succeeded_duo_chat event.

duoMessagingUserMetrics#

Duo Messaging user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
aiDuoMessagingFeedbackSubmittedEventCount Int Total count of ai_duo_messaging_feedback_submitted event.
lastDuoActivityOn Date Date of the last Duo Messaging activity for the user.
totalEventCount Int Total count of all Duo Messaging events for the user.
triggerSlackDuoEventCount Int Total count of trigger_slack_duo event.

duoWorkflowUserMetrics#

Duo Workflow user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
duoWorkflowWorkloadCompletedEventCount Int Total count of duo_workflow_workload_completed event.
lastDuoActivityOn Date Date of the last Duo Workflow activity for the user.
totalEventCount Int Total count of all Duo Workflow events for the user.

explainCodeUserMetrics#

Explain Code user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
explainCodeEventCount Int Total count of explain_code event.
lastDuoActivityOn Date Date of the last Explain Code activity for the user.
totalEventCount Int Total count of all Explain Code events for the user.

explainVulnerabilityUserMetrics#

Explain Vulnerability user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
explainVulnerabilityEventCount Int Total count of explain_vulnerability event.
lastDuoActivityOn Date Date of the last Explain Vulnerability activity for the user.
totalEventCount Int Total count of all Explain Vulnerability events for the user.

featureDiscoveryUserMetrics#

Feature Discovery user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Feature Discovery activity for the user.
resolveFeatureDiscoverySearchEventCount Int Total count of resolve_feature_discovery_search event.
totalEventCount Int Total count of all Feature Discovery events for the user.

fixCodeUserMetrics#

Fix Code user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
fixCodeEventCount Int Total count of fix_code event.
lastDuoActivityOn Date Date of the last Fix Code activity for the user.
totalEventCount Int Total count of all Fix Code events for the user.

fixPipelineUserMetrics#

Fix Pipeline user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
fixPipelineSuggestionAppliedEventCount Int Total count of fix_pipeline_suggestion_applied event.
fixPipelineSuggestionPostedEventCount Int Total count of fix_pipeline_suggestion_posted event.
lastDuoActivityOn Date Date of the last Fix Pipeline activity for the user.
totalEventCount Int Total count of all Fix Pipeline events for the user.

generateMergeCommitMessageUserMetrics#

Generate Merge Commit Message user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
generateMergeCommitMessageEventCount Int Total count of generate_merge_commit_message event.
lastDuoActivityOn Date Date of the last Generate Merge Commit Message activity for the user.
totalEventCount Int Total count of all Generate Merge Commit Message events for the user.

mcpMetrics#

Model Context Protocol metrics. Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
finishMcpToolCallEventCount Int Total count of finish_mcp_tool_call event.
startMcpToolCallEventCount Int Total count of start_mcp_tool_call event.

mcpUserMetrics#

MCP user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
finishMcpToolCallEventCount Int Total count of finish_mcp_tool_call event.
lastDuoActivityOn Date Date of the last MCP activity for the user.
startMcpToolCallEventCount Int Total count of start_mcp_tool_call event.
totalEventCount Int Total count of all MCP events for the user.

refactorCodeUserMetrics#

Refactor Code user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Refactor Code activity for the user.
refactorCodeEventCount Int Total count of refactor_code event.
totalEventCount Int Total count of all Refactor Code events for the user.

requestDuoVulnerabilityResolutionUserMetrics#

Request Duo Vulnerability Resolution user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Request Duo Vulnerability Resolution activity for the user.
requestDuoVulnerabilityResolutionEventCount Int Total count of request_duo_vulnerability_resolution event.
totalEventCount Int Total count of all Request Duo Vulnerability Resolution events for the user.

summarizeNewMergeRequestUserMetrics#

Summarize New Merge Request user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Summarize New Merge Request activity for the user.
summarizeNewMergeRequestEventCount Int Total count of summarize_new_merge_request event.
totalEventCount Int Total count of all Summarize New Merge Request events for the user.

summarizeReviewUserMetrics#

Summarize Review user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Summarize Review activity for the user.
summarizeReviewEventCount Int Total count of summarize_review event.
totalEventCount Int Total count of all Summarize Review events for the user.

troubleshootJobMetrics#

Requires ClickHouse. Premium and Ultimate only.

Fields#

Name Type Description
troubleshootJobEventCount Int Total count of troubleshoot_job event.

troubleshootJobUserMetrics#

Troubleshoot Job user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Troubleshoot Job activity for the user.
totalEventCount Int Total count of all Troubleshoot Job events for the user.
troubleshootJobEventCount Int Total count of troubleshoot_job event.

writeTestsUserMetrics#

Write Tests user metrics for a user. Requires ClickHouse. Premium and Ultimate with GitLab Duo Enterprise only.

Fields#

Name Type Description
lastDuoActivityOn Date Date of the last Write Tests activity for the user.
totalEventCount Int Total count of all Write Tests events for the user.
writeTestsEventCount Int Total count of write_tests event.

Connections and pagination#

Some fields return a connection: a paginated list of items that follows the Relay cursor connections specification. Because every connection shares the same pagination fields and arguments, they are documented here once rather than repeated for every connection field.

Standard connection fields#

Every connection type has the following fields:

Field Type Description
nodes [Item] The items in the current page. The item type depends on the connection.
edges [Edge] The edges. Each edge wraps a node and a cursor.
pageInfo PageInfo! Pagination information.

Every edge type has the following fields:

Field Type Description
node Item The item at the end of the edge. The item type depends on the connection.
cursor String! A cursor for use in pagination.

Some connections and edges have additional fields specific to their type. These are documented individually in each connection or edge section above.

Pagination arguments#

All connection fields accept the following optional pagination arguments:

Name Type Description
after String Returns the items that come after the specified cursor.
before String Returns the items that come before the specified cursor.
first Int Returns the first n items from the list.
last Int Returns the last n items from the list.

Querying a connection#

The following example queries the projects field, which returns a ProjectConnection. It shows the pagination arguments in use and annotates each part of the response with its type:

{
  projects(
    first: 10        # optional - return at most 10 items
    after: "abc123"  # optional - start after this cursor (from a previous endCursor)
  ) {                # ProjectConnection
    pageInfo {       # PageInfo
      hasNextPage    # Boolean - true if more pages follow
      endCursor      # String - pass as `after:` to fetch the next page
    }
    nodes {          # [Project] - the items on this page
      id
      name
    }
    edges {          # [ProjectEdge] - the same items, each with a cursor
      cursor         # String - cursor for this specific item
      node {         # Project
        id
        name
      }
    }
  }
}

To fetch the next page, pass the endCursor value from pageInfo as the after argument. Use last and before to paginate in reverse.