GraphQL API resources

This documentation is self-generated based on GitLab current GraphQL schema.

The API can be explored using the interactive GraphQL explorer. Developers can also generate a machine-readable GraphQL schema in IDL and JSON formats.

Each table below documents a GraphQL type. Types match loosely to models, but not all fields and methods on a model are available via GraphQL.

Fields that are deprecated are marked with warning-solid . Items (fields, enums, etc) that have been removed according to our deprecation process can be found in Removed Items.

Query type

The Query type contains the API’s top-level entry points for all executable queries.

Query.abuseReport

Find an abuse report.

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Returns AbuseReport.

Arguments

NameTypeDescription
idAbuseReportID!ID of the abuse report.

Query.abuseReportLabels

Abuse report labels.

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Returns AbuseReportLabelConnection.

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

Arguments

NameTypeDescription
searchTermStringSearch term to find labels with.

Query.addOnPurchase

Retrieve the active add-on purchase. This query can be used in GitLab SaaS and self-managed environments.

Returns AddOnPurchase.

Arguments

NameTypeDescription
addOnTypeGitlabSubscriptionsAddOnType!Type of add-on for the add-on purchase.
namespaceIdNamespaceIDID of namespace that the add-on was purchased for.

Query.addOnPurchases

Retrieve all active add-on purchases. This query can be used in GitLab.com and self-managed environments.

Returns [AddOnPurchase!].

Arguments

NameTypeDescription
namespaceIdNamespaceIDID of namespace that the add-ons were purchased for.

Query.adminMemberRole

Finds a single admin custom role for the instance. Available only for GitLab Self-Managed.

  • Introduced in GitLab 17.10.
  • Status: Experiment.

Returns AdminMemberRole.

Arguments

NameTypeDescription
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering column. Default is ASC.

Query.adminMemberRolePermissions

List of all admin customizable permissions.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Returns CustomizableAdminPermissionConnection.

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

Query.adminMemberRoles

Admin custom roles available for the instance. Available only for GitLab Self-Managed.

  • Introduced in GitLab 17.10.
  • Status: Experiment.

Returns AdminMemberRoleConnection.

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

Arguments

NameTypeDescription
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering column. Default is ASC.

Query.aiConversationThreads

List conversation threads of AI features.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Returns AiConversationsThreadConnection!.

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

Arguments

NameTypeDescription
conversationTypeAiConversationsThreadsConversationTypeConversation type of the thread.
idAiConversationThreadIDId of the thread.

Query.aiFeatureSettings

List of configurable AI features.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns AiFeatureSettingConnection.

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

Arguments

NameTypeDescription
selfHostedModelIdAiSelfHostedModelIDGlobal ID of the self-hosted model.

Query.aiMessages

Find GitLab Duo Chat messages.

  • Introduced in GitLab 16.1.
  • Status: Experiment.

Returns AiMessageConnection!.

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

Arguments

NameTypeDescription
agentVersionIdAiAgentVersionIDGlobal ID of the agent to answer the chat.
conversationTypeAiConversationsThreadsConversationTypeConversation type of the thread.
requestIds[ID!]Array of request IDs to fetch.
roles[AiMessageRole!]Array of roles to fetch.
threadIdAiConversationThreadIDGlobal Id of the existing thread.If it is not specified, the last thread for the specified conversation_type will be retrieved.

Query.aiSelfHostedModels

Returns the self-hosted model if an ID is provided, otherwise returns all models.

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Returns AiSelfHostedModelConnection.

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

Arguments

NameTypeDescription
idAiSelfHostedModelIDGlobal ID of a self-hosted model.

Query.aiSlashCommands

Get available Duo Chat slash commands for the current user for a specific URL.

Returns [SlashCommand!].

Arguments

NameTypeDescription
urlString!URL of the page the user is currently on.

Query.auditEventDefinitions

Definitions for all audit events available on the instance.

Returns AuditEventDefinitionConnection!.

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

Query.auditEventsInstanceAmazonS3Configurations

Instance-level Amazon S3 configurations for audit events.

Returns InstanceAmazonS3ConfigurationTypeConnection.

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

Query.auditEventsInstanceStreamingDestinations

Instance-level external audit event streaming destinations.

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Returns InstanceAuditEventStreamingDestinationConnection.

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

Query.blobSearch

Find code visible to the current user.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Returns BlobSearch.

Arguments

NameTypeDescription
chunkCount warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Maximum chunks per file.
groupId warning-solidGroupIDIntroduced in GitLab 17.2. Status: Experiment. Group to search in.
includeArchived warning-solidBooleanIntroduced in GitLab 17.7. Status: Experiment. Includes archived projects in the search. Always true for project search. Default is false.
includeForked warning-solidBooleanIntroduced in GitLab 17.7. Status: Experiment. Includes forked projects in the search. Always true for project search. Not available for global search. Default is false.
page warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Page number to fetch the results.
perPage warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Number of results per page.
projectId warning-solidProjectIDIntroduced in GitLab 17.2. Status: Experiment. Project to search in.
regex warning-solidBooleanIntroduced in GitLab 17.3. Status: Experiment. Uses the regular expression search mode. Default is false.
repositoryRef warning-solidStringIntroduced in GitLab 17.2. Status: Experiment. Repository reference to search in.
searchString!Searched term.

Query.boardList

Find an issue board list.

Returns BoardList.

Arguments

NameTypeDescription
idListID!Global ID of the list.
issueFiltersBoardIssueInputFilters applied when getting issue metadata in the board list.

Query.ciApplicationSettings

CI related settings that apply to the entire instance.

Returns CiApplicationSettings.

Query.ciCatalogResource

A single CI/CD Catalog resource visible to an authorized user.

  • Introduced in GitLab 16.1.
  • Status: Experiment.

Returns CiCatalogResource.

Arguments

NameTypeDescription
fullPathIDCI/CD Catalog resource full path.
idCiCatalogResourceIDCI/CD Catalog resource global ID.

Query.ciCatalogResources

All CI/CD Catalog resources under a common namespace, visible to an authorized user.

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Returns CiCatalogResourceConnection.

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

Arguments

NameTypeDescription
scopeCiCatalogResourceScopeScope of the returned catalog resources.
searchStringSearch term to filter the catalog resources by name or description.
sortCiCatalogResourceSortSort catalog resources by given criteria.
verificationLevelCiCatalogResourceVerificationLevelFilter catalog resources by verification level.

Query.ciConfig

Linted and processed contents of a CI config. Should not be requested more than once per request.

Returns CiConfig.

Arguments

NameTypeDescription
contentString!Contents of .gitlab-ci.yml.
dryRunBooleanRun pipeline creation simulation, or only do static check.
projectPathID!Project of the CI config.
shaStringSha for the pipeline.
skipVerifyProjectSha warning-solidBooleanIntroduced in GitLab 16.5. Status: Experiment. If the provided sha is found in the project’s repository but is not associated with a Git reference (a detached commit), the verification fails and a validation error is returned. Otherwise, verification passes, even if the sha is invalid. Set to true to skip this verification process.

Query.ciMinutesUsage

Compute usage data for a namespace.

Returns CiMinutesNamespaceMonthlyUsageConnection.

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

Arguments

NameTypeDescription
dateDateDate for which to retrieve the usage data, should be the first day of a month.
namespaceIdNamespaceIDGlobal ID of the Namespace for the monthly compute usage.

Query.ciPipelineStage

Stage belonging to a CI pipeline.

Returns CiStage.

Arguments

NameTypeDescription
idCiStageID!Global ID of the CI stage.

Query.ciQueueingHistory

Time taken for CI jobs to be picked up by runner by percentile. Enable the ClickHouse database backend to use this query.

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Returns QueueingDelayHistory.

Arguments

NameTypeDescription
fromTimeTimeStart of the requested time. Defaults to three hours ago.
runnerTypeCiRunnerTypeFilter jobs by the type of runner that executed them.
toTimeTimeEnd of the requested time. Defaults to the current time.

Query.ciVariables

List of the instance’s CI/CD variables.

Returns CiInstanceVariableConnection.

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

Arguments

NameTypeDescription
sortCiVariableSortSort order of results.

Query.cloudConnectorStatus

Run a series of status checks for Cloud Connector features.

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Returns CloudConnectorStatus.

Query.complianceRequirementControls

Get the list of all the compliance requirement controls.

Returns ComplianceRequirementControl.

Query.containerRepository

Find a container repository.

Returns ContainerRepositoryDetails.

Arguments

NameTypeDescription
idContainerRepositoryID!Global ID of the container repository.

Query.currentLicense

Fields related to the current license.

Returns CurrentLicense.

Query.currentUser

Get information about current user.

Returns CurrentUser.

Query.designManagement

Fields related to design management.

Returns DesignManagement!.

Query.devopsAdoptionEnabledNamespaces

Get configured DevOps adoption namespaces. Status: Beta. This endpoint is subject to change without notice.

Returns DevopsAdoptionEnabledNamespaceConnection.

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

Arguments

NameTypeDescription
displayNamespaceIdNamespaceIDFilter by display namespace.

Query.duoSettings

Get GitLab Duo settings.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Returns DuoSettings.

Query.duoWorkflowEvents

List the events for a Duo Workflow.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Returns DuoWorkflowEventConnection!.

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

Arguments

NameTypeDescription
workflowIdAiDuoWorkflowsWorkflowID!Array of request IDs to fetch.

Query.duoWorkflowWorkflows

List the workflows owned by the current user.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Returns DuoWorkflowConnection!.

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

Arguments

NameTypeDescription
projectPathIDFull path of the project containing the workflows.

Query.echo

Testing endpoint to validate the API with.

Returns String!.

Arguments

NameTypeDescription
textString!Text to echo back.

Query.epicBoardList

Returns EpicList.

Arguments

NameTypeDescription
epicFiltersEpicFiltersFilters applied when getting epic metadata in the epic board list.
idBoardsEpicListID!Global ID of the list.

Query.featureFlagEnabled

Check if a feature flag is enabled.

  • Deprecated in GitLab 17.4.
  • Replaced with metadata.featureFlags.

Returns Boolean!.

Arguments

NameTypeDescription
nameString!Name of the feature flag.

Query.frecentGroups

A user’s frecently visited groups.

Returns [Group!].

Query.frecentProjects

A user’s frecently visited projects.

Returns [Project!].

Query.geoNode

Find a Geo node.

Returns GeoNode.

Arguments

NameTypeDescription
nameStringName of the Geo node. Defaults to the current Geo node name.

Query.gitpodEnabled

Whether Gitpod is enabled in application settings.

Returns Boolean.

Query.googleCloudArtifactRegistryRepositoryArtifact

Details about an artifact in the Google Artifact Registry.

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Returns GoogleCloudArtifactRegistryArtifactDetails.

Arguments

NameTypeDescription
googleCloudProjectIdString!ID of the Google Cloud project.
imageString!Name of the image in the Google Artifact Registry.
locationString!Location of the Artifact Registry repository.
projectPathID!Full project path.
repositoryString!Repository on the Google Artifact Registry.

Query.group

Find a group.

Returns Group.

Arguments

NameTypeDescription
fullPathID!Full path of the group. For example, gitlab-org/gitlab-foss.

Query.groups

Find groups.

Returns GroupConnection.

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

Arguments

NameTypeDescription
ids[ID!]Filter groups by IDs.
markedForDeletionOnDateDate when the group was marked for deletion.
ownedOnlyBooleanOnly include groups where the current user has an owner role.
searchStringSearch query for group name or group full path.
sortStringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topLevelOnlyBooleanOnly include top-level groups.

Query.instanceExternalAuditEventDestinations

Instance level external audit event destinations.

Returns InstanceExternalAuditEventDestinationConnection.

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

Query.instanceGoogleCloudLoggingConfigurations

Instance level google cloud logging configurations.

Returns InstanceGoogleCloudLoggingConfigurationTypeConnection.

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

Query.instanceSecurityDashboard

Fields related to Instance Security Dashboard.

Returns InstanceSecurityDashboard.

Query.integrationExclusions

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Returns IntegrationExclusionConnection.

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

Arguments

NameTypeDescription
integrationNameIntegrationType!Type of integration.

Query.issue

Find an issue.

Returns Issue.

Arguments

NameTypeDescription
idIssueID!Global ID of the issue.

Query.issues

Find issues visible to the current user. At least one filter must be provided.

  • Introduced in GitLab 15.6.
  • Status: Experiment.

Returns IssueConnection.

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

Arguments

NameTypeDescription
assigneeIdStringID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername warning-solidStringDeprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames[String!]Usernames of users assigned to the issue.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsernameStringUsername of the author of the issue.
closedAfterTimeIssues closed after the date.
closedBeforeTimeIssues closed before the date.
confidentialBooleanFilter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfterTimeIssues created after the date.
createdBeforeTimeIssues created before the date.
crmContactIdStringID of a contact assigned to the issues.
crmOrganizationIdStringID of an organization assigned to the issues.
dueAfterTimeReturn issues due on or after the given time.
dueBeforeTimeReturn issues due on or before the given time.
epicIdStringID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardIdEpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatusFilterHealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iidStringIID 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.'.
includeArchivedBooleanWhether to include issues from archived projects. Defaults to false.
includeSubepicsBooleanWhether 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.
iterationTitleStringFilter by iteration title.
iterationWildcardIdIterationWildcardIdFilter by iteration ID wildcard.
labelName[String]Labels applied to the issue.
milestoneTitle[String]Milestone applied to the issue.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
notNegatedIssueFilterInputNegated arguments.
orUnionedIssueFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortIssueSortSort issues by the criteria.
stateIssuableStateCurrent state of the issue.
subscribedSubscriptionStatusIssues the current user is subscribed to.
types[IssueType!]Filter issues by the given issue types.
updatedAfterTimeIssues updated after the date.
updatedBeforeTimeIssues updated before the date.
weightStringWeight applied to the issue, “none” and “any” values are supported.
weightWildcardIdWeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.

Query.iteration

Find an iteration.

Returns Iteration.

Arguments

NameTypeDescription
idIterationID!Find an iteration by its ID.

Query.jobs

All jobs on this GitLab instance. Returns an empty result for users without administrator access.

Returns CiJobConnection.

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

Arguments

NameTypeDescription
failureReason warning-solidCiJobFailureReasonIntroduced in GitLab 16.4. Status: Experiment. Filter jobs by failure reason. Currently only RUNNER_SYSTEM_FAILURE together with runnerTypes: INSTANCE_TYPE is supported.
runnerTypes warning-solid[CiRunnerType!]Introduced in GitLab 16.4. Status: Experiment. Filter jobs by runner type if feature flag :admin_jobs_filter_runner_type is enabled.
statuses[CiJobStatus!]Filter jobs by status.

Query.licenseHistoryEntries

Fields related to entries in the license history.

Returns LicenseHistoryEntryConnection.

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

Query.memberRole

Finds a single custom role for the instance. Available only for GitLab Self-Managed.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns MemberRole.

Arguments

NameTypeDescription
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering column. Default is ASC.

Query.memberRolePermissions

List of all standard customizable permissions.

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Returns CustomizableStandardPermissionConnection.

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

Query.memberRoles

Custom roles available for the instance. Available only for GitLab Self-Managed.

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Returns MemberRoleConnection.

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

Arguments

NameTypeDescription
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering column. Default is ASC.

Query.mergeRequest

Find a merge request.

Returns MergeRequest.

Arguments

NameTypeDescription
idMergeRequestID!Global ID of the merge request.

Query.metadata

Metadata about GitLab.

Returns Metadata.

Query.milestone

Find a milestone.

Returns Milestone.

Arguments

NameTypeDescription
idMilestoneID!Find a milestone by its ID.

Query.mlExperiment

Find a machine learning experiment.

Returns MlExperiment.

Arguments

NameTypeDescription
idMlExperimentID!ID of the experiment.

Query.mlModel

Find machine learning models.

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Returns MlModel.

Arguments

NameTypeDescription
idMlModelID!ID of the model.

Query.namespace

Find a namespace.

Returns Namespace.

Arguments

NameTypeDescription
fullPathID!Full path of the namespace. For example, gitlab-org/gitlab-foss.

Query.note

Find a note.

  • Introduced in GitLab 15.9.
  • Status: Experiment.

Returns Note.

Arguments

NameTypeDescription
idNoteID!Global ID of the note.

Query.organization

Find an organization.

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Returns Organization.

Arguments

NameTypeDescription
idOrganizationsOrganizationID!ID of the organization.

Query.organizations

List organizations.

  • Introduced in GitLab 16.8.
  • Status: Experiment.

Returns OrganizationConnection.

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

Query.package

Find a package. This field can only be resolved for one query in any single request. Returns null if a package has no default status.

Returns PackageDetailsType.

Arguments

NameTypeDescription
idPackagesPackageID!Global ID of the package.

Query.project

Find a project.

Returns Project.

Arguments

NameTypeDescription
fullPathID!Full path of the project. For example, gitlab-org/gitlab-foss.

Query.projectSecret

View a specific project secret.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Returns ProjectSecret.

Arguments

NameTypeDescription
nameString!Name of the project secret to view.
projectPathID!Project the secrets belong to.

Query.projectSecrets

List project secrets.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Returns ProjectSecretConnection.

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

Arguments

NameTypeDescription
projectPathID!Project the secrets belong to.

Query.projectSecretsManager

Find a project secrets manager.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns ProjectSecretsManager.

Arguments

NameTypeDescription
projectPathID!Project of the secrets manager.

Query.projects

Find projects visible to the current user.

Returns ProjectConnection.

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

Arguments

NameTypeDescription
aimedForDeletionBooleanReturn only projects marked for deletion.
archivedProjectArchivedFilter projects by archived status.
fullPaths[String!]Filter projects by full paths. You cannot provide more than 50 full paths.
ids[ID!]Filter projects by IDs.
includeHiddenBooleanInclude hidden projects.
markedForDeletionOnDateDate when the project was marked for deletion.
membershipBooleanReturn only projects that the current user is a member of.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
personalBooleanReturn only personal projects.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query, which can be for the project name, a path, or a description.
searchNamespacesBooleanInclude namespace in project search.
sortStringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics[String!]Filter projects by topics.
withIssuesEnabledBooleanReturn only projects with issues enabled.
withMergeRequestsEnabledBooleanReturn only projects with merge requests enabled.

Query.queryComplexity

Information about the complexity of the GraphQL query.

Returns QueryComplexity.

Query.runner

Find a runner.

Returns CiRunner.

Arguments

NameTypeDescription
idCiRunnerID!Runner ID.

Query.runnerPlatforms

Supported runner platforms.

  • Deprecated in GitLab 15.9.
  • No longer used, use gitlab-runner documentation to learn about supported platforms.

Returns RunnerPlatformConnection.

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

Query.runnerSetup

Runner setup instructions.

  • Deprecated in GitLab 15.9.
  • No longer used, use gitlab-runner documentation to learn about runner registration commands.

Returns RunnerSetup.

Arguments

NameTypeDescription
architectureString!Architecture to generate the instructions for.
groupId warning-solidGroupIDDeprecated in GitLab 13.11. No longer used.
platformString!Platform to generate the instructions for.
projectId warning-solidProjectIDDeprecated in GitLab 13.11. No longer used.

Query.runnerUsage

Runner usage by runner. Enable the ClickHouse database backend to use this query.

Returns [CiRunnerUsage!].

Arguments

NameTypeDescription
fromDateDateStart of the requested date frame. Defaults to the start of the previous calendar month.
fullPathIDFilter jobs by the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
runnerTypeCiRunnerTypeFilter runners by the type.
runnersLimitIntMaximum number of runners to return. Other runners will be aggregated to a runner: null entry. Defaults to 5 if unspecified. Maximum of 500.
toDateDateEnd of the requested date frame. Defaults to the end of the previous calendar month.

Query.runnerUsageByProject

Runner usage by project. Enable the ClickHouse database backend to use this query.

Returns [CiRunnerUsageByProject!].

Arguments

NameTypeDescription
fromDateDateStart of the requested date frame. Defaults to the start of the previous calendar month.
fullPathIDFilter jobs based on the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
projectsLimitIntMaximum number of projects to return. Other projects will be aggregated to a project: null entry. Defaults to 5 if unspecified. Maximum of 500.
runnerTypeCiRunnerTypeFilter jobs by the type of runner that executed them.
toDateDateEnd of the requested date frame. Defaults to the end of the previous calendar month.

Query.runners

Get all runners in the GitLab instance (project and shared). Access is restricted to users with administrator access.

Returns CiRunnerConnection.

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

Arguments

NameTypeDescription
active warning-solidBooleanDeprecated in GitLab 14.8. This was renamed. Use: paused.
creatorIdUserIDFilter runners by creator ID.
creatorUsername warning-solidStringIntroduced in GitLab 16.7. Status: Experiment. Filter runners by creator username.
ownerFullPath warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Filter runners by owning project or group.
ownerWildcard warning-solidCiRunnerOwnerWildcardIntroduced in GitLab 17.8. Status: Experiment. Filter runners by owner wildcard.
pausedBooleanFilter runners by paused (true) or active (false) status.
searchStringFilter by full token or partial text in description field.
sortCiRunnerSortSort order of results.
statusCiRunnerStatusFilter runners by status.
tagList[String!]Filter by tags associated with the runner (comma-separated or array).
typeCiRunnerTypeFilter runners by type.
upgradeStatusCiRunnerUpgradeStatusFilter by upgrade status.
versionPrefix warning-solidStringIntroduced in GitLab 16.6. Status: Experiment. Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term ‘14.’ returns runner managers with versions ‘14.11.1’ and ‘14.2.3’.

Query.selfManagedAddOnEligibleUsers

Users within the self-managed instance who are eligible for add-ons.

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Returns AddOnUserConnection.

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

Arguments

NameTypeDescription
addOnPurchaseIds[GitlabSubscriptionsAddOnPurchaseID!]!Global IDs of the add on purchases to find assignments for.
addOnTypeGitlabSubscriptionsAddOnType!Type of add on to filter the eligible users by.
filterByAssignedSeatStringFilter users list by assigned seat.
searchStringSearch the user list.
sortGitlabSubscriptionsUserSortSort the user list.

Query.selfManagedUsersQueuedForRolePromotion

Fields related to users within a self-managed instance that are pending role promotion approval.

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Returns UsersQueuedForRolePromotionConnection.

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

Query.snippets

Find Snippets visible to the current user.

Returns SnippetConnection.

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

Arguments

NameTypeDescription
authorIdUserIDID of an author.
exploreBooleanExplore personal snippets.
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
projectIdProjectIDID of a project.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.

Query.standardRole

Finds a single default role for the instance. Available only for GitLab Self-Managed.

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Returns StandardRole.

Arguments

NameTypeDescription
accessLevel[MemberAccessLevel!]Access level or levels to filter by.

Query.standardRoles

Default roles available for the instance. Available only for GitLab Self-Managed.

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Returns StandardRoleConnection.

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

Arguments

NameTypeDescription
accessLevel[MemberAccessLevel!]Access level or levels to filter by.

Query.subscriptionFutureEntries

Fields related to entries in future subscriptions.

Returns SubscriptionFutureEntryConnection.

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

Query.syntheticNote

Find a synthetic note.

  • Introduced in GitLab 15.9.
  • Status: Experiment.

Returns Note.

Arguments

NameTypeDescription
noteableIdNoteableID!Global ID of the resource to search synthetic note on.
shaString!Global ID of the note.

Query.timelogs

Find timelogs visible to the current user.

Returns TimelogConnection.

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

Arguments

NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.

Query.todo

Retrieve a single to-do item.

Returns Todo.

Arguments

NameTypeDescription
idTodoID!ID of the to-do item.

Query.topics

Find project topics.

Returns TopicConnection.

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

Arguments

NameTypeDescription
organizationId warning-solidOrganizationsOrganizationIDIntroduced in GitLab 17.7. Status: Experiment. Global ID of the organization.
searchStringSearch query for topic name.

Query.usageTrendsMeasurements

Get statistics on the instance.

Returns UsageTrendsMeasurementConnection.

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

Arguments

NameTypeDescription
identifierMeasurementIdentifier!Type of measurement or statistics to retrieve.
recordedAfterTimeMeasurement recorded after the date.
recordedBeforeTimeMeasurement recorded before the date.

Query.user

Find a user.

Returns UserCore.

Arguments

NameTypeDescription
idUserIDID of the User.
usernameStringUsername of the User.

Query.users

Find users.

Returns UserCoreConnection.

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

Arguments

NameTypeDescription
activeBooleanFilter by active users. When true, returns active users. When false, returns non-active users.
adminsBooleanReturn only admin users.
groupIdGroupIDReturn users member of a given group.
humansBooleanFilter by regular users. When true, returns only users that are not bot or internal users. When false, returns only users that are bot or internal users.
ids[ID!]List of user Global IDs.
searchStringQuery to search users by name, username, or primary email.
sortSortSort users by the criteria.
usernames[String!]List of usernames.

Query.vulnerabilities

Vulnerabilities reported on projects on the current user’s instance security dashboard.

Returns VulnerabilityConnection.

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

Arguments

NameTypeDescription
clusterAgentId[ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId[ClustersClusterID!]Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason[VulnerabilityDismissalReason!]Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
hasAiResolution warning-solidBooleanIntroduced in GitLab 17.5. Status: Experiment. Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution. Requires the vulnerability_report_vr_filter feature flag to be enabled, otherwise the argument is ignored.
hasIssuesBooleanReturns only the vulnerabilities which have linked issues.
hasMergeRequestBooleanReturns only the vulnerabilities which have linked merge requests.
hasRemediationsBooleanReturns only the vulnerabilities which have remediations.
hasResolutionBooleanReturns only the vulnerabilities which have been resolved on default branch.
identifierNameStringFilter vulnerabilities by identifier name. Applicable on group level when feature flag vulnerability_filtering_by_identifier_group is enabled. 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.
owaspTopTen[VulnerabilityOwaspTop10!]Filter vulnerabilities by OWASP Top 10 category. Wildcard value “NONE” also supported and it cannot be combined with other OWASP top 10 values.
projectId[ID!]Filter vulnerabilities by project.
reportType[VulnerabilityReportType!]Filter vulnerabilities by report type.
scanner[String!]Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId[VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity[VulnerabilitySeverity!]Filter vulnerabilities by severity.
sortVulnerabilitySortList vulnerabilities by sort order.
state[VulnerabilityState!]Filter vulnerabilities by state.

Query.vulnerabilitiesCountByDay

The historical number of vulnerabilities per day for the projects on the current user’s instance security dashboard.

Returns VulnerabilitiesCountByDayConnection.

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

Arguments

NameTypeDescription
endDateISO8601Date!Last day for which to fetch vulnerability history.
startDateISO8601Date!First day for which to fetch vulnerability history.

Query.vulnerability

Find a vulnerability.

Returns Vulnerability.

Arguments

NameTypeDescription
idVulnerabilityID!Global ID of the Vulnerability.

Query.wikiPage

Find a wiki page.

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Returns WikiPage.

Arguments

NameTypeDescription
namespaceIdNamespaceIDWiki page namespace ID.
projectIdProjectIDWiki page project ID.
slugStringWiki page slug.

Query.workItem

Find a work item.

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Returns WorkItem.

Arguments

NameTypeDescription
idWorkItemID!Global ID of the work item.

Query.workItemDescriptionTemplateContent

Find a work item description template.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Returns WorkItemDescriptionTemplate.

Arguments

NameTypeDescription
templateContentInputWorkItemDescriptionTemplateContentInput!Input for fetching a specific Descriptiontemplate.

Query.workItemsByReference

Find work items by their reference.

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Returns WorkItemConnection.

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

Arguments

NameTypeDescription
contextNamespacePathIDFull path of the context namespace (project or group).
refs[String!]!Work item references. Can be either a short reference or URL.

Query.workspace

Find a workspace.

Returns Workspace.

Arguments

NameTypeDescription
idRemoteDevelopmentWorkspaceID!Find a workspace by its ID.

Query.workspaces

Find workspaces across the entire instance. This field is only available to instance admins, it will return an empty result for all non-admins.

Returns WorkspaceConnection.

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

Arguments

NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.
userIds[ProjectID!]Filter workspaces by user GlobalIDs.

Mutation type

The Mutation type contains all the mutations you can execute.

All mutations receive their arguments in a single input object named input, and all mutations support at least a return field errors containing a list of error messages.

All input objects may have a clientMutationId: String field, identifying the mutation.

For example:

mutation($id: NoteableID!, $body: String!) {
  createNote(input: { noteableId: $id, body: $body }) {
    errors
  }
}

Mutation.abuseReportLabelCreate

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Input type: AbuseReportLabelCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
colorStringThe color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names.
titleString!Title of the label.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
labelAbuseReportLabelLabel after mutation.

Mutation.achievementsAward

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Input type: AchievementsAwardInput

Arguments

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being awarded.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIdUserID!Global ID of the user being awarded the achievement.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userAchievementUserAchievementAchievement award.

Mutation.achievementsCreate

  • Introduced in GitLab 15.8.
  • Status: Experiment.

Input type: AchievementsCreateInput

Arguments

NameTypeDescription
avatarUploadAvatar for the achievement.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of or notes for the achievement.
nameString!Name for the achievement.
namespaceIdNamespaceID!Namespace for the achievement.

Fields

NameTypeDescription
achievementAchievementAchievement created.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.achievementsDelete

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Input type: AchievementsDeleteInput

Arguments

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being deleted.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields

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

Mutation.achievementsRevoke

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Input type: AchievementsRevokeInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being revoked.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userAchievementUserAchievementAchievement award.

Mutation.achievementsUpdate

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Input type: AchievementsUpdateInput

Arguments

NameTypeDescription
achievementIdAchievementsAchievementID!Global ID of the achievement being updated.
avatarUploadAvatar for the achievement.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of or notes for the achievement.
nameStringName for the achievement.

Fields

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

Mutation.addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectID!ID of the project to be added to Instance Security Dashboard.

Fields

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

Mutation.adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

Arguments

NameTypeDescription
aiResourceStringDelete jobs matching ai_resource in the context metadata.
artifactSizeStringDelete jobs matching artifact_size in the context metadata.
artifactUsedCdnStringDelete jobs matching artifact_used_cdn in the context metadata.
artifactsDependenciesCountStringDelete jobs matching artifacts_dependencies_count in the context metadata.
artifactsDependenciesSizeStringDelete jobs matching artifacts_dependencies_size in the context metadata.
bulkImportEntityIdStringDelete jobs matching bulk_import_entity_id in the context metadata.
callerIdStringDelete jobs matching caller_id in the context metadata.
clientIdStringDelete jobs matching client_id in the context metadata.
clientMutationIdStringA unique identifier for the client performing the mutation.
featureCategoryStringDelete jobs matching feature_category in the context metadata.
jobIdStringDelete jobs matching job_id in the context metadata.
mergeActionStatusStringDelete jobs matching merge_action_status in the context metadata.
organizationIdStringDelete jobs matching organization_id in the context metadata.
pipelineIdStringDelete jobs matching pipeline_id in the context metadata.
projectStringDelete jobs matching project in the context metadata.
queueNameString!Name of the queue to delete jobs from.
relatedClassStringDelete jobs matching related_class in the context metadata.
remoteIpStringDelete jobs matching remote_ip in the context metadata.
rootCallerIdStringDelete jobs matching root_caller_id in the context metadata.
rootNamespaceStringDelete jobs matching root_namespace in the context metadata.
scopedUserStringDelete jobs matching scoped_user in the context metadata.
scopedUserIdStringDelete jobs matching scoped_user_id in the context metadata.
sidekiqDestinationShardRedisStringDelete jobs matching sidekiq_destination_shard_redis in the context metadata.
subscriptionPlanStringDelete jobs matching subscription_plan in the context metadata.
userStringDelete jobs matching user in the context metadata.
userIdStringDelete jobs matching user_id in the context metadata.
workerClassStringDelete jobs with the given worker class.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
resultDeleteJobsResponseInformation about the status of the deletion request.

Mutation.aiAction

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Input type: AiActionInput

Arguments

NameTypeDescription
chatAiChatInputInput for chat AI action.
clientMutationIdStringA unique identifier for the client performing the mutation.
clientSubscriptionIdStringClient generated ID that can be subscribed to, to receive a response for the mutation.
conversationTypeAiConversationsThreadsConversationTypeConversation type of the thread.
explainVulnerabilityAiExplainVulnerabilityInputInput for explain_vulnerability AI action.
generateCommitMessageAiGenerateCommitMessageInputInput for generate_commit_message AI action.
generateCubeQueryAiGenerateCubeQueryInputInput for generate_cube_query AI action.
generateDescriptionAiGenerateDescriptionInputInput for generate_description AI action.
measureCommentTemperatureAiMeasureCommentTemperatureInputInput for measure_comment_temperature AI action.
platformOriginStringSpecifies the origin platform of the request.
projectIdProjectIDGlobal ID of the project the user is acting on.
resolveVulnerabilityAiResolveVulnerabilityInputInput for resolve_vulnerability AI action.
summarizeCommentsAiSummarizeCommentsInputInput for summarize_comments AI action.
summarizeNewMergeRequestAiSummarizeNewMergeRequestInputInput for summarize_new_merge_request AI action.
summarizeReviewAiSummarizeReviewInputInput for summarize_review AI action.
threadIdAiConversationThreadIDGlobal Id of the existing thread to continue the conversation. If it is not specified, a new thread will be created for the specified conversation_type.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
requestIdStringID of the request.
threadIdAiConversationThreadIDGlobal Id of the thread.

Mutation.aiAgentCreate

  • Introduced in GitLab 16.8.
  • Status: Experiment.

Input type: AiAgentCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the agent.
projectPathID!Project to which the agent belongs.
promptString!Prompt for the agent.

Fields

NameTypeDescription
agentAiAgentAgent after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.aiAgentDestroy

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: AiAgentDestroyInput

Arguments

NameTypeDescription
agentIdAiAgentID!Global ID of the AI Agent to be deleted.
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project to which the agent belongs.

Fields

NameTypeDescription
agentAiAgentAgent after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
messageStringAI Agent deletion result message.

Mutation.aiAgentUpdate

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: AiAgentUpdateInput

Arguments

NameTypeDescription
agentIdAiAgentID!ID of the agent.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameStringName of the agent.
projectPathID!Project to which the agent belongs.
promptStringPrompt for the agent.

Fields

NameTypeDescription
agentAiAgentAgent after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.aiFeatureSettingUpdate

Updates or create setting for the AI feature.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: AiFeatureSettingUpdateInput

Arguments

NameTypeDescription
aiSelfHostedModelIdAiSelfHostedModelIDGlobal ID of the self-hosted model provide the AI setting.
clientMutationIdStringA unique identifier for the client performing the mutation.
featureAiFeatures!AI feature being configured.
providerAiFeatureProviders!Provider for AI setting.

Fields

NameTypeDescription
aiFeatureSettingAiFeatureSettingAI feature setting after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.aiSelfHostedModelConnectionCheck

Checks if the AI Gateway can establish a connection with the given model configuration.

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Input type: AiSelfHostedModelConnectionCheckInput

Arguments

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
clientMutationIdStringA unique identifier for the client performing the mutation.
endpointString!Endpoint of the self-hosted model.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
resultCloudConnectorProbeResultSelf-hosted hosted connection check result.

Mutation.aiSelfHostedModelCreate

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: AiSelfHostedModelCreateInput

Arguments

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
clientMutationIdStringA unique identifier for the client performing the mutation.
endpointString!Endpoint of the self-hosted model.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
selfHostedModelAiSelfHostedModelSelf-hosted model after mutation.

Mutation.aiSelfHostedModelDelete

Deletes a self-hosted model.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: AiSelfHostedModelDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAiSelfHostedModelID!Global ID of the self-hosted model to delete.

Fields

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

Mutation.aiSelfHostedModelUpdate

Updates a self-hosted model.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: AiSelfHostedModelUpdateInput

Arguments

NameTypeDescription
apiTokenStringAPI token to access the self-hosted model, if any.
clientMutationIdStringA unique identifier for the client performing the mutation.
endpointString!Endpoint of the self-hosted model.
idAiSelfHostedModelID!Global ID of the self-hosted model to update.
identifierStringIdentifier for 3rd party model provider.
modelAiAcceptedSelfHostedModels!AI model deployed.
nameString!Deployment name of the self-hosted model.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
selfHostedModelAiSelfHostedModelSelf-hosted model after mutation.

Mutation.alertSetAssignees

Input type: AlertSetAssigneesInput

Arguments

NameTypeDescription
assigneeUsernames[String!]!Usernames to assign to the alert. Replaces existing assignees by default.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the alert to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.
projectPathID!Project the alert to mutate is in.

Fields

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

Mutation.alertTodoCreate

Input type: AlertTodoCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.

Fields

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

Mutation.approvalProjectRuleDelete

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: approvalProjectRuleDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idApprovalProjectRuleID!Global ID of the approval project rule to delete.

Fields

NameTypeDescription
approvalRuleApprovalProjectRuleDeleted approval rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.approvalProjectRuleUpdate

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: approvalProjectRuleUpdateInput

Arguments

NameTypeDescription
approvalsRequiredInt!How many approvals are required to satify rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[ID!]List of IDs of Groups that can approval rule.
idApprovalProjectRuleID!Global ID of the approval rule to destroy.
nameString!Name of the approval rule.
userIds[ID!]List of IDs of Users that can approval rule.

Fields

NameTypeDescription
approvalRuleApprovalProjectRuleApproval rule after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.approveDeployment

Input type: ApproveDeploymentInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment to go with the approval.
idDeploymentID!ID of the deployment.
representedAsStringName of the User/Group/Role to use for the approval, when the user belongs to multiple approval rules.
statusDeploymentsApprovalStatus!Status of the approval (either APPROVED or REJECTED).

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
deploymentApprovalDeploymentApprovalDeploymentApproval after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.artifactDestroy

Input type: ArtifactDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiJobArtifactID!ID of the artifact to delete.

Fields

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

Mutation.auditEventsAmazonS3ConfigurationCreate

Input type: AuditEventsAmazonS3ConfigurationCreateInput

Arguments

NameTypeDescription
accessKeyXidString!Access key ID of the Amazon S3 account.
awsRegionString!AWS region where the bucket is created.
bucketNameString!Name of the bucket where the audit events would be logged.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group path.
nameStringDestination name.
secretAccessKeyString!Secret access key of the Amazon S3 account.

Fields

NameTypeDescription
amazonS3ConfigurationAmazonS3ConfigurationTypeconfiguration created.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsAmazonS3ConfigurationDelete

Input type: AuditEventsAmazonS3ConfigurationDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsAmazonS3ConfigurationID!ID of the Amazon S3 configuration to destroy.

Fields

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

Mutation.auditEventsAmazonS3ConfigurationUpdate

Input type: AuditEventsAmazonS3ConfigurationUpdateInput

Arguments

NameTypeDescription
accessKeyXidStringAccess key ID of the Amazon S3 account.
awsRegionStringAWS region where the bucket is created.
bucketNameStringName of the bucket where the audit events would be logged.
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsAmazonS3ConfigurationID!ID of the Amazon S3 configuration to update.
nameStringDestination name.
secretAccessKeyStringSecret access key of the Amazon S3 account.

Fields

NameTypeDescription
amazonS3ConfigurationAmazonS3ConfigurationTypeUpdated Amazon S3 configuration.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.auditEventsGroupDestinationEventsAdd

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: AuditEventsGroupDestinationEventsAddInput

Arguments

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

Fields

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

Mutation.auditEventsGroupDestinationEventsDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: AuditEventsGroupDestinationEventsDeleteInput

Arguments

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

Fields

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

Mutation.auditEventsGroupDestinationNamespaceFilterCreate

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: AuditEventsGroupDestinationNamespaceFilterCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsGroupExternalStreamingDestinationID!Destination ID.
namespacePathStringFull path of the namespace(only project or group).

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
namespaceFilterGroupAuditEventNamespaceFilterNamespace filter created.

Mutation.auditEventsGroupDestinationNamespaceFilterDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: AuditEventsGroupDestinationNamespaceFilterDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceFilterIdAuditEventsGroupNamespaceFilterID!Namespace filter ID.

Fields

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

Mutation.auditEventsInstanceAmazonS3ConfigurationCreate

Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput

Arguments

NameTypeDescription
accessKeyXidString!Access key ID of the Amazon S3 account.
awsRegionString!AWS region where the bucket is created.
bucketNameString!Name of the bucket where the audit events would be logged.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameStringDestination name.
secretAccessKeyString!Secret access key of the Amazon S3 account.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
instanceAmazonS3ConfigurationInstanceAmazonS3ConfigurationTypeCreated instance Amazon S3 configuration.

Mutation.auditEventsInstanceAmazonS3ConfigurationDelete

Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceAmazonS3ConfigurationID!ID of the instance-level Amazon S3 configuration to delete.

Fields

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

Mutation.auditEventsInstanceAmazonS3ConfigurationUpdate

Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput

Arguments

NameTypeDescription
accessKeyXidStringAccess key ID of the Amazon S3 account.
awsRegionStringAWS region where the bucket is created.
bucketNameStringName of the bucket where the audit events would be logged.
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceAmazonS3ConfigurationID!ID of the instance-level Amazon S3 configuration to update.
nameStringDestination name.
secretAccessKeyStringSecret access key of the Amazon S3 account.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
instanceAmazonS3ConfigurationInstanceAmazonS3ConfigurationTypeUpdated instance-level Amazon S3 configuration.

Mutation.auditEventsInstanceDestinationEventsAdd

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: AuditEventsInstanceDestinationEventsAddInput

Arguments

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

Fields

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

Mutation.auditEventsInstanceDestinationEventsDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: AuditEventsInstanceDestinationEventsDeleteInput

Arguments

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

Fields

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

Mutation.auditEventsInstanceDestinationNamespaceFilterCreate

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: AuditEventsInstanceDestinationNamespaceFilterCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsInstanceExternalStreamingDestinationID!Destination ID.
namespacePathStringFull path of the namespace. Project or group namespaces only.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
namespaceFilterInstanceAuditEventNamespaceFilterNamespace filter to be created.

Mutation.auditEventsInstanceDestinationNamespaceFilterDelete

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: AuditEventsInstanceDestinationNamespaceFilterDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceFilterIdAuditEventsInstanceNamespaceFilterID!Namespace filter ID.

Fields

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

Mutation.auditEventsStreamingDestinationEventsAdd

Input type: AuditEventsStreamingDestinationEventsAddInput

Arguments

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

Fields

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

Mutation.auditEventsStreamingDestinationEventsRemove

Input type: AuditEventsStreamingDestinationEventsRemoveInput

Arguments

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

Fields

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

Mutation.auditEventsStreamingDestinationInstanceEventsAdd

Input type: AuditEventsStreamingDestinationInstanceEventsAddInput

Arguments

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

Fields

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

Mutation.auditEventsStreamingDestinationInstanceEventsRemove

Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput

Arguments

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

Fields

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

Mutation.auditEventsStreamingHeadersCreate

Input type: AuditEventsStreamingHeadersCreateInput

Arguments

NameTypeDescription
activeBooleanBoolean option determining whether header is active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsExternalAuditEventDestinationID!Destination to associate header with.
keyString!Header key.
valueString!Header value.

Fields

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

Mutation.auditEventsStreamingHeadersDestroy

Input type: AuditEventsStreamingHeadersDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
headerIdAuditEventsStreamingHeaderID!Header to delete.

Fields

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

Mutation.auditEventsStreamingHeadersUpdate

Input type: AuditEventsStreamingHeadersUpdateInput

Arguments

NameTypeDescription
activeBooleanBoolean option determining whether header is active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
headerIdAuditEventsStreamingHeaderID!Header to update.
keyStringHeader key.
valueStringHeader value.

Fields

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

Mutation.auditEventsStreamingHttpNamespaceFiltersAdd

Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsExternalAuditEventDestinationID!Destination ID.
groupPathIDFull path of the group.
projectPathIDFull path of the project.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
namespaceFilterAuditEventStreamingHTTPNamespaceFilterNamespace filter created.

Mutation.auditEventsStreamingHttpNamespaceFiltersDelete

Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceFilterIdAuditEventsStreamingHTTPNamespaceFilterID!Namespace filter ID.

Fields

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

Mutation.auditEventsStreamingInstanceHeadersCreate

Input type: AuditEventsStreamingInstanceHeadersCreateInput

Arguments

NameTypeDescription
activeBooleanBoolean option determining whether header is active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationIdAuditEventsInstanceExternalAuditEventDestinationID!Instance level external destination to associate header with.
keyString!Header key.
valueString!Header value.

Fields

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

Mutation.auditEventsStreamingInstanceHeadersDestroy

Input type: AuditEventsStreamingInstanceHeadersDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
headerIdAuditEventsStreamingInstanceHeaderID!Header to delete.

Fields

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

Mutation.auditEventsStreamingInstanceHeadersUpdate

Input type: AuditEventsStreamingInstanceHeadersUpdateInput

Arguments

NameTypeDescription
activeBooleanBoolean option determining whether header is active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
headerIdAuditEventsStreamingInstanceHeaderID!Header to update.
keyStringHeader key.
valueStringHeader value.

Fields

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

Mutation.awardEmojiAdd

Input type: AwardEmojiAddInput

Arguments

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Emoji name.

Fields

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.awardEmojiRemove

Input type: AwardEmojiRemoveInput

Arguments

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Emoji name.

Fields

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.awardEmojiToggle

Input type: AwardEmojiToggleInput

Arguments

NameTypeDescription
awardableIdAwardableID!Global ID of the awardable resource.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Emoji name.

Fields

NameTypeDescription
awardEmojiAwardEmojiEmoji reactions after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
toggledOnBoolean!Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.

Mutation.boardEpicCreate

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: BoardEpicCreateInput

Arguments

NameTypeDescription
boardIdBoardsEpicBoardID!Global ID of the board that the epic is in.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group the epic to create is in.
listIdBoardsEpicListID!Global ID of the epic board list in which epic will be created.
titleString!Title of the epic.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after creation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.boardListCreate

Input type: BoardListCreateInput

Arguments

NameTypeDescription
assigneeIdUserIDGlobal ID of an existing user.
backlogBooleanCreate the backlog list.
boardIdBoardID!Global ID of the issue board to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.
iterationIdIterationIDGlobal ID of an existing iteration.
labelIdLabelIDGlobal ID of an existing label.
milestoneIdMilestoneIDGlobal ID of an existing milestone.
positionIntPosition of the list.

Fields

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

Mutation.boardListUpdateLimitMetrics

Input type: BoardListUpdateLimitMetricsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
limitMetricListLimitMetricNew limit metric type for the list.
listIdListID!Global ID of the list.
maxIssueCountIntNew maximum issue count limit.
maxIssueWeightIntNew maximum issue weight limit.

Fields

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

Mutation.branchDelete

Input type: BranchDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the branch.
projectPathID!Project full path the branch is associated with.

Fields

NameTypeDescription
branchBranchBranch after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.branchRuleApprovalProjectRuleCreate

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: branchRuleApprovalProjectRuleCreateInput

Arguments

NameTypeDescription
approvalsRequiredInt!How many approvals are required to satify rule.
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule to destroy.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[ID!]List of IDs of Groups that can approval rule.
nameString!Name of the approval rule.
userIds[ID!]List of IDs of Users that can approval rule.

Fields

NameTypeDescription
approvalRuleApprovalProjectRuleApproval rule after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.branchRuleCreate

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: BranchRuleCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Branch name, with wildcards, for the branch rules.
projectPathID!Full path to the project that the branch is associated with.

Fields

NameTypeDescription
branchRuleBranchRuleBranch rule after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.branchRuleDelete

  • Introduced in GitLab 16.9.
  • Status: Experiment.

Input type: BranchRuleDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectsBranchRuleID!Global ID of the branch rule to destroy.

Fields

NameTypeDescription
branchRuleBranchRuleBranch rule after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.branchRuleExternalStatusCheckCreate

Create a new external status check from a branch rule.

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: BranchRuleExternalStatusCheckCreateInput

Arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule to update.
clientMutationIdStringA unique identifier for the client performing the mutation.
externalUrlString!URL of external status check resource.
nameString!Name of the external status check.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalStatusCheckExternalStatusCheckNew status check after mutation.

Mutation.branchRuleExternalStatusCheckDestroy

Destroy an external status check from a branch rule.

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: BranchRuleExternalStatusCheckDestroyInput

Arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
idMergeRequestsExternalStatusCheckID!Global ID of the external status check to destroy.

Fields

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

Mutation.branchRuleExternalStatusCheckUpdate

Update an external status check from a branch rule.

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: BranchRuleExternalStatusCheckUpdateInput

Arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
externalUrlString!External URL of the external status check.
idMergeRequestsExternalStatusCheckID!Global ID of the external status check to update.
nameString!Name of the external status check.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalStatusCheckExternalStatusCheckUpdated external status check after mutation.

Mutation.branchRuleSquashOptionDelete

Delete a squash option for a branch rule.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: BranchRuleSquashOptionDeleteInput

Arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields

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

Mutation.branchRuleSquashOptionUpdate

Update a squash option for a branch rule.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: BranchRuleSquashOptionUpdateInput

Arguments

NameTypeDescription
branchRuleIdProjectsBranchRuleID!Global ID of the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
squashOptionSquashOptionSetting!Squash option after mutation.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
squashOptionSquashOptionUpdated squash option after mutation.

Mutation.branchRuleUpdate

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: BranchRuleUpdateInput

Arguments

NameTypeDescription
branchProtectionBranchProtectionInputBranch protections configured for the branch rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectsBranchRuleID!Global ID of the branch rule to update.
nameString!Branch name, with wildcards, for the branch rules.

Fields

NameTypeDescription
branchRuleBranchRuleBranch rule after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.bulkDestroyJobArtifacts

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Input type: BulkDestroyJobArtifactsInput

Arguments

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

Fields

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

Mutation.bulkEnableDevopsAdoptionNamespaces

Status: Beta.

Input type: BulkEnableDevopsAdoptionNamespacesInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displayNamespaceIdNamespaceIDDisplay namespace ID.
namespaceIds[NamespaceID!]!List of Namespace IDs.

Fields

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

Mutation.bulkRunnerDelete

  • Introduced in GitLab 15.3.
  • Status: Experiment.

Input type: BulkRunnerDeleteInput

Arguments

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

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
deletedCountIntNumber of records effectively deleted. Only present if operation was performed synchronously.
deletedIds[CiRunnerID!]IDs of records effectively deleted. Only present if operation was performed synchronously.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.catalogResourcesCreate

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Input type: CatalogResourcesCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project path belonging to the catalog resource.

Fields

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

Mutation.catalogResourcesDestroy

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Input type: CatalogResourcesDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project path belonging to the catalog resource.

Fields

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

Mutation.ciJobTokenScopeAddGroupOrProject

Input type: CiJobTokenScopeAddGroupOrProjectInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultPermissions warning-solidBooleanDeprecated: Status: Experiment. Introduced in GitLab 17.8.
jobTokenPolicies warning-solid[CiJobTokenScopePolicies!]Deprecated: Status: Experiment. Introduced in GitLab 17.5.
projectPathID!Project that the CI job token scope belongs to.
targetPathID!Group or project to be added to the CI job token scope.

Fields

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryDeprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeAddProject

Input type: CiJobTokenScopeAddProjectInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
direction warning-solidCiJobTokenScopeDirectionDeprecated: Outbound job token scope is being removed. This field can now only be set to INBOUND. Deprecated in GitLab 16.0.
projectPathID!Project that the CI job token scope belongs to.
targetProjectPathID!Project to be added to the CI job token scope.

Fields

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryDeprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeAutopopulateAllowlist

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: CiJobTokenScopeAutopopulateAllowlistInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project in which to autopopulate the allowlist.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
statusString!Status of the autopopulation process.

Mutation.ciJobTokenScopeClearAllowlistAutopopulations

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: CiJobTokenScopeClearAllowlistAutopopulationsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project in which to autopopulate the allowlist.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
statusString!Status of the autopopulation process.

Mutation.ciJobTokenScopeRemoveGroup

Input type: CiJobTokenScopeRemoveGroupInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project that the CI job token scope belongs to.
targetGroupPathID!Group to be removed from the CI job token scope.

Fields

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryDeprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeRemoveProject

Input type: CiJobTokenScopeRemoveProjectInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
direction warning-solidCiJobTokenScopeDirectionDeprecated: Outbound job token scope is being removed. This field can now only be set to INBOUND. Deprecated in GitLab 16.9.
projectPathID!Project that the CI job token scope belongs to.
targetProjectPathID!Project to be removed from the CI job token scope.

Fields

NameTypeDescription
ciJobTokenScopeCiJobTokenScopeTypeCI job token’s access scope.
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryDeprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeUpdatePolicies

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Input type: CiJobTokenScopeUpdatePoliciesInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultPermissionsBoolean!Indicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
jobTokenPolicies[CiJobTokenScopePolicies!]!List of policies added to the CI job token scope.
projectPathID!Project that the CI job token scope belongs to.
targetPathID!Group or project that the CI job token targets.

Fields

NameTypeDescription
ciJobTokenScopeAllowlistEntry warning-solidCiJobTokenScopeAllowlistEntryDeprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.clusterAgentDelete

Input type: ClusterAgentDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idClustersAgentID!Global ID of the cluster agent that will be deleted.

Fields

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

Mutation.clusterAgentTokenCreate

Input type: ClusterAgentTokenCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!Global ID of the cluster agent that will be associated with the new token.
descriptionStringDescription of the token.
nameString!Name of the token.

Fields

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

Mutation.clusterAgentTokenRevoke

Input type: ClusterAgentTokenRevokeInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idClustersAgentTokenID!Global ID of the agent token that will be revoked.

Fields

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

Mutation.clusterAgentUrlConfigurationCreate

Input type: ClusterAgentUrlConfigurationCreateInput

Arguments

NameTypeDescription
caCertStringBase64-encoded CA certificate in PEM format to verify the agent endpoint.
clientCertStringBase64-encoded client certificate in PEM format if mTLS authentication should be used. Must be provided with client_key.
clientKeyStringBase64-encoded client key in PEM format if mTLS authentication should be used. Must be provided with client_cert.
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!Global ID of the cluster agent that will be associated with the new URL configuration.
tlsHostStringTLS host name to verify the server name in agent endpoint certificate.
urlString!URL for the new URL configuration.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
urlConfigurationClusterAgentUrlConfigurationURL configuration created after mutation.

Mutation.clusterAgentUrlConfigurationDelete

Input type: ClusterAgentUrlConfigurationDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idClustersAgentsUrlConfigurationID!Global ID of the agent URL configuration that will be deleted.

Fields

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

Mutation.commitCreate

Input type: CommitCreateInput

Arguments

NameTypeDescription
actions[CommitAction!]!Array of action hashes to commit as a batch.
branchString!Name of the branch to commit into, it can be a new branch.
clientMutationIdStringA unique identifier for the client performing the mutation.
messageString!Raw commit message.
projectPathID!Project full path the branch is associated with.
startBranchStringIf on a new branch, name of the original branch.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commitCommitCommit after mutation.
commitPipelinePathStringETag path for the commit’s pipeline.
content[String!]Contents of the commit.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.configureContainerScanning

Configure Container Scanning for a project by enabling Container Scanning in a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a merge request are part of the response.

Input type: ConfigureContainerScanningInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields

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

Mutation.configureDependencyScanning

Configure Dependency Scanning for a project by enabling Dependency Scanning in a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a Merge Request are a part of the response.

Input type: ConfigureDependencyScanningInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields

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

Mutation.configureSast

Configure SAST for a project by enabling SAST in a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a Merge Request are a part of the response.

Input type: ConfigureSastInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
configurationSastCiConfigurationInput!SAST CI configuration for the project.
projectPathID!Full path of the project.

Fields

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

Mutation.configureSastIac

Enable SAST IaC for a project in a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a merge request are a part of the response.

Input type: ConfigureSastIacInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields

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

Mutation.configureSecretDetection

Configure Secret Detection for a project by enabling Secret Detection in a new or modified .gitlab-ci.yml file in a new branch. The new branch and a URL to create a Merge Request are a part of the response.

Input type: ConfigureSecretDetectionInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields

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

Mutation.corpusCreate

Input type: CorpusCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Project the corpus belongs to.
packageIdPackagesPackageID!ID of the corpus package.

Fields

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

Mutation.createAbuseReportNote

Creates an abuse report Note.

Input type: CreateAbuseReportNoteInput

Arguments

NameTypeDescription
abuseReportIdAbuseReportID!ID of the abuse report.
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
discussionIdDiscussionIDGlobal ID of the abuse report discussion the note is in reply to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteAbuseReportNoteAbuse report note after mutation.

Mutation.createAlertIssue

Input type: CreateAlertIssueInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.

Fields

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

Mutation.createAnnotation

  • Deprecated in GitLab 16.0.
  • Underlying feature was removed in 16.0.

Input type: CreateAnnotationInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterIdClustersClusterIDGlobal ID of the cluster to add an annotation to.
dashboardPathString!Path to a file defining the dashboard on which the annotation should be added.
descriptionString!Description of the annotation.
endingAtTimeTimestamp indicating ending moment to which the annotation relates.
environmentIdEnvironmentIDGlobal ID of the environment to add an annotation to.
startingAtTime!Timestamp indicating starting moment to which the annotation relates.

Fields

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

Mutation.createBoard

Input type: CreateBoardInput

Arguments

NameTypeDescription
assigneeIdUserIDID of user to be assigned to the board.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathIDFull path of the group with which the resource is associated.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
iterationCadenceIdIterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationIdIterationIDID of iteration to be assigned to the board.
labelIds[LabelID!]IDs of labels to be added to the board.
labels[String!]Labels of the issue.
milestoneIdMilestoneIDID of milestone to be assigned to the board.
nameStringBoard name.
projectPathIDFull path of the project with which the resource is associated.
weightIntWeight value to be assigned to the board.

Fields

NameTypeDescription
boardBoardBoard after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.createBranch

Input type: CreateBranchInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the branch.
projectPathID!Project full path the branch is associated with.
refString!Branch name or commit SHA to create branch from.

Fields

NameTypeDescription
branchBranchBranch after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.createClusterAgent

Input type: CreateClusterAgentInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the cluster agent.
projectPathID!Full path of the associated project for the cluster agent.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentClusterAgentCluster agent created after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.createComplianceFramework

Input type: CreateComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Full path of the namespace to add the compliance framework to.
paramsComplianceFrameworkInput!Parameters to update the compliance framework with.

Fields

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

Mutation.createComplianceRequirement

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Input type: CreateComplianceRequirementInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceFrameworkIdComplianceManagementFrameworkID!Global ID of the compliance framework of the new requirement.
paramsComplianceRequirementInput!Parameters to update the compliance requirement with.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
requirementComplianceRequirementCreated compliance requirement.

Mutation.createComplianceRequirementsControl

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: CreateComplianceRequirementsControlInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceRequirementIdComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement of the new control.
paramsComplianceRequirementsControlInput!Parameters to create the compliance requirement control.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
requirementsControlComplianceRequirementsControlCreated compliance requirements control.

Mutation.createContainerProtectionRepositoryRule

Creates a repository protection rule to restrict access to a project’s container registry.

Input type: CreateContainerProtectionRepositoryRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
minimumAccessLevelForDeleteContainerProtectionRepositoryRuleAccessLevelMinimum 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.
minimumAccessLevelForPushContainerProtectionRepositoryRuleAccessLevelMinimum 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.
projectPathID!Full path of the project where a protection rule is located.
repositoryPathPatternString!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.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionRepositoryRuleContainerProtectionRepositoryRuleContainer repository protection rule after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.createContainerProtectionTagRule

Creates a protection rule to control which user roles can modify container image tags matching a specified pattern. Available only when feature flag container_registry_protected_tags is enabled.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Input type: createContainerProtectionTagRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
minimumAccessLevelForDeleteContainerProtectionTagRuleAccessLevelMinimum 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 minimum access level is enforced. Users with the Developer role or higher can delete tags by default. Introduced in GitLab 17.8: Status: Experiment.
minimumAccessLevelForPushContainerProtectionTagRuleAccessLevelMinimum 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 minimum access level is enforced. Users with the Developer role or higher can push tags by default. Introduced in GitLab 17.8: Status: Experiment.
projectPathID!Full path of the project containing the container image tags.
tagNamePatternString!The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed. Introduced in GitLab 17.8: Status: Experiment.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionTagRule warning-solidContainerProtectionTagRuleDeprecated: Status: Experiment. Introduced in GitLab 17.8.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.createCustomEmoji

Input type: CreateCustomEmojiInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Namespace full path the emoji is associated with.
nameString!Name of the emoji.
urlString!Location of the emoji file.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customEmojiCustomEmojiNew custom emoji.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.createDiffNote

Input type: CreateDiffNoteInput

Arguments

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
internalBooleanInternal flag for a note. Default is false.
noteableIdNoteableID!Global ID of the resource to add a note to.
positionDiffPositionInput!Position of the note on a diff.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createDiscussion

Input type: CreateDiscussionInput

Arguments

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
internalBooleanInternal flag for a note. Default is false.
noteableIdNoteableID!Global ID of the resource to add a note to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createEpic

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: CreateEpicInput

Arguments

NameTypeDescription
addLabelIds[ID!]IDs of labels to be added to the epic.
addLabels[String!]Array of labels to be added to the epic.
clientMutationIdStringA unique identifier for the client performing the mutation.
colorColorColor of the epic.
confidentialBooleanIndicates if the epic is confidential.
descriptionStringDescription of the epic.
dueDateFixedStringEnd date of the epic.
dueDateIsFixedBooleanIndicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPathID!Group the epic to mutate is in.
removeLabelIds[ID!]IDs of labels to be removed from the epic.
startDateFixedStringStart date of the epic.
startDateIsFixedBooleanIndicates start date should be sourced from start_date_fixed field not the issue milestones.
titleStringTitle of the epic.

Fields

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

Mutation.createImageDiffNote

Input type: CreateImageDiffNoteInput

Arguments

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
internalBooleanInternal flag for a note. Default is false.
noteableIdNoteableID!Global ID of the resource to add a note to.
positionDiffImagePositionInput!Position of the note on a diff.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createIssue

Input type: CreateIssueInput

Arguments

NameTypeDescription
assigneeIds[UserID!]Array of user IDs to assign to the issue.
clientMutationIdStringA unique identifier for the client performing the mutation.
confidentialBooleanIndicates the issue is confidential.
createdAtTimeTimestamp when the issue was created. Available only for admins and project owners.
descriptionStringDescription of the issue.
discussionToResolveStringID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of.
dueDateISO8601DateDue date of the issue.
epicId warning-solidEpicIDDeprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
healthStatusHealthStatusDesired health status.
iidIntIID (internal ID) of a project issue. Only admins and project owners can modify.
iterationCadenceIdIterationsCadenceIDGlobal iteration cadence ID. Required when iterationWildcardId is provided.
iterationIdIterationIDGlobal iteration ID. Mutually exlusive argument with iterationWildcardId.
iterationWildcardIdIssueCreationIterationWildcardIdIteration wildcard ID. Supported values are: CURRENT. Mutually exclusive argument with iterationId. iterationCadenceId also required when this argument is provided.
labelIds[LabelID!]IDs of labels to be added to the issue.
labels[String!]Labels of the issue.
lockedBooleanIndicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOfMergeRequestIDIID of a merge request for which to resolve discussions.
milestoneIdMilestoneIDID of the milestone to assign to the issue. On update milestone will be removed if set to null.
moveAfterIdIssueIDGlobal ID of issue that should be placed after the current issue.
moveBeforeIdIssueIDGlobal ID of issue that should be placed before the current issue.
projectPathID!Project full path the issue is associated with.
titleString!Title of the issue.
typeIssueTypeType of the issue.
weightIntWeight of the issue.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.createIteration

  • Deprecated in GitLab 14.0.
  • Use iterationCreate.

Input type: CreateIterationInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathIDFull path of the group with which the resource is associated.
iterationsCadenceIdIterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPathIDFull path of the project with which the resource is associated.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

Fields

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

Mutation.createNote

Creates a Note. If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.

Input type: CreateNoteInput

Arguments

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
discussionIdDiscussionIDGlobal ID of the discussion the note is in reply to.
internalBooleanInternal flag for a note. Default is false.
mergeRequestDiffHeadShaStringSHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent.
noteableIdNoteableID!Global ID of the resource to add a note to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.createPackagesProtectionRule

Creates a protection rule to restrict access to project packages.

Input type: CreatePackagesProtectionRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
minimumAccessLevelForPushPackagesProtectionRuleAccessLevel!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.
packageNamePatternString!Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageTypePackagesProtectionRulePackageType!Package type protected by the protection rule. For example, NPM, PYPI.
projectPathID!Full path of the project where a protection rule is located.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule after mutation.

Mutation.createRequirement

Input type: CreateRequirementInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the requirement.
projectPathID!Full project path the requirement is associated with.
titleStringTitle of the requirement.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
requirementRequirementRequirement after mutation.

Mutation.createSnippet

Input type: CreateSnippetInput

Arguments

NameTypeDescription
blobActions[SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the snippet.
projectPathIDFull path of the project the snippet is associated with.
titleString!Title of the snippet.
uploadedFiles[String!]Paths to files uploaded in the snippet description.
visibilityLevelVisibilityLevelsEnum!Visibility level of the snippet.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
snippetSnippetSnippet after mutation.

Mutation.createTestCase

Input type: CreateTestCaseInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
confidentialBooleanSets the test case confidentiality.
descriptionStringTest case description.
labelIds[ID!]IDs of labels to be added to the test case.
projectPathID!Project full path to create the test case in.
titleString!Test case title.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
testCaseIssueTest case created.

Mutation.customFieldArchive

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: CustomFieldArchiveInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIssuablesCustomFieldID!Global ID of the custom field.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customFieldCustomFieldArchived custom field.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.customFieldCreate

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Input type: CustomFieldCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fieldTypeCustomFieldType!Type of custom field.
groupPathID!Group path where the custom field is created.
nameString!Name of the custom field.
selectOptions[CustomFieldSelectOptionInput!]Available options for a select field.
workItemTypeIds[WorkItemsTypeID!]Work item type global IDs associated to the custom field.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customFieldCustomFieldCreated custom field.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.customFieldUnarchive

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: CustomFieldUnarchiveInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIssuablesCustomFieldID!Global ID of the custom field.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customFieldCustomFieldUnarchived custom field.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.customFieldUpdate

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Input type: CustomFieldUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIssuablesCustomFieldID!Global ID of the custom field.
nameStringName of the custom field.
selectOptions[CustomFieldSelectOptionInput!]Available options for a select field.
workItemTypeIds[WorkItemsTypeID!]Work item type global IDs associated to the custom field.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customFieldCustomFieldUpdated custom field.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.customerRelationsContactCreate

Input type: CustomerRelationsContactCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of or notes for the contact.
emailStringEmail address of the contact.
firstNameString!First name of the contact.
groupIdGroupID!Group for the contact.
lastNameString!Last name of the contact.
organizationIdCustomerRelationsOrganizationIDOrganization for the contact.
phoneStringPhone number of the contact.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contactCustomerRelationsContactContact after the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.customerRelationsContactUpdate

Input type: CustomerRelationsContactUpdateInput

Arguments

NameTypeDescription
activeBooleanState of the contact.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of or notes for the contact.
emailStringEmail address of the contact.
firstNameStringFirst name of the contact.
idCustomerRelationsContactID!Global ID of the contact.
lastNameStringLast name of the contact.
organizationIdCustomerRelationsOrganizationIDOrganization of the contact.
phoneStringPhone number of the contact.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contactCustomerRelationsContactContact after the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.customerRelationsOrganizationCreate

Input type: CustomerRelationsOrganizationCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultRateFloatStandard billing rate for the organization.
descriptionStringDescription of or notes for the organization.
groupIdGroupID!Group for the organization.
nameString!Name of the organization.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
organizationCustomerRelationsOrganizationOrganization after the mutation.

Mutation.customerRelationsOrganizationUpdate

Input type: CustomerRelationsOrganizationUpdateInput

Arguments

NameTypeDescription
activeBooleanState of the organization.
clientMutationIdStringA unique identifier for the client performing the mutation.
defaultRateFloatStandard billing rate for the organization.
descriptionStringDescription of or notes for the organization.
idCustomerRelationsOrganizationID!Global ID of the organization.
nameStringName of the organization.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
organizationCustomerRelationsOrganization!Organization after the mutation.

Mutation.dastOnDemandScanCreate

Input type: DastOnDemandScanCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastScannerProfileIdDastScannerProfileIDID of the scanner profile to be used for the scan.
dastSiteProfileIdDastSiteProfileID!ID of the site profile to be used for the scan.
fullPathID!Project the site profile belongs to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelineUrlStringURL of the pipeline that was created.

Mutation.dastProfileCreate

Input type: DastProfileCreateInput

Arguments

NameTypeDescription
branchNameStringAssociated branch.
clientMutationIdStringA unique identifier for the client performing the mutation.
dastProfileScheduleDastProfileScheduleInputRepresents a DAST Profile Schedule.
dastScannerProfileIdDastScannerProfileID!ID of the scanner profile to be associated.
dastSiteProfileIdDastSiteProfileID!ID of the site profile to be associated.
descriptionStringDescription of the profile. Defaults to an empty string.
fullPathID!Project the profile belongs to.
nameString!Name of the profile.
runAfterCreateBooleanRun scan using profile after creation. Defaults to false.
tagList[String!]Indicates the runner tags associated with the profile.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastProfileDastProfileCreated profile.
errors[String!]!Errors encountered during execution of the mutation.
pipelineUrlStringURL of the pipeline that was created. Requires runAfterCreate to be set to true.

Mutation.dastProfileDelete

Input type: DastProfileDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idDastProfileID!ID of the profile to be deleted.

Fields

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

Mutation.dastProfileRun

Input type: DastProfileRunInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPath warning-solidIDDeprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
idDastProfileID!ID of the profile to be used for the scan.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelineUrlStringURL of the pipeline that was created.

Mutation.dastProfileUpdate

Input type: DastProfileUpdateInput

Arguments

NameTypeDescription
branchNameStringAssociated branch.
clientMutationIdStringA unique identifier for the client performing the mutation.
dastProfileScheduleDastProfileScheduleInputRepresents a DAST profile schedule.
dastScannerProfileIdDastScannerProfileIDID of the scanner profile to be associated.
dastSiteProfileIdDastSiteProfileIDID of the site profile to be associated.
descriptionStringDescription of the profile. Defaults to an empty string.
fullPath warning-solidIDDeprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
idDastProfileID!ID of the profile to be deleted.
nameStringName of the profile.
runAfterUpdateBooleanRun scan using profile after update. Defaults to false.
tagList[String!]Indicates the runner tags associated with the profile.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastProfileDastProfileUpdated profile.
errors[String!]!Errors encountered during execution of the mutation.
pipelineUrlStringThe URL of the pipeline that was created. Requires the input argument runAfterUpdate to be set to true when calling the mutation, otherwise no pipeline will be created.

Mutation.dastScannerProfileCreate

Input type: DastScannerProfileCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Project the scanner profile belongs to.
profileNameString!Name of the scanner profile.
scanTypeDastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessagesBooleanIndicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeoutIntMaximum number of minutes allowed for the spider to traverse the site.
tagList warning-solid[String!]Deprecated: Moved to DastProfile. Deprecated in GitLab 15.8.
targetTimeoutIntMaximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpiderBooleanIndicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastScannerProfileDastScannerProfileCreated scanner profile.
errors[String!]!Errors encountered during execution of the mutation.
id warning-solidDastScannerProfileIDDeprecated: use dastScannerProfile field. Deprecated in GitLab 14.10.

Mutation.dastScannerProfileDelete

Input type: DastScannerProfileDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPath warning-solidIDDeprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
idDastScannerProfileID!ID of the scanner profile to be deleted.

Fields

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

Mutation.dastScannerProfileUpdate

Input type: DastScannerProfileUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPath warning-solidIDDeprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
idDastScannerProfileID!ID of the scanner profile to be updated.
profileNameString!Name of the scanner profile.
scanTypeDastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessagesBooleanIndicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeoutInt!Maximum number of minutes allowed for the spider to traverse the site.
tagList warning-solid[String!]Deprecated: Moved to DastProfile. Deprecated in GitLab 15.8.
targetTimeoutInt!Maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpiderBooleanIndicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastScannerProfileDastScannerProfileUpdated scanner profile.
errors[String!]!Errors encountered during execution of the mutation.
id warning-solidDastScannerProfileIDDeprecated: use dastScannerProfile field. Deprecated in GitLab 14.10.

Mutation.dastSiteProfileCreate

Input type: DastSiteProfileCreateInput

Arguments

NameTypeDescription
authDastSiteProfileAuthInputParameters for authentication.
clientMutationIdStringA unique identifier for the client performing the mutation.
excludedUrls[String!]URLs to skip during an authenticated scan. Defaults to [].
fullPathID!Project the site profile belongs to.
optionalVariables[JSON!]Optional variables that can be configured for DAST scans.
profileNameString!Name of the site profile.
requestHeadersStringComma-separated list of request header names and values to be added to every request made by DAST.
scanFilePathStringFile Path or URL used as input for the scan method.
scanMethodDastScanMethodTypeScan method by the scanner.
targetTypeDastTargetTypeEnumType of target to be scanned.
targetUrlStringURL of the target to be scanned.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastSiteProfileDastSiteProfileSite Profile object.
errors[String!]!Errors encountered during execution of the mutation.
id warning-solidDastSiteProfileIDDeprecated: use dastSiteProfile.id field. Deprecated in GitLab 14.10.

Mutation.dastSiteProfileDelete

Input type: DastSiteProfileDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPath warning-solidIDDeprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
idDastSiteProfileID!ID of the site profile to be deleted.

Fields

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

Mutation.dastSiteProfileUpdate

Input type: DastSiteProfileUpdateInput

Arguments

NameTypeDescription
authDastSiteProfileAuthInputParameters for authentication.
clientMutationIdStringA unique identifier for the client performing the mutation.
excludedUrls[String!]URLs to skip during an authenticated scan.
fullPath warning-solidIDDeprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
idDastSiteProfileID!ID of the site profile to be updated.
optionalVariables[JSON!]Optional variables that can be configured for DAST scans.
profileNameString!Name of the site profile.
requestHeadersStringComma-separated list of request header names and values to be added to every request made by DAST.
scanFilePathStringFile Path or URL used as input for the scan method.
scanMethodDastScanMethodTypeScan method by the scanner.
targetTypeDastTargetTypeEnumType of target to be scanned.
targetUrlStringURL of the target to be scanned.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastSiteProfileDastSiteProfileSite profile object.
errors[String!]!Errors encountered during execution of the mutation.
id warning-solidDastSiteProfileIDDeprecated: use dastSiteProfile.id field. Deprecated in GitLab 14.10.

Mutation.dastSiteTokenCreate

Input type: DastSiteTokenCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Project the site token belongs to.
targetUrlStringURL of the target to be validated.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
idDastSiteTokenIDID of the site token.
statusDastSiteProfileValidationStatusEnumCurrent validation status of the target.
tokenStringToken string.

Mutation.dastSiteValidationCreate

Input type: DastSiteValidationCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dastSiteTokenIdDastSiteTokenID!ID of the site token.
fullPathID!Project the site profile belongs to.
strategyDastSiteValidationStrategyEnumValidation strategy to be used.
validationPathString!Path to be requested during validation.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
idDastSiteValidationIDID of the site validation.
statusDastSiteProfileValidationStatusEnumCurrent validation status.

Mutation.dastSiteValidationRevoke

Input type: DastSiteValidationRevokeInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Project the site validation belongs to.
normalizedTargetUrlString!Normalized URL of the target to be revoked.

Fields

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

Mutation.deleteAnnotation

  • Deprecated in GitLab 16.0.
  • Underlying feature was removed in 16.0.

Input type: DeleteAnnotationInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idString!Global ID of the annotation to delete.

Fields

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

Mutation.deleteContainerProtectionRepositoryRule

Deletes a container repository protection rule.

Input type: DeleteContainerProtectionRepositoryRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRegistryProtectionRuleID!Global ID of the container repository protection rule to delete.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionRepositoryRuleContainerProtectionRepositoryRuleContainer repository protection rule that was deleted successfully.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.deleteContainerProtectionTagRule

Deletes a protection rule that controls which user roles can modify container image tags matching a specified pattern. Available only when feature flag container_registry_protected_tags is enabled.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Input type: DeleteContainerProtectionTagRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRegistryProtectionTagRuleID!Global ID of the tag protection rule to delete.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionTagRule warning-solidContainerProtectionTagRuleDeprecated: Status: Experiment. Introduced in GitLab 17.8.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.deleteConversationThread

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: DeleteConversationThreadInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
threadIdAiConversationThreadID!Global ID of the thread to delete.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!List of errors that occurred whilst trying to delete the thread.
successBoolean!Returns true if thread was successfully deleted.

Mutation.deletePackagesProtectionRule

Deletes a protection rule for packages.

Input type: DeletePackagesProtectionRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPackagesProtectionRuleID!Global ID of the package protection rule to delete.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule that was deleted successfully.

Mutation.deletePagesDeployment

Deletes a Pages deployment.

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: DeletePagesDeploymentInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPagesDeploymentID!ID of the Pages Deployment.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pagesDeploymentPagesDeployment!Deleted Pages Deployment.

Mutation.designManagementDelete

Input type: DesignManagementDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
filenames[String!]!Filenames of the designs to delete.
iidID!IID of the issue to modify designs for.
projectPathID!Project where the issue is to upload designs for.

Fields

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

Mutation.designManagementMove

Input type: DesignManagementMoveInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idDesignManagementDesignID!ID of the design to move.
nextDesignManagementDesignIDID of the immediately following design.
previousDesignManagementDesignIDID of the immediately preceding design.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
designCollectionDesignCollectionCurrent state of the collection.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.designManagementUpdate

Input type: DesignManagementUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the design.
idDesignManagementDesignID!ID of the design to update.

Fields

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

Mutation.designManagementUpload

Input type: DesignManagementUploadInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
files[Upload!]!Files to upload.
iidID!IID of the issue to modify designs for.
projectPathID!Project where the issue is to upload designs for.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
designs[Design!]!Designs that were uploaded by the mutation.
errors[String!]!Errors encountered during execution of the mutation.
skippedDesigns[Design!]!Any designs that were skipped from the upload due to there being no change to their content since their last version.

Mutation.destroyBoard

Input type: DestroyBoardInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idBoardID!Global ID of the board to destroy.

Fields

NameTypeDescription
boardBoardBoard after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.destroyBoardList

Input type: DestroyBoardListInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
listIdListID!Global ID of the list to destroy. Only label lists are accepted.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
listBoardListList after mutation.

Mutation.destroyComplianceFramework

Input type: DestroyComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementFrameworkID!Global ID of the compliance framework to destroy.

Fields

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

Mutation.destroyComplianceRequirement

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Input type: DestroyComplianceRequirementInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement to destroy.

Fields

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

Mutation.destroyContainerRepository

Input type: DestroyContainerRepositoryInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRepositoryID!ID of the container repository.

Fields

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

Mutation.destroyContainerRepositoryTags

Input type: DestroyContainerRepositoryTagsInput

Arguments

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

Fields

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

Mutation.destroyCustomEmoji

Input type: DestroyCustomEmojiInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCustomEmojiID!Global ID of the custom emoji to destroy.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
customEmojiCustomEmojiDeleted custom emoji.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.destroyEpicBoard

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: DestroyEpicBoardInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idBoardsEpicBoardID!Global ID of the board to destroy.

Fields

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

Mutation.destroyNote

Input type: DestroyNoteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idNoteID!Global ID of the note to destroy.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.destroyPackage

Input type: DestroyPackageInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPackagesPackageID!ID of the Package.

Fields

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

Mutation.destroyPackageFile

Input type: DestroyPackageFileInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPackagesPackageFileID!ID of the Package file.

Fields

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

Mutation.destroyPackageFiles

Input type: DestroyPackageFilesInput

Arguments

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

Fields

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

Mutation.destroyPackages

Input type: DestroyPackagesInput

Arguments

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

Fields

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

Mutation.destroySnippet

Input type: DestroySnippetInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSnippetID!Global ID of the snippet to destroy.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
snippetSnippetSnippet after mutation.

Mutation.disableDevopsAdoptionNamespace

Status: Beta.

Input type: DisableDevopsAdoptionNamespaceInput

Arguments

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

Fields

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

Mutation.discussionToggleResolve

Toggles the resolved state of a discussion.

Input type: DiscussionToggleResolveInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idDiscussionID!Global ID of the discussion.
resolveBoolean!Will resolve the discussion when true, and unresolve the discussion when false.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
discussionDiscussionDiscussion after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.duoSettingsUpdate

Updates GitLab Duo settings.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: DuoSettingsUpdateInput

Arguments

NameTypeDescription
aiGatewayUrlStringURL for local AI gateway server.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields

NameTypeDescription
aiGatewayUrlStringURL for local AI gateway server.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.duoUserFeedback

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: DuoUserFeedbackInput

Arguments

NameTypeDescription
agentVersionIdAiAgentVersionIDGlobal ID of the agent to answer the chat.
aiMessageIdString!ID of the AI Message.
clientMutationIdStringA unique identifier for the client performing the mutation.
trackingEventTrackingEventInputTracking event data.

Fields

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

Mutation.echoCreate

A mutation that does not perform any changes.

This is expected to be used for testing of endpoints, to verify that a user has mutation access.

Input type: EchoCreateInput

Arguments

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

Fields

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

Mutation.enableDevopsAdoptionNamespace

Status: Beta.

Input type: EnableDevopsAdoptionNamespaceInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displayNamespaceIdNamespaceIDDisplay namespace ID.
namespaceIdNamespaceID!Namespace ID.

Fields

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

Mutation.environmentCreate

Create an environment.

Input type: EnvironmentCreateInput

Arguments

NameTypeDescription
autoStopSettingAutoStopSettingAuto stop setting of the environment.
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentIDCluster agent of the environment.
descriptionStringDescription of the environment.
externalUrlStringExternal URL of the environment.
fluxResourcePathStringFlux resource path of the environment.
kubernetesNamespaceStringKubernetes namespace of the environment.
nameString!Name of the environment.
projectPathID!Full path of the project.
tierDeploymentTierTier of the environment.

Fields

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

Mutation.environmentDelete

Delete an environment.

Input type: EnvironmentDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idEnvironmentID!Global ID of the environment to Delete.

Fields

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

Mutation.environmentStop

Stop an environment.

Input type: EnvironmentStopInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
forceBooleanForce environment to stop without executing on_stop actions.
idEnvironmentID!Global ID of the environment to stop.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentEnvironmentEnvironment after attempt to stop.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.environmentUpdate

Update an environment.

Input type: EnvironmentUpdateInput

Arguments

NameTypeDescription
autoStopSettingAutoStopSettingAuto stop setting of the environment.
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentIDCluster agent of the environment.
descriptionStringDescription of the environment.
externalUrlStringExternal URL of the environment.
fluxResourcePathStringFlux resource path of the environment.
idEnvironmentID!Global ID of the environment to update.
kubernetesNamespaceStringKubernetes namespace of the environment.
tierDeploymentTierTier of the environment.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
environmentEnvironmentEnvironment after attempt to update.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.environmentsCanaryIngressUpdate

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

Input type: EnvironmentsCanaryIngressUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idEnvironmentID!Global ID of the environment to update.
weightInt!Weight of the Canary Ingress.

Fields

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

Mutation.epicAddIssue

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicAddIssueInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group the epic to mutate belongs to.
iidID!IID of the epic to mutate.
issueIidString!IID of the issue to be added.
projectPathID!Full path of the project the issue belongs to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after mutation.
epicIssueEpicIssueEpic-issue relationship.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.epicBoardCreate

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicBoardCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displayColorsBooleanWhether or not display epic colors.
groupPathIDFull path of the group with which the resource is associated.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
labelIds[LabelID!]IDs of labels to be added to the board.
labels[String!]Labels of the issue.
nameStringBoard name.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicBoardEpicBoardCreated epic board.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.epicBoardListCreate

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicBoardListCreateInput

Arguments

NameTypeDescription
backlogBooleanCreate the backlog list.
boardIdBoardsEpicBoardID!Global ID of the issue board to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.
labelIdLabelIDGlobal ID of an existing label.

Fields

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

Mutation.epicBoardListDestroy

Destroys an epic board list.

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicBoardListDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
listIdBoardsEpicListID!Global ID of the epic board list to destroy.

Fields

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

Mutation.epicBoardUpdate

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicBoardUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
displayColorsBooleanWhether or not display epic colors.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
idBoardsEpicBoardID!Epic board global ID.
labelIds[LabelID!]IDs of labels to be added to the board.
labels[String!]Labels of the issue.
nameStringBoard name.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicBoardEpicBoardUpdated epic board.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.epicMoveList

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicMoveListInput

Arguments

NameTypeDescription
boardIdBoardsEpicBoardID!Global ID of the board that the epic is in.
clientMutationIdStringA unique identifier for the client performing the mutation.
epicIdEpicID!ID of the epic to mutate.
fromListIdBoardsEpicListIDID of the board list that the epic will be moved from. Required if moving between lists.
moveAfterIdEpicIDID of epic that should be placed after the current epic.
moveBeforeIdEpicIDID of epic that should be placed before the current epic.
positionInListIntPosition of epics within the board list. Positions start at 0. Use -1 to move to the end of the list.
toListIdBoardsEpicListID!ID of the list the epic will be in after mutation.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.epicSetSubscription

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicSetSubscriptionInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group the epic to mutate belongs to.
iidID!IID of the epic to mutate.
subscribedStateBoolean!Desired state of the subscription.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.epicTreeReorder

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: EpicTreeReorderInput

Arguments

NameTypeDescription
baseEpicIdEpicID!ID of the base epic of the tree.
clientMutationIdStringA unique identifier for the client performing the mutation.
movedEpicTreeNodeFieldsInputType!Parameters for updating the tree positions.

Fields

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

Mutation.escalationPolicyCreate

Input type: EscalationPolicyCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the escalation policy.
nameString!Name of the escalation policy.
projectPathID!Project to create the escalation policy for.
rules[EscalationRuleInput!]!Steps of the escalation policy.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

Mutation.escalationPolicyDestroy

Input type: EscalationPolicyDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementEscalationPolicyID!Escalation policy internal ID to remove.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

Mutation.escalationPolicyUpdate

Input type: EscalationPolicyUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the escalation policy.
idIncidentManagementEscalationPolicyID!ID of the on-call schedule to create the on-call rotation in.
nameStringName of the escalation policy.
rules[EscalationRuleInput!]Steps of the escalation policy.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
escalationPolicyEscalationPolicyTypeEscalation policy.

Mutation.exportRequirements

Input type: ExportRequirementsInput

Arguments

NameTypeDescription
authorUsername[String!]Filter requirements by author username.
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full project path the requirements are associated with.
searchStringSearch query for requirement title.
selectedFields[String!]List of selected requirements fields to be exported.
sortSortList requirements by sort order.
stateRequirementStateFilter requirements by state.

Fields

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

Mutation.externalAuditEventDestinationCreate

Input type: ExternalAuditEventDestinationCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationUrlString!Destination URL.
groupPathID!Group path.
nameStringDestination name.
verificationTokenStringVerification token.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalAuditEventDestinationExternalAuditEventDestinationDestination created.

Mutation.externalAuditEventDestinationDestroy

Input type: ExternalAuditEventDestinationDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsExternalAuditEventDestinationID!ID of external audit event destination to destroy.

Fields

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

Mutation.externalAuditEventDestinationUpdate

Input type: ExternalAuditEventDestinationUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationUrlStringDestination URL to change.
idAuditEventsExternalAuditEventDestinationID!ID of external audit event destination to update.
nameStringDestination name.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalAuditEventDestinationExternalAuditEventDestinationUpdated destination.

Mutation.geoRegistriesBulkUpdate

Mutates multiple Geo registries for a given registry class.

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Input type: GeoRegistriesBulkUpdateInput

Arguments

NameTypeDescription
actionGeoRegistriesBulkAction!Action to be executed on Geo registries.
clientMutationIdStringA unique identifier for the client performing the mutation.
registryClassGeoRegistryClass!Class of the Geo registries to be updated.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
registryClassGeoRegistryClassUpdated Geo registry class.

Mutation.geoRegistriesUpdate

Mutates a Geo registry.

  • Introduced in GitLab 16.1.
  • Status: Experiment.

Input type: GeoRegistriesUpdateInput

Arguments

NameTypeDescription
actionGeoRegistryAction!Action to be executed on a Geo registry.
clientMutationIdStringA unique identifier for the client performing the mutation.
registryIdGeoBaseRegistryID!ID of the Geo registry entry to be updated.

Fields

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

Mutation.gitlabSubscriptionActivate

Input type: GitlabSubscriptionActivateInput

Arguments

NameTypeDescription
activationCodeString!Activation code received after purchasing a GitLab subscription.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields

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

Mutation.googleCloudLoggingConfigurationCreate

Input type: GoogleCloudLoggingConfigurationCreateInput

Arguments

NameTypeDescription
clientEmailString!Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationIdStringA unique identifier for the client performing the mutation.
googleProjectIdNameString!Unique identifier of the Google Cloud project to which the logging configuration belongs.
groupPathID!Group path.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events).
nameStringDestination name.
privateKeyString!Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
googleCloudLoggingConfigurationGoogleCloudLoggingConfigurationTypeconfiguration created.

Mutation.googleCloudLoggingConfigurationDestroy

Input type: GoogleCloudLoggingConfigurationDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsGoogleCloudLoggingConfigurationID!ID of the Google Cloud logging configuration to destroy.

Fields

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

Mutation.googleCloudLoggingConfigurationUpdate

Input type: GoogleCloudLoggingConfigurationUpdateInput

Arguments

NameTypeDescription
clientEmailStringEmail address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationIdStringA unique identifier for the client performing the mutation.
googleProjectIdNameStringUnique identifier of the Google Cloud project to which the logging configuration belongs.
idAuditEventsGoogleCloudLoggingConfigurationID!ID of the google Cloud configuration to update.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.
nameStringDestination name.
privateKeyStringPrivate Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
googleCloudLoggingConfigurationGoogleCloudLoggingConfigurationTypeconfiguration updated.

Mutation.groupAuditEventStreamingDestinationsCreate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: GroupAuditEventStreamingDestinationsCreateInput

Arguments

NameTypeDescription
categoryString!Destination category.
clientMutationIdStringA unique identifier for the client performing the mutation.
configJSON!Destination config.
groupPathID!Group path.
nameStringDestination name.
secretTokenStringSecret token.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalAuditEventDestinationGroupAuditEventStreamingDestinationDestination created.

Mutation.groupAuditEventStreamingDestinationsDelete

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: GroupAuditEventStreamingDestinationsDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsGroupExternalStreamingDestinationID!ID of the audit events external streaming destination to delete.

Fields

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

Mutation.groupAuditEventStreamingDestinationsUpdate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: GroupAuditEventStreamingDestinationsUpdateInput

Arguments

NameTypeDescription
categoryStringDestination category.
clientMutationIdStringA unique identifier for the client performing the mutation.
configJSONDestination config.
idAuditEventsGroupExternalStreamingDestinationID!ID of external audit event destination to update.
nameStringDestination name.
secretTokenStringSecret token.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalAuditEventDestinationGroupAuditEventStreamingDestinationUpdated destination.

Mutation.groupMemberBulkUpdate

Input type: GroupMemberBulkUpdateInput

Arguments

NameTypeDescription
accessLevelMemberAccessLevel!Access level to update the members to.
clientMutationIdStringA unique identifier for the client performing the mutation.
expiresAtTimeDate and time the membership expires.
groupIdGroupID!Global ID of the group.
userIds[UserID!]!Global IDs of the members.

Fields

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

Mutation.groupMembersExport

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: GroupMembersExportInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIdGroupID!Global ID of the group.

Fields

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

Mutation.groupSavedReplyCreate

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: GroupSavedReplyCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
groupIdGroupID!Group for the save reply.
nameString!Name of the saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

Mutation.groupSavedReplyDestroy

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: GroupSavedReplyDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idGroupsSavedReplyID!Global ID of the group-level saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

Mutation.groupSavedReplyUpdate

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: GroupSavedReplyUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
idGroupsSavedReplyID!Global ID of the group-level saved reply.
nameString!Name of the saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplyGroupSavedReplySaved reply after mutation.

Mutation.groupUpdate

Input type: GroupUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
duoFeaturesEnabledBooleanIndicates whether GitLab Duo features are enabled for the group. Introduced in GitLab 16.10: Status: Experiment.
fullPathID!Full path of the group that will be updated.
lockDuoFeaturesEnabledBooleanIndicates if the GitLab Duo features enabled setting is enforced for all subgroups. Introduced in GitLab 16.10: Status: Experiment.
lockMathRenderingLimitsEnabledBooleanIndicates if math rendering limits are locked for all descendant groups.
mathRenderingLimitsEnabledBooleanIndicates if math rendering limits are used for this group.
nameStringName of the namespace.
pathStringPath of the namespace.
sharedRunnersSettingSharedRunnersSettingShared runners availability for the namespace and its descendants.
visibilityVisibilityLevelsEnumVisibility of the namespace.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
groupGroupGroup after update.

Mutation.httpIntegrationCreate

Input type: HttpIntegrationCreateInput

Arguments

NameTypeDescription
activeBoolean!Whether the integration is receiving alerts.
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the integration.
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.
projectPathID!Project to create the integration in.

Fields

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

Mutation.httpIntegrationDestroy

Input type: HttpIntegrationDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAlertManagementHttpIntegrationID!ID of the integration to remove.

Fields

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

Mutation.httpIntegrationResetToken

Input type: HttpIntegrationResetTokenInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAlertManagementHttpIntegrationID!ID of the integration to mutate.

Fields

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

Mutation.httpIntegrationUpdate

Input type: HttpIntegrationUpdateInput

Arguments

NameTypeDescription
activeBooleanWhether the integration is receiving alerts.
clientMutationIdStringA unique identifier for the client performing the mutation.
idAlertManagementHttpIntegrationID!ID of the integration to mutate.
nameStringName of the integration.
payloadAttributeMappings[AlertManagementPayloadAlertFieldInput!]Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExampleJsonStringExample of an alert payload.

Fields

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

Mutation.importSourceUserCancelReassignment

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: ImportSourceUserCancelReassignmentInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserKeepAllAsPlaceholder

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Input type: ImportSourceUserKeepAllAsPlaceholderInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespaceIdNamespaceID!Global ID of the namespace.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
updatedImportSourceUserCountIntNumber of successfully updated mappings of users on source instance to their destination users.

Mutation.importSourceUserKeepAsPlaceholder

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: ImportSourceUserKeepAsPlaceholderInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserReassign

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: ImportSourceUserReassignInput

Arguments

NameTypeDescription
assigneeUserIdUserID!Global ID of the assignee user.
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserResendNotification

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: ImportSourceUserResendNotificationInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
importSourceUserImportSourceUserMapping of a user on source instance to a user on destination instance after mutation.

Mutation.instanceAuditEventStreamingDestinationsCreate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: InstanceAuditEventStreamingDestinationsCreateInput

Arguments

NameTypeDescription
categoryString!Destination category.
clientMutationIdStringA unique identifier for the client performing the mutation.
configJSON!Destination config.
nameStringDestination name.
secretTokenStringSecret token.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalAuditEventDestinationInstanceAuditEventStreamingDestinationDestination created.

Mutation.instanceAuditEventStreamingDestinationsDelete

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: InstanceAuditEventStreamingDestinationsDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceExternalStreamingDestinationID!ID of the audit events external streaming destination to delete.

Fields

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

Mutation.instanceAuditEventStreamingDestinationsUpdate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: InstanceAuditEventStreamingDestinationsUpdateInput

Arguments

NameTypeDescription
categoryStringDestination category.
clientMutationIdStringA unique identifier for the client performing the mutation.
configJSONDestination config.
idAuditEventsInstanceExternalStreamingDestinationID!ID of external audit event destination to update.
nameStringDestination name.
secretTokenStringSecret token.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalAuditEventDestinationInstanceAuditEventStreamingDestinationUpdated destination.

Mutation.instanceExternalAuditEventDestinationCreate

Input type: InstanceExternalAuditEventDestinationCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationUrlString!Destination URL.
nameStringDestination name.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
instanceExternalAuditEventDestinationInstanceExternalAuditEventDestinationDestination created.

Mutation.instanceExternalAuditEventDestinationDestroy

Input type: InstanceExternalAuditEventDestinationDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceExternalAuditEventDestinationID!ID of the external instance audit event destination to destroy.

Fields

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

Mutation.instanceExternalAuditEventDestinationUpdate

Input type: InstanceExternalAuditEventDestinationUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destinationUrlStringDestination URL to change.
idAuditEventsInstanceExternalAuditEventDestinationID!ID of the external instance audit event destination to update.
nameStringDestination name.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
instanceExternalAuditEventDestinationInstanceExternalAuditEventDestinationUpdated destination.

Mutation.instanceGoogleCloudLoggingConfigurationCreate

Input type: InstanceGoogleCloudLoggingConfigurationCreateInput

Arguments

NameTypeDescription
clientEmailString!Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationIdStringA unique identifier for the client performing the mutation.
googleProjectIdNameString!Unique identifier of the Google Cloud project to which the logging configuration belongs.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events).
nameStringDestination name.
privateKeyString!Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
instanceGoogleCloudLoggingConfigurationInstanceGoogleCloudLoggingConfigurationTypeconfiguration created.

Mutation.instanceGoogleCloudLoggingConfigurationDestroy

Input type: InstanceGoogleCloudLoggingConfigurationDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAuditEventsInstanceGoogleCloudLoggingConfigurationID!ID of the Google Cloud logging configuration to destroy.

Fields

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

Mutation.instanceGoogleCloudLoggingConfigurationUpdate

Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput

Arguments

NameTypeDescription
clientEmailStringEmail address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationIdStringA unique identifier for the client performing the mutation.
googleProjectIdNameStringUnique identifier of the Google Cloud project to which the logging configuration belongs.
idAuditEventsInstanceGoogleCloudLoggingConfigurationID!ID of the instance google Cloud configuration to update.
logIdNameStringUnique identifier used to distinguish and manage different logs within the same Google Cloud project.
nameStringDestination name.
privateKeyStringPrivate Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
instanceGoogleCloudLoggingConfigurationInstanceGoogleCloudLoggingConfigurationTypeconfiguration updated.

Mutation.integrationExclusionCreate

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: IntegrationExclusionCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[GroupID!]IDs of groups to exclude up to a maximum of 100.
integrationNameIntegrationType!Type of integration to exclude.
projectIds[ProjectID!]IDs of projects to exclude up to a maximum of 100.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
exclusions[IntegrationExclusion!]Integration exclusions created by the mutation.

Mutation.integrationExclusionDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: IntegrationExclusionDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[GroupID!]IDs of excluded groups.
integrationNameIntegrationType!Type of integration.
projectIds[ProjectID!]IDs of excluded projects.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
exclusions[IntegrationExclusion!]Project no longer excluded due to the mutation.

Mutation.issuableResourceLinkCreate

Input type: IssuableResourceLinkCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIssueID!Incident id to associate the resource link with.
linkString!Link of the resource.
linkTextStringLink text of the resource.
linkTypeIssuableResourceLinkTypeLink type of the resource.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issuableResourceLinkIssuableResourceLinkIssuable resource link.

Mutation.issuableResourceLinkDestroy

Input type: IssuableResourceLinkDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementIssuableResourceLinkID!Issuable resource link ID to remove.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issuableResourceLinkIssuableResourceLinkIssuable resource link.

Mutation.issueLinkAlerts

Input type: IssueLinkAlertsInput

Arguments

NameTypeDescription
alertReferences[String!]!Alerts references to be linked to the incident.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueMove

Input type: IssueMoveInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
targetProjectPathID!Project to move the issue to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueMoveList

Input type: IssueMoveListInput

Arguments

NameTypeDescription
boardIdBoardID!Global ID of the board that the issue is in.
clientMutationIdStringA unique identifier for the client performing the mutation.
epicId warning-solidEpicIDDeprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
fromListIdIDID of the board list that the issue will be moved from.
iidString!IID of the issue to mutate.
moveAfterIdIDID of issue that should be placed after the current issue.
moveBeforeIdIDID of issue that should be placed before the current issue.
positionInListIntPosition of issue within the board list. Positions start at 0. Use -1 to move to the end of the list.
projectPathID!Project the issue to mutate is in.
toListIdIDID of the board list that the issue will be moved to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetAssignees

Input type: IssueSetAssigneesInput

Arguments

NameTypeDescription
assigneeUsernames[String!]!Usernames to assign to the resource. Replaces existing assignees by default.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetConfidential

Input type: IssueSetConfidentialInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
confidentialBoolean!Whether or not to set the issue as a confidential.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetCrmContacts

Input type: IssueSetCrmContactsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contactIds[CustomerRelationsContactID!]!Customer relations contact IDs to set. Replaces existing contacts by default.
iidString!IID of the issue to mutate.
operationModeMutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetDueDate

Input type: IssueSetDueDateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dueDateTimeDesired due date for the issue. Due date is removed if null.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetEpic

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: IssueSetEpicInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicId warning-solidEpicIDDeprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetEscalationPolicy

Input type: IssueSetEscalationPolicyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
escalationPolicyIdIncidentManagementEscalationPolicyIDGlobal ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetEscalationStatus

Input type: IssueSetEscalationStatusInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
statusIssueEscalationStatus!Set the escalation status.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetIteration

Input type: IssueSetIterationInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
iterationIdIterationIDIteration to assign to the issue.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetLocked

Input type: IssueSetLockedInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
lockedBoolean!Whether or not to lock discussion on the issue.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetSeverity

Input type: IssueSetSeverityInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
severityIssuableSeverity!Set the incident severity level.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetSubscription

Input type: IssueSetSubscriptionInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
subscribedStateBoolean!Desired state of the subscription.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueSetWeight

Input type: IssueSetWeightInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.
weightIntThe desired weight for the issue. If set to null, weight is removed.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issueUnlinkAlert

Input type: IssueUnlinkAlertInput

Arguments

NameTypeDescription
alertIdAlertManagementAlertID!Global ID of the alert to unlink from the incident.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.issuesBulkUpdate

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

  • Introduced in GitLab 15.9.
  • Status: Experiment.

Input type: IssuesBulkUpdateInput

Arguments

NameTypeDescription
addLabelIds[LabelID!]Global ID array of the labels that will be added to the issues.
assigneeIds[UserID!]Global ID array of the users that will be assigned to the given issues. Existing assignees will be replaced with the ones on this list.
clientMutationIdStringA unique identifier for the client performing the mutation.
epicId warning-solidEpicIDDeprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
healthStatusHealthStatusHealth status that will be assigned to the issues.
ids[IssueID!]!Global ID array of the issues that will be updated. IDs that the user can’t update will be ignored. A max of 100 can be provided.
iterationIdIterationIDGlobal ID of the iteration that will be assigned to the issues.
milestoneIdMilestoneIDGlobal ID of the milestone that will be assigned to the issues.
parentIdIssueParentID!Global ID of the parent to which the bulk update will be scoped. The parent can be a project. The parent can also be a group (Premium and Ultimate only). Example IssueParentID are "gid://gitlab/Project/1" and "gid://gitlab/Group/1".
removeLabelIds[LabelID!]Global ID array of the labels that will be removed from the issues.
stateEventIssueStateEventClose or reopen an issue.
subscriptionEventIssuableSubscriptionEventSubscribe to or unsubscribe from issue notifications.

Fields

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

Mutation.iterationCadenceCreate

Input type: IterationCadenceCreateInput

Arguments

NameTypeDescription
activeBoolean!Whether the iteration cadence is active.
automaticBoolean!Whether the iteration cadence should automatically generate upcoming iterations.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeksIntDuration in weeks of the iterations within this cadence.
groupPathID!Group where the iteration cadence is created.
iterationsInAdvanceIntUpcoming iterations to be created when iteration cadence is set to automatic.
rollOverBooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDateTimeTimestamp of the automation start date.
titleStringTitle of the iteration cadence.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
iterationCadenceIterationCadenceCreated iteration cadence.

Mutation.iterationCadenceDestroy

Input type: IterationCadenceDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIterationsCadenceID!Global ID of the iteration cadence.

Fields

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

Mutation.iterationCadenceUpdate

Input type: IterationCadenceUpdateInput

Arguments

NameTypeDescription
activeBooleanWhether the iteration cadence is active.
automaticBooleanWhether the iteration cadence should automatically generate upcoming iterations.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeksIntDuration in weeks of the iterations within this cadence.
idIterationsCadenceID!Global ID of the iteration cadence.
iterationsInAdvanceIntUpcoming iterations to be created when iteration cadence is set to automatic.
rollOverBooleanWhether the iteration cadence should roll over issues to the next iteration or not.
startDateTimeTimestamp of the automation start date.
titleStringTitle of the iteration cadence.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
iterationCadenceIterationCadenceUpdated iteration cadence.

Mutation.iterationCreate

Input type: iterationCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathIDFull path of the group with which the resource is associated.
iterationsCadenceIdIterationsCadenceIDGlobal ID of the iteration cadence to be assigned to the new iteration.
projectPathIDFull path of the project with which the resource is associated.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

Fields

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

Mutation.iterationDelete

Input type: IterationDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIterationID!ID of the iteration.

Fields

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

Mutation.jiraImportStart

Input type: JiraImportStartInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
jiraProjectKeyString!Project key of the importer Jira project.
jiraProjectName warning-solidStringDeprecated: Argument is not used. Deprecated in GitLab 17.4.
projectPathID!Project to import the Jira project into.
usersMapping[JiraUsersMappingInputType!]Mapping of Jira to GitLab users.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
jiraImportJiraImportJira import data after mutation.

Mutation.jiraImportUsers

Input type: JiraImportUsersInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project to import the Jira users into.
startAtIntIndex of the record the import should started at, default 0 (50 records returned).

Fields

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

Mutation.jobArtifactsDestroy

Input type: JobArtifactsDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiBuildID!ID of the job to mutate.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
destroyedArtifactsCountInt!Number of artifacts deleted.
errors[String!]!Errors encountered during execution of the mutation.
jobCiJobJob with artifacts to be deleted.

Mutation.jobCancel

Input type: JobCancelInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiBuildID!ID of the job to mutate.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
jobCiJobJob after the mutation.

Mutation.jobPlay

Input type: JobPlayInput

Arguments

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

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
jobCiJobJob after the mutation.

Mutation.jobRetry

Input type: JobRetryInput

Arguments

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

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
jobCiJobJob after the mutation.

Mutation.jobUnschedule

Input type: JobUnscheduleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiBuildID!ID of the job to mutate.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
jobCiJobJob after the mutation.

Mutation.labelCreate

Input type: LabelCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
colorStringThe color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names.
descriptionStringDescription of the label.
groupPathIDFull path of the group with which the resource is associated.
projectPathIDFull path of the project with which the resource is associated.
titleString!Title of the label.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
labelLabelLabel after mutation.

Mutation.markAsSpamSnippet

Input type: MarkAsSpamSnippetInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSnippetID!Global ID of the snippet to update.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
snippetSnippetSnippet after mutation.

Mutation.memberRoleAdminCreate

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Input type: MemberRoleAdminCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the member role.
nameStringName of the member role.
permissions[MemberRoleAdminPermission!]!List of all customizable admin permissions.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
memberRoleAdminMemberRoleCreated member role.

Mutation.memberRoleCreate

  • Introduced in GitLab 16.5.
  • Status: Experiment.

Input type: MemberRoleCreateInput

Arguments

NameTypeDescription
baseAccessLevelMemberRolesAccessLevel!Base access level for the custom role.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the member role.
groupPathIDGroup the member role to mutate is in. Required for SaaS.
nameStringName of the member role.
permissions[MemberRolePermission!]List of all customizable permissions.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
memberRoleMemberRoleUpdated member role.

Mutation.memberRoleDelete

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: MemberRoleDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMemberRoleID!ID of the member role to delete.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
memberRoleMemberRoleDeleted member role.

Mutation.memberRoleToUserAssign

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Input type: MemberRoleToUserAssignInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
memberRoleIdMemberRoleIDGlobal ID of the custom role to be assigned to a user. Admin roles will be unassigned from the user if omitted or set as NULL.
userIdUserID!Global ID of the user to be assigned to a custom role.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userMemberRoleUserMemberRoleCreated user member role or nil if the relation was deleted.

Mutation.memberRoleUpdate

Input type: MemberRoleUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the member role.
idMemberRoleID!ID of the member role to mutate.
nameStringName of the member role.
permissions[MemberRolePermission!]List of all customizable permissions.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
memberRoleMemberRoleUpdated member role.

Mutation.mergeRequestAccept

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

In GitLab 16.5, the merging happens asynchronously. This results in mergeRequest and state not updating after a mutation request, because the merging may not have happened yet.

Input type: MergeRequestAcceptInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commitMessageStringCustom merge commit message.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
shaString!HEAD SHA at the time when the merge was requested.
shouldRemoveSourceBranchBooleanShould the source branch be removed.
squashBooleanSquash commits on the source branch before merge.
squashCommitMessageStringCustom squash commit message (if squash is true).
strategyMergeStrategyEnumHow to merge the merge request.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestCreate

Input type: MergeRequestCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the merge request (Markdown rendered as HTML for caching).
labels[String!]Labels of the merge request.
mergeAfterTimeDate after which the merge request can be merged.
projectPathID!Project full path the merge request is associated with.
sourceBranchString!Source branch of the merge request.
targetBranchString!Target branch of the merge request.
titleString!Title of the merge request.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestDestroyRequestedChanges

Input type: MergeRequestDestroyRequestedChangesInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestReviewerRereview

Input type: MergeRequestReviewerRereviewInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
userIdUserID!User ID for the user that has been requested for a new review.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetAssignees

Input type: MergeRequestSetAssigneesInput

Arguments

NameTypeDescription
assigneeUsernames[String!]!Usernames to assign to the resource. Replaces existing assignees by default.
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.
projectPathID!Project the merge request to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetDraft

Input type: MergeRequestSetDraftInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
draftBoolean!Whether or not to set the merge request as a draft.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetLabels

Input type: MergeRequestSetLabelsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
labelIds[LabelID!]!Label IDs to set. Replaces existing labels by default.
operationModeMutationOperationModeChanges the operation mode. Defaults to REPLACE.
projectPathID!Project the merge request to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetLocked

Input type: MergeRequestSetLockedInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
lockedBoolean!Whether or not to lock the merge request.
projectPathID!Project the merge request to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetMilestone

Input type: MergeRequestSetMilestoneInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
milestoneIdMilestoneIDMilestone to assign to the merge request.
projectPathID!Project the merge request to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetReviewers

Input type: MergeRequestSetReviewersInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
operationModeMutationOperationModeOperation to perform. Defaults to REPLACE.
projectPathID!Project the merge request to mutate is in.
reviewerUsernames[String!]!Usernames of reviewers to assign. Replaces existing reviewers by default.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestSetSubscription

Input type: MergeRequestSetSubscriptionInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the merge request to mutate.
projectPathID!Project the merge request to mutate is in.
subscribedStateBoolean!Desired state of the subscription.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestUpdate

Update attributes of a merge request.

Input type: MergeRequestUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the merge request (Markdown rendered as HTML for caching).
iidString!IID of the merge request to mutate.
mergeAfterTimeDate after which the merge request can be merged.
overrideRequestedChangesBooleanOverride all requested changes. Can only be set by users who have permissionto merge this merge request.
projectPathID!Project the merge request to mutate is in.
stateMergeRequestNewStateAction to perform to change the state.
targetBranchStringTarget branch of the merge request.
timeEstimateStringEstimated time to complete the merge request. Use null or 0 to remove the current estimate.
titleStringTitle of the merge request.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeRequestUpdateApprovalRule

Input type: MergeRequestUpdateApprovalRuleInput

Arguments

NameTypeDescription
approvalRuleIdInt!ID of an approval rule.
approvalsRequiredInt!Number of required approvals for a given rule.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupIds[String!]IDs of groups as approvers.
iidString!IID of the merge request to mutate.
nameString!Name of the approval rule.
projectPathID!Project the merge request to mutate is in.
removeHiddenGroupsBooleanWhether hidden groups should be removed.
userIds[String!]IDs of users as approvers.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge request after mutation.

Mutation.mergeTrainsDeleteCar

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: MergeTrainsDeleteCarInput

Arguments

NameTypeDescription
carIdMergeTrainsCarID!Global ID of the car.
clientMutationIdStringA unique identifier for the client performing the mutation.

Fields

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

Mutation.mlModelCreate

  • Introduced in GitLab 16.8.
  • Status: Experiment.

Input type: MlModelCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the model.
nameString!Name of the model.
projectPathID!Project the model to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
modelMlModelModel after mutation.

Mutation.mlModelDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: MlModelDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMlModelID!Global ID of the model to be deleted.
projectPathID!Project the model to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
modelMlModelModel after mutation.

Mutation.mlModelDestroy

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Input type: MlModelDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMlModelID!Global ID of the model to be deleted.
projectPathID!Project the model to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
messageStringModel deletion result message.
modelMlModelModel after mutation.

Mutation.mlModelEdit

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Input type: MlModelEditInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the model.
modelIdIntId of the model.
nameString!Name of the model.
projectPathID!Project the model to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
modelMlModelModel after mutation.

Mutation.mlModelVersionCreate

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: MlModelVersionCreateInput

Arguments

NameTypeDescription
candidateIdMlCandidateIDGlobal ID of a candidate to promote optionally.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the model version.
modelIdMlModelID!Global ID of the model the version belongs to.
projectPathID!Project the model to mutate is in.
versionStringModel version.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
modelVersionMlModelVersionModel after mutation.

Mutation.mlModelVersionDelete

  • Introduced in GitLab 17.0.
  • Status: Experiment.

Input type: MlModelVersionDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idMlModelVersionID!Global ID of the model version to be deleted.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
modelVersionMlModelVersionDeleted model version.

Mutation.mlModelVersionEdit

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: MlModelVersionEditInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionString!Description of the model version.
modelIdMlModelID!Global ID of the model the version belongs to.
projectPathID!Project the model to mutate is in.
versionString!Model version.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
modelVersionMlModelVersionModel after mutation.

Mutation.namespaceBanDestroy

Input type: NamespaceBanDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idNamespacesNamespaceBanID!Global ID of the namespace ban to remove.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
namespaceBanNamespaceBanNamespace Ban.

Mutation.namespaceCiCdSettingsUpdate

Input type: NamespaceCiCdSettingsUpdateInput

Arguments

NameTypeDescription
allowStaleRunnerPruningBooleanIndicates if stale runners directly belonging to this namespace should be periodically pruned.
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the namespace the settings belong to.

Fields

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

Mutation.namespaceCreateRemoteDevelopmentClusterAgentMapping

Input type: NamespaceCreateRemoteDevelopmentClusterAgentMappingInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be associated with the namespace.
namespaceIdNamespaceID!GlobalID of the namespace to be associated with the cluster agent.

Fields

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

Mutation.namespaceDeleteRemoteDevelopmentClusterAgentMapping

Input type: NamespaceDeleteRemoteDevelopmentClusterAgentMappingInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!GlobalID of the cluster agent to be un-associated from the namespace.
namespaceIdNamespaceID!GlobalID of the namespace to be un-associated from the cluster agent.

Fields

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

Mutation.namespaceSettingsUpdate

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: NamespaceSettingsUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full path of the namespace the settings belong to.
pipelineVariablesDefaultRolePipelineVariablesDefaultRoleTypeIndicates the default minimum role required to override pipeline variables in the namespace.

Fields

NameTypeDescription
ciCdSettingsCiCdSettings!Namespace CI/CD settings after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.noteConvertToThread

Convert a standard comment to a resolvable thread.

Input type: NoteConvertToThreadInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idNoteID!Global ID of the Note to convert.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.oncallRotationCreate

Input type: OncallRotationCreateInput

Arguments

NameTypeDescription
activePeriodOncallRotationActivePeriodInputTypeActive period of time that the on-call rotation should take place.
clientMutationIdStringA unique identifier for the client performing the mutation.
endsAtOncallRotationDateInputTypeEnd date and time of the on-call rotation, in the timezone of the on-call schedule.
nameString!Name of the on-call rotation.
participants[OncallUserInputType!]!Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
projectPathID!Project to create the on-call schedule in.
rotationLengthOncallRotationLengthInputType!Rotation length of the on-call rotation.
scheduleIidString!IID of the on-call schedule to create the on-call rotation in.
startsAtOncallRotationDateInputType!Start date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

Mutation.oncallRotationDestroy

Input type: OncallRotationDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementOncallRotationID!ID of the on-call rotation to remove.
projectPathID!Project to remove the on-call schedule from.
scheduleIidString!IID of the on-call schedule to the on-call rotation belongs to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

Mutation.oncallRotationUpdate

Input type: OncallRotationUpdateInput

Arguments

NameTypeDescription
activePeriodOncallRotationActivePeriodInputTypeActive period of time that the on-call rotation should take place.
clientMutationIdStringA unique identifier for the client performing the mutation.
endsAtOncallRotationDateInputTypeEnd date and time of the on-call rotation, in the timezone of the on-call schedule.
idIncidentManagementOncallRotationID!ID of the on-call schedule to create the on-call rotation in.
nameStringName of the on-call rotation.
participants[OncallUserInputType!]Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
rotationLengthOncallRotationLengthInputTypeRotation length of the on-call rotation.
startsAtOncallRotationDateInputTypeStart date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
oncallRotationIncidentManagementOncallRotationOn-call rotation.

Mutation.oncallScheduleCreate

Input type: OncallScheduleCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the on-call schedule.
nameString!Name of the on-call schedule.
projectPathID!Project to create the on-call schedule in.
timezoneString!Timezone of the on-call schedule.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

Mutation.oncallScheduleDestroy

Input type: OncallScheduleDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!On-call schedule internal ID to remove.
projectPathID!Project to remove the on-call schedule from.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

Mutation.oncallScheduleUpdate

Input type: OncallScheduleUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the on-call schedule.
iidString!On-call schedule internal ID to update.
nameStringName of the on-call schedule.
projectPathID!Project to update the on-call schedule in.
timezoneStringTimezone of the on-call schedule.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule.

Mutation.organizationCreate

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Input type: OrganizationCreateInput

Arguments

NameTypeDescription
avatarUploadAvatar for the organization.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the organization.
nameString!Name for the organization.
pathString!Path for the organization.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
organizationOrganizationOrganization after mutation.

Mutation.organizationUpdate

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: OrganizationUpdateInput

Arguments

NameTypeDescription
avatarUploadAvatar for the organization.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the organization.
idOrganizationsOrganizationID!ID of the organization to mutate.
nameStringName for the organization.
pathStringPath for the organization.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
organizationOrganizationOrganization after mutation.

Mutation.organizationUserUpdate

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Input type: OrganizationUserUpdateInput

Arguments

NameTypeDescription
accessLevelOrganizationUserAccessLevel!Access level to update the organization user to.
clientMutationIdStringA unique identifier for the client performing the mutation.
idOrganizationsOrganizationUserID!ID of the organization user to mutate.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
organizationUser warning-solidOrganizationUserDeprecated: Status: Experiment. Introduced in GitLab 17.5.

Mutation.pagesMarkOnboardingComplete

Input type: PagesMarkOnboardingCompleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project.

Fields

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

Mutation.pipelineCancel

Input type: PipelineCancelInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineID!ID of the pipeline to mutate.

Fields

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

Mutation.pipelineCreate

Input type: PipelineCreateInput

Arguments

NameTypeDescription
async warning-solidBooleanDeprecated: Status: Experiment. Introduced in GitLab 17.8.
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project that is triggering the pipeline.
refString!Ref on which to run the pipeline.
variables[CiVariableInput!]Variables for the pipeline.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelinePipelinePipeline created after mutation. Null if async: true.
requestId warning-solidStringDeprecated: Status: Experiment. Introduced in GitLab 17.8.

Mutation.pipelineDestroy

Input type: PipelineDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineID!ID of the pipeline to mutate.

Fields

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

Mutation.pipelineRetry

Input type: PipelineRetryInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineID!ID of the pipeline to mutate.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelinePipelinePipeline after mutation.

Mutation.pipelineScheduleCreate

Input type: PipelineScheduleCreateInput

Arguments

NameTypeDescription
activeBooleanIndicates if the pipeline schedule should be active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
cronString!Cron expression of the pipeline schedule.
cronTimezoneStringCron time zone supported by ActiveSupport::TimeZone. For example: “Pacific Time (US & Canada)” (default: “UTC”).
descriptionString!Description of the pipeline schedule.
projectPathID!Full path of the project the pipeline schedule is associated with.
refString!Ref of the pipeline schedule.
variables[PipelineScheduleVariableInput!]Variables for the pipeline schedule.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelineSchedulePipelineScheduleCreated pipeline schedule.

Mutation.pipelineScheduleDelete

Input type: PipelineScheduleDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields

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

Mutation.pipelineSchedulePlay

Input type: PipelineSchedulePlayInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelineSchedulePipelineSchedulePipeline schedule after mutation.

Mutation.pipelineScheduleTakeOwnership

Input type: PipelineScheduleTakeOwnershipInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelineSchedulePipelineScheduleUpdated pipeline schedule ownership.

Mutation.pipelineScheduleUpdate

Input type: PipelineScheduleUpdateInput

Arguments

NameTypeDescription
activeBooleanIndicates if the pipeline schedule should be active or not.
clientMutationIdStringA unique identifier for the client performing the mutation.
cronStringCron expression of the pipeline schedule.
cronTimezoneStringCron time zone supported by ActiveSupport::TimeZone. For example: “Pacific Time (US & Canada)” (default: “UTC”).
descriptionStringDescription of the pipeline schedule.
idCiPipelineScheduleID!ID of the pipeline schedule to mutate.
refStringRef of the pipeline schedule.
variables[PipelineScheduleVariableInput!]Variables for the pipeline schedule.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelineSchedulePipelineScheduleUpdated pipeline schedule.

Mutation.pipelineTriggerCreate

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: PipelineTriggerCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionString!Description of the pipeline trigger token.
expiresAtTimeTimestamp of when the pipeline trigger token expires.
projectPathID!Full path of the project that the pipeline trigger token to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelineTriggerPipelineTriggerMutated pipeline trigger token.

Mutation.pipelineTriggerDelete

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: PipelineTriggerDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiTriggerID!ID of the pipeline trigger token to delete.

Fields

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

Mutation.pipelineTriggerUpdate

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: PipelineTriggerUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionString!Description of the pipeline trigger token.
idCiTriggerID!ID of the pipeline trigger token to update.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pipelineTriggerPipelineTriggerMutated pipeline trigger token.

Mutation.processUserBillablePromotionRequest

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Input type: ProcessUserBillablePromotionRequestInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
statusMemberApprovalStatusType!Status for the member approval request (approved, denied, pending).
userIdUserID!Global ID of user to be promoted.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
resultUserPromotionStatusTypeStatus of the user promotion process (success, partial_success, failed).

Mutation.productAnalyticsProjectSettingsUpdate

Input type: ProductAnalyticsProjectSettingsUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
cubeApiBaseUrlStringBase URL for the Cube API.
cubeApiKeyStringAPI key for the Cube API.
fullPathID!Full path of the project the settings belong to.
productAnalyticsConfiguratorConnectionStringStringConnection string for the product analytics configurator.
productAnalyticsDataCollectorHostStringHost for the product analytics data collector.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
cubeApiBaseUrlStringBase URL for the Cube API.
cubeApiKeyStringAPI key for the Cube API.
errors[String!]!Errors encountered during execution of the mutation.
productAnalyticsConfiguratorConnectionStringStringConnection string for the product analytics configurator.
productAnalyticsDataCollectorHostStringHost for the product analytics data collector.

Mutation.projectBlobsRemove

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: projectBlobsRemoveInput

Arguments

NameTypeDescription
blobOids[String!]!List of blob oids.
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project to replace.

Fields

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

Mutation.projectCiCdSettingsUpdate

Input type: ProjectCiCdSettingsUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathID!Full Path of the project the settings belong to.
inboundJobTokenScopeEnabledBooleanIndicates CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabled warning-solidBooleanDeprecated: Outbound job token scope is being removed. This field can now only be set to false. Deprecated in GitLab 16.0.
keepLatestArtifactBooleanIndicates if the latest artifact should be kept for the project.
mergePipelinesEnabledBooleanIndicates if merged results pipelines are enabled for the project.
mergeTrainsEnabledBooleanIndicates if merge trains are enabled for the project.
mergeTrainsSkipTrainAllowedBooleanIndicates whether an option is allowed to merge without refreshing the merge train. Ignored unless the merge_trains_skip_train feature flag is also enabled.
pushRepositoryForJobTokenAllowedBooleanIndicates the ability to push to the original project repository using a job token.

Fields

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

Mutation.projectInitializeProductAnalytics

Input type: ProjectInitializeProductAnalyticsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project to initialize.

Fields

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

Mutation.projectMemberBulkUpdate

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

Input type: ProjectMemberBulkUpdateInput

Arguments

NameTypeDescription
accessLevelMemberAccessLevel!Access level to update the members to.
clientMutationIdStringA unique identifier for the client performing the mutation.
expiresAtTimeDate and time the membership expires.
projectIdProjectID!Global ID of the project.
userIds[UserID!]!Global IDs of the members.

Fields

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

Mutation.projectSavedReplyCreate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: ProjectSavedReplyCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
nameString!Name of the saved reply.
projectIdProjectID!Project for the saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

Mutation.projectSavedReplyDestroy

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: ProjectSavedReplyDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectsSavedReplyID!Global ID of the project-level saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

Mutation.projectSavedReplyUpdate

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Input type: ProjectSavedReplyUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
idProjectsSavedReplyID!Global ID of the project-level saved reply.
nameString!Name of the saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplyProjectSavedReplySaved reply after mutation.

Mutation.projectSecretCreate

Input type: ProjectSecretCreateInput

Arguments

NameTypeDescription
branchString!Branches that can access the secret.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the project secret.
environmentString!Environments that can access the secret.
nameString!Name of the project secret.
projectPathID!Project of the secret.
valueString!Value of the project secret.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projectSecretProjectSecretProject secret.

Mutation.projectSecretDelete

Input type: ProjectSecretDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the project secret.
projectPathID!Project of the secret.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projectSecretProjectSecretDeleted project secret.

Mutation.projectSecretsManagerInitialize

Input type: ProjectSecretsManagerInitializeInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project of the secrets manager.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projectSecretsManagerProjectSecretsManagerProject secrets manager.

Mutation.projectSecurityExclusionCreate

Input type: ProjectSecurityExclusionCreateInput

Arguments

NameTypeDescription
activeBoolean!Whether the exclusion is active.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringOptional description for the exclusion.
projectPathID!Full path of the project the exclusion will be associated with.
scannerExclusionScannerEnum!Scanner to ignore values for based on the exclusion.
typeExclusionTypeEnum!Type of the exclusion.
valueString!Value of the exclusion.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
securityExclusionProjectSecurityExclusionProject security exclusion created.

Mutation.projectSecurityExclusionDelete

Input type: ProjectSecurityExclusionDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idSecurityProjectSecurityExclusionID!Global ID of the exclusion to be deleted.

Fields

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

Mutation.projectSecurityExclusionUpdate

Input type: ProjectSecurityExclusionUpdateInput

Arguments

NameTypeDescription
activeBooleanWhether the exclusion is active.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringOptional description for the exclusion.
idSecurityProjectSecurityExclusionID!Global ID of the exclusion to be updated.
scannerExclusionScannerEnumScanner to ignore values for based on the exclusion.
typeExclusionTypeEnumType of the exclusion.
valueStringValue of the exclusion.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
securityExclusionProjectSecurityExclusionProject security exclusion updated.

Mutation.projectSetComplianceFramework

Assign (or unset) a compliance framework to a project. This mutation raises an error if the project has more than one compliance framework associated with it.

Input type: ProjectSetComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceFrameworkIdComplianceManagementFrameworkIDID of the compliance framework to assign to the project. Set to null to unset.
projectIdProjectID!ID of the project to change the compliance framework of.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projectProjectProject after mutation.

Mutation.projectSetContinuousVulnerabilityScanning

Enable/disable Continuous Vulnerability Scanning for the given project.

  • Deprecated in GitLab 17.3.
  • CVS has been enabled permanently. See [this epic](https: //gitlab.com/groups/gitlab-org/-/epics/11474) for more information.

Input type: ProjectSetContinuousVulnerabilityScanningInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for Continuous Vulnerability Scanning feature.
projectPathID!Full path of the project.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
continuousVulnerabilityScanningEnabledBoolean!Whether feature is enabled.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.projectSetLocked

Input type: ProjectSetLockedInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
filePathString!Full path to the file.
lockBoolean!Whether or not to lock the file path.
projectPathID!Full path of the project to mutate.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projectProjectProject after mutation.

Mutation.projectSettingsUpdate

  • Introduced in GitLab 16.9.
  • Status: Experiment.

Input type: ProjectSettingsUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
duoFeaturesEnabledBoolean!Indicates whether GitLab Duo features are enabled for the project.
fullPathID!Full Path of the project the settings belong to.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projectSettingsProjectSetting!Project settings after mutation.

Mutation.projectSubscriptionCreate

Input type: ProjectSubscriptionCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathString!Full path of the downstream project of the Project Subscription.
upstreamPathString!Full path of the upstream project of the Project Subscription.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
subscriptionCiSubscriptionsProjectProject Subscription created by the mutation.

Mutation.projectSubscriptionDelete

Input type: ProjectSubscriptionDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
subscriptionIdCiSubscriptionsProjectID!ID of the subscription to delete.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projectProjectProject after mutation.

Mutation.projectSyncFork

  • Introduced in GitLab 15.9.
  • Status: Experiment.

Input type: ProjectSyncForkInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project to initialize.
targetBranchString!Ref of the fork to fetch into.

Fields

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

Mutation.projectTargetBranchRuleCreate

Input type: ProjectTargetBranchRuleCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name for the target branch rule.
projectIdProjectID!Project ID for the target branch rule.
targetBranchString!Target branch for the target branch rule.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
targetBranchRuleProjectTargetBranchRuleTarget branch rule after mutation.

Mutation.projectTargetBranchRuleDestroy

Input type: ProjectTargetBranchRuleDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectsTargetBranchRuleID!ID for the target branch rule.

Fields

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

Mutation.projectTextReplace

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: projectTextReplaceInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project to replace.
replacements[String!]!List of text patterns to replace project-wide.

Fields

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

Mutation.projectUpdateComplianceFrameworks

Update compliance frameworks for a project.

Input type: ProjectUpdateComplianceFrameworksInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceFrameworkIds[ComplianceManagementFrameworkID!]!IDs of the compliance framework to update for the project.
projectIdProjectID!ID of the project to change the compliance framework of.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projectProjectProject after mutation.

Mutation.prometheusIntegrationCreate

Input type: PrometheusIntegrationCreateInput

Arguments

NameTypeDescription
activeBoolean!Whether the integration is receiving alerts.
apiUrlStringEndpoint at which Prometheus can be queried.
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Project to create the integration in.

Fields

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

Mutation.prometheusIntegrationResetToken

Input type: PrometheusIntegrationResetTokenInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIntegrationsPrometheusID!ID of the integration to mutate.

Fields

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

Mutation.prometheusIntegrationUpdate

Input type: PrometheusIntegrationUpdateInput

Arguments

NameTypeDescription
activeBooleanWhether the integration is receiving alerts.
apiUrlStringEndpoint at which Prometheus can be queried.
clientMutationIdStringA unique identifier for the client performing the mutation.
idIntegrationsPrometheusID!ID of the integration to mutate.

Fields

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

Mutation.promoteToEpic

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: PromoteToEpicInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathIDGroup the promoted epic will belong to.
iidString!IID of the issue to mutate.
projectPathID!Project the issue to mutate is in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after issue promotion.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.refreshStandardsAdherenceChecks

Input type: RefreshStandardsAdherenceChecksInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
groupPathID!Group path.

Fields

NameTypeDescription
adherenceChecksStatusStandardsAdherenceChecksStatusProgress of standards adherence checks.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.releaseAssetLinkCreate

Input type: ReleaseAssetLinkCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
directAssetPathStringRelative path for a direct asset link.
linkTypeReleaseAssetLinkTypeType of the asset link.
nameString!Name of the asset link.
projectPathID!Full path of the project the asset link is associated with.
tagNameString!Name of the associated release’s tag.
urlString!URL of the asset link.

Fields

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

Mutation.releaseAssetLinkDelete

Input type: ReleaseAssetLinkDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idReleasesLinkID!ID of the release asset link to delete.

Fields

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

Mutation.releaseAssetLinkUpdate

Input type: ReleaseAssetLinkUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
directAssetPathStringRelative path for a direct asset link.
idReleasesLinkID!ID of the release asset link to update.
linkTypeReleaseAssetLinkTypeType of the asset link.
nameStringName of the asset link.
urlStringURL of the asset link.

Fields

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

Mutation.releaseCreate

Input type: ReleaseCreateInput

Arguments

NameTypeDescription
assetsReleaseAssetsInputAssets associated to the release.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription (also known as “release notes”) of the release.
milestones[String!]Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
nameStringName of the release.
projectPathID!Full path of the project the release is associated with.
refStringCommit SHA or branch name to use if creating a new tag.
releasedAtTimeDate and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
tagMessageStringMessage to use if creating a new annotated tag.
tagNameString!Name of the tag to associate with the release.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
releaseReleaseRelease after mutation.

Mutation.releaseDelete

Input type: ReleaseDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectPathID!Full path of the project the release is associated with.
tagNameString!Name of the tag associated with the release to delete.

Fields

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

Mutation.releaseUpdate

Input type: ReleaseUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription (release notes) of the release.
milestones[String!]Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
nameStringName of the release.
projectPathID!Full path of the project the release is associated with.
releasedAtTimeRelease date.
tagNameString!Name of the tag associated with the release.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
releaseReleaseRelease after mutation.

Mutation.removeProjectFromSecurityDashboard

Input type: RemoveProjectFromSecurityDashboardInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idProjectID!ID of the project to remove from the Instance Security Dashboard.

Fields

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

Mutation.repositionImageDiffNote

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

Input type: RepositionImageDiffNoteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idDiffNoteID!Global ID of the DiffNote to update.
positionUpdateDiffImagePositionInput!Position of the note on a diff.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.restorePagesDeployment

Restores a Pages deployment that has been scheduled for deletion.

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: RestorePagesDeploymentInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPagesDeploymentID!ID of the Pages Deployment.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
pagesDeploymentPagesDeployment!Restored Pages Deployment.

Mutation.runnerCacheClear

Input type: RunnerCacheClearInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectIdProjectID!Global ID of the project that will have its runner cache cleared.

Fields

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

Mutation.runnerCreate

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Input type: RunnerCreateInput

Arguments

NameTypeDescription
accessLevelCiRunnerAccessLevelAccess level of the runner.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the runner.
groupIdGroupIDGlobal ID of the group that the runner is created in (valid only for group runner).
lockedBooleanIndicates the runner is locked.
maintenanceNoteStringRunner’s maintenance notes.
maximumTimeoutIntMaximum timeout (in seconds) for jobs processed by the runner.
pausedBooleanIndicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor warning-solidFloatDeprecated: Status: Experiment. Introduced in GitLab 17.7.
projectIdProjectIDGlobal ID of the project that the runner is created in (valid only for project runner).
publicProjectsMinutesCostFactor warning-solidFloatDeprecated: Status: Experiment. Introduced in GitLab 17.7.
runUntaggedBooleanIndicates the runner is able to run untagged jobs.
runnerTypeCiRunnerType!Type of the runner to create.
tagList[String!]Tags associated with the runner.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
runnerCiRunnerRunner after mutation.

Mutation.runnerDelete

Input type: RunnerDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idCiRunnerID!ID of the runner to delete.

Fields

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

Mutation.runnerUpdate

Input type: RunnerUpdateInput

Arguments

NameTypeDescription
accessLevelCiRunnerAccessLevelAccess level of the runner.
active warning-solidBooleanDeprecated: This was renamed. Please use paused. Deprecated in GitLab 14.8.
associatedProjects[ProjectID!]Projects associated with the runner. Available only for project runners.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the runner.
idCiRunnerID!ID of the runner to update.
lockedBooleanIndicates the runner is locked.
maintenanceNoteStringRunner’s maintenance notes.
maximumTimeoutIntMaximum timeout (in seconds) for jobs processed by the runner.
pausedBooleanIndicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor warning-solidFloatDeprecated: Status: Experiment. Introduced in GitLab 17.7.
publicProjectsMinutesCostFactor warning-solidFloatDeprecated: Status: Experiment. Introduced in GitLab 17.7.
runUntaggedBooleanIndicates the runner is able to run untagged jobs.
tagList[String!]Tags associated with the runner.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
runnerCiRunnerRunner after mutation.

Mutation.runnersExportUsage

Input type: RunnersExportUsageInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fromDateISO8601DateUTC start date of the period to report on. Defaults to the start of last full month.
fullPathIDFilter jobs by the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
maxProjectCountIntMaximum number of projects to return. All other runner usage will be attributed to an <Other projects> entry. Defaults to 1000 projects.
runnerTypeCiRunnerTypeScope of the runners to include in the report.
toDateISO8601DateUTC end date of the period to report on. " \ “Defaults to the end of the month specified by fromDate.

Fields

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

Mutation.runnersRegistrationTokenReset

  • Deprecated in GitLab 17.7.
  • Underlying feature was deprecated in 15.6 and will be removed in 18.0.

Input type: RunnersRegistrationTokenResetInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIDID of the project or group to reset the token for. Omit if resetting instance runner token.
typeCiRunnerType!Scope of the object to reset the token for.

Fields

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

Mutation.savedReplyCreate

Input type: SavedReplyCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
nameString!Name of the saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplySavedReplySaved reply after mutation.

Mutation.savedReplyDestroy

Input type: SavedReplyDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idUsersSavedReplyID!Global ID of the user saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplySavedReplySaved reply after mutation.

Mutation.savedReplyUpdate

Input type: SavedReplyUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contentString!Content of the saved reply.
idUsersSavedReplyID!Global ID of the user saved reply.
nameString!Name of the saved reply.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
savedReplySavedReplySaved reply after mutation.

Mutation.scanExecutionPolicyCommit

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

Input type: ScanExecutionPolicyCommitInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathStringFull path of the project.
nameString!Name of the policy. If the name is null, the name field from policy_yaml is used.
operationModeMutationOperationMode!Changes the operation mode.
policyYamlString!YAML snippet of the policy.
projectPath warning-solidIDDeprecated: Use fullPath. Deprecated in GitLab 14.10.

Fields

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

Mutation.securityFindingCreateIssue

Input type: SecurityFindingCreateIssueInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectProjectID!ID of the project to attach the issue to.
uuidString!UUID of the security finding to be used to create an issue.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue created after mutation.

Mutation.securityFindingCreateMergeRequest

Input type: SecurityFindingCreateMergeRequestInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
uuidString!UUID of the security finding to be used to create a merge request.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
mergeRequestMergeRequestMerge Request created after mutation.

Mutation.securityFindingCreateVulnerability

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Input type: SecurityFindingCreateVulnerabilityInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
uuidString!UUID of the security finding to be used to create a vulnerability.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
vulnerabilityVulnerabilityVulnerability created after mutation.

Mutation.securityFindingDismiss

Input type: SecurityFindingDismissInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why finding should be dismissed.
dismissalReasonVulnerabilityDismissalReasonReason why finding should be dismissed.
uuidString!UUID of the finding to be dismissed.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
securityFindingPipelineSecurityReportFindingDismissed finding.
uuidStringUUID of dismissed finding.

Mutation.securityFindingRevertToDetected

Input type: SecurityFindingRevertToDetectedInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment that explains why finding was reverted to detected status.
uuidString!UUID of the finding to be dismissed.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
securityFindingPipelineSecurityReportFindingFinding reverted to detected.

Mutation.securityFindingSeverityOverride

Input type: SecurityFindingSeverityOverrideInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
severityVulnerabilitySeverity!New severity value for the finding.
uuidString!UUID of the finding to modify.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
securityFindingPipelineSecurityReportFindingFinding of which the severity was modified.

Mutation.securityPolicyProjectAssign

Assigns the specified project(security_policy_project_id) as security policy project for the given project(full_path). If the project already has a security policy project, this reassigns the project’s security policy project with the given security_policy_project_id.

Input type: SecurityPolicyProjectAssignInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathStringFull path of the project or group.
projectPath warning-solidIDDeprecated: Use fullPath. Deprecated in GitLab 14.10.
securityPolicyProjectIdProjectID!ID of the security policy project.

Fields

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

Mutation.securityPolicyProjectCreate

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

Input type: SecurityPolicyProjectCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathStringFull path of the project or group.
projectPath warning-solidIDDeprecated: Use fullPath. Deprecated in GitLab 14.10.

Fields

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

Mutation.securityPolicyProjectCreateAsync

Status: Experiment. Creates and assigns a security policy project for the given project or group (full_path) async.

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Input type: SecurityPolicyProjectCreateAsyncInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathString!Full path of the project or group.

Fields

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

Mutation.securityPolicyProjectUnassign

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

Input type: SecurityPolicyProjectUnassignInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
fullPathStringFull path of the project or group.
projectPath warning-solidIDDeprecated: Use fullPath. Deprecated in GitLab 14.10.

Fields

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

Mutation.securityTrainingUpdate

Input type: SecurityTrainingUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
isEnabledBoolean!Sets the training provider as enabled for the project.
isPrimaryBooleanSets the training provider as primary for the project.
projectPathID!Full path of the project.
providerIdSecurityTrainingProviderID!ID of the provider.

Fields

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

Mutation.setContainerScanningForRegistry

Enable/disable Container Scanning on Container Registry for the given project.

Input type: SetContainerScanningForRegistryInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for Container Scanning on Container Registry feature.
namespacePathID!Full path of the namespace (project).

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerScanningForRegistryEnabledBooleanWhether the feature is enabled.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.setGroupSecretPushProtection

Enable or disable Secret Push Protection for a group.

Input type: SetGroupSecretPushProtectionInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Full path of the group.
projectsToExclude[Int!]IDs of projects to exclude from the feature.
secretPushProtectionEnabledBoolean!Whether to enable the feature.

Fields

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

Mutation.setPreReceiveSecretDetection

Enable/disable secret push protection for the given project.

Input type: SetPreReceiveSecretDetectionInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for secret push protection feature.
namespacePathID!Full path of the namespace (project).

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
preReceiveSecretDetectionEnabledBooleanWhether the feature is enabled.
secretPushProtectionEnabledBooleanWhether the feature is enabled.

Mutation.setSecretPushProtection

Enable/disable secret push protection for the given project.

Input type: SetSecretPushProtectionInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enableBoolean!Desired status for secret push protection feature.
namespacePathID!Full path of the namespace (project).

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
preReceiveSecretDetectionEnabledBooleanWhether the feature is enabled.
secretPushProtectionEnabledBooleanWhether the feature is enabled.

Mutation.starProject

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Input type: StarProjectInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectIdProjectID!Full path of the project to star or unstar.
starredBoolean!Indicates whether to star or unstar the project.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
countString!Number of stars for the project.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.tagCreate

Input type: TagCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
messageStringTagging message.
nameString!Name of the tag.
projectPathID!Project full path the branch is associated with.
refString!Tag name or commit SHA to create tag from.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
tagTagTag after mutation.

Mutation.tagDelete

Input type: TagDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the tag.
projectPathID!Project full path the branch is associated with.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
tagTagTag after mutation.

Mutation.terraformStateDelete

Input type: TerraformStateDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTerraformStateID!Global ID of the Terraform state.

Fields

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

Mutation.terraformStateLock

Input type: TerraformStateLockInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTerraformStateID!Global ID of the Terraform state.

Fields

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

Mutation.terraformStateUnlock

Input type: TerraformStateUnlockInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTerraformStateID!Global ID of the Terraform state.

Fields

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

Mutation.timelineEventCreate

  • Introduced in GitLab 15.6.
  • Status: Experiment.

Input type: TimelineEventCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
incidentIdIssueID!Incident ID of the timeline event.
noteString!Text note of the timeline event.
occurredAtTime!Timestamp of when the event occurred.
timelineEventTagNames[String!]Tags for the incident timeline event.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
timelineEventTimelineEventTypeTimeline event.

Mutation.timelineEventDestroy

Input type: TimelineEventDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementTimelineEventID!Timeline event ID to remove.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
timelineEventTimelineEventTypeTimeline event.

Mutation.timelineEventPromoteFromNote

Input type: TimelineEventPromoteFromNoteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
noteIdNoteID!Note ID from which the timeline event promoted.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
timelineEventTimelineEventTypeTimeline event.

Mutation.timelineEventTagCreate

Input type: TimelineEventTagCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Name of the tag.
projectPathID!Project to create the timeline event tag in.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
timelineEventTagTimelineEventTagTypeTimeline event tag.

Mutation.timelineEventUpdate

Input type: TimelineEventUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idIncidentManagementTimelineEventID!ID of the timeline event to update.
noteStringText note of the timeline event.
occurredAtTimeTimestamp when the event occurred.
timelineEventTagNames[String!]Tags for the incident timeline event.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
timelineEventTimelineEventTypeTimeline event.

Mutation.timelogCreate

Input type: TimelogCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
issuableIdIssuableID!Global ID of the issuable (Issue, WorkItem or MergeRequest).
spentAtTimeTimestamp of when the time was spent. If empty, defaults to current time.
summaryString!Summary of time spent.
timeSpentString!Amount of time spent.

Fields

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

Mutation.timelogDelete

Input type: TimelogDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTimelogID!Global ID of the timelog.

Fields

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

Mutation.todoCreate

Input type: TodoCreateInput

Arguments

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

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
todoTodoTo-do item created.

Mutation.todoMarkDone

Input type: TodoMarkDoneInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTodoID!Global ID of the to-do item to mark as done.

Fields

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

Mutation.todoResolveMany

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: TodoResolveManyInput

Arguments

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

Fields

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

Mutation.todoRestore

Input type: TodoRestoreInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTodoID!Global ID of the to-do item to restore.

Fields

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

Mutation.todoRestoreMany

Input type: TodoRestoreManyInput

Arguments

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

Fields

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

Mutation.todoSnooze

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: TodoSnoozeInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTodoID!Global ID of the to-do item to be snoozed.
snoozeUntilTime!Time until which the todo should be snoozed.

Fields

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

Mutation.todoSnoozeMany

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: TodoSnoozeManyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[TodoID!]!Global IDs of the to-do items to process (a maximum of 100 is supported at once).
snoozeUntilTime!Time until which the todos should be snoozed.

Fields

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

Mutation.todoUnSnooze

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: TodoUnSnoozeInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idTodoID!Global ID of the to-do item to be snoozed.

Fields

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

Mutation.todoUnsnoozeMany

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: TodoUnsnoozeManyInput

Arguments

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

Fields

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

Mutation.todosMarkAllDone

Input type: TodosMarkAllDoneInput

Arguments

NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
clientMutationIdStringA unique identifier for the client performing the mutation.
groupId[ID!]ID of a group.
projectId[ID!]ID of a project.
targetIdTodoableIDGlobal ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported. If argument is omitted, all pending to-do items of the current user are marked as done.
type[TodoTargetEnum!]Type of the todo.

Fields

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

Mutation.updateAbuseReportNote

Updates an abuse report Note.

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Input type: UpdateAbuseReportNoteInput

Arguments

NameTypeDescription
bodyString!Content of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
idAntiAbuseReportsNoteID!Global ID of the note to update.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteAbuseReportNote!Abuse report note after mutation.

Mutation.updateAlertStatus

Input type: UpdateAlertStatusInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
iidString!IID of the alert to mutate.
projectPathID!Project the alert to mutate is in.
statusAlertManagementStatus!Status to set the alert.

Fields

NameTypeDescription
alertAlertManagementAlertAlert after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue created after mutation.
todoTodoTo-do item after mutation.

Mutation.updateBoard

Input type: UpdateBoardInput

Arguments

NameTypeDescription
assigneeIdUserIDID of user to be assigned to the board.
clientMutationIdStringA unique identifier for the client performing the mutation.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
idBoardID!Board global ID.
iterationCadenceIdIterationsCadenceIDID of iteration cadence to be assigned to the board.
iterationIdIterationIDID of iteration to be assigned to the board.
labelIds[LabelID!]IDs of labels to be added to the board.
labels[String!]Labels of the issue.
milestoneIdMilestoneIDID of milestone to be assigned to the board.
nameStringBoard name.
weightIntWeight value to be assigned to the board.

Fields

NameTypeDescription
boardBoardBoard after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateBoardEpicUserPreferences

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: UpdateBoardEpicUserPreferencesInput

Arguments

NameTypeDescription
boardIdBoardID!Board global ID.
clientMutationIdStringA unique identifier for the client performing the mutation.
collapsedBoolean!Whether the epic should be collapsed in the board.
epicIdEpicID!ID of an epic to set preferences for.

Fields

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

Mutation.updateBoardList

Input type: UpdateBoardListInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
collapsedBooleanIndicates if the list is collapsed for the user.
listIdListID!Global ID of the list.
positionIntPosition of list within the board.

Fields

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

Mutation.updateComplianceFramework

Input type: UpdateComplianceFrameworkInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementFrameworkID!Global ID of the compliance framework to update.
paramsComplianceFrameworkInput!Parameters to update the compliance framework with.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
complianceFrameworkComplianceFrameworkCompliance framework after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateComplianceRequirement

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Input type: UpdateComplianceRequirementInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementComplianceFrameworkComplianceRequirementID!Global ID of the compliance requirement to update.
paramsComplianceRequirementInput!Parameters to update the compliance requirement with.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
requirementComplianceRequirementCompliance requirement after updation.

Mutation.updateComplianceRequirementsControl

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: UpdateComplianceRequirementsControlInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idComplianceManagementComplianceFrameworkComplianceRequirementsControlID!Global ID of the compliance requirement control to update.
paramsComplianceRequirementsControlInput!Parameters to update the compliance requirement control with.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
requirementsControlComplianceRequirementsControlCompliance requirement control after updation.

Mutation.updateContainerExpirationPolicy

Input type: UpdateContainerExpirationPolicyInput

Arguments

NameTypeDescription
cadenceContainerExpirationPolicyCadenceEnumSchedule of the container expiration policy.
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanIndicates whether the container expiration policy is enabled.
keepNContainerExpirationPolicyKeepEnumNumber of tags to retain.
nameRegexUntrustedRegexpTags with names matching the regex pattern will expire.
nameRegexKeepUntrustedRegexpTags with names matching the regex pattern will be preserved.
olderThanContainerExpirationPolicyOlderThanEnumTags older than the given age will expire.
projectPathID!Project path where the container expiration policy is located.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerExpirationPolicy warning-solidContainerExpirationPolicyDeprecated: Use container_tags_expiration_policy. Deprecated in GitLab 17.5.
containerTagsExpirationPolicyContainerTagsExpirationPolicyContainer tags expiration policy after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateContainerProtectionRepositoryRule

Updates a container repository protection rule that controls who can modify container images based on user roles.

Input type: UpdateContainerProtectionRepositoryRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRegistryProtectionRuleID!Global ID of the container repository protection rule to be updated.
minimumAccessLevelForDeleteContainerProtectionRepositoryRuleAccessLevelMinimum 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.
minimumAccessLevelForPushContainerProtectionRepositoryRuleAccessLevelMinimum 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.
repositoryPathPatternStringContainer 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.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionRepositoryRuleContainerProtectionRepositoryRuleContainer repository protection rule after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateContainerProtectionTagRule

Updates a protection rule that controls which user roles can modify container image tags matching a specified pattern. Available only when feature flag container_registry_protected_tags is enabled.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Input type: UpdateContainerProtectionTagRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idContainerRegistryProtectionTagRuleID!Global ID of the tag protection rule to update.
minimumAccessLevelForDelete warning-solidContainerProtectionTagRuleAccessLevelDeprecated: Status: Experiment. Introduced in GitLab 17.8.
minimumAccessLevelForPush warning-solidContainerProtectionTagRuleAccessLevelDeprecated: Status: Experiment. Introduced in GitLab 17.8.
tagNamePattern warning-solidStringDeprecated: Status: Experiment. Introduced in GitLab 17.8.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
containerProtectionTagRule warning-solidContainerProtectionTagRuleDeprecated: Status: Experiment. Introduced in GitLab 17.8.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateDependencyProxyImageTtlGroupPolicy

These settings can be adjusted only by the group Owner.

Input type: UpdateDependencyProxyImageTtlGroupPolicyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanIndicates whether the policy is enabled or disabled.
groupPathID!Group path for the group dependency proxy image TTL policy.
ttlIntNumber of days to retain a cached image file.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dependencyProxyImageTtlPolicyDependencyProxyImageTtlGroupPolicyGroup image TTL policy after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateDependencyProxyPackagesSettings

Updates or creates dependency proxy for packages settings. Requires the packages and dependency proxy to be enabled in the config. Requires the packages feature to be enabled at the project level.

Input type: UpdateDependencyProxyPackagesSettingsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanIndicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryPasswordStringPassword for the external Maven packages registry. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time.
mavenExternalRegistryUrlStringURL for the external Maven packages registry.
mavenExternalRegistryUsernameStringUsername for the external Maven packages registry.
projectPathID!Project path for the dependency proxy for packages settings.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dependencyProxyPackagesSettingDependencyProxyPackagesSettingDependency proxy for packages settings after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateDependencyProxySettings

These settings can be adjusted only by the group Owner.

Input type: UpdateDependencyProxySettingsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
enabledBooleanIndicates whether the policy is enabled or disabled.
groupPathID!Group path for the group dependency proxy.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
dependencyProxySettingDependencyProxySettingGroup dependency proxy settings after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateEpic

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: UpdateEpicInput

Arguments

NameTypeDescription
addLabelIds[ID!]IDs of labels to be added to the epic.
addLabels[String!]Array of labels to be added to the epic.
clientMutationIdStringA unique identifier for the client performing the mutation.
colorColorColor of the epic.
confidentialBooleanIndicates if the epic is confidential.
descriptionStringDescription of the epic.
dueDateFixedStringEnd date of the epic.
dueDateIsFixedBooleanIndicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPathID!Group the epic to mutate is in.
iidID!IID of the epic to mutate.
removeLabelIds[ID!]IDs of labels to be removed from the epic.
removeLabels[String!]Array of labels to be removed from the epic.
startDateFixedStringStart date of the epic.
startDateIsFixedBooleanIndicates start date should be sourced from start_date_fixed field not the issue milestones.
stateEventEpicStateEventState event for the epic.
titleStringTitle of the epic.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicEpic after mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.updateEpicBoardList

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Input type: UpdateEpicBoardListInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
collapsedBooleanIndicates if the list is collapsed for the user.
listIdBoardsEpicListID!Global ID of the epic list.
positionIntPosition of list within the board.

Fields

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

Mutation.updateImageDiffNote

Updates a DiffNote on an image (a Note where the position.positionType is "image"). If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.

Input type: UpdateImageDiffNoteInput

Arguments

NameTypeDescription
bodyStringContent of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
idNoteID!Global ID of the note to update.
positionUpdateDiffImagePositionInputPosition of the note on a diff.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.updateIssue

Input type: UpdateIssueInput

Arguments

NameTypeDescription
addLabelIds[ID!]IDs of labels to be added to the issue.
clientMutationIdStringA unique identifier for the client performing the mutation.
confidentialBooleanIndicates the issue is confidential.
descriptionStringDescription of the issue.
dueDateISO8601DateDue date of the issue.
epicId warning-solidEpicIDDeprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
healthStatusHealthStatusDesired health status.
iidString!IID of the issue to mutate.
labelIds[ID!]IDs of labels to be set. Replaces existing issue labels.
lockedBooleanIndicates discussion is locked on the issue.
milestoneIdIDID of the milestone to assign to the issue. On update milestone will be removed if set to null.
projectPathID!Project the issue to mutate is in.
removeLabelIds[ID!]IDs of labels to be removed from the issue.
stateEventIssueStateEventClose or reopen an issue.
timeEstimateStringEstimated time to complete the issue. Use null or 0 to remove the current estimate.
titleStringTitle of the issue.
typeIssueTypeType of the issue.
weightIntWeight of the issue.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue after mutation.

Mutation.updateIteration

Input type: UpdateIterationInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the iteration.
dueDateStringEnd date of the iteration.
groupPathID!Group of the iteration.
idID!Global ID of the iteration.
startDateStringStart date of the iteration.
titleStringTitle of the iteration.

Fields

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

Mutation.updateNamespacePackageSettings

These settings can be adjusted only by the group Owner.

Input type: UpdateNamespacePackageSettingsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
genericDuplicateExceptionRegexUntrustedRegexpWhen generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
genericDuplicatesAllowedBooleanIndicates whether duplicate generic packages are allowed for this namespace.
lockMavenPackageRequestsForwardingBooleanIndicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwardingBooleanIndicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwardingBooleanIndicates whether PyPI package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegexUntrustedRegexpWhen maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
mavenDuplicatesAllowedBooleanIndicates whether duplicate Maven packages are allowed for this namespace.
mavenPackageRequestsForwardingBooleanIndicates whether Maven package forwarding is allowed for this namespace.
namespacePathID!Namespace path where the namespace package setting is located.
npmPackageRequestsForwardingBooleanIndicates whether npm package forwarding is allowed for this namespace.
nugetDuplicateExceptionRegexUntrustedRegexpWhen nuget_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
nugetDuplicatesAllowedBooleanIndicates whether duplicate NuGet packages are allowed for this namespace.
nugetSymbolServerEnabledBooleanIndicates wheather the NuGet symbol server is enabled for this namespace.
pypiPackageRequestsForwardingBooleanIndicates whether PyPI package forwarding is allowed for this namespace.
terraformModuleDuplicateExceptionRegexUntrustedRegexpWhen terraform_module_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
terraformModuleDuplicatesAllowedBooleanIndicates whether duplicate Terraform packages are allowed for this namespace.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
packageSettingsPackageSettingsNamespace package setting after mutation.

Mutation.updateNote

Updates a Note. If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.

Input type: UpdateNoteInput

Arguments

NameTypeDescription
bodyStringContent of the note.
clientMutationIdStringA unique identifier for the client performing the mutation.
idNoteID!Global ID of the note to update.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
noteNoteNote after mutation.
quickActionsStatusQuickActionsStatusStatus of quick actions after mutation.

Mutation.updatePackagesCleanupPolicy

Input type: UpdatePackagesCleanupPolicyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
keepNDuplicatedPackageFilesPackagesCleanupKeepDuplicatedPackageFilesEnumNumber of duplicated package files to retain.
projectPathID!Project path where the packages cleanup policy is located.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
packagesCleanupPolicyPackagesCleanupPolicyPackages cleanup policy after mutation.

Mutation.updatePackagesProtectionRule

Updates a package protection rule to restrict access to project packages. You can prevent users without certain permissions from altering packages.

Input type: UpdatePackagesProtectionRuleInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idPackagesProtectionRuleID!Global ID of the package protection rule to be updated.
minimumAccessLevelForPushPackagesProtectionRuleAccessLevelMinimum 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.
packageNamePatternStringPackage name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageTypePackagesProtectionRulePackageTypePackage type protected by the protection rule. For example, NPM, PYPI.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
packageProtectionRulePackagesProtectionRulePackages protection rule after mutation.

Mutation.updateRequirement

Input type: UpdateRequirementInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the requirement.
iid warning-solidStringDeprecated: Use work_item_iid instead. Deprecated in GitLab 15.8.
lastTestReportStateTestReportStateCreates a test report for the requirement with the given state.
projectPathID!Full project path the requirement is associated with.
stateRequirementStateState of the requirement.
titleStringTitle of the requirement.
workItemIidStringIID of the requirement work item to update.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
requirementRequirementRequirement after mutation.

Mutation.updateSnippet

Input type: UpdateSnippetInput

Arguments

NameTypeDescription
blobActions[SnippetBlobActionInputType!]Actions to perform over the snippet repository and blobs.
clientMutationIdStringA unique identifier for the client performing the mutation.
descriptionStringDescription of the snippet.
idSnippetID!Global ID of the snippet to update.
titleStringTitle of the snippet.
visibilityLevelVisibilityLevelsEnumVisibility level of the snippet.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
snippetSnippetSnippet after mutation.

Mutation.uploadDelete

Deletes an upload.

Input type: UploadDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
filenameString!Upload filename.
groupPathIDFull path of the group with which the resource is associated.
projectPathIDFull path of the project with which the resource is associated.
secretString!Secret part of upload path.

Fields

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

Mutation.userAchievementPrioritiesUpdate

  • Introduced in GitLab 16.5.
  • Status: Experiment.

Input type: UserAchievementPrioritiesUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
userAchievementIds[AchievementsUserAchievementID!]!Global IDs of the user achievements being prioritized, ordered from highest to lowest priority.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userAchievements[UserAchievement!]!Updated user achievements.

Mutation.userAchievementsDelete

  • Introduced in GitLab 16.1.
  • Status: Experiment.

Input type: UserAchievementsDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being deleted.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userAchievementUserAchievementDeleted user achievement.

Mutation.userAchievementsUpdate

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Input type: UserAchievementsUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
showOnProfileBoolean!Indicates whether or not the user achievement is visible on the profile.
userAchievementIdAchievementsUserAchievementID!Global ID of the user achievement being updated.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userAchievementUserAchievementAchievement award.

Mutation.userAddOnAssignmentBulkCreate

Input type: UserAddOnAssignmentBulkCreateInput

Arguments

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be assigned to.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIds[UserID!]!Global IDs of user to be assigned.

Fields

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.userAddOnAssignmentBulkRemove

Input type: UserAddOnAssignmentBulkRemoveInput

Arguments

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be unassigned from.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIds[UserID!]!Global IDs of user to be unassigned.

Fields

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.

Mutation.userAddOnAssignmentCreate

Input type: UserAddOnAssignmentCreateInput

Arguments

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase to be assigned to.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIdUserID!Global ID of user to be assigned.

Fields

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userAddOnUserUser who the add-on purchase was assigned to.

Mutation.userAddOnAssignmentRemove

Input type: UserAddOnAssignmentRemoveInput

Arguments

NameTypeDescription
addOnPurchaseIdGitlabSubscriptionsAddOnPurchaseID!Global ID of AddOnPurchase assignment belongs to.
clientMutationIdStringA unique identifier for the client performing the mutation.
userIdUserID!Global ID of user whose assignment will be removed.

Fields

NameTypeDescription
addOnPurchaseAddOnPurchaseAddOnPurchase state after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userAddOnUserUser that the add-on was removed from.

Mutation.userCalloutCreate

Input type: UserCalloutCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
featureNameString!Feature name you want to dismiss the callout for.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userCalloutUserCallout!User callout dismissed.

Mutation.userPreferencesUpdate

Input type: UserPreferencesUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
extensionsMarketplaceOptInStatusExtensionsMarketplaceOptInStatusStatus of the Web IDE Extension Marketplace opt-in for the user.
issuesSortIssueSortSort order for issue lists.
mergeRequestsSortMergeRequestSortSort order for issue lists.
organizationGroupsProjectsDisplay warning-solidOrganizationGroupProjectDisplayDeprecated: Status: Experiment. Introduced in GitLab 17.2.
organizationGroupsProjectsSort warning-solidOrganizationGroupProjectSortDeprecated: Status: Experiment. Introduced in GitLab 17.2.
projectsSortProjectSortSort order for projects.
useWorkItemsViewBooleanUse work item view instead of legacy issue view.
visibilityPipelineIdTypeVisibilityPipelineIdTypeDetermines whether the pipeline list shows ID or IID.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
userPreferencesUserPreferencesUser preferences after mutation.

Mutation.userSetNamespaceCommitEmail

Input type: UserSetNamespaceCommitEmailInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
emailIdEmailIDID of the email to set.
namespaceIdNamespaceID!ID of the namespace to set the namespace commit email for.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
namespaceCommitEmailNamespaceCommitEmailUser namespace commit email after mutation.

Mutation.valueStreamCreate

Creates a value stream.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Input type: ValueStreamCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
nameString!Value stream name.
namespacePathID!Full path of the namespace(project or group) the value stream is created in.
settingValueStreamSettingInputValue stream configuration.
stages[ValueStreamStageInput!]Value stream custom stages.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
valueStreamValueStreamCreated value stream.

Mutation.valueStreamDestroy

Destroy a value stream.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Input type: ValueStreamDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAnalyticsCycleAnalyticsValueStreamID!Global ID of the value stream to destroy.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
valueStreamValueStreamValue stream deleted after mutation.

Mutation.valueStreamUpdate

Updates a value stream.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Input type: ValueStreamUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idAnalyticsCycleAnalyticsValueStreamID!Global ID of the value stream to update.
nameStringValue stream name.
settingValueStreamSettingInputValue stream configuration.
stages[ValueStreamStageInput!]Value stream custom stages.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
valueStreamValueStreamUpdated value stream.

Mutation.verifiedNamespaceCreate

Create a verified namespace and mark all child catalog resources with the passed verification level info.

Input type: VerifiedNamespaceCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
namespacePathID!Root namespace path.
verificationLevelCiCatalogResourceVerificationLevel!Verification level used to indicate the verification for namespace given by Gitlab.

Fields

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

Mutation.vulnerabilitiesCreateIssue

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Input type: VulnerabilitiesCreateIssueInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectProjectID!ID of the project to attach the issue to.
vulnerabilityIds[VulnerabilityID!]!IDs of vulnerabilities to link to the given issue. Up to 100 can be provided.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
issueIssueIssue created after mutation.

Mutation.vulnerabilitiesDismiss

Input type: VulnerabilitiesDismissInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReasonVulnerabilityDismissalReasonReason why vulnerability should be dismissed.
vulnerabilityIds[VulnerabilityID!]!IDs of the vulnerabilities to be dismissed (maximum 100 entries).

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
vulnerabilities[Vulnerability!]!Vulnerabilities after state change.

Mutation.vulnerabilitiesRemoveAllFromProject

Remove all Vulnerabilities and related information from a given project. Introduced in GitLab 16.7.

Input type: VulnerabilitiesRemoveAllFromProjectInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
projectIds[ProjectID!]!IDs of project for which all Vulnerabilities should be removed. The deletion will happen in the background so the changes will not be visible immediately.
resolvedOnDefaultBranchBooleanWhen set as true, deletes only the vulnerabilities no longer detected. When set as false, deletes only the vulnerabilities still detected.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
projects[Project!]!Projects for which the deletion was scheduled.

Mutation.vulnerabilitiesSeverityOverride

Input type: vulnerabilitiesSeverityOverrideInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentString!Comment why vulnerability severity was changed (maximum 50,000 characters).
severityVulnerabilitySeverity!New severity value for the severities.
vulnerabilityIds[VulnerabilityID!]!IDs of the vulnerabilities for which severity needs to be changed (maximum 100 entries).

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
vulnerabilities[Vulnerability!]!Vulnerabilities after severity change.

Mutation.vulnerabilityConfirm

Input type: VulnerabilityConfirmInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was confirmed (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be confirmed.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

Mutation.vulnerabilityCreate

Input type: VulnerabilityCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
confirmedAtTimeTimestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is confirmed).
descriptionString!Long text section that describes the vulnerability in more detail.
detectedAtTimeTimestamp of when the vulnerability was first detected (defaults to creation time).
dismissedAtTimeTimestamp of when the vulnerability state changed to dismissed (defaults to creation time if status is dismissed).
identifiers[VulnerabilityIdentifierInput!]!Array of CVE or CWE identifiers for the vulnerability.
nameString!Name of the vulnerability.
projectProjectID!ID of the project to attach the vulnerability to.
resolvedAtTimeTimestamp of when the vulnerability state changed to resolved (defaults to creation time if status is resolved).
scannerVulnerabilityScannerInput!Information about the scanner used to discover the vulnerability.
severityVulnerabilitySeveritySeverity of the vulnerability (defaults to unknown).
solutionStringInstructions for how to fix the vulnerability.
stateVulnerabilityStateState of the vulnerability (defaults to detected).

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
vulnerabilityVulnerabilityVulnerability created.

Mutation.vulnerabilityDismiss

Input type: VulnerabilityDismissInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReasonVulnerabilityDismissalReasonReason why vulnerability should be dismissed.
idVulnerabilityID!ID of the vulnerability to be dismissed.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

Mutation.vulnerabilityExternalIssueLinkCreate

Input type: VulnerabilityExternalIssueLinkCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
externalTrackerVulnerabilityExternalIssueLinkExternalTracker!External tracker type of the external issue link.
idVulnerabilityID!ID of the vulnerability.
linkTypeVulnerabilityExternalIssueLinkType!Type of the external issue link.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
externalIssueLinkVulnerabilityExternalIssueLinkCreated external issue link.

Mutation.vulnerabilityExternalIssueLinkDestroy

Input type: VulnerabilityExternalIssueLinkDestroyInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idVulnerabilitiesExternalIssueLinkID!Global ID of the vulnerability external issue link.

Fields

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

Mutation.vulnerabilityIssueLinkCreate

Input type: VulnerabilityIssueLinkCreateInput

Arguments

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

Fields

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

Mutation.vulnerabilityResolve

Input type: VulnerabilityResolveInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was resolved (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be resolved.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

Mutation.vulnerabilityRevertToDetected

Input type: VulnerabilityRevertToDetectedInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
commentStringComment why vulnerability was reverted to detected (maximum 50,000 characters).
idVulnerabilityID!ID of the vulnerability to be reverted to detected.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
vulnerabilityVulnerabilityVulnerability after state change.

Mutation.workItemAddClosingMergeRequest

Adds a closing merge request to a work item.

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Input type: WorkItemAddClosingMergeRequestInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
contextNamespacePathIDFull path of the context namespace (project or group). Only project full paths are used to find a merge request using a short reference syntax like !1. Ignored for full references and URLs. Defaults to the namespace of the work item if not provided.
idWorkItemID!Global ID of the work item.
mergeRequestReferenceString!Merge request reference (short, full or URL). Example: !1, project_full_path!1 or https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
closingMergeRequestWorkItemClosingMergeRequestClosing merge request added to the work item.
errors[String!]!Errors encountered during execution of the mutation.
workItemWorkItemWork item with new closing merge requests.

Mutation.workItemAddLinkedItems

Add linked items to the work item.

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: WorkItemAddLinkedItemsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
linkTypeWorkItemRelatedLinkTypeType of link. Defaults to RELATED.
workItemsIds[WorkItemID!]!Global IDs of the items to link. Maximum number of IDs you can provide: 10.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
messageStringLinked items update result message.
workItemWorkItemUpdated work item.

Mutation.workItemBulkUpdate

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

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Input type: WorkItemBulkUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
ids[WorkItemID!]!Global ID array of the issues that will be updated. IDs that the user can’t update will be ignored. A max of 100 can be provided.
labelsWidgetWorkItemWidgetLabelsUpdateInputInput for labels widget.
parentIdWorkItemsParentID!Global ID of the parent to which the bulk update will be scoped. The parent can be a project. The parent can also be a group (Premium and Ultimate only). Example WorkItemsParentID are "gid://gitlab/Project/1" and "gid://gitlab/Group/1".

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
updatedWorkItemCountIntNumber of work items that were successfully updated.

Mutation.workItemConvert

Converts the work item to a new type.

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Input type: WorkItemConvertInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
workItemTypeIdWorkItemsTypeID!Global ID of the new work item type.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
workItemWorkItemUpdated work item.

Mutation.workItemCreate

Creates a work item.

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Input type: WorkItemCreateInput

Arguments

NameTypeDescription
assigneesWidgetWorkItemWidgetAssigneesInputInput for assignees widget.
clientMutationIdStringA unique identifier for the client performing the mutation.
colorWidgetWorkItemWidgetColorInputInput for color widget.
confidentialBooleanSets the work item confidentiality.
createdAtTimeTimestamp when the work item was created. Available only for admins and project owners.
crmContactsWidgetWorkItemWidgetCrmContactsCreateInputInput for CRM contacts widget.
description warning-solidStringDeprecated: use description widget instead. Deprecated in GitLab 16.9.
descriptionWidgetWorkItemWidgetDescriptionInputInput for description widget.
discussionsToResolveWorkItemResolveDiscussionsInputInformation required to resolve discussions in a noteable, when the work item is created.
healthStatusWidgetWorkItemWidgetHealthStatusInputInput for health status widget.
hierarchyWidgetWorkItemWidgetHierarchyCreateInputInput for hierarchy widget.
iterationWidgetWorkItemWidgetIterationInputIteration widget of the work item.
labelsWidgetWorkItemWidgetLabelsCreateInputInput for labels widget.
linkedItemsWidgetWorkItemWidgetLinkedItemsCreateInputInput for linked items widget.
milestoneWidgetWorkItemWidgetMilestoneInputInput for milestone widget.
namespacePathIDFull path of the namespace(project or group) the work item is created in.
projectPath warning-solidIDDeprecated: Please use namespacePath instead. That will cover for both projects and groups. Deprecated in GitLab 15.10.
startAndDueDateWidgetWorkItemWidgetStartAndDueDateUpdateInputInput for start and due date widget.
titleString!Title of the work item.
vulnerabilityId warning-solidVulnerabilityIDDeprecated: Status: Experiment. Introduced in GitLab 17.9.
weightWidgetWorkItemWidgetWeightInputInput for weight widget.
workItemTypeIdWorkItemsTypeID!Global ID of a work item type.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
workItemWorkItemCreated work item.

Mutation.workItemCreateFromTask

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

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Input type: WorkItemCreateFromTaskInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
workItemDataWorkItemConvertTaskInput!Arguments necessary to convert a task into a work item.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
newWorkItemWorkItemNew work item created from task.
workItemWorkItemUpdated work item.

Mutation.workItemDelete

Deletes a work item.

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Input type: WorkItemDeleteInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
namespaceNamespaceNamespace the deleted work item belonged to.
project warning-solidProjectDeprecated: Use namespace. Deprecated in GitLab 16.9.

Mutation.workItemExport

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Input type: WorkItemExportInput

Arguments

NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
clientMutationIdStringA unique identifier for the client performing the mutation.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
iids[String!]List of IIDs of work items. For example, ["1", "2"].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
labelName[String!]Labels applied to the work item.
milestoneTitle[String!]Milestone applied to the work item.
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
projectPathID!Full project path.
searchStringSearch query for title or description.
selectedFields[AvailableExportFields!]List of selected fields to be exported. Omit to export all available fields.
stateIssuableStateCurrent state of the work item.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.

Fields

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

Mutation.workItemRemoveLinkedItems

Remove items linked to the work item.

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: WorkItemRemoveLinkedItemsInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
workItemsIds[WorkItemID!]!Global IDs of the items to unlink. Maximum number of IDs you can provide: 10.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
messageStringLinked items update result message.
workItemWorkItemUpdated work item.

Mutation.workItemSubscribe

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Input type: WorkItemSubscribeInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item.
subscribedBoolean!Desired state of the subscription.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
workItemWorkItemWork item after mutation.

Mutation.workItemUpdate

Updates a work item by Global ID.

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Input type: WorkItemUpdateInput

Arguments

NameTypeDescription
assigneesWidgetWorkItemWidgetAssigneesInputInput for assignees widget.
awardEmojiWidgetWorkItemWidgetAwardEmojiUpdateInputInput for emoji reactions widget.
clientMutationIdStringA unique identifier for the client performing the mutation.
colorWidgetWorkItemWidgetColorInputInput for color widget.
confidentialBooleanSets the work item confidentiality.
crmContactsWidgetWorkItemWidgetCrmContactsUpdateInputInput for CRM contacts widget.
currentUserTodosWidgetWorkItemWidgetCurrentUserTodosInputInput for to-dos widget.
descriptionWidgetWorkItemWidgetDescriptionInputInput for description widget.
healthStatusWidgetWorkItemWidgetHealthStatusInputInput for health status widget.
hierarchyWidgetWorkItemWidgetHierarchyUpdateInputInput for hierarchy widget.
idWorkItemID!Global ID of the work item.
iterationWidgetWorkItemWidgetIterationInputInput for iteration widget.
labelsWidgetWorkItemWidgetLabelsUpdateInputInput for labels widget.
milestoneWidgetWorkItemWidgetMilestoneInputInput for milestone widget.
notesWidgetWorkItemWidgetNotesInputInput for notes widget.
notificationsWidgetWorkItemWidgetNotificationsUpdateInputInput for notifications widget.
progressWidgetWorkItemWidgetProgressInputInput for progress widget.
startAndDueDateWidgetWorkItemWidgetStartAndDueDateUpdateInputInput for start and due date widget.
stateEventWorkItemStateEventClose or reopen a work item.
statusWidgetStatusInputInput for status widget.
timeTrackingWidgetWorkItemWidgetTimeTrackingInputInput for time tracking widget.
titleStringTitle of the work item.
weightWidgetWorkItemWidgetWeightInputInput for weight widget.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
workItemWorkItemUpdated work item.

Mutation.workItemsHierarchyReorder

Reorder a work item in the hierarchy tree.

  • Introduced in GitLab 17.3.
  • Status: Experiment.

Input type: workItemsHierarchyReorderInput

Arguments

NameTypeDescription
adjacentWorkItemIdWorkItemIDID of the work item to move next to. For example, the item above or below.
clientMutationIdStringA unique identifier for the client performing the mutation.
idWorkItemID!Global ID of the work item to be reordered.
parentIdWorkItemIDGlobal ID of the new parent work item.
relativePositionRelativePositionTypePosition relative to the adjacent work item. Valid values are BEFORE or AFTER.

Fields

NameTypeDescription
adjacentWorkItemWorkItemAdjacent work item after mutation.
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
parentWorkItemWorkItemWork item’s parent after mutation.
workItemWorkItemWork item after mutation.

Mutation.workspaceCreate

Input type: WorkspaceCreateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
clusterAgentIdClustersAgentID!GlobalID of the cluster agent the created workspace will be associated with.
desiredStateString!Desired state of the created workspace.
devfilePathStringProject path containing the devfile used to configure the workspace. If not provided, the GitLab default devfile is used.
devfileRef warning-solidStringDeprecated: Argument is renamed to project_ref. Deprecated in GitLab 17.8.
editor warning-solidStringDeprecated: Argument is not used. Deprecated in GitLab 17.5.
maxHoursBeforeTermination warning-solidIntDeprecated: Field is not used. Deprecated in GitLab 17.9.
projectIdProjectID!ID of the project that will provide the Devfile for the created workspace.
projectRefStringProject repo git ref.
variables[WorkspaceVariableInput!]Variables to inject into the workspace.

Fields

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

Mutation.workspaceUpdate

Input type: WorkspaceUpdateInput

Arguments

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
desiredStateString!Desired state of the created workspace.
idRemoteDevelopmentWorkspaceID!Global ID of the workspace.

Fields

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

Connections

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

Pagination arguments

All connection fields support the following pagination arguments:

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

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

Connection fields

All connections have at least the following fields:

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

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

Connection types

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

AbuseReportDiscussionConnection

The connection type for AbuseReportDiscussion.

Fields
NameTypeDescription
edges[AbuseReportDiscussionEdge]A list of edges.
nodes[AbuseReportDiscussion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AbuseReportDiscussionEdge

The edge type for AbuseReportDiscussion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAbuseReportDiscussionThe item at the end of the edge.

AbuseReportLabelConnection

The connection type for AbuseReportLabel.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[AbuseReportLabelEdge]A list of edges.
nodes[AbuseReportLabel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AbuseReportLabelEdge

The edge type for AbuseReportLabel.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAbuseReportLabelThe item at the end of the edge.

AbuseReportNoteConnection

The connection type for AbuseReportNote.

Fields
NameTypeDescription
edges[AbuseReportNoteEdge]A list of edges.
nodes[AbuseReportNote]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AbuseReportNoteEdge

The edge type for AbuseReportNote.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAbuseReportNoteThe item at the end of the edge.

AccessLevelDeployKeyConnection

The connection type for AccessLevelDeployKey.

Fields
NameTypeDescription
edges[AccessLevelDeployKeyEdge]A list of edges.
nodes[AccessLevelDeployKey]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AccessLevelDeployKeyEdge

The edge type for AccessLevelDeployKey.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAccessLevelDeployKeyThe item at the end of the edge.

AchievementConnection

The connection type for Achievement.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[AchievementEdge]A list of edges.
nodes[Achievement]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AchievementEdge

The edge type for Achievement.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAchievementThe item at the end of the edge.

AddOnUserConnection

The connection type for AddOnUser.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[AddOnUserEdge]A list of edges.
nodes[AddOnUser]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AddOnUserEdge

The edge type for AddOnUser.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAddOnUserThe item at the end of the edge.

AdminMemberRoleConnection

The connection type for AdminMemberRole.

Fields
NameTypeDescription
edges[AdminMemberRoleEdge]A list of edges.
nodes[AdminMemberRole]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AdminMemberRoleEdge

The edge type for AdminMemberRole.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAdminMemberRoleThe item at the end of the edge.

AgentConfigurationConnection

The connection type for AgentConfiguration.

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

AgentConfigurationEdge

The edge type for AgentConfiguration.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAgentConfigurationThe item at the end of the edge.

AiAgentConnection

The connection type for AiAgent.

Fields
NameTypeDescription
edges[AiAgentEdge]A list of edges.
nodes[AiAgent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiAgentEdge

The edge type for AiAgent.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiAgentThe item at the end of the edge.

AiConversationsThreadConnection

The connection type for AiConversationsThread.

Fields
NameTypeDescription
edges[AiConversationsThreadEdge]A list of edges.
nodes[AiConversationsThread]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiConversationsThreadEdge

The edge type for AiConversationsThread.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiConversationsThreadThe item at the end of the edge.

AiFeatureSettingConnection

The connection type for AiFeatureSetting.

Fields
NameTypeDescription
edges[AiFeatureSettingEdge]A list of edges.
nodes[AiFeatureSetting]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiFeatureSettingEdge

The edge type for AiFeatureSetting.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiFeatureSettingThe item at the end of the edge.

AiMessageConnection

The connection type for AiMessage.

Fields
NameTypeDescription
edges[AiMessageEdge]A list of edges.
nodes[AiMessage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiMessageEdge

The edge type for AiMessage.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiMessageThe item at the end of the edge.

AiSelfHostedModelConnection

The connection type for AiSelfHostedModel.

Fields
NameTypeDescription
edges[AiSelfHostedModelEdge]A list of edges.
nodes[AiSelfHostedModel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiSelfHostedModelEdge

The edge type for AiSelfHostedModel.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiSelfHostedModelThe item at the end of the edge.

AiUserMetricsConnection

The connection type for AiUserMetrics.

Fields
NameTypeDescription
edges[AiUserMetricsEdge]A list of edges.
nodes[AiUserMetrics]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiUserMetricsEdge

The edge type for AiUserMetrics.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiUserMetricsThe item at the end of the edge.

AiXrayReportConnection

The connection type for AiXrayReport.

Fields
NameTypeDescription
edges[AiXrayReportEdge]A list of edges.
nodes[AiXrayReport]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AiXrayReportEdge

The edge type for AiXrayReport.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAiXrayReportThe item at the end of the edge.

AlertManagementAlertConnection

The connection type for AlertManagementAlert.

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

AlertManagementAlertEdge

The edge type for AlertManagementAlert.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAlertManagementAlertThe item at the end of the edge.

AlertManagementHttpIntegrationConnection

The connection type for AlertManagementHttpIntegration.

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

AlertManagementHttpIntegrationEdge

The edge type for AlertManagementHttpIntegration.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAlertManagementHttpIntegrationThe item at the end of the edge.

AlertManagementIntegrationConnection

The connection type for AlertManagementIntegration.

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

AlertManagementIntegrationEdge

The edge type for AlertManagementIntegration.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAlertManagementIntegrationThe item at the end of the edge.

AmazonS3ConfigurationTypeConnection

The connection type for AmazonS3ConfigurationType.

Fields
NameTypeDescription
edges[AmazonS3ConfigurationTypeEdge]A list of edges.
nodes[AmazonS3ConfigurationType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

AmazonS3ConfigurationTypeEdge

The edge type for AmazonS3ConfigurationType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAmazonS3ConfigurationTypeThe item at the end of the edge.

ApprovalPolicyConnection

The connection type for ApprovalPolicy.

Fields
NameTypeDescription
edges[ApprovalPolicyEdge]A list of edges.
nodes[ApprovalPolicy]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ApprovalPolicyEdge

The edge type for ApprovalPolicy.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeApprovalPolicyThe item at the end of the edge.

ApprovalProjectRuleConnection

The connection type for ApprovalProjectRule.

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

ApprovalProjectRuleEdge

The edge type for ApprovalProjectRule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeApprovalProjectRuleThe item at the end of the edge.

AuditEventDefinitionConnection

The connection type for AuditEventDefinition.

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

AuditEventDefinitionEdge

The edge type for AuditEventDefinition.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAuditEventDefinitionThe item at the end of the edge.

AuditEventStreamingHeaderConnection

The connection type for AuditEventStreamingHeader.

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

AuditEventStreamingHeaderEdge

The edge type for AuditEventStreamingHeader.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAuditEventStreamingHeaderThe item at the end of the edge.

AuditEventsStreamingInstanceHeaderConnection

The connection type for AuditEventsStreamingInstanceHeader.

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

AuditEventsStreamingInstanceHeaderEdge

The edge type for AuditEventsStreamingInstanceHeader.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAuditEventsStreamingInstanceHeaderThe item at the end of the edge.

AwardEmojiConnection

The connection type for AwardEmoji.

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

AwardEmojiEdge

The edge type for AwardEmoji.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeAwardEmojiThe item at the end of the edge.

BlobConnection

The connection type for Blob.

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

BlobEdge

The edge type for Blob.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBlobThe item at the end of the edge.

BoardConnection

The connection type for Board.

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

BoardEdge

The edge type for Board.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBoardThe item at the end of the edge.

BoardEpicConnection

The connection type for BoardEpic.

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

BoardEpicEdge

The edge type for BoardEpic.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBoardEpicThe item at the end of the edge.

BoardListConnection

The connection type for BoardList.

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

BoardListEdge

The edge type for BoardList.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBoardListThe item at the end of the edge.

BranchRuleConnection

The connection type for BranchRule.

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

BranchRuleEdge

The edge type for BranchRule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeBranchRuleThe item at the end of the edge.

CiBuildNeedConnection

The connection type for CiBuildNeed.

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

CiBuildNeedEdge

The edge type for CiBuildNeed.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiBuildNeedThe item at the end of the edge.

CiCatalogResourceComponentConnection

The connection type for CiCatalogResourceComponent.

Fields
NameTypeDescription
edges[CiCatalogResourceComponentEdge]A list of edges.
nodes[CiCatalogResourceComponent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiCatalogResourceComponentEdge

The edge type for CiCatalogResourceComponent.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceComponentThe item at the end of the edge.

CiCatalogResourceComponentUsageConnection

The connection type for CiCatalogResourceComponentUsage.

Fields
NameTypeDescription
edges[CiCatalogResourceComponentUsageEdge]A list of edges.
nodes[CiCatalogResourceComponentUsage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiCatalogResourceComponentUsageEdge

The edge type for CiCatalogResourceComponentUsage.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceComponentUsageThe item at the end of the edge.

CiCatalogResourceConnection

The connection type for CiCatalogResource.

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

CiCatalogResourceEdge

The edge type for CiCatalogResource.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceThe item at the end of the edge.

CiCatalogResourceVersionConnection

The connection type for CiCatalogResourceVersion.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[CiCatalogResourceVersionEdge]A list of edges.
nodes[CiCatalogResourceVersion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiCatalogResourceVersionEdge

The edge type for CiCatalogResourceVersion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiCatalogResourceVersionThe item at the end of the edge.

CiConfigGroupConnection

The connection type for CiConfigGroup.

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

CiConfigGroupEdge

The edge type for CiConfigGroup.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiConfigGroupThe item at the end of the edge.

CiConfigJobConnection

The connection type for CiConfigJob.

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

CiConfigJobEdge

The edge type for CiConfigJob.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiConfigJobThe item at the end of the edge.

CiConfigNeedConnection

The connection type for CiConfigNeed.

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

CiConfigNeedEdge

The edge type for CiConfigNeed.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiConfigNeedThe item at the end of the edge.

CiConfigStageConnection

The connection type for CiConfigStage.

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

CiConfigStageEdge

The edge type for CiConfigStage.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiConfigStageThe item at the end of the edge.

CiGroupConnection

The connection type for CiGroup.

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

CiGroupEdge

The edge type for CiGroup.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiGroupThe item at the end of the edge.

CiGroupEnvironmentScopeConnection

The connection type for CiGroupEnvironmentScope.

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

CiGroupEnvironmentScopeEdge

The edge type for CiGroupEnvironmentScope.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiGroupEnvironmentScopeThe item at the end of the edge.

CiGroupVariableConnection

The connection type for CiGroupVariable.

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

CiGroupVariableEdge

The edge type for CiGroupVariable.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiGroupVariableThe item at the end of the edge.

CiInstanceVariableConnection

The connection type for CiInstanceVariable.

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

CiInstanceVariableEdge

The edge type for CiInstanceVariable.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiInstanceVariableThe item at the end of the edge.

CiJobArtifactConnection

The connection type for CiJobArtifact.

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

CiJobArtifactEdge

The edge type for CiJobArtifact.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobArtifactThe item at the end of the edge.

CiJobConnection

The connection type for CiJob.

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

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

Returns Int!.

####### Arguments

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

CiJobEdge

The edge type for CiJob.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobThe item at the end of the edge.

CiJobTokenAccessibleGroupConnection

The connection type for CiJobTokenAccessibleGroup.

Fields
NameTypeDescription
edges[CiJobTokenAccessibleGroupEdge]A list of edges.
nodes[CiJobTokenAccessibleGroup]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiJobTokenAccessibleGroupEdge

The edge type for CiJobTokenAccessibleGroup.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobTokenAccessibleGroupThe item at the end of the edge.

CiJobTokenAccessibleProjectConnection

The connection type for CiJobTokenAccessibleProject.

Fields
NameTypeDescription
edges[CiJobTokenAccessibleProjectEdge]A list of edges.
nodes[CiJobTokenAccessibleProject]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiJobTokenAccessibleProjectEdge

The edge type for CiJobTokenAccessibleProject.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobTokenAccessibleProjectThe item at the end of the edge.

CiJobTokenAuthLogConnection

The connection type for CiJobTokenAuthLog.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[CiJobTokenAuthLogEdge]A list of edges.
nodes[CiJobTokenAuthLog]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiJobTokenAuthLogEdge

The edge type for CiJobTokenAuthLog.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobTokenAuthLogThe item at the end of the edge.

CiJobTokenScopeAllowlistEntryConnection

The connection type for CiJobTokenScopeAllowlistEntry.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[CiJobTokenScopeAllowlistEntryEdge]A list of edges.
nodes[CiJobTokenScopeAllowlistEntry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiJobTokenScopeAllowlistEntryEdge

The edge type for CiJobTokenScopeAllowlistEntry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiJobTokenScopeAllowlistEntryThe item at the end of the edge.

CiManualVariableConnection

The connection type for CiManualVariable.

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

CiManualVariableEdge

The edge type for CiManualVariable.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiManualVariableThe item at the end of the edge.

CiMinutesNamespaceMonthlyUsageConnection

The connection type for CiMinutesNamespaceMonthlyUsage.

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

CiMinutesNamespaceMonthlyUsageEdge

The edge type for CiMinutesNamespaceMonthlyUsage.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiMinutesNamespaceMonthlyUsageThe item at the end of the edge.

CiMinutesProjectMonthlyUsageConnection

The connection type for CiMinutesProjectMonthlyUsage.

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

CiMinutesProjectMonthlyUsageEdge

The edge type for CiMinutesProjectMonthlyUsage.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiMinutesProjectMonthlyUsageThe item at the end of the edge.

CiProjectSubscriptionConnection

The connection type for CiProjectSubscription.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[CiProjectSubscriptionEdge]A list of edges.
nodes[CiProjectSubscription]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiProjectSubscriptionEdge

The edge type for CiProjectSubscription.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiProjectSubscriptionThe item at the end of the edge.

CiProjectVariableConnection

The connection type for CiProjectVariable.

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

CiProjectVariableEdge

The edge type for CiProjectVariable.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiProjectVariableThe item at the end of the edge.

CiRunnerConnection

The connection type for CiRunner.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[CiRunnerEdge]A list of edges.
jobsStatisticsCiJobsStatisticsJobs statistics for jobs executed by a collection of runners. Available only to admins.
nodes[CiRunner]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiRunnerEdge

The edge type for CiRunner.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
editUrlStringWeb 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.
nodeCiRunnerThe item at the end of the edge.
webUrlStringWeb URL of the runner. The value depends on where you put the field in the query. You can use it for projects or groups.

CiRunnerManagerConnection

The connection type for CiRunnerManager.

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

CiRunnerManagerEdge

The edge type for CiRunnerManager.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiRunnerManagerThe item at the end of the edge.

CiSecureFileRegistryConnection

The connection type for CiSecureFileRegistry.

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

CiSecureFileRegistryEdge

The edge type for CiSecureFileRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiSecureFileRegistryThe item at the end of the edge.

CiStageConnection

The connection type for CiStage.

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

CiStageEdge

The edge type for CiStage.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiStageThe item at the end of the edge.

CiSubscriptionsProjectConnection

The connection type for CiSubscriptionsProject.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[CiSubscriptionsProjectEdge]A list of edges.
nodes[CiSubscriptionsProject]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CiSubscriptionsProjectEdge

The edge type for CiSubscriptionsProject.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCiSubscriptionsProjectThe item at the end of the edge.

ClusterAgentActivityEventConnection

The connection type for ClusterAgentActivityEvent.

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

ClusterAgentActivityEventEdge

The edge type for ClusterAgentActivityEvent.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeClusterAgentActivityEventThe item at the end of the edge.

ClusterAgentAuthorizationCiAccessConnection

The connection type for ClusterAgentAuthorizationCiAccess.

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

ClusterAgentAuthorizationCiAccessEdge

The edge type for ClusterAgentAuthorizationCiAccess.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeClusterAgentAuthorizationCiAccessThe item at the end of the edge.

ClusterAgentAuthorizationUserAccessConnection

The connection type for ClusterAgentAuthorizationUserAccess.

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

ClusterAgentAuthorizationUserAccessEdge

The edge type for ClusterAgentAuthorizationUserAccess.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeClusterAgentAuthorizationUserAccessThe item at the end of the edge.

ClusterAgentConnection

The connection type for ClusterAgent.

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

ClusterAgentEdge

The edge type for ClusterAgent.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeClusterAgentThe item at the end of the edge.

ClusterAgentTokenConnection

The connection type for ClusterAgentToken.

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

ClusterAgentTokenEdge

The edge type for ClusterAgentToken.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeClusterAgentTokenThe item at the end of the edge.

ClusterAgentUrlConfigurationConnection

The connection type for ClusterAgentUrlConfiguration.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[ClusterAgentUrlConfigurationEdge]A list of edges.
nodes[ClusterAgentUrlConfiguration]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ClusterAgentUrlConfigurationEdge

The edge type for ClusterAgentUrlConfiguration.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeClusterAgentUrlConfigurationThe item at the end of the edge.

CodeCoverageActivityConnection

The connection type for CodeCoverageActivity.

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

CodeCoverageActivityEdge

The edge type for CodeCoverageActivity.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCodeCoverageActivityThe item at the end of the edge.

CodeQualityDegradationConnection

The connection type for CodeQualityDegradation.

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

CodeQualityDegradationEdge

The edge type for CodeQualityDegradation.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCodeQualityDegradationThe item at the end of the edge.

CodeSuggestionEventConnection

The connection type for CodeSuggestionEvent.

Fields
NameTypeDescription
edges[CodeSuggestionEventEdge]A list of edges.
nodes[CodeSuggestionEvent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CodeSuggestionEventEdge

The edge type for CodeSuggestionEvent.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCodeSuggestionEventThe item at the end of the edge.

CommitConnection

The connection type for Commit.

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

CommitEdge

The edge type for Commit.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCommitThe item at the end of the edge.

ComplianceFrameworkConnection

The connection type for ComplianceFramework.

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

ComplianceFrameworkEdge

The edge type for ComplianceFramework.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeComplianceFrameworkThe item at the end of the edge.

ComplianceRequirementConnection

The connection type for ComplianceRequirement.

Fields
NameTypeDescription
edges[ComplianceRequirementEdge]A list of edges.
nodes[ComplianceRequirement]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ComplianceRequirementEdge

The edge type for ComplianceRequirement.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeComplianceRequirementThe item at the end of the edge.

ComplianceRequirementsControlConnection

The connection type for ComplianceRequirementsControl.

Fields
NameTypeDescription
edges[ComplianceRequirementsControlEdge]A list of edges.
nodes[ComplianceRequirementsControl]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ComplianceRequirementsControlEdge

The edge type for ComplianceRequirementsControl.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeComplianceRequirementsControlThe item at the end of the edge.

ComplianceStandardsAdherenceConnection

The connection type for ComplianceStandardsAdherence.

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

ComplianceStandardsAdherenceEdge

The edge type for ComplianceStandardsAdherence.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeComplianceStandardsAdherenceThe item at the end of the edge.

ComplianceViolationConnection

The connection type for ComplianceViolation.

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

ComplianceViolationEdge

The edge type for ComplianceViolation.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeComplianceViolationThe item at the end of the edge.

ConnectedAgentConnection

The connection type for ConnectedAgent.

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

ConnectedAgentEdge

The edge type for ConnectedAgent.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeConnectedAgentThe item at the end of the edge.

ContainerProtectionRepositoryRuleConnection

The connection type for ContainerProtectionRepositoryRule.

Fields
NameTypeDescription
edges[ContainerProtectionRepositoryRuleEdge]A list of edges.
nodes[ContainerProtectionRepositoryRule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ContainerProtectionRepositoryRuleEdge

The edge type for ContainerProtectionRepositoryRule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeContainerProtectionRepositoryRuleThe item at the end of the edge.

ContainerProtectionTagRuleConnection

The connection type for ContainerProtectionTagRule.

Fields
NameTypeDescription
edges[ContainerProtectionTagRuleEdge]A list of edges.
nodes[ContainerProtectionTagRule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ContainerProtectionTagRuleEdge

The edge type for ContainerProtectionTagRule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeContainerProtectionTagRuleThe item at the end of the edge.

ContainerRepositoryConnection

The connection type for ContainerRepository.

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

ContainerRepositoryEdge

The edge type for ContainerRepository.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeContainerRepositoryThe item at the end of the edge.

ContainerRepositoryRegistryConnection

The connection type for ContainerRepositoryRegistry.

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

ContainerRepositoryRegistryEdge

The edge type for ContainerRepositoryRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeContainerRepositoryRegistryThe item at the end of the edge.

ContainerRepositoryTagConnection

The connection type for ContainerRepositoryTag.

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

ContainerRepositoryTagEdge

The edge type for ContainerRepositoryTag.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeContainerRepositoryTagThe item at the end of the edge.

ContributionAnalyticsContributionConnection

The connection type for ContributionAnalyticsContribution.

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

ContributionAnalyticsContributionEdge

The edge type for ContributionAnalyticsContribution.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeContributionAnalyticsContributionThe item at the end of the edge.

CoverageFuzzingCorpusConnection

The connection type for CoverageFuzzingCorpus.

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

CoverageFuzzingCorpusEdge

The edge type for CoverageFuzzingCorpus.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCoverageFuzzingCorpusThe item at the end of the edge.

CustomEmojiConnection

The connection type for CustomEmoji.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[CustomEmojiEdge]A list of edges.
nodes[CustomEmoji]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CustomEmojiEdge

The edge type for CustomEmoji.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomEmojiThe item at the end of the edge.

CustomFieldConnection

The connection type for CustomField.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[CustomFieldEdge]A list of edges.
nodes[CustomField]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CustomFieldEdge

The edge type for CustomField.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomFieldThe item at the end of the edge.

CustomerRelationsContactConnection

The connection type for CustomerRelationsContact.

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

CustomerRelationsContactEdge

The edge type for CustomerRelationsContact.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomerRelationsContactThe item at the end of the edge.

CustomerRelationsOrganizationConnection

The connection type for CustomerRelationsOrganization.

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

CustomerRelationsOrganizationEdge

The edge type for CustomerRelationsOrganization.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomerRelationsOrganizationThe item at the end of the edge.

CustomizableAdminPermissionConnection

The connection type for CustomizableAdminPermission.

Fields
NameTypeDescription
edges[CustomizableAdminPermissionEdge]A list of edges.
nodes[CustomizableAdminPermission]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CustomizableAdminPermissionEdge

The edge type for CustomizableAdminPermission.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomizableAdminPermissionThe item at the end of the edge.

CustomizableDashboardConnection

The connection type for CustomizableDashboard.

Fields
NameTypeDescription
edges[CustomizableDashboardEdge]A list of edges.
nodes[CustomizableDashboard]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CustomizableDashboardEdge

The edge type for CustomizableDashboard.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomizableDashboardThe item at the end of the edge.

CustomizableDashboardPanelConnection

The connection type for CustomizableDashboardPanel.

Fields
NameTypeDescription
edges[CustomizableDashboardPanelEdge]A list of edges.
nodes[CustomizableDashboardPanel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CustomizableDashboardPanelEdge

The edge type for CustomizableDashboardPanel.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomizableDashboardPanelThe item at the end of the edge.

CustomizableDashboardVisualizationConnection

The connection type for CustomizableDashboardVisualization.

Fields
NameTypeDescription
edges[CustomizableDashboardVisualizationEdge]A list of edges.
nodes[CustomizableDashboardVisualization]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CustomizableDashboardVisualizationEdge

The edge type for CustomizableDashboardVisualization.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomizableDashboardVisualizationThe item at the end of the edge.

CustomizableStandardPermissionConnection

The connection type for CustomizableStandardPermission.

Fields
NameTypeDescription
edges[CustomizableStandardPermissionEdge]A list of edges.
nodes[CustomizableStandardPermission]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

CustomizableStandardPermissionEdge

The edge type for CustomizableStandardPermission.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeCustomizableStandardPermissionThe item at the end of the edge.

DastProfileConnection

The connection type for DastProfile.

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

DastProfileEdge

The edge type for DastProfile.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDastProfileThe item at the end of the edge.

DastScannerProfileConnection

The connection type for DastScannerProfile.

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

DastScannerProfileEdge

The edge type for DastScannerProfile.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDastScannerProfileThe item at the end of the edge.

DastSiteProfileConnection

The connection type for DastSiteProfile.

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

DastSiteProfileEdge

The edge type for DastSiteProfile.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDastSiteProfileThe item at the end of the edge.

DastSiteValidationConnection

The connection type for DastSiteValidation.

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

DastSiteValidationEdge

The edge type for DastSiteValidation.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDastSiteValidationThe item at the end of the edge.

DependencyConnection

The connection type for Dependency.

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

DependencyEdge

The edge type for Dependency.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDependencyThe item at the end of the edge.

DependencyProxyBlobConnection

The connection type for DependencyProxyBlob.

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

DependencyProxyBlobEdge

The edge type for DependencyProxyBlob.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDependencyProxyBlobThe item at the end of the edge.

DependencyProxyBlobRegistryConnection

The connection type for DependencyProxyBlobRegistry.

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

DependencyProxyBlobRegistryEdge

The edge type for DependencyProxyBlobRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDependencyProxyBlobRegistryThe item at the end of the edge.

DependencyProxyManifestConnection

The connection type for DependencyProxyManifest.

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

DependencyProxyManifestEdge

The edge type for DependencyProxyManifest.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDependencyProxyManifestThe item at the end of the edge.

DependencyProxyManifestRegistryConnection

The connection type for DependencyProxyManifestRegistry.

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

DependencyProxyManifestRegistryEdge

The edge type for DependencyProxyManifestRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDependencyProxyManifestRegistryThe item at the end of the edge.

DeploymentConnection

The connection type for Deployment.

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

DeploymentEdge

The edge type for Deployment.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDeploymentThe item at the end of the edge.

DesignAtVersionConnection

The connection type for DesignAtVersion.

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

DesignAtVersionEdge

The edge type for DesignAtVersion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDesignAtVersionThe item at the end of the edge.

DesignConnection

The connection type for Design.

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

DesignEdge

The edge type for Design.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDesignThe item at the end of the edge.

DesignManagementRepositoryRegistryConnection

The connection type for DesignManagementRepositoryRegistry.

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

DesignManagementRepositoryRegistryEdge

The edge type for DesignManagementRepositoryRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDesignManagementRepositoryRegistryThe item at the end of the edge.

DesignVersionConnection

The connection type for DesignVersion.

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

DesignVersionEdge

The edge type for DesignVersion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDesignVersionThe item at the end of the edge.

DevopsAdoptionEnabledNamespaceConnection

The connection type for DevopsAdoptionEnabledNamespace.

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

DevopsAdoptionEnabledNamespaceEdge

The edge type for DevopsAdoptionEnabledNamespace.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDevopsAdoptionEnabledNamespaceThe item at the end of the edge.

DevopsAdoptionSnapshotConnection

The connection type for DevopsAdoptionSnapshot.

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

DevopsAdoptionSnapshotEdge

The edge type for DevopsAdoptionSnapshot.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDevopsAdoptionSnapshotThe item at the end of the edge.

DiscussionConnection

The connection type for Discussion.

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

DiscussionEdge

The edge type for Discussion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDiscussionThe item at the end of the edge.

DoraPerformanceScoreCountConnection

The connection type for DoraPerformanceScoreCount.

Fields
NameTypeDescription
edges[DoraPerformanceScoreCountEdge]A list of edges.
noDoraDataProjectsCountInt!Count of projects without any DORA scores within the scope.
nodes[DoraPerformanceScoreCount]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
totalProjectsCountInt!Count of total projects.

DoraPerformanceScoreCountEdge

The edge type for DoraPerformanceScoreCount.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDoraPerformanceScoreCountThe item at the end of the edge.

DuoWorkflowConnection

The connection type for DuoWorkflow.

Fields
NameTypeDescription
edges[DuoWorkflowEdge]A list of edges.
nodes[DuoWorkflow]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

DuoWorkflowEdge

The edge type for DuoWorkflow.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDuoWorkflowThe item at the end of the edge.

DuoWorkflowEventConnection

The connection type for DuoWorkflowEvent.

Fields
NameTypeDescription
edges[DuoWorkflowEventEdge]A list of edges.
nodes[DuoWorkflowEvent]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

DuoWorkflowEventEdge

The edge type for DuoWorkflowEvent.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeDuoWorkflowEventThe item at the end of the edge.

EgressNodeConnection

The connection type for EgressNode.

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

EgressNodeEdge

The edge type for EgressNode.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEgressNodeThe item at the end of the edge.

EmailConnection

The connection type for Email.

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

EmailEdge

The edge type for Email.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEmailThe item at the end of the edge.

EmailParticipantTypeConnection

The connection type for EmailParticipantType.

Fields
NameTypeDescription
edges[EmailParticipantTypeEdge]A list of edges.
nodes[EmailParticipantType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

EmailParticipantTypeEdge

The edge type for EmailParticipantType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEmailParticipantTypeThe item at the end of the edge.

EnvironmentConnection

The connection type for Environment.

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

EnvironmentEdge

The edge type for Environment.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEnvironmentThe item at the end of the edge.

EpicBoardConnection

The connection type for EpicBoard.

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

EpicBoardEdge

The edge type for EpicBoard.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEpicBoardThe item at the end of the edge.

EpicConnection

The connection type for Epic.

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

EpicEdge

The edge type for Epic.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEpicThe item at the end of the edge.

EpicIssueConnection

The connection type for EpicIssue.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[EpicIssueEdge]A list of edges.
nodes[EpicIssue]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
weightInt!Total weight of issues collection.

EpicIssueEdge

The edge type for EpicIssue.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEpicIssueThe item at the end of the edge.

EpicListConnection

The connection type for EpicList.

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

EpicListEdge

The edge type for EpicList.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEpicListThe item at the end of the edge.

EscalationPolicyTypeConnection

The connection type for EscalationPolicyType.

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

EscalationPolicyTypeEdge

The edge type for EscalationPolicyType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEscalationPolicyTypeThe item at the end of the edge.

EventConnection

The connection type for Event.

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

EventEdge

The edge type for Event.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeEventThe item at the end of the edge.

ExternalAuditEventDestinationConnection

The connection type for ExternalAuditEventDestination.

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

ExternalAuditEventDestinationEdge

The edge type for ExternalAuditEventDestination.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeExternalAuditEventDestinationThe item at the end of the edge.

ExternalStatusCheckConnection

The connection type for ExternalStatusCheck.

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

ExternalStatusCheckEdge

The edge type for ExternalStatusCheck.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeExternalStatusCheckThe item at the end of the edge.

FeatureFlagConnection

The connection type for FeatureFlag.

Fields
NameTypeDescription
edges[FeatureFlagEdge]A list of edges.
nodes[FeatureFlag]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

FeatureFlagEdge

The edge type for FeatureFlag.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeFeatureFlagThe item at the end of the edge.

GitlabSubscriptionHistoryConnection

The connection type for GitlabSubscriptionHistory.

Fields
NameTypeDescription
edges[GitlabSubscriptionHistoryEdge]A list of edges.
nodes[GitlabSubscriptionHistory]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

GitlabSubscriptionHistoryEdge

The edge type for GitlabSubscriptionHistory.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeGitlabSubscriptionHistoryThe item at the end of the edge.

GoogleCloudArtifactRegistryArtifactConnection

The connection type for GoogleCloudArtifactRegistryArtifact.

Fields
NameTypeDescription
edges[GoogleCloudArtifactRegistryArtifactEdge]A list of edges.
nodes[GoogleCloudArtifactRegistryArtifact]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

GoogleCloudArtifactRegistryArtifactEdge

The edge type for GoogleCloudArtifactRegistryArtifact.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeGoogleCloudArtifactRegistryArtifactThe item at the end of the edge.

GoogleCloudLoggingConfigurationTypeConnection

The connection type for GoogleCloudLoggingConfigurationType.

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

GoogleCloudLoggingConfigurationTypeEdge

The edge type for GoogleCloudLoggingConfigurationType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeGoogleCloudLoggingConfigurationTypeThe item at the end of the edge.

GroupAuditEventStreamingDestinationConnection

The connection type for GroupAuditEventStreamingDestination.

Fields
NameTypeDescription
edges[GroupAuditEventStreamingDestinationEdge]A list of edges.
nodes[GroupAuditEventStreamingDestination]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

GroupAuditEventStreamingDestinationEdge

The edge type for GroupAuditEventStreamingDestination.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeGroupAuditEventStreamingDestinationThe item at the end of the edge.

GroupConnection

The connection type for Group.

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

GroupEdge

The edge type for Group.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeGroupThe item at the end of the edge.

GroupMemberConnection

The connection type for GroupMember.

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

GroupMemberEdge

The edge type for GroupMember.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeGroupMemberThe item at the end of the edge.

GroupSavedReplyConnection

The connection type for GroupSavedReply.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[GroupSavedReplyEdge]A list of edges.
nodes[GroupSavedReply]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

GroupSavedReplyEdge

The edge type for GroupSavedReply.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeGroupSavedReplyThe item at the end of the edge.

GroupWikiRepositoryRegistryConnection

The connection type for GroupWikiRepositoryRegistry.

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

GroupWikiRepositoryRegistryEdge

The edge type for GroupWikiRepositoryRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeGroupWikiRepositoryRegistryThe item at the end of the edge.

ImportSourceUserConnection

The connection type for ImportSourceUser.

Fields
NameTypeDescription
edges[ImportSourceUserEdge]A list of edges.
nodes[ImportSourceUser]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ImportSourceUserEdge

The edge type for ImportSourceUser.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeImportSourceUserThe item at the end of the edge.

IncidentManagementOncallRotationConnection

The connection type for IncidentManagementOncallRotation.

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

IncidentManagementOncallRotationEdge

The edge type for IncidentManagementOncallRotation.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeIncidentManagementOncallRotationThe item at the end of the edge.

IncidentManagementOncallScheduleConnection

The connection type for IncidentManagementOncallSchedule.

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

IncidentManagementOncallScheduleEdge

The edge type for IncidentManagementOncallSchedule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeIncidentManagementOncallScheduleThe item at the end of the edge.

IncidentManagementOncallShiftConnection

The connection type for IncidentManagementOncallShift.

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

IncidentManagementOncallShiftEdge

The edge type for IncidentManagementOncallShift.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeIncidentManagementOncallShiftThe item at the end of the edge.

InheritedCiVariableConnection

The connection type for InheritedCiVariable.

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

InheritedCiVariableEdge

The edge type for InheritedCiVariable.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeInheritedCiVariableThe item at the end of the edge.

InstanceAmazonS3ConfigurationTypeConnection

The connection type for InstanceAmazonS3ConfigurationType.

Fields
NameTypeDescription
edges[InstanceAmazonS3ConfigurationTypeEdge]A list of edges.
nodes[InstanceAmazonS3ConfigurationType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

InstanceAmazonS3ConfigurationTypeEdge

The edge type for InstanceAmazonS3ConfigurationType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeInstanceAmazonS3ConfigurationTypeThe item at the end of the edge.

InstanceAuditEventStreamingDestinationConnection

The connection type for InstanceAuditEventStreamingDestination.

Fields
NameTypeDescription
edges[InstanceAuditEventStreamingDestinationEdge]A list of edges.
nodes[InstanceAuditEventStreamingDestination]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

InstanceAuditEventStreamingDestinationEdge

The edge type for InstanceAuditEventStreamingDestination.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeInstanceAuditEventStreamingDestinationThe item at the end of the edge.

InstanceExternalAuditEventDestinationConnection

The connection type for InstanceExternalAuditEventDestination.

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

InstanceExternalAuditEventDestinationEdge

The edge type for InstanceExternalAuditEventDestination.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeInstanceExternalAuditEventDestinationThe item at the end of the edge.

InstanceGoogleCloudLoggingConfigurationTypeConnection

The connection type for InstanceGoogleCloudLoggingConfigurationType.

Fields
NameTypeDescription
edges[InstanceGoogleCloudLoggingConfigurationTypeEdge]A list of edges.
nodes[InstanceGoogleCloudLoggingConfigurationType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

InstanceGoogleCloudLoggingConfigurationTypeEdge

The edge type for InstanceGoogleCloudLoggingConfigurationType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeInstanceGoogleCloudLoggingConfigurationTypeThe item at the end of the edge.

IntegrationExclusionConnection

The connection type for IntegrationExclusion.

Fields
NameTypeDescription
edges[IntegrationExclusionEdge]A list of edges.
nodes[IntegrationExclusion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

IntegrationExclusionEdge

The edge type for IntegrationExclusion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeIntegrationExclusionThe item at the end of the edge.

IssuableResourceLinkConnection

The connection type for IssuableResourceLink.

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

IssuableResourceLinkEdge

The edge type for IssuableResourceLink.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeIssuableResourceLinkThe item at the end of the edge.

IssueConnection

The connection type for Issue.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[IssueEdge]A list of edges.
nodes[Issue]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
weightInt!Total weight of issues collection.

IssueEdge

The edge type for Issue.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeIssueThe item at the end of the edge.

IterationCadenceConnection

The connection type for IterationCadence.

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

IterationCadenceEdge

The edge type for IterationCadence.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeIterationCadenceThe item at the end of the edge.

IterationConnection

The connection type for Iteration.

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

IterationEdge

The edge type for Iteration.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeIterationThe item at the end of the edge.

JiraImportConnection

The connection type for JiraImport.

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

JiraImportEdge

The edge type for JiraImport.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeJiraImportThe item at the end of the edge.

JiraProjectConnection

The connection type for JiraProject.

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

JiraProjectEdge

The edge type for JiraProject.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeJiraProjectThe item at the end of the edge.

JobArtifactRegistryConnection

The connection type for JobArtifactRegistry.

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

JobArtifactRegistryEdge

The edge type for JobArtifactRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeJobArtifactRegistryThe item at the end of the edge.

JobNeedUnionConnection

The connection type for JobNeedUnion.

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

JobNeedUnionEdge

The edge type for JobNeedUnion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeJobNeedUnionThe item at the end of the edge.

LabelConnection

The connection type for Label.

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

LabelEdge

The edge type for Label.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeLabelThe item at the end of the edge.

LfsObjectRegistryConnection

The connection type for LfsObjectRegistry.

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

LfsObjectRegistryEdge

The edge type for LfsObjectRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeLfsObjectRegistryThe item at the end of the edge.

LicenseHistoryEntryConnection

The connection type for LicenseHistoryEntry.

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

LicenseHistoryEntryEdge

The edge type for LicenseHistoryEntry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeLicenseHistoryEntryThe item at the end of the edge.

LinkedWorkItemTypeConnection

The connection type for LinkedWorkItemType.

Fields
NameTypeDescription
edges[LinkedWorkItemTypeEdge]A list of edges.
nodes[LinkedWorkItemType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

LinkedWorkItemTypeEdge

The edge type for LinkedWorkItemType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeLinkedWorkItemTypeThe item at the end of the edge.

MemberApprovalConnection

The connection type for MemberApproval.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[MemberApprovalEdge]A list of edges.
nodes[MemberApproval]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

MemberApprovalEdge

The edge type for MemberApproval.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMemberApprovalThe item at the end of the edge.

MemberInterfaceConnection

The connection type for MemberInterface.

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

MemberInterfaceEdge

The edge type for MemberInterface.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMemberInterfaceThe item at the end of the edge.

MemberRoleConnection

The connection type for MemberRole.

Fields
NameTypeDescription
edges[MemberRoleEdge]A list of edges.
nodes[MemberRole]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

MemberRoleEdge

The edge type for MemberRole.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMemberRoleThe item at the end of the edge.

MergeAccessLevelConnection

The connection type for MergeAccessLevel.

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

MergeAccessLevelEdge

The edge type for MergeAccessLevel.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeAccessLevelThe item at the end of the edge.

MergeRequestAssigneeConnection

The connection type for MergeRequestAssignee.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[MergeRequestAssigneeEdge]A list of edges.
nodes[MergeRequestAssignee]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

MergeRequestAssigneeEdge

The edge type for MergeRequestAssignee.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeRequestAssigneeThe item at the end of the edge.

MergeRequestConnection

The connection type for MergeRequest.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[MergeRequestEdge]A list of edges.
nodes[MergeRequest]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
totalTimeToMergeFloatTotal sum of time to merge, in seconds, for the collection of merge requests.

MergeRequestDiffConnection

The connection type for MergeRequestDiff.

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

MergeRequestDiffEdge

The edge type for MergeRequestDiff.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeRequestDiffThe item at the end of the edge.

MergeRequestDiffRegistryConnection

The connection type for MergeRequestDiffRegistry.

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

MergeRequestDiffRegistryEdge

The edge type for MergeRequestDiffRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeRequestDiffRegistryThe item at the end of the edge.

MergeRequestEdge

The edge type for MergeRequest.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeRequestThe item at the end of the edge.

MergeRequestParticipantConnection

The connection type for MergeRequestParticipant.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[MergeRequestParticipantEdge]A list of edges.
nodes[MergeRequestParticipant]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

MergeRequestParticipantEdge

The edge type for MergeRequestParticipant.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeRequestParticipantThe item at the end of the edge.

MergeRequestReviewerConnection

The connection type for MergeRequestReviewer.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[MergeRequestReviewerEdge]A list of edges.
nodes[MergeRequestReviewer]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

MergeRequestReviewerEdge

The edge type for MergeRequestReviewer.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeRequestReviewerThe item at the end of the edge.

MergeTrainCarConnection

The connection type for MergeTrainCar.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[MergeTrainCarEdge]A list of edges.
nodes[MergeTrainCar]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

MergeTrainCarEdge

The edge type for MergeTrainCar.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeTrainCarThe item at the end of the edge.

MergeTrainConnection

The connection type for MergeTrain.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[MergeTrainEdge]A list of edges.
nodes[MergeTrain]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

MergeTrainEdge

The edge type for MergeTrain.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMergeTrainThe item at the end of the edge.

MilestoneConnection

The connection type for Milestone.

Fields
NameTypeDescription
edges[MilestoneEdge]A list of edges.
nodes[Milestone]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

MilestoneEdge

The edge type for Milestone.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMilestoneThe item at the end of the edge.

MlCandidateConnection

The connection type for MlCandidate.

Fields
NameTypeDescription
edges[MlCandidateEdge]A list of edges.
nodes[MlCandidate]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
MlCandidateConnection.count

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

Returns Int!.

####### Arguments

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

MlCandidateEdge

The edge type for MlCandidate.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMlCandidateThe item at the end of the edge.

MlCandidateMetadataConnection

The connection type for MlCandidateMetadata.

Fields
NameTypeDescription
edges[MlCandidateMetadataEdge]A list of edges.
nodes[MlCandidateMetadata]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
MlCandidateMetadataConnection.count

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

Returns Int!.

####### Arguments

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

MlCandidateMetadataEdge

The edge type for MlCandidateMetadata.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMlCandidateMetadataThe item at the end of the edge.

MlCandidateMetricConnection

The connection type for MlCandidateMetric.

Fields
NameTypeDescription
edges[MlCandidateMetricEdge]A list of edges.
nodes[MlCandidateMetric]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
MlCandidateMetricConnection.count

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

Returns Int!.

####### Arguments

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

MlCandidateMetricEdge

The edge type for MlCandidateMetric.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMlCandidateMetricThe item at the end of the edge.

MlCandidateParamConnection

The connection type for MlCandidateParam.

Fields
NameTypeDescription
edges[MlCandidateParamEdge]A list of edges.
nodes[MlCandidateParam]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
MlCandidateParamConnection.count

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

Returns Int!.

####### Arguments

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

MlCandidateParamEdge

The edge type for MlCandidateParam.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMlCandidateParamThe item at the end of the edge.

MlExperimentConnection

The connection type for MlExperiment.

Fields
NameTypeDescription
edges[MlExperimentEdge]A list of edges.
nodes[MlExperiment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
MlExperimentConnection.count

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

Returns Int!.

####### Arguments

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

MlExperimentEdge

The edge type for MlExperiment.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMlExperimentThe item at the end of the edge.

MlModelConnection

The connection type for MlModel.

Fields
NameTypeDescription
edges[MlModelEdge]A list of edges.
nodes[MlModel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
MlModelConnection.count

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

Returns Int!.

####### Arguments

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

MlModelEdge

The edge type for MlModel.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMlModelThe item at the end of the edge.

MlModelVersionConnection

The connection type for MlModelVersion.

Fields
NameTypeDescription
edges[MlModelVersionEdge]A list of edges.
nodes[MlModelVersion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
Fields with arguments
MlModelVersionConnection.count

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

Returns Int!.

####### Arguments

NameTypeDescription
limitIntLimit value to be applied to the count query. Default is 1000.

MlModelVersionEdge

The edge type for MlModelVersion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeMlModelVersionThe item at the end of the edge.

NamespaceCommitEmailConnection

The connection type for NamespaceCommitEmail.

Fields
NameTypeDescription
edges[NamespaceCommitEmailEdge]A list of edges.
nodes[NamespaceCommitEmail]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

NamespaceCommitEmailEdge

The edge type for NamespaceCommitEmail.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeNamespaceCommitEmailThe item at the end of the edge.

NamespaceConnection

The connection type for Namespace.

Fields
NameTypeDescription
edges[NamespaceEdge]A list of edges.
nodes[Namespace]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

NamespaceEdge

The edge type for Namespace.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeNamespaceThe item at the end of the edge.

NestedEnvironmentConnection

The connection type for NestedEnvironment.

Fields
NameTypeDescription
edges[NestedEnvironmentEdge]A list of edges.
nodes[NestedEnvironment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

NestedEnvironmentEdge

The edge type for NestedEnvironment.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeNestedEnvironmentThe item at the end of the edge.

NoteConnection

The connection type for Note.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[NoteEdge]A list of edges.
nodes[Note]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

NoteEdge

The edge type for Note.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeNoteThe item at the end of the edge.

ObservabilityLogConnection

The connection type for ObservabilityLog.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[ObservabilityLogEdge]A list of edges.
nodes[ObservabilityLog]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ObservabilityLogEdge

The edge type for ObservabilityLog.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeObservabilityLogThe item at the end of the edge.

ObservabilityMetricConnection

The connection type for ObservabilityMetric.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[ObservabilityMetricEdge]A list of edges.
nodes[ObservabilityMetric]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ObservabilityMetricEdge

The edge type for ObservabilityMetric.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeObservabilityMetricThe item at the end of the edge.

ObservabilityTraceConnection

The connection type for ObservabilityTrace.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[ObservabilityTraceEdge]A list of edges.
nodes[ObservabilityTrace]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ObservabilityTraceEdge

The edge type for ObservabilityTrace.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeObservabilityTraceThe item at the end of the edge.

OncallParticipantTypeConnection

The connection type for OncallParticipantType.

Fields
NameTypeDescription
edges[OncallParticipantTypeEdge]A list of edges.
nodes[OncallParticipantType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

OncallParticipantTypeEdge

The edge type for OncallParticipantType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeOncallParticipantTypeThe item at the end of the edge.

OrganizationConnection

The connection type for Organization.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[OrganizationEdge]A list of edges.
nodes[Organization]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

OrganizationEdge

The edge type for Organization.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeOrganizationThe item at the end of the edge.

OrganizationUserConnection

The connection type for OrganizationUser.

Fields
NameTypeDescription
edges[OrganizationUserEdge]A list of edges.
nodes[OrganizationUser]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

OrganizationUserEdge

The edge type for OrganizationUser.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeOrganizationUserThe item at the end of the edge.

PackageBaseConnection

The connection type for PackageBase.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[PackageBaseEdge]A list of edges.
nodes[PackageBase]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PackageBaseEdge

The edge type for PackageBase.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePackageBaseThe item at the end of the edge.

PackageConnection

The connection type for Package.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[PackageEdge]A list of edges.
nodes[Package]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PackageDependencyLinkConnection

The connection type for PackageDependencyLink.

Fields
NameTypeDescription
edges[PackageDependencyLinkEdge]A list of edges.
nodes[PackageDependencyLink]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PackageDependencyLinkEdge

The edge type for PackageDependencyLink.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePackageDependencyLinkThe item at the end of the edge.

PackageEdge

The edge type for Package.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePackageThe item at the end of the edge.

PackageFileConnection

The connection type for PackageFile.

Fields
NameTypeDescription
edges[PackageFileEdge]A list of edges.
nodes[PackageFile]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PackageFileEdge

The edge type for PackageFile.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePackageFileThe item at the end of the edge.

PackageFileRegistryConnection

The connection type for PackageFileRegistry.

Fields
NameTypeDescription
edges[PackageFileRegistryEdge]A list of edges.
nodes[PackageFileRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PackageFileRegistryEdge

The edge type for PackageFileRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePackageFileRegistryThe item at the end of the edge.

PackageTagConnection

The connection type for PackageTag.

Fields
NameTypeDescription
edges[PackageTagEdge]A list of edges.
nodes[PackageTag]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PackageTagEdge

The edge type for PackageTag.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePackageTagThe item at the end of the edge.

PackagesProtectionRuleConnection

The connection type for PackagesProtectionRule.

Fields
NameTypeDescription
edges[PackagesProtectionRuleEdge]A list of edges.
nodes[PackagesProtectionRule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PackagesProtectionRuleEdge

The edge type for PackagesProtectionRule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePackagesProtectionRuleThe item at the end of the edge.

PagesDeploymentConnection

The connection type for PagesDeployment.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[PagesDeploymentEdge]A list of edges.
nodes[PagesDeployment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PagesDeploymentEdge

The edge type for PagesDeployment.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePagesDeploymentThe item at the end of the edge.

PagesDeploymentRegistryConnection

The connection type for PagesDeploymentRegistry.

Fields
NameTypeDescription
edges[PagesDeploymentRegistryEdge]A list of edges.
nodes[PagesDeploymentRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PagesDeploymentRegistryEdge

The edge type for PagesDeploymentRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePagesDeploymentRegistryThe item at the end of the edge.

PathLockConnection

The connection type for PathLock.

Fields
NameTypeDescription
edges[PathLockEdge]A list of edges.
nodes[PathLock]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PathLockEdge

The edge type for PathLock.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePathLockThe item at the end of the edge.

PendingMemberInterfaceConnection

The connection type for PendingMemberInterface.

Fields
NameTypeDescription
edges[PendingMemberInterfaceEdge]A list of edges.
nodes[PendingMemberInterface]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PendingMemberInterfaceEdge

The edge type for PendingMemberInterface.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePendingMemberInterfaceThe item at the end of the edge.

PipelineArtifactRegistryConnection

The connection type for PipelineArtifactRegistry.

Fields
NameTypeDescription
edges[PipelineArtifactRegistryEdge]A list of edges.
nodes[PipelineArtifactRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineArtifactRegistryEdge

The edge type for PipelineArtifactRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineArtifactRegistryThe item at the end of the edge.

PipelineConnection

The connection type for Pipeline.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[PipelineEdge]A list of edges.
nodes[Pipeline]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineEdge

The edge type for Pipeline.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineThe item at the end of the edge.

PipelineExecutionPolicyConnection

The connection type for PipelineExecutionPolicy.

Fields
NameTypeDescription
edges[PipelineExecutionPolicyEdge]A list of edges.
nodes[PipelineExecutionPolicy]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineExecutionPolicyEdge

The edge type for PipelineExecutionPolicy.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineExecutionPolicyThe item at the end of the edge.

PipelineManualVariableConnection

The connection type for PipelineManualVariable.

Fields
NameTypeDescription
edges[PipelineManualVariableEdge]A list of edges.
nodes[PipelineManualVariable]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineManualVariableEdge

The edge type for PipelineManualVariable.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineManualVariableThe item at the end of the edge.

PipelineMessageConnection

The connection type for PipelineMessage.

Fields
NameTypeDescription
edges[PipelineMessageEdge]A list of edges.
nodes[PipelineMessage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineMessageEdge

The edge type for PipelineMessage.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineMessageThe item at the end of the edge.

PipelineScheduleConnection

The connection type for PipelineSchedule.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[PipelineScheduleEdge]A list of edges.
nodes[PipelineSchedule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineScheduleEdge

The edge type for PipelineSchedule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineScheduleThe item at the end of the edge.

PipelineScheduleVariableConnection

The connection type for PipelineScheduleVariable.

Fields
NameTypeDescription
edges[PipelineScheduleVariableEdge]A list of edges.
nodes[PipelineScheduleVariable]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineScheduleVariableEdge

The edge type for PipelineScheduleVariable.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineScheduleVariableThe item at the end of the edge.

PipelineSecurityReportFindingConnection

The connection type for PipelineSecurityReportFinding.

Fields
NameTypeDescription
edges[PipelineSecurityReportFindingEdge]A list of edges.
nodes[PipelineSecurityReportFinding]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineSecurityReportFindingEdge

The edge type for PipelineSecurityReportFinding.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineSecurityReportFindingThe item at the end of the edge.

PipelineTriggerConnection

The connection type for PipelineTrigger.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[PipelineTriggerEdge]A list of edges.
nodes[PipelineTrigger]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PipelineTriggerEdge

The edge type for PipelineTrigger.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePipelineTriggerThe item at the end of the edge.

ProjectConnection

The connection type for Project.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[ProjectEdge]A list of edges.
nodes[Project]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProjectEdge

The edge type for Project.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProjectThe item at the end of the edge.

ProjectMemberConnection

The connection type for ProjectMember.

Fields
NameTypeDescription
edges[ProjectMemberEdge]A list of edges.
nodes[ProjectMember]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProjectMemberEdge

The edge type for ProjectMember.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProjectMemberThe item at the end of the edge.

ProjectRepositoryRegistryConnection

The connection type for ProjectRepositoryRegistry.

Fields
NameTypeDescription
edges[ProjectRepositoryRegistryEdge]A list of edges.
nodes[ProjectRepositoryRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProjectRepositoryRegistryEdge

The edge type for ProjectRepositoryRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProjectRepositoryRegistryThe item at the end of the edge.

ProjectSavedReplyConnection

The connection type for ProjectSavedReply.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[ProjectSavedReplyEdge]A list of edges.
nodes[ProjectSavedReply]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProjectSavedReplyEdge

The edge type for ProjectSavedReply.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProjectSavedReplyThe item at the end of the edge.

ProjectSecretConnection

The connection type for ProjectSecret.

Fields
NameTypeDescription
edges[ProjectSecretEdge]A list of edges.
nodes[ProjectSecret]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProjectSecretEdge

The edge type for ProjectSecret.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProjectSecretThe item at the end of the edge.

ProjectSecurityExclusionConnection

The connection type for ProjectSecurityExclusion.

Fields
NameTypeDescription
edges[ProjectSecurityExclusionEdge]A list of edges.
nodes[ProjectSecurityExclusion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProjectSecurityExclusionEdge

The edge type for ProjectSecurityExclusion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProjectSecurityExclusionThe item at the end of the edge.

ProjectTargetBranchRuleConnection

The connection type for ProjectTargetBranchRule.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[ProjectTargetBranchRuleEdge]A list of edges.
nodes[ProjectTargetBranchRule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProjectTargetBranchRuleEdge

The edge type for ProjectTargetBranchRule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProjectTargetBranchRuleThe item at the end of the edge.

ProjectWikiRepositoryRegistryConnection

The connection type for ProjectWikiRepositoryRegistry.

Fields
NameTypeDescription
edges[ProjectWikiRepositoryRegistryEdge]A list of edges.
nodes[ProjectWikiRepositoryRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProjectWikiRepositoryRegistryEdge

The edge type for ProjectWikiRepositoryRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProjectWikiRepositoryRegistryThe item at the end of the edge.

ProtectedEnvironmentApprovalRuleConnection

The connection type for ProtectedEnvironmentApprovalRule.

Fields
NameTypeDescription
edges[ProtectedEnvironmentApprovalRuleEdge]A list of edges.
nodes[ProtectedEnvironmentApprovalRule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProtectedEnvironmentApprovalRuleEdge

The edge type for ProtectedEnvironmentApprovalRule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProtectedEnvironmentApprovalRuleThe item at the end of the edge.

ProtectedEnvironmentConnection

The connection type for ProtectedEnvironment.

Fields
NameTypeDescription
edges[ProtectedEnvironmentEdge]A list of edges.
nodes[ProtectedEnvironment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProtectedEnvironmentDeployAccessLevelConnection

The connection type for ProtectedEnvironmentDeployAccessLevel.

Fields
NameTypeDescription
edges[ProtectedEnvironmentDeployAccessLevelEdge]A list of edges.
nodes[ProtectedEnvironmentDeployAccessLevel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ProtectedEnvironmentDeployAccessLevelEdge

The edge type for ProtectedEnvironmentDeployAccessLevel.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProtectedEnvironmentDeployAccessLevelThe item at the end of the edge.

ProtectedEnvironmentEdge

The edge type for ProtectedEnvironment.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeProtectedEnvironmentThe item at the end of the edge.

PushAccessLevelConnection

The connection type for PushAccessLevel.

Fields
NameTypeDescription
edges[PushAccessLevelEdge]A list of edges.
nodes[PushAccessLevel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

PushAccessLevelEdge

The edge type for PushAccessLevel.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodePushAccessLevelThe item at the end of the edge.

ReleaseAssetLinkConnection

The connection type for ReleaseAssetLink.

Fields
NameTypeDescription
edges[ReleaseAssetLinkEdge]A list of edges.
nodes[ReleaseAssetLink]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ReleaseAssetLinkEdge

The edge type for ReleaseAssetLink.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeReleaseAssetLinkThe item at the end of the edge.

ReleaseConnection

The connection type for Release.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[ReleaseEdge]A list of edges.
nodes[Release]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ReleaseEdge

The edge type for Release.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeReleaseThe item at the end of the edge.

ReleaseEvidenceConnection

The connection type for ReleaseEvidence.

Fields
NameTypeDescription
edges[ReleaseEvidenceEdge]A list of edges.
nodes[ReleaseEvidence]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ReleaseEvidenceEdge

The edge type for ReleaseEvidence.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeReleaseEvidenceThe item at the end of the edge.

ReleaseSourceConnection

The connection type for ReleaseSource.

Fields
NameTypeDescription
edges[ReleaseSourceEdge]A list of edges.
nodes[ReleaseSource]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ReleaseSourceEdge

The edge type for ReleaseSource.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeReleaseSourceThe item at the end of the edge.

RepositoryBlobConnection

The connection type for RepositoryBlob.

Fields
NameTypeDescription
edges[RepositoryBlobEdge]A list of edges.
nodes[RepositoryBlob]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

RepositoryBlobEdge

The edge type for RepositoryBlob.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeRepositoryBlobThe item at the end of the edge.

RequirementConnection

The connection type for Requirement.

Fields
NameTypeDescription
edges[RequirementEdge]A list of edges.
nodes[Requirement]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

RequirementEdge

The edge type for Requirement.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeRequirementThe item at the end of the edge.

RunnerArchitectureConnection

The connection type for RunnerArchitecture.

Fields
NameTypeDescription
edges[RunnerArchitectureEdge]A list of edges.
nodes[RunnerArchitecture]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

RunnerArchitectureEdge

The edge type for RunnerArchitecture.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeRunnerArchitectureThe item at the end of the edge.

RunnerPlatformConnection

The connection type for RunnerPlatform.

Fields
NameTypeDescription
edges[RunnerPlatformEdge]A list of edges.
nodes[RunnerPlatform]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

RunnerPlatformEdge

The edge type for RunnerPlatform.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeRunnerPlatformThe item at the end of the edge.

SastCiConfigurationAnalyzersEntityConnection

The connection type for SastCiConfigurationAnalyzersEntity.

Fields
NameTypeDescription
edges[SastCiConfigurationAnalyzersEntityEdge]A list of edges.
nodes[SastCiConfigurationAnalyzersEntity]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SastCiConfigurationAnalyzersEntityEdge

The edge type for SastCiConfigurationAnalyzersEntity.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSastCiConfigurationAnalyzersEntityThe item at the end of the edge.

SastCiConfigurationEntityConnection

The connection type for SastCiConfigurationEntity.

Fields
NameTypeDescription
edges[SastCiConfigurationEntityEdge]A list of edges.
nodes[SastCiConfigurationEntity]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SastCiConfigurationEntityEdge

The edge type for SastCiConfigurationEntity.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSastCiConfigurationEntityThe item at the end of the edge.

SastCiConfigurationOptionsEntityConnection

The connection type for SastCiConfigurationOptionsEntity.

Fields
NameTypeDescription
edges[SastCiConfigurationOptionsEntityEdge]A list of edges.
nodes[SastCiConfigurationOptionsEntity]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SastCiConfigurationOptionsEntityEdge

The edge type for SastCiConfigurationOptionsEntity.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSastCiConfigurationOptionsEntityThe item at the end of the edge.

SavedReplyConnection

The connection type for SavedReply.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[SavedReplyEdge]A list of edges.
nodes[SavedReply]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SavedReplyEdge

The edge type for SavedReply.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSavedReplyThe item at the end of the edge.

ScanConnection

The connection type for Scan.

Fields
NameTypeDescription
edges[ScanEdge]A list of edges.
nodes[Scan]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ScanEdge

The edge type for Scan.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeScanThe item at the end of the edge.

ScanExecutionPolicyConnection

The connection type for ScanExecutionPolicy.

Fields
NameTypeDescription
edges[ScanExecutionPolicyEdge]A list of edges.
nodes[ScanExecutionPolicy]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ScanExecutionPolicyEdge

The edge type for ScanExecutionPolicy.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeScanExecutionPolicyThe item at the end of the edge.

ScanResultPolicyConnection

The connection type for ScanResultPolicy.

Fields
NameTypeDescription
edges[ScanResultPolicyEdge]A list of edges.
nodes[ScanResultPolicy]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ScanResultPolicyEdge

The edge type for ScanResultPolicy.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeScanResultPolicyThe item at the end of the edge.

ScannedResourceConnection

The connection type for ScannedResource.

Fields
NameTypeDescription
edges[ScannedResourceEdge]A list of edges.
nodes[ScannedResource]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ScannedResourceEdge

The edge type for ScannedResource.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeScannedResourceThe item at the end of the edge.

SentryErrorConnection

The connection type for SentryError.

Fields
NameTypeDescription
edges[SentryErrorEdge]A list of edges.
nodes[SentryError]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SentryErrorEdge

The edge type for SentryError.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSentryErrorThe item at the end of the edge.

ServiceConnection

The connection type for Service.

Fields
NameTypeDescription
edges[ServiceEdge]A list of edges.
nodes[Service]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ServiceEdge

The edge type for Service.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeServiceThe item at the end of the edge.

SeverityOverrideConnection

The connection type for SeverityOverride.

Fields
NameTypeDescription
edges[SeverityOverrideEdge]A list of edges.
nodes[SeverityOverride]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SeverityOverrideEdge

The edge type for SeverityOverride.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSeverityOverrideThe item at the end of the edge.

SnippetBlobConnection

The connection type for SnippetBlob.

Fields
NameTypeDescription
edges[SnippetBlobEdge]A list of edges.
hasUnretrievableBlobsBoolean!Indicates if the snippet has unretrievable blobs.
nodes[SnippetBlob]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SnippetBlobEdge

The edge type for SnippetBlob.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSnippetBlobThe item at the end of the edge.

SnippetConnection

The connection type for Snippet.

Fields
NameTypeDescription
edges[SnippetEdge]A list of edges.
nodes[Snippet]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SnippetEdge

The edge type for Snippet.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSnippetThe item at the end of the edge.

SnippetRepositoryRegistryConnection

The connection type for SnippetRepositoryRegistry.

Fields
NameTypeDescription
edges[SnippetRepositoryRegistryEdge]A list of edges.
nodes[SnippetRepositoryRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SnippetRepositoryRegistryEdge

The edge type for SnippetRepositoryRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSnippetRepositoryRegistryThe item at the end of the edge.

StandardRoleConnection

The connection type for StandardRole.

Fields
NameTypeDescription
edges[StandardRoleEdge]A list of edges.
nodes[StandardRole]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

StandardRoleEdge

The edge type for StandardRole.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeStandardRoleThe item at the end of the edge.

SubmoduleConnection

The connection type for Submodule.

Fields
NameTypeDescription
edges[SubmoduleEdge]A list of edges.
nodes[Submodule]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SubmoduleEdge

The edge type for Submodule.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSubmoduleThe item at the end of the edge.

SubscriptionFutureEntryConnection

The connection type for SubscriptionFutureEntry.

Fields
NameTypeDescription
edges[SubscriptionFutureEntryEdge]A list of edges.
nodes[SubscriptionFutureEntry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

SubscriptionFutureEntryEdge

The edge type for SubscriptionFutureEntry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeSubscriptionFutureEntryThe item at the end of the edge.

TerraformStateConnection

The connection type for TerraformState.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[TerraformStateEdge]A list of edges.
nodes[TerraformState]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TerraformStateEdge

The edge type for TerraformState.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTerraformStateThe item at the end of the edge.

TerraformStateVersionRegistryConnection

The connection type for TerraformStateVersionRegistry.

Fields
NameTypeDescription
edges[TerraformStateVersionRegistryEdge]A list of edges.
nodes[TerraformStateVersionRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TerraformStateVersionRegistryEdge

The edge type for TerraformStateVersionRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTerraformStateVersionRegistryThe item at the end of the edge.

TestCaseConnection

The connection type for TestCase.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[TestCaseEdge]A list of edges.
nodes[TestCase]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TestCaseEdge

The edge type for TestCase.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTestCaseThe item at the end of the edge.

TestReportConnection

The connection type for TestReport.

Fields
NameTypeDescription
edges[TestReportEdge]A list of edges.
nodes[TestReport]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TestReportEdge

The edge type for TestReport.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTestReportThe item at the end of the edge.

TestSuiteSummaryConnection

The connection type for TestSuiteSummary.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[TestSuiteSummaryEdge]A list of edges.
nodes[TestSuiteSummary]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TestSuiteSummaryEdge

The edge type for TestSuiteSummary.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTestSuiteSummaryThe item at the end of the edge.

TimeTrackingTimelogCategoryConnection

The connection type for TimeTrackingTimelogCategory.

Fields
NameTypeDescription
edges[TimeTrackingTimelogCategoryEdge]A list of edges.
nodes[TimeTrackingTimelogCategory]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TimeTrackingTimelogCategoryEdge

The edge type for TimeTrackingTimelogCategory.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTimeTrackingTimelogCategoryThe item at the end of the edge.

TimelineEventTagTypeConnection

The connection type for TimelineEventTagType.

Fields
NameTypeDescription
edges[TimelineEventTagTypeEdge]A list of edges.
nodes[TimelineEventTagType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TimelineEventTagTypeEdge

The edge type for TimelineEventTagType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTimelineEventTagTypeThe item at the end of the edge.

TimelineEventTypeConnection

The connection type for TimelineEventType.

Fields
NameTypeDescription
edges[TimelineEventTypeEdge]A list of edges.
nodes[TimelineEventType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TimelineEventTypeEdge

The edge type for TimelineEventType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTimelineEventTypeThe item at the end of the edge.

TimelogConnection

The connection type for Timelog.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[TimelogEdge]A list of edges.
nodes[Timelog]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
totalSpentTimeBigInt!Total time spent in seconds.

TimelogEdge

The edge type for Timelog.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTimelogThe item at the end of the edge.

TodoConnection

The connection type for Todo.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[TodoEdge]A list of edges.
nodes[Todo]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TodoEdge

The edge type for Todo.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTodoThe item at the end of the edge.

TopicConnection

The connection type for Topic.

Fields
NameTypeDescription
edges[TopicEdge]A list of edges.
nodes[Topic]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TopicEdge

The edge type for Topic.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTopicThe item at the end of the edge.

TreeConnection

The connection type for Tree.

Fields
NameTypeDescription
edges[TreeEdge]A list of edges.
nodes[Tree]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TreeEdge

The edge type for Tree.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTreeThe item at the end of the edge.

TreeEntryConnection

The connection type for TreeEntry.

Fields
NameTypeDescription
edges[TreeEntryEdge]A list of edges.
nodes[TreeEntry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

TreeEntryEdge

The edge type for TreeEntry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeTreeEntryThe item at the end of the edge.

UnprotectAccessLevelConnection

The connection type for UnprotectAccessLevel.

Fields
NameTypeDescription
edges[UnprotectAccessLevelEdge]A list of edges.
nodes[UnprotectAccessLevel]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

UnprotectAccessLevelEdge

The edge type for UnprotectAccessLevel.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeUnprotectAccessLevelThe item at the end of the edge.

UploadRegistryConnection

The connection type for UploadRegistry.

Fields
NameTypeDescription
edges[UploadRegistryEdge]A list of edges.
nodes[UploadRegistry]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

UploadRegistryEdge

The edge type for UploadRegistry.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeUploadRegistryThe item at the end of the edge.

UsageTrendsMeasurementConnection

The connection type for UsageTrendsMeasurement.

Fields
NameTypeDescription
edges[UsageTrendsMeasurementEdge]A list of edges.
nodes[UsageTrendsMeasurement]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

UsageTrendsMeasurementEdge

The edge type for UsageTrendsMeasurement.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeUsageTrendsMeasurementThe item at the end of the edge.

UserAchievementConnection

The connection type for UserAchievement.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[UserAchievementEdge]A list of edges.
nodes[UserAchievement]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

UserAchievementEdge

The edge type for UserAchievement.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeUserAchievementThe item at the end of the edge.

UserAddOnAssignmentConnection

The connection type for UserAddOnAssignment.

Fields
NameTypeDescription
edges[UserAddOnAssignmentEdge]A list of edges.
nodes[UserAddOnAssignment]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

UserAddOnAssignmentEdge

The edge type for UserAddOnAssignment.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeUserAddOnAssignmentThe item at the end of the edge.

UserCalloutConnection

The connection type for UserCallout.

Fields
NameTypeDescription
edges[UserCalloutEdge]A list of edges.
nodes[UserCallout]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

UserCalloutEdge

The edge type for UserCallout.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeUserCalloutThe item at the end of the edge.

UserCoreConnection

The connection type for UserCore.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[UserCoreEdge]A list of edges.
nodes[UserCore]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

UserCoreEdge

The edge type for UserCore.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeUserCoreThe item at the end of the edge.

UsersQueuedForRolePromotionConnection

The connection type for UsersQueuedForRolePromotion.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[UsersQueuedForRolePromotionEdge]A list of edges.
nodes[UsersQueuedForRolePromotion]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

UsersQueuedForRolePromotionEdge

The edge type for UsersQueuedForRolePromotion.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeUsersQueuedForRolePromotionThe item at the end of the edge.

ValueStreamConnection

The connection type for ValueStream.

Fields
NameTypeDescription
edges[ValueStreamEdge]A list of edges.
nodes[ValueStream]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ValueStreamEdge

The edge type for ValueStream.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeValueStreamThe item at the end of the edge.

ValueStreamStageItemsConnection

The connection type for ValueStreamStageItems.

Fields
NameTypeDescription
edges[ValueStreamStageItemsEdge]A list of edges.
nodes[ValueStreamStageItems]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

ValueStreamStageItemsEdge

The edge type for ValueStreamStageItems.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeValueStreamStageItemsThe item at the end of the edge.

VulnerabilitiesCountByDayConnection

The connection type for VulnerabilitiesCountByDay.

Fields
NameTypeDescription
edges[VulnerabilitiesCountByDayEdge]A list of edges.
nodes[VulnerabilitiesCountByDay]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

VulnerabilitiesCountByDayEdge

The edge type for VulnerabilitiesCountByDay.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeVulnerabilitiesCountByDayThe item at the end of the edge.

VulnerabilityConnection

The connection type for Vulnerability.

Fields
NameTypeDescription
edges[VulnerabilityEdge]A list of edges.
nodes[Vulnerability]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

VulnerabilityContainerImageConnection

The connection type for VulnerabilityContainerImage.

Fields
NameTypeDescription
edges[VulnerabilityContainerImageEdge]A list of edges.
nodes[VulnerabilityContainerImage]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

VulnerabilityContainerImageEdge

The edge type for VulnerabilityContainerImage.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeVulnerabilityContainerImageThe item at the end of the edge.

VulnerabilityEdge

The edge type for Vulnerability.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeVulnerabilityThe item at the end of the edge.

VulnerabilityExternalIssueLinkConnection

The connection type for VulnerabilityExternalIssueLink.

Fields
NameTypeDescription
edges[VulnerabilityExternalIssueLinkEdge]A list of edges.
nodes[VulnerabilityExternalIssueLink]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

VulnerabilityExternalIssueLinkEdge

The edge type for VulnerabilityExternalIssueLink.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeVulnerabilityExternalIssueLinkThe item at the end of the edge.

VulnerabilityIssueLinkConnection

The connection type for VulnerabilityIssueLink.

Fields
NameTypeDescription
edges[VulnerabilityIssueLinkEdge]A list of edges.
nodes[VulnerabilityIssueLink]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

VulnerabilityIssueLinkEdge

The edge type for VulnerabilityIssueLink.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeVulnerabilityIssueLinkThe item at the end of the edge.

VulnerabilityManagementPolicyConnection

The connection type for VulnerabilityManagementPolicy.

Fields
NameTypeDescription
edges[VulnerabilityManagementPolicyEdge]A list of edges.
nodes[VulnerabilityManagementPolicy]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

VulnerabilityManagementPolicyEdge

The edge type for VulnerabilityManagementPolicy.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeVulnerabilityManagementPolicyThe item at the end of the edge.

VulnerabilityScannerConnection

The connection type for VulnerabilityScanner.

Fields
NameTypeDescription
edges[VulnerabilityScannerEdge]A list of edges.
nodes[VulnerabilityScanner]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

VulnerabilityScannerEdge

The edge type for VulnerabilityScanner.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeVulnerabilityScannerThe item at the end of the edge.

VulnerabilityStateTransitionTypeConnection

The connection type for VulnerabilityStateTransitionType.

Fields
NameTypeDescription
edges[VulnerabilityStateTransitionTypeEdge]A list of edges.
nodes[VulnerabilityStateTransitionType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

VulnerabilityStateTransitionTypeEdge

The edge type for VulnerabilityStateTransitionType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeVulnerabilityStateTransitionTypeThe item at the end of the edge.

WorkItemClosingMergeRequestConnection

The connection type for WorkItemClosingMergeRequest.

Fields
NameTypeDescription
edges[WorkItemClosingMergeRequestEdge]A list of edges.
nodes[WorkItemClosingMergeRequest]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkItemClosingMergeRequestEdge

The edge type for WorkItemClosingMergeRequest.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkItemClosingMergeRequestThe item at the end of the edge.

WorkItemConnection

The connection type for WorkItem.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[WorkItemEdge]A list of edges.
nodes[WorkItem]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkItemDescriptionTemplateConnection

The connection type for WorkItemDescriptionTemplate.

Fields
NameTypeDescription
edges[WorkItemDescriptionTemplateEdge]A list of edges.
nodes[WorkItemDescriptionTemplate]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkItemDescriptionTemplateEdge

The edge type for WorkItemDescriptionTemplate.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkItemDescriptionTemplateThe item at the end of the edge.

WorkItemEdge

The edge type for WorkItem.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkItemThe item at the end of the edge.

WorkItemLinkedResourceConnection

The connection type for WorkItemLinkedResource.

Fields
NameTypeDescription
edges[WorkItemLinkedResourceEdge]A list of edges.
nodes[WorkItemLinkedResource]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkItemLinkedResourceEdge

The edge type for WorkItemLinkedResource.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkItemLinkedResourceThe item at the end of the edge.

WorkItemRelatedBranchConnection

The connection type for WorkItemRelatedBranch.

Fields
NameTypeDescription
edges[WorkItemRelatedBranchEdge]A list of edges.
nodes[WorkItemRelatedBranch]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkItemRelatedBranchEdge

The edge type for WorkItemRelatedBranch.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkItemRelatedBranchThe item at the end of the edge.

WorkItemTimelogConnection

The connection type for WorkItemTimelog.

Fields
NameTypeDescription
countInt!Total count of collection.
edges[WorkItemTimelogEdge]A list of edges.
nodes[WorkItemTimelog]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.
totalSpentTimeBigInt!Total time spent in seconds.

WorkItemTimelogEdge

The edge type for WorkItemTimelog.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkItemTimelogThe item at the end of the edge.

WorkItemTypeConnection

The connection type for WorkItemType.

Fields
NameTypeDescription
edges[WorkItemTypeEdge]A list of edges.
nodes[WorkItemType]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkItemTypeEdge

The edge type for WorkItemType.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkItemTypeThe item at the end of the edge.

WorkItemWidgetCustomStatusConnection

The connection type for WorkItemWidgetCustomStatus.

Fields
NameTypeDescription
edges[WorkItemWidgetCustomStatusEdge]A list of edges.
nodes[WorkItemWidgetCustomStatus]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkItemWidgetCustomStatusEdge

The edge type for WorkItemWidgetCustomStatus.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkItemWidgetCustomStatusThe item at the end of the edge.

WorkspaceConnection

The connection type for Workspace.

Fields
NameTypeDescription
edges[WorkspaceEdge]A list of edges.
nodes[Workspace]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkspaceEdge

The edge type for Workspace.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkspaceThe item at the end of the edge.

WorkspaceVariableConnection

The connection type for WorkspaceVariable.

Fields
NameTypeDescription
edges[WorkspaceVariableEdge]A list of edges.
nodes[WorkspaceVariable]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

WorkspaceVariableEdge

The edge type for WorkspaceVariable.

Fields
NameTypeDescription
cursorString!A cursor for use in pagination.
nodeWorkspaceVariableThe item at the end of the edge.

Object types

Object types represent the resources that the GitLab GraphQL API can return. They contain fields. Each field has its own type, which will either be one of the basic GraphQL scalar types (e.g.: String or Boolean) or other object types. Fields may have arguments. Fields with arguments are exactly like top-level queries, and are listed beneath the table of fields for each object type.

For more information, see Object Types and Fields on graphql.org.

AbuseReport

An abuse report.

Fields

NameTypeDescription
discussionsAbuseReportDiscussionConnection!All discussions on the noteable. (see Connections)
idAbuseReportID!Global ID of the abuse report.
labelsAbuseReportLabelConnectionLabels of the abuse report. (see Connections)
notesAbuseReportNoteConnection!All notes on the noteable. (see Connections)

AbuseReportDiscussion

Fields

NameTypeDescription
abuseReportAbuseReportAbuse report which the discussion belongs to.
createdAtTime!Timestamp of the discussion’s creation.
idDiscussionID!ID of the discussion.
notesAbuseReportNoteConnection!All notes in the discussion. (see Connections)
replyIdDiscussionID!ID used to reply to the discussion.
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.

AbuseReportLabel

Fields

NameTypeDescription
colorString!Background color of the label.
createdAtTime!When the label was created.
descriptionStringDescription of the label (Markdown rendered as HTML for caching).
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
idAntiAbuseReportsLabelID!Global ID of the abuse report label.
textColorString!Text color of the label.
titleString!Content of the label.
updatedAtTime!When the label was last updated.

AbuseReportNote

Fields

NameTypeDescription
authorUserCoreUser who wrote the note.
awardEmojiAwardEmojiConnectionList of emoji reactions associated with the note. (see Connections)
bodyString!Content of the note.
bodyFirstLineHtmlString!First line of the note content.
bodyHtmlStringGitLab Flavored Markdown rendering of the content of the note.
createdAtTime!Timestamp of the note creation.
discussionAbuseReportDiscussionDiscussion the note is a part of.
idAntiAbuseReportsNoteID!ID of the note.
lastEditedAtTimeTimestamp when note was last edited.
lastEditedByUserCoreUser who last edited the note.
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.
updatedAtTime!Timestamp of the note’s last activity.
urlStringURL to view the note in the Web UI.

AccessLevel

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

Fields

NameTypeDescription
humanAccessStringHuman-readable display name for the access level.
integerValueIntInteger number of the access level.
stringValueAccessLevelEnumEnum string of the the access level.

AccessLevelDeployKey

Representation of a GitLab deploy key.

Fields

NameTypeDescription
expiresAtDateExpiration date of the deploy key.
idID!ID of the deploy key.
titleString!Title of the deploy key.
userAccessLevelUser!User assigned to the deploy key.

AccessLevelGroup

Representation of a GitLab group.

Fields

NameTypeDescription
avatarUrlStringAvatar URL of the group.
idID!ID of the group.
nameString!Name of the group.
parentAccessLevelGroupParent group.
webUrlString!Web URL of the group.

AccessLevelUser

Representation of a GitLab user.

Fields

NameTypeDescription
avatarUrlStringURL of the user’s avatar.
idID!ID of the user.
nameString!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.
publicEmailStringUser’s public email.
usernameString!Username of the user.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Achievement

Fields

NameTypeDescription
avatarUrlStringURL to avatar of the achievement.
createdAtTime!Timestamp the achievement was created.
descriptionStringDescription or notes for the achievement.
idAchievementsAchievementID!ID of the achievement.
nameString!Name of the achievement.
namespaceNamespaceNamespace of the achievement.
updatedAtTime!Timestamp the achievement was last updated.
userAchievements warning-solidUserAchievementConnectionIntroduced in GitLab 15.10. Status: Experiment. Recipients for the achievement.

AddOnPurchase

Represents AddOn purchase for Namespace.

Fields

NameTypeDescription
assignedQuantityInt!Number of seats assigned.
idGitlabSubscriptionsAddOnPurchaseID!ID of AddOnPurchase.
nameString!Name of AddOn.
purchasedQuantityInt!Number of seats purchased.

AddOnUser

A user with add-on data.

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
lastDuoActivityOnDateDate of the last Duo activity of the user. Refreshed on any GitLab Duo activity.
lastLoginAtTimeTimestamp of the last sign in.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Fields with arguments

AddOnUser.addOnAssignments

Add-on purchase assignments for the user.

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Returns UserAddOnAssignmentConnection.

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

Arguments
NameTypeDescription
addOnPurchaseIds[GitlabSubscriptionsAddOnPurchaseID!]!Global IDs of the add on purchases to find assignments for.
AddOnUser.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
AddOnUser.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
AddOnUser.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
AddOnUser.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
AddOnUser.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
AddOnUser.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
AddOnUser.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
AddOnUser.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
AddOnUser.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
AddOnUser.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
AddOnUser.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
AddOnUser.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

Arguments
NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.
AddOnUser.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.

AdminMemberRole

Represents an admin member role.

Fields

NameTypeDescription
baseAccessLevel warning-solidAccessLevel!Introduced in GitLab 16.5. Status: Experiment. Base access level for the custom role.
createdAtTime!Timestamp of when the member role was created.
dependentSecurityPolicies[ApprovalPolicy!]Array of security policies dependent on the custom role.
descriptionStringRole description.
detailsPath warning-solidStringIntroduced in GitLab 17.4. Status: Experiment. URL path to the role details webpage.
editPath warning-solidString!Introduced in GitLab 16.11. Status: Experiment. Web UI path to edit the custom role.
enabledPermissions warning-solidCustomizableAdminPermissionConnection!Introduced in GitLab 17.7. Status: Experiment. Array of all permissions enabled for the custom role.
idID!Role ID.
membersCount warning-solidIntIntroduced in GitLab 17.3. Status: Experiment. Number of times the role has been directly assigned to a group or project member.
nameStringRole name.
usersCount warning-solidIntIntroduced in GitLab 17.5. Status: Experiment. Number of users who have been directly assigned the role in at least one group or project.

AgentConfiguration

Configuration details for an Agent.

Fields

NameTypeDescription
agentNameStringName of the agent.

AgentMetadata

Information about a connected Agent.

Fields

NameTypeDescription
commitStringAgent version commit.
podNameStringName of the pod running the Agent.
podNamespaceStringNamespace of the pod running the Agent.
versionStringAgent version tag.

AgentVersionWarning

Version-related warning for a connected Agent.

Fields

NameTypeDescription
messageStringWarning message related to the version.
typeStringWarning type related to the version.

AgentWarning

Warning object for a connected Agent.

Fields

NameTypeDescription
versionAgentVersionWarningAgent warning related to the version.

AggregationStatus

Fields

NameTypeDescription
enabledBoolean!Whether background aggregation is enabled or disabled. For downgraded, non-licensed groups and projects the field is false.
estimatedNextUpdateAtTimeEstimated time when the next incremental update will happen.
lastUpdateAtTimeLast incremental update time.

AiAdditionalContext

Additional context for AI message.

Fields

NameTypeDescription
categoryAiAdditionalContextCategory!Category of the additional context.
contentString!Content of the additional context.
idID!ID of the additional context.
metadataJSONMetadata of the additional context.

AiAgent

An AI agent.

Fields

NameTypeDescription
createdAtTime!Date of creation.
idID!ID of the agent.
latestVersionAiAgentVersionLatest version of the agent.
nameString!Name of the agent.
routeIdInt!Route ID of the agent.
versions[AiAgentVersion!]Versions of the agent.

AiAgentVersion

Version of an AI Agent.

Fields

NameTypeDescription
createdAtTime!Timestamp when the agent version was created.
idID!ID of the agent version.
modelString!Model of the agent.
promptString!Prompt of the agent.

AiConversationsThread

Conversation thread of the AI feature.

Fields

NameTypeDescription
conversationTypeAiConversationsThreadsConversationType!Conversation type of the thread.
createdAtTime!Created date of the thread.
idID!ID of the thread.
lastUpdatedAtTime!Last updated date of the thread.
titleStringTitle of the thread.

AiFeatureSetting

Duo Chat feature setting.

Fields

NameTypeDescription
compatibleLlms[String!]LLMs Compatible with the feature.
featureString!Identifier for the AI feature.
mainFeatureStringDisplayed name of the main feature.
providerString!Humanized name for the AI feature, e.g “Code Completion”.
releaseStateStringCurrent release state of the feature.
selfHostedModelAiSelfHostedModelSelf-hosted model selected for use with the AI feature.
titleStringDisplayed AI feature name.
validModelsAiSelfHostedModelConnection!Compatible self-hosted models for the feature. (see Connections)

AiMessage

AI features communication message.

Fields

NameTypeDescription
agentVersionIdAiAgentVersionIDGlobal ID of the agent version to answer the message.
chunkIdIntIncremental ID for a chunk from a streamed message. Null when it is not a streamed message.
contentStringRaw response content.
contentHtmlStringResponse content as HTML.
errors[String!]Message errors.
extrasAiMessageExtrasExtra message metadata.
idIDUUID of the message.
requestIdStringUUID of the original request. Shared between chat prompt and response.
roleAiMessageRole!Message owner role.
threadIdAiConversationThreadIDGlobal ID of the existing thread for the Chat conversation.
timestampTime!Message creation timestamp.
typeAiMessageTypeMessage type.

AiMessageExtras

Extra metadata for AI message.

Fields

NameTypeDescription
additionalContext[AiAdditionalContext!]Additional context for the message.
hasFeedbackBooleanWhether the user has provided feedback for the mesage.
sources[JSON!]Sources used to form the message.

AiMetrics

Requires ClickHouse. Premium and Ultimate with GitLab Duo Pro and Enterprise only.

Fields

NameTypeDescription
codeContributorsCountIntNumber of code contributors.
codeSuggestionsAcceptedCountIntTotal count of code suggestions accepted by code contributors.
codeSuggestionsContributorsCountIntNumber of code contributors who used GitLab Duo Code Suggestions features.
codeSuggestionsShownCountIntTotal count of code suggestions shown to code contributors.
duoAssignedUsersCountIntTotal assigned Duo Pro and Enterprise seats. Ignores time period filter. Returns current data.
duoChatContributorsCountIntNumber of contributors who used GitLab Duo Chat features.
duoProAssignedUsersCount warning-solidIntDeprecated in GitLab 17.6. use duoAssignedUsersCount for the same behavior.
duoUsedCountIntNumber of contributors who used any GitLab Duo feature.

AiSelfHostedModel

Self-hosted LLM servers.

Fields

NameTypeDescription
apiTokenStringOptional API key for the self-hosted model server.
createdAtTime!Timestamp of creation.
endpointString!Endpoint of the self-hosted model server.
featureSettingsAiFeatureSettingConnectionAI feature settings using the self-hosted model. (see Connections)
hasApiTokenBoolean!Indicates if an API key is set for the self-hosted model server.
idAiSelfHostedModelID!ID of the self-hosted model server.
identifierStringIdentifier for 3rd party model provider.
modelString!AI model deployed.
modelDisplayNameString!Display name of the AI model deployed.
nameString!Deployment name of the self-hosted model.
releaseStateAiSelfHostedModelReleaseState!GitLab release status of the model.
updatedAtTimeTimestamp of last update.

AiUsageData

Usage data for events stored in the default PostgreSQL database. Data retained for three months. Requires a personal access token. Endpoint works only on the top-level group. Ultimate with GitLab Duo Enterprise only.

Fields

NameTypeDescription
codeSuggestionEventsCodeSuggestionEventConnectionEvents related to code suggestions. (see Connections)

AiUserMetrics

Pre-aggregated per-user metrics for GitLab Code Suggestions and GitLab Duo Chat. Require ClickHouse to be enabled and GitLab Ultimate with the Duo Enterprise add-on.

Fields

NameTypeDescription
codeSuggestionsAcceptedCountIntTotal count of code suggestions accepted by the user.
duoChatInteractionsCountIntNumber of user interactions with GitLab Duo Chat.
userAddOnUser!User associated with metrics.

AiXrayReport

Fields

NameTypeDescription
languageString!Language of the x-ray report.

AlertManagementAlert

Describes an alert from the project’s Alert Management.

Fields

NameTypeDescription
assigneesUserCoreConnectionAssignees of the alert. (see Connections)
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
createdAtTimeTimestamp the alert was created.
descriptionStringDescription of the alert.
detailsJSONAlert details.
detailsUrlString!URL of the alert detail page.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
endedAtTimeTimestamp the alert ended.
environmentEnvironmentEnvironment for the alert.
eventCountIntNumber of events of the alert.
hosts[String!]List of hosts the alert came from.
idID!ID of the alert.
iidString!Internal ID of the alert.
issueIssueIssue attached to the alert.
issueIid warning-solidStringDeprecated in GitLab 13.10. Use issue field.
metricsDashboardUrl warning-solidStringDeprecated in GitLab 16.0. Returns no data. Underlying feature was removed in 16.0.
monitoringToolStringMonitoring tool the alert came from.
nameStringName or title of this object.
prometheusAlert warning-solidPrometheusAlertDeprecated in GitLab 17.3. Returns no data. Underlying feature was removed in 16.0.
runbookStringRunbook for the alert as defined in alert details.
serviceStringService the alert came from.
severityAlertManagementSeveritySeverity of the alert.
startedAtTimeTimestamp the alert was raised.
statusAlertManagementStatusStatus of the alert.
titleStringTitle of the alert.
updatedAtTimeTimestamp the alert was last updated.
webUrlString!URL of the alert.

Fields with arguments

AlertManagementAlert.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
AlertManagementAlert.todos

To-do items of the current user for the alert.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.

AlertManagementAlertStatusCountsType

Represents total number of alerts for the represented categories.

Fields

NameTypeDescription
acknowledgedIntNumber of alerts with status ACKNOWLEDGED for the project.
allIntTotal number of alerts for the project.
ignoredIntNumber of alerts with status IGNORED for the project.
openIntNumber of alerts with status TRIGGERED or ACKNOWLEDGED for the project.
resolvedIntNumber of alerts with status RESOLVED for the project.
triggeredIntNumber of alerts with status TRIGGERED for the project.

AlertManagementHttpIntegration

An endpoint and credentials used to accept alerts for a project.

Fields

NameTypeDescription
activeBooleanWhether the endpoint is currently accepting alerts.
apiUrlStringURL at which Prometheus metrics can be queried to populate the metrics dashboard.
idID!ID of the integration.
nameStringName 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.
payloadExampleJsonStringExample of an alert payload.
tokenStringToken used to authenticate alert notification requests.
typeAlertManagementIntegrationType!Type of integration.
urlStringEndpoint which accepts alert notifications.

AlertManagementPayloadAlertField

Parsed field from an alert used for custom mappings.

Fields

NameTypeDescription
labelStringHuman-readable label of the payload path.
path[PayloadAlertFieldPathSegment!]Path to value inside payload JSON.
typeAlertManagementPayloadAlertFieldTypeType of the parsed value.

AlertManagementPayloadAlertMappingField

Parsed field (with its name) from an alert used for custom mappings.

Fields

NameTypeDescription
fieldNameAlertManagementPayloadAlertFieldNameGitLab alert field name.
labelStringHuman-readable label of the payload path.
path[PayloadAlertFieldPathSegment!]Path to value inside payload JSON.
typeAlertManagementPayloadAlertFieldTypeType of the parsed value.

AlertManagementPrometheusIntegration

An endpoint and credentials used to accept Prometheus alerts for a project.

Fields

NameTypeDescription
activeBooleanWhether the endpoint is currently accepting alerts.
apiUrlStringURL at which Prometheus metrics can be queried to populate the metrics dashboard.
idID!ID of the integration.
nameStringName of the integration.
tokenStringToken used to authenticate alert notification requests.
typeAlertManagementIntegrationType!Type of integration.
urlStringEndpoint which accepts alert notifications.

AmazonS3ConfigurationType

Stores Amazon S3 configurations for audit event streaming.

Fields

NameTypeDescription
accessKeyXidString!Access key ID of the Amazon S3 account.
awsRegionString!AWS region where the bucket is created.
bucketNameString!Name of the bucket where the audit events would be logged.
groupGroup!Group the configuration belongs to.
idID!ID of the configuration.
nameString!Name of the external destination to send audit events to.

ApiFuzzingCiConfiguration

Data associated with configuring API fuzzing scans in GitLab CI.

Fields

NameTypeDescription
scanModes[ApiFuzzingScanMode!]All available scan modes.
scanProfiles[ApiFuzzingScanProfile!]All default scan profiles.

ApiFuzzingScanProfile

An API Fuzzing scan profile.

Fields

NameTypeDescription
descriptionStringShort description of the profile.
nameStringUnique name of the profile.
yamlStringSyntax highlighted HTML representation of the YAML.

ApprovalPolicy

Represents the approval policy.

Fields

NameTypeDescription
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 warning-solid[String!]Introduced in GitLab 16.10. Status: Experiment. All deprecated properties in the policy.
descriptionString!Description of the policy.
editPathString!URL of policy edit page.
enabledBoolean!Indicates whether this policy is enabled.
nameString!Name of the policy.
policyScopePolicyScopeScope of the policy.
roleApprovers[MemberAccessLevelName!]Approvers of the role type. Users belonging to these role(s) alone will be approvers.
sourceSecurityPolicySource!Source of the policy. Its fields depend on the source type.
updatedAtTime!Timestamp of when the policy YAML was last updated.
userApprovers[UserCore!]Approvers of the user type.
yamlString!YAML definition of the policy.

ApprovalProjectRule

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

Fields

NameTypeDescription
approvalsRequiredIntNumber of required approvals.
eligibleApproversUserCoreConnectionList of users eligible to approve merge requests for this approval rule. (see Connections)
idGlobalID!ID of the rule.
nameStringName of the rule.
typeApprovalRuleTypeType of the rule.

ApprovalRule

Describes a rule for who can approve merge requests.

Fields

NameTypeDescription
allowMergeWhenInvalidBooleanIndicates if the rule can be ignored if it is invalid.
approvalsRequiredIntNumber of required approvals.
approvedBooleanIndicates if the rule is satisfied.
approvedByUserCoreConnectionList of users defined in the rule that approved the merge request. (see Connections)
commentedByUserCoreConnectionList of users, defined in the rule, who commented on the merge request. (see Connections)
containsHiddenGroupsBooleanIndicates 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).
groupsGroupConnectionList of groups added as approvers for the rule. (see Connections)
idGlobalID!ID of the rule.
invalidBooleanIndicates if the rule is invalid and cannot be approved.
nameStringName of the rule.
overriddenBooleanIndicates if the rule was overridden for the merge request.
scanResultPolicies[ApprovalScanResultPolicy!]List of scan result policies associated with the rule.
sectionStringNamed section of the Code Owners file that the rule applies to.
sourceRuleApprovalRuleSource rule used to create the rule.
typeApprovalRuleTypeType of the rule.
usersUserCoreConnectionList of users added as approvers for the rule. (see Connections)

ApprovalScanResultPolicy

Represents the scan result policy.

Fields

NameTypeDescription
approvalsRequiredInt!Represents the required approvals defined in the policy.
nameString!Represents the name of the policy.
reportTypeApprovalReportType!Represents the report_type of the approval rule.

AssetType

Represents a vulnerability asset type.

Fields

NameTypeDescription
nameString!Name of the asset.
typeString!Type of the asset.
urlString!URL of the asset.

AuditEventDefinition

Represents the YAML definitions for audit events defined in ee/config/audit_events/types/<event-type-name>.yml and config/audit_events/types/<event-type-name>.yml.

Fields

NameTypeDescription
descriptionString!Description of what action the audit event tracks.
featureCategoryString!Feature category associated with the event.
introducedByIssueStringLink to the issue introducing the event. For olderaudit events, it can be a commit URL rather than amerge request URL.
introducedByMrStringLink to the merge request introducing the event. Forolder audit events, it can be a commit URL rather thana merge request URL.
milestoneString!Milestone the event was introduced in.
nameString!Key name of the audit event.
savedToDatabaseBoolean!Indicates if the event is saved to PostgreSQL database.
streamedBoolean!Indicates if the event is streamed to an external destination.

AuditEventStreamingHTTPNamespaceFilter

Represents a subgroup or project filter that belongs to an external audit event streaming destination.

Fields

NameTypeDescription
externalAuditEventDestinationExternalAuditEventDestination!Destination to which the filter belongs.
idID!ID of the filter.
namespaceNamespace!Group or project namespace the filter belongs to.

AuditEventStreamingHeader

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

Fields

NameTypeDescription
activeBoolean!Header is active or not.
idID!ID of the header.
keyString!Key of the header.
valueString!Value of the header.

AuditEventsStreamingHTTPNamespaceFiltersAddPayload

Autogenerated return type of AuditEventsStreamingHTTPNamespaceFiltersAdd.

Fields

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errors[String!]!Errors encountered during execution of the mutation.
namespaceFilterAuditEventStreamingHTTPNamespaceFilterNamespace filter created.

AuditEventsStreamingHTTPNamespaceFiltersDeletePayload

Autogenerated return type of AuditEventsStreamingHTTPNamespaceFiltersDelete.

Fields

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

AuditEventsStreamingInstanceHeader

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

Fields

NameTypeDescription
activeBoolean!Header is active or not.
idID!ID of the header.
keyString!Key of the header.
valueString!Value of the header.

AutocompletedUser

Core representation of a GitLab user.

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Fields with arguments

AutocompletedUser.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
AutocompletedUser.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
AutocompletedUser.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
AutocompletedUser.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
AutocompletedUser.mergeRequestInteraction

Merge request state related to the user.

Returns UserMergeRequestInteraction.

Arguments
NameTypeDescription
idMergeRequestID!Global ID of the merge request.
AutocompletedUser.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
AutocompletedUser.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
AutocompletedUser.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
AutocompletedUser.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
AutocompletedUser.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
AutocompletedUser.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
AutocompletedUser.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
AutocompletedUser.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

Arguments
NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.
AutocompletedUser.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.

AwardEmoji

An emoji awarded by a user.

Fields

NameTypeDescription
descriptionString!Emoji description.
emojiString!Emoji as an icon.
nameString!Emoji name.
unicodeString!Emoji in Unicode.
unicodeVersionString!Unicode version for the emoji.
userUserCore!User who awarded the emoji.

BaseService

Fields

NameTypeDescription
activeBooleanIndicates if the service is active.
serviceTypeServiceTypeType of the service.
typeStringClass name of the service.

Blame

Fields

NameTypeDescription
firstLineStringFirst line of Git Blame for given range.
groups[Groups!]Git Blame grouped by contiguous lines for commit.

Blob

Fields

NameTypeDescription
flatPathString!Flat path of the entry.
idID!ID of the entry.
lfsOidStringLFS ID of the blob.
modeStringBlob mode in numeric format.
nameString!Name of the entry.
pathString!Path of the entry.
shaString!SHA of the entry.
typeEntryType!Type of tree entry.
webPathStringWeb path of the blob.
webUrlStringWeb URL of the blob.

BlobSearch

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

Fields

NameTypeDescription
fileCount warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Total number of files with matches.
files warning-solid[SearchBlobFileType!]Introduced in GitLab 17.2. Status: Experiment. List of files with matches.
matchCount warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Total number of matches.
perPage warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Total number of files per page.
searchLevel warning-solidSearchLevelIntroduced in GitLab 17.2. Status: Experiment. Level of search performed.
searchType warning-solidSearchTypeIntroduced in GitLab 17.2. Status: Experiment. Type of search performed.

BlobViewer

Represents how the blob content should be displayed.

Fields

NameTypeDescription
collapsedBoolean!Shows whether the blob should be displayed collapsed.
fileTypeString!Content file type.
loadAsyncBoolean!Shows whether the blob content is loaded asynchronously.
loadingPartialNameString!Loading partial name.
renderErrorStringError rendering the blob content.
tooLargeBoolean!Shows whether the blob is too large to be displayed.
typeBlobViewersType!Type of blob viewer.

BlockingMergeRequests

Information about the rules that must be satisfied to merge this merge request.

Fields

NameTypeDescription
hiddenCountInt!Blocking merge requests not visible to the user.
totalCountInt!Total number of blocking merge requests.
visibleMergeRequests[MergeRequest!]Blocking merge requests visible to the user.

Board

Represents a project or group issue board.

Fields

NameTypeDescription
assigneeUserCoreBoard assignee.
createdAtTime!Timestamp of when the board was created.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
idID!ID (global ID) of the board.
iterationIterationBoard iteration.
iterationCadenceIterationCadenceBoard iteration cadence.
labelsLabelConnectionLabels of the board. (see Connections)
milestoneMilestoneBoard milestone.
nameStringName of the board.
updatedAtTime!Timestamp of when the board was last updated.
webPathString!Web path of the board.
webUrlString!Web URL of the board.
weightIntWeight of the board.

Fields with arguments

Board.epics

Epics associated with board issues.

Returns BoardEpicConnection.

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

Arguments
NameTypeDescription
issueFiltersBoardIssueInputFilters applied when selecting issues on the board.
Board.lists

Lists of the board.

Returns BoardListConnection.

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

Arguments
NameTypeDescription
idListIDFind a list by its global ID.
issueFiltersBoardIssueInputFilters applied when getting issue metadata in the board list.

BoardEpic

Represents an epic on an issue board.

Fields

NameTypeDescription
authorUserCore!Author of the epic.
awardEmojiAwardEmojiConnectionList of emoji reactions associated with the epic. (see Connections)
blockedBooleanIndicates the epic is blocked.
blockedByCountIntCount of epics blocking this epic.
blockedByEpicsEpicConnectionEpics blocking this epic. (see Connections)
blockingCountIntCount of epics that this epic is blocking.
closedAtTimeTimestamp of when the epic was closed.
colorStringColor of the epic.
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
confidentialBooleanIndicates if the epic is confidential.
createdAtTimeTimestamp of when the epic was created.
defaultProjectForIssueCreationProjectDefault Project for issue creation. Based on the project the user created the last issue in.
descendantCountsEpicDescendantCountNumber of open and closed descendant epics and issues.
descendantWeightSumEpicDescendantWeightsTotal weight of open and closed issues in the epic and its descendants.
descriptionStringDescription of the epic.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
downvotesInt!Number of downvotes the epic has received.
dueDateTimeDue date of the epic.
dueDateFixedTimeFixed due date of the epic.
dueDateFromInheritedSourceTimeInherited due date of the epic from child epics or milestones.
dueDateFromMilestonesTimeInherited due date of the epic from milestones.
dueDateIsFixedBooleanIndicates if the due date has been manually set.
eventsEventConnectionList of events associated with the object. (see Connections)
groupGroup!Group to which the epic belongs.
hasChildrenBoolean!Indicates if the epic has children.
hasChildrenWithinTimeframeBoolean!Indicates if the epic has children in the specified timeframe.
hasIssuesBoolean!Indicates if the epic has direct issues.
hasParentBoolean!Indicates if the epic has a parent epic.
healthStatusEpicHealthStatusCurrent health status of the epic.
idID!ID of the epic.
iidString!Internal ID of the epic.
issuesEpicIssueConnectionA list of issues associated with the epic. (see Connections)
labelsLabelConnectionLabels assigned to the epic. (see Connections)
nameStringName or title of this object.
parentEpicParent epic of the epic.
participantsUserCoreConnectionList of participants for the epic. (see Connections)
relationPathStringURI path of the epic-issue relationship.
relativePositionIntRelative position of the epic in the epic tree.
startDateTimeStart date of the epic.
startDateFixedTimeFixed start date of the epic.
startDateFromInheritedSourceTimeInherited start date of the epic from child epics or milestones.
startDateFromMilestonesTimeInherited start date of the epic from milestones.
startDateIsFixedBooleanIndicates if the start date has been manually set.
stateEpicState!State of the epic.
subscribedBoolean!Indicates the currently logged in user is subscribed to the epic.
textColorStringText color generated for the epic.
titleStringTitle of the epic.
titleHtmlStringGitLab Flavored Markdown rendering of title.
updatedAtTimeTimestamp of when the epic was updated.
upvotesInt!Number of upvotes the epic has received.
userDiscussionsCountInt!Number of user discussions in the epic.
userNotesCountInt!Number of user notes of the epic.
userPermissionsEpicPermissions!Permissions for the current user on the resource.
userPreferencesBoardEpicUserPreferencesUser preferences for the epic on the issue board.
webPathString!Web path of the epic.
webUrlString!Web URL of the epic.

Fields with arguments

BoardEpic.ancestors

Ancestors (parents) of the epic.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsernameStringFilter epics by author.
confidentialBooleanFilter epics by given confidentiality.
createdAfterTimeEpics created after this date.
createdBeforeTimeEpics created before this date.
iidIDIID of the epic, e.g., “1”.
iidStartsWithStringFilter 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.'.
includeAncestorGroupsBooleanInclude epics from ancestor groups.
includeDescendantGroupsBooleanInclude epics from descendant groups.
labelName[String!]Filter epics by labels.
milestoneTitleStringFilter epics by milestone title, computed from epic’s issues.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedEpicFilterInputNegated epic arguments.
orUnionedEpicFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortEpicSortList epics by sort order.
stateEpicStateFilter epics by state.
subscribedSubscriptionStatusEpics the current user is subscribed to.
timeframeTimeframeList items overlapping the given timeframe.
topLevelHierarchyOnlyBooleanFilter epics with a top-level hierarchy.
updatedAfterTimeEpics updated after this date.
updatedBeforeTimeEpics updated before this date.
BoardEpic.children

Children (sub-epics) of the epic.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsernameStringFilter epics by author.
confidentialBooleanFilter epics by given confidentiality.
createdAfterTimeEpics created after this date.
createdBeforeTimeEpics created before this date.
iidIDIID of the epic, e.g., “1”.
iidStartsWithStringFilter 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.'.
includeAncestorGroupsBooleanInclude child epics from ancestor groups.
includeDescendantGroupsBooleanInclude epics from descendant groups.
labelName[String!]Filter epics by labels.
milestoneTitleStringFilter epics by milestone title, computed from epic’s issues.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedEpicFilterInputNegated epic arguments.
orUnionedEpicFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortEpicSortList epics by sort order.
stateEpicStateFilter epics by state.
subscribedSubscriptionStatusEpics the current user is subscribed to.
timeframeTimeframeList items overlapping the given timeframe.
topLevelHierarchyOnlyBooleanFilter epics with a top-level hierarchy.
updatedAfterTimeEpics updated after this date.
updatedBeforeTimeEpics updated before this date.
BoardEpic.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
stateTodoStateEnumState of the to-do items.
BoardEpic.linkedWorkItems

Work items linked to the epic.

Returns LinkedWorkItemTypeConnection.

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

Arguments
NameTypeDescription
filterWorkItemRelatedLinkTypeFilter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
BoardEpic.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
BoardEpic.reference

Internal reference of the epic. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
fullBooleanIndicates if the reference should be returned in full.

BoardEpicUserPreferences

Represents user preferences for a board epic.

Fields

NameTypeDescription
collapsedBoolean!Indicates epic should be displayed as collapsed.

BoardList

Represents a list for an issue board.

Fields

NameTypeDescription
assigneeUserCoreAssignee in the list.
collapsedBooleanIndicates if the list is collapsed for the user.
idID!ID (global ID) of the list.
issuesCountIntCount of issues in the list.
iterationIterationIteration of the list.
labelLabelLabel of the list.
limitMetricListLimitMetricCurrent limit metric for the list.
listTypeString!Type of the list.
maxIssueCountIntMaximum number of issues in the list.
maxIssueWeightIntMaximum weight of issues in the list.
milestoneMilestoneMilestone of the list.
positionIntPosition of list within the board.
titleString!Title of the list.
totalIssueWeightBigIntTotal weight of all issues in the list, encoded as a string.

Fields with arguments

BoardList.issues

Board issues.

Returns IssueConnection.

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

Arguments
NameTypeDescription
filtersBoardIssueInputFilters applied when selecting issues in the board list.

BooleanExpression

an expression with a boolean value.

Fields

NameTypeDescription
fieldString!Field the expression applies to.
operatorString!Operator of the expression.
valueBoolean!Boolean value of the expression.

Branch

Fields

NameTypeDescription
commitCommitCommit for the branch.
nameString!Name of the branch.

BranchProtection

Branch protection details for a branch rule.

Fields

NameTypeDescription
allowForcePushBoolean!Toggle force push to the branch for users with write access.
codeOwnerApprovalRequiredBoolean!Enforce code owner approvals before allowing a merge.
mergeAccessLevelsMergeAccessLevelConnectionDetails about who can merge when the branch is the source branch. (see Connections)
pushAccessLevelsPushAccessLevelConnectionDetails about who can push when the branch is the source branch. (see Connections)
unprotectAccessLevelsUnprotectAccessLevelConnectionDetails about who can unprotect this branch. (see Connections)

BranchRule

Branch rules configured for a rule target.

Fields

NameTypeDescription
approvalRulesApprovalProjectRuleConnectionMerge request approval rules configured for this branch rule. (see Connections)
branchProtectionBranchProtectionBranch protections configured for this branch rule.
createdAtTimeTimestamp of when the branch rule was created.
externalStatusChecksExternalStatusCheckConnectionExternal status checks configured for this branch rule. (see Connections)
idProjectsBranchRuleIDID of the branch rule.
isDefaultBoolean!Check if this branch rule protects the project’s default branch.
isProtectedBoolean!Check if this branch rule protects access for the branch.
matchingBranchesCountInt!Number of existing branches that match this branch rule.
nameString!Name of the branch rule target. Includes wildcards.
squashOption warning-solidSquashOptionIntroduced in GitLab 17.9. Status: Experiment. The default behavior for squashing in merge requests. Returns null if branch_rule_squash_settings feature flag is disabled.
updatedAtTimeTimestamp of when the branch rule was last updated.

BurnupChartDailyTotals

Represents the total number of issues and their weights for a particular day.

Fields

NameTypeDescription
completedCountInt!Number of closed issues as of this day.
completedWeightInt!Total weight of closed issues as of this day.
dateISO8601Date!Date for burnup totals.
scopeCountInt!Number of issues as of this day.
scopeWeightInt!Total weight of issues as of this day.

CarPermissions

Check user’s permission for the car.

Fields

NameTypeDescription
deleteMergeTrainCarBoolean!If true, the user can perform delete_merge_train_car on this resource.

CiApplicationSettings

Fields

NameTypeDescription
keepLatestArtifactBooleanWhether to keep the latest jobs artifacts.

CiBuildNeed

Fields

NameTypeDescription
idID!ID of the BuildNeed.
nameStringName of the job we need to complete.

CiCatalogResource

Fields

NameTypeDescription
descriptionStringDescription of the catalog resource.
fullPath warning-solidIDIntroduced in GitLab 16.11. Status: Experiment. Full project path of the catalog resource.
iconStringIcon for the catalog resource.
idID!ID of the catalog resource.
last30DayUsageCount warning-solidInt!Introduced in GitLab 17.0. Status: Experiment. Number of projects that used a component from this catalog resource in a pipeline, by using include:component, in the last 30 days.
latestReleasedAt warning-solidTimeIntroduced in GitLab 16.5. Status: Experiment. Release date of the catalog resource’s latest version.
nameStringName of the catalog resource.
starCountInt!Number of times the catalog resource has been starred.
starrersPathStringRelative path to the starrers page for the catalog resource project.
topics[String!]Topics for the catalog resource.
verificationLevelCiCatalogResourceVerificationLevelVerification level of the catalog resource.
visibilityLevelVisibilityLevelsEnumVisibility level of the catalog resource.
webPath warning-solidStringIntroduced in GitLab 16.1. Status: Experiment. Web path of the catalog resource.

Fields with arguments

CiCatalogResource.versions

Versions of the catalog resource. This field can only be resolved for one catalog resource in any single request.

Returns CiCatalogResourceVersionConnection.

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

Arguments
NameTypeDescription
nameStringName of the version.

CiCatalogResourceComponent

Fields

NameTypeDescription
idCiCatalogResourcesComponentID!ID of the component.
includePathStringPath used to include the component.
inputs[CiCatalogResourceComponentInput!]Inputs for the component.
nameStringName of the component.

CiCatalogResourceComponentInput

Fields

NameTypeDescription
defaultStringDefault value for the input.
descriptionStringDescription of the input.
nameStringName of the input.
regexStringPattern that the input value must match. Only applicable to string inputs.
requiredBooleanIndicates if an input is required.
typeCiCatalogResourceComponentInputTypeType of the input.

CiCatalogResourceComponentUsage

Represents a component usage in a project.

Fields

NameTypeDescription
lastUsedDateISO8601DateWhen the component was last used.
nameStringName of the component.
versionStringVersion of the component.

CiCatalogResourceVersion

Fields

NameTypeDescription
authorUserCoreUser that created the version.
commitCommitCommit associated with the version.
componentsCiCatalogResourceComponentConnectionComponents belonging to the catalog resource. (see Connections)
createdAtTimeTimestamp of when the version was created.
idCiCatalogResourcesVersionID!Global ID of the version.
nameStringName that uniquely identifies the version within the catalog resource.
pathStringRelative web path to the version.
readmeStringReadme data.
readmeHtmlStringGitLab Flavored Markdown rendering of readme.
releasedAt warning-solidTimeIntroduced in GitLab 16.7. Status: Experiment. Timestamp of when the version was released.

CiCdSettings

Fields

NameTypeDescription
pipelineVariablesDefaultRoleStringIndicates the default minimum role required to override pipeline variables in the namespace.

CiConfig

Fields

NameTypeDescription
errors[String!]Linting errors.
includes[CiConfigInclude!]List of included files.
mergedYamlStringMerged CI configuration YAML.
stagesCiConfigStageConnectionStages of the pipeline. (see Connections)
statusCiConfigStatusStatus of linting, can be either valid or invalid.
warnings[String!]Linting warnings.

CiConfigGroup

Fields

NameTypeDescription
jobsCiConfigJobConnectionJobs in group. (see Connections)
nameStringName of the job group.
sizeIntSize of the job group.

CiConfigInclude

Fields

NameTypeDescription
blobStringFile 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".
contextProjectStringCurrent project scope, e.g., “gitlab-org/gitlab”.
contextShaStringCurrent sha scope.
extraJSONExtra information for the include, which can contain job_name, project, and ref. Values can be masked if they contain masked variables.
locationStringFile location. It can be masked if it contains masked variables. For example, ".gitlab/ci/build-images.gitlab-ci.yml".
rawStringFile 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".
typeCiConfigIncludeTypeInclude type.

CiConfigJob

Fields

NameTypeDescription
afterScript[String!]Override a set of commands that are executed after the job.
allowFailureBooleanAllow job to fail.
beforeScript[String!]Override a set of commands that are executed before the job.
environmentStringName of an environment to which the job deploys.
exceptCiConfigJobRestrictionLimit when jobs are not created.
groupNameStringName of the job group.
nameStringName of the job.
needsCiConfigNeedConnectionBuilds that must complete before the jobs run. (see Connections)
onlyCiConfigJobRestrictionJobs are created when these conditions do not apply.
script[String!]Shell script that is executed by a runner.
stageStringName of the job stage.
tags[String!]List of tags that are used to select a runner.
whenStringWhen to run the job.

CiConfigJobRestriction

Fields

NameTypeDescription
refs[String!]Git refs the job restriction applies to.

CiConfigNeed

Fields

NameTypeDescription
nameStringName of the need.

CiConfigStage

Fields

NameTypeDescription
groupsCiConfigGroupConnectionGroups of jobs for the stage. (see Connections)
nameStringName of the stage.

CiConfigVariable

CI/CD config variables.

Fields

NameTypeDescription
descriptionStringDescription for the CI/CD config variable.
keyStringName of the variable.
valueStringValue of the variable.
valueOptions[String!]Value options for the variable.

CiDurationStatistics

Histogram of durations for a group of CI/CD jobs or pipelines.

Fields

NameTypeDescription
p50 warning-solidDurationIntroduced in GitLab 15.8. Status: Experiment. 50th percentile. 50% of the durations are lower than this value.
p75 warning-solidDurationIntroduced in GitLab 15.8. Status: Experiment. 75th percentile. 75% of the durations are lower than this value.
p90 warning-solidDurationIntroduced in GitLab 15.8. Status: Experiment. 90th percentile. 90% of the durations are lower than this value.
p95 warning-solidDurationIntroduced in GitLab 15.8. Status: Experiment. 95th percentile. 95% of the durations are lower than this value.
p99 warning-solidDurationIntroduced in GitLab 15.8. Status: Experiment. 99th percentile. 99% of the durations are lower than this value.

CiFreezePeriod

Represents a deployment freeze window of a project.

Fields

NameTypeDescription
cronTimezoneStringTime zone for the cron fields, defaults to UTC if not provided.
endCronString!End of the freeze period in cron format.
endTimeTimeTimestamp (UTC) of when the current/next active period ends.
startCronString!Start of the freeze period in cron format.
startTimeTimeTimestamp (UTC) of when the current/next active period starts.
statusCiFreezePeriodStatus!Freeze period status.

CiGroup

Fields

NameTypeDescription
detailedStatusDetailedStatusDetailed status of the group.
idString!ID for a group.
jobsCiJobConnectionJobs in group. (see Connections)
nameStringName of the job group.
sizeIntSize of the group.

CiGroupEnvironmentScope

CI/CD environment scope for a group.

Fields

NameTypeDescription
nameStringScope name defininig the enviromnments that can use the variable.

CiGroupVariable

CI/CD variables for a group.

Fields

NameTypeDescription
descriptionStringDescription of the variable.
environmentScopeStringScope defining the environments that can use the variable.
hiddenBooleanIndicates whether the variable is hidden.
idID!ID of the variable.
keyStringName of the variable.
maskedBooleanIndicates whether the variable is masked.
protectedBooleanIndicates whether the variable is protected.
rawBooleanIndicates whether the variable is raw.
valueStringValue of the variable.
variableTypeCiVariableTypeType of the variable.

CiInstanceVariable

CI/CD variables for a GitLab instance.

Fields

NameTypeDescription
descriptionStringDescription of the variable.
environmentScope warning-solidStringDeprecated in GitLab 15.3. No longer used, only available for GroupVariableType and ProjectVariableType.
idID!ID of the variable.
keyStringName of the variable.
maskedBooleanIndicates whether the variable is masked.
protectedBooleanIndicates whether the variable is protected.
rawBooleanIndicates whether the variable is raw.
valueStringValue of the variable.
variableTypeCiVariableTypeType of the variable.

CiJob

Fields

NameTypeDescription
activeBoolean!Indicates the job is active.
allowFailureBoolean!Whether the job is allowed to fail.
artifactsCiJobArtifactConnectionArtifacts generated by the job. (see Connections)
browseArtifactsPathStringURL for browsing the artifact’s archive.
canPlayJobBoolean!Indicates whether the current user can play the job.
cancelableBoolean!Indicates the job can be canceled.
commitPathStringPath to the commit that triggered the job.
coverageFloatCoverage level of the job.
createdAtTime!When the job was created.
createdByTagBoolean!Whether the job was created by a tag.
detailedStatusDetailedStatusDetailed status of the job.
downstreamPipelinePipelineDownstream pipeline for a bridge.
durationIntDuration of the job in seconds.
erasedAtTimeWhen the job was erased.
exitCodeIntExit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code.
failureMessageStringMessage on why the job failed.
finishedAtTimeWhen a job has finished running.
idJobIDID of the job.
kindCiJobKind!Indicates the type of job.
manualJobBooleanWhether the job has a manual action.
manualVariablesCiManualVariableConnectionVariables added to a manual job when the job is triggered. (see Connections)
nameStringName of the job.
needsCiBuildNeedConnectionReferences to builds that must complete before the jobs run. (see Connections)
pipelinePipelinePipeline the job belongs to.
playPathStringPlay path of the job.
playableBoolean!Indicates the job can be played.
previousStageJobsCiJobConnectionJobs from the previous stage. (see Connections)
previousStageJobsOrNeeds warning-solidJobNeedUnionConnectionDeprecated in GitLab 16.4. Replaced by previousStageJobs and needs fields.
projectProjectProject that the job belongs to.
queuedAtTimeWhen the job was enqueued and marked as pending.
queuedDurationDurationHow long the job was enqueued before starting.
refNameStringRef name of the job.
refPathStringPath to the ref.
retriedBooleanIndicates that the job has been retried.
retryableBoolean!Indicates the job can be retried.
runnerCiRunnerRunner assigned to execute the job.
runnerManagerCiRunnerManagerRunner manager assigned to the job.
scheduledBoolean!Indicates the job is scheduled.
scheduledAtTimeSchedule for the build.
schedulingTypeStringType of job scheduling. Value is dag if the job uses the needs keyword, and stage otherwise.
shortShaString!Short SHA1 ID of the commit.
sourceStringPolicy or action that initiated the job. If not set, the value is inherited from the pipeline.
stageCiStageStage of the job.
startedAtTimeWhen the job was started.
statusCiJobStatusStatus of the job.
stuckBoolean!Indicates the job is stuck.
tags[String!]Tags for the current job.
traceCiJobTraceTrace generated by the job.
triggeredBooleanWhether the job was triggered.
userPermissionsJobPermissions!Permissions for the current user on the resource.
webPathStringWeb path of the job.

CiJobArtifact

Fields

NameTypeDescription
downloadPathStringURL for downloading the artifact’s file.
expireAtTimeExpiry date of the artifact.
fileTypeJobArtifactFileTypeFile type of the artifact.
idCiJobArtifactID!ID of the artifact.
nameStringFile name of the artifact.
sizeBigInt!Size of the artifact in bytes.

CiJobTokenAccessibleGroup

Group that can access the current project by authenticating with a CI/CD job token.

Fields

NameTypeDescription
avatarUrlStringAvatar URL of the group.
fullPathID!Full path of the group.
idID!ID of the group.
nameString!Name of the group.
pathString!Path of the group.
webUrlStringWeb URL of the group.

CiJobTokenAccessibleProject

Project that can access the current project by authenticating with a CI/CD job token.

Fields

NameTypeDescription
avatarUrlStringURL to avatar image file of the project.
fullPathID!Full path of the project.
idID!ID of the project.
nameString!Name of the project (without namespace).
pathString!Path of the project.
webUrlStringWeb URL of the project.

CiJobTokenAuthLog

Fields

NameTypeDescription
lastAuthorizedAt warning-solidTime!Introduced in GitLab 17.6. Status: Experiment. Last authorization date time.
originProject warning-solidCiJobTokenAccessibleProject!Introduced in GitLab 17.6. Status: Experiment. Origin project.

CiJobTokenScopeAllowlist

Fields

NameTypeDescription
groupsAllowlistCiJobTokenScopeAllowlistEntryConnectionAllowlist of groups that can access the current project by authenticating with a CI/CD job token. (see Connections)
projectsAllowlistCiJobTokenScopeAllowlistEntryConnectionAllowlist of projects that can access the current project by authenticating with a CI/CD job token. (see Connections)

CiJobTokenScopeAllowlistEntry

Represents an allowlist entry for the CI_JOB_TOKEN.

Fields

NameTypeDescription
addedByUserCoreUser that added the entry.
autopopulatedBooleanIndicates whether the entry is created by the autopopulation process.
createdAtTime!When the entry was created.
defaultPermissionsBooleanIndicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
directionStringDirection of access. Defaults to INBOUND.
jobTokenPolicies warning-solid[CiJobTokenScopePolicies!]Introduced in GitLab 17.5. Status: Experiment. List of policies for the entry.
sourceProjectProject!Project that owns the allowlist entry.
targetCiJobTokenScopeTargetGroup or project allowed by the entry.

CiJobTokenScopeType

Fields

NameTypeDescription
groupAllowlistAutopopulatedIds[GroupID!]!List of IDs of groups which have been created by the autopopulation process.
groupsAllowlistCiJobTokenAccessibleGroupConnection!Allowlist of groups that can access the current project by authenticating with a CI/CD job token. (see Connections)
groupsAllowlistCountInt!Count of groups that can access the current project by authenticating with a CI/CD job token. The count does not include subgroups.
inboundAllowlistCiJobTokenAccessibleProjectConnection!Allowlist of projects that can access the current project by authenticating with a CI/CD job token. (see Connections)
inboundAllowlistAutopopulatedIds[ProjectID!]!List of IDs of projects which have been created by the autopopulation process.
inboundAllowlistCountInt!Count of projects that can access the current project by authenticating with a CI/CD job token. The count does not include nested projects.
outboundAllowlistProjectConnection!Allow list of projects that are accessible using the current project’s CI Job tokens. (see Connections)
projects warning-solidProjectConnection!Deprecated in GitLab 15.9. The projects attribute is being deprecated. Use outbound_allowlist.

CiJobTrace

Fields with arguments

CiJobTrace.htmlSummary

HTML summary that contains the tail lines of the trace. Returns at most 16KB of raw bytes from the trace. The returned string might start with an unexpected invalid UTF-8 code point due to truncation.

  • Introduced in GitLab 15.11.
  • Status: Experiment.

Returns String!.

Arguments
NameTypeDescription
lastLinesIntNumber of tail lines to return, up to a maximum of 100 lines.

CiJobsStatistics

Statistics for a group of CI jobs.

Fields

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

Fields

NameTypeDescription
environmentScope warning-solidStringDeprecated in GitLab 15.3. No longer used, only available for GroupVariableType and ProjectVariableType.
idID!ID of the variable.
keyStringName of the variable.
rawBooleanIndicates whether the variable is raw.
valueStringValue of the variable.
variableTypeCiVariableTypeType of the variable.

CiMinutesNamespaceMonthlyUsage

Fields

NameTypeDescription
minutesIntTotal number of compute minutes used by all projects in the namespace.
monthStringMonth related to the usage data.
monthIso8601ISO8601DateMonth related to the usage data in ISO 8601 date format.
projectsCiMinutesProjectMonthlyUsageConnectionCompute usage data for projects in the namespace. (see Connections)
sharedRunnersDurationIntTotal duration (in seconds) of shared runners use by the namespace for the month.

CiMinutesProjectMonthlyUsage

Fields

NameTypeDescription
minutesIntNumber of compute minutes used by the project in the month.
name warning-solidStringDeprecated in GitLab 15.6. Use project.name.
projectProjectProject having the recorded usage.
sharedRunnersDurationIntTotal duration (in seconds) of shared runners use by the project for the month.

CiPipelineCreationRequest

Information about an asynchronous pipeline creation request.

Fields

NameTypeDescription
errorStringError message if pipeline creation failed.
pipelineIdCiPipelineIDID of the created pipeline if creation was successful.
statusCiPipelineCreationStatus!Current status of the pipeline creation.

CiProjectSubscription

Fields

NameTypeDescription
authorUserCoreAuthor of the subscription.
downstreamProjectCiSubscriptionsProjectDetailsDownstream project of the subscription.When an upstream project’s pipeline completes, a pipeline is triggered in the downstream project.
idCiSubscriptionsProjectIDGlobal ID of the subscription.
upstreamProjectCiSubscriptionsProjectDetailsUpstream project of the subscription.When an upstream project’s pipeline completes, a pipeline is triggered in the downstream project.

CiProjectVariable

CI/CD variables for a project.

Fields

NameTypeDescription
descriptionStringDescription of the variable.
environmentScopeStringScope defining the environments that can use the variable.
hiddenBooleanIndicates whether the variable is hidden.
idID!ID of the variable.
keyStringName of the variable.
maskedBooleanIndicates whether the variable is masked.
protectedBooleanIndicates whether the variable is protected.
rawBooleanIndicates whether the variable is raw.
valueStringValue of the variable.
variableTypeCiVariableTypeType of the variable.

CiRunner

Fields

NameTypeDescription
accessLevelCiRunnerAccessLevel!Access level of the runner.
active warning-solidBoolean!Deprecated in GitLab 14.8. Use paused.
adminUrlStringAdmin URL of the runner. Only available for administrators.
contactedAtTimeTimestamp of last contact from the runner.
createdAtTimeTimestamp of creation of the runner.
createdByUserCoreUser that created the runner.
creationMethod warning-solidCiRunnerCreationMethodIntroduced in GitLab 17.0. Status: Experiment. Type of runner registration.
descriptionStringDescription of the runner.
editAdminUrlStringAdmin form URL of the runner. Only available for administrators.
ephemeralAuthenticationToken warning-solidStringIntroduced in GitLab 15.9. Status: Experiment. Ephemeral authentication token used for runner manager registration. Only available for the creator of the runner for a limited time during registration.
ephemeralRegisterUrl warning-solidStringIntroduced in GitLab 15.11. Status: Experiment. URL of the registration page of the runner manager. Only available for the creator of the runner for a limited time during registration.
groupsGroupConnectionGroups the runner is associated with. For group runners only. (see Connections)
idCiRunnerID!ID of the runner.
jobExecutionStatus warning-solidCiRunnerJobExecutionStatusIntroduced in GitLab 15.7. Status: Experiment. Job execution status of the runner.
lockedBooleanIndicates the runner is locked.
maintenanceNoteStringRunner’s maintenance notes.
maintenanceNoteHtmlStringGitLab Flavored Markdown rendering of maintenance_note.
maximumTimeoutIntMaximum timeout (in seconds) for jobs processed by the runner.
ownerProjectProjectProject that owns the runner. For project runners only.
pausedBoolean!Indicates the runner is paused and not available to run jobs.
privateProjectsMinutesCostFactorFloatPrivate projects’ “compute cost factor” associated with the runner (GitLab.com only).
projectCountIntNumber of projects that the runner is associated with.
publicProjectsMinutesCostFactorFloatPublic projects’ “compute cost factor” associated with the runner (GitLab.com only).
registerAdminUrlStringURL of the temporary registration page of the runner. Only available before the runner is registered. Only available for administrators.
runUntaggedBoolean!Indicates the runner is able to run untagged jobs.
runnerTypeCiRunnerType!Type of the runner.
shortShaStringFirst eight characters of the runner’s token used to authenticate new job requests. Used as the runner’s unique ID.
statusCiRunnerStatus!Status of the runner.
tagList[String!]Tags associated with the runner.
tokenExpiresAtTimeRunner token expiration time.
upgradeStatusCiRunnerUpgradeStatusAvailability of upgrades for the runner.
userPermissionsRunnerPermissions!Permissions for the current user on the resource.

Fields with arguments

CiRunner.jobCount

Number of jobs processed by the runner (limited to 1000, plus one to indicate that more items exist). jobCount is an optimized version of jobs { count }, and can be requested for multiple runners on the same request.

Returns Int.

Arguments
NameTypeDescription
statuses warning-solid[CiJobStatus!]Introduced in GitLab 16.2. Status: Experiment. Filter jobs by status.
CiRunner.jobs

Jobs assigned to the runner. This field can only be resolved for one runner in any single request.

Returns CiJobConnection.

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

Arguments
NameTypeDescription
statuses[CiJobStatus!]Filter jobs by status.
CiRunner.managers

Runner managers associated with the runner configuration.

Returns CiRunnerManagerConnection.

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

Arguments
NameTypeDescription
statusCiRunnerStatusFilter runner managers by status.
systemIdStringFilter runner managers by system ID.
CiRunner.projects

Find projects the runner is associated with. For project runners only.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
membershipBooleanReturn only projects that the current user is a member of.
personalBooleanReturn only personal projects.
searchStringSearch query, which can be for the project name, a path, or a description.
searchNamespacesBooleanInclude namespace in project search.
sortStringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics[String!]Filter projects by topics.

CiRunnerCloudProvisioningStep

Step used to provision the runner to Google Cloud.

Fields

NameTypeDescription
instructionsStringInstructions to provision the runner.
languageIdentifierStringIdentifier 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.
titleStringTitle of the step.

CiRunnerGkeProvisioning

Information used for GKE runner provisioning.

Fields

NameTypeDescription
projectSetupShellScriptStringInstructions for setting up a Google Cloud project.

Fields with arguments

CiRunnerGkeProvisioning.provisioningSteps

Steps used to provision a runner in GKE.

Returns [CiRunnerGkeProvisioningStep!].

Arguments
NameTypeDescription
nodePools[GoogleCloudNodePool!]Configuration for the node pools of the runner.
regionGoogleCloudRegion!Name of the region to provision the runner in.
runnerTokenString!Authentication token of the runner.
zoneGoogleCloudZone!Name of the zone to provision the runner in.

CiRunnerGkeProvisioningStep

Step used to provision the runner to GKE.

Fields

NameTypeDescription
instructionsStringInstructions to provision the runner.
languageIdentifierStringIdentifier 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.
titleStringTitle of the step.

CiRunnerGoogleCloudProvisioning

Information used for runner Google Cloud provisioning.

Fields

NameTypeDescription
projectSetupShellScriptStringInstructions for setting up a Google Cloud project.

Fields with arguments

CiRunnerGoogleCloudProvisioning.provisioningSteps

Steps used to provision a runner in the cloud.

Returns [CiRunnerCloudProvisioningStep!].

Arguments
NameTypeDescription
ephemeralMachineTypeGoogleCloudMachineType!Name of the machine type to use for running jobs.
regionGoogleCloudRegion!Name of the region to provision the runner in.
runnerTokenStringAuthentication token of the runner.
zoneGoogleCloudZone!Name of the zone to provision the runner in.

CiRunnerManager

Fields

NameTypeDescription
architectureNameStringArchitecture provided by the runner manager.
contactedAtTimeTimestamp of last contact from the runner manager.
createdAtTimeTimestamp of creation of the runner manager.
executorNameStringExecutor last advertised by the runner.
idCiRunnerManagerID!ID of the runner manager.
ipAddressStringIP address of the runner manager.
jobExecutionStatus warning-solidCiRunnerJobExecutionStatusIntroduced in GitLab 16.3. Status: Experiment. Job execution status of the runner manager.
platformNameStringPlatform provided by the runner manager.
revisionStringRevision of the runner.
runnerCiRunnerRunner configuration for the runner manager.
statusCiRunnerStatus!Status of the runner manager.
systemIdString!System ID associated with the runner manager.
upgradeStatusCiRunnerUpgradeStatusAvailability of upgrades for the runner manager.
versionStringVersion of the runner.

CiRunnerUsage

Runner usage in minutes.

Fields

NameTypeDescription
ciBuildCountBigInt!Amount of builds executed during the selected period. Encoded as a string.
ciDurationBigInt!Number of minutes spent to process jobs during the selected period. Encoded as a string.
ciMinutesUsed warning-solidBigInt!Deprecated in GitLab 17.5. Use ciDuration.
runnerCiRunnerRunner that the usage refers to. Null means “Other runners”.

CiRunnerUsageByProject

Runner usage in minutes by project.

Fields

NameTypeDescription
ciBuildCountBigInt!Amount of builds executed during the selected period. Encoded as a string.
ciDurationBigInt!Number of minutes spent to process jobs during the selected period. Encoded as a string.
ciMinutesUsed warning-solidBigInt!Deprecated in GitLab 17.5. Use ciDuration.
projectProjectProject that the usage refers to. Null means “Other projects”.

CiSecureFileRegistry

Represents the Geo replication and verification state of a ci_secure_file.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the CiSecureFileRegistry do not match on the primary and secondary.
ciSecureFileIdID!ID of the Ci Secure File.
createdAtTimeTimestamp when the CiSecureFileRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the CiSecureFileRegistry.
lastSyncFailureStringError message during sync of the CiSecureFileRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the CiSecureFileRegistry.
missingOnPrimaryBooleanIndicate if the CiSecureFileRegistry is missing on primary.
modelRecordIdIntID of the CiSecureFileRegistry’s model record.
retryAtTimeTimestamp after which the CiSecureFileRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the CiSecureFileRegistry.
stateRegistryStateSync state of the CiSecureFileRegistry.
verificationChecksumStringThe local checksum of the CiSecureFileRegistry.
verificationChecksumMismatchedStringThe expected checksum of the CiSecureFileRegistry in case of mismatch.
verificationFailureStringError message during verification of the CiSecureFileRegistry.
verificationRetryAtTimeTimestamp after which the CiSecureFileRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the CiSecureFileRegistry.
verificationStartedAtTimeTimestamp when the verification of CiSecureFileRegistry started.
verificationStateVerificationStateEnumVerification state of the CiSecureFileRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the CiSecureFileRegistry.

CiStage

Fields

NameTypeDescription
detailedStatusDetailedStatusDetailed status of the stage.
groupsCiGroupConnectionGroup of jobs for the stage. (see Connections)
idID!ID of the stage.
jobsCiJobConnectionJobs for the stage. (see Connections)
nameStringName of the stage.
statusStringStatus of the pipeline stage.

CiSubscriptionsProject

Fields

NameTypeDescription
authorUserCoreAuthor of the subscription.
downstreamProjectProjectDownstream project of the subscription.
idCiSubscriptionsProjectIDGlobal ID of the subscription.
upstreamProjectProjectUpstream project of the subscription.

CiSubscriptionsProjectDetails

Fields

NameTypeDescription
idID!ID of the project.
nameID!Full path of the project.
namespaceCiSubscriptionsProjectNamespaceDetails!Namespace of the project.
webUrlStringWeb URL of the project.

CiSubscriptionsProjectNamespaceDetails

Fields

NameTypeDescription
idID!ID of the project.
nameID!Full path of the project.

CiTemplate

GitLab CI/CD configuration template.

Fields

NameTypeDescription
contentString!Contents of the CI template.
nameString!Name of the CI template.

CloudConnectorProbeResult

Fields

NameTypeDescription
detailsJSONAdditional details about the probe result.
errors[String!]Full list of errors about the probe result.
messageStringAdditional message or details about the probe result.
nameStringName of the probe.
successBooleanIndicates if the probe was successful.

CloudConnectorStatus

Fields

NameTypeDescription
probeResults[CloudConnectorProbeResult!]Results of individual probes run during verification.
successBooleanIndicates if the setup verification was successful.

ClusterAgent

Fields

NameTypeDescription
activityEventsClusterAgentActivityEventConnectionRecent activity for the cluster agent. (see Connections)
connectionsConnectedAgentConnectionActive connections for the cluster agent. (see Connections)
createdAtTimeTimestamp the cluster agent was created.
createdByUserUserCoreUser object, containing information about the person who created the agent.
idID!ID of the cluster agent.
isReceptiveBooleanWhether the cluster agent is receptive or not.
nameStringName of the cluster agent.
projectProjectProject the cluster agent is associated with.
remoteDevelopmentAgentConfig warning-solidRemoteDevelopmentAgentConfigIntroduced in GitLab 17.4. Status: Experiment. Remote development agent config for the cluster agent.
tokensClusterAgentTokenConnectionTokens associated with the cluster agent. (see Connections)
updatedAtTimeTimestamp the cluster agent was updated.
urlConfigurationsClusterAgentUrlConfigurationConnectionURL configurations for the cluster agent in case it is a receptive agent. (see Connections)
userAccessAuthorizationsClusterAgentAuthorizationUserAccessUser access config for the cluster agent.
vulnerabilityImagesVulnerabilityContainerImageConnectionContainer images reported on the agent vulnerabilities. (see Connections)
webPathStringWeb path of the cluster agent.
workspacesAgentConfig warning-solidWorkspacesAgentConfigIntroduced in GitLab 17.4. Status: Experiment. Workspaces agent config for the cluster agent.

Fields with arguments

ClusterAgent.workspaces

Workspaces associated with the agent.

Returns WorkspaceConnection.

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

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

ClusterAgentActivityEvent

Fields

NameTypeDescription
agentTokenClusterAgentTokenAgent token associated with the event.
kindStringType of event.
levelStringSeverity of the event.
recordedAtTimeTimestamp the event was recorded.
userUserCoreUser associated with the event.

ClusterAgentAuthorizationCiAccess

Fields

NameTypeDescription
agentClusterAgentAuthorized cluster agent.
configJSONConfiguration for the authorized project.

ClusterAgentAuthorizationUserAccess

Fields

NameTypeDescription
agentClusterAgentAuthorized cluster agent.
configJSONConfiguration for the authorized project.

ClusterAgentToken

Fields

NameTypeDescription
clusterAgentClusterAgentCluster agent the token is associated with.
createdAtTimeTimestamp the token was created.
createdByUserUserCoreUser who created the token.
descriptionStringDescription of the token.
idClustersAgentTokenID!Global ID of the token.
lastUsedAtTimeTimestamp the token was last used.
nameStringName given to the token.
statusAgentTokenStatusCurrent status of the token.

ClusterAgentUrlConfiguration

Fields

NameTypeDescription
caCertStringCA certificate of the URL configuration. It is used to verify the agent endpoint.
clientCertStringClient certificate if JWT authentication is used.
clusterAgentClusterAgentCluster agent of the URL configuration.
idClustersAgentsUrlConfigurationID!Global ID of the URL configuration.
publicKeyStringPublic key if JWT authentication is used.
tlsHostStringTLS host of the URL configuration. It is used to verify the server name in the agent endpoint certificate.
urlStringURL of the URL configuration.

CodeCoverageActivity

Represents the code coverage activity for a group.

Fields

NameTypeDescription
averageCoverageFloatAverage percentage of the different code coverage results available for the group.
coverageCountIntNumber of different code coverage results available for the group.
dateDate!Date when the code coverage was created.
projectCountIntNumber of projects with code coverage results for the group.

CodeCoverageSummary

Represents the code coverage summary for a project.

Fields

NameTypeDescription
averageCoverageFloatAverage percentage of the different code coverage results available for the project.
coverageCountIntNumber of different code coverage results available.
lastUpdatedOnDateLatest date when the code coverage was created for the project.

CodeQualityDegradation

Represents a code quality degradation on the pipeline.

Fields

NameTypeDescription
descriptionString!Description of the code quality degradation.
engineNameString!Code Quality plugin that reported the finding.
fingerprintString!Unique fingerprint to identify the code quality degradation. For example, an MD5 hash.
lineInt!Line on which the code quality degradation occurred.
pathString!Relative path to the file containing the code quality degradation.
severityCodeQualityDegradationSeverity!Status of the degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO, UNKNOWN).
webUrlStringURL to the file along with line number.

CodeQualityReportSummary

Code Quality report for a pipeline.

Fields

NameTypeDescription
blockerIntTotal number of blocker status.
countIntTotal number of Code Quality reports.
criticalIntTotal number of critical status.
infoIntTotal number of info status.
majorIntTotal number of major status.
minorIntTotal number of minor status.
unknownIntTotal number of unknown status.

CodeSuggestionEvent

Fields

NameTypeDescription
eventAiUsageCodeSuggestionEvent!Type of the event.
idID!ID of the code suggestion event.
languageStringProgramming language in the context of the suggestion.
suggestionSizeStringSize of the code suggestion.
timestampTime!When the event happened.
uniqueTrackingIdStringUnique tracking number.
userUserCore!User associated with the event.

CodequalityReportsComparer

Represents reports comparison for code quality.

Fields

NameTypeDescription
reportCodequalityReportsComparerReportCompared codequality report.
statusCodequalityReportsComparerReportGenerationStatusCompared codequality report generation status.

CodequalityReportsComparerReport

Represents compared code quality report.

Fields

NameTypeDescription
existingErrors[CodequalityReportsComparerReportDegradation!]All code quality degradations.
newErrors[CodequalityReportsComparerReportDegradation!]!New code quality degradations.
resolvedErrors[CodequalityReportsComparerReportDegradation!]Resolved code quality degradations.
statusCodequalityReportsComparerStatus!Status of report.
summaryCodequalityReportsComparerReportSummary!Codequality report summary.

CodequalityReportsComparerReportDegradation

Represents a degradation on the compared codequality report.

Fields

NameTypeDescription
descriptionString!Description of the code quality degradation.
engineNameStringCode quality plugin that reported the degradation.
filePathString!Relative path to the file containing the code quality degradation.
fingerprintString!Unique fingerprint to identify the code quality degradation. For example, an MD5 hash.
lineInt!Line on which the code quality degradation occurred.
severityCodeQualityDegradationSeverity!Severity of the code quality degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO, UNKNOWN).
webUrlStringURL to the file along with line number.

CodequalityReportsComparerReportSummary

Represents a summary of the compared codequality report.

Fields

NameTypeDescription
erroredIntCount of code quality errors.
resolvedIntCount of resolved code quality degradations.
totalIntTotal count of code quality degradations.

Commit

Fields

NameTypeDescription
authorUserCoreAuthor of the commit.
authorEmailStringCommit author’s email.
authorGravatarStringCommit authors gravatar.
authorNameStringCommit authors name.
authoredDateTimeTimestamp of when the commit was authored.
committedDateTimeTimestamp of when the commit was committed.
committerEmailStringEmail of the committer.
committerNameStringName of the committer.
descriptionStringDescription of the commit message.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
diffs[Diff!]Diffs contained within the commit. This field can only be resolved for 10 diffs in any single request.
fullTitleStringFull title of the commit message.
fullTitleHtmlStringGitLab Flavored Markdown rendering of full_title.
idID!ID (global ID) of the commit.
messageStringRaw commit message.
nameStringName or title of this object.
shaString!SHA1 ID of the commit.
shortIdString!Short SHA1 ID of the commit.
signatureCommitSignatureSignature of the commit.
signatureHtmlStringRendered HTML of the commit signature.
titleStringTitle of the commit message.
titleHtmlStringGitLab Flavored Markdown rendering of title.
webPathString!Web path of the commit.
webUrlString!Web URL of the commit.

Fields with arguments

Commit.pipelines

Pipelines of the commit ordered latest first.

Returns PipelineConnection.

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

Arguments
NameTypeDescription
refStringFilter pipelines by the ref they are run for.
scopePipelineScopeEnumFilter pipelines by scope.
shaStringFilter pipelines by the sha of the commit they are run for.
sourceStringFilter pipelines by their source.
statusPipelineStatusEnumFilter pipelines by their status.
updatedAfterTimePipelines updated after the date.
updatedBeforeTimePipelines updated before the date.
usernameStringFilter pipelines by the user that triggered the pipeline.

CommitData

Fields

NameTypeDescription
ageMapClassString!CSS class for age of commit.
authorAvatarString!Link to author avatar.
commitAuthorLinkString!Link to the commit author.
commitLinkString!Link to the commit.
projectBlameLinkStringLink to blame prior to the change.
timeAgoTooltipString!Time of commit.

CommitParentNames

Fields

NameTypeDescription
names[String!]Names of the commit parent (branch or tag).

CommitReferences

Fields with arguments

CommitReferences.containingBranches

Get branch names containing a given commit.

Returns CommitParentNames.

Arguments
NameTypeDescription
excludeTippedBoolean!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.
limitInt!Number of ref names to return.
CommitReferences.containingTags

Get tag names containing a given commit.

Returns CommitParentNames.

Arguments
NameTypeDescription
excludeTippedBoolean!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.
limitInt!Number of ref names to return.
CommitReferences.tippingBranches

Get branch names tipping at a given commit.

Returns CommitParentNames.

Arguments
NameTypeDescription
limitInt!Number of ref names to return.
CommitReferences.tippingTags

Get tag names tipping at a given commit.

Returns CommitParentNames.

Arguments
NameTypeDescription
limitInt!Number of ref names to return.

ComparedSecurityReport

Represents compared security report.

Fields

NameTypeDescription
added warning-solid[ComparedSecurityReportFinding!]Introduced in GitLab 16.1. Status: Experiment. New vulnerability findings.
baseReportCreatedAtTimeTime of the base report creation.
baseReportOutOfDateBooleanIndicates whether the base report out of date.
fixed warning-solid[ComparedSecurityReportFinding!]Introduced in GitLab 16.1. Status: Experiment. Fixed vulnerability findings.
headReportCreatedAtTimeTime of the base report creation.

ComparedSecurityReportFinding

Represents finding.

Fields

NameTypeDescription
descriptionStringDescription of the vulnerability finding.
details warning-solid[VulnerabilityDetail!]!Introduced in GitLab 17.6. Status: Experiment. Details of the vulnerability finding.
foundByPipelineIidStringIID of the pipeline.
identifiers warning-solid[VulnerabilityIdentifier!]Introduced in GitLab 16.3. Status: Experiment. Identifiers of the vulnerability finding.
location warning-solidVulnerabilityLocationIntroduced in GitLab 16.3. Status: Experiment. Location of the vulnerability finding.
scannerComparedSecurityReportScannerCompared report vulnerability scanner.
severityVulnerabilitySeveritySeverity of the vulnerability finding.
stateVulnerabilityStateFinding status.
titleStringTitle of the vulnerability finding.
uuidStringUUIDv5 digest based on the vulnerability’s report type, primary identifier, location, fingerprint, project identifier.

ComparedSecurityReportScanner

Represents a compared report vulnerability scanner.

Fields

NameTypeDescription
externalIdStringExternal ID of the vulnerability scanner.
nameStringName of the vulnerability scanner.
vendorStringVendor of the vulnerability scanner.

ComplianceFramework

Represents a ComplianceFramework associated with a Project.

Fields

NameTypeDescription
colorString!Hexadecimal representation of compliance framework’s label color.
complianceRequirementsComplianceRequirementConnectionCompliance requirements of the compliance framework. (see Connections)
defaultBooleanDefault compliance framework for the group.
descriptionString!Description of the compliance framework.
idID!Compliance framework ID.
nameString!Name of the compliance framework.
pipelineConfigurationFullPath warning-solidStringDeprecated in GitLab 17.4. Use pipeline execution policies instead.
pipelineExecutionPoliciesPipelineExecutionPolicyConnectionPipeline Execution Policies of the compliance framework. (see Connections)
projectsProjectConnectionProjects associated with the compliance framework. (see Connections)
scanExecutionPoliciesScanExecutionPolicyConnectionScan Execution Policies of the compliance framework. (see Connections)
scanResultPoliciesScanResultPolicyConnectionScan Result Policies of the compliance framework. (see Connections)
vulnerabilityManagementPoliciesVulnerabilityManagementPolicyConnectionVulnerability Management Policies of the compliance framework. (see Connections)

ComplianceRequirement

Represents a ComplianceRequirement associated with a ComplianceFramework.

Fields

NameTypeDescription
complianceRequirementsControlsComplianceRequirementsControlConnectionCompliance controls of the compliance requirement. (see Connections)
descriptionString!Description of the compliance requirement.
idID!Compliance requirement ID.
nameString!Name of the compliance requirement.

ComplianceRequirementControl

Lists down all the possible types of requirement controls.

Fields

NameTypeDescription
controlExpressions[ControlExpression!]!List of requirement controls.

ComplianceRequirementsControl

Represents a ComplianceRequirementsControl associated with a ComplianceRequirement.

Fields

NameTypeDescription
controlTypeString!Type of the compliance control.
expressionStringExpression of the compliance control.
idID!Compliance requirements control ID.
nameString!Name of the compliance control.

ComplianceStandardsAdherence

Compliance standards adherence for a project.

Fields

NameTypeDescription
checkNameComplianceStandardsAdherenceCheckName!Name of the check for the compliance standard.
idID!Compliance standards adherence ID.
projectProject!Project adhering to the compliance standard.
standardComplianceStandardsAdherenceStandard!Name of the compliance standard.
statusComplianceStandardsAdherenceStatus!Status of the compliance standards adherence.
updatedAtTime!Timestamp when the adherence was updated.

ComplianceViolation

Compliance violation associated with a merged merge request.

Fields

NameTypeDescription
idID!Compliance violation ID.
mergeRequestMergeRequest!Merge request the compliance violation occurred in.
reasonComplianceViolationReason!Reason the compliance violation occurred.
severityLevelComplianceViolationSeverity!Severity of the compliance violation.
violatingUserUserCore!User suspected of causing the compliance violation.

Component

A software dependency used by a project.

Fields

NameTypeDescription
idSbomComponentID!ID of the dependency.
nameString!Name of the dependency.

ComposerMetadata

Composer metadata.

Fields

NameTypeDescription
composerJsonPackageComposerJsonType!Data of the Composer JSON file.
targetShaString!Target SHA of the package.

ConanFileMetadata

Conan file metadata.

Fields

NameTypeDescription
conanFileTypeConanMetadatumFileTypeEnum!Type of the Conan file.
conanPackageReferenceStringReference of the Conan package.
createdAtTime!Date of creation.
idPackagesConanFileMetadatumID!ID of the metadatum.
packageRevisionStringRevision of the package.
recipeRevisionString!Revision of the Conan recipe.
updatedAtTime!Date of most recent update.

ConanMetadata

Conan metadata.

Fields

NameTypeDescription
createdAtTime!Date of creation.
idPackagesConanMetadatumID!ID of the metadatum.
packageChannelString!Channel of the Conan package.
packageUsernameString!Username of the Conan package.
recipeString!Recipe of the Conan package.
recipePathString!Recipe path of the Conan package.
updatedAtTime!Date of most recent update.

ConnectedAgent

Connection details for an Agent.

Fields

NameTypeDescription
connectedAtTimeWhen the connection was established.
connectionIdBigIntID of the connection.
metadataAgentMetadataInformation about the Agent.
warnings[AgentWarning!]Agent warnings list.

ContactStateCounts

Represents the total number of contacts for the represented states.

Fields

NameTypeDescription
activeIntNumber of contacts with state ACTIVE.
allIntNumber of contacts with state ALL.
inactiveIntNumber of contacts with state INACTIVE.

ContainerExpirationPolicy

A tag expiration policy designed to keep only the images that matter most.

Fields

NameTypeDescription
cadenceContainerExpirationPolicyCadenceEnum!This container expiration policy schedule.
createdAtTime!Timestamp of when the container expiration policy was created.
enabledBoolean!Indicates whether the container expiration policy is enabled.
keepNContainerExpirationPolicyKeepEnumNumber of tags to retain.
nameRegexUntrustedRegexpTags with names matching the regex pattern will expire.
nameRegexKeepUntrustedRegexpTags with names matching the regex pattern will be preserved.
nextRunAtTimeNext time that the container expiration policy will get executed.
olderThanContainerExpirationPolicyOlderThanEnumTags older than the given age will expire.
updatedAtTime!Timestamp of when the container expiration policy was updated.

ContainerProtectionAccessLevel

Represents the most restrictive permissions for a container image tag.

Fields

NameTypeDescription
minimumAccessLevelForDelete warning-solidContainerProtectionTagRuleAccessLevelIntroduced in GitLab 17.8. Status: Experiment. 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 minimum access level is enforced. Users with the Developer role or higher can delete tags by default.
minimumAccessLevelForPush warning-solidContainerProtectionTagRuleAccessLevelIntroduced in GitLab 17.8. Status: Experiment. 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 minimum access level is enforced. Users with the Developer role or higher can push tags by default.

ContainerProtectionRepositoryRule

A container repository protection rule designed to prevent users with a certain access level or lower from altering the container registry.

Fields

NameTypeDescription
idContainerRegistryProtectionRuleID!ID of the container repository protection rule.
minimumAccessLevelForDeleteContainerProtectionRepositoryRuleAccessLevelMinimum 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.
minimumAccessLevelForPushContainerProtectionRepositoryRuleAccessLevelMinimum 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.
repositoryPathPatternString!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.

ContainerProtectionTagRule

A container repository tag protection rule designed to prevent users with a certain access level or lower from altering the container registry.

Fields

NameTypeDescription
id warning-solidContainerRegistryProtectionTagRuleID!Introduced in GitLab 17.8. Status: Experiment. ID of the container repository tag protection rule.
minimumAccessLevelForDelete warning-solidContainerProtectionTagRuleAccessLevelIntroduced in GitLab 17.8. Status: Experiment. 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 minimum access level is enforced. Users with the Developer role or higher can delete tags by default.
minimumAccessLevelForPush warning-solidContainerProtectionTagRuleAccessLevelIntroduced in GitLab 17.8. Status: Experiment. 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 minimum access level is enforced. Users with the Developer role or higher can push tags by default.
tagNamePattern warning-solidString!Introduced in GitLab 17.8. Status: Experiment. The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.

ContainerRepository

A container repository.

Fields

NameTypeDescription
createdAtTime!Timestamp when the container repository was created.
expirationPolicyCleanupStatusContainerRepositoryCleanupStatusTags cleanup status for the container repository.
expirationPolicyStartedAtTimeTimestamp when the cleanup done by the expiration policy was started on the container repository.
idID!ID of the container repository.
lastCleanupDeletedTagsCountIntNumber of deleted tags from the last cleanup.
locationString!URL of the container repository.
migrationState warning-solidString!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.
nameString!Name of the container repository.
pathString!Path of the container repository.
projectProject!Project of the container registry.
protectionRuleExistsBoolean!Whether any matching container protection rule exists for the container repository.
statusContainerRepositoryStatusStatus of the container repository.
tagsCountInt!Number of tags associated with the image.
updatedAtTime!Timestamp when the container repository was updated.
userPermissionsContainerRepositoryPermissions!Permissions for the current user on the resource.

ContainerRepositoryDetails

Details of a container repository.

Fields

NameTypeDescription
createdAtTime!Timestamp when the container repository was created.
expirationPolicyCleanupStatusContainerRepositoryCleanupStatusTags cleanup status for the container repository.
expirationPolicyStartedAtTimeTimestamp when the cleanup done by the expiration policy was started on the container repository.
idID!ID of the container repository.
lastCleanupDeletedTagsCountIntNumber of deleted tags from the last cleanup.
lastPublishedAtTimeTimestamp when a repository tag was last created or updated. Only present for repositories that had tags created or updated after GitLab 16.11.
locationString!URL of the container repository.
migrationState warning-solidString!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.
nameString!Name of the container repository.
pathString!Path of the container repository.
projectProject!Project of the container registry.
protectionRuleExistsBoolean!Whether any matching container protection rule exists for the container repository.
sizeFloatDeduplicated size of the image repository in bytes. This is only available on GitLab.com for repositories created after 2021-11-04.
statusContainerRepositoryStatusStatus of the container repository.
tagsCountInt!Number of tags associated with the image.
updatedAtTime!Timestamp when the container repository was updated.
userPermissionsContainerRepositoryPermissions!Permissions for the current user on the resource.

Fields with arguments

ContainerRepositoryDetails.manifest

An image manifest from the container repository.

Returns String.

Arguments
NameTypeDescription
referenceString!Tag name or digest of the manifest.
ContainerRepositoryDetails.tags

Tags of the container repository.

Returns ContainerRepositoryTagConnection.

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

Arguments
NameTypeDescription
nameStringSearch by tag name.
referrerTypeStringComma-separated list of artifact types used to filter referrers. Applies only when referrers is set to true.
referrersBooleanInclude tag referrers.
sortContainerRepositoryTagSortSort tags by these criteria.

ContainerRepositoryPermissions

Fields

NameTypeDescription
destroyContainerRepositoryBoolean!If true, the user can perform destroy_container_image on this resource.

ContainerRepositoryReferrer

A referrer for a container repository tag.

Fields

NameTypeDescription
artifactTypeStringArtifact type of the referrer.
digestStringDigest of the referrer.
userPermissionsContainerRepositoryTagPermissions!Permissions for the current user on the resource.

ContainerRepositoryRegistry

Represents the Geo replication and verification state of an Container Repository.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the ContainerRepositoryRegistry do not match on the primary and secondary.
containerRepositoryIdID!ID of the ContainerRepository.
createdAtTimeTimestamp when the ContainerRepositoryRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the ContainerRepositoryRegistry.
lastSyncFailureStringError message during sync of the ContainerRepositoryRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the ContainerRepositoryRegistry.
missingOnPrimaryBooleanIndicate if the ContainerRepositoryRegistry is missing on primary.
modelRecordIdIntID of the ContainerRepositoryRegistry’s model record.
retryAtTimeTimestamp after which the ContainerRepositoryRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the ContainerRepositoryRegistry.
stateRegistryStateSync state of the ContainerRepositoryRegistry.
verificationChecksumStringThe local checksum of the ContainerRepositoryRegistry.
verificationChecksumMismatchedStringThe expected checksum of the ContainerRepositoryRegistry in case of mismatch.
verificationFailureStringError message during verification of the ContainerRepositoryRegistry.
verificationRetryAtTimeTimestamp after which the ContainerRepositoryRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the ContainerRepositoryRegistry.
verificationStartedAtTimeTimestamp when the verification of ContainerRepositoryRegistry started.
verificationStateVerificationStateEnumVerification state of the ContainerRepositoryRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the ContainerRepositoryRegistry.

ContainerRepositoryTag

A tag from a container repository.

Fields

NameTypeDescription
createdAtTimeTimestamp when the tag was created.
digestStringDigest of the tag.
locationString!URL of the tag.
mediaTypeStringMedia type of the tag.
nameString!Name of the tag.
pathString!Path of the tag.
protection warning-solidContainerProtectionAccessLevelIntroduced in GitLab 17.9. Status: Experiment. Minimum GitLab access level required to push and delete container image tags. If multiple protection rules match an image tag, the highest access levels are applied.
publishedAtTimeTimestamp when the tag was published.
referrers[ContainerRepositoryReferrer!]Referrers for the tag.
revisionStringRevision of the tag.
shortRevisionStringShort revision of the tag.
totalSizeBigIntSize of the tag.
userPermissionsContainerRepositoryTagPermissions!Permissions for the current user on the resource.

ContainerRepositoryTagPermissions

Fields

NameTypeDescription
destroyContainerRepositoryTagBoolean!If true, the user can perform destroy_container_image on this resource.

ContainerTagsExpirationPolicy

A tag expiration policy using regex patterns to control which images to keep or expire.

Fields

NameTypeDescription
cadenceContainerExpirationPolicyCadenceEnumSchedule of the container expiration policy.
createdAtTimeTimestamp of when the container expiration policy was created.
enabledBoolean!Indicates whether the container expiration policy is enabled.
keepNContainerExpirationPolicyKeepEnumNumber of tags to retain.
nameRegexUntrustedRegexpTags with names matching the regex pattern will expire.
nameRegexKeepUntrustedRegexpTags with names matching the regex pattern will be preserved.
nextRunAtTimeNext time that the container expiration policy will get executed.
olderThanContainerExpirationPolicyOlderThanEnumTags older than the given age will expire.
updatedAtTimeTimestamp of when the container expiration policy was updated.

ContributionAnalyticsContribution

Represents the contributions of a user.

Fields

NameTypeDescription
issuesClosedIntNumber of issues closed by the user.
issuesCreatedIntNumber of issues created by the user.
mergeRequestsApprovedIntNumber of merge requests approved by the user.
mergeRequestsClosedIntNumber of merge requests closed by the user.
mergeRequestsCreatedIntNumber of merge requests created by the user.
mergeRequestsMergedIntNumber of merge requests merged by the user.
repoPushedIntNumber of repository pushes the user made.
totalEventsIntTotal number of events contributed by the user.
userUserCoreContributor User object.

ControlExpression

Represents a control expression.

Fields

NameTypeDescription
expressionExpressionValue!Expression details for the control.
idID!ID for the control.
nameString!Name of the control.

CoverageFuzzingCorpus

Corpus for a coverage fuzzing job.

Fields

NameTypeDescription
idAppSecFuzzingCoverageCorpusID!ID of the corpus.
packagePackageDetailsType!Package of the corpus.

CurrentLicense

Represents the current license.

Fields

NameTypeDescription
activatedAtDateDate when the license was activated.
billableUsersCountIntNumber of billable users on the system.
blockChangesAtDateDate, including grace period, when licensed features will be blocked.
companyStringCompany of the licensee.
createdAtDateDate when the license was added.
emailStringEmail of the licensee.
expiresAtDateDate when the license expires.
idID!ID of the license extracted from the license data.
lastSyncTimeDate when the license was last synced.
maximumUserCountIntHighest number of billable users on the system during the term of the current license.
nameStringName of the licensee.
planString!Name of the subscription plan.
startsAtDateDate when the license started.
trialBooleanIndicates if the license is a trial.
typeString!Type of the license.
usersInLicenseCountIntNumber of paid users in the license.
usersOverLicenseCountIntNumber of users over the paid users in the license.

CurrentUser

The currently authenticated GitLab user.

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
codeSuggestionsContexts warning-solid[String!]!Introduced in GitLab 17.9. Status: Experiment. List of additional contexts enabled for Code Suggestions.
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
duoChatAvailable warning-solidBoolean!Introduced in GitLab 16.8. Status: Experiment. User access to AI chat feature.
duoChatAvailableFeatures warning-solid[String!]!Introduced in GitLab 17.6. Status: Experiment. List of available features for AI chat.
duoCodeSuggestionsAvailable warning-solidBoolean!Introduced in GitLab 16.8. Status: Experiment. User access to code suggestions feature.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
recentlyViewedIssues warning-solid[Issue!]Introduced in GitLab 17.9. Status: Experiment. Most-recently viewed issues for the current user.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Fields with arguments

CurrentUser.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
CurrentUser.assigneeOrReviewerMergeRequests

Merge requests the current user is an assignee or a reviewer of.Ignored if merge_request_dashboard feature flag is disabled.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
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 warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerReviewStates[MergeRequestReviewState!]Reviewer states for the merge requests the current user is a reviewer of.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
CurrentUser.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
CurrentUser.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
CurrentUser.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
CurrentUser.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
CurrentUser.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
CurrentUser.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
CurrentUser.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
CurrentUser.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
CurrentUser.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
CurrentUser.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
CurrentUser.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

Arguments
NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.
CurrentUser.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.

CustomEmoji

A custom emoji uploaded by user.

Fields

NameTypeDescription
createdAtTime!Timestamp of when the custom emoji was created.
externalBoolean!Whether the emoji is an external link.
idCustomEmojiID!ID of the emoji.
nameString!Name of the emoji.
urlString!Link to file of the emoji.
userPermissionsCustomEmojiPermissions!Permissions for the current user on the resource.

CustomEmojiPermissions

Fields

NameTypeDescription
createCustomEmojiBoolean!If true, the user can perform create_custom_emoji on this resource.
deleteCustomEmojiBoolean!If true, the user can perform delete_custom_emoji on this resource.
readCustomEmojiBoolean!If true, the user can perform read_custom_emoji on this resource.

CustomField

Represents a custom field.

Fields

NameTypeDescription
activeBoolean!Whether the custom field is active.
createdAtTime!Timestamp when the custom field was created.
createdByUserCoreUser that created the custom field.
fieldTypeCustomFieldType!Type of custom field.
idIssuablesCustomFieldID!Global ID of the custom field.
nameString!Name of the custom field.
selectOptions[CustomFieldSelectOption!]Available options for a select field.
updatedAtTime!Timestamp when the custom field was last updated.
updatedByUserCoreUser that last updated the custom field.
workItemTypes[WorkItemType!]Work item types that the custom field is available on.

CustomFieldSelectOption

Represents a custom field select option.

Fields

NameTypeDescription
idIssuablesCustomFieldSelectOptionID!Global ID of the custom field select option.
valueString!Value of the custom field select option.

CustomerRelationsContact

Fields

NameTypeDescription
activeBoolean!State of the contact.
createdAtTime!Timestamp the contact was created.
descriptionStringDescription of or notes for the contact.
emailStringEmail address of the contact.
firstNameString!First name of the contact.
idID!Internal ID of the contact.
lastNameString!Last name of the contact.
organizationCustomerRelationsOrganizationOrganization of the contact.
phoneStringPhone number of the contact.
updatedAtTime!Timestamp the contact was last updated.

CustomerRelationsOrganization

Fields

NameTypeDescription
activeBoolean!State of the organization.
createdAtTime!Timestamp the organization was created.
defaultRateFloatStandard billing rate for the organization.
descriptionStringDescription of or notes for the organization.
idID!Internal ID of the organization.
nameString!Name of the organization.
updatedAtTime!Timestamp the organization was last updated.

CustomizableAdminPermission

Fields

NameTypeDescription
descriptionStringDescription of the permission.
nameString!Localized name of the permission.
requirements[MemberRoleAdminPermission!]Requirements of the permission.
valueMemberRoleAdminPermission!Value of the permission.

CustomizableDashboard

Represents a product analytics dashboard.

Fields

NameTypeDescription
categoryCustomizableDashboardCategory!Category of dashboard.
configurationProjectProjectProject which contains the dashboard definition.
descriptionStringDescription of the dashboard.
errors[String!]Errors on yaml definition.
filtersJSONDashboard global filters.
panelsCustomizableDashboardPanelConnectionPanels shown on the dashboard. (see Connections)
slugString!Slug of the dashboard.
status warning-solidStringIntroduced in GitLab 17.0. Status: Experiment. Status of the dashboard.
titleStringTitle of the dashboard.
userDefinedBoolean!Indicates whether the dashboard is user-defined or provided by GitLab.

CustomizableDashboardPanel

Represents a product analytics dashboard panel.

Fields

NameTypeDescription
gridAttributesJSONDescription of the position and size of the panel.
queryOverridesJSONOverrides for the visualization query object.
titleStringTitle of the panel.
visualizationCustomizableDashboardVisualizationVisualization of the panel.

CustomizableDashboardVisualization

Represents a product analytics dashboard visualization.

Fields

NameTypeDescription
dataJSON!Data of the visualization.
errors[String!]Validation errors in the visualization.
optionsJSON!Options of the visualization.
slugString!Slug of the visualization.
typeString!Type of the visualization.

CustomizableStandardPermission

Fields

NameTypeDescription
availableFor[String!]!Objects the permission is available for.
descriptionStringDescription 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.
nameString!Localized name of the permission.
requirements[MemberRoleStandardPermission!]Requirements of the permission.
valueMemberRoleStandardPermission!Value of the permission.

CveEnrichmentType

Represents a CVE’s Enrichment (EPSS score).

Fields

NameTypeDescription
cveString!CVE identifier of relevant vulnerability.
epssScoreFloat!EPSS score for the CVE.
isKnownExploitBoolean!Whether the CVE appears in the CISA KEV catalog.

CvssType

Represents a vulnerability’s CVSS score.

Fields

NameTypeDescription
baseScoreFloat!Base score of the CVSS.
overallScoreFloat!Overall score of the CVSS.
severityCvssSeverity!Severity calculated from the overall score.
vectorString!CVSS vector string.
vendorString!Vendor who assigned the CVSS score.
versionFloat!Version of the CVSS.

DastPreScanVerification

Represents a DAST Pre Scan Verification.

Fields

NameTypeDescription
preScanVerificationSteps[DastPreScanVerificationStep!]Pre Scan Verifications Steps.
statusDastPreScanVerificationStatusStatus of the pre scan verification.
validBoolean!Whether or not the configuration has changed after the last pre scan run.

DastPreScanVerificationStep

Represents a DAST Pre Scan Verification Step.

Fields

NameTypeDescription
checkTypeDastPreScanVerificationCheckTypeType of the pre scan verification check.
errors[String!]Errors that occurred in the pre scan verification step.
name warning-solidStringDeprecated in GitLab 15.10. This was renamed. Use: DastPreScanVerificationStep.checkType.
successBoolean!Whether or not the pre scan verification step has errors.

DastProfile

Represents a DAST Profile.

Fields

NameTypeDescription
branchDastProfileBranchAssociated branch.
dastPreScanVerificationDastPreScanVerificationDAST Pre Scan Verification associated with the site profile. Will always return null if dast_on_demand_scans_scheduler feature flag is disabled.
dastProfileScheduleDastProfileScheduleAssociated profile schedule.
dastScannerProfileDastScannerProfileAssociated scanner profile.
dastSiteProfileDastSiteProfileAssociated site profile.
descriptionStringDescription of the scan.
editPathStringRelative web path to the edit page of a profile.
idDastProfileID!ID of the profile.
nameStringName of the profile.
tagList[String!]Runner tags associated with the profile.

DastProfileBranch

Represents a DAST Profile Branch.

Fields

NameTypeDescription
existsBooleanIndicates whether or not the branch exists.
nameStringName of the branch.

DastProfileCadence

Represents DAST Profile Cadence.

Fields

NameTypeDescription
durationIntDuration of the DAST profile cadence.
unitDastProfileCadenceUnitUnit for the duration of DAST profile cadence.

DastProfileSchedule

Represents a DAST profile schedule.

Fields

NameTypeDescription
activeBooleanStatus of the DAST profile schedule.
cadenceDastProfileCadenceCadence of the DAST profile schedule.
idDastProfileScheduleID!ID of the DAST profile schedule.
nextRunAtTimeNext run time of the DAST profile schedule in the given timezone.
ownerValidBooleanStatus of the current owner of the DAST profile schedule.
startsAtTimeStart time of the DAST profile schedule in the given timezone.
timezoneStringTime zone of the start time of the DAST profile schedule.

DastScannerProfile

Represents a DAST scanner profile.

Fields

NameTypeDescription
editPathStringRelative web path to the edit page of a scanner profile.
idDastScannerProfileID!ID of the DAST scanner profile.
profileNameStringName of the DAST scanner profile.
referencedInSecurityPolicies[String!]List of security policy names that are referencing given project.
scanTypeDastScanTypeEnumIndicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessagesBoolean!Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeoutIntMaximum number of minutes allowed for the spider to traverse the site.
tagList warning-solid[String!]Deprecated in GitLab 15.8. Moved to DastProfile.
targetTimeoutIntMaximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpiderBoolean!Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

DastSiteProfile

Represents a DAST Site Profile.

Fields

NameTypeDescription
authDastSiteProfileAuthTarget authentication details.
editPathStringRelative web path to the edit page of a site profile.
excludedUrls[String!]URLs to skip during an authenticated scan.
idDastSiteProfileID!ID of the site profile.
normalizedTargetUrlStringNormalized URL of the target to be scanned.
optionalVariables[JSON!]Optional variables that can be configured for DAST scans.
profileNameStringName of the site profile.
referencedInSecurityPolicies[String!]List of security policy names that are referencing given project.
requestHeadersStringComma-separated list of request header names and values to be added to every request made by DAST.
scanFilePathStringScan File Path used as input for the scanner.
scanMethodDastScanMethodTypeScan method used by the scanner.
targetTypeDastTargetTypeEnumType of target to be scanned.
targetUrlStringURL of the target to be scanned.
userPermissionsDastSiteProfilePermissions!Permissions for the current user on the resource.
validationStartedAtTimeSite profile validation start time.
validationStatusDastSiteProfileValidationStatusEnumCurrent validation status of the site profile.

DastSiteProfileAuth

DastSiteProfile authentication.

Fields

NameTypeDescription
enabledBooleanIndicates whether authentication is enabled.
passwordStringRedacted password to authenticate with on the target website.
passwordFieldStringName of password field at the sign-in HTML form.
submitFieldStringName or ID of sign-in submit button at the sign-in HTML form.
urlStringThe URL of the page containing the sign-in HTML form on the target website.
usernameStringUsername to authenticate with on the target website.
usernameFieldStringName of username field at the sign-in HTML form.

DastSiteProfilePermissions

Check permissions for the current user on site profile.

Fields

NameTypeDescription
createOnDemandDastScanBoolean!If true, the user can perform create_on_demand_dast_scan on this resource.

DastSiteValidation

Represents a DAST Site Validation.

Fields

NameTypeDescription
idDastSiteValidationID!Global ID of the site validation.
normalizedTargetUrlStringNormalized URL of the target to be validated.
statusDastSiteProfileValidationStatusEnum!Status of the site validation.
validationStartedAtTimeTimestamp of when the validation started.

DeleteJobsResponse

The response from the AdminSidekiqQueuesDeleteJobs mutation.

Fields

NameTypeDescription
completedBooleanWhether or not the entire queue was processed in time; if not, retrying the same request is safe.
deletedJobsIntNumber of matching jobs deleted.
queueSizeIntQueue size after processing.

DeletedNote

Fields

NameTypeDescription
discussionIdDiscussionIDID of the discussion for the deleted note.
idNoteID!ID of the deleted note.
lastDiscussionNoteBooleanWhether deleted note is the last note in the discussion.

Dependency

A software dependency used by a project.

Fields

NameTypeDescription
idGlobalID!ID of the dependency.
licenses[License!]Licenses associated to the dependency.
locationLocationInformation about where the dependency is located.
nameString!Name of the dependency.
packagerPackageManagerDescription of the tool used to manage the dependency.
reachabilityReachabilityTypeInformation about reachability of a dependency.
versionStringVersion of the dependency.
vulnerabilityCountInt!Number of vulnerabilities within the dependency.

DependencyProxyBlob

Dependency proxy blob.

Fields

NameTypeDescription
createdAtTime!Date of creation.
fileNameString!Name of the blob.
sizeString!Size of the blob file.
updatedAtTime!Date of most recent update.

DependencyProxyBlobRegistry

Represents the Geo replication and verification state of a dependency_proxy_blob.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the DependencyProxyBlobRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the DependencyProxyBlobRegistry was created.
dependencyProxyBlobIdID!ID of the Dependency Proxy Blob.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the DependencyProxyBlobRegistry.
lastSyncFailureStringError message during sync of the DependencyProxyBlobRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the DependencyProxyBlobRegistry.
missingOnPrimaryBooleanIndicate if the DependencyProxyBlobRegistry is missing on primary.
modelRecordIdIntID of the DependencyProxyBlobRegistry’s model record.
retryAtTimeTimestamp after which the DependencyProxyBlobRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the DependencyProxyBlobRegistry.
stateRegistryStateSync state of the DependencyProxyBlobRegistry.
verificationChecksumStringThe local checksum of the DependencyProxyBlobRegistry.
verificationChecksumMismatchedStringThe expected checksum of the DependencyProxyBlobRegistry in case of mismatch.
verificationFailureStringError message during verification of the DependencyProxyBlobRegistry.
verificationRetryAtTimeTimestamp after which the DependencyProxyBlobRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the DependencyProxyBlobRegistry.
verificationStartedAtTimeTimestamp when the verification of DependencyProxyBlobRegistry started.
verificationStateVerificationStateEnumVerification state of the DependencyProxyBlobRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the DependencyProxyBlobRegistry.

DependencyProxyImageTtlGroupPolicy

Group-level Dependency Proxy TTL policy settings.

Fields

NameTypeDescription
createdAtTimeTimestamp of creation.
enabledBoolean!Indicates whether the policy is enabled or disabled.
ttlIntNumber of days to retain a cached image file.
updatedAtTimeTimestamp of the most recent update.

DependencyProxyManifest

Dependency proxy manifest.

Fields

NameTypeDescription
createdAtTime!Date of creation.
digestString!Digest of the manifest.
fileNameString!Name of the manifest.
idDependencyProxyManifestID!ID of the manifest.
imageNameString!Name of the image.
sizeString!Size of the manifest file.
statusDependencyProxyManifestStatus!Status of the manifest (default, pending_destruction, processing, error).
updatedAtTime!Date of most recent update.

DependencyProxyManifestRegistry

Represents the Geo replication and verification state of a dependency_proxy_manifest.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the DependencyProxyManifestRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the DependencyProxyManifestRegistry was created.
dependencyProxyManifestIdID!ID of the Dependency Proxy Manifest.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the DependencyProxyManifestRegistry.
lastSyncFailureStringError message during sync of the DependencyProxyManifestRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the DependencyProxyManifestRegistry.
missingOnPrimaryBooleanIndicate if the DependencyProxyManifestRegistry is missing on primary.
modelRecordIdIntID of the DependencyProxyManifestRegistry’s model record.
retryAtTimeTimestamp after which the DependencyProxyManifestRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the DependencyProxyManifestRegistry.
stateRegistryStateSync state of the DependencyProxyManifestRegistry.
verificationChecksumStringThe local checksum of the DependencyProxyManifestRegistry.
verificationChecksumMismatchedStringThe expected checksum of the DependencyProxyManifestRegistry in case of mismatch.
verificationFailureStringError message during verification of the DependencyProxyManifestRegistry.
verificationRetryAtTimeTimestamp after which the DependencyProxyManifestRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the DependencyProxyManifestRegistry.
verificationStartedAtTimeTimestamp when the verification of DependencyProxyManifestRegistry started.
verificationStateVerificationStateEnumVerification state of the DependencyProxyManifestRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the DependencyProxyManifestRegistry.

DependencyProxyPackagesSetting

Project-level Dependency Proxy for packages settings.

Fields

NameTypeDescription
enabledBoolean!Indicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryUrlStringURL for the external Maven packages registry.
mavenExternalRegistryUsernameStringUsername for the external Maven packages registry.

DependencyProxySetting

Group-level Dependency Proxy settings.

Fields

NameTypeDescription
enabledBoolean!Indicates whether the dependency proxy is enabled for the group.

Deployment

The deployment of an environment.

Fields

NameTypeDescription
approvalSummaryDeploymentApprovalSummaryApproval summary of the deployment.This field can only be resolved for one deployment in any single request.
approvals[DeploymentApproval!]Current approvals of the deployment.
commitCommitCommit details of the deployment.
createdAtTimeWhen the deployment record was created.
finishedAtTimeWhen the deployment finished.
idIDGlobal ID of the deployment.
iidStringProject-level internal ID of the deployment.
jobCiJobPipeline job of the deployment.
pendingApprovalCountIntNumber of pending unified approvals on the deployment.
refStringGit-Ref that the deployment ran on.
refPathStringPath to the Git-Ref that the deployment ran on.
shaStringGit-SHA that the deployment ran on.
statusDeploymentStatusStatus of the deployment.
tagBooleanTrue 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.
triggererUserCoreUser who executed the deployment.
updatedAtTimeWhen the deployment record was updated.
userPermissionsDeploymentPermissions!Permissions for the current user on the resource.
webPathStringWeb path to the deployment page.

DeploymentApproval

Approval of the deployment.

Fields

NameTypeDescription
commentStringAdditional comment.
createdAtTimeWhen the user approved/rejected first time.
statusDeploymentsApprovalStatusWhether the deployment was approved/rejected.
updatedAtTimeWhen the user updated the approval.
userUserCoreUser who approved or rejected the deployment.

DeploymentApprovalSummary

Approval summary of the deployment.

Fields

NameTypeDescription
rules[ProtectedEnvironmentApprovalRuleForSummary!]Approval Rules for the deployment.
statusDeploymentApprovalSummaryStatusStatus of the approvals.
totalPendingApprovalCountIntTotal pending approval count.
totalRequiredApprovalsIntTotal number of required approvals.

DeploymentPermissions

Fields

NameTypeDescription
approveDeploymentBoolean!Indicates the user can perform approve_deployment on this resource. This field can only be resolved for one environment in any single request.
destroyDeploymentBoolean!If true, the user can perform destroy_deployment on this resource.
updateDeploymentBoolean!If true, the user can perform update_deployment on this resource.

DeploymentTag

Tags for a given deployment.

Fields

NameTypeDescription
nameStringName of this git tag.
pathStringPath for this tag.
webPathStringWeb path for this tag.

DescriptionVersion

Fields

NameTypeDescription
canDelete warning-solidBooleanDeprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deletePath warning-solidStringDeprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deleted warning-solidBooleanDeprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
descriptionStringContent of the given description version.
diffPath warning-solidStringDeprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
idDescriptionVersionID!ID of the description version.

Fields with arguments

DescriptionVersion.diff

Description diff between versions.

Returns String.

Arguments
NameTypeDescription
versionIdDescriptionVersionIDID of a previous version to compare. If not specified first previous version is used.

Design

A single design.

Fields

NameTypeDescription
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
descriptionStringDescription of the design.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
diffRefsDiffRefs!Diff refs for this design.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
eventDesignVersionEvent!How this design was changed in the current version.
filenameString!Filename of the design.
fullPathID!Full path to the design file.
idID!ID of this design.
imageString!URL of the full-sized image.
imageV432x230StringThe URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
importedBoolean!Indicates whether the design was imported.
importedFromImportSource!Import source of the design.
issueIssue!Issue the design belongs to.
nameStringName or title of this object.
notesCountInt!Total count of user-created notes for this design.
projectProject!Project the design belongs to.
webUrlString!URL of the design.

Fields with arguments

Design.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
stateTodoStateEnumState of the to-do items.
Design.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
Design.versions

All versions related to this design ordered newest first.

Returns DesignVersionConnection!.

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

Arguments
NameTypeDescription
earlierOrEqualToIdDesignManagementVersionIDGlobal ID of the most recent acceptable version.
earlierOrEqualToShaStringSHA256 of the most recent acceptable version.

DesignAtVersion

A design pinned to a specific version. The image field reflects the design as of the associated version.

Fields

NameTypeDescription
designDesign!Underlying design.
diffRefsDiffRefs!Diff refs for this design.
eventDesignVersionEvent!How this design was changed in the current version.
filenameString!Filename of the design.
fullPathID!Full path to the design file.
idID!ID of this design.
imageString!URL of the full-sized image.
imageV432x230StringThe URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
issueIssue!Issue the design belongs to.
notesCountInt!Total count of user-created notes for this design.
projectProject!Project the design belongs to.
versionDesignVersion!Version this design-at-versions is pinned to.

DesignCollection

A collection of designs.

Fields

NameTypeDescription
copyStateDesignCollectionCopyStateCopy state of the design collection.
issueIssue!Issue associated with the design collection.
projectProject!Project associated with the design collection.

Fields with arguments

DesignCollection.design

Find a specific design.

Returns Design.

Arguments
NameTypeDescription
filenameStringFind a design by its filename.
idDesignManagementDesignIDFind a design by its ID.
DesignCollection.designAtVersion

Find a design as of a version.

Returns DesignAtVersion.

Arguments
NameTypeDescription
idDesignManagementDesignAtVersionID!Global ID of the design at the version.
DesignCollection.designs

All designs for the design collection.

Returns DesignConnection!.

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

Arguments
NameTypeDescription
atVersionDesignManagementVersionIDFilters designs to only those that existed at the version. If argument is omitted or nil then all designs will reflect the latest version.
filenames[String!]Filters designs by their filename.
ids[DesignManagementDesignID!]Filters designs by their ID.
DesignCollection.version

A specific version.

Returns DesignVersion.

Arguments
NameTypeDescription
idDesignManagementVersionIDGlobal ID of the version.
shaStringSHA256 of a specific version.
DesignCollection.versions

All versions related to all designs, ordered newest first.

Returns DesignVersionConnection!.

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

Arguments
NameTypeDescription
earlierOrEqualToIdDesignManagementVersionIDGlobal ID of the most recent acceptable version.
earlierOrEqualToShaStringSHA256 of the most recent acceptable version.

DesignManagement

Fields with arguments

DesignManagement.designAtVersion

Find a design as of a version.

Returns DesignAtVersion.

Arguments
NameTypeDescription
idDesignManagementDesignAtVersionID!Global ID of the design at the version.
DesignManagement.version

Find a version.

Returns DesignVersion.

Arguments
NameTypeDescription
idDesignManagementVersionID!Global ID of the version.

DesignManagementRepositoryRegistry

Represents the Geo replication and verification state of a Design Management Repository.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the DesignManagementRepositoryRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the DesignManagementRepositoryRegistry was created.
designManagementRepositoryIdID!ID of the Design Management Repository.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the DesignManagementRepositoryRegistry.
lastSyncFailureStringError message during sync of the DesignManagementRepositoryRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the DesignManagementRepositoryRegistry.
missingOnPrimaryBooleanIndicate if the DesignManagementRepositoryRegistry is missing on primary.
modelRecordIdIntID of the DesignManagementRepositoryRegistry’s model record.
retryAtTimeTimestamp after which the DesignManagementRepositoryRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the DesignManagementRepositoryRegistry.
stateRegistryStateSync state of the DesignManagementRepositoryRegistry.
verificationChecksumStringThe local checksum of the DesignManagementRepositoryRegistry.
verificationChecksumMismatchedStringThe expected checksum of the DesignManagementRepositoryRegistry in case of mismatch.
verificationFailureStringError message during verification of the DesignManagementRepositoryRegistry.
verificationRetryAtTimeTimestamp after which the DesignManagementRepositoryRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the DesignManagementRepositoryRegistry.
verificationStartedAtTimeTimestamp when the verification of DesignManagementRepositoryRegistry started.
verificationStateVerificationStateEnumVerification state of the DesignManagementRepositoryRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the DesignManagementRepositoryRegistry.

DesignVersion

A specific version in which designs were added, modified or deleted.

Fields

NameTypeDescription
authorUserCore!Author of the version.
createdAtTime!Timestamp of when the version was created.
designsDesignConnection!All designs that were changed in the version. (see Connections)
idID!ID of the design version.
shaID!SHA of the design version.

Fields with arguments

DesignVersion.designAtVersion

A particular design as of this version, provided it is visible at this version.

Returns DesignAtVersion!.

Arguments
NameTypeDescription
designIdDesignManagementDesignIDID of a specific design.
filenameStringFilename of a specific design.
idDesignManagementDesignAtVersionIDID of the DesignAtVersion.
DesignVersion.designsAtVersion

All designs that are visible at this version, as of this version.

Returns DesignAtVersionConnection!.

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

Arguments
NameTypeDescription
filenames[String!]Filters designs by their filename.
ids[DesignManagementDesignID!]Filters designs by their ID.

DetailedImportStatus

Details of the import status of a project.

Fields

NameTypeDescription
idProjectImportStateIDID of the import state.
lastErrorStringLast error of the import.
lastSuccessfulUpdateAtTimeTime of the last successful update.
lastUpdateAtTimeTime of the last update.
lastUpdateStartedAtTimeTime of the start of the last update.
statusStringCurrent status of the import.
urlStringImport url.

DetailedStatus

Fields

NameTypeDescription
actionStatusActionAction information for the status. This includes method, button title, icon, path, and title.
detailsPathStringPath of the details for the status.
faviconStringFavicon of the status.
group warning-solidStringDeprecated in GitLab 16.4. The group attribute is deprecated. Use name instead.
hasDetailsBooleanIndicates if the status has further details.
icon warning-solidStringDeprecated in GitLab 16.4. The icon attribute is deprecated. Use name to identify the status to display instead.
idString!ID for a detailed status.
labelStringHuman-readable label of the status (e.g. success).
nameStringMachine-readable status name (e.g. SUCCESS).
text warning-solidStringDeprecated in GitLab 16.4. The text attribute is being deprecated. Use label instead.
tooltipStringTooltip associated with the status.

DevopsAdoptionEnabledNamespace

Enabled namespace for DevopsAdoption.

Fields

NameTypeDescription
displayNamespaceNamespaceNamespace where data should be displayed.
idID!ID of the enabled namespace.
latestSnapshotDevopsAdoptionSnapshotMetrics snapshot for previous month for the enabled namespace.
namespaceNamespaceNamespace which should be calculated.

Fields with arguments

DevopsAdoptionEnabledNamespace.snapshots

Data snapshots of the namespace.

Returns DevopsAdoptionSnapshotConnection.

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

Arguments
NameTypeDescription
endTimeAfterTimeFilter to snapshots with month end after the provided date.
endTimeBeforeTimeFilter to snapshots with month end before the provided date.

DevopsAdoptionSnapshot

Snapshot.

Fields

NameTypeDescription
codeOwnersUsedCountIntTotal number of projects with existing CODEOWNERS file.
coverageFuzzingEnabledCountIntTotal number of projects with enabled coverage fuzzing.
dastEnabledCountIntTotal number of projects with enabled DAST.
dependencyScanningEnabledCountIntTotal number of projects with enabled dependency scanning.
deploySucceededBoolean!At least one deployment succeeded.
endTimeTime!End time for the snapshot where the data points were collected.
issueOpenedBoolean!At least one issue was opened.
mergeRequestApprovedBoolean!At least one merge request was approved.
mergeRequestOpenedBoolean!At least one merge request was opened.
pipelineSucceededBoolean!At least one pipeline succeeded.
recordedAtTime!Time the snapshot was recorded.
runnerConfiguredBoolean!At least one runner was used.
sastEnabledCountIntTotal number of projects with enabled SAST.
startTimeTime!Start time for the snapshot where the data points were collected.
totalProjectsCountIntTotal number of projects.
vulnerabilityManagementUsedCountIntTotal number of projects with vulnerability management used at least once.

Diff

Fields

NameTypeDescription
aModeStringOld file mode of the file.
bModeStringNew file mode of the file.
deletedFileStringIndicates if the file has been removed.
diffStringDiff representation of the changes made to the file.
newFileStringIndicates if the file has just been added.
newPathStringNew path of the file.
oldPathStringOld path of the file.
renamedFileStringIndicates if the file has been renamed.

DiffPosition

Fields

NameTypeDescription
diffRefsDiffRefs!Information about the branch, HEAD, and base at the time of commenting.
filePathString!Path of the file that was changed.
heightIntTotal height of the image.
newLineIntLine on HEAD SHA that was changed.
newPathStringPath of the file on the HEAD SHA.
oldLineIntLine on start SHA that was changed.
oldPathStringPath of the file on the start SHA.
positionTypeDiffPositionType!Type of file the position refers to.
widthIntTotal width of the image.
xIntX position of the note.
yIntY position of the note.

DiffRefs

Fields

NameTypeDescription
baseShaStringMerge base of the branch the comment was made on.
headShaString!SHA of the HEAD at the time the comment was made.
startShaString!SHA of the branch being compared against.

DiffStats

Changes to a single file.

Fields

NameTypeDescription
additionsInt!Number of lines added to this file.
deletionsInt!Number of lines deleted from this file.
pathString!File path, relative to repository root.

DiffStatsSummary

Aggregated summary of changes.

Fields

NameTypeDescription
additionsInt!Number of lines added.
changesInt!Number of lines changed.
deletionsInt!Number of lines deleted.
fileCountInt!Number of files changed.

Discussion

Fields

NameTypeDescription
createdAtTime!Timestamp of the discussion’s creation.
idDiscussionID!ID of the discussion.
noteableNoteableTypeObject which the discussion belongs to.
notesNoteConnection!All notes in the discussion. (see Connections)
replyIdDiscussionID!ID used to reply to the discussion.
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.

Dora

All information related to DORA metrics.

Fields with arguments

Dora.metrics

DORA metrics for the current group or project.

Returns [DoraMetric!].

Arguments
NameTypeDescription
endDateDateDate range to end at. Default is the current date.
environmentTiers[DeploymentTier!]Deployment tiers of the environments to return. Defaults to [PRODUCTION].
intervalDoraMetricBucketingIntervalHow the metric should be aggregated. Defaults to DAILY. In the case of ALL, the date field in the response will be null.
startDateDateDate range to start from. Default is 3 months ago.

DoraMetric

Fields

NameTypeDescription
changeFailureRateFloatPercentage of deployments that caused incidents in production.
dateStringDate of the data point.
deploymentFrequencyFloatNumber of deployments per day.
leadTimeForChangesFloatMedian time to deploy a merged merge request.
timeToRestoreServiceFloatMedian time to close an incident.

DoraPerformanceScoreCount

Aggregated DORA score counts for projects for the last complete month.

Fields

NameTypeDescription
highProjectsCountIntNumber of projects that score “high” on the metric.
lowProjectsCountIntNumber of projects that score “low” on the metric.
mediumProjectsCountIntNumber of projects that score “medium” on the metric.
metricNameString!Name of the DORA metric.
noDataProjectsCountIntNumber of projects with no data for the metric.

DuoSettings

GitLab Duo settings.

Fields

NameTypeDescription
aiGatewayUrl warning-solidStringIntroduced in GitLab 17.9. Status: Experiment. URL for local AI gateway server.
updatedAt warning-solidTime!Introduced in GitLab 17.9. Status: Experiment. Timestamp of last GitLab Duo setting update.

DuoWorkflow

A Duo Workflow.

Fields

NameTypeDescription
createdAtTime!Timestamp of when the workflow was created.
goalStringGoal of the workflow.
humanStatusString!Human-readable status of the workflow.
idID!ID of the workflow.
projectIdProjectID!ID of the project.
updatedAtTime!Timestamp of when the workflow was last updated.
userIdUserID!ID of the user.
workflowDefinitionStringDuo Workflow type based on its capabilities.

DuoWorkflowEnablement

Duo Workflow enablement status checks.

Fields

NameTypeDescription
checks[DuoWorkflowEnablementCheck!]Enablement checks.
enabledBoolean!Indicates whether GitLab Duo Workflow is enabled for current user and the project.

DuoWorkflowEnablementCheck

Represents single Duo Workflow enablement check.

Fields

NameTypeDescription
messageStringDescription of status check.
nameString!Name of the status check.
valueBoolean!Whether the check was successful or not.

DuoWorkflowEvent

Events that describe the history and progress of a Duo Workflow.

Fields

NameTypeDescription
checkpointJsonStringCheckpoint of the event.
errors[String!]Message errors.
metadataJsonStringMetadata associated with the event.
parentTimestampTimeTime of the parent event.
timestampTimeTime of the event.
workflowDefinitionStringDuo Workflow type based on its capabilities.
workflowGoalStringGoal of the workflow.
workflowStatusDuoWorkflowStatusStatus of the workflow.

EgressNode

Fields

NameTypeDescription
artifactsEgressBigInt!Artifacts egress for that project in that period of time.
dateString!First day of the node range. There is one node per month.
packagesEgressBigInt!Packages egress for that project in that period of time.
registryEgressBigInt!Registry egress for that project in that period of time.
repositoryEgressBigInt!Repository egress for that project in that period of time.
totalEgressBigInt!Total egress for that project in that period of time.

Email

Fields

NameTypeDescription
confirmedAtTimeTimestamp the email was confirmed.
createdAtTime!Timestamp the email was created.
emailString!Email address.
idID!Internal ID of the email.
updatedAtTime!Timestamp the email was last updated.

EmailParticipantType

Fields

NameTypeDescription
emailString!Email address of the email participant. For guests, the email address is obfuscated.

Environment

Describes where code is deployed for a project.

Fields

NameTypeDescription
autoDeleteAtTimeWhen the environment is going to be deleted automatically.
autoStopAtTimeWhen the environment is going to be stopped automatically.
autoStopSettingAutoStopSettingAuto stop setting of the environment.
clusterAgentClusterAgentCluster agent of the environment.
createdAtTimeWhen the environment was created.
deployFreezes[CiFreezePeriod!]Deployment freeze periods of the environment.
deploymentsDisplayCountStringNumber of deployments in the environment for display. Returns the precise number up to 999, and “999+” for counts exceeding this limit.
descriptionStringDescription of the environment.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
environmentTypeStringFolder name of the environment.
externalUrlStringExternal URL of the environment.
fluxResourcePathStringFlux resource path of the environment.
idID!ID of the environment.
kubernetesNamespaceStringKubernetes namespace of the environment.
latestOpenedMostSevereAlertAlertManagementAlertMost severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned.
nameString!Human-readable name of the environment.
pathString!Path to the environment.
protectedEnvironmentsProtectedEnvironmentConnectionProtected Environments for the environment. (see Connections)
slugStringSlug of the environment.
stateString!State of the environment, for example: available/stopped.
tierDeploymentTierDeployment tier of the environment.
updatedAtTimeWhen the environment was updated.
userPermissionsEnvironmentPermissions!Permissions for the current user on the resource. This field can only be resolved for one environment in any single request.

Fields with arguments

Environment.deployments

Deployments of the environment. This field can only be resolved for one environment in any single request.

Returns DeploymentConnection.

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

Arguments
NameTypeDescription
orderByDeploymentsOrderByInputOrder by a specified field.
statuses[DeploymentStatus!]Statuses of the deployments.
Environment.lastDeployment

Last deployment of the environment.

Returns Deployment.

Arguments
NameTypeDescription
statusDeploymentStatus!Status of the Deployment.

EnvironmentPermissions

Fields

NameTypeDescription
destroyEnvironmentBoolean!If true, the user can perform destroy_environment on this resource.
stopEnvironmentBoolean!If true, the user can perform stop_environment on this resource.
updateEnvironmentBoolean!If true, the user can perform update_environment on this resource.

Epic

Represents an epic.

Fields

NameTypeDescription
authorUserCore!Author of the epic.
awardEmojiAwardEmojiConnectionList of emoji reactions associated with the epic. (see Connections)
blockedBooleanIndicates the epic is blocked.
blockedByCountIntCount of epics blocking this epic.
blockedByEpicsEpicConnectionEpics blocking this epic. (see Connections)
blockingCountIntCount of epics that this epic is blocking.
closedAtTimeTimestamp of when the epic was closed.
colorStringColor of the epic.
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
confidentialBooleanIndicates if the epic is confidential.
createdAtTimeTimestamp of when the epic was created.
defaultProjectForIssueCreationProjectDefault Project for issue creation. Based on the project the user created the last issue in.
descendantCountsEpicDescendantCountNumber of open and closed descendant epics and issues.
descendantWeightSumEpicDescendantWeightsTotal weight of open and closed issues in the epic and its descendants.
descriptionStringDescription of the epic.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
downvotesInt!Number of downvotes the epic has received.
dueDateTimeDue date of the epic.
dueDateFixedTimeFixed due date of the epic.
dueDateFromInheritedSourceTimeInherited due date of the epic from child epics or milestones.
dueDateFromMilestonesTimeInherited due date of the epic from milestones.
dueDateIsFixedBooleanIndicates if the due date has been manually set.
eventsEventConnectionList of events associated with the object. (see Connections)
groupGroup!Group to which the epic belongs.
hasChildrenBoolean!Indicates if the epic has children.
hasChildrenWithinTimeframeBoolean!Indicates if the epic has children in the specified timeframe.
hasIssuesBoolean!Indicates if the epic has direct issues.
hasParentBoolean!Indicates if the epic has a parent epic.
healthStatusEpicHealthStatusCurrent health status of the epic.
idID!ID of the epic.
iidString!Internal ID of the epic.
issuesEpicIssueConnectionA list of issues associated with the epic. (see Connections)
labelsLabelConnectionLabels assigned to the epic. (see Connections)
nameStringName or title of this object.
parentEpicParent epic of the epic.
participantsUserCoreConnectionList of participants for the epic. (see Connections)
relationPathStringURI path of the epic-issue relationship.
relativePositionIntRelative position of the epic in the epic tree.
startDateTimeStart date of the epic.
startDateFixedTimeFixed start date of the epic.
startDateFromInheritedSourceTimeInherited start date of the epic from child epics or milestones.
startDateFromMilestonesTimeInherited start date of the epic from milestones.
startDateIsFixedBooleanIndicates if the start date has been manually set.
stateEpicState!State of the epic.
subscribedBoolean!Indicates the currently logged in user is subscribed to the epic.
textColorStringText color generated for the epic.
titleStringTitle of the epic.
titleHtmlStringGitLab Flavored Markdown rendering of title.
updatedAtTimeTimestamp of when the epic was updated.
upvotesInt!Number of upvotes the epic has received.
userDiscussionsCountInt!Number of user discussions in the epic.
userNotesCountInt!Number of user notes of the epic.
userPermissionsEpicPermissions!Permissions for the current user on the resource.
webPathString!Web path of the epic.
webUrlString!Web URL of the epic.

Fields with arguments

Epic.ancestors

Ancestors (parents) of the epic.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsernameStringFilter epics by author.
confidentialBooleanFilter epics by given confidentiality.
createdAfterTimeEpics created after this date.
createdBeforeTimeEpics created before this date.
iidIDIID of the epic, e.g., “1”.
iidStartsWithStringFilter 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.'.
includeAncestorGroupsBooleanInclude epics from ancestor groups.
includeDescendantGroupsBooleanInclude epics from descendant groups.
labelName[String!]Filter epics by labels.
milestoneTitleStringFilter epics by milestone title, computed from epic’s issues.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedEpicFilterInputNegated epic arguments.
orUnionedEpicFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortEpicSortList epics by sort order.
stateEpicStateFilter epics by state.
subscribedSubscriptionStatusEpics the current user is subscribed to.
timeframeTimeframeList items overlapping the given timeframe.
topLevelHierarchyOnlyBooleanFilter epics with a top-level hierarchy.
updatedAfterTimeEpics updated after this date.
updatedBeforeTimeEpics updated before this date.
Epic.children

Children (sub-epics) of the epic.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsernameStringFilter epics by author.
confidentialBooleanFilter epics by given confidentiality.
createdAfterTimeEpics created after this date.
createdBeforeTimeEpics created before this date.
iidIDIID of the epic, e.g., “1”.
iidStartsWithStringFilter 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.'.
includeAncestorGroupsBooleanInclude child epics from ancestor groups.
includeDescendantGroupsBooleanInclude epics from descendant groups.
labelName[String!]Filter epics by labels.
milestoneTitleStringFilter epics by milestone title, computed from epic’s issues.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedEpicFilterInputNegated epic arguments.
orUnionedEpicFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortEpicSortList epics by sort order.
stateEpicStateFilter epics by state.
subscribedSubscriptionStatusEpics the current user is subscribed to.
timeframeTimeframeList items overlapping the given timeframe.
topLevelHierarchyOnlyBooleanFilter epics with a top-level hierarchy.
updatedAfterTimeEpics updated after this date.
updatedBeforeTimeEpics updated before this date.
Epic.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
stateTodoStateEnumState of the to-do items.
Epic.linkedWorkItems

Work items linked to the epic.

Returns LinkedWorkItemTypeConnection.

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

Arguments
NameTypeDescription
filterWorkItemRelatedLinkTypeFilter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
Epic.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
Epic.reference

Internal reference of the epic. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
fullBooleanIndicates if the reference should be returned in full.

EpicBoard

Represents an epic board.

Fields

NameTypeDescription
displayColorsBooleanWhether or not display epic colors.
hideBacklogListBooleanWhether or not backlog list is hidden.
hideClosedListBooleanWhether or not closed list is hidden.
idBoardsEpicBoardID!Global ID of the epic board.
labelsLabelConnectionLabels of the board. (see Connections)
nameStringName of the epic board.
webPathString!Web path of the epic board.
webUrlString!Web URL of the epic board.

Fields with arguments

EpicBoard.lists

Epic board lists.

Returns EpicListConnection.

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

Arguments
NameTypeDescription
epicFiltersEpicFiltersFilters applied when getting epic metadata in the epic board list.
idBoardsEpicListIDFind an epic board list by ID.

EpicDescendantCount

Counts of descendent epics.

Fields

NameTypeDescription
closedEpicsIntNumber of closed child epics.
closedIssuesIntNumber of closed epic issues.
openedEpicsIntNumber of opened child epics.
openedIssuesIntNumber of opened epic issues.

EpicDescendantWeights

Total weight of open and closed descendant issues.

Fields

NameTypeDescription
closedIssues warning-solidIntDeprecated in GitLab 16.6. Use closedIssuesTotal.
closedIssuesTotalBigIntTotal weight of completed (closed) issues in this epic, including epic descendants, encoded as a string.
openedIssues warning-solidIntDeprecated in GitLab 16.6. Use OpenedIssuesTotal.
openedIssuesTotalBigIntTotal weight of opened issues in this epic, including epic descendants, encoded as a string.

EpicHealthStatus

Health status of child issues.

Fields

NameTypeDescription
issuesAtRiskIntNumber of issues at risk.
issuesNeedingAttentionIntNumber of issues that need attention.
issuesOnTrackIntNumber of issues on track.

EpicIssue

Relationship between an epic and an issue.

Fields

NameTypeDescription
alertManagementAlert warning-solidAlertManagementAlertDeprecated in GitLab 15.6. Use alert_management_alerts.
assigneesUserCoreConnectionAssignees of the issue. (see Connections)
authorUserCore!User that created the issue.
blockedBoolean!Indicates the issue is blocked.
blockedByCountIntCount of issues blocking this issue.
blockedByIssuesIssueConnectionIssues blocking this issue. (see Connections)
blockingCountInt!Count of issues this issue is blocking.
closedAsDuplicateOfIssueIssue this issue was closed as a duplicate of.
closedAtTimeTimestamp of when the issue was closed.
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
confidentialBoolean!Indicates the issue is confidential.
createNoteEmailStringUser specific email address for the issue.
createdAtTime!Timestamp of when the issue was created.
customerRelationsContactsCustomerRelationsContactConnectionCustomer relations contacts of the issue. (see Connections)
descriptionStringDescription of the issue.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
designCollectionDesignCollectionCollection of design images associated with this issue.
discussionLockedBoolean!Indicates discussion is locked on the issue.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
downvotesInt!Number of downvotes the issue has received.
dueDateTimeDue date of the issue.
emailsDisabled warning-solidBoolean!Deprecated in GitLab 16.3. Use emails_enabled.
emailsEnabledBoolean!Indicates if the parent project or group has email notifications disabled: false if email notifications are disabled.
epic warning-solidEpicDeprecated in GitLab 17.5. Replaced by WorkItem type.
epicIssueIdID!ID of the epic-issue relation.
escalationPolicyEscalationPolicyTypeEscalation policy associated with the issue. Available for issues which support escalation.
escalationStatusIssueEscalationStatusEscalation status of the issue.
externalAuthorStringEmail address of non-GitLab user reporting the issue. For guests, the email address is obfuscated.
hasEpicBoolean!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 warning-solidBoolean!Introduced in GitLab 16.5. Status: Experiment. Indicates if the issue has a parent work item.
healthStatusHealthStatusCurrent health status.
hiddenBooleanIndicates the issue is hidden because the author has been banned.
humanTimeEstimateStringHuman-readable time estimate of the issue.
humanTotalTimeSpentStringHuman-readable total time reported as spent on the issue.
idIDGlobal ID of the epic-issue relation.
iidString!Internal ID of the issue.
iterationIterationIteration of the issue.
labelsLabelConnectionLabels of the issue. (see Connections)
mergeRequestsCountInt!Number of merge requests that close the issue on merge.
metricImages[MetricImage!]Metric images associated to the issue.
milestoneMilestoneMilestone of the issue.
movedBooleanIndicates if issue got moved from other project.
movedToIssueUpdated Issue after it got moved to another project.
nameStringName or title of this object.
participantsUserCoreConnectionList of participants in the issue. (see Connections)
projectIdIntID of the issue project.
relatedMergeRequestsMergeRequestConnectionMerge requests related to the issue. This field can only be resolved for one issue in any single request. (see Connections)
relatedVulnerabilitiesVulnerabilityConnectionRelated vulnerabilities of the issue. (see Connections)
relationPathStringURI path of the epic-issue relation.
relativePositionIntRelative position of the issue (used for positioning in epic tree and issue boards).
severityIssuableSeveritySeverity level of the incident.
slaDueAtTimeTimestamp of when the issue SLA expires.
stateIssueState!State of the issue.
statusPagePublishedIncidentBooleanIndicates whether an issue is published to the status page.
subscribedBoolean!Indicates the currently logged in user is subscribed to the issue.
taskCompletionStatusTaskCompletionStatus!Task completion status of the issue.
timeEstimateInt!Time estimate of the issue.
timelogsTimelogConnection!Timelogs on the issue. (see Connections)
titleString!Title of the issue.
titleHtmlStringGitLab Flavored Markdown rendering of title.
totalTimeSpentInt!Total time (in seconds) reported as spent on the issue.
typeIssueTypeType of the issue.
updatedAtTime!Timestamp of when the issue was last updated.
updatedByUserCoreUser that last updated the issue.
upvotesInt!Number of upvotes the issue has received.
userDiscussionsCountInt!Number of user discussions in the issue.
userNotesCountInt!Number of user notes of the issue.
userPermissionsIssuePermissions!Permissions for the current user on the resource.
webPathString!Web path of the issue.
webUrlString!Web URL of the issue.
weightIntWeight of the issue.

Fields with arguments

EpicIssue.alertManagementAlerts

Alert Management alerts associated to this issue.

Returns AlertManagementAlertConnection.

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

Arguments
NameTypeDescription
assigneeUsernameStringUsername of a user assigned to the issue.
domainAlertManagementDomainFilter!Filter query for given domain.
iidStringIID of the alert. For example, “1”.
searchStringSearch query for title, description, service, or monitoring_tool.
sortAlertManagementAlertSortSort alerts by the criteria.
statuses[AlertManagementStatus!]Alerts with the specified statues. For example, [TRIGGERED].
EpicIssue.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
stateTodoStateEnumState of the to-do items.

Issuable resource links of the incident issue.

Returns IssuableResourceLinkConnection.

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

Arguments
NameTypeDescription
incidentIdIssueID!ID of the incident.
EpicIssue.linkedWorkItems

Work items linked to the issue.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Returns LinkedWorkItemTypeConnection.

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

Arguments
NameTypeDescription
filterWorkItemRelatedLinkTypeFilter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
EpicIssue.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
EpicIssue.reference

Internal reference of the issue. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
fullBooleanBoolean option specifying whether the reference should be returned in full.

EpicList

Represents an epic board list.

Fields

NameTypeDescription
collapsedBooleanIndicates if this list is collapsed for this user.
idBoardsEpicListID!Global ID of the board list.
labelLabelLabel of the list.
listTypeString!Type of the list.
metadataEpicListMetadataEpic list metatada.
positionIntPosition of the list within the board.
titleString!Title of the list.

Fields with arguments

EpicList.epics

List epics.

Returns EpicConnection.

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

Arguments
NameTypeDescription
filtersEpicFiltersFilters applied when selecting epics in the board list.

EpicListMetadata

Represents epic board list metadata.

Fields

NameTypeDescription
epicsCountIntCount of epics in the list.
totalWeight warning-solidIntIntroduced in GitLab 14.7. Status: Experiment. Total weight of all issues in the list.

EpicPermissions

Check permissions for the current user on an epic.

Fields

NameTypeDescription
adminEpicBoolean!If true, the user can perform admin_epic on this resource.
adminEpicRelationBoolean!If true, the user can perform admin_epic_relation on this resource.
awardEmojiBoolean!If true, the user can perform award_emoji on this resource.
createEpicBoolean!If true, the user can perform create_epic on this resource.
createNoteBoolean!If true, the user can perform create_note on this resource.
destroyEpicBoolean!If true, the user can perform destroy_epic on this resource.
readEpicBoolean!If true, the user can perform read_epic on this resource.
readEpicIidBoolean!If true, the user can perform read_epic_iid on this resource.
updateEpicBoolean!If true, the user can perform update_epic on this resource.

EscalationPolicyType

Represents an escalation policy.

Fields

NameTypeDescription
descriptionStringDescription of the escalation policy.
idIncidentManagementEscalationPolicyIDID of the escalation policy.
nameStringName of the escalation policy.
rules[EscalationRuleType!]Steps of the escalation policy.

EscalationRuleType

Represents an escalation rule for an escalation policy.

Fields

NameTypeDescription
elapsedTimeSecondsIntTime in seconds before the rule is activated.
idIncidentManagementEscalationRuleIDID of the escalation policy.
oncallScheduleIncidentManagementOncallScheduleOn-call schedule to notify.
statusEscalationRuleStatusStatus required to prevent the rule from activating.
userUserCoreUser to notify.

Event

Representing an event.

Fields

NameTypeDescription
actionEventAction!Action of the event.
authorUserCore!Author of this event.
createdAtTime!When this event was created.
idID!ID of the event.
updatedAtTime!When this event was updated.

ExternalAuditEventDestination

Represents an external resource to send audit events to.

Fields

NameTypeDescription
destinationUrlString!External destination to send audit events to.
eventTypeFilters[String!]!List of event type filters added for streaming.
groupGroup!Group the destination belongs to.
headersAuditEventStreamingHeaderConnection!List of additional HTTP headers sent with each event. (see Connections)
idID!ID of the destination.
nameString!Name of the external destination to send audit events to.
namespaceFilterAuditEventStreamingHTTPNamespaceFilterList of subgroup or project filters for the destination.
verificationTokenString!Verification token to validate source of event.

ExternalIssue

Represents an external issue.

Fields

NameTypeDescription
createdAtTimeTimestamp of when the issue was created.
externalTrackerStringType of external tracker.
relativeReferenceStringRelative reference of the issue in the external tracker.
statusStringStatus of the issue in the external tracker.
titleStringTitle of the issue in the external tracker.
updatedAtTimeTimestamp of when the issue was updated.
webUrlStringURL to the issue in the external tracker.

ExternalStatusCheck

Describes an external status check.

Fields

NameTypeDescription
externalUrlString!External URL for the status check.
hmacBoolean!Whether or not HMAC secret is enabled for the status check.
idGlobalID!ID of the rule.
nameString!Name of the rule.

FeatureFlag

Fields

NameTypeDescription
activeBoolean!Whether the feature flag is active.
idOperationsFeatureFlagID!Global ID of the feature flag.
nameString!Name of the feature flag.
pathString!Path to feature flag.
referenceString!Reference to feature flag.

FileUpload

Fields

NameTypeDescription
idUploadID!Global ID of the upload.
pathString!Path of the upload.
sizeInt!Size of the upload in bytes.

FindingReportsComparer

Represents security reports comparison for vulnerability findings.

Fields

NameTypeDescription
report warning-solidComparedSecurityReportIntroduced in GitLab 16.1. Status: Experiment. Compared security report.
statusFindingReportsComparerStatusComparison status.
statusReasonStringText explaining the status.

ForkDetails

Details of the fork project compared to its upstream project.

Fields

NameTypeDescription
aheadIntNumber of commits ahead of upstream.
behindIntNumber of commits behind upstream.
hasConflictsBooleanIndicates if the fork conflicts with its upstream project.
isSyncingBooleanIndicates if there is a synchronization in progress.

GeoNode

Fields

NameTypeDescription
containerRepositoriesMaxCapacityIntMaximum concurrency of container repository sync for this secondary node.
enabledBooleanIndicates whether this Geo node is enabled.
filesMaxCapacityIntMaximum concurrency of LFS/attachment backfill for this secondary node.
idID!ID of this GeoNode.
internalUrlStringURL defined on the primary node secondary nodes should use to contact it.
minimumReverificationIntervalIntInterval (in days) in which the repository verification is valid. After expiry, it is reverted.
nameStringUnique identifier for this Geo node.
primaryBooleanIndicates whether this Geo node is the primary.
reposMaxCapacityIntMaximum concurrency of repository backfill for this secondary node.
selectiveSyncNamespacesNamespaceConnectionNamespaces that should be synced, if selective_sync_type == namespaces. (see Connections)
selectiveSyncShards[String!]Repository storages whose projects should be synced, if selective_sync_type == shards.
selectiveSyncTypeStringIndicates if syncing is limited to only specific groups, or shards.
syncObjectStorageBooleanIndicates if this secondary node will replicate blobs in Object Storage.
urlStringUser-facing URL for this Geo node.
verificationMaxCapacityIntMaximum concurrency of repository verification for this secondary node.

Fields with arguments

GeoNode.ciSecureFileRegistries

Find Ci Secure File registries on this Geo node.

Returns CiSecureFileRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.containerRepositoryRegistries

Find Container Repository registries on this Geo node.

Returns ContainerRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.dependencyProxyBlobRegistries

Find Dependency Proxy Blob registries on this Geo node.

  • Introduced in GitLab 15.6.
  • Status: Experiment.

Returns DependencyProxyBlobRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.dependencyProxyManifestRegistries

Find Dependency Proxy Manifest registries on this Geo node.

Returns DependencyProxyManifestRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.designManagementRepositoryRegistries

Find Design Management Repository registries on this Geo node.

  • Introduced in GitLab 16.1.
  • Status: Experiment.

Returns DesignManagementRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.groupWikiRepositoryRegistries

Find group wiki repository registries on this Geo node.

Returns GroupWikiRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.jobArtifactRegistries

Find Job Artifact registries on this Geo node.

Returns JobArtifactRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.lfsObjectRegistries

Find LFS object registries on this Geo node.

Returns LfsObjectRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.mergeRequestDiffRegistries

Find merge request diff registries on this Geo node.

Returns MergeRequestDiffRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.packageFileRegistries

Package file registries of the GeoNode.

Returns PackageFileRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.pagesDeploymentRegistries

Find Pages Deployment registries on this Geo node.

Returns PagesDeploymentRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.pipelineArtifactRegistries

Find pipeline artifact registries on this Geo node.

Returns PipelineArtifactRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.projectRepositoryRegistries

Find Project registries on this Geo node. Ignored if geo_project_repository_replication feature flag is disabled.

Returns ProjectRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.projectWikiRepositoryRegistries

Find Project Wiki Repository registries on this Geo node. Ignored if geo_project_wiki_repository_replication feature flag is disabled.

Returns ProjectWikiRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.snippetRepositoryRegistries

Find snippet repository registries on this Geo node.

Returns SnippetRepositoryRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.terraformStateVersionRegistries

Find terraform state version registries on this Geo node.

Returns TerraformStateVersionRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.
GeoNode.uploadRegistries

Find Upload registries on this Geo node.

Returns UploadRegistryConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filters registries by their ID.
keyword warning-solidStringDeprecated 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.
replicationStateReplicationStateEnumFilters registries by their replication state.
sortGeoRegistrySortSort registries by given criteria.
verificationStateVerificationStateEnumFilters registries by their verification state.

GitlabInstanceFeatureFlag

A feature flag for the GitLab instance.

Fields

NameTypeDescription
enabledBoolean!Indicates whether the GitLab instance feature flag is enabled or not.
nameString!Name of the GitLab instance feature flag.

GitlabSubscriptionHistory

Describes the subscription history of a given namespace.

Fields

NameTypeDescription
changeTypeSubscriptionHistoryChangeTypeIndicates what type of change in the subscription has happened.
createdAtTimeTimestamp of the subscription history entry creation.
endDateTimeSubscription end date.
maxSeatsUsedIntMaximum seats used in subscription.
seatsIntSeats purchased in subscription.
seatsInUseIntSeats being used in subscription.
startDateTimeSubscription start date.

GoogleCloudArtifactRegistryDockerImage

Represents a docker artifact of Google Artifact Registry.

Fields

NameTypeDescription
digestString!Image’s digest.
imageString!Image’s name.
nameString!Unique image name.
tags[String!]Tags attached to the image.
updateTimeTimeTime when the image was last updated.
uploadTimeTimeTime when the image was uploaded.
uriString!Google Cloud URI to access the image.

GoogleCloudArtifactRegistryDockerImageDetails

Represents details about docker artifact of Google Artifact Registry.

Fields

NameTypeDescription
artifactRegistryImageUrlString!Google Cloud URL to access the image.
buildTimeTimeTime when the image was built.
digestString!Image’s digest.
imageString!Image’s name.
imageSizeBytesStringCalculated size of the image.
locationString!Location of the Artifact Registry repository.
mediaTypeStringMedia type of the image.
nameString!Unique image name.
projectIdString!ID of the Google Cloud project.
repositoryString!Repository on the Google Artifact Registry.
tags[String!]Tags attached to the image.
updateTimeTimeTime when the image was last updated.
uploadTimeTimeTime when the image was uploaded.
uriString!Google Cloud URI to access the image.

GoogleCloudArtifactRegistryRepository

Represents a repository of Google Artifact Registry.

Fields

NameTypeDescription
artifactRegistryRepositoryUrlString!Google Cloud URL to access the repository.
projectIdString!ID of the Google Cloud project.
repositoryString!Repository on the Google Artifact Registry.

Fields with arguments

GoogleCloudArtifactRegistryRepository.artifacts

Google Artifact Registry repository artifacts. Returns null if GitLab.com feature is unavailable.

Returns GoogleCloudArtifactRegistryArtifactConnection.

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

Arguments
NameTypeDescription
sortGoogleCloudArtifactRegistryArtifactsSortCriteria to sort artifacts by.

GoogleCloudLoggingConfigurationType

Stores Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Fields

NameTypeDescription
clientEmailString!Client email.
googleProjectIdNameString!Google project ID.
groupGroup!Group the configuration belongs to.
idID!ID of the configuration.
logIdNameString!Log ID.
nameString!Name of the external destination to send audit events to.

GpgSignature

GPG signature for a signed commit.

Fields

NameTypeDescription
commitShaStringSHA of the associated commit.
gpgKeyPrimaryKeyidStringID of the GPG key.
gpgKeyUserEmailStringUser email associated with the GPG key.
gpgKeyUserNameStringUser name associated with the GPG key.
projectProjectProject of the associated commit.
userUserCoreUser associated with the key.
verificationStatusVerificationStatusIndicates verification status of the associated key or certificate.

GrafanaIntegration

Fields

NameTypeDescription
createdAtTime!Timestamp of the issue’s creation.
enabledBoolean!Indicates whether Grafana integration is enabled.
grafanaUrlString!URL for the Grafana host for the Grafana integration.
idID!Internal ID of the Grafana integration.
updatedAtTime!Timestamp of the issue’s last activity.

Group

Fields

NameTypeDescription
achievementsPath warning-solidStringIntroduced in GitLab 17.0. Status: Experiment. Path for the namespace’s achievements. Returns null if the namespace is not a group, or the achievements feature flag is disabled.
actualRepositorySizeLimitFloatSize limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement.
actualSizeLimitFloatThe actual storage size limit (in bytes) based on the enforcement type of either repository or namespace. This limit is agnostic of enforcement type.
additionalPurchasedStorageSizeFloatAdditional storage purchased for the root namespace in bytes.
aiUsageData warning-solidAiUsageDataIntroduced in GitLab 17.5. Status: Experiment. AI-related data.
allowStaleRunnerPruningBoolean!Indicates whether to regularly prune stale group runners. Defaults to false.
allowedCustomStatuses warning-solidWorkItemWidgetCustomStatusConnectionIntroduced in GitLab 17.8. Status: Experiment. Allowed custom statuses for the group.
amazonS3ConfigurationsAmazonS3ConfigurationTypeConnectionAmazon S3 configurations that receive audit events belonging to the group. (see Connections)
autoDevopsEnabledBooleanIndicates whether Auto DevOps is enabled for all projects within this group.
avatarUrlStringAvatar URL of the group.
ciCdSettings warning-solidCiCdSettingsIntroduced in GitLab 17.9. Status: Experiment. Namespace CI/CD settings for the namespace.
containerRepositoriesCountInt!Number of container repositories in the group.
containsLockedProjectsBooleanIncludes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
createdAtTimeTimestamp of the group creation.
crossProjectPipelineAvailableBoolean!Indicates if the cross_project_pipeline feature is available for the namespace.
dependencyProxyBlobCountInt!Number of dependency proxy blobs cached in the group.
dependencyProxyBlobsDependencyProxyBlobConnectionDependency Proxy blobs. (see Connections)
dependencyProxyImageCountInt!Number of dependency proxy images cached in the group.
dependencyProxyImagePrefixString!Prefix for pulling images when using the dependency proxy.
dependencyProxyImageTtlPolicyDependencyProxyImageTtlGroupPolicyDependency proxy TTL policy for the group.
dependencyProxyManifestsDependencyProxyManifestConnectionDependency Proxy manifests. (see Connections)
dependencyProxySettingDependencyProxySettingDependency Proxy settings for the group.
dependencyProxyTotalSizeString!Total size of the dependency proxy cached images.
dependencyProxyTotalSizeBytesBigInt!Total size of the dependency proxy cached images in bytes, encoded as a string.
dependencyProxyTotalSizeInBytes warning-solidInt!Deprecated in GitLab 16.1. Use dependencyProxyTotalSizeBytes.
descendantGroupsCountInt!Count of direct descendant groups of this group.
descriptionStringDescription of the namespace.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
doraDoraGroup’s DORA metrics.
duoFeaturesEnabled warning-solidBooleanIntroduced in GitLab 16.10. Status: Experiment. Indicates whether GitLab Duo features are enabled for the group.
emailsDisabledBooleanIndicates if a group has email notifications disabled.
emailsEnabledBooleanIndicates if a group has email notifications enabled.
enforceFreeUserCapBooleanIndicates whether the group has limited users for a free plan.
epicBoards warning-solidEpicBoardConnectionDeprecated in GitLab 17.5. Replaced by WorkItem type.
epicsEnabled warning-solidBooleanDeprecated in GitLab 17.5. Replaced by WorkItem type.
externalAuditEventDestinationsExternalAuditEventDestinationConnectionExternal locations that receive audit events belonging to the group. (see Connections)
externalAuditEventStreamingDestinations warning-solidGroupAuditEventStreamingDestinationConnectionIntroduced in GitLab 16.11. Status: Experiment. External destinations that receive audit events belonging to the group.
flowMetrics warning-solidGroupValueStreamAnalyticsFlowMetricsIntroduced in GitLab 15.10. Status: Experiment. Flow metrics for value stream analytics.
fullNameString!Full name of the namespace.
fullPathID!Full path of the namespace.
googleCloudLoggingConfigurationsGoogleCloudLoggingConfigurationTypeConnectionGoogle Cloud logging configurations that receive audit events belonging to the group. (see Connections)
groupMembersCountInt!Count of direct members of this group.
idID!ID of the namespace.
isAdjournedDeletionEnabled warning-solidBoolean!Introduced in GitLab 16.11. Status: Experiment. Indicates if delayed group deletion is enabled.
isLinkedToSubscriptionBooleanIndicates if group is linked to a subscription.
lfsEnabledBooleanIndicates if Large File Storage (LFS) is enabled for namespace.
lockDuoFeaturesEnabled warning-solidBooleanIntroduced in GitLab 16.10. Status: Experiment. Indicates if the GitLab Duo features enabled setting is enforced for all subgroups.
lockMathRenderingLimitsEnabledBooleanIndicates if math rendering limits are locked for all descendant groups.
markedForDeletionOn warning-solidTimeIntroduced in GitLab 16.11. Status: Experiment. Date when group was scheduled to be deleted.
mathRenderingLimitsEnabledBooleanIndicates if math rendering limits are used for this group.
maxAccessLevelAccessLevel!The maximum access level of the current user in the group.
mentionsDisabledBooleanIndicates if a group is disabled from getting mentioned.
nameString!Name of the namespace.
organizationEditPath warning-solidStringIntroduced in GitLab 17.1. Status: Experiment. Path for editing group at the organization level.
packageSettingsPackageSettingsPackage settings for the namespace.
parentGroupParent group.
pathString!Path of the namespace.
pendingMemberApprovals warning-solidMemberApprovalConnectionIntroduced in GitLab 17.3. Status: Experiment. Pending member promotions of the group.
pendingMembers warning-solidPendingMemberInterfaceConnectionIntroduced in GitLab 16.6. Status: Experiment. A pending membership of a user within this group.
permanentDeletionDate warning-solidStringIntroduced in GitLab 16.11. Status: Experiment. Date when group will be deleted if delayed group deletion is enabled.
productAnalyticsStoredEventsLimit warning-solidIntIntroduced in GitLab 16.9. Status: Experiment. Number of product analytics events namespace is permitted to store per cycle.
projectCreationLevelStringPermission level required to create projects in the group.
projectsCountInt!Count of direct projects in this group.
recentIssueBoardsBoardConnectionList of recently visited boards of the group. Maximum size is 4. (see Connections)
repositorySizeExcessProjectCountIntNumber of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
requestAccessEnabledBooleanIndicates if users can request access to namespace.
requireTwoFactorAuthenticationBooleanIndicates if all users in this group are required to set up two-factor authentication.
rootStorageStatisticsRootStorageStatisticsAggregated storage statistics of the namespace. Only available for root namespaces.
securityPolicyProjectProjectSecurity policy project assigned to the namespace.
shareWithGroupLockBooleanIndicates if sharing a project with another group within this group is prevented.
sharedRunnersSettingSharedRunnersSettingShared runners availability for the namespace and its descendants.
sidebar warning-solidNamespaceSidebarIntroduced in GitLab 17.6. Status: Experiment. Data needed to render the sidebar for the namespace.
statsGroupStatsGroup statistics.
storageSizeLimitFloatThe storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement.
subgroupCreationLevelStringPermission level required to create subgroups within the group.
subscriptionHistory warning-solidGitlabSubscriptionHistoryConnectionIntroduced in GitLab 17.3. Status: Experiment. Find subscription history records.
timelogCategories warning-solidTimeTrackingTimelogCategoryConnectionIntroduced in GitLab 15.3. Status: Experiment. Timelog categories for the namespace.
totalRepositorySizeFloatTotal repository size of all projects in the root namespace in bytes.
totalRepositorySizeExcessFloatTotal excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement.
twoFactorGracePeriodIntTime before two-factor authentication is enforced.
updatedAtTimeTimestamp of when the group was last updated.
userPermissionsGroupPermissions!Permissions for the current user on the resource.
valueStreamAnalyticsValueStreamAnalyticsInformation about Value Stream Analytics within the group.
visibilityStringVisibility of the namespace.
vulnerabilityScannersVulnerabilityScannerConnectionVulnerability scanners reported on the project vulnerabilities of the group and its subgroups. (see Connections)
webUrlString!Web URL of the group.

Fields with arguments

Group.achievements

Achievements for the namespace. Returns null if the achievements feature flag is disabled.

  • Introduced in GitLab 15.8.
  • Status: Experiment.

Returns AchievementConnection.

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

Arguments
NameTypeDescription
ids[AchievementsAchievementID!]Filter achievements by IDs.
Group.addOnEligibleUsers

Users in the namespace hierarchy that add ons are applicable for. This only applies to root namespaces.

  • Introduced in GitLab 16.5.
  • Status: Experiment.

Returns AddOnUserConnection.

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

Arguments
NameTypeDescription
addOnPurchaseIds[GitlabSubscriptionsAddOnPurchaseID!]!Global IDs of the add on purchases to find assignments for.
addOnTypeGitlabSubscriptionsAddOnType!Type of add on to filter the eligible users by.
filterByAssignedSeatStringFilter users list by assigned seat.
searchStringSearch the user list.
sortGitlabSubscriptionsUserSortSort the user list.
Group.addOnPurchase

AddOnPurchase associated with the namespace.

  • Deprecated in GitLab 17.5.
  • Use root addOnPurchases instead.

Returns AddOnPurchase.

Arguments
NameTypeDescription
addOnNameString!AddOn name.
Group.aiMetrics

AI-related metrics.

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Returns AiMetrics.

Arguments
NameTypeDescription
endDateDateDate range to end at. Default is the end of current month.
startDateDateDate range to start from. Default is the beginning of current month.
Group.aiUserMetrics

AI-related user metrics.

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Returns AiUserMetricsConnection.

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

Arguments
NameTypeDescription
endDateDateDate range to end at. Default is the end of current month.
startDateDateDate range to start from. Default is the beginning of current month.
Group.approvalPolicies

Approval Policies of the project.

Returns ApprovalPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Group.autocompleteUsers

Search users for autocompletion.

Returns [AutocompletedUser!].

Arguments
NameTypeDescription
searchStringQuery to search users by name, username, or public email.
Group.billableMembersCount

Number of billable users in the group.

Returns Int.

Arguments
NameTypeDescription
requestedHostedPlanStringPlan from which to get billable members.
Group.board

A single board of the group.

Returns Board.

Arguments
NameTypeDescription
idBoardID!ID of the board.
Group.boards

Boards of the group.

Returns BoardConnection.

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

Arguments
NameTypeDescription
idBoardIDFind a board by its ID.
Group.ciQueueingHistory

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.

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Returns QueueingDelayHistory.

Arguments
NameTypeDescription
fromTimeTimeStart of the requested time. Defaults to three hours ago.
toTimeTimeEnd of the requested time. Defaults to the current time.
Group.ciVariables

List of the group’s CI/CD variables.

Returns CiGroupVariableConnection.

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

Arguments
NameTypeDescription
sortCiVariableSortSort order of results.
Group.clusterAgents

Cluster agents associated with projects in the group and its subgroups.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
hasRemoteDevelopmentAgentConfig warning-solidBooleanDeprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabledBooleanReturns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilitiesBooleanReturns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfigBooleanReturns only cluster agents which have an associated workspaces agent config.
Group.codeCoverageActivities

Represents the code coverage activity for this group.

Returns CodeCoverageActivityConnection.

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

Arguments
NameTypeDescription
startDateDate!First day for which to fetch code coverage activity (maximum time window is set to 90 days).
Group.complianceFrameworks

Compliance frameworks available to projects in this namespace.

Returns ComplianceFrameworkConnection.

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

Arguments
NameTypeDescription
idComplianceManagementFrameworkIDGlobal ID of a specific compliance framework to return.
ids[ComplianceManagementFrameworkID!]List of Global IDs of compliance frameworks to return.
searchStringSearch framework with most similar names.
Group.components

Find software dependencies by name.

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Returns [Component!].

Arguments
NameTypeDescription
nameStringEntire name or part of the name.
Group.contactStateCounts

Counts of contacts by state for the group.

Returns ContactStateCounts.

Arguments
NameTypeDescription
searchStringSearch term to find contacts with.
stateCustomerRelationsContactStateState of the contacts to search for.
Group.contacts

Find contacts of this group.

Returns CustomerRelationsContactConnection.

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

Arguments
NameTypeDescription
ids[CustomerRelationsContactID!]Filter contacts by IDs.
searchStringSearch term to find contacts with.
sortContactSortCriteria to sort contacts by.
stateCustomerRelationsContactStateState of the contacts to search for.
Group.containerRepositories

Container repositories of the group.

Returns ContainerRepositoryConnection.

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

Arguments
NameTypeDescription
nameStringFilter the container repositories by their name.
sortContainerRepositorySortSort container repositories by the criteria.
Group.contributions

Provides the aggregated contributions by users within the group and its subgroups.

Returns ContributionAnalyticsContributionConnection.

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

Arguments
NameTypeDescription
fromISO8601Date!Start date of the reporting time range.
toISO8601Date!End date of the reporting time range. The end date must be within 93 days after the start date.
Group.customEmoji

Custom emoji in this namespace.

Returns CustomEmojiConnection.

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

Arguments
NameTypeDescription
includeAncestorGroupsBooleanIncludes custom emoji from parent groups.
Group.customField

A custom field configured for the group. Available only when feature flag custom_fields_feature is enabled.

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Returns CustomField.

Arguments
NameTypeDescription
idIssuablesCustomFieldID!Global ID of the custom field.
Group.customFields

Custom fields configured for the group. Available only when feature flag custom_fields_feature is enabled.

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Returns CustomFieldConnection.

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

Arguments
NameTypeDescription
activeBooleanFilter for active fields. If false, excludes active fields. If true, returns only active fields.
searchStringSearch query for custom field name.
workItemTypeIds[WorkItemsTypeID!]Filter custom fields associated to the given work item types. If empty, returns custom fields not associated to any work item type.
Group.customizableDashboardVisualizations

Visualizations of the group or associated configuration project.

Returns CustomizableDashboardVisualizationConnection.

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

Arguments
NameTypeDescription
slugStringSlug of the visualization to return.
Group.customizableDashboards

Customizable dashboards for the group.

Returns CustomizableDashboardConnection.

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

Arguments
NameTypeDescription
categoryCustomizableDashboardCategoryFind by dashboard type.
slugStringFind by dashboard slug.
Group.dataTransfer

Data transfer data point for a specific period. This is mocked data under a development feature flag.

Returns GroupDataTransfer.

Arguments
NameTypeDescription
fromDateRetain egress data for one year. Data for the current month will increase dynamically as egress occurs.
toDateEnd date for the data.
Group.dependencies

Software dependencies used by projects under this group.

Returns DependencyConnection.

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

Arguments
NameTypeDescription
componentIds[SbomComponentID!]Filter dependencies by component IDs.
componentNames[String!]Filter dependencies by component names.
packageManagers[PackageManager!]Filter dependencies by package managers.
sortDependencySortSort dependencies by given criteria.
sourceTypes[SbomSourceType!]Filter dependencies by source type.
Group.descendantGroups

List of descendant groups of this group.

Returns GroupConnection.

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

Arguments
NameTypeDescription
includeParentDescendantsBooleanList of descendant groups of the parent group.
ownedBooleanLimit result to groups owned by authenticated user.
searchStringSearch query for group name or group full path.
Group.doraPerformanceScoreCounts

Group’s DORA scores for all projects by DORA key metric for the last complete month.

Returns DoraPerformanceScoreCountConnection.

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

Arguments
NameTypeDescription
projectFiltersDoraProjectFilterInputFilter DORA metric results by project attributes.
Group.environmentScopes

Environment scopes of the group.

Returns CiGroupEnvironmentScopeConnection.

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

Arguments
NameTypeDescription
nameStringName of the environment scope.
searchStringSearch query for environment scope name.
Group.epic

Find a single epic.

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Returns Epic.

Arguments
NameTypeDescription
authorUsernameStringFilter epics by author.
confidentialBooleanFilter epics by given confidentiality.
createdAfterTimeEpics created after this date.
createdBeforeTimeEpics created before this date.
iidIDIID of the epic, e.g., “1”.
iidStartsWithStringFilter 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.'.
includeAncestorGroupsBooleanInclude epics from ancestor groups.
includeDescendantGroupsBooleanInclude epics from descendant groups.
labelName[String!]Filter epics by labels.
milestoneTitleStringFilter epics by milestone title, computed from epic’s issues.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedEpicFilterInputNegated epic arguments.
orUnionedEpicFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortEpicSortList epics by sort order.
stateEpicStateFilter epics by state.
subscribedSubscriptionStatusEpics the current user is subscribed to.
timeframeTimeframeList items overlapping the given timeframe.
topLevelHierarchyOnlyBooleanFilter epics with a top-level hierarchy.
updatedAfterTimeEpics updated after this date.
updatedBeforeTimeEpics updated before this date.
Group.epicBoard

Find a single epic board.

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Returns EpicBoard.

Arguments
NameTypeDescription
idBoardsEpicBoardID!Find an epic board by ID.
Group.epics

Find epics.

  • Deprecated in GitLab 17.5.
  • Replaced by WorkItem type.

Returns EpicConnection.

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

Arguments
NameTypeDescription
authorUsernameStringFilter epics by author.
confidentialBooleanFilter epics by given confidentiality.
createdAfterTimeEpics created after this date.
createdBeforeTimeEpics created before this date.
iidIDIID of the epic, e.g., “1”.
iidStartsWithStringFilter 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.'.
includeAncestorGroupsBooleanInclude epics from ancestor groups.
includeDescendantGroupsBooleanInclude epics from descendant groups.
labelName[String!]Filter epics by labels.
milestoneTitleStringFilter epics by milestone title, computed from epic’s issues.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedEpicFilterInputNegated epic arguments.
orUnionedEpicFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortEpicSortList epics by sort order.
stateEpicStateFilter epics by state.
subscribedSubscriptionStatusEpics the current user is subscribed to.
timeframeTimeframeList items overlapping the given timeframe.
topLevelHierarchyOnlyBooleanFilter epics with a top-level hierarchy.
updatedAfterTimeEpics updated after this date.
updatedBeforeTimeEpics updated before this date.
Group.gitlabSubscriptionsPreviewBillableUserChange

Preview Billable User Changes.

Returns PreviewBillableUserChange.

Arguments
NameTypeDescription
addGroupIdIntGroup ID to add.
addUserEmails[String!]User emails to add.
addUserIds[Int!]User IDs to add.
memberRoleIdIntCustom role assigned to the users.
roleGitlabSubscriptionsUserRole!Role of users being added to group.
Group.groupMembers

A membership of a user within this group.

Returns GroupMemberConnection.

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

Arguments
NameTypeDescription
accessLevels[AccessLevelEnum!]Filter members by the given access levels.
enterpriseBooleanFilter members by enterprise users.
relations[GroupMemberRelation!]Filter members by the given member relations.
searchStringSearch query.
sortMemberSortsort query.
Group.importSourceUsers

Import source users of the namespace. This field can only be resolved for one namespace in any single request.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Returns ImportSourceUserConnection.

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

Arguments
NameTypeDescription
searchStringQuery to search mappings by name or username of users on source instance.
sortSourceUserSortSort 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.
Group.issues

Issues for projects in this group.

Returns IssueConnection.

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

Arguments
NameTypeDescription
assigneeIdStringID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername warning-solidStringDeprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames[String!]Usernames of users assigned to the issue.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsernameStringUsername of the author of the issue.
closedAfterTimeIssues closed after the date.
closedBeforeTimeIssues closed before the date.
confidentialBooleanFilter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfterTimeIssues created after the date.
createdBeforeTimeIssues created before the date.
crmContactIdStringID of a contact assigned to the issues.
crmOrganizationIdStringID of an organization assigned to the issues.
dueAfterTimeReturn issues due on or after the given time.
dueBeforeTimeReturn issues due on or before the given time.
epicIdStringID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardIdEpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatus warning-solidHealthStatusDeprecated in GitLab 15.4. Use healthStatusFilter.
healthStatusFilterHealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iidStringIID 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.'.
includeArchivedBooleanReturn issues from archived projects.
includeSubepicsBooleanWhether to include subepics when filtering issues by epicId.
includeSubgroupsBooleanInclude 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.
iterationTitleStringFilter by iteration title.
iterationWildcardIdIterationWildcardIdFilter by iteration ID wildcard.
labelName[String]Labels applied to the issue.
milestoneTitle[String]Milestone applied to the issue.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
notNegatedIssueFilterInputNegated arguments.
orUnionedIssueFilterInputList of arguments with inclusive OR.
searchStringSearch query for title or description.
sortIssueSortSort issues by the criteria.
stateIssuableStateCurrent state of the issue.
subscribedSubscriptionStatusIssues the current user is subscribed to.
types[IssueType!]Filter issues by the given issue types.
updatedAfterTimeIssues updated after the date.
updatedBeforeTimeIssues updated before the date.
weightStringWeight applied to the issue, “none” and “any” values are supported.
weightWildcardIdWeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.
Group.iterationCadences

Find iteration cadences.

Returns IterationCadenceConnection.

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

Arguments
NameTypeDescription
activeBooleanWhether the iteration cadence is active.
automaticBooleanWhether the iteration cadence should automatically generate upcoming iterations.
durationInWeeksIntDuration in weeks of the iterations within this cadence.
idIterationsCadenceIDGlobal ID of the iteration cadence to look up.
includeAncestorGroupsBooleanWhether to include ancestor groups to search iterations cadences in.
titleStringFuzzy search by title.
Group.iterations

Find iterations.

Returns IterationConnection.

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

Arguments
NameTypeDescription
idIDGlobal ID of the Iteration to look up.
iidIDInternal 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].
includeAncestorsBooleanWhether to include ancestor iterations. Defaults to true.
includeDescendantsBooleanWhether to include descendant iterations.
iterationCadenceIds[IterationsCadenceID!]Global iteration cadence IDs by which to look up the iterations.
searchStringQuery used for fuzzy-searching in the fields selected in the argument in. Returns all iterations if empty.
sortIterationSortList iterations by sort order. If unspecified, an arbitrary order (subject to change) is used.
stateIterationStateFilter iterations by state.
timeframeTimeframeList items overlapping the given timeframe.
title warning-solidStringDeprecated in GitLab 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
Group.label

Label available on this group.

Returns Label.

Arguments
NameTypeDescription
titleString!Title of the label.
Group.labels

Labels available on this group.

Returns LabelConnection.

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

Arguments
NameTypeDescription
includeAncestorGroupsBooleanInclude labels from ancestor groups.
includeDescendantGroupsBooleanInclude labels from descendant groups.
onlyGroupLabelsBooleanInclude only group level labels.
searchIn[LabelSearchFieldList!]!Specify which fields to search in. Ignored if using title.
searchTermStringSearch term to find labels with.
titleStringExact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.
Group.memberRoles

Custom roles available for the group.

  • Introduced in GitLab 16.5.
  • Status: Experiment.

Returns MemberRoleConnection.

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

Arguments
NameTypeDescription
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering column. Default is ASC.
Group.mergeRequestViolations

Compliance violations reported on merge requests merged within the group.

Returns ComplianceViolationConnection.

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

Arguments
NameTypeDescription
filtersComplianceViolationInputFilters applied when retrieving compliance violations.
sortComplianceViolationSortList compliance violations by sort order.
Group.mergeRequests

Merge requests for projects in this group.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
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.'.
includeArchivedBooleanReturn merge requests from archived projects.
includeSubgroupsBooleanInclude merge requests belonging to subgroups.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
Group.milestones

Milestones of the group.

Returns MilestoneConnection.

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

Arguments
NameTypeDescription
containingDateTimeDate the milestone contains.
ids[ID!]Array of global milestone IDs, e.g., "gid://gitlab/Milestone/1".
includeAncestorsBooleanInclude milestones from all parent groups.
includeDescendantsBooleanInclude milestones from all subgroups and subprojects.
searchTitleStringSearch string for the title.
sortMilestoneSortSort milestones by the criteria.
stateMilestoneStateEnumFilter milestones by state.
timeframeTimeframeList items overlapping the given timeframe.
titleStringTitle of the milestone.
Group.organizationStateCounts

Counts of organizations by status for the group.

Returns OrganizationStateCounts.

Arguments
NameTypeDescription
searchStringSearch term to find organizations with.
stateCustomerRelationsOrganizationStateState of the organizations to search for.
Group.organizations

Find organizations of this group.

Returns CustomerRelationsOrganizationConnection.

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

Arguments
NameTypeDescription
ids[CustomerRelationsOrganizationID!]Filter organizations by IDs.
searchStringSearch term used to find organizations with.
sortOrganizationSortCriteria to sort organizations by.
stateCustomerRelationsOrganizationStateState of the organization to search for.
Group.packages

Packages of the group. This field can only be resolved for one group in any single request.

Returns PackageConnection.

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

Arguments
NameTypeDescription
includeVersionlessBooleanInclude versionless packages.
packageNameStringSearch a package by name.
packageTypePackageTypeEnumFilter a package by type.
packageVersionStringFilter a package by version. If used in combination with include_versionless, then no versionless packages are returned.
sortPackageGroupSortSort packages by the criteria.
statusPackageStatusFilter a package by status.
Group.pagesDeployments

List of the namespaces’s Pages Deployments.

Returns PagesDeploymentConnection.

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

Arguments
NameTypeDescription
activeBooleanFilter by active or inactive state.
sortSortSort results.
versionedBooleanFilter deployments that are versioned or unversioned.
Group.pipelineAnalytics

Pipeline analytics.

Returns PipelineAnalytics.

Arguments
NameTypeDescription
fromTime warning-solidTimeIntroduced in GitLab 17.5. Status: Experiment. Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref warning-solidStringIntroduced in GitLab 17.5. Status: Experiment. Branch that triggered the pipeline.
source warning-solidCiPipelineCiSourcesIntroduced in GitLab 17.5. Status: Experiment. Source of the pipeline.
toTime warning-solidTimeIntroduced in GitLab 17.5. Status: Experiment. End of the requested time (in UTC). Defaults to the pipelines started before the current date.
Group.pipelineExecutionPolicies

Pipeline Execution Policies of the namespace.

Returns PipelineExecutionPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Group.projectComplianceStandardsAdherence

Compliance standards adherence for the projects in a group and its subgroups.

Returns ComplianceStandardsAdherenceConnection.

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

Arguments
NameTypeDescription
filtersComplianceStandardsAdherenceInputFilters applied when retrieving compliance standards adherence.
Group.projects

Projects within this namespace. Returns projects from the parent group if namespace is project.

Returns ProjectConnection!.

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

Arguments
NameTypeDescription
complianceFrameworkFiltersComplianceFrameworkFiltersFilters applied when selecting a compliance framework.
hasCodeCoverageBooleanReturns only the projects which have code coverage.
hasVulnerabilitiesBooleanReturns only the projects which have vulnerabilities.
ids[ID!]Filter projects by IDs.
includeArchivedBooleanInclude also archived projects.
includeSiblingProjects warning-solidBooleanIntroduced in GitLab 17.2. Status: Experiment. Include also projects from parent group.
includeSubgroupsBooleanInclude also subgroup projects.
notAimedForDeletionBooleanInclude projects that are not aimed for deletion.
sbomComponentIdIDReturn only the projects related to the specified SBOM component.
searchStringSearch project with most similar names or paths.
sortNamespaceProjectSortSort projects by the criteria.
withIssuesEnabledBooleanReturn only projects with issues enabled.
withMergeRequestsEnabledBooleanReturn only projects with merge requests enabled.
withNamespaceDomainPagesBooleanReturn only projects that use the namespace domain for pages projects.
Group.releases

Releases belonging to projects in the group.

Returns ReleaseConnection.

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

Arguments
NameTypeDescription
sortGroupReleaseSortSort group releases by given criteria.
Group.remoteDevelopmentClusterAgents

Cluster agents in the namespace with remote development capabilities.

  • Deprecated in GitLab 17.8.
  • Use workspacesClusterAgents.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
filterNamespaceClusterAgentFilter!Filter the types of cluster agents to return.
Group.runnerCloudProvisioning

Information used for provisioning the runner on a cloud provider. Returns null if the GitLab instance is not a SaaS instance.

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Returns CiRunnerCloudProvisioning.

Arguments
NameTypeDescription
cloudProjectIdGoogleCloudProject!Identifier of the cloud project.
providerCiRunnerCloudProvider!Identifier of the cloud provider.
Group.runners

Find runners visible to the current user.

Returns CiRunnerConnection.

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

Arguments
NameTypeDescription
active warning-solidBooleanDeprecated in GitLab 14.8. This was renamed. Use: paused.
creatorIdUserIDFilter runners by creator ID.
creatorUsername warning-solidStringIntroduced in GitLab 16.7. Status: Experiment. Filter runners by creator username.
membershipCiRunnerMembershipFilterControl which runners to include in the results.
ownerFullPath warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Filter runners by owning project or group.
ownerWildcard warning-solidCiRunnerOwnerWildcardIntroduced in GitLab 17.8. Status: Experiment. Filter runners by owner wildcard.
pausedBooleanFilter runners by paused (true) or active (false) status.
searchStringFilter by full token or partial text in description field.
sortCiRunnerSortSort order of results.
statusCiRunnerStatusFilter runners by status.
tagList[String!]Filter by tags associated with the runner (comma-separated or array).
typeCiRunnerTypeFilter runners by type.
upgradeStatusCiRunnerUpgradeStatusFilter by upgrade status.
versionPrefix warning-solidStringIntroduced in GitLab 16.6. Status: Experiment. Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term ‘14.’ returns runner managers with versions ‘14.11.1’ and ‘14.2.3’.
Group.savedReplies

Saved replies available to the group. This field can only be resolved for one group in any single request.

Returns GroupSavedReplyConnection.

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

Arguments
NameTypeDescription
includeAncestorGroupsBooleanInclude saved replies from parent groups.
Group.savedReply

Saved reply in the group. This field can only be resolved for one group in any single request.

Returns GroupSavedReply.

Arguments
NameTypeDescription
idGroupsSavedReplyID!Global ID of a saved reply.
Group.scanExecutionPolicies

Scan Execution Policies of the namespace.

Returns ScanExecutionPolicyConnection.

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

Arguments
NameTypeDescription
actionScanTypes[SecurityReportTypeEnum!]Filters policies by the action scan type. Only these scan types are supported: dast, secret_detection, cluster_image_scanning, container_scanning, sast, sast_iac, dependency_scanning.
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Group.scanResultPolicies

Scan Result Policies of the project.

  • Deprecated in GitLab 16.9.
  • Use approvalPolicies.

Returns ScanResultPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Group.securityPolicyProjectSuggestions

Security policy project suggestions.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
onlyLinkedBooleanWhether to suggest only projects already linked as security policy projects.
searchString!Search query for projects’ full paths.
Group.standardRole

Finds a single default role for the group. Available only for SaaS.

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Returns StandardRole.

Arguments
NameTypeDescription
accessLevel[MemberAccessLevel!]Access level or levels to filter by.
Group.standardRoles

Default roles available for the group. Available only for SaaS.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns StandardRoleConnection.

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

Arguments
NameTypeDescription
accessLevel[MemberAccessLevel!]Access level or levels to filter by.
Group.timelogs

Time logged on issues and merge requests in the group and its subgroups.

Returns TimelogConnection!.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
Group.valueStreamDashboardUsageOverview

Aggregated usage counts within the group.

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Returns ValueStreamDashboardCount.

Arguments
NameTypeDescription
identifierValueStreamDashboardMetric!Type of counts to retrieve.
timeframeTimeframe!Counts recorded during this time frame, usually from beginning of the month until the end of the month (the system runs monthly aggregations).
Group.valueStreams

Value streams available to the group.

Returns ValueStreamConnection.

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

Arguments
NameTypeDescription
idIDValue stream id.
Group.vulnerabilities

Vulnerabilities reported on the projects in the group and its subgroups.

Returns VulnerabilityConnection.

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

Arguments
NameTypeDescription
clusterAgentId[ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId[ClustersClusterID!]Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason[VulnerabilityDismissalReason!]Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
hasAiResolution warning-solidBooleanIntroduced in GitLab 17.5. Status: Experiment. Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution. Requires the vulnerability_report_vr_filter feature flag to be enabled, otherwise the argument is ignored.
hasIssuesBooleanReturns only the vulnerabilities which have linked issues.
hasMergeRequestBooleanReturns only the vulnerabilities which have linked merge requests.
hasRemediationsBooleanReturns only the vulnerabilities which have remediations.
hasResolutionBooleanReturns only the vulnerabilities which have been resolved on default branch.
identifierNameStringFilter vulnerabilities by identifier name. Applicable on group level when feature flag vulnerability_filtering_by_identifier_group is enabled. 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.
owaspTopTen[VulnerabilityOwaspTop10!]Filter vulnerabilities by OWASP Top 10 category. Wildcard value “NONE” also supported and it cannot be combined with other OWASP top 10 values.
projectId[ID!]Filter vulnerabilities by project.
reportType[VulnerabilityReportType!]Filter vulnerabilities by report type.
scanner[String!]Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId[VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity[VulnerabilitySeverity!]Filter vulnerabilities by severity.
sortVulnerabilitySortList vulnerabilities by sort order.
state[VulnerabilityState!]Filter vulnerabilities by state.
Group.vulnerabilitiesCountByDay

The historical number of vulnerabilities per day for the projects in the group and its subgroups.

Returns VulnerabilitiesCountByDayConnection.

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

Arguments
NameTypeDescription
endDateISO8601Date!Last day for which to fetch vulnerability history.
startDateISO8601Date!First day for which to fetch vulnerability history.
Group.vulnerabilityGrades

Represents vulnerable project counts for each grade.

Returns [VulnerableProjectsByGrade!].

Arguments
NameTypeDescription
includeSubgroupsBooleanInclude grades belonging to subgroups.
letterGradeVulnerabilityGradeFilter the response by given letter grade.
Group.vulnerabilityIdentifierSearch

Search for vulnerabilities by identifier. Feature flag vulnerability_filtering_by_identifier_group has to be enabled for the group.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Returns [String!].

Arguments
NameTypeDescription
nameString!Search identifier by name. Substring or partial match search is supported and argument should be greater than 3 characters.
Group.vulnerabilityManagementPolicies

Vulnerability Management Policies of the project.

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Returns VulnerabilityManagementPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Group.vulnerabilitySeveritiesCount

Counts for each vulnerability severity in the group and its subgroups.

Returns VulnerabilitySeveritiesCount.

Arguments
NameTypeDescription
cappedBooleanDefault value is false. When set to true, the count returned for each severity is capped at a maximum of 1001.
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.
hasAiResolution warning-solidBooleanIntroduced in GitLab 17.5. Status: Experiment. Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution. Requires the vulnerability_report_vr_filter feature flag to be enabled, otherwise the argument is ignored.
hasIssuesBooleanFilter vulnerabilities that do or do not have issues.
hasMergeRequestBooleanFilter vulnerabilities that do or do not have a merge request.
hasRemediationsBooleanFilter vulnerabilities that do or do not have remediations.
hasResolutionBooleanFilter vulnerabilities that do or do not have a resolution.
identifierName warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Filter vulnerabilities by identifier name. Applicable on group level when feature flag vulnerability_filtering_by_identifier_group is enabled. 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.
owaspTopTen[VulnerabilityOwaspTop10!]Filter vulnerabilities by OWASP Top 10 category. Wildcard value “NONE” also supported and it cannot be combined with other OWASP top 10 values.
projectId[ID!]Filter vulnerabilities by project.
reportType[VulnerabilityReportType!]Filter vulnerabilities by report type.
scanner[String!]Filter vulnerabilities by scanner.
scannerId[VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity[VulnerabilitySeverity!]Filter vulnerabilities by severity.
state[VulnerabilityState!]Filter vulnerabilities by state.
Group.workItem

Find a work item by IID directly associated with the group. Returns null if the namespace_level_work_items feature flag is disabled.

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Returns WorkItem.

Arguments
NameTypeDescription
iidString!IID of the work item.
Group.workItemDescriptionTemplates

Work item description templates available to the namespace.

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Returns WorkItemDescriptionTemplateConnection.

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

Arguments
NameTypeDescription
name warning-solidStringDeprecated in GitLab 17.9. name and project ID are both required for fetching, use DescriptionTemplateContentInputType instead.
search warning-solidStringDeprecated in GitLab 17.8. search on template names is performed on the FE only.
Group.workItemStateCounts

Counts of work items by state for the namespace. Returns null if the namespace_level_work_items feature flag is disabled.

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Returns WorkItemStateCountsType.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
excludeProjects warning-solidBooleanIntroduced in GitLab 17.5. Status: Experiment. Exclude work items from projects within the group.
healthStatusHealthStatusFilterHealth status of the work item, “none” and “any” values are supported.
iidStringIID of the work item. For example, “1”.
iids[String!]List of IIDs of work items. For example, ["1", "2"].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorsBooleanInclude work items from ancestor groups.
includeDescendantsBooleanInclude work items from descendant groups and projects.
labelName[String!]Labels applied to the work item.
milestoneTitle[String!]Milestone applied to the work item.
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
requirementLegacyWidget warning-solidRequirementLegacyFilterInputDeprecated in GitLab 15.9. Use work item IID filter instead.
searchStringSearch query for title or description.
sortWorkItemSortSort work items by criteria.
stateIssuableStateCurrent state of the work item.
statusWidgetStatusFilterInputInput for status widget filter. Ignored if work_items_alpha is disabled.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.
weightStringWeight applied to the work item, “none” and “any” values are supported.
Group.workItemTypes

Work item types available to the group.

Returns WorkItemTypeConnection.

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

Arguments
NameTypeDescription
nameIssueTypeFilter work item types by the given name.
Group.workItems

Work items that belong to the namespace.

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Returns WorkItemConnection.

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

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
excludeProjects warning-solidBooleanIntroduced in GitLab 17.5. Status: Experiment. Exclude work items from projects within the group.
healthStatusHealthStatusFilterHealth status of the work item, “none” and “any” values are supported.
iidStringIID of the work item. For example, “1”.
iids[String!]List of IIDs of work items. For example, ["1", "2"].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorsBooleanInclude work items from ancestor groups.
includeDescendantsBooleanInclude work items from descendant groups and projects.
labelName[String!]Labels applied to the work item.
milestoneTitle[String!]Milestone applied to the work item.
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
requirementLegacyWidget warning-solidRequirementLegacyFilterInputDeprecated in GitLab 15.9. Use work item IID filter instead.
searchStringSearch query for title or description.
sortWorkItemSortSort work items by criteria.
stateIssuableStateCurrent state of the work item.
statusWidgetStatusFilterInputInput for status widget filter. Ignored if work_items_alpha is disabled.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.
weightStringWeight applied to the work item, “none” and “any” values are supported.
Group.workspacesClusterAgents

Cluster agents in the namespace with workspaces capabilities.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
filterNamespaceClusterAgentFilter!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

NameTypeDescription
externalStreamingDestinationGroupAuditEventStreamingDestination!Destination to which the filter belongs.
idID!ID of the filter.
namespaceNamespace!Group or project namespace the filter belongs to.

GroupAuditEventStreamingDestination

Represents an external destination to stream group level audit events.

Fields

NameTypeDescription
categoryString!Category of the external destination to send audit events to.
configJSON!Config of the external destination.
eventTypeFilters[String!]!List of event type filters added for streaming.
groupGroup!Group to which the destination belongs.
idID!ID of the destination.
nameString!Name of the external destination to send audit events to.
namespaceFilters[GroupAuditEventNamespaceFilter!]List of subgroup or project filters for the destination.
secretTokenString!Secret token for the destination, will be non-empty value only for http category.

GroupDataTransfer

Fields

NameTypeDescription
egressNodesEgressNodeConnectionData nodes. (see Connections)

GroupMember

Represents a Group Membership.

Fields

NameTypeDescription
accessLevelAccessLevelGitLab::Access level.
createdAtTimeDate and time the membership was created.
createdByUserCoreUser that authorized membership.
expiresAtTimeDate and time the membership expires.
groupGroupGroup that a user is a member of.
idID!ID of the member.
notificationEmailStringGroup notification email for user. Only available for admins.
updatedAtTimeDate and time the membership was last updated.
userUserCoreUser that is associated with the member object.
userPermissionsGroupPermissions!Permissions for the current user on the resource.

Fields with arguments

GroupMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
NameTypeDescription
idMergeRequestID!Global ID of the merge request.

GroupPermissions

Fields

NameTypeDescription
createCustomEmojiBoolean!If true, the user can perform create_custom_emoji on this resource.
createProjectsBoolean!If true, the user can perform create_projects on this resource.
generateDescriptionBoolean!If true, the user can perform generate_description on this resource.
readGroupBoolean!If true, the user can perform read_group on this resource.
removeGroupBoolean!If true, the user can perform remove_group on this resource.
viewEditPageBoolean!If true, the user can perform view_edit_page on this resource.

GroupReleaseStats

Contains release-related statistics about a group.

Fields

NameTypeDescription
releasesCountIntTotal number of releases in all descendant projects of the group.
releasesPercentageIntPercentage of the group’s descendant projects that have at least one release.

GroupSavedReply

Fields

NameTypeDescription
contentString!Content of the saved reply.
idGroupsSavedReplyID!Global ID of the group-level saved reply.
nameString!Name of the saved reply.

GroupSecurityPolicySource

Represents the source of a security policy belonging to a group.

Fields

NameTypeDescription
inheritedBoolean!Indicates whether this policy is inherited from parent group.
namespaceNamespaceProject the policy is associated with.

GroupStats

Contains statistics about a group.

Fields

NameTypeDescription
releaseStatsGroupReleaseStatsStatistics related to releases within the group.

GroupValueStreamAnalyticsFlowMetrics

Exposes aggregated value stream flow metrics.

Fields with arguments

GroupValueStreamAnalyticsFlowMetrics.cycleTime

Median time from first commit to issue closed.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue.
authorUsernameStringUsername of the author of the issue.
epicIdIDID of an epic associated with the issues.
fromTime!Timestamp marking the start date and time.
iterationIdIDID of an iteration associated with the issues.
labelNames[String!]Labels applied to the issue.
milestoneTitleStringMilestone applied to the issue.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
projectIds[ID!]Project IDs within the group hierarchy.
toTime!Timestamp marking the end date and time.
weightIntWeight applied to the issue.
GroupValueStreamAnalyticsFlowMetrics.deploymentCount

Number of production deployments in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
fromTime!Timestamp marking the start date and time.
projectIds[ID!]Project IDs within the group hierarchy.
toTime!Timestamp marking the end date and time.
GroupValueStreamAnalyticsFlowMetrics.issueCount

Number of issues opened in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue.
authorUsernameStringUsername of the author of the issue.
epicIdIDID of an epic associated with the issues.
fromTime!Timestamp marking the start date and time.
iterationIdIDID of an iteration associated with the issues.
labelNames[String!]Labels applied to the issue.
milestoneTitleStringMilestone applied to the issue.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
projectIds[ID!]Project IDs within the group hierarchy.
toTime!Timestamp marking the end date and time.
weightIntWeight applied to the issue.
GroupValueStreamAnalyticsFlowMetrics.issuesCompletedCount

Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue.
authorUsernameStringUsername of the author of the issue.
epicIdIDID of an epic associated with the issues.
fromTime!Timestamp marking the start date and time.
iterationIdIDID of an iteration associated with the issues.
labelNames[String!]Labels applied to the issue.
milestoneTitleStringMilestone applied to the issue.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
projectIds[ID!]Project IDs within the group hierarchy.
toTime!Timestamp marking the end date and time.
weightIntWeight applied to the issue.
GroupValueStreamAnalyticsFlowMetrics.leadTime

Median time from when the issue was created to when it was closed.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue.
authorUsernameStringUsername of the author of the issue.
epicIdIDID of an epic associated with the issues.
fromTime!Timestamp marking the start date and time.
iterationIdIDID of an iteration associated with the issues.
labelNames[String!]Labels applied to the issue.
milestoneTitleStringMilestone applied to the issue.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
projectIds[ID!]Project IDs within the group hierarchy.
toTime!Timestamp marking the end date and time.
weightIntWeight applied to the issue.
GroupValueStreamAnalyticsFlowMetrics.timeToMerge

Median time from merge request creation to merge request merged.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the merge request.
authorUsernameStringUsername of the author of the merge request.
fromTime!Timestamp marking the start date and time.
labelNames[String!]Labels applied to the merge request.
milestoneTitleStringMilestone applied to the merge request.
projectIds[ID!]Project IDs within the group hierarchy.
toTime!Timestamp marking the end date and time.

GroupWikiRepositoryRegistry

Represents the Geo sync and verification state of a group wiki repository.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the GroupWikiRepositoryRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the GroupWikiRepositoryRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
groupWikiRepositoryIdID!ID of the Group Wiki Repository.
idID!ID of the GroupWikiRepositoryRegistry.
lastSyncFailureStringError message during sync of the GroupWikiRepositoryRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the GroupWikiRepositoryRegistry.
missingOnPrimaryBooleanIndicate if the GroupWikiRepositoryRegistry is missing on primary.
modelRecordIdIntID of the GroupWikiRepositoryRegistry’s model record.
retryAtTimeTimestamp after which the GroupWikiRepositoryRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the GroupWikiRepositoryRegistry.
stateRegistryStateSync state of the GroupWikiRepositoryRegistry.
verificationChecksumStringThe local checksum of the GroupWikiRepositoryRegistry.
verificationChecksumMismatchedStringThe expected checksum of the GroupWikiRepositoryRegistry in case of mismatch.
verificationFailureStringError message during verification of the GroupWikiRepositoryRegistry.
verificationRetryAtTimeTimestamp after which the GroupWikiRepositoryRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the GroupWikiRepositoryRegistry.
verificationStartedAtTimeTimestamp when the verification of GroupWikiRepositoryRegistry started.
verificationStateVerificationStateEnumVerification state of the GroupWikiRepositoryRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the GroupWikiRepositoryRegistry.

Groups

Fields

NameTypeDescription
commitCommit!Commit responsible for specified group.
commitDataCommitDataHTML data derived from commit needed to present blame.
linenoInt!Starting line number for the commit group.
lines[String!]!Array of lines added for the commit group.
spanInt!Number of contiguous lines which the blame spans for the commit group.

HelmFileMetadata

Helm file metadata.

Fields

NameTypeDescription
channelString!Channel of the Helm chart.
createdAtTime!Date of creation.
metadataPackageHelmMetadataType!Metadata of the Helm chart.
updatedAtTime!Date of most recent update.

Ide

IDE settings and feature flags.

Fields

NameTypeDescription
codeSuggestionsEnabledBoolean!Indicates whether AI assisted code suggestions are enabled.

ImagePullSecrets

Fields

NameTypeDescription
nameString!Name of the Kubernetes image pull secret.
namespaceString!Namespace of the kubernetes image pull secret.

ImportSourceUser

Fields

NameTypeDescription
idImportSourceUserID!Global ID of the mapping of a user on source instance to a user on destination instance.
importTypeImportSource!Name of the importer.
placeholderUserUserCorePlaceholder user associated with the import source user.
reassignToUserUserCoreUser that contributions are reassigned to.
reassignedByUserUserCoreUser that did the reassignment.
reassignmentErrorStringError message if reassignment failed.
sourceHostnameString!Source instance hostname.
sourceNameStringName of user in the source instance.
sourceUserIdentifierString!ID of the user in the source instance.
sourceUsernameStringUsername of user in the source instance.
statusImportSourceUserStatus!Status of the mapping.

IncidentManagementOncallRotation

Describes an incident management on-call rotation.

Fields

NameTypeDescription
activePeriodOncallRotationActivePeriodTypeActive period for the on-call rotation.
endsAtTimeEnd date and time of the on-call rotation.
idIncidentManagementOncallRotationID!ID of the on-call rotation.
lengthIntLength of the on-call schedule, in the units specified by lengthUnit.
lengthUnitOncallRotationUnitEnumUnit of the on-call rotation length.
nameString!Name of the on-call rotation.
participantsOncallParticipantTypeConnectionParticipants of the on-call rotation. (see Connections)
startsAtTimeStart date of the on-call rotation.

Fields with arguments

IncidentManagementOncallRotation.shifts

Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month.

Returns IncidentManagementOncallShiftConnection.

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

Arguments
NameTypeDescription
endTimeTime!End of timeframe to include shifts for. Cannot exceed one month after start.
startTimeTime!Start of timeframe to include shifts for.

IncidentManagementOncallSchedule

Describes an incident management on-call schedule.

Fields

NameTypeDescription
descriptionStringDescription of the on-call schedule.
iidString!Internal ID of the on-call schedule.
nameString!Name of the on-call schedule.
oncallUsers[UserCore!]
rotationsIncidentManagementOncallRotationConnection!On-call rotations for the on-call schedule. (see Connections)
timezoneString!Time zone of the on-call schedule.

Fields with arguments

IncidentManagementOncallSchedule.rotation

On-call rotation for the on-call schedule.

Returns IncidentManagementOncallRotation.

Arguments
NameTypeDescription
idIncidentManagementOncallRotationID!ID of the on-call rotation.

IncidentManagementOncallShift

A block of time for which a participant is on-call.

Fields

NameTypeDescription
endsAtTimeEnd time of the on-call shift.
participantOncallParticipantTypeParticipant assigned to the on-call shift.
startsAtTimeStart time of the on-call shift.

InheritedCiVariable

CI/CD variables a project inherites from its parent group and ancestors.

Fields

NameTypeDescription
descriptionStringDescription of the variable.
environmentScopeStringScope defining the environments that can use the variable.
groupCiCdSettingsPathStringIndicates the path to the CI/CD settings of the group the variable belongs to.
groupNameStringIndicates group the variable belongs to.
hiddenBooleanIndicates whether the variable is hidden.
idID!ID of the variable.
keyStringName of the variable.
maskedBooleanIndicates whether the variable is masked.
protectedBooleanIndicates whether the variable is protected.
rawBooleanIndicates whether the variable is raw.
variableTypeCiVariableTypeType of the variable.

InstanceAmazonS3ConfigurationType

Stores instance level Amazon S3 configurations for audit event streaming.

Fields

NameTypeDescription
accessKeyXidString!Access key ID of the Amazon S3 account.
awsRegionString!AWS region where the bucket is created.
bucketNameString!Name of the bucket where the audit events would be logged.
idID!ID of the configuration.
nameString!Name of the external destination to send audit events to.

InstanceAuditEventNamespaceFilter

Represents a subgroup or project filter that belongs to an instance level external audit event streaming destination.

Fields

NameTypeDescription
externalStreamingDestinationInstanceAuditEventStreamingDestination!Destination to which the filter belongs.
idID!ID of the filter.
namespaceNamespace!Group or project namespace the filter belongs to.

InstanceAuditEventStreamingDestination

Represents an external destination to stream instance level audit events.

Fields

NameTypeDescription
categoryString!Category of the external destination to send audit events to.
configJSON!Config of the external destination.
eventTypeFilters[String!]!List of event type filters added for streaming.
idID!ID of the destination.
nameString!Name of the external destination to send audit events to.
namespaceFilters[InstanceAuditEventNamespaceFilter!]List of subgroup or project filters for the destination.
secretTokenString!Secret token for the destination, will be non-empty value only for http category.

InstanceExternalAuditEventDestination

Represents an external resource to send instance audit events to.

Fields

NameTypeDescription
destinationUrlString!External destination to send audit events to.
eventTypeFilters[String!]!List of event type filters added for streaming.
headersAuditEventsStreamingInstanceHeaderConnection!List of additional HTTP headers sent with each event. (see Connections)
idID!ID of the destination.
nameString!Name of the external destination to send audit events to.
verificationTokenString!Verification token to validate source of event.

InstanceGoogleCloudLoggingConfigurationType

Stores instance level Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Fields

NameTypeDescription
clientEmailString!Client email.
googleProjectIdNameString!Google project ID.
idID!ID of the configuration.
logIdNameString!Log ID.
nameString!Name of the external destination to send audit events to.

InstanceSecurityDashboard

Fields

NameTypeDescription
vulnerabilityScannersVulnerabilityScannerConnectionVulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. (see Connections)

Fields with arguments

InstanceSecurityDashboard.clusterAgents

Cluster agents associated with projects selected in the Instance Security Dashboard.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
hasRemoteDevelopmentAgentConfig warning-solidBooleanDeprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabledBooleanReturns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilitiesBooleanReturns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfigBooleanReturns only cluster agents which have an associated workspaces agent config.
InstanceSecurityDashboard.projects

Projects selected in Instance Security Dashboard.

Returns ProjectConnection!.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the project name, a path, or a description.
InstanceSecurityDashboard.vulnerabilityGrades

Represents vulnerable project counts for each grade.

Returns [VulnerableProjectsByGrade!]!.

Arguments
NameTypeDescription
letterGradeVulnerabilityGradeFilter the response by given letter grade.
InstanceSecurityDashboard.vulnerabilitySeveritiesCount

Counts for each vulnerability severity from projects selected in Instance Security Dashboard.

Returns VulnerabilitySeveritiesCount.

Arguments
NameTypeDescription
cappedBooleanDefault value is false. When set to true, the count returned for each severity is capped at a maximum of 1001.
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.
hasAiResolution warning-solidBooleanIntroduced in GitLab 17.5. Status: Experiment. Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution. Requires the vulnerability_report_vr_filter feature flag to be enabled, otherwise the argument is ignored.
hasIssuesBooleanFilter vulnerabilities that do or do not have issues.
hasMergeRequestBooleanFilter vulnerabilities that do or do not have a merge request.
hasRemediationsBooleanFilter vulnerabilities that do or do not have remediations.
hasResolutionBooleanFilter vulnerabilities that do or do not have a resolution.
identifierName warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Filter vulnerabilities by identifier name. Applicable on group level when feature flag vulnerability_filtering_by_identifier_group is enabled. 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.
owaspTopTen[VulnerabilityOwaspTop10!]Filter vulnerabilities by OWASP Top 10 category. Wildcard value “NONE” also supported and it cannot be combined with other OWASP top 10 values.
projectId[ID!]Filter vulnerabilities by project.
reportType[VulnerabilityReportType!]Filter vulnerabilities by report type.
scanner[String!]Filter vulnerabilities by scanner.
scannerId[VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity[VulnerabilitySeverity!]Filter vulnerabilities by severity.
state[VulnerabilityState!]Filter vulnerabilities by state.

IntegerExpression

An expression with an integer value.

Fields

NameTypeDescription
fieldString!Field the expression applies to.
operatorString!Operator of the expression.
valueInt!Integer value of the expression.

IntegrationExclusion

An integration to override the level settings of instance specific integrations.

Fields

NameTypeDescription
groupGroupGroup that has been excluded from the instance specific integration.
projectProjectProject that has been excluded from the instance specific integration.

Describes an issuable resource link for incident issues.

Fields

NameTypeDescription
idIncidentManagementIssuableResourceLinkID!ID of the Issuable resource link.
issueIssue!Incident of the resource link.
linkString!Web Link to the resource.
linkTextStringOptional text for the link.
linkTypeIssuableResourceLinkType!Type of the resource link.

Issue

Fields

NameTypeDescription
alertManagementAlert warning-solidAlertManagementAlertDeprecated in GitLab 15.6. Use alert_management_alerts.
assigneesUserCoreConnectionAssignees of the issue. (see Connections)
authorUserCore!User that created the issue.
blockedBoolean!Indicates the issue is blocked.
blockedByCountIntCount of issues blocking this issue.
blockedByIssuesIssueConnectionIssues blocking this issue. (see Connections)
blockingCountInt!Count of issues this issue is blocking.
closedAsDuplicateOfIssueIssue this issue was closed as a duplicate of.
closedAtTimeTimestamp of when the issue was closed.
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
confidentialBoolean!Indicates the issue is confidential.
createNoteEmailStringUser specific email address for the issue.
createdAtTime!Timestamp of when the issue was created.
customerRelationsContactsCustomerRelationsContactConnectionCustomer relations contacts of the issue. (see Connections)
descriptionStringDescription of the issue.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
designCollectionDesignCollectionCollection of design images associated with this issue.
discussionLockedBoolean!Indicates discussion is locked on the issue.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
downvotesInt!Number of downvotes the issue has received.
dueDateTimeDue date of the issue.
emailsDisabled warning-solidBoolean!Deprecated in GitLab 16.3. Use emails_enabled.
emailsEnabledBoolean!Indicates if the parent project or group has email notifications disabled: false if email notifications are disabled.
epic warning-solidEpicDeprecated in GitLab 17.5. Replaced by WorkItem type.
escalationPolicyEscalationPolicyTypeEscalation policy associated with the issue. Available for issues which support escalation.
escalationStatusIssueEscalationStatusEscalation status of the issue.
externalAuthorStringEmail address of non-GitLab user reporting the issue. For guests, the email address is obfuscated.
hasEpicBoolean!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 warning-solidBoolean!Introduced in GitLab 16.5. Status: Experiment. Indicates if the issue has a parent work item.
healthStatusHealthStatusCurrent health status.
hiddenBooleanIndicates the issue is hidden because the author has been banned.
humanTimeEstimateStringHuman-readable time estimate of the issue.
humanTotalTimeSpentStringHuman-readable total time reported as spent on the issue.
idID!ID of the issue.
iidString!Internal ID of the issue.
iterationIterationIteration of the issue.
labelsLabelConnectionLabels of the issue. (see Connections)
mergeRequestsCountInt!Number of merge requests that close the issue on merge.
metricImages[MetricImage!]Metric images associated to the issue.
milestoneMilestoneMilestone of the issue.
movedBooleanIndicates if issue got moved from other project.
movedToIssueUpdated Issue after it got moved to another project.
nameStringName or title of this object.
participantsUserCoreConnectionList of participants in the issue. (see Connections)
projectIdIntID of the issue project.
relatedMergeRequestsMergeRequestConnectionMerge requests related to the issue. This field can only be resolved for one issue in any single request. (see Connections)
relatedVulnerabilitiesVulnerabilityConnectionRelated vulnerabilities of the issue. (see Connections)
relativePositionIntRelative position of the issue (used for positioning in epic tree and issue boards).
severityIssuableSeveritySeverity level of the incident.
slaDueAtTimeTimestamp of when the issue SLA expires.
stateIssueState!State of the issue.
statusPagePublishedIncidentBooleanIndicates whether an issue is published to the status page.
subscribedBoolean!Indicates the currently logged in user is subscribed to the issue.
taskCompletionStatusTaskCompletionStatus!Task completion status of the issue.
timeEstimateInt!Time estimate of the issue.
timelogsTimelogConnection!Timelogs on the issue. (see Connections)
titleString!Title of the issue.
titleHtmlStringGitLab Flavored Markdown rendering of title.
totalTimeSpentInt!Total time (in seconds) reported as spent on the issue.
typeIssueTypeType of the issue.
updatedAtTime!Timestamp of when the issue was last updated.
updatedByUserCoreUser that last updated the issue.
upvotesInt!Number of upvotes the issue has received.
userDiscussionsCountInt!Number of user discussions in the issue.
userNotesCountInt!Number of user notes of the issue.
userPermissionsIssuePermissions!Permissions for the current user on the resource.
webPathString!Web path of the issue.
webUrlString!Web URL of the issue.
weightIntWeight of the issue.

Fields with arguments

Issue.alertManagementAlerts

Alert Management alerts associated to this issue.

Returns AlertManagementAlertConnection.

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

Arguments
NameTypeDescription
assigneeUsernameStringUsername of a user assigned to the issue.
domainAlertManagementDomainFilter!Filter query for given domain.
iidStringIID of the alert. For example, “1”.
searchStringSearch query for title, description, service, or monitoring_tool.
sortAlertManagementAlertSortSort alerts by the criteria.
statuses[AlertManagementStatus!]Alerts with the specified statues. For example, [TRIGGERED].
Issue.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
stateTodoStateEnumState of the to-do items.

Issuable resource links of the incident issue.

Returns IssuableResourceLinkConnection.

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

Arguments
NameTypeDescription
incidentIdIssueID!ID of the incident.
Issue.linkedWorkItems

Work items linked to the issue.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Returns LinkedWorkItemTypeConnection.

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

Arguments
NameTypeDescription
filterWorkItemRelatedLinkTypeFilter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
Issue.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
Issue.reference

Internal reference of the issue. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
fullBooleanBoolean option specifying whether the reference should be returned in full.

IssuePermissions

Check permissions for the current user on a issue.

Fields

NameTypeDescription
adminIssueBoolean!If true, the user can perform admin_issue on this resource.
adminIssueRelationBoolean!If true, the user can perform admin_issue_relation on this resource.
cloneIssueBoolean!If true, the user can perform clone_issue on this resource.
createDesignBoolean!If true, the user can perform create_design on this resource.
createNoteBoolean!If true, the user can perform create_note on this resource.
destroyDesignBoolean!If true, the user can perform destroy_design on this resource.
moveDesignBoolean!If true, the user can perform move_design on this resource.
moveIssueBoolean!If true, the user can perform move_issue on this resource.
readDesignBoolean!If true, the user can perform read_design on this resource.
readIssueBoolean!If true, the user can perform read_issue on this resource.
reopenIssueBoolean!If true, the user can perform reopen_issue on this resource.
updateDesignBoolean!If true, the user can perform update_design on this resource.
updateIssueBoolean!If true, the user can perform update_issue on this resource.

IssueStatusCountsType

Represents total number of issues for the represented statuses.

Fields

NameTypeDescription
allIntNumber of issues with status ALL for the project.
closedIntNumber of issues with status CLOSED for the project.
openedIntNumber of issues with status OPENED for the project.

Iteration

Represents an iteration object.

Fields

NameTypeDescription
createdAtTime!Timestamp of iteration creation.
descriptionStringDescription of the iteration.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
dueDateTimeTimestamp of the iteration due date.
idID!ID of the iteration.
iidString!Internal ID of the iteration.
iterationCadenceIterationCadence!Cadence of the iteration.
scopedPathStringWeb path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.
scopedUrlStringWeb URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.
sequenceInt!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.
startDateTimeTimestamp of the iteration start date.
stateIterationState!State of the iteration.
titleStringTitle of the iteration.
updatedAtTime!Timestamp of last iteration update.
webPathString!Web path of the iteration.
webUrlString!Web URL of the iteration.

Fields with arguments

Iteration.report

Historically accurate report about the timebox.

Returns TimeboxReport.

Arguments
NameTypeDescription
fullPathStringFull path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

IterationCadence

Represents an iteration cadence.

Fields

NameTypeDescription
activeBooleanWhether the iteration cadence is active.
automaticBooleanWhether the iteration cadence should automatically generate upcoming iterations.
descriptionStringDescription of the iteration cadence. Maximum length is 5000 characters.
durationInWeeksIntDuration in weeks of the iterations within this cadence.
idIterationsCadenceID!Global ID of the iteration cadence.
iterationsInAdvanceIntUpcoming iterations to be created when iteration cadence is set to automatic.
rollOverBoolean!Whether the iteration cadence should roll over issues to the next iteration or not.
startDateTimeTimestamp of the automation start date.
titleString!Title of the iteration cadence.

JiraImport

Fields

NameTypeDescription
createdAtTimeTimestamp of when the Jira import was created.
failedToImportCountInt!Count of issues that failed to import.
importedIssuesCountInt!Count of issues that were successfully imported.
jiraProjectKeyString!Project key for the imported Jira project.
scheduledAtTimeTimestamp of when the Jira import was scheduled.
scheduledByUserCoreUser that started the Jira import.
totalIssueCountInt!Total count of issues that were attempted to import.

JiraProject

Fields

NameTypeDescription
keyString!Key of the Jira project.
nameStringName of the Jira project.
projectIdInt!ID of the Jira project.

JiraService

Fields

NameTypeDescription
activeBooleanIndicates if the service is active.
serviceTypeServiceTypeType of the service.
typeStringClass name of the service.

Fields with arguments

JiraService.projects

List of all Jira projects fetched through Jira REST API.

Returns JiraProjectConnection.

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

Arguments
NameTypeDescription
nameStringProject name or key.

JiraUser

Fields

NameTypeDescription
gitlabIdIntID of the matched GitLab user.
gitlabNameStringName of the matched GitLab user.
gitlabUsernameStringUsername of the matched GitLab user.
jiraAccountIdString!Account ID of the Jira user.
jiraDisplayNameString!Display name of the Jira user.
jiraEmailStringEmail of the Jira user, returned only for users with public emails.

JobArtifactRegistry

Represents the Geo replication and verification state of a job_artifact.

Fields

NameTypeDescription
artifactIdID!ID of the Job Artifact.
checksumMismatchBooleanIndicate if the checksums of the JobArtifactRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the JobArtifactRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the JobArtifactRegistry.
lastSyncFailureStringError message during sync of the JobArtifactRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the JobArtifactRegistry.
missingOnPrimaryBooleanIndicate if the JobArtifactRegistry is missing on primary.
modelRecordIdIntID of the JobArtifactRegistry’s model record.
retryAtTimeTimestamp after which the JobArtifactRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the JobArtifactRegistry.
stateRegistryStateSync state of the JobArtifactRegistry.
verificationChecksumStringThe local checksum of the JobArtifactRegistry.
verificationChecksumMismatchedStringThe expected checksum of the JobArtifactRegistry in case of mismatch.
verificationFailureStringError message during verification of the JobArtifactRegistry.
verificationRetryAtTimeTimestamp after which the JobArtifactRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the JobArtifactRegistry.
verificationStartedAtTimeTimestamp when the verification of JobArtifactRegistry started.
verificationStateVerificationStateEnumVerification state of the JobArtifactRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the JobArtifactRegistry.

JobPermissions

Fields

NameTypeDescription
cancelBuildBoolean!If true, the user can perform cancel_build on this resource.
readBuildBoolean!If true, the user can perform read_build on this resource.
readJobArtifactsBoolean!If true, the user can perform read_job_artifacts on this resource.
updateBuildBoolean!If true, the user can perform update_build on this resource.

Kas

Fields

NameTypeDescription
enabledBoolean!Indicates whether the Kubernetes agent server is enabled.
externalK8sProxyUrlStringURL used by the Kubernetes tooling to communicate with the KAS Kubernetes API proxy.
externalUrlStringURL used by the agents to communicate with the server.
versionStringKAS version.

Key

Represents an SSH key.

Fields

NameTypeDescription
createdAtTime!Timestamp of when the key was created.
expiresAtTime!Timestamp of when the key expires. It’s null if it never expires.
idID!ID of the key.
keyString!Public key of the key pair.
nameStringName or title of this object.
titleString!Title of the key.
webUrlStringURL of this object.

KubernetesAnnotation

Annotation to apply to associated Kubernetes objects of a workspace.

Fields

NameTypeDescription
keyString!Key of the annotation.
valueString!Value of the annotation.

KubernetesLabel

Label to apply to associated Kubernetes objects of a workspace.

Fields

NameTypeDescription
keyString!Key of the label.
valueString!Value of the label.

Label

Fields

NameTypeDescription
colorString!Background color of the label.
createdAtTime!When the label was created.
descriptionStringDescription of the label (Markdown rendered as HTML for caching).
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
idLabelID!Global ID of the label.
lockOnMergeBoolean!Indicates this label is locked for merge requests that have been merged.
textColorString!Text color of the label.
titleString!Content of the label.
updatedAtTime!When the label was last updated.

LfsObjectRegistry

Represents the Geo sync and verification state of an LFS object.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the LfsObjectRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the LfsObjectRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the LfsObjectRegistry.
lastSyncFailureStringError message during sync of the LfsObjectRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the LfsObjectRegistry.
lfsObjectIdID!ID of the LFS object.
missingOnPrimaryBooleanIndicate if the LfsObjectRegistry is missing on primary.
modelRecordIdIntID of the LfsObjectRegistry’s model record.
retryAtTimeTimestamp after which the LfsObjectRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the LfsObjectRegistry.
stateRegistryStateSync state of the LfsObjectRegistry.
verificationChecksumStringThe local checksum of the LfsObjectRegistry.
verificationChecksumMismatchedStringThe expected checksum of the LfsObjectRegistry in case of mismatch.
verificationFailureStringError message during verification of the LfsObjectRegistry.
verificationRetryAtTimeTimestamp after which the LfsObjectRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the LfsObjectRegistry.
verificationStartedAtTimeTimestamp when the verification of LfsObjectRegistry started.
verificationStateVerificationStateEnumVerification state of the LfsObjectRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the LfsObjectRegistry.

License

Fields

NameTypeDescription
nameString!Name of the license.
spdxIdentifierStringName of the SPDX identifier.
urlStringLicense URL in relation to SPDX.

LicenseHistoryEntry

Represents an entry from the Cloud License history.

Fields

NameTypeDescription
activatedAtDateDate when the license was activated.
blockChangesAtDateDate, including grace period, when licensed features will be blocked.
companyStringCompany of the licensee.
createdAtDateDate when the license was added.
emailStringEmail of the licensee.
expiresAtDateDate when the license expires.
idID!ID of the license extracted from the license data.
nameStringName of the licensee.
planString!Name of the subscription plan.
startsAtDateDate when the license started.
typeString!Type of the license.
usersInLicenseCountIntNumber of paid users in the license.

LinkedWorkItemType

Fields

NameTypeDescription
linkCreatedAtTime!Timestamp the link was created.
linkIdWorkItemsRelatedWorkItemLinkID!Global ID of the link.
linkTypeString!Type of link.
linkUpdatedAtTime!Timestamp the link was updated.
workItemWorkItemLinked work item.
workItemStateWorkItemState!State of the linked work item.

Location

Fields

NameTypeDescription
blobPathStringHTTP URI path to view the input file in GitLab.
pathStringPath, relative to the root of the repository, of the filewhich was analyzed to detect the dependency.
topLevelBooleanIs top level dependency.

Represents links to perform actions on the candidate.

Fields

NameTypeDescription
artifactPathStringPath to the artifact.
showPathStringPath to the details page of the candidate.

Represents links to perform actions on the model.

Fields

NameTypeDescription
showPathStringPath to the details page of the model.

Represents links to perform actions on the model version.

Fields

NameTypeDescription
importPathStringFile upload path for the machine learning model.
packagePathStringPath to the package of the model version.
showPathStringPath to the details page of the model version.

MavenMetadata

Maven metadata.

Fields

NameTypeDescription
appGroupString!App group of the Maven package.
appNameString!App name of the Maven package.
appVersionStringApp version of the Maven package.
createdAtTime!Date of creation.
idPackagesMavenMetadatumID!ID of the metadatum.
pathString!Path of the Maven package.
updatedAtTime!Date of most recent update.

MemberApproval

Represents a Member Approval queued for role promotion.

Fields

NameTypeDescription
createdAtTimeTimestamp when the member approval was created.
memberMemberInterfaceMember associated with the member approval object.
memberRoleIdIDID of the member role.
newAccessLevelAccessLevelNew GitLab::Access level requested for the member.
oldAccessLevelAccessLevelExisting GitLab::Access level for the member.
requestedByUserCoreUser who requested the member promotion.
reviewedByUserCoreUser who reviewed the member promotion.
statusStringStatus for the member approval request (approved, denied, pending).
updatedAtTimeTimestamp when the member approval was last updated.
userUserCoreUser that is associated with the member approval object.

MemberRole

Represents a member role.

Fields

NameTypeDescription
baseAccessLevel warning-solidAccessLevel!Introduced in GitLab 16.5. Status: Experiment. Base access level for the custom role.
createdAtTime!Timestamp of when the member role was created.
dependentSecurityPolicies[ApprovalPolicy!]Array of security policies dependent on the custom role.
descriptionStringRole description.
detailsPath warning-solidStringIntroduced in GitLab 17.4. Status: Experiment. URL path to the role details webpage.
editPath warning-solidString!Introduced in GitLab 16.11. Status: Experiment. Web UI path to edit the custom role.
enabledPermissions warning-solidCustomizableStandardPermissionConnection!Introduced in GitLab 16.5. Status: Experiment. Array of all permissions enabled for the custom role.
idID!Role ID.
membersCount warning-solidIntIntroduced in GitLab 17.3. Status: Experiment. Number of times the role has been directly assigned to a group or project member.
nameStringRole name.
usersCount warning-solidIntIntroduced in GitLab 17.5. Status: Experiment. Number of users who have been directly assigned the role in at least one group or project.

MergeAccessLevel

Defines which user roles, users, or groups can merge into a protected branch.

Fields

NameTypeDescription
accessLevelInt!GitLab::Access level.
accessLevelDescriptionString!Human readable representation for the access level.
groupAccessLevelGroupGroup associated with this access level.
userAccessLevelUserUser associated with this access level.

MergeRequest

Fields

NameTypeDescription
allowCollaborationBooleanIndicates if members of the target project can push to the fork.
allowsMultipleAssigneesBoolean!Allows assigning multiple users to a merge request.
allowsMultipleReviewersBoolean!Allows assigning multiple reviewers to a merge request.
approvalStateMergeRequestApprovalState!Information relating to rules that must be satisfied to merge the merge request.
approvalsLeftIntNumber of approvals left.
approvalsRequiredIntNumber of approvals required.
approvedBoolean!Indicates if the merge request has all the required approvals.
approvedByUserCoreConnectionUsers who approved the merge request. (see Connections)
assigneesMergeRequestAssigneeConnectionAssignees of the merge request. (see Connections)
authorMergeRequestAuthorUser who created this merge request.
autoMergeEnabledBoolean!Indicates if auto merge is enabled for the merge request.
autoMergeStrategyStringSelected auto merge strategy.
availableAutoMergeStrategies[String!]Array of available auto merge strategies.
awardEmojiAwardEmojiConnectionList of emoji reactions associated with the merge request. (see Connections)
blockingMergeRequests warning-solidBlockingMergeRequestsIntroduced in GitLab 16.5. Status: Experiment. Merge requests that block another merge request from merging.
changeRequestersUserCoreConnectionUsers that have requested changes to the merge request. (see Connections)
closedAtTimeTimestamp of when the merge request was closed, null if not closed.
codequalityReportsComparerCodequalityReportsComparerCode quality reports comparison reported on the merge request.
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
commitCountIntNumber of commits in the merge request.
commitsCommitConnectionMerge request commits. (see Connections)
commitsWithoutMergeCommitsCommitConnectionMerge request commits excluding merge commits. (see Connections)
committersUserCoreConnectionUsers who have added commits to the merge request. (see Connections)
conflictsBoolean!Indicates if the merge request has conflicts.
createdAtTime!Timestamp of when the merge request was created.
defaultMergeCommitMessageStringDefault merge commit message of the merge request.
defaultSquashCommitMessageStringDefault squash commit message of the merge request.
descriptionStringDescription of the merge request (Markdown rendered as HTML for caching).
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
detailedMergeStatusDetailedMergeStatusDetailed merge status of the merge request.
diffHeadShaStringDiff head SHA of the merge request.
diffRefsDiffRefsReferences of the base SHA, the head SHA, and the start SHA for this merge request.
diffStatsSummaryDiffStatsSummarySummary of which files were changed in this merge request.
discussionLockedBoolean!Indicates if comments on the merge request are locked to members only.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
divergedFromTargetBranchBoolean!Indicates if the source branch is behind the target branch.
downvotesInt!Number of downvotes for the merge request.
draftBoolean!Indicates if the merge request is a draft.
forceRemoveSourceBranchBooleanIndicates if the project settings will lead to source branch deletion after merge.
hasCiBoolean!Indicates if the merge request has CI.
hasSecurityReportsBoolean!Indicates if the source branch has any security reports.
headPipelinePipelinePipeline running on the branch HEAD of the merge request.
hiddenBooleanIndicates the merge request is hidden because the author has been banned.
humanTimeEstimateStringHuman-readable time estimate of the merge request.
humanTotalTimeSpentStringHuman-readable total time reported as spent on the merge request.
idID!ID of the merge request.
iidString!Internal ID of the merge request.
inProgressMergeCommitShaStringCommit SHA of the merge request if merge is in progress.
labelsLabelConnectionLabels of the merge request. (see Connections)
mergeAfterTimeDate after which the merge request can be merged.
mergeCommitShaStringSHA of the merge request commit (set once merged).
mergeErrorStringError message due to a merge error.
mergeOngoingBoolean!Indicates if a merge is currently occurring.
mergeRequestDiffs warning-solidMergeRequestDiffConnectionIntroduced in GitLab 16.2. Status: Experiment. Diff versions of a merge request.
mergeStatus warning-solidStringDeprecated in GitLab 14.0. This was renamed. Use: MergeRequest.mergeStatusEnum.
mergeStatusEnumMergeStatusMerge status of the merge request.
mergeTrainCar warning-solidMergeTrainCarIntroduced in GitLab 17.2. Status: Experiment. Represents the merge request in a merge train.
mergeTrainIndex warning-solidIntDeprecated in GitLab 17.4. Use index on MergeTrains::CarType instead.
mergeTrainsCount warning-solidIntDeprecated in GitLab 17.4. Use count from cars connection on MergeTrains::TrainType instead.
mergeUserUserCoreUser who merged this merge request or set it to auto-merge.
mergeWhenPipelineSucceedsBooleanIndicates if the merge has been set to auto-merge.
mergeabilityChecks warning-solid[MergeRequestMergeabilityCheck!]!Introduced in GitLab 16.5. Status: Experiment. Status of all mergeability checks of the merge request.
mergeableBoolean!Indicates if the merge request is mergeable.
mergeableDiscussionsStateBooleanIndicates if all discussions in the merge request have been resolved, allowing the merge request to be merged.
mergedAtTimeTimestamp of when the merge request was merged, null if not merged.
milestoneMilestoneMilestone of the merge request.
nameStringName or title of this object.
participantsMergeRequestParticipantConnectionParticipants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. (see Connections)
policiesOverridingApprovalSettings[PolicyApprovalSettingsOverride!]Approval settings that are overridden by the policies for the merge request.
policyViolationsPolicyViolationDetailsPolicy violations reported on the merge request.
preparedAtTimeTimestamp of when the merge request was prepared.
projectProject!Alias for target_project.
projectIdInt!ID of the merge request project.
rebaseCommitShaStringRebase commit SHA of the merge request.
rebaseInProgressBoolean!Indicates if there is a rebase currently in progress for the merge request.
resolvableDiscussionsCountIntNumber of user discussions that are resolvable in the merge request.
resolvedDiscussionsCountIntNumber of user discussions that are resolved in the merge request.
retargetedBooleanIndicates if merge request was retargeted.
reviewersMergeRequestReviewerConnectionUsers from whom a review has been requested. (see Connections)
securityAutoFix warning-solidBooleanDeprecated in GitLab 16.11. Security Auto Fix experiment feature was removed. It was always hidden behind security_auto_fix feature flag.
securityReportsUpToDateOnTargetBranchBoolean!Indicates if the target branch security reports are out of date.
shouldBeRebasedBoolean!Indicates if the merge request will be rebased.
shouldRemoveSourceBranchBooleanIndicates if the source branch of the merge request will be deleted after merge.
sourceBranchString!Source branch of the merge request.
sourceBranchExistsBoolean!Indicates if the source branch of the merge request exists.
sourceBranchProtectedBoolean!Indicates if the source branch is protected.
sourceProjectProjectSource project of the merge request.
sourceProjectIdIntID of the merge request source project.
squashBoolean!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.
squashOnMergeBoolean!Indicates if the merge request will be squashed when merged.
stateMergeRequestState!State of the merge request.
subscribedBoolean!Indicates if the currently logged in user is subscribed to this merge request.
suggestedReviewersSuggestedReviewersTypeSuggested reviewers for merge request.
supportsLockOnMergeBoolean!Indicates if the merge request supports locked labels.
targetBranchString!Target branch of the merge request.
targetBranchExistsBoolean!Indicates if the target branch of the merge request exists.
targetBranchPathStringPath to the target branch of the merge request.
targetProjectProject!Target project of the merge request.
targetProjectIdInt!ID of the merge request target project.
taskCompletionStatusTaskCompletionStatus!Completion status of tasks.
timeEstimateInt!Time estimate of the merge request.
timelogsTimelogConnection!Timelogs on the merge request. (see Connections)
titleString!Title of the merge request.
titleHtmlStringGitLab Flavored Markdown rendering of title.
totalTimeSpentInt!Total time (in seconds) reported as spent on the merge request.
updatedAtTime!Timestamp of when the merge request was last updated.
upvotesInt!Number of upvotes for the merge request.
userDiscussionsCountIntNumber of user discussions in the merge request.
userNotesCountIntUser notes count of the merge request.
userPermissionsMergeRequestPermissions!Permissions for the current user on the resource.
webPathString!Web path of the merge request.
webUrlStringWeb URL of the merge request.

Fields with arguments

MergeRequest.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
stateTodoStateEnumState of the to-do items.
MergeRequest.diffStats

Details about which files were changed in this merge request.

Returns [DiffStats!].

Arguments
NameTypeDescription
pathStringSpecific file path.
MergeRequest.findingReportsComparer

Vulnerability finding reports comparison reported on the merge request.

  • Introduced in GitLab 16.1.
  • Status: Experiment.

Returns FindingReportsComparer.

Arguments
NameTypeDescription
reportTypeComparableSecurityReportType!Filter vulnerability findings by report type.
MergeRequest.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
MergeRequest.pipelines

Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned.

Returns PipelineConnection.

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

Arguments
NameTypeDescription
refStringFilter pipelines by the ref they are run for.
scopePipelineScopeEnumFilter pipelines by scope.
shaStringFilter pipelines by the sha of the commit they are run for.
sourceStringFilter pipelines by their source.
statusPipelineStatusEnumFilter pipelines by their status.
updatedAfterTimePipelines updated after the date.
updatedBeforeTimePipelines updated before the date.
usernameStringFilter pipelines by the user that triggered the pipeline.
MergeRequest.reference

Internal reference of the merge request. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
fullBooleanBoolean option specifying whether the reference should be returned in full.

MergeRequestApprovalState

Information relating to rules that must be satisfied to merge this merge request.

Fields

NameTypeDescription
approvalRulesOverwrittenBooleanIndicates 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.
suggestedApproversUserCoreConnectionList of suggested approvers. (see Connections)

MergeRequestAssignee

A user assigned to a merge request.

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
mergeRequestInteractionUserMergeRequestInteractionDetails of this user’s interactions with the merge request.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Fields with arguments

MergeRequestAssignee.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestAssignee.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestAssignee.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
MergeRequestAssignee.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
MergeRequestAssignee.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
MergeRequestAssignee.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestAssignee.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
MergeRequestAssignee.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
MergeRequestAssignee.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
MergeRequestAssignee.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
MergeRequestAssignee.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
MergeRequestAssignee.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

Arguments
NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.
MergeRequestAssignee.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.

MergeRequestAuthor

The author of the merge request.

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
mergeRequestInteractionUserMergeRequestInteractionDetails of this user’s interactions with the merge request.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Fields with arguments

MergeRequestAuthor.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestAuthor.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestAuthor.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
MergeRequestAuthor.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
MergeRequestAuthor.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
MergeRequestAuthor.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestAuthor.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
MergeRequestAuthor.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
MergeRequestAuthor.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
MergeRequestAuthor.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
MergeRequestAuthor.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
MergeRequestAuthor.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

Arguments
NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.
MergeRequestAuthor.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.

MergeRequestDiff

A diff version of a merge request.

Fields

NameTypeDescription
createdAtTime!Timestamp of when the diff was created.
updatedAtTime!Timestamp of when the diff was updated.

MergeRequestDiffRegistry

Represents the Geo sync and verification state of a Merge Request diff.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the MergeRequestDiffRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the MergeRequestDiffRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the MergeRequestDiffRegistry.
lastSyncFailureStringError message during sync of the MergeRequestDiffRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the MergeRequestDiffRegistry.
mergeRequestDiffIdID!ID of the Merge Request diff.
missingOnPrimaryBooleanIndicate if the MergeRequestDiffRegistry is missing on primary.
modelRecordIdIntID of the MergeRequestDiffRegistry’s model record.
retryAtTimeTimestamp after which the MergeRequestDiffRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the MergeRequestDiffRegistry.
stateRegistryStateSync state of the MergeRequestDiffRegistry.
verificationChecksumStringThe local checksum of the MergeRequestDiffRegistry.
verificationChecksumMismatchedStringThe expected checksum of the MergeRequestDiffRegistry in case of mismatch.
verificationFailureStringError message during verification of the MergeRequestDiffRegistry.
verificationRetryAtTimeTimestamp after which the MergeRequestDiffRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the MergeRequestDiffRegistry.
verificationStartedAtTimeTimestamp when the verification of MergeRequestDiffRegistry started.
verificationStateVerificationStateEnumVerification state of the MergeRequestDiffRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the MergeRequestDiffRegistry.

MergeRequestMergeabilityCheck

Mergeability check of the merge request.

Fields

NameTypeDescription
identifierMergeabilityCheckIdentifier!Identifier of the mergeability check.
statusMergeabilityCheckStatus!Status of the mergeability check.

MergeRequestParticipant

A user participating in a merge request.

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
mergeRequestInteractionUserMergeRequestInteractionDetails of this user’s interactions with the merge request.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Fields with arguments

MergeRequestParticipant.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestParticipant.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestParticipant.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
MergeRequestParticipant.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
MergeRequestParticipant.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
MergeRequestParticipant.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestParticipant.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
MergeRequestParticipant.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
MergeRequestParticipant.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
MergeRequestParticipant.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
MergeRequestParticipant.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
MergeRequestParticipant.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

Arguments
NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.
MergeRequestParticipant.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.

MergeRequestPermissions

Check permissions for the current user on a merge request.

Fields

NameTypeDescription
adminMergeRequestBoolean!If true, the user can perform admin_merge_request on this resource.
canApproveBoolean!If true, the user can perform can_approve on this resource.
canMergeBoolean!If true, the user can perform can_merge on this resource.
cherryPickOnCurrentMergeRequestBoolean!If true, the user can perform cherry_pick_on_current_merge_request on this resource.
createNoteBoolean!If true, the user can perform create_note on this resource.
pushToSourceBranchBoolean!If true, the user can perform push_to_source_branch on this resource.
readMergeRequestBoolean!If true, the user can perform read_merge_request on this resource.
removeSourceBranchBoolean!If true, the user can perform remove_source_branch on this resource.
revertOnCurrentMergeRequestBoolean!If true, the user can perform revert_on_current_merge_request on this resource.
updateMergeRequestBoolean!If true, the user can perform update_merge_request on this resource.

MergeRequestReviewer

A user assigned to a merge request as a reviewer.

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
mergeRequestInteractionUserMergeRequestInteractionDetails of this user’s interactions with the merge request.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Fields with arguments

MergeRequestReviewer.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestReviewer.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestReviewer.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
MergeRequestReviewer.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
MergeRequestReviewer.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
MergeRequestReviewer.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
MergeRequestReviewer.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
MergeRequestReviewer.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
MergeRequestReviewer.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
MergeRequestReviewer.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
MergeRequestReviewer.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
MergeRequestReviewer.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

Arguments
NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.
MergeRequestReviewer.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.

MergeTrain

Represents a set of cars/merge_requests queued for merging.

Fields

NameTypeDescription
targetBranchString!Target branch of the car’s merge request.

Fields with arguments

MergeTrain.cars

Cars queued in the train.

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Returns MergeTrainCarConnection!.

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

Arguments
NameTypeDescription
activityStatusMergeTrainStatus!Filter by the high-level status of the cars. Defaults to ACTIVE.

MergeTrainCar

MergeTrainCar represents an attempt to merge a merge requestusing merge trains.

Fields

NameTypeDescription
createdAtTime!Timestamp of when the car was created.
durationIntDuration of the car.
idMergeTrainsCarID!Global ID of the car.
indexIntZero-based position of the car in the merge train. Returns null if the car is not active in a merge train.
mergeRequestMergeRequest!Merge request the car contains.
mergedAtTimeTimestamp of when the car was merged.
pipelinePipelinePipeline of the car.
statusCarStatus!Status of the car.
targetBranchString!Target branch of the car’s merge request.
targetProjectProject!Project the car’s MR targets.
updatedAtTime!Timestamp of when the car was last updated.
userUserCore!Creator of the car (user who added the merge request to the train).
userPermissionsCarPermissions!Permissions for the current user on the resource.

Metadata

Fields

NameTypeDescription
enterpriseBoolean!Enterprise edition.
kasKas!Metadata about KAS.
revisionString!Revision.
versionString!Version.

Fields with arguments

Metadata.featureFlags

Feature flags for the GitLab instance.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns [GitlabInstanceFeatureFlag!]!.

Arguments
NameTypeDescription
names[String!]!Names of the feature flags to lookup (maximum of 20).

MetricImage

Represents a metric image upload.

Fields

NameTypeDescription
fileNameStringFile name of the metric image.
filePathStringFile path of the metric image.
idID!ID of the metric upload.
iidString!Internal ID of the metric upload.
urlString!URL of the metric source.

MetricsDashboardAnnotation

Fields

NameTypeDescription
descriptionStringDescription of the annotation.
endingAtTimeTimestamp marking end of annotated time span.
idID!ID of the annotation.
panelIdStringID of a dashboard panel to which the annotation should be scoped.
startingAtTimeTimestamp marking start of annotated time span.

Milestone

Represents a milestone.

Fields

NameTypeDescription
createdAtTime!Timestamp of milestone creation.
descriptionStringDescription of the milestone.
dueDateTimeTimestamp of the milestone due date.
expiredBoolean!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.
groupGroupGroup of the milestone.
groupMilestoneBoolean!Indicates if milestone is at group level.
idID!ID of the milestone.
iidID!Internal ID of the milestone.
projectProjectProject of the milestone.
projectMilestoneBoolean!Indicates if milestone is at project level.
releasesReleaseConnectionReleases associated with this milestone. (see Connections)
startDateTimeTimestamp of the milestone start date.
stateMilestoneStateEnum!State of the milestone.
statsMilestoneStatsMilestone statistics.
subgroupMilestoneBoolean!Indicates if milestone is at subgroup level.
titleString!Title of the milestone.
upcomingBoolean!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.
updatedAtTime!Timestamp of last milestone update.
webPathString!Web path of the milestone.

Fields with arguments

Milestone.report

Historically accurate report about the timebox.

Returns TimeboxReport.

Arguments
NameTypeDescription
fullPathStringFull path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

MilestoneStats

Contains statistics about a milestone.

Fields

NameTypeDescription
closedIssuesCountIntNumber of closed issues associated with the milestone.
totalIssuesCountIntTotal number of issues associated with the milestone.

MlCandidate

Candidate for a model version in the model registry.

Fields

NameTypeDescription
_linksMLCandidateLinks!Map of links to perform actions on the candidate.
ciJobCiJobCI information about the job that created the candidate.
createdAtTime!Date of creation.
creatorUserCoreUser that created the candidate.
eidString!MLflow uuid for the candidate.
idMlCandidateID!ID of the candidate.
iidInt!IID of the candidate scoped to project.
metadataMlCandidateMetadataConnection!Metadata entries for the candidate. (see Connections)
metricsMlCandidateMetricConnection!Metrics for the candidate. (see Connections)
nameStringName of the candidate.
paramsMlCandidateParamConnection!Parameters for the candidate. (see Connections)
statusStringCandidate status.

MlCandidateMetadata

Metadata for a candidate in the model registry.

Fields

NameTypeDescription
idMlCandidateMetadataID!ID of the metadata.
nameStringName of the metadata entry.
valueString!Value set for the metadata entry.

MlCandidateMetric

Metric for a candidate in the model registry.

Fields

NameTypeDescription
idMlCandidateMetricID!ID of the metric.
nameStringName of the metric.
stepInt!Step at which the metric was measured.
valueFloat!Value set for the metric.

MlCandidateParam

Parameter for a candidate in the model registry.

Fields

NameTypeDescription
idMlCandidateParamID!ID of the parameter.
nameStringName of the parameter.
valueString!Value set for the parameter.

MlExperiment

Machine learning experiment in model experiments.

Fields

NameTypeDescription
candidateCountInt!Number of candidates in the experiment.
candidatesMlCandidateConnectionCandidates of the experiment. (see Connections)
createdAtTime!Timestamp of when the experiment was created.
creatorUserCoreUser who created the experiment.
idMlExperimentID!ID of the experiment.
modelIdMlModelIDID of the model.
nameString!Name of the experiment.
pathString!Web URL of the experiment.
updatedAtTime!Timestamp of when the experiment was updated.

MlModel

Machine learning model in the model registry.

Fields

NameTypeDescription
_linksMLModelLinks!Map of links to perform actions on the model.
authorUserCoreUser that created the model.
candidateCountIntCount of candidates in the model.
candidatesMlCandidateConnectionVersion candidates of the model. (see Connections)
createdAtTime!Date of creation.
defaultExperimentPathStringPath to default experiment page for the model.
descriptionStringDescription of the model.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
idMlModelID!ID of the model.
latestVersionMlModelVersionLatest version of the model.
nameString!Name of the model.
versionCountIntCount of versions in the model.

Fields with arguments

MlModel.version

Version of the model.

Returns MlModelVersion.

Arguments
NameTypeDescription
modelVersionIdMlModelVersionIDId of the version to be fetched.
MlModel.versions

Versions of the model.

Returns MlModelVersionConnection.

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

Arguments
NameTypeDescription
orderByMlModelVersionsOrderByOrdering column. Default is created_at.
sortSortDirectionEnumOrdering column. Default is desc.
versionStringSearch for versions where the name includes the string.

MlModelVersion

Version of a machine learning model.

Fields

NameTypeDescription
_linksMLModelVersionLinks!Map of links to perform actions on the model version.
artifactsCountIntNumber of files in the package.
authorUserCoreUser that created the model version.
candidateMlCandidate!Metrics, params and metadata for the model version.
createdAtTime!Date of creation.
descriptionStringDescription of the version.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
idMlModelVersionID!ID of the model version.
packageIdPackagesPackageID!Package for model version artifacts.
versionString!Name of the version.

MonthlyUsage

Product analytics events for a specific month and year.

Fields

NameTypeDescription
countIntCount of product analytics events.
monthInt!Month of the data.
yearInt!Year of the data.

Namespace

Fields

NameTypeDescription
achievementsPath warning-solidStringIntroduced in GitLab 17.0. Status: Experiment. Path for the namespace’s achievements. Returns null if the namespace is not a group, or the achievements feature flag is disabled.
actualRepositorySizeLimitFloatSize limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement.
actualSizeLimitFloatThe actual storage size limit (in bytes) based on the enforcement type of either repository or namespace. This limit is agnostic of enforcement type.
additionalPurchasedStorageSizeFloatAdditional storage purchased for the root namespace in bytes.
allowedCustomStatuses warning-solidWorkItemWidgetCustomStatusConnectionIntroduced in GitLab 17.8. Status: Experiment. Allowed custom statuses for the namespace.
ciCdSettings warning-solidCiCdSettingsIntroduced in GitLab 17.9. Status: Experiment. Namespace CI/CD settings for the namespace.
containsLockedProjectsBooleanIncludes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
crossProjectPipelineAvailableBoolean!Indicates if the cross_project_pipeline feature is available for the namespace.
descriptionStringDescription of the namespace.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
fullNameString!Full name of the namespace.
fullPathID!Full path of the namespace.
idID!ID of the namespace.
lfsEnabledBooleanIndicates if Large File Storage (LFS) is enabled for namespace.
nameString!Name of the namespace.
packageSettingsPackageSettingsPackage settings for the namespace.
pathString!Path of the namespace.
productAnalyticsStoredEventsLimit warning-solidIntIntroduced in GitLab 16.9. Status: Experiment. Number of product analytics events namespace is permitted to store per cycle.
repositorySizeExcessProjectCountIntNumber of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
requestAccessEnabledBooleanIndicates if users can request access to namespace.
rootStorageStatisticsRootStorageStatisticsAggregated storage statistics of the namespace. Only available for root namespaces.
securityPolicyProjectProjectSecurity policy project assigned to the namespace.
sharedRunnersSettingSharedRunnersSettingShared runners availability for the namespace and its descendants.
sidebar warning-solidNamespaceSidebarIntroduced in GitLab 17.6. Status: Experiment. Data needed to render the sidebar for the namespace.
storageSizeLimitFloatThe storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement.
subscriptionHistory warning-solidGitlabSubscriptionHistoryConnectionIntroduced in GitLab 17.3. Status: Experiment. Find subscription history records.
timelogCategories warning-solidTimeTrackingTimelogCategoryConnectionIntroduced in GitLab 15.3. Status: Experiment. Timelog categories for the namespace.
totalRepositorySizeFloatTotal repository size of all projects in the root namespace in bytes.
totalRepositorySizeExcessFloatTotal excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement.
userPermissionsNamespacePermissions!Permissions for the current user on the resource.
visibilityStringVisibility of the namespace.
webUrlStringURL of this object.

Fields with arguments

Namespace.achievements

Achievements for the namespace. Returns null if the achievements feature flag is disabled.

  • Introduced in GitLab 15.8.
  • Status: Experiment.

Returns AchievementConnection.

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

Arguments
NameTypeDescription
ids[AchievementsAchievementID!]Filter achievements by IDs.
Namespace.addOnEligibleUsers

Users in the namespace hierarchy that add ons are applicable for. This only applies to root namespaces.

  • Introduced in GitLab 16.5.
  • Status: Experiment.

Returns AddOnUserConnection.

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

Arguments
NameTypeDescription
addOnPurchaseIds[GitlabSubscriptionsAddOnPurchaseID!]!Global IDs of the add on purchases to find assignments for.
addOnTypeGitlabSubscriptionsAddOnType!Type of add on to filter the eligible users by.
filterByAssignedSeatStringFilter users list by assigned seat.
searchStringSearch the user list.
sortGitlabSubscriptionsUserSortSort the user list.
Namespace.addOnPurchase

AddOnPurchase associated with the namespace.

  • Deprecated in GitLab 17.5.
  • Use root addOnPurchases instead.

Returns AddOnPurchase.

Arguments
NameTypeDescription
addOnNameString!AddOn name.
Namespace.approvalPolicies

Approval Policies of the project.

Returns ApprovalPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Namespace.complianceFrameworks

Compliance frameworks available to projects in this namespace.

Returns ComplianceFrameworkConnection.

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

Arguments
NameTypeDescription
idComplianceManagementFrameworkIDGlobal ID of a specific compliance framework to return.
ids[ComplianceManagementFrameworkID!]List of Global IDs of compliance frameworks to return.
searchStringSearch framework with most similar names.
Namespace.importSourceUsers

Import source users of the namespace. This field can only be resolved for one namespace in any single request.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Returns ImportSourceUserConnection.

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

Arguments
NameTypeDescription
searchStringQuery to search mappings by name or username of users on source instance.
sortSourceUserSortSort 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.
Namespace.pagesDeployments

List of the namespaces’s Pages Deployments.

Returns PagesDeploymentConnection.

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

Arguments
NameTypeDescription
activeBooleanFilter by active or inactive state.
sortSortSort results.
versionedBooleanFilter deployments that are versioned or unversioned.
Namespace.pipelineExecutionPolicies

Pipeline Execution Policies of the namespace.

Returns PipelineExecutionPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Namespace.projects

Projects within this namespace. Returns projects from the parent group if namespace is project.

Returns ProjectConnection!.

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

Arguments
NameTypeDescription
complianceFrameworkFiltersComplianceFrameworkFiltersFilters applied when selecting a compliance framework.
hasCodeCoverageBooleanReturns only the projects which have code coverage.
hasVulnerabilitiesBooleanReturns only the projects which have vulnerabilities.
ids[ID!]Filter projects by IDs.
includeArchivedBooleanInclude also archived projects.
includeSiblingProjects warning-solidBooleanIntroduced in GitLab 17.2. Status: Experiment. Include also projects from parent group.
includeSubgroupsBooleanInclude also subgroup projects.
notAimedForDeletionBooleanInclude projects that are not aimed for deletion.
sbomComponentIdIDReturn only the projects related to the specified SBOM component.
searchStringSearch project with most similar names or paths.
sortNamespaceProjectSortSort projects by the criteria.
withIssuesEnabledBooleanReturn only projects with issues enabled.
withMergeRequestsEnabledBooleanReturn only projects with merge requests enabled.
withNamespaceDomainPagesBooleanReturn only projects that use the namespace domain for pages projects.
Namespace.remoteDevelopmentClusterAgents

Cluster agents in the namespace with remote development capabilities.

  • Deprecated in GitLab 17.8.
  • Use workspacesClusterAgents.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
filterNamespaceClusterAgentFilter!Filter the types of cluster agents to return.
Namespace.scanExecutionPolicies

Scan Execution Policies of the namespace.

Returns ScanExecutionPolicyConnection.

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

Arguments
NameTypeDescription
actionScanTypes[SecurityReportTypeEnum!]Filters policies by the action scan type. Only these scan types are supported: dast, secret_detection, cluster_image_scanning, container_scanning, sast, sast_iac, dependency_scanning.
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Namespace.scanResultPolicies

Scan Result Policies of the project.

  • Deprecated in GitLab 16.9.
  • Use approvalPolicies.

Returns ScanResultPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Namespace.vulnerabilityManagementPolicies

Vulnerability Management Policies of the project.

  • Introduced in GitLab 17.7.
  • Status: Experiment.

Returns VulnerabilityManagementPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Namespace.workItem

Find a work item by IID directly associated with the namespace(project or group). Returns null for group level work items if the namespace_level_work_items feature flag is disabled.

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Returns WorkItem.

Arguments
NameTypeDescription
iidString!IID of the work item.
Namespace.workItemDescriptionTemplates

Work item description templates available to the namespace.

  • Introduced in GitLab 17.6.
  • Status: Experiment.

Returns WorkItemDescriptionTemplateConnection.

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

Arguments
NameTypeDescription
name warning-solidStringDeprecated in GitLab 17.9. name and project ID are both required for fetching, use DescriptionTemplateContentInputType instead.
search warning-solidStringDeprecated in GitLab 17.8. search on template names is performed on the FE only.
Namespace.workItemTypes

Work item types available to the namespace.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Returns WorkItemTypeConnection.

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

Arguments
NameTypeDescription
nameIssueTypeFilter work item types by the given name.
Namespace.workspacesClusterAgents

Cluster agents in the namespace with workspaces capabilities.

  • Introduced in GitLab 17.8.
  • Status: Experiment.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
filterNamespaceClusterAgentFilter!Filter the types of cluster agents to return.

NamespaceBan

Fields

NameTypeDescription
idGlobalID!Global ID of the namespace ban.
namespaceNamespace!Root namespace to which the ban applies.
userUserCore!User to which the namespace ban applies.

NamespaceCiCdSetting

Fields

NameTypeDescription
allowStaleRunnerPruningBooleanIndicates if stale runners directly belonging to this namespace should be periodically pruned.
namespaceNamespaceNamespace the CI/CD settings belong to.

NamespaceCommitEmail

Fields

NameTypeDescription
createdAtTime!Timestamp the namespace commit email was created.
emailEmail!Email.
idID!Internal ID of the namespace commit email.
namespaceNamespace!Namespace.
updatedAtTime!Timestamp the namespace commit email was last updated.

NamespacePermissions

Fields

NameTypeDescription
generateDescriptionBoolean!If true, the user can perform generate_description on this resource.
readNamespaceBoolean!If true, the user can perform read_namespace on this resource.

NamespaceSidebar

Fields

NameTypeDescription
openEpicsCountIntNumber of open epics of the namespace.
openIssuesCountIntNumber of open issues of the namespace.
openMergeRequestsCountIntNumber of open merge requests of the namespace.

NestedEnvironment

Describes where code is deployed for a project organized by folder.

Fields

NameTypeDescription
environmentEnvironmentLatest environment in the folder.
nameString!Human-readable name of the environment.
sizeInt!Number of environments nested in the folder.

NetworkPolicyEgress

Fields

NameTypeDescription
allowString!IP range to allow traffic from.
except[String!]List of IP ranges to exclude from the allow range.

Note

Fields

NameTypeDescription
authorUserCoreUser who wrote the note.
authorIsContributorBooleanIndicates whether the note author is a contributor.
awardEmojiAwardEmojiConnectionList of emoji reactions associated with the note. (see Connections)
bodyString!Content of the note.
bodyFirstLineHtmlString!First line of the note content.
bodyHtmlStringGitLab Flavored Markdown rendering of the content of the note.
createdAtTime!Timestamp of the note creation.
discussionDiscussionDiscussion the note is a part of.
externalAuthorStringEmail address of non-GitLab user adding the note. For guests, the email address is obfuscated.
idNoteID!ID of the note.
importedBooleanIndicates whether the note was imported.
internalBooleanIndicates if the note is internal.
lastEditedAtTimeTimestamp when note was last edited.
lastEditedByUserCoreUser who last edited the note.
maxAccessLevelOfAuthorStringMax access level of the note author in the project.
positionDiffPositionPosition of the note on a diff.
projectProjectProject associated with the note.
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.
systemBoolean!Indicates whether the note was created by the system or by a user.
systemNoteIconNameStringName of the icon corresponding to a system note.
systemNoteMetadataSystemNoteMetadataMetadata for the given note if it is a system note.
updatedAtTime!Timestamp of the note’s last activity.
urlStringURL to view the note in the Web UI.
userPermissionsNotePermissions!Permissions for the current user on the resource.

NotePermissions

Fields

NameTypeDescription
adminNoteBoolean!If true, the user can perform admin_note on this resource.
awardEmojiBoolean!If true, the user can perform award_emoji on this resource.
createNoteBoolean!If true, the user can perform create_note on this resource.
readNoteBoolean!If true, the user can perform read_note on this resource.
repositionNoteBoolean!If true, the user can perform reposition_note on this resource.
resolveNoteBoolean!If true, the user can perform resolve_note on this resource.

NugetDependencyLinkMetadata

Nuget dependency link metadata.

Fields

NameTypeDescription
idPackagesNugetDependencyLinkMetadatumID!ID of the metadatum.
targetFrameworkString!Target framework of the dependency link package.

NugetMetadata

Nuget metadata.

Fields

NameTypeDescription
iconUrlStringIcon URL of the Nuget package.
idPackagesNugetMetadatumID!ID of the metadatum.
licenseUrlStringLicense URL of the Nuget package.
projectUrlStringProject URL of the Nuget package.

ObservabilityLog

ObservabilityLog represents a connection between an issue and a log entry.

Fields

NameTypeDescription
fingerprintString!Log fingerprint of the log.
issueIssue!Issue associated with the log.
serviceNameString!Service name of the log.
severityNumberInt!Severity number of the log.
timestampISO8601DateTime!Timestamp of the log.
traceIdentifierString!Trace identifier of the log.

ObservabilityMetric

ObservabilityMetric represents a connection between an issue and a metric.

Fields

NameTypeDescription
issueIssueIssues that the metric is attributed to.
nameString!Name of the metric.
typeString!OpenTelemetry metric type of the metric.

ObservabilityTrace

ObservabilityTrace represents a connection between an issue and a trace.

Fields

NameTypeDescription
issueIssue!Issue associated with the trace.
traceIdentifierString!Identifier of the trace.

OncallParticipantType

The rotation participant and color palette.

Fields

NameTypeDescription
colorPaletteStringColor palette to assign to the on-call user. For example “blue”.
colorWeightStringColor weight to assign to for the on-call user, for example “500”. Max 4 chars. For easy identification of the user.
idIncidentManagementOncallParticipantID!ID of the on-call participant.
userUserCore!User who is participating.

OncallRotationActivePeriodType

Active period time range for on-call rotation.

Fields

NameTypeDescription
endTimeStringEnd of the rotation active period.
startTimeStringStart of the rotation active period.

Organization

Fields

NameTypeDescription
avatarUrl warning-solidStringIntroduced in GitLab 16.7. Status: Experiment. Avatar URL of the organization.
description warning-solidStringIntroduced in GitLab 16.7. Status: Experiment. Description of the organization.
descriptionHtml warning-solidStringIntroduced in GitLab 16.7. Status: Experiment. GitLab Flavored Markdown rendering of description.
id warning-solidID!Introduced in GitLab 16.4. Status: Experiment. ID of the organization.
name warning-solidString!Introduced in GitLab 16.4. Status: Experiment. Name of the organization.
organizationUsers warning-solidOrganizationUserConnection!Introduced in GitLab 16.4. Status: Experiment. Users with access to the organization.
path warning-solidString!Introduced in GitLab 16.4. Status: Experiment. Path of the organization.
webUrl warning-solidString!Introduced in GitLab 16.6. Status: Experiment. Web URL of the organization.

Fields with arguments

Organization.groups

Groups within this organization that the user has access to.

  • Introduced in GitLab 16.4.
  • Status: Experiment.

Returns GroupConnection!.

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

Arguments
NameTypeDescription
ids[ID!]Filter groups by IDs.
markedForDeletionOnDateDate when the group was marked for deletion.
ownedOnlyBooleanOnly include groups where the current user has an owner role.
searchStringSearch query for group name or group full path.
sortStringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topLevelOnlyBooleanOnly include top-level groups.
Organization.projects

Projects within this organization that the user has access to.

  • Introduced in GitLab 16.8.
  • Status: Experiment.

Returns ProjectConnection!.

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

Arguments
NameTypeDescription
aimedForDeletionBooleanReturn only projects marked for deletion.
archivedProjectArchivedFilter projects by archived status.
fullPaths[String!]Filter projects by full paths. You cannot provide more than 50 full paths.
ids[ID!]Filter projects by IDs.
includeHiddenBooleanInclude hidden projects.
markedForDeletionOnDateDate when the project was marked for deletion.
membershipBooleanReturn only projects that the current user is a member of.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
personalBooleanReturn only personal projects.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query, which can be for the project name, a path, or a description.
searchNamespacesBooleanInclude namespace in project search.
sortStringSort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics[String!]Filter projects by topics.
withIssuesEnabledBooleanReturn only projects with issues enabled.
withMergeRequestsEnabledBooleanReturn only projects with merge requests enabled.

OrganizationStateCounts

Represents the total number of organizations for the represented states.

Fields

NameTypeDescription
activeIntNumber of organizations with state ACTIVE.
allIntNumber of organizations with state ALL.
inactiveIntNumber of organizations with state INACTIVE.

OrganizationUser

A user with access to the organization.

Fields

NameTypeDescription
accessLevel warning-solidOrganizationUserAccess!Introduced in GitLab 16.11. Status: Experiment. Access level of the user in the organization.
badges warning-solid[OrganizationUserBadge!]Introduced in GitLab 16.4. Status: Experiment. Badges describing the user within the organization.
id warning-solidID!Introduced in GitLab 16.4. Status: Experiment. ID of the organization user.
isLastOwner warning-solidBoolean!Introduced in GitLab 16.11. Status: Experiment. Whether the user is the last owner of the organization.
user warning-solidUserCore!Introduced in GitLab 16.4. Status: Experiment. User that is associated with the organization.
userPermissionsOrganizationUserPermissions!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

NameTypeDescription
integerValue warning-solidIntIntroduced in GitLab 16.11. Status: Experiment. Integer representation of access level.
stringValue warning-solidOrganizationUserAccessLevelIntroduced in GitLab 16.11. Status: Experiment. String representation of access level.

OrganizationUserBadge

An organization user badge.

Fields

NameTypeDescription
textString!Badge text.
variantString!Badge variant.

OrganizationUserPermissions

Fields

NameTypeDescription
adminOrganizationBoolean!If true, the user can perform admin_organization on this resource.
deleteUserBoolean!If true, the user can perform delete_user on this resource.
removeUserBoolean!If true, the user can perform remove_user on this resource.

Package

Represents a package with pipelines in the Package Registry.

Fields

NameTypeDescription
_linksPackageLinks!Map of links to perform actions on the package.
createdAtTime!Date of creation.
idPackagesPackageID!ID of the package.
metadataPackageMetadataPackage metadata.
nameString!Name of the package.
packageTypePackageTypeEnum!Package type.
pipelinesPipelineConnectionPipelines that built the package. Max page size 20. (see Connections)
projectProject!Project where the package is stored.
protectionRuleExistsBoolean!Whether any matching package protection rule exists for the package.
statusPackageStatus!Package status.
statusMessageStringStatus message.
tagsPackageTagConnectionPackage tags. (see Connections)
updatedAtTime!Date of most recent update.
userPermissionsPackagePermissions!Permissions for the current user on the resource.
versionStringVersion string.

PackageBase

Represents a package in the Package Registry.

Fields

NameTypeDescription
_linksPackageLinks!Map of links to perform actions on the package.
createdAtTime!Date of creation.
idPackagesPackageID!ID of the package.
metadataPackageMetadataPackage metadata.
nameString!Name of the package.
packageTypePackageTypeEnum!Package type.
projectProject!Project where the package is stored.
protectionRuleExistsBoolean!Whether any matching package protection rule exists for the package.
statusPackageStatus!Package status.
statusMessageStringStatus message.
tagsPackageTagConnectionPackage tags. (see Connections)
updatedAtTime!Date of most recent update.
userPermissionsPackagePermissions!Permissions for the current user on the resource.
versionStringVersion string.

PackageComposerJsonType

Represents a composer JSON file.

Fields

NameTypeDescription
licenseStringLicense set in the Composer JSON file.
nameStringName set in the Composer JSON file.
typeStringType set in the Composer JSON file.
versionStringVersion set in the Composer JSON file.

PackageDependency

Represents a package dependency.

Fields

NameTypeDescription
idPackagesDependencyID!ID of the dependency.
nameString!Name of the dependency.
versionPatternString!Version pattern of the dependency.

Represents a package dependency link.

Fields

NameTypeDescription
dependencyPackageDependencyDependency.
dependencyTypePackageDependencyType!Dependency type.
idPackagesDependencyLinkID!ID of the dependency link.
metadataDependencyLinkMetadataDependency link metadata.

PackageDetailsType

Represents a package details in the Package Registry.

Fields

NameTypeDescription
_linksPackageLinks!Map of links to perform actions on the package.
composerConfigRepositoryUrlStringUrl of the Composer setup endpoint.
composerUrlStringUrl of the Composer endpoint.
conanUrlStringUrl of the Conan project endpoint.
createdAtTime!Date of creation.
dependencyLinksPackageDependencyLinkConnectionDependency link. (see Connections)
idPackagesPackageID!ID of the package.
lastDownloadedAtTimeLast time that a file of this package was downloaded.
mavenUrlStringUrl of the Maven project endpoint.
metadataPackageMetadataPackage metadata.
nameString!Name of the package.
npmUrlStringUrl of the NPM project endpoint.
nugetUrlStringUrl of the Nuget project endpoint.
packageFilesPackageFileConnectionPackage files. (see Connections)
packageTypePackageTypeEnum!Package type.
pipelinesPipelineConnectionPipelines that built the package. Max page size 20. (see Connections)
projectProject!Project where the package is stored.
protectionRuleExistsBoolean!Whether any matching package protection rule exists for the package.
publicPackageBooleanIndicates if there is public access to the package.
pypiSetupUrlStringUrl of the PyPi project setup endpoint.
pypiUrlStringUrl of the PyPi project endpoint.
statusPackageStatus!Package status.
statusMessageStringStatus message.
tagsPackageTagConnectionPackage tags. (see Connections)
updatedAtTime!Date of most recent update.
userPermissionsPackagePermissions!Permissions for the current user on the resource.
versionStringVersion string.
versionsPackageBaseConnectionOther versions of the package. (see Connections)

PackageFile

Represents a package file.

Fields

NameTypeDescription
createdAtTime!Created date.
downloadPathString!Download path of the package file.
fileMd5StringMd5 of the package file.
fileMetadataPackageFileMetadataFile metadata.
fileNameString!Name of the package file.
fileSha1StringSha1 of the package file.
fileSha256StringSha256 of the package file.
idPackagesPackageFileID!ID of the file.
sizeString!Size of the package file.
updatedAtTime!Updated date.

PackageFileRegistry

Represents the Geo sync and verification state of a package file.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the PackageFileRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the PackageFileRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the PackageFileRegistry.
lastSyncFailureStringError message during sync of the PackageFileRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the PackageFileRegistry.
missingOnPrimaryBooleanIndicate if the PackageFileRegistry is missing on primary.
modelRecordIdIntID of the PackageFileRegistry’s model record.
packageFileIdID!ID of the PackageFile.
retryAtTimeTimestamp after which the PackageFileRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the PackageFileRegistry.
stateRegistryStateSync state of the PackageFileRegistry.
verificationChecksumStringThe local checksum of the PackageFileRegistry.
verificationChecksumMismatchedStringThe expected checksum of the PackageFileRegistry in case of mismatch.
verificationFailureStringError message during verification of the PackageFileRegistry.
verificationRetryAtTimeTimestamp after which the PackageFileRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the PackageFileRegistry.
verificationStartedAtTimeTimestamp when the verification of PackageFileRegistry started.
verificationStateVerificationStateEnumVerification state of the PackageFileRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the PackageFileRegistry.

PackageHelmDependencyType

Represents a Helm dependency.

Fields

NameTypeDescription
aliasStringAlias of the dependency.
conditionStringCondition of the dependency.
enabledBooleanIndicates the dependency is enabled.
importValues[JSON!]Import-values of the dependency.
nameStringName of the dependency.
repositoryStringRepository of the dependency.
tags[String!]Tags of the dependency.
versionStringVersion of the dependency.

PackageHelmMaintainerType

Represents a Helm maintainer.

Fields

NameTypeDescription
emailStringEmail of the maintainer.
nameStringName of the maintainer.
urlStringURL of the maintainer.

PackageHelmMetadataType

Represents the contents of a Helm Chart.yml file.

Fields

NameTypeDescription
annotationsJSONAnnotations for the chart.
apiVersionString!API version of the chart.
appVersionStringApp version of the chart.
conditionStringCondition for the chart.
dependencies[PackageHelmDependencyType!]Dependencies of the chart.
deprecatedBooleanIndicates if the chart is deprecated.
descriptionStringDescription of the chart.
homeStringURL of the home page.
iconStringURL to an SVG or PNG image for the chart.
keywords[String!]Keywords for the chart.
kubeVersionStringKubernetes versions for the chart.
maintainers[PackageHelmMaintainerType!]Maintainers of the chart.
nameString!Name of the chart.
sources[String!]URLs of the source code for the chart.
tagsStringTags for the chart.
typeStringType of the chart.
versionString!Version of the chart.

Represents links to perform actions on the package.

Fields

NameTypeDescription
webPathStringPath to the package details page.

PackagePermissions

Fields

NameTypeDescription
destroyPackageBoolean!If true, the user can perform destroy_package on this resource.

PackageSettings

Namespace-level Package Registry settings.

Fields

NameTypeDescription
genericDuplicateExceptionRegexUntrustedRegexpWhen generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
genericDuplicatesAllowedBoolean!Indicates whether duplicate generic packages are allowed for this namespace.
lockMavenPackageRequestsForwardingBoolean!Indicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwardingBoolean!Indicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwardingBoolean!Indicates whether PyPI package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegexUntrustedRegexpWhen maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
mavenDuplicatesAllowedBoolean!Indicates whether duplicate Maven packages are allowed for this namespace.
mavenPackageRequestsForwardingBooleanIndicates whether Maven package forwarding is allowed for this namespace.
mavenPackageRequestsForwardingLockedBoolean!Indicates whether Maven package forwarding settings are locked by a parent namespace.
npmPackageRequestsForwardingBooleanIndicates whether npm package forwarding is allowed for this namespace.
npmPackageRequestsForwardingLockedBoolean!Indicates whether npm package forwarding settings are locked by a parent namespace.
nugetDuplicateExceptionRegexUntrustedRegexpWhen nuget_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
nugetDuplicatesAllowedBoolean!Indicates whether duplicate NuGet packages are allowed for this namespace.
nugetSymbolServerEnabledBoolean!Indicates wheather the NuGet symbol server is enabled for this namespace.
pypiPackageRequestsForwardingBooleanIndicates whether PyPI package forwarding is allowed for this namespace.
pypiPackageRequestsForwardingLockedBoolean!Indicates whether PyPI package forwarding settings are locked by a parent namespace.
terraformModuleDuplicateExceptionRegexUntrustedRegexpWhen terraform_module_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
terraformModuleDuplicatesAllowedBoolean!Indicates whether duplicate Terraform packages are allowed for this namespace.

PackageTag

Represents a package tag.

Fields

NameTypeDescription
createdAtTime!Created date.
idID!ID of the tag.
nameString!Name of the tag.
updatedAtTime!Updated date.

PackagesCleanupPolicy

A packages cleanup policy designed to keep only packages and packages assets that matter most.

Fields

NameTypeDescription
keepNDuplicatedPackageFilesPackagesCleanupKeepDuplicatedPackageFilesEnum!Number of duplicated package files to retain.
nextRunAtTimeNext time that this packages cleanup policy will be executed.

PackagesProtectionRule

A packages protection rule designed to protect packages from being pushed by users with a certain access level.

Fields

NameTypeDescription
idPackagesProtectionRuleID!Global ID of the package protection rule.
minimumAccessLevelForPushPackagesProtectionRuleAccessLevel!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.
packageNamePatternString!Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageTypePackagesProtectionRulePackageType!Package type protected by the protection rule. For example, NPM, PYPI.

PageInfo

Information about pagination in a connection.

Fields

NameTypeDescription
endCursorStringWhen paginating forwards, the cursor to continue.
hasNextPageBoolean!When paginating forwards, are there more items?.
hasPreviousPageBoolean!When paginating backwards, are there more items?.
startCursorStringWhen paginating backwards, the cursor to continue.

PagesDeployment

Represents a pages deployment.

Fields

NameTypeDescription
activeBoolean!Whether the deployment is currently active.
ciBuildIdIDID of the CI build that created the deployment.
createdAtISO8601DateTime!Time the deployment was created.
deletedAtISO8601DateTimeTime the deployment was deleted.
expiresAtISO8601DateTimeTime the deployment will expire.
fileCountIntNumber of files that were published with the deployment.
idID!ID of the Pages Deployment.
pathPrefixStringURL path Prefix that points to the deployment.
projectProject!Project the deployment belongs to.
rootDirectoryStringPath within the build assets that functions as the root directory for Pages sites.
sizeIntSize of the storage used.
updatedAtISO8601DateTime!Time the deployment was last updated.
urlString!Publicly accessible URL of the deployment.

PagesDeploymentRegistry

Represents the Geo replication and verification state of a pages_deployment.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the PagesDeploymentRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the PagesDeploymentRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the PagesDeploymentRegistry.
lastSyncFailureStringError message during sync of the PagesDeploymentRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the PagesDeploymentRegistry.
missingOnPrimaryBooleanIndicate if the PagesDeploymentRegistry is missing on primary.
modelRecordIdIntID of the PagesDeploymentRegistry’s model record.
pagesDeploymentIdID!ID of the Pages Deployment.
retryAtTimeTimestamp after which the PagesDeploymentRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the PagesDeploymentRegistry.
stateRegistryStateSync state of the PagesDeploymentRegistry.
verificationChecksumStringThe local checksum of the PagesDeploymentRegistry.
verificationChecksumMismatchedStringThe expected checksum of the PagesDeploymentRegistry in case of mismatch.
verificationFailureStringError message during verification of the PagesDeploymentRegistry.
verificationRetryAtTimeTimestamp after which the PagesDeploymentRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the PagesDeploymentRegistry.
verificationStartedAtTimeTimestamp when the verification of PagesDeploymentRegistry started.
verificationStateVerificationStateEnumVerification state of the PagesDeploymentRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the PagesDeploymentRegistry.

PathLock

Represents a file or directory in the project repository that has been locked.

Fields

NameTypeDescription
idPathLockID!ID of the path lock.
pathStringLocked path.
userUserCoreUser that has locked this path.

PendingGroupMember

Represents a Pending Group Membership.

Fields

NameTypeDescription
accessLevelAccessLevelGitLab::Access level.
approvedBooleanWhether the pending member has been approved.
avatarUrlStringURL to avatar image file of the pending member.
createdAtTimeDate and time the membership was created.
createdByUserCoreUser that authorized membership.
emailStringPublic email of the pending member.
expiresAtTimeDate and time the membership expires.
idID!ID of the member.
invitedBooleanWhether the pending member has been invited.
nameStringName of the pending member.
updatedAtTimeDate and time the membership was last updated.
userUserCoreUser that is associated with the member object.
usernameStringUsername of the pending member.
webUrlStringWeb URL of the pending member.

Fields with arguments

PendingGroupMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
NameTypeDescription
idMergeRequestID!Global ID of the merge request.

PendingProjectMember

Represents a Pending Project Membership.

Fields

NameTypeDescription
accessLevelAccessLevelGitLab::Access level.
approvedBooleanWhether the pending member has been approved.
avatarUrlStringURL to avatar image file of the pending member.
createdAtTimeDate and time the membership was created.
createdByUserCoreUser that authorized membership.
emailStringPublic email of the pending member.
expiresAtTimeDate and time the membership expires.
idID!ID of the member.
invitedBooleanWhether the pending member has been invited.
nameStringName of the pending member.
updatedAtTimeDate and time the membership was last updated.
userUserCoreUser that is associated with the member object.
usernameStringUsername of the pending member.
webUrlStringWeb URL of the pending member.

Fields with arguments

PendingProjectMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
NameTypeDescription
idMergeRequestID!Global ID of the merge request.

Pipeline

Fields

NameTypeDescription
activeBoolean!Indicates if the pipeline is active.
beforeShaStringBase SHA of the source branch.
cancelableBoolean!Specifies if a pipeline can be canceled.
childBoolean!If the pipeline is a child or not.
codeQualityReportSummaryCodeQualityReportSummaryCode Quality report summary for a pipeline.
codeQualityReportsCodeQualityDegradationConnectionCode Quality degradations reported on the pipeline. (see Connections)
commitCommitGit commit of the pipeline.
commitPathStringPath to the commit that triggered the pipeline.
committedAtTimeTimestamp of the pipeline’s commit.
completeBoolean!Indicates if a pipeline is complete.
computeMinutesFloatTotal minutes consumed by the pipeline.
configSourcePipelineConfigSourceEnumConfiguration 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).
coverageFloatCoverage percentage.
createdAtTime!Timestamp of the pipeline’s creation.
dastProfileDastProfileDAST profile associated with the pipeline.
detailedStatusDetailedStatus!Detailed status of the pipeline.
downstreamPipelineConnectionPipelines the pipeline will trigger. (see Connections)
durationIntDuration of the pipeline in seconds.
errorMessagesPipelineMessageConnectionPipeline error messages. (see Connections)
failureReasonStringReason why the pipeline failed.
finishedAtTimeTimestamp of the pipeline’s completion.
idID!ID of the pipeline.
iidString!Internal ID of the pipeline.
jobArtifacts[CiJobArtifact!]Job artifacts of the pipeline.
latestBoolean!If the pipeline is the latest one or not.
manualVariablesPipelineManualVariableConnectionCI/CD variables added to a manual pipeline. (see Connections)
mergeRequestMergeRequestMR which the Pipeline is attached to.
mergeRequestEventTypePipelineMergeRequestEventTypeEvent type of the pipeline associated with a merge request.
nameStringName of the pipeline.
pathStringRelative path to the pipeline’s page.
projectProjectProject the pipeline belongs to.
queuedDurationDurationHow long the pipeline was queued before starting.
refStringReference to the branch from which the pipeline was triggered.
refPathStringReference path to the branch from which the pipeline was triggered.
refTextString!Reference text from the presenter.
retryableBoolean!Specifies if a pipeline’s jobs can be retried.
securityReportSummarySecurityReportSummaryVulnerability and scanned resource counts for each security scanner of the pipeline.
sourceStringSource of the pipeline.
sourceJobCiJobJob where pipeline was triggered from.
stagesCiStageConnectionStages of the pipeline. (see Connections)
startedAtTimeTimestamp when the pipeline was started.
statusPipelineStatusEnum!Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, WAITING_FOR_CALLBACK, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, CANCELING, SKIPPED, MANUAL, SCHEDULED).
stuckBoolean!If the pipeline is stuck.
testReportSummaryTestReportSummary!Summary of the test report generated by the pipeline.
totalJobsInt!Total number of jobs in the pipeline.
triggerBoolean!If the pipeline was created by a Trigger request.
triggeredByPathStringPath that triggered the pipeline.
troubleshootJobWithAiBoolean!If the user can troubleshoot jobs of a pipeline.
typeString!Type of the pipeline.
updatedAtTime!Timestamp of the pipeline’s last activity.
upstreamPipelinePipeline that triggered the pipeline.
userUserCorePipeline user.
userPermissionsPipelinePermissions!Permissions for the current user on the resource.
usesNeedsBooleanIndicates if the pipeline has jobs with needs dependencies.
warningMessagesPipelineMessageConnectionPipeline warning messages. (see Connections)
warningsBoolean!Indicates if a pipeline has warnings.
yamlErrorMessagesStringPipeline YAML errors.
yamlErrorsBoolean!If the pipeline has YAML errors.

Fields with arguments

Pipeline.job

Specific job in the pipeline, either by name or ID.

Returns CiJob.

Arguments
NameTypeDescription
idJobIDID of the job.
nameStringName of the job.
Pipeline.jobs

Jobs belonging to the pipeline.

Returns CiJobConnection.

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

Arguments
NameTypeDescription
jobKindCiJobKindFilter jobs by kind.
retriedBooleanFilter jobs by retry-status.
securityReportTypes[SecurityReportTypeEnum!]Filter jobs by the type of security report they produce.
statuses[CiJobStatus!]Filter jobs by status.
whenExecuted[String!]Filter jobs by when they are executed.
Pipeline.securityReportFinding

Vulnerability finding reported on the pipeline.

Returns PipelineSecurityReportFinding.

Arguments
NameTypeDescription
uuidString!UUID of the security report finding.
Pipeline.securityReportFindings

Vulnerability findings reported on the pipeline. By default all the states except dismissed are included in the response.

Returns PipelineSecurityReportFindingConnection.

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

Arguments
NameTypeDescription
reportType[String!]Filter vulnerability findings by report type.
scanner[String!]Filter vulnerability findings by Scanner.externalId.
severity[String!]Filter vulnerability findings by severity.
sortPipelineSecurityReportFindingSortList vulnerability findings by sort order.
state[VulnerabilityState!]Filter vulnerability findings by state.
Pipeline.sha

SHA of the pipeline’s commit.

Returns String.

Arguments
NameTypeDescription
formatShaFormatFormat of the SHA.
Pipeline.testSuite

A specific test suite in a pipeline test report.

Returns TestSuite.

Arguments
NameTypeDescription
buildIds[ID!]!IDs of the builds used to run the test suite.

PipelineAnalytics

Fields

NameTypeDescription
aggregate warning-solidPipelineAnalyticsPeriodIntroduced in GitLab 17.5. Status: Experiment. 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.
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.

Fields with arguments

PipelineAnalytics.timeSeries

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.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Returns [PipelineAnalyticsPeriod!].

Arguments
NameTypeDescription
periodAnalyticsAggregationPeriod!Periodicity of aggregated data.

PipelineAnalyticsPeriod

Fields

NameTypeDescription
durationStatistics warning-solidCiDurationStatisticsIntroduced in GitLab 17.5. Status: Experiment. Pipeline duration statistics.
label warning-solidDateIntroduced in GitLab 17.5. Status: Experiment. Data point label (UTC time).

Fields with arguments

PipelineAnalyticsPeriod.count

Pipeline count, optionally filtered by status.

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Returns BigInt.

Arguments
NameTypeDescription
statusPipelineAnalyticsJobStatus!Filter pipeline totals by status. If not specified, totals for all pipeline statuses are returned.

PipelineArtifactRegistry

Represents the Geo sync and verification state of a pipeline artifact.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the PipelineArtifactRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the PipelineArtifactRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the PipelineArtifactRegistry.
lastSyncFailureStringError message during sync of the PipelineArtifactRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the PipelineArtifactRegistry.
missingOnPrimaryBooleanIndicate if the PipelineArtifactRegistry is missing on primary.
modelRecordIdIntID of the PipelineArtifactRegistry’s model record.
pipelineArtifactIdID!ID of the pipeline artifact.
retryAtTimeTimestamp after which the PipelineArtifactRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the PipelineArtifactRegistry.
stateRegistryStateSync state of the PipelineArtifactRegistry.
verificationChecksumStringThe local checksum of the PipelineArtifactRegistry.
verificationChecksumMismatchedStringThe expected checksum of the PipelineArtifactRegistry in case of mismatch.
verificationFailureStringError message during verification of the PipelineArtifactRegistry.
verificationRetryAtTimeTimestamp after which the PipelineArtifactRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the PipelineArtifactRegistry.
verificationStartedAtTimeTimestamp when the verification of PipelineArtifactRegistry started.
verificationStateVerificationStateEnumVerification state of the PipelineArtifactRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the PipelineArtifactRegistry.

PipelineCounts

Represents pipeline counts for the project.

Fields

NameTypeDescription
allIntTotal number of pipelines for the project.
finishedIntNumber of pipelines with scope FINISHED for the project.
pendingIntNumber of pipelines with scope PENDING for the project.
runningIntNumber of pipelines with scope RUNNING for the project.

PipelineExecutionPolicy

Represents the pipeline execution policy.

Fields

NameTypeDescription
descriptionString!Description of the policy.
editPathString!URL of policy edit page.
enabledBoolean!Indicates whether this policy is enabled.
nameString!Name of the policy.
policyBlobFilePathString!Path to the policy file in the project.
policyScopePolicyScopeScope of the policy.
sourceSecurityPolicySource!Source of the policy. Its fields depend on the source type.
updatedAtTime!Timestamp of when the policy YAML was last updated.
warnings[String!]!Warnings associated with the policy.
yamlString!YAML definition of the policy.

PipelineManualVariable

CI/CD variables added to a manual pipeline.

Fields

NameTypeDescription
idID!ID of the variable.
keyStringName of the variable.
valueStringValue of the variable.

PipelineMessage

Fields

NameTypeDescription
contentString!Content of the pipeline message.
idID!ID of the pipeline message.

PipelinePermissions

Fields

NameTypeDescription
adminPipelineBoolean!If true, the user can perform admin_pipeline on this resource.
cancelPipelineBoolean!If true, the user can perform cancel_pipeline on this resource.
destroyPipelineBoolean!If true, the user can perform destroy_pipeline on this resource.
updatePipelineBoolean!If true, the user can perform update_pipeline on this resource.

PipelineSchedule

Represents a pipeline schedule.

Fields

NameTypeDescription
activeBoolean!Indicates if the pipeline schedule is active.
createdAtTime!Timestamp of when the pipeline schedule was created.
cronString!Cron notation for the schedule.
cronTimezoneString!Timezone for the pipeline schedule.
descriptionStringDescription of the pipeline schedule.
editPathStringEdit path of the pipeline schedule.
forTagBoolean!Indicates if a pipelines schedule belongs to a tag.
idID!ID of the pipeline schedule.
lastPipelinePipelineLast pipeline object.
nextRunAtTimeTime when the next pipeline will run.
ownerUserCoreOwner of the pipeline schedule.
projectProjectProject of the pipeline schedule.
realNextRunTimeTime when the next pipeline will run.
refStringRef of the pipeline schedule.
refForDisplayStringGit ref for the pipeline schedule.
refPathStringPath to the ref that triggered the pipeline.
updatedAtTime!Timestamp of when the pipeline schedule was last updated.
userPermissionsPipelineSchedulePermissions!Permissions for the current user on the resource.
variablesPipelineScheduleVariableConnectionPipeline schedule variables. (see Connections)

PipelineSchedulePermissions

Fields

NameTypeDescription
adminPipelineScheduleBoolean!If true, the user can perform admin_pipeline_schedule on this resource.
playPipelineScheduleBoolean!If true, the user can perform play_pipeline_schedule on this resource.
takeOwnershipPipelineSchedule warning-solidBoolean!Deprecated in GitLab 15.9. Use admin_pipeline_schedule permission to determine if the user can take ownership of a pipeline schedule.
updatePipelineScheduleBoolean!If true, the user can perform update_pipeline_schedule on this resource.

PipelineScheduleVariable

Fields

NameTypeDescription
idID!ID of the variable.
keyStringName of the variable.
rawBooleanIndicates whether the variable is raw.
valueStringValue of the variable.
variableTypeCiVariableTypeType of the variable.

PipelineSecurityReportFinding

Represents vulnerability finding of a security report on the pipeline.

Fields

NameTypeDescription
aiResolutionAvailableBooleanIndicates whether the type of finding can be resolved with AI.
aiResolutionEnabledBooleanIndicates whether the specific finding can be resolved with AI.
assets[AssetType!]List of assets associated with the vulnerability.
descriptionStringDescription of the vulnerability finding.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
details[VulnerabilityDetail!]!Details of the security finding.
dismissalReasonVulnerabilityDismissalReasonReason for the dismissal of the security report finding.
dismissedAtTimeTime of the dismissal of the security report finding.
dismissedByUserCoreUser who dismissed the security report finding.
evidenceVulnerabilityEvidenceEvidence for the vulnerability.
falsePositiveBooleanIndicates whether the vulnerability is a false positive.
identifiers[VulnerabilityIdentifier!]!Identifiers of the vulnerability finding.
issueLinksVulnerabilityIssueLinkConnectionList of issue links related to the vulnerability. (see Connections)
links[VulnerabilityLink!]List of links associated with the vulnerability.
locationVulnerabilityLocationLocation metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability.
mergeRequestMergeRequestMerge request that fixes the vulnerability.
projectProjectProject on which the vulnerability finding was found.
projectFingerprint warning-solidStringDeprecated in GitLab 16.1. Use uuid instead.
remediations[VulnerabilityRemediationType!]Remediations of the security report finding.
reportTypeVulnerabilityReportTypeType of the security report that found the vulnerability finding.
scannerVulnerabilityScannerScanner metadata for the vulnerability.
severityVulnerabilitySeveritySeverity of the vulnerability finding.
severityOverridesSeverityOverrideConnectionList of severity changes for the vulnerability finding. (see Connections)
solutionStringSolution for resolving the security report finding.
solutionHtmlStringGitLab Flavored Markdown rendering of solution.
stateVulnerabilityStateFinding status.
stateCommentStringComment for the state of the security report finding.
titleStringTitle of the vulnerability finding.
userPermissionsPipelineSecurityReportFindingPermissions!Permissions for the current user on the resource.
uuidStringUUIDv5 digest based on the vulnerability’s report type, primary identifier, location, fingerprint, project identifier.
vulnerabilityVulnerabilityVulnerability related to the security report finding.

PipelineSecurityReportFindingPermissions

Check permissions for the current user on a vulnerability finding.

Fields

NameTypeDescription
adminVulnerabilityBoolean!If true, the user can perform admin_vulnerability on this resource.
createIssueBoolean!If true, the user can perform create_issue on this resource.

PipelineTrigger

Fields

NameTypeDescription
canAccessProjectBoolean!Indicates if the pipeline trigger token has access to the project.
descriptionStringDescription of the pipeline trigger token.
expiresAtTimeTimestamp of when the pipeline trigger token expires.
hasTokenExposedBoolean!Indicates if the token is exposed.
idID!ID of the pipeline trigger token.
lastUsedTimeTimestamp of the last usage of the pipeline trigger token.
ownerUserCore!Owner of the pipeline trigger token.
tokenString!Value of the pipeline trigger token.

PolicyAnyMergeRequestViolation

Represents policy violation for any_merge_request report_type.

Fields

NameTypeDescription
commitsJSONList of unsigned commits causing the violation. If policy targets any commits, it returns true.
nameString!Represents the policy name.

PolicyApprovalGroup

Fields

NameTypeDescription
avatarUrlStringAvatar URL of the group.
fullPathID!Full path of the namespace.
idID!ID of the namespace.
webUrlString!Web URL of the group.

PolicyApprovalSettingsOverride

Represents the approval settings of merge request overridden by a policy.

Fields

NameTypeDescription
editPath warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Path to edit the policy.
name warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Policy name.
settingsJSON!Overridden project approval settings.

PolicyApproversType

Multiple approvers action.

Fields

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

PolicyComparisonPipeline

Represents the source and target pipelines used for comparison in the policy evaluation.

Fields

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

PolicyError

Represents an error that can occur during policy evaluation.

Fields

NameTypeDescription
dataJSONRepresents the error-specific data.
errorPolicyViolationErrorType!Represents error code.
messageString!Represents the error message.
reportTypeApprovalReportType!Represents the report type.

PolicyLicenseScanningViolation

Represents policy violation for license_scanning report_type.

Fields

NameTypeDescription
dependencies[String!]!List of dependencies using the violated license.
licenseString!License name.
urlStringURL of the license.

PolicyProjectCreated

Response of security policy creation.

Fields

NameTypeDescription
errorMessage warning-solidStringDeprecated in GitLab 17.5. Use errors instead.
errors[String!]Error messages in case status is :error.
projectProjectSecurity Policy Project that was created.
statusPolicyProjectCreatedStatusStatus of the creation of the security policy project.

PolicyScanFindingViolation

Represents policy violation for scan_finding report_type.

Fields

NameTypeDescription
locationJSONLocation of the finding determined by the scanner.
nameStringRepresents the name of the finding.
pathStringRepresents the URL path to the finding.
reportTypeVulnerabilityReportType!Represents the report type.
severityVulnerabilitySeveritySeverity of the finding.

PolicyScope

Fields

NameTypeDescription
complianceFrameworksComplianceFrameworkConnection!Compliance Frameworks linked to the policy. (see Connections)
excludingGroupsGroupConnection!Groups to which the policy should not be applied. (see Connections)
excludingProjectsProjectConnection!Projects to which the policy should not be applied. (see Connections)
includingGroupsGroupConnection!Groups to which the policy should be applied. (see Connections)
includingProjectsProjectConnection!Projects to which the policy should be applied. (see Connections)

PolicyViolationDetails

Represents the details of merge request approval policy violations.

Fields

NameTypeDescription
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.
violationsCountInt!Total count of violations.

PolicyViolationInfo

Represents generic policy violation information.

Fields

NameTypeDescription
nameString!Represents the name of the violated policy.
reportTypeApprovalReportType!Represents the report type.
statusPolicyViolationStatusRepresents the status of the violated policy.

PreviewBillableUserChange

Fields

NameTypeDescription
newBillableUserCountIntTotal number of billable users after change.
seatsInSubscriptionIntNumber of seats in subscription.
willIncreaseOverageBooleanIf the group will have an increased overage after change.

ProductAnalyticsProjectSettings

Project-level settings for product analytics provider.

Fields

NameTypeDescription
cubeApiBaseUrlStringBase URL for the Cube API.
cubeApiKeyStringAPI key for the Cube API.
productAnalyticsConfiguratorConnectionStringStringConnection string for the product analytics configurator.
productAnalyticsDataCollectorHostStringHost for the product analytics data collector.

Project

Fields

NameTypeDescription
actualRepositorySizeLimitFloatSize limit for the repository in bytes.
agentConfigurationsAgentConfigurationConnectionAgent configurations defined by the project. (see Connections)
aiAgents warning-solidAiAgentConnectionIntroduced in GitLab 16.9. Status: Experiment. Ai Agents for the project.
aiUsageData warning-solidAiUsageDataIntroduced in GitLab 17.5. Status: Experiment. AI-related data.
aiXrayReports warning-solidAiXrayReportConnection!Introduced in GitLab 17.8. Status: Experiment. X-ray reports of the project.
allowMergeOnSkippedPipelineBooleanIf only_allow_merge_if_pipeline_succeeds is true, indicates if merge requests of the project can also be merged with skipped jobs.
allowedCustomStatuses warning-solidWorkItemWidgetCustomStatusConnectionIntroduced in GitLab 17.8. Status: Experiment. Allowed custom statuses for the project.
allowsMultipleMergeRequestAssigneesBoolean!Project allows assigning multiple users to a merge request.
allowsMultipleMergeRequestReviewersBoolean!Project allows assigning multiple reviewers to a merge request.
apiFuzzingCiConfigurationApiFuzzingCiConfigurationAPI fuzzing configuration for the project.
archivedBooleanIndicates the archived status of the project.
autocloseReferencedIssuesBooleanIndicates if issues referenced by merge requests and commits within the default branch are closed automatically.
avatarUrlStringURL to avatar image file of the project.
ciAccessAuthorizedAgentsClusterAgentAuthorizationCiAccessConnectionAuthorized cluster agents for the project through ci_access keyword. (see Connections)
ciCdSettingsProjectCiCdSettingCI/CD settings for the project.
ciConfigPathOrDefaultString!Path of the CI configuration file.
ciDownstreamProjectSubscriptions warning-solidCiProjectSubscriptionConnectionIntroduced in GitLab 17.6. Status: Experiment. Pipeline subscriptions where this project is the upstream project.When this project’s pipeline completes, a pipeline is triggered in the downstream project.
ciJobTokenAuthLogs warning-solidCiJobTokenAuthLogConnectionIntroduced in GitLab 17.6. Status: Experiment. The CI Job Tokens authorization logs.
ciJobTokenScopeCiJobTokenScopeTypeThe CI Job Tokens scope of access.
ciJobTokenScopeAllowlist warning-solidCiJobTokenScopeAllowlistIntroduced in GitLab 17.6. Status: Experiment. List of CI job token scopes where the project is the source.
ciSubscribedProjects warning-solidCiSubscriptionsProjectConnectionDeprecated in GitLab 17.6. Use ciDownstreamProjectSubscriptions.
ciSubscriptionsProjects warning-solidCiSubscriptionsProjectConnectionDeprecated in GitLab 17.6. Use ciUpstreamProjectSubscriptions.
ciUpstreamProjectSubscriptions warning-solidCiProjectSubscriptionConnectionIntroduced in GitLab 17.6. Status: Experiment. 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).
codeCoverageSummaryCodeCoverageSummaryCode coverage summary associated with the project.
complianceFrameworksComplianceFrameworkConnectionCompliance frameworks associated with the project. (see Connections)
componentUsagesCiCatalogResourceComponentUsageConnectionComponent(s) used by the project. (see Connections)
containerExpirationPolicy warning-solidContainerExpirationPolicyDeprecated in GitLab 17.5. Use container_tags_expiration_policy.
containerProtectionRepositoryRules warning-solidContainerProtectionRepositoryRuleConnectionIntroduced in GitLab 16.10. Status: Experiment. Container protection rules for the project.
containerProtectionTagRules warning-solidContainerProtectionTagRuleConnectionIntroduced in GitLab 17.8. Status: Experiment. Container repository tag protection rules for the project. Returns an empty array if the container_registry_protected_tags feature flag is disabled.
containerRegistryEnabledBooleanIndicates if Container Registry is enabled for the current user.
containerRepositoriesCountInt!Number of container repositories in the project.
containerTagsExpirationPolicyContainerTagsExpirationPolicyContainer tags expiration policy of the project.
corpusesCoverageFuzzingCorpusConnectionFind corpuses of the project. (see Connections)
createdAtTimeTimestamp of the project creation.
dastScannerProfilesDastScannerProfileConnectionDAST scanner profiles associated with the project. (see Connections)
dastSiteProfilesDastSiteProfileConnectionDAST Site Profiles associated with the project. (see Connections)
dependencyProxyPackagesSettingDependencyProxyPackagesSettingPackages 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.
descriptionStringShort description of the project.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
detailedImportStatusDetailedImportStatusDetailed import status of the project.
doraDoraProject’s DORA metrics.
duoFeaturesEnabled warning-solidBooleanIntroduced in GitLab 16.9. Status: Experiment. Indicates whether GitLab Duo features are enabled for the project.
duoWorkflowStatusCheck warning-solidDuoWorkflowEnablementIntroduced in GitLab 17.7. Status: Experiment. Indicates whether GitLab Duo Workflow is enabled for the project.
exploreCatalogPath warning-solidStringIntroduced in GitLab 17.6. Status: Experiment. Path to the project catalog resource.
flowMetrics warning-solidProjectValueStreamAnalyticsFlowMetricsIntroduced in GitLab 15.10. Status: Experiment. Flow metrics for value stream analytics.
forkingAccessLevelProjectFeatureAccessAccess level required for forking access.
forksCountInt!Number of times the project has been forked.
fullPathID!Full path of the project.
googleCloudArtifactRegistryRepository warning-solidGoogleCloudArtifactRegistryRepositoryIntroduced in GitLab 16.10. Status: Experiment. Google Artifact Registry repository. Returns null if the GitLab instance is not a SaaS instance.
grafanaIntegrationGrafanaIntegrationGrafana integration details for the project.
groupGroupGroup of the project.
hasJiraVulnerabilityIssueCreationEnabledBoolean!Indicates whether Jira issue creation from vulnerabilities is enabled.
httpUrlToRepoStringURL to connect to the project via HTTPS.
idID!ID of the project.
importStatusStringStatus of import background job of the project.
incidentManagementTimelineEventTags[TimelineEventTagType!]Timeline event tags for the project.
isAdjournedDeletionEnabled warning-solidBoolean!Introduced in GitLab 16.11. Status: Experiment. Indicates if delayed project deletion is enabled.
isCatalogResource warning-solidBooleanIntroduced in GitLab 15.11. Status: Experiment. Indicates if a project is a catalog resource.
isForkedBoolean!Project is forked.
issuesAccessLevelProjectFeatureAccessAccess level required for issues access.
issuesEnabledBooleanIndicates if Issues are enabled for the current user.
jiraImportStatusStringStatus of Jira import background job of the project.
jiraImportsJiraImportConnectionJira imports into the project. (see Connections)
jobsEnabledBooleanIndicates if CI/CD pipeline jobs are enabled for the current user.
languages[RepositoryLanguage!]Programming languages used in the project.
lastActivityAtTimeTimestamp of the project last activity.
lfsEnabledBooleanIndicates if the project has Large File Storage (LFS) enabled.
markedForDeletionOn warning-solidTimeIntroduced in GitLab 16.10. Status: Experiment. Date when project was scheduled to be deleted.
maxAccessLevelAccessLevel!The maximum access level of the current user in the project.
mergeCommitTemplateStringTemplate used to create merge commit message in merge requests.
mergeRequestsAccessLevelProjectFeatureAccessAccess level required for merge requests access.
mergeRequestsDisableCommittersApprovalBoolean!Indicates that committers of the given merge request cannot approve.
mergeRequestsEnabledBooleanIndicates if Merge requests are enabled for the current user.
mergeRequestsFfOnlyEnabledBooleanIndicates 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.
nameString!Name of the project (without namespace).
nameWithNamespaceString!Full name of the project with its namespace.
namespaceNamespaceNamespace of the project.
onlyAllowMergeIfAllDiscussionsAreResolvedBooleanIndicates if merge requests of the project can only be merged when all the discussions are resolved.
onlyAllowMergeIfAllStatusChecksPassedBooleanIndicates that merges of merge requests should be blocked unless all status checks have passed.
onlyAllowMergeIfPipelineSucceedsBooleanIndicates if merge requests of the project can only be merged with successful jobs.
openIssuesCountIntNumber of open issues for the project.
openMergeRequestsCountIntNumber of open merge requests for the project.
organizationEditPath warning-solidStringIntroduced in GitLab 16.11. Status: Experiment. Path for editing project at the organization level.
packagesCleanupPolicyPackagesCleanupPolicyPackages cleanup policy for the project.
packagesProtectionRules warning-solidPackagesProtectionRuleConnectionIntroduced in GitLab 16.6. Status: Experiment. Packages protection rules for the project.
pagesForceHttpsBoolean!Project’s Pages site redirects unsecured connections to HTTPS.
pagesUseUniqueDomainBoolean!Project’s Pages site uses a unique subdomain.
pathString!Path of the project.
pathLocksPathLockConnectionThe project’s path locks. (see Connections)
pendingMemberApprovals warning-solidMemberApprovalConnectionIntroduced in GitLab 17.3. Status: Experiment. Pending member promotions of the project.
permanentDeletionDate warning-solidStringIntroduced in GitLab 16.11. Status: Experiment. Date when project will be deleted if delayed project deletion is enabled.
pipelineTriggers warning-solidPipelineTriggerConnectionIntroduced in GitLab 16.3. Status: Experiment. List of pipeline trigger tokens.
preReceiveSecretDetectionEnabledBooleanIndicates whether Secret Push Protection is on or not for the project.
preventMergeWithoutJiraIssueEnabledBoolean!Indicates if an associated issue from Jira is required.
printingMergeRequestLinkEnabledBooleanIndicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line.
productAnalyticsInstrumentationKey warning-solidStringIntroduced in GitLab 16.0. Status: Experiment. Product Analytics instrumentation key assigned to the project.
productAnalyticsSettingsProductAnalyticsProjectSettingsProject-level settings for product analytics.
productAnalyticsState warning-solidProductAnalyticsStateIntroduced in GitLab 15.10. Status: Experiment. Current state of the product analytics stack for this project.Can only be called for one project in a single request.
projectPlanLimits warning-solidProjectPlanLimitsIntroduced in GitLab 16.9. Status: Experiment. Plan limits for the current project.
protectableBranches warning-solid[String!]Introduced in GitLab 16.9. Status: Experiment. List of unprotected branches, ignoring any wildcard branch rules.
publicJobsBooleanIndicates if there is public access to pipelines and job details of the project, including output logs and artifacts.
pushRulesPushRulesProject’s push rules settings.
recentIssueBoardsBoardConnectionList of recently visited boards of the project. Maximum size is 4. (see Connections)
removeSourceBranchAfterMergeBooleanIndicates if Delete source branch option should be enabled by default for all new merge requests of the project.
repositoryRepositoryGit repository of the project.
repositorySizeExcessFloatSize of repository that exceeds the limit in bytes.
requestAccessEnabledBooleanIndicates if users can request member access to the project.
requirementStatesCountRequirementStatesCountNumber of requirements for the project by their state.
sastCiConfigurationSastCiConfigurationSAST CI configuration for the project.
savedRepliesProjectSavedReplyConnectionSaved replies available to the project. (see Connections)
secretPushProtectionEnabledBooleanIndicates whether Secret Push Protection is on or not for the project.
securityDashboardPathStringPath to project’s security dashboard.
securityPolicyProjectProjectSecurity policy project assigned to the project, absent if assigned to a parent group.
securityPolicyProjectLinkedNamespaces warning-solidNamespaceConnectionDeprecated in GitLab 17.4. This was renamed. Use: security_policy_project_linked_groups.
securityPolicyProjectLinkedProjectsProjectConnectionProjects linked to the project, when used as Security Policy Project. (see Connections)
securityScannersSecurityScannersInformation about security analyzers used in the project.
sentryErrorsSentryErrorCollectionPaginated collection of Sentry errors on the project.
serviceDeskAddressStringE-mail address of the Service Desk.
serviceDeskEnabledBooleanIndicates if the project has Service Desk enabled.
sharedRunnersEnabledBooleanIndicates if shared runners are enabled for the project.
snippetsEnabledBooleanIndicates if Snippets are enabled for the current user.
squashCommitTemplateStringTemplate used to create squash commit message in merge requests.
squashReadOnlyBoolean!Indicates if squashReadOnly is enabled.
sshUrlToRepoStringURL to connect to the project via SSH.
starCountInt!Number of times the project has been starred.
statisticsProjectStatisticsStatistics of the project.
statisticsDetailsPathsProjectStatisticsRedirectRedirects for Statistics of the project.
suggestionCommitMessageStringCommit message used to apply merge request suggestions.
tagList warning-solidStringDeprecated in GitLab 13.12. Use topics.
targetBranchRulesProjectTargetBranchRuleConnectionTarget branch rules of the project. (see Connections)
terraformStatesTerraformStateConnectionTerraform states associated with the project. (see Connections)
timelogCategories warning-solidTimeTrackingTimelogCategoryConnectionIntroduced in GitLab 15.3. Status: Experiment. Timelog categories for the project.
topics[String!]List of project topics.
trackingKey warning-solidStringIntroduced in GitLab 16.0. Status: Experiment. Tracking key assigned to the project.
updatedAtTimeTimestamp of when the project was last updated.
userAccessAuthorizedAgentsClusterAgentAuthorizationUserAccessConnectionAuthorized cluster agents for the project through user_access keyword. (see Connections)
userPermissionsProjectPermissions!Permissions for the current user on the resource.
valueStreamAnalyticsValueStreamAnalyticsInformation about Value Stream Analytics within the project.
visibilityStringVisibility of the project.
vulnerabilityArchives warning-solid[VulnerabilityArchive!]Introduced in GitLab 17.9. Status: Experiment. All vulnerability archives of the project.
vulnerabilityImagesVulnerabilityContainerImageConnectionContainer images reported on the project vulnerabilities. (see Connections)
vulnerabilityScannersVulnerabilityScannerConnectionVulnerability scanners reported on the project vulnerabilities. (see Connections)
webUrlStringWeb URL of the project.
wikiEnabledBooleanIndicates if Wikis are enabled for the current user.

Fields with arguments

Project.aiAgent

Find a specific AI Agent.

  • Introduced in GitLab 16.10.
  • Status: Experiment.

Returns AiAgent.

Arguments
NameTypeDescription
idAiAgentID!ID of the Agent.
Project.aiMetrics

AI-related metrics.

  • Introduced in GitLab 16.11.
  • Status: Experiment.

Returns AiMetrics.

Arguments
NameTypeDescription
endDateDateDate range to end at. Default is the end of current month.
startDateDateDate range to start from. Default is the beginning of current month.
Project.aiUserMetrics

AI-related user metrics.

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Returns AiUserMetricsConnection.

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

Arguments
NameTypeDescription
endDateDateDate range to end at. Default is the end of current month.
startDateDateDate range to start from. Default is the beginning of current month.
Project.alertManagementAlert

A single Alert Management alert of the project.

Returns AlertManagementAlert.

Arguments
NameTypeDescription
assigneeUsernameStringUsername of a user assigned to the issue.
domainAlertManagementDomainFilter!Filter query for given domain.
iidStringIID of the alert. For example, “1”.
searchStringSearch query for title, description, service, or monitoring_tool.
sortAlertManagementAlertSortSort alerts by the criteria.
statuses[AlertManagementStatus!]Alerts with the specified statues. For example, [TRIGGERED].
Project.alertManagementAlertStatusCounts

Counts of alerts by status for the project.

Returns AlertManagementAlertStatusCountsType.

Arguments
NameTypeDescription
assigneeUsernameStringUsername of a user assigned to the issue.
searchStringSearch query for title, description, service, or monitoring_tool.
Project.alertManagementAlerts

Alert Management alerts of the project.

Returns AlertManagementAlertConnection.

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

Arguments
NameTypeDescription
assigneeUsernameStringUsername of a user assigned to the issue.
domainAlertManagementDomainFilter!Filter query for given domain.
iidStringIID of the alert. For example, “1”.
searchStringSearch query for title, description, service, or monitoring_tool.
sortAlertManagementAlertSortSort alerts by the criteria.
statuses[AlertManagementStatus!]Alerts with the specified statues. For example, [TRIGGERED].
Project.alertManagementHttpIntegrations

HTTP Integrations which can receive alerts for the project.

Returns AlertManagementHttpIntegrationConnection.

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

Arguments
NameTypeDescription
idAlertManagementHttpIntegrationIDID of the integration.
Project.alertManagementIntegrations

Integrations which can receive alerts for the project.

Returns AlertManagementIntegrationConnection.

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

Arguments
NameTypeDescription
idGlobalIDID of the integration.
Project.alertManagementPayloadFields

Extract alert fields from payload for custom mapping.

Returns [AlertManagementPayloadAlertField!].

Arguments
NameTypeDescription
payloadExampleString!Sample payload for extracting alert fields for custom mappings.
Project.approvalPolicies

Approval Policies of the project.

Returns ApprovalPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Project.autocompleteUsers

Search users for autocompletion.

Returns [AutocompletedUser!].

Arguments
NameTypeDescription
searchStringQuery to search users by name, username, or public email.
Project.availableDeployKeys

List of available deploy keys.

Returns AccessLevelDeployKeyConnection.

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

Arguments
NameTypeDescription
titleQueryStringTerm by which to search deploy key titles.
Project.board

A single board of the project.

Returns Board.

Arguments
NameTypeDescription
idBoardID!ID of the board.
Project.boards

Boards of the project.

Returns BoardConnection.

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

Arguments
NameTypeDescription
idBoardIDFind a board by its ID.
Project.branchRules

Branch rules configured for the project.

Returns BranchRuleConnection.

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

Arguments
NameTypeDescription
buildMissingBooleanReturn unpersisted custom branch rules.
Project.ciConfigVariables

CI/CD config variable.

  • Introduced in GitLab 15.3.
  • Status: Experiment.

Returns [CiConfigVariable!].

Arguments
NameTypeDescription
refString!Ref.
Project.ciPipelineCreationRequest

Get information about an asynchronous pipeline creation request.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Returns CiPipelineCreationRequest.

Arguments
NameTypeDescription
requestIdString!ID of the pipeline creation request.
Project.ciTemplate

Find a single CI/CD template by name.

Returns CiTemplate.

Arguments
NameTypeDescription
nameString!Name of the CI/CD template to search for. Template must be formatted as Name.gitlab-ci.yml.
Project.ciVariables

List of the project’s CI/CD variables.

Returns CiProjectVariableConnection.

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

Arguments
NameTypeDescription
sortCiVariableSortSort order of results.
Project.clusterAgent

Find a single cluster agent by name.

Returns ClusterAgent.

Arguments
NameTypeDescription
hasRemoteDevelopmentAgentConfig warning-solidBooleanDeprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabledBooleanReturns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilitiesBooleanReturns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfigBooleanReturns only cluster agents which have an associated workspaces agent config.
nameString!Name of the cluster agent.
Project.clusterAgents

Cluster agents associated with the project.

Returns ClusterAgentConnection.

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

Arguments
NameTypeDescription
hasRemoteDevelopmentAgentConfig warning-solidBooleanDeprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabledBooleanReturns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilitiesBooleanReturns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfigBooleanReturns only cluster agents which have an associated workspaces agent config.
Project.commitReferences

Get tag names containing a given commit.

  • Introduced in GitLab 16.0.
  • Status: Experiment.

Returns CommitReferences.

Arguments
NameTypeDescription
commitShaString!Project commit SHA identifier. For example, 287774414568010855642518513f085491644061.
Project.complianceStandardsAdherence

Compliance standards adherence for the project.

Returns ComplianceStandardsAdherenceConnection.

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

Arguments
NameTypeDescription
filtersComplianceStandardsProjectAdherenceInputFilters applied when retrieving compliance standards adherence.
Project.components

Find software dependencies by name.

  • Introduced in GitLab 17.9.
  • Status: Experiment.

Returns [Component!].

Arguments
NameTypeDescription
nameStringEntire name or part of the name.
Project.containerRepositories

Container repositories of the project.

Returns ContainerRepositoryConnection.

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

Arguments
NameTypeDescription
nameStringFilter the container repositories by their name.
sortContainerRepositorySortSort container repositories by the criteria.
Project.customizableDashboardVisualizations

Visualizations of the project or associated configuration project.

  • Introduced in GitLab 16.1.
  • Status: Experiment.

Returns CustomizableDashboardVisualizationConnection.

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

Arguments
NameTypeDescription
slugStringSlug of the visualization to return.
Project.customizableDashboards

Customizable dashboards for the project.

  • Introduced in GitLab 15.6.
  • Status: Experiment.

Returns CustomizableDashboardConnection.

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

Arguments
NameTypeDescription
categoryCustomizableDashboardCategoryFind by dashboard type.
slugStringFind by dashboard slug.
Project.dastProfile

DAST Profile associated with the project.

Returns DastProfile.

Arguments
NameTypeDescription
hasDastProfileScheduleBooleanFilter DAST Profiles by whether or not they have a schedule.
idDastProfileID!ID of the DAST Profile.
Project.dastProfiles

DAST Profiles associated with the project.

Returns DastProfileConnection.

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

Arguments
NameTypeDescription
hasDastProfileScheduleBooleanFilter DAST Profiles by whether or not they have a schedule.
Project.dastSiteProfile

DAST Site Profile associated with the project.

Returns DastSiteProfile.

Arguments
NameTypeDescription
idDastSiteProfileID!ID of the site profile.
Project.dastSiteValidations

DAST Site Validations associated with the project.

Returns DastSiteValidationConnection.

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

Arguments
NameTypeDescription
normalizedTargetUrls[String!]Normalized URL of the target to be scanned.
statusDastSiteValidationStatusEnumStatus of the site validation.
Project.dataTransfer

Data transfer data point for a specific period. This is mocked data under a development feature flag.

Returns ProjectDataTransfer.

Arguments
NameTypeDescription
fromDateRetain egress data for one year. Data for the current month will increase dynamically as egress occurs.
toDateEnd date for the data.
Project.dependencies

Software dependencies used by the project.

Returns DependencyConnection.

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

Arguments
NameTypeDescription
componentIds[SbomComponentID!]Filter dependencies by component IDs.
componentNames[String!]Filter dependencies by component names.
packageManagers[PackageManager!]Filter dependencies by package managers.
sortDependencySortSort dependencies by given criteria.
sourceTypes[SbomSourceType!]Filter dependencies by source type.
Project.deployment

Details of the deployment of the project.

Returns Deployment.

Arguments
NameTypeDescription
iidID!Project-level internal ID of the Deployment.
Project.environment

A single environment of the project.

Returns Environment.

Arguments
NameTypeDescription
nameStringName of the environment.
searchStringSearch query for environment name.
states[String!]States of environments that should be included in result.
typeStringSearch query for environment type.
Project.environments

Environments of the project. This field can only be resolved for one project in any single request.

Returns EnvironmentConnection.

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

Arguments
NameTypeDescription
nameStringName of the environment.
searchStringSearch query for environment name.
states[String!]States of environments that should be included in result.
typeStringSearch query for environment type.
Project.forkDetails

Details of the fork project compared to its upstream project.

  • Introduced in GitLab 15.7.
  • Status: Experiment.

Returns ForkDetails.

Arguments
NameTypeDescription
refStringRef of the fork. Default value is HEAD.
Project.forkTargets

Namespaces in which the current user can fork the project into.

Returns NamespaceConnection.

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

Arguments
NameTypeDescription
searchStringSearch query for path or name.
Project.gitlabSubscriptionsPreviewBillableUserChange

Preview Billable User Changes.

Returns PreviewBillableUserChange.

Arguments
NameTypeDescription
addGroupIdIntGroup ID to add.
addUserEmails[String!]User emails to add.
addUserIds[Int!]User IDs to add.
memberRoleIdIntCustom role assigned to the users.
roleGitlabSubscriptionsUserRole!Role of users being added to group.
Project.incidentManagementEscalationPolicies

Incident Management escalation policies of the project.

Returns EscalationPolicyTypeConnection.

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

Arguments
NameTypeDescription
nameStringFuzzy search by escalation policy name.
Project.incidentManagementEscalationPolicy

Incident Management escalation policy of the project.

Returns EscalationPolicyType.

Arguments
NameTypeDescription
idIncidentManagementEscalationPolicyID!ID of the escalation policy.
nameStringFuzzy search by escalation policy name.
Project.incidentManagementOncallSchedules

Incident Management On-call schedules of the project.

Returns IncidentManagementOncallScheduleConnection.

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

Arguments
NameTypeDescription
iids[ID!]IIDs of on-call schedules.
Project.incidentManagementTimelineEvent

Incident Management Timeline event associated with the incident.

Returns TimelineEventType.

Arguments
NameTypeDescription
idIncidentManagementTimelineEventID!ID of the timeline event.
incidentIdIssueID!ID of the incident.
Project.incidentManagementTimelineEvents

Incident Management Timeline events associated with the incident.

Returns TimelineEventTypeConnection.

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

Arguments
NameTypeDescription
incidentIdIssueID!ID of the incident.
Project.inheritedCiVariables

List of CI/CD variables the project inherited from its parent group and ancestors.

Returns InheritedCiVariableConnection.

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

Arguments
NameTypeDescription
sortCiGroupVariablesSortSort variables by the criteria.
Project.issue

A single issue of the project.

Returns Issue.

Arguments
NameTypeDescription
assigneeIdStringID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername warning-solidStringDeprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames[String!]Usernames of users assigned to the issue.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsernameStringUsername of the author of the issue.
closedAfterTimeIssues closed after the date.
closedBeforeTimeIssues closed before the date.
confidentialBooleanFilter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfterTimeIssues created after the date.
createdBeforeTimeIssues created before the date.
crmContactIdStringID of a contact assigned to the issues.
crmOrganizationIdStringID of an organization assigned to the issues.
dueAfterTimeReturn issues due on or after the given time.
dueBeforeTimeReturn issues due on or before the given time.
epicIdStringID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardIdEpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatus warning-solidHealthStatusDeprecated in GitLab 15.4. Use healthStatusFilter.
healthStatusFilterHealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iidStringIID 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.'.
includeSubepicsBooleanWhether 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.
iterationTitleStringFilter by iteration title.
iterationWildcardIdIterationWildcardIdFilter by iteration ID wildcard.
labelName[String]Labels applied to the issue.
milestoneTitle[String]Milestone applied to the issue.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
notNegatedIssueFilterInputNegated arguments.
orUnionedIssueFilterInputList of arguments with inclusive OR.
releaseTag[String!]Release tag associated with the issue’s milestone.
releaseTagWildcardIdReleaseTagWildcardIdFilter issues by release tag ID wildcard.
searchStringSearch query for title or description.
sortIssueSortSort issues by the criteria.
stateIssuableStateCurrent state of the issue.
subscribedSubscriptionStatusIssues the current user is subscribed to.
types[IssueType!]Filter issues by the given issue types.
updatedAfterTimeIssues updated after the date.
updatedBeforeTimeIssues updated before the date.
weightStringWeight applied to the issue, “none” and “any” values are supported.
weightWildcardIdWeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.
Project.issueStatusCounts

Counts of issues by status for the project.

Returns IssueStatusCountsType.

Arguments
NameTypeDescription
assigneeIdStringID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername warning-solidStringDeprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames[String!]Usernames of users assigned to the issue.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsernameStringUsername of the author of the issue.
closedAfterTimeIssues closed after the date.
closedBeforeTimeIssues closed before the date.
confidentialBooleanFilter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfterTimeIssues created after the date.
createdBeforeTimeIssues created before the date.
crmContactIdStringID of a contact assigned to the issues.
crmOrganizationIdStringID of an organization assigned to the issues.
dueAfterTimeReturn issues due on or after the given time.
dueBeforeTimeReturn issues due on or before the given time.
epicIdStringID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardIdEpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatusFilterHealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iidStringIID 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.'.
includeSubepicsBooleanWhether 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.
iterationTitleStringFilter by iteration title.
iterationWildcardIdIterationWildcardIdFilter by iteration ID wildcard.
labelName[String]Labels applied to the issue.
milestoneTitle[String]Milestone applied to the issue.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
notNegatedIssueFilterInputNegated arguments.
orUnionedIssueFilterInputList of arguments with inclusive OR.
releaseTag[String!]Release tag associated with the issue’s milestone.
releaseTagWildcardIdReleaseTagWildcardIdFilter issues by release tag ID wildcard.
searchStringSearch query for title or description.
subscribedSubscriptionStatusIssues the current user is subscribed to.
types[IssueType!]Filter issues by the given issue types.
updatedAfterTimeIssues updated after the date.
updatedBeforeTimeIssues updated before the date.
weightStringWeight applied to the issue, “none” and “any” values are supported.
weightWildcardIdWeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.
Project.issues

Issues of the project.

Returns IssueConnection.

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

Arguments
NameTypeDescription
assigneeIdStringID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername warning-solidStringDeprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames[String!]Usernames of users assigned to the issue.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsernameStringUsername of the author of the issue.
closedAfterTimeIssues closed after the date.
closedBeforeTimeIssues closed before the date.
confidentialBooleanFilter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfterTimeIssues created after the date.
createdBeforeTimeIssues created before the date.
crmContactIdStringID of a contact assigned to the issues.
crmOrganizationIdStringID of an organization assigned to the issues.
dueAfterTimeReturn issues due on or after the given time.
dueBeforeTimeReturn issues due on or before the given time.
epicIdStringID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardIdEpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatus warning-solidHealthStatusDeprecated in GitLab 15.4. Use healthStatusFilter.
healthStatusFilterHealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iidStringIID 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.'.
includeSubepicsBooleanWhether 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.
iterationTitleStringFilter by iteration title.
iterationWildcardIdIterationWildcardIdFilter by iteration ID wildcard.
labelName[String]Labels applied to the issue.
milestoneTitle[String]Milestone applied to the issue.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
notNegatedIssueFilterInputNegated arguments.
orUnionedIssueFilterInputList of arguments with inclusive OR.
releaseTag[String!]Release tag associated with the issue’s milestone.
releaseTagWildcardIdReleaseTagWildcardIdFilter issues by release tag ID wildcard.
searchStringSearch query for title or description.
sortIssueSortSort issues by the criteria.
stateIssuableStateCurrent state of the issue.
subscribedSubscriptionStatusIssues the current user is subscribed to.
types[IssueType!]Filter issues by the given issue types.
updatedAfterTimeIssues updated after the date.
updatedBeforeTimeIssues updated before the date.
weightStringWeight applied to the issue, “none” and “any” values are supported.
weightWildcardIdWeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.
Project.iterationCadences

Find iteration cadences.

Returns IterationCadenceConnection.

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

Arguments
NameTypeDescription
activeBooleanWhether the iteration cadence is active.
automaticBooleanWhether the iteration cadence should automatically generate upcoming iterations.
durationInWeeksIntDuration in weeks of the iterations within this cadence.
idIterationsCadenceIDGlobal ID of the iteration cadence to look up.
includeAncestorGroupsBooleanWhether to include ancestor groups to search iterations cadences in.
titleStringFuzzy search by title.
Project.iterations

Find iterations.

Returns IterationConnection.

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

Arguments
NameTypeDescription
idIDGlobal ID of the Iteration to look up.
iidIDInternal 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].
includeAncestorsBooleanWhether to include ancestor iterations. Defaults to true.
includeDescendantsBooleanWhether to include descendant iterations.
iterationCadenceIds[IterationsCadenceID!]Global iteration cadence IDs by which to look up the iterations.
searchStringQuery used for fuzzy-searching in the fields selected in the argument in. Returns all iterations if empty.
sortIterationSortList iterations by sort order. If unspecified, an arbitrary order (subject to change) is used.
stateIterationStateFilter iterations by state.
timeframeTimeframeList items overlapping the given timeframe.
title warning-solidStringDeprecated in GitLab 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
Project.job

One job belonging to the project, selected by ID.

Returns CiJob.

Arguments
NameTypeDescription
idJobID!ID of the job.
Project.jobs

Jobs of a project. This field can only be resolved for one project in any single request.

Returns CiJobConnection.

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

Arguments
NameTypeDescription
name warning-solidStringIntroduced in GitLab 17.1. Status: Experiment. Filter jobs by name.
sources warning-solid[CiJobSource!]Introduced in GitLab 17.7. Status: Experiment. Filter jobs by source. Ignored if ‘populate_and_use_build_source_table’ feature flag is disabled.
statuses[CiJobStatus!]Filter jobs by status.
withArtifactsBooleanFilter by artifacts presence.
Project.label

Label available on this project.

Returns Label.

Arguments
NameTypeDescription
titleString!Title of the label.
Project.labels

Labels available on this project.

Returns LabelConnection.

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

Arguments
NameTypeDescription
includeAncestorGroupsBooleanInclude labels from ancestor groups.
searchIn[LabelSearchFieldList!]!Specify which fields to search in. Ignored if using title.
searchTermStringSearch term to find labels with.
titleStringExact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.
Project.memberRoles

Member roles available for the group.

  • Introduced in GitLab 16.5.
  • Status: Experiment.

Returns MemberRoleConnection.

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

Arguments
NameTypeDescription
idMemberRoleIDGlobal ID of the member role to look up.
ids[MemberRoleID!]Global IDs of the member role to look up.
orderByMemberRolesOrderByOrdering column. Default is NAME.
sortSortDirectionEnumOrdering column. Default is ASC.
Project.mergeRequest

A single merge request of the project.

Returns MergeRequest.

Arguments
NameTypeDescription
iidString!IID of the merge request, for example 1.
Project.mergeRequestViolations

Compliance violations reported on merge requests merged within the project.

Returns ComplianceViolationConnection.

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

Arguments
NameTypeDescription
filtersComplianceViolationProjectInputFilters applied when retrieving compliance violations.
sortComplianceViolationSortList compliance violations by sort order.
Project.mergeRequests

Merge requests of the project.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
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 warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
Project.mergeTrains

Merge trains available to the project.

  • Introduced in GitLab 17.1.
  • Status: Experiment.

Returns MergeTrainConnection.

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

Arguments
NameTypeDescription
statusMergeTrainStatusFilter merge trains by a specific status.
targetBranches[String!]Filter merge trains by a list of target branches.
Project.milestones

Milestones of the project.

Returns MilestoneConnection.

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

Arguments
NameTypeDescription
containingDateTimeDate the milestone contains.
ids[ID!]Array of global milestone IDs, e.g., "gid://gitlab/Milestone/1".
includeAncestorsBooleanAlso return milestones in the project’s parent group and its ancestors.
searchTitleStringSearch string for the title.
sortMilestoneSortSort milestones by the criteria.
stateMilestoneStateEnumFilter milestones by state.
timeframeTimeframeList items overlapping the given timeframe.
titleStringTitle of the milestone.
Project.mlExperiments

Find machine learning experiments.

Returns MlExperimentConnection.

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

Arguments
NameTypeDescription
nameStringSearch for names that include the string.
orderByMlModelsOrderByOrdering column. Default is created_at.
sortSortDirectionEnumOrdering direction. Default is desc.
Project.mlModels

Finds machine learning models.

  • Introduced in GitLab 16.8.
  • Status: Experiment.

Returns MlModelConnection.

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

Arguments
NameTypeDescription
nameStringSearch for names that include the string.
orderByMlModelsOrderByOrdering column. Default is created_at.
sortSortDirectionEnumOrdering column. Default is desc.
Project.nestedEnvironments

Environments for this project with nested folders, can only be resolved for one project in any single request.

Returns NestedEnvironmentConnection.

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

Arguments
NameTypeDescription
nameStringName of the environment.
searchStringSearch query for environment name.
states[String!]States of environments that should be included in result.
typeStringSearch query for environment type.

Logs attached to the project.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns ObservabilityLogConnection.

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

Arguments
NameTypeDescription
fingerprintStringFingerprint of the log.
serviceNameStringService name of the log.
severityNumberIntSeverity number of the log.
timestampISO8601DateTimeLog timestamp of the log.
traceIdentifierStringTrace id of the log.

Metrics attached to the project.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns ObservabilityMetricConnection.

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

Arguments
NameTypeDescription
nameStringName of the metric.
typeOpenTelemetryMetricTypeType of the metric.

Traces attached to the project.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns ObservabilityTraceConnection.

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

Arguments
NameTypeDescription
traceIdentifierStringIdentifier of the trace.
Project.packages

Packages of the project.

Returns PackageConnection.

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

Arguments
NameTypeDescription
includeVersionlessBooleanInclude versionless packages.
packageNameStringSearch a package by name.
packageTypePackageTypeEnumFilter a package by type.
packageVersionStringFilter a package by version. If used in combination with include_versionless, then no versionless packages are returned.
sortPackageSortSort packages by the criteria.
statusPackageStatusFilter a package by status.
Project.pagesDeployments

List of the project’s Pages Deployments.

Returns PagesDeploymentConnection.

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

Arguments
NameTypeDescription
activeBooleanFilter by active or inactive state.
sortSortSort results.
versionedBooleanFilter deployments that are versioned or unversioned.
Project.pipeline

Pipeline of the project. If no arguments are provided, returns the latest pipeline for the head commit on the default branch.

Returns Pipeline.

Arguments
NameTypeDescription
idCiPipelineIDGlobal ID of the Pipeline. For example, “gid://gitlab/Ci::Pipeline/314”.
iidIDIID of the Pipeline. For example, “1”.
shaStringSHA of the Pipeline. For example, “dyd0f15ay83993f5ab66k927w28673882x99100b”.
Project.pipelineAnalytics

Pipeline analytics.

Returns PipelineAnalytics.

Arguments
NameTypeDescription
fromTime warning-solidTimeIntroduced in GitLab 17.5. Status: Experiment. Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref warning-solidStringIntroduced in GitLab 17.5. Status: Experiment. Branch that triggered the pipeline.
source warning-solidCiPipelineCiSourcesIntroduced in GitLab 17.5. Status: Experiment. Source of the pipeline.
toTime warning-solidTimeIntroduced in GitLab 17.5. Status: Experiment. End of the requested time (in UTC). Defaults to the pipelines started before the current date.
Project.pipelineCounts

Pipeline counts of the project.

Returns PipelineCounts.

Arguments
NameTypeDescription
refStringFilter pipelines by the ref they are run for.
shaStringFilter pipelines by the SHA of the commit they are run for.
sourceStringFilter pipelines by their source.
Project.pipelineExecutionPolicies

Pipeline Execution Policies of the project.

Returns PipelineExecutionPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Project.pipelineSchedules

Pipeline schedules of the project. This field can only be resolved for one project per request.

Returns PipelineScheduleConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filter pipeline schedules by IDs.
sortPipelineScheduleSortList pipeline schedules by sort order. Default is id_desc.
statusPipelineScheduleStatusFilter pipeline schedules by active status.
Project.pipelines

Pipelines of the project.

Returns PipelineConnection.

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

Arguments
NameTypeDescription
refStringFilter pipelines by the ref they are run for.
scopePipelineScopeEnumFilter pipelines by scope.
shaStringFilter pipelines by the sha of the commit they are run for.
sourceStringFilter pipelines by their source.
statusPipelineStatusEnumFilter pipelines by their status.
updatedAfterTimePipelines updated after the date.
updatedBeforeTimePipelines updated before the date.
usernameStringFilter pipelines by the user that triggered the pipeline.
Project.productAnalyticsEventsStored

Count of all events used, broken down by month.

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Returns [MonthlyUsage!].

Arguments
NameTypeDescription
monthSelection[MonthSelectionInput!]!Selection for the period to return.
Project.projectMembers

Members of the project.

Returns MemberInterfaceConnection.

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

Arguments
NameTypeDescription
relations[ProjectMemberRelation!]Filter members by the given member relations.
searchStringSearch query.
sortMemberSortsort query.
Project.release

A single release of the project.

Returns Release.

Arguments
NameTypeDescription
tagNameString!Name of the tag associated to the release.
Project.releases

Releases of the project.

Returns ReleaseConnection.

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

Arguments
NameTypeDescription
sortReleaseSortSort releases by given criteria.
Project.requirement

Find a single requirement.

Returns Requirement.

Arguments
NameTypeDescription
authorUsername[String!]Filter requirements by author username.
iid warning-solidIDDeprecated in GitLab 15.8. Use work_item_iid instead.
iids warning-solid[ID!]Deprecated in GitLab 15.8. Use work_item_iids instead.
lastTestReportStateRequirementStatusFilterState of latest requirement test report.
searchStringSearch query for requirement title.
sortSortList requirements by sort order.
stateRequirementStateFilter requirements by state.
workItemIidIDIID of the requirement work item, for example, “1”.
workItemIids[ID!]List of IIDs of requirement work items, for example, [1, 2].
Project.requirements

Find requirements.

Returns RequirementConnection.

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

Arguments
NameTypeDescription
authorUsername[String!]Filter requirements by author username.
iid warning-solidIDDeprecated in GitLab 15.8. Use work_item_iid instead.
iids warning-solid[ID!]Deprecated in GitLab 15.8. Use work_item_iids instead.
lastTestReportStateRequirementStatusFilterState of latest requirement test report.
searchStringSearch query for requirement title.
sortSortList requirements by sort order.
stateRequirementStateFilter requirements by state.
workItemIidIDIID of the requirement work item, for example, “1”.
workItemIids[ID!]List of IIDs of requirement work items, for example, [1, 2].
Project.runnerCloudProvisioning

Information used for provisioning the runner on a cloud provider. Returns null if the GitLab instance is not a SaaS instance.

  • Introduced in GitLab 16.9.
  • Status: Experiment.

Returns CiRunnerCloudProvisioning.

Arguments
NameTypeDescription
cloudProjectIdGoogleCloudProject!Identifier of the cloud project.
providerCiRunnerCloudProvider!Identifier of the cloud provider.
Project.runners

Find runners visible to the current user.

Returns CiRunnerConnection.

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

Arguments
NameTypeDescription
active warning-solidBooleanDeprecated in GitLab 14.8. This was renamed. Use: paused.
creatorIdUserIDFilter runners by creator ID.
creatorUsername warning-solidStringIntroduced in GitLab 16.7. Status: Experiment. Filter runners by creator username.
ownerFullPath warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Filter runners by owning project or group.
ownerWildcard warning-solidCiRunnerOwnerWildcardIntroduced in GitLab 17.8. Status: Experiment. Filter runners by owner wildcard.
pausedBooleanFilter runners by paused (true) or active (false) status.
searchStringFilter by full token or partial text in description field.
sortCiRunnerSortSort order of results.
statusCiRunnerStatusFilter runners by status.
tagList[String!]Filter by tags associated with the runner (comma-separated or array).
typeCiRunnerTypeFilter runners by type.
upgradeStatusCiRunnerUpgradeStatusFilter by upgrade status.
versionPrefix warning-solidStringIntroduced in GitLab 16.6. Status: Experiment. Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term ‘14.’ returns runner managers with versions ‘14.11.1’ and ‘14.2.3’.
Project.savedReply

Saved reply in the project.

Returns ProjectSavedReply.

Arguments
NameTypeDescription
idProjectsSavedReplyID!Global ID of a saved reply.
Project.scanExecutionPolicies

Scan Execution Policies of the project.

Returns ScanExecutionPolicyConnection.

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

Arguments
NameTypeDescription
actionScanTypes[SecurityReportTypeEnum!]Filters policies by the action scan type. Only these scan types are supported: dast, secret_detection, cluster_image_scanning, container_scanning, sast, sast_iac, dependency_scanning.
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Project.scanResultPolicies

Scan Result Policies of the project.

  • Deprecated in GitLab 16.9.
  • Use approvalPolicies.

Returns ScanResultPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Project.securityExclusion

A single security exclusion of a project.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns ProjectSecurityExclusion.

Arguments
NameTypeDescription
activeBooleanFilter entries by active status.
idSecurityProjectSecurityExclusionID!ID of the project security exclusion.
scannerExclusionScannerEnumFilter entries by scanner.
typeExclusionTypeEnumFilter entries by exclusion type.
Project.securityExclusions

Security exclusions of the project.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns ProjectSecurityExclusionConnection.

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

Arguments
NameTypeDescription
activeBooleanFilter entries by active status.
scannerExclusionScannerEnumFilter entries by scanner.
typeExclusionTypeEnumFilter entries by exclusion type.
Project.securityPolicyProjectLinkedGroups

Groups linked to the project, when used as Security Policy Project.

Returns GroupConnection.

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

Arguments
NameTypeDescription
ids[ID!]Filter groups by IDs.
searchStringSearch query for groups.
topLevelOnlyBooleanOnly include top-level groups.
Project.securityPolicyProjectSuggestions

Security policy project suggestions.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
onlyLinkedBooleanWhether to suggest only projects already linked as security policy projects.
searchString!Search query for projects’ full paths.
Project.securityTrainingProviders

List of security training providers for the project.

Returns [ProjectSecurityTraining!].

Arguments
NameTypeDescription
onlyEnabledBooleanFilter the list by only enabled security trainings.
Project.securityTrainingUrls

Security training URLs for the enabled training providers of the project.

Returns [SecurityTrainingUrl!].

Arguments
NameTypeDescription
filenameStringFilename to filter security training URLs by programming language.
identifierExternalIds[String!]!List of external IDs of vulnerability identifiers.
Project.sentryDetailedError

Detailed version of a Sentry error on the project.

Returns SentryDetailedError.

Arguments
NameTypeDescription
idGitlabErrorTrackingDetailedErrorID!ID of the Sentry issue.
Project.services

Project services.

  • Deprecated in GitLab 15.9.
  • A Project.integrations field is proposed instead in [issue 389904](https: //gitlab.com/gitlab-org/gitlab/-/issues/389904).

Returns ServiceConnection.

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

Arguments
NameTypeDescription
activeBooleanIndicates if the integration is active.
typeServiceTypeType of integration.
Project.snippets

Snippets of the project.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
visibilityVisibilityScopesEnumVisibility of the snippet.
Project.terraformState

Find a single Terraform state by name.

Returns TerraformState.

Arguments
NameTypeDescription
nameString!Name of the Terraform state.
Project.timelogs

Time logged on issues and merge requests in the project.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
Project.valueStreamDashboardUsageOverview

Aggregated usage counts within the project.

  • Introduced in GitLab 17.2.
  • Status: Experiment.

Returns ValueStreamDashboardCount.

Arguments
NameTypeDescription
identifierValueStreamDashboardProjectLevelMetric!Type of counts to retrieve.
timeframeTimeframe!Counts recorded during this time frame, usually from beginning of the month until the end of the month (the system runs monthly aggregations).
Project.valueStreams

Value streams available to the project.

Returns ValueStreamConnection.

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

Arguments
NameTypeDescription
idIDValue stream id.
Project.visibleForks

Visible forks of the project.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minimumAccessLevelAccessLevelEnumMinimum access level.
Project.vulnerabilities

Vulnerabilities reported on the project.

Returns VulnerabilityConnection.

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

Arguments
NameTypeDescription
clusterAgentId[ClustersAgentID!]Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId[ClustersClusterID!]Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason[VulnerabilityDismissalReason!]Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
hasAiResolution warning-solidBooleanIntroduced in GitLab 17.5. Status: Experiment. Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution. Requires the vulnerability_report_vr_filter feature flag to be enabled, otherwise the argument is ignored.
hasIssuesBooleanReturns only the vulnerabilities which have linked issues.
hasMergeRequestBooleanReturns only the vulnerabilities which have linked merge requests.
hasRemediationsBooleanReturns only the vulnerabilities which have remediations.
hasResolutionBooleanReturns only the vulnerabilities which have been resolved on default branch.
identifierNameStringFilter vulnerabilities by identifier name. Applicable on group level when feature flag vulnerability_filtering_by_identifier_group is enabled. 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.
owaspTopTen[VulnerabilityOwaspTop10!]Filter vulnerabilities by OWASP Top 10 category. Wildcard value “NONE” also supported and it cannot be combined with other OWASP top 10 values.
projectId[ID!]Filter vulnerabilities by project.
reportType[VulnerabilityReportType!]Filter vulnerabilities by report type.
scanner[String!]Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId[VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity[VulnerabilitySeverity!]Filter vulnerabilities by severity.
sortVulnerabilitySortList vulnerabilities by sort order.
state[VulnerabilityState!]Filter vulnerabilities by state.
Project.vulnerabilitiesCountByDay

The historical number of vulnerabilities per day for the project.

Returns VulnerabilitiesCountByDayConnection.

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

Arguments
NameTypeDescription
endDateISO8601Date!Last day for which to fetch vulnerability history.
startDateISO8601Date!First day for which to fetch vulnerability history.
Project.vulnerabilityIdentifierSearch

Search for vulnerabilities by identifier.

Returns [String!].

Arguments
NameTypeDescription
nameString!Search identifier by name. Substring or partial match search is supported and argument should be greater than 3 characters.
Project.vulnerabilityManagementPolicies

Vulnerability Management Policies of the project.

  • Introduced in GitLab 17.5.
  • Status: Experiment.

Returns VulnerabilityManagementPolicyConnection.

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

Arguments
NameTypeDescription
includeUnscopedBooleanFilter policies that are scoped to the project.
relationshipSecurityPolicyRelationTypeFilter policies by the given policy relationship.
Project.vulnerabilitySeveritiesCount

Counts for each vulnerability severity in the project.

Returns VulnerabilitySeveritiesCount.

Arguments
NameTypeDescription
cappedBooleanDefault value is false. When set to true, the count returned for each severity is capped at a maximum of 1001.
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.
hasAiResolution warning-solidBooleanIntroduced in GitLab 17.5. Status: Experiment. Filters vulnerabilities which can or can not be resolved by GitLab Duo Vulnerability Resolution. Requires the vulnerability_report_vr_filter feature flag to be enabled, otherwise the argument is ignored.
hasIssuesBooleanFilter vulnerabilities that do or do not have issues.
hasMergeRequestBooleanFilter vulnerabilities that do or do not have a merge request.
hasRemediationsBooleanFilter vulnerabilities that do or do not have remediations.
hasResolutionBooleanFilter vulnerabilities that do or do not have a resolution.
identifierName warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Filter vulnerabilities by identifier name. Applicable on group level when feature flag vulnerability_filtering_by_identifier_group is enabled. 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.
owaspTopTen[VulnerabilityOwaspTop10!]Filter vulnerabilities by OWASP Top 10 category. Wildcard value “NONE” also supported and it cannot be combined with other OWASP top 10 values.
projectId[ID!]Filter vulnerabilities by project.
reportType[VulnerabilityReportType!]Filter vulnerabilities by report type.
scanner[String!]Filter vulnerabilities by scanner.
scannerId[VulnerabilitiesScannerID!]Filter vulnerabilities by scanner ID.
severity[VulnerabilitySeverity!]Filter vulnerabilities by severity.
state[VulnerabilityState!]Filter vulnerabilities by state.
Project.workItemStateCounts

Counts of work items by state for the project.

  • Introduced in GitLab 16.7.
  • Status: Experiment.

Returns WorkItemStateCountsType.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
healthStatusHealthStatusFilterHealth status of the work item, “none” and “any” values are supported.
iidStringIID of the work item. For example, “1”.
iids[String!]List of IIDs of work items. For example, ["1", "2"].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
labelName[String!]Labels applied to the work item.
milestoneTitle[String!]Milestone applied to the work item.
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
requirementLegacyWidget warning-solidRequirementLegacyFilterInputDeprecated in GitLab 15.9. Use work item IID filter instead.
searchStringSearch query for title or description.
sortWorkItemSortSort work items by criteria.
stateIssuableStateCurrent state of the work item.
statusWidgetStatusFilterInputInput for status widget filter. Ignored if work_items_alpha is disabled.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.
weightStringWeight applied to the work item, “none” and “any” values are supported.
Project.workItemTypes

Work item types available to the project.

Returns WorkItemTypeConnection.

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

Arguments
NameTypeDescription
nameIssueTypeFilter work item types by the given name.
Project.workItems

Work items of the project.

  • Introduced in GitLab 15.1.
  • Status: Experiment.

Returns WorkItemConnection.

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

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the work item.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsernameStringFilter work items by author username.
closedAfterTimeWork items closed after the date.
closedBeforeTimeWork items closed before the date.
confidentialBooleanFilter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfterTimeWork items created after the timestamp.
createdBeforeTimeWork items created before the timestamp.
dueAfterTimeWork items due after the timestamp.
dueBeforeTimeWork items due before the timestamp.
healthStatusHealthStatusFilterHealth status of the work item, “none” and “any” values are supported.
iidStringIID of the work item. For example, “1”.
iids[String!]List of IIDs of work items. For example, ["1", "2"].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
labelName[String!]Labels applied to the work item.
milestoneTitle[String!]Milestone applied to the work item.
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
notNegatedWorkItemFilterInputNegated work item arguments.
orUnionedWorkItemFilterInputList of arguments with inclusive OR.
requirementLegacyWidget warning-solidRequirementLegacyFilterInputDeprecated in GitLab 15.9. Use work item IID filter instead.
searchStringSearch query for title or description.
sortWorkItemSortSort work items by criteria.
stateIssuableStateCurrent state of the work item.
statusWidgetStatusFilterInputInput for status widget filter. Ignored if work_items_alpha is disabled.
subscribedSubscriptionStatusWork items the current user is subscribed to.
types[IssueType!]Filter work items by the given work item types.
updatedAfterTimeWork items updated after the timestamp.
updatedBeforeTimeWork items updated before the timestamp.
weightStringWeight applied to the work item, “none” and “any” values are supported.

ProjectCiCdSetting

Fields

NameTypeDescription
inboundJobTokenScopeEnabledBooleanIndicates CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabledBooleanIndicates CI/CD job tokens generated in this project have restricted access to other projects.
keepLatestArtifactBooleanWhether to keep the latest builds artifacts.
mergePipelinesEnabledBooleanWhether merged results pipelines are enabled.
mergeTrainsEnabledBooleanWhether merge trains are enabled.
mergeTrainsSkipTrainAllowedBoolean!Whether merge immediately is allowed for merge trains.
projectProjectProject the CI/CD settings belong to.
pushRepositoryForJobTokenAllowedBooleanIndicates the ability to push to the original project repository using a job token.

ProjectDataTransfer

Fields

NameTypeDescription
egressNodesEgressNodeConnectionData nodes. (see Connections)
totalEgressBigIntTotal egress for that project in that period of time.

ProjectFeatureAccess

Represents the access level required by the user to access a project feature.

Fields

NameTypeDescription
integerValueIntInteger representation of access level.
stringValueProjectFeatureAccessLevelString representation of access level.

ProjectMember

Represents a Project Membership.

Fields

NameTypeDescription
accessLevelAccessLevelGitLab::Access level.
createdAtTimeDate and time the membership was created.
createdByUserCoreUser that authorized membership.
expiresAtTimeDate and time the membership expires.
idID!ID of the member.
projectProjectProject that User is a member of.
updatedAtTimeDate and time the membership was last updated.
userUserCoreUser that is associated with the member object.
userPermissionsProjectPermissions!Permissions for the current user on the resource.

Fields with arguments

ProjectMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
NameTypeDescription
idMergeRequestID!Global ID of the merge request.

ProjectPermissions

Fields

NameTypeDescription
adminOperationsBoolean!If true, the user can perform admin_operations on this resource.
adminPathLocksBoolean!If true, the user can perform admin_path_locks on this resource.
adminProjectBoolean!If true, the user can perform admin_project on this resource.
adminRemoteMirrorBoolean!If true, the user can perform admin_remote_mirror on this resource.
adminWikiBoolean!If true, the user can perform admin_wiki on this resource.
archiveProjectBoolean!If true, the user can perform archive_project on this resource.
changeNamespaceBoolean!If true, the user can perform change_namespace on this resource.
changeVisibilityLevelBoolean!If true, the user can perform change_visibility_level on this resource.
createDeploymentBoolean!If true, the user can perform create_deployment on this resource.
createDesignBoolean!If true, the user can perform create_design on this resource.
createIssueBoolean!If true, the user can perform create_issue on this resource.
createLabelBoolean!If true, the user can perform create_label on this resource.
createMergeRequestFromBoolean!If true, the user can perform create_merge_request_from on this resource.
createMergeRequestInBoolean!If true, the user can perform create_merge_request_in on this resource.
createPagesBoolean!If true, the user can perform create_pages on this resource.
createPipelineBoolean!If true, the user can perform create_pipeline on this resource.
createPipelineScheduleBoolean!If true, the user can perform create_pipeline_schedule on this resource.
createSnippetBoolean!If true, the user can perform create_snippet on this resource.
createWikiBoolean!If true, the user can perform create_wiki on this resource.
destroyDesignBoolean!If true, the user can perform destroy_design on this resource.
destroyPagesBoolean!If true, the user can perform destroy_pages on this resource.
destroyWikiBoolean!If true, the user can perform destroy_wiki on this resource.
downloadCodeBoolean!If true, the user can perform download_code on this resource.
downloadWikiCodeBoolean!If true, the user can perform download_wiki_code on this resource.
forkProjectBoolean!If true, the user can perform fork_project on this resource.
generateDescriptionBoolean!If true, the user can perform generate_description on this resource.
moveDesignBoolean!If true, the user can perform move_design on this resource.
pushCodeBoolean!If true, the user can perform push_code on this resource.
pushToDeleteProtectedBranchBoolean!If true, the user can perform push_to_delete_protected_branch on this resource.
readCommitStatusBoolean!If true, the user can perform read_commit_status on this resource.
readCycleAnalyticsBoolean!If true, the user can perform read_cycle_analytics on this resource.
readDesignBoolean!If true, the user can perform read_design on this resource.
readEnvironmentBoolean!If true, the user can perform read_environment on this resource.
readMergeRequestBoolean!If true, the user can perform read_merge_request on this resource.
readPagesContentBoolean!If true, the user can perform read_pages_content on this resource.
readProjectBoolean!If true, the user can perform read_project on this resource.
readProjectMemberBoolean!If true, the user can perform read_project_member on this resource.
readWikiBoolean!If true, the user can perform read_wiki on this resource.
removeForkProjectBoolean!If true, the user can perform remove_fork_project on this resource.
removePagesBoolean!If true, the user can perform remove_pages on this resource.
removeProjectBoolean!If true, the user can perform remove_project on this resource.
renameProjectBoolean!If true, the user can perform rename_project on this resource.
requestAccessBoolean!If true, the user can perform request_access on this resource.
updateDesignBoolean!If true, the user can perform update_design on this resource.
updatePagesBoolean!If true, the user can perform update_pages on this resource.
updateWikiBoolean!If true, the user can perform update_wiki on this resource.
uploadFileBoolean!If true, the user can perform upload_file on this resource.
viewEditPageBoolean!If true, the user can perform view_edit_page on this resource.

ProjectPlanLimits

Plan limits for the current project.

Fields

NameTypeDescription
ciPipelineSchedulesIntMaximum number of pipeline schedules allowed per project.

ProjectRepositoryRegistry

Represents the Geo replication and verification state of a project repository.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the ProjectRepositoryRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the ProjectRepositoryRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the ProjectRepositoryRegistry.
lastSyncFailureStringError message during sync of the ProjectRepositoryRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the ProjectRepositoryRegistry.
missingOnPrimaryBooleanIndicate if the ProjectRepositoryRegistry is missing on primary.
modelRecordIdIntID of the ProjectRepositoryRegistry’s model record.
projectIdID!ID of the Project.
retryAtTimeTimestamp after which the ProjectRepositoryRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the ProjectRepositoryRegistry.
stateRegistryStateSync state of the ProjectRepositoryRegistry.
verificationChecksumStringThe local checksum of the ProjectRepositoryRegistry.
verificationChecksumMismatchedStringThe expected checksum of the ProjectRepositoryRegistry in case of mismatch.
verificationFailureStringError message during verification of the ProjectRepositoryRegistry.
verificationRetryAtTimeTimestamp after which the ProjectRepositoryRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the ProjectRepositoryRegistry.
verificationStartedAtTimeTimestamp when the verification of ProjectRepositoryRegistry started.
verificationStateVerificationStateEnumVerification state of the ProjectRepositoryRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the ProjectRepositoryRegistry.

ProjectSavedReply

Fields

NameTypeDescription
contentString!Content of the saved reply.
idProjectsSavedReplyID!Global ID of the project-level saved reply.
nameString!Name of the saved reply.

ProjectSecret

Representation of a project secret.

Fields

NameTypeDescription
branchString!Branches that can access the secret.
descriptionStringDescription of the project secret.
environmentString!Environments that can access the secret.
nameString!Name of the project secret.
projectProject!Project the secret belong to.

ProjectSecretsManager

Representation of a project secrets manager.

Fields

NameTypeDescription
ciSecretsMountPathString!Mount path of the secrets engine for the project.
projectProject!Project the secrets manager belong to.
statusProjectSecretsManagerStatusStatus of the project secrets manager.

ProjectSecurityExclusion

Represents a project-level security scanner exclusion.

Fields

NameTypeDescription
activeBoolean!Whether the exclusion is active.
createdAtTime!Timestamp of when the exclusion was created.
descriptionStringOptional description for the exclusion.
idSecurityProjectSecurityExclusionID!ID of the exclusion.
scannerExclusionScannerEnum!Security scanner the exclusion will be used for.
typeExclusionTypeEnum!Type of the exclusion.
updatedAtTime!Timestamp of when the exclusion was updated.
valueString!Value of the exclusion.

ProjectSecurityPolicySource

Represents the source of a security policy belonging to a project.

Fields

NameTypeDescription
projectProjectProject the policy is associated with.

ProjectSecurityTraining

Fields

NameTypeDescription
descriptionStringDescription of the training provider.
idGlobalID!ID of the training provider.
isEnabledBoolean!Represents whether the provider is enabled or not.
isPrimaryBoolean!Represents whether the provider is set as primary or not.
logoUrlStringLogo URL of the provider.
nameString!Name of the training provider.
urlString!URL of the provider.

ProjectSetting

Fields

NameTypeDescription
duoFeaturesEnabledBooleanIndicates whether GitLab Duo features are enabled for the project.
projectProjectProject the settings belong to.

ProjectStatistics

Fields

NameTypeDescription
buildArtifactsSizeFloat!Build artifacts size of the project in bytes.
commitCountFloat!Commit count of the project.
containerRegistrySizeFloatContainer Registry size of the project in bytes.
costFactoredBuildArtifactsSize warning-solidFloat!Introduced in GitLab 16.6. Status: Experiment. 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 warning-solidFloat!Introduced in GitLab 16.6. Status: Experiment. 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 warning-solidFloat!Introduced in GitLab 16.6. Status: Experiment. 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 warning-solidFloat!Introduced in GitLab 16.6. Status: Experiment. 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 warning-solidFloat!Introduced in GitLab 16.6. Status: Experiment. 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 warning-solidFloat!Introduced in GitLab 16.2. Status: Experiment. 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 warning-solidFloat!Introduced in GitLab 16.6. Status: Experiment. Wiki size in bytes with any applicable cost factor for forks applied. This will equal wiki_size if there is no applicable cost factor.
lfsObjectsSizeFloat!Large File Storage (LFS) object size of the project in bytes.
packagesSizeFloat!Packages size of the project in bytes.
pipelineArtifactsSizeFloatCI Pipeline artifacts size in bytes.
repositorySizeFloat!Repository size of the project in bytes.
snippetsSizeFloatSnippets size of the project in bytes.
storageSizeFloat!Storage size of the project in bytes.
uploadsSizeFloatUploads size of the project in bytes.
wikiSizeFloatWiki size of the project in bytes.

ProjectStatisticsRedirect

Fields

NameTypeDescription
buildArtifactsString!Redirection Route for job_artifacts.
containerRegistryString!Redirection Route for container_registry.
packagesString!Redirection Route for packages.
repositoryString!Redirection Route for repository.
snippetsString!Redirection Route for snippets.
wikiString!Redirection Route for wiki.

ProjectTargetBranchRule

Fields

NameTypeDescription
createdAtTime!Timestamp of when the target branch rule was created.
idProjectsTargetBranchRuleID!ID of the target branch rule.
nameString!Name of the target branch rule.
targetBranchString!Target branch for the target branch rule.

ProjectValueStreamAnalyticsFlowMetrics

Exposes aggregated value stream flow metrics.

Fields with arguments

ProjectValueStreamAnalyticsFlowMetrics.cycleTime

Median time from first commit to issue closed.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue.
authorUsernameStringUsername of the author of the issue.
epicIdIDID of an epic associated with the issues.
fromTime!Timestamp marking the start date and time.
iterationIdIDID of an iteration associated with the issues.
labelNames[String!]Labels applied to the issue.
milestoneTitleStringMilestone applied to the issue.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
toTime!Timestamp marking the end date and time.
weightIntWeight applied to the issue.
ProjectValueStreamAnalyticsFlowMetrics.deploymentCount

Number of production deployments in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
fromTime!Timestamp marking the start date and time.
toTime!Timestamp marking the end date and time.
ProjectValueStreamAnalyticsFlowMetrics.issueCount

Number of issues opened in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue.
authorUsernameStringUsername of the author of the issue.
epicIdIDID of an epic associated with the issues.
fromTime!Timestamp marking the start date and time.
iterationIdIDID of an iteration associated with the issues.
labelNames[String!]Labels applied to the issue.
milestoneTitleStringMilestone applied to the issue.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
toTime!Timestamp marking the end date and time.
weightIntWeight applied to the issue.
ProjectValueStreamAnalyticsFlowMetrics.issuesCompletedCount

Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue.
authorUsernameStringUsername of the author of the issue.
epicIdIDID of an epic associated with the issues.
fromTime!Timestamp marking the start date and time.
iterationIdIDID of an iteration associated with the issues.
labelNames[String!]Labels applied to the issue.
milestoneTitleStringMilestone applied to the issue.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
toTime!Timestamp marking the end date and time.
weightIntWeight applied to the issue.
ProjectValueStreamAnalyticsFlowMetrics.leadTime

Median time from when the issue was created to when it was closed.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue.
authorUsernameStringUsername of the author of the issue.
epicIdIDID of an epic associated with the issues.
fromTime!Timestamp marking the start date and time.
iterationIdIDID of an iteration associated with the issues.
labelNames[String!]Labels applied to the issue.
milestoneTitleStringMilestone applied to the issue.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
toTime!Timestamp marking the end date and time.
weightIntWeight applied to the issue.
ProjectValueStreamAnalyticsFlowMetrics.timeToMerge

Median time from merge request creation to merge request merged.

Returns ValueStreamAnalyticsMetric.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the merge request.
authorUsernameStringUsername of the author of the merge request.
fromTime!Timestamp marking the start date and time.
labelNames[String!]Labels applied to the merge request.
milestoneTitleStringMilestone applied to the merge request.
toTime!Timestamp marking the end date and time.

ProjectWikiRepositoryRegistry

Represents the Geo replication and verification state of a project_wiki_repository.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the ProjectWikiRepositoryRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the ProjectWikiRepositoryRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the ProjectWikiRepositoryRegistry.
lastSyncFailureStringError message during sync of the ProjectWikiRepositoryRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the ProjectWikiRepositoryRegistry.
missingOnPrimaryBooleanIndicate if the ProjectWikiRepositoryRegistry is missing on primary.
modelRecordIdIntID of the ProjectWikiRepositoryRegistry’s model record.
projectWikiRepositoryIdID!ID of the Project Wiki Repository.
retryAtTimeTimestamp after which the ProjectWikiRepositoryRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the ProjectWikiRepositoryRegistry.
stateRegistryStateSync state of the ProjectWikiRepositoryRegistry.
verificationChecksumStringThe local checksum of the ProjectWikiRepositoryRegistry.
verificationChecksumMismatchedStringThe expected checksum of the ProjectWikiRepositoryRegistry in case of mismatch.
verificationFailureStringError message during verification of the ProjectWikiRepositoryRegistry.
verificationRetryAtTimeTimestamp after which the ProjectWikiRepositoryRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the ProjectWikiRepositoryRegistry.
verificationStartedAtTimeTimestamp when the verification of ProjectWikiRepositoryRegistry started.
verificationStateVerificationStateEnumVerification state of the ProjectWikiRepositoryRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the ProjectWikiRepositoryRegistry.

PrometheusAlert

The alert condition for Prometheus.

Fields

NameTypeDescription
humanizedTextString!Human-readable text of the alert condition.
idID!ID of the alert condition.

ProtectedEnvironment

Protected Environments of the environment.

Fields

NameTypeDescription
approvalRulesProtectedEnvironmentApprovalRuleConnectionWhich group, user or role is allowed to approve deployments to the environment. (see Connections)
deployAccessLevelsProtectedEnvironmentDeployAccessLevelConnectionWhich group, user or role is allowed to execute deployments to the environment. (see Connections)
groupGroupGroup details. Present if it’s group-level protected environment.
nameStringName of the environment if it’s a project-level protected environment. Tier of the environment if it’s a group-level protected environment.
projectProjectProject details. Present if it’s project-level protected environment.
requiredApprovalCountIntRequired approval count for Unified Approval Setting.

ProtectedEnvironmentApprovalRule

Which group, user or role is allowed to approve deployments to the environment.

Fields

NameTypeDescription
accessLevelAccessLevelRole details. Present if it’s role specific access control.
groupGroupGroup details. Present if it’s group specific access control.
requiredApprovalsIntNumber of required approvals.
userUserCoreUser details. Present if it’s user specific access control.

ProtectedEnvironmentApprovalRuleForSummary

Which group, user or role is allowed to approve deployments to the environment.

Fields

NameTypeDescription
accessLevelAccessLevelRole details. Present if it’s role specific access control.
approvals[DeploymentApproval!]Current approvals of the deployment.
approvedCountIntApproved count.
canApproveBooleanIndicates whether a user is authorized to approve.
groupGroupGroup details. Present if it’s group specific access control.
pendingApprovalCountIntPending approval count.
requiredApprovalsIntNumber of required approvals.
statusDeploymentApprovalSummaryStatusStatus of the approval summary.
userUserCoreUser details. Present if it’s user specific access control.

ProtectedEnvironmentDeployAccessLevel

Which group, user or role is allowed to execute deployments to the environment.

Fields

NameTypeDescription
accessLevelAccessLevelRole details. Present if it’s role specific access control.
groupGroupGroup details. Present if it’s group specific access control.
userUserCoreUser details. Present if it’s user specific access control.

PushAccessLevel

Defines which user roles, users, or groups can push to a protected branch.

Fields

NameTypeDescription
accessLevelInt!GitLab::Access level.
accessLevelDescriptionString!Human readable representation for the access level.
deployKeyAccessLevelDeployKeyDeploy key assigned to the access level.
groupAccessLevelGroupGroup associated with this access level.
userAccessLevelUserUser associated with this access level.

PushRules

Represents rules that commit pushes must follow.

Fields

NameTypeDescription
rejectUnsignedCommitsBoolean!Indicates whether commits not signed through GPG will be rejected.

PypiMetadata

Pypi metadata.

Fields

NameTypeDescription
authorEmailStringAuthor email address(es) in RFC-822 format.
descriptionStringLonger description that can run to several paragraphs.
descriptionContentTypeStringMarkup syntax used in the description field.
idPackagesPypiMetadatumID!ID of the metadatum.
keywordsStringList of keywords, separated by commas.
metadataVersionStringMetadata version.
requiredPythonStringRequired Python version of the Pypi package.
summaryStringOne-line summary of the description.

QueryComplexity

Fields

NameTypeDescription
limitIntGraphQL query complexity limit. See GitLab documentation on this limit.
scoreIntGraphQL query complexity score.

QueueingDelayHistory

Aggregated statistics about queueing times for CI jobs.

Fields

NameTypeDescription
timeSeries[QueueingHistoryTimeSeries!]Time series.

QueueingHistoryTimeSeries

The amount of time for a job to be picked up by a runner, in percentiles.

Fields

NameTypeDescription
p50Duration50th percentile. 50% of the durations are lower than this value.
p75Duration75th percentile. 75% of the durations are lower than this value.
p90Duration90th percentile. 90% of the durations are lower than this value.
p95Duration95th percentile. 95% of the durations are lower than this value.
p99Duration99th percentile. 99% of the durations are lower than this value.
timeTime!Start of the time interval.

QuickActionsStatus

Fields

NameTypeDescription
commandNames[String!]Quick action command names.
commandsOnlyBooleanReturns 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

NameTypeDescription
baseBranchStringName of the base branch of the project.
countIntNumber of times the test case has failed in the past 14 days.

Release

Represents a release.

Fields

NameTypeDescription
assetsReleaseAssetsAssets of the release.
authorUserCoreUser that created the release.
commitCommitCommit associated with the release.
createdAtTimeTimestamp of when the release was created.
descriptionStringDescription (also known as “release notes”) of the release.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
evidencesReleaseEvidenceConnectionEvidence for the release. (see Connections)
historicalReleaseBooleanIndicates the release is an historical release.
idReleaseID!Global ID of the release.
linksReleaseLinksLinks of the release.
milestonesMilestoneConnectionMilestones associated to the release. (see Connections)
nameStringName of the release.
releasedAtTimeTimestamp of when the release was released.
tagNameStringName of the tag associated with the release.
tagPathStringRelative web path to the tag associated with the release.
upcomingReleaseBooleanIndicates the release is an upcoming release.

Represents an asset link associated with a release.

Fields

NameTypeDescription
directAssetPathStringRelative path for the direct asset link.
directAssetUrlStringDirect asset URL of the link.
idID!ID of the link.
linkTypeReleaseAssetLinkTypeType of the link: other, runbook, image, package; defaults to other.
nameStringName of the link.
urlStringURL of the link.

ReleaseAssets

A container for all assets associated with a release.

Fields

NameTypeDescription
countIntNumber of assets of the release.
linksReleaseAssetLinkConnectionAsset links of the release. (see Connections)
sourcesReleaseSourceConnectionSources of the release. (see Connections)

ReleaseEvidence

Evidence for a release.

Fields

NameTypeDescription
collectedAtTimeTimestamp when the evidence was collected.
filepathStringURL from where the evidence can be downloaded.
idID!ID of the evidence.
shaStringSHA1 ID of the evidence hash.

Fields

NameTypeDescription
closedIssuesUrlStringHTTP URL of the issues page, filtered by this release and state=closed.
closedMergeRequestsUrlStringHTTP URL of the merge request page , filtered by this release and state=closed.
editUrlStringHTTP URL of the release’s edit page.
mergedMergeRequestsUrlStringHTTP URL of the merge request page , filtered by this release and state=merged.
openedIssuesUrlStringHTTP URL of the issues page, filtered by this release and state=open.
openedMergeRequestsUrlStringHTTP URL of the merge request page, filtered by this release and state=open.
selfUrlStringHTTP URL of the release.

ReleaseSource

Represents the source code attached to a release in a particular format.

Fields

NameTypeDescription
formatStringFormat of the source.
urlStringDownload URL of the source.

RemoteDevelopmentAgentConfig

Represents a remote development agent configuration.

Fields

NameTypeDescription
clusterAgentClusterAgent!Cluster agent that the remote development agent config belongs to.
createdAtTime!Timestamp of when the remote development agent config was created.
defaultMaxHoursBeforeTerminationInt!Default max hours before worksapce termination of the remote development agent config.
dnsZoneString!DNS zone where workspaces are available.
enabledBoolean!Indicates whether remote development is enabled for the GitLab agent.
gitlabWorkspacesProxyNamespaceString!Namespace where gitlab-workspaces-proxy is installed.
idRemoteDevelopmentRemoteDevelopmentAgentConfigID!Global ID of the remote development agent config.
maxHoursBeforeTerminationLimitInt!Max hours before worksapce termination limit of the remote development agent config.
networkPolicyEnabledBoolean!Whether the network policy of the remote development agent config is enabled.
projectIdIDID of the project that the remote development agent config belongs to.
updatedAtTime!Timestamp of the last update to any mutable remote development agent config property.
workspacesPerUserQuotaInt!Maximum number of workspaces per user.
workspacesQuotaInt!Maximum number of workspaces for the GitLab agent.

Repository

Fields

NameTypeDescription
diskPathStringShows a disk path of the repository.
emptyBoolean!Indicates repository has no visible content.
existsBoolean!Indicates a corresponding Git repository exists on disk.
rootRefStringDefault branch of the repository.

Fields with arguments

Repository.blobs

Blobs contained within the repository.

Returns RepositoryBlobConnection.

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

Arguments
NameTypeDescription
paths[String!]!Array of desired blob paths.
refStringCommit ref to get the blobs from. Default value is HEAD.
refTypeRefTypeType of ref.
Repository.branchNames

Names of branches available in this repository that match the search pattern.

Returns [String!].

Arguments
NameTypeDescription
limitInt!Number of branch names to return.
offsetInt!Number of branch names to skip.
searchPatternString!Pattern to search for branch names by.
Repository.codeOwnersPath

Path to CODEOWNERS file in a ref.

Returns String.

Arguments
NameTypeDescription
refStringName of the ref.
Repository.paginatedTree

Paginated tree of the repository.

Returns TreeConnection.

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

Arguments
NameTypeDescription
pathStringPath to get the tree for. Default value is the root of the repository.
recursiveBooleanUsed to get a recursive tree. Default is false.
refStringCommit ref to get the tree for. Default value is HEAD.
refTypeRefTypeType of ref.
Repository.tree

Tree of the repository.

Returns Tree.

Arguments
NameTypeDescription
pathStringPath to get the tree for. Default value is the root of the repository.
recursiveBooleanUsed to get a recursive tree. Default is false.
refStringCommit ref to get the tree for. Default value is HEAD.
refTypeRefTypeType of ref.
Repository.validateCodeownerFile

Shows linting errors in the CODEOWNER file of the repository.

Returns RepositoryCodeownerValidation.

Arguments
NameTypeDescription
pathStringPath of a file called CODEOWNERS that should be validated. Default to file in use.
refStringRef where code owners file needs to be checked. Defaults to the repository’s default branch.

RepositoryBlob

Fields

NameTypeDescription
archivedBooleanWhether the current project is archived.
base64EncodedBlob warning-solidStringIntroduced in GitLab 17.1. Status: Experiment. Content of blob is encoded base64. Returns null if the unicode_escaped_data feature flag is disabled.
blamePathStringWeb path to blob blame page.
canCurrentUserPushToBranchBooleanWhether the current user can push to the branch.
canModifyBlobBooleanWhether the current user can modify the blob.
canModifyBlobWithWebIdeBoolean!Whether the current user can modify the blob with Web IDE.
codeNavigationPathStringWeb path for code navigation.
codeOwners[UserCore!]List of code owners for the blob.
editBlobPathStringWeb path to edit the blob in the old-style editor.
environmentExternalUrlForRouteMapStringWeb path to blob on an environment.
environmentFormattedExternalUrlStringEnvironment on which the blob is available.
externalStorageStringExternal storage being used, if enabled (for instance, ‘LFS’).
externalStorageUrlStringWeb path to download the raw blob via external storage, if enabled.
fileTypeStringExpected format of the blob based on the extension.
findFilePathStringWeb path to find file.
forkAndEditPathStringWeb path to edit this blob using a forked project.
forkAndViewPathStringWeb path to view this blob using a forked project.
gitpodBlobUrlStringURL to the blob within Gitpod.
historyPathStringWeb path to blob history page.
idID!ID of the blob.
ideEditPathStringWeb path to edit this blob in the Web IDE.
ideForkAndEditPathStringWeb path to edit this blob in the Web IDE using a forked project.
languageStringBlob language.
lfsOidStringLFS OID of the blob.
modeStringBlob mode.
nameStringBlob name.
oidString!OID of the blob.
pathString!Path of the blob.
permalinkPathStringWeb path to blob permalink.
pipelineEditorPathStringWeb path to edit .gitlab-ci.yml file.
plainDataStringBlob plain highlighted data.
projectBlobPathRootStringWeb path for the root of the blob.
rawBlobStringRaw content of the blob.
rawPathStringWeb path to download the raw blob.
rawSizeBigIntSize (in bytes) of the blob, or the blob target if stored externally.
rawTextBlobStringRaw content of the blob, if the blob is text data.
replacePathStringWeb path to replace the blob content.
richViewerBlobViewerBlob content rich viewer.
simpleViewerBlobViewer!Blob content simple viewer.
sizeBigIntSize (in bytes) of the blob.
storedExternallyBooleanWhether the blob’s content is stored externally (for instance, in LFS).
webPathStringWeb path of the blob.

Fields with arguments

RepositoryBlob.blame

Blob blame.

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Returns Blame.

Arguments
NameTypeDescription
fromLineIntRange starting from the line. Cannot be less than 1 or greater than to_line.
toLineIntRange ending on the line. Cannot be smaller than from_line or greater than from_line + 100.

RepositoryCodeownerError

Fields

NameTypeDescription
codeString!Linting error code.
lines[Int!]!Lines where the error occurred.

RepositoryCodeownerValidation

Fields

NameTypeDescription
totalInt!Total number of validation error in the file.
validationErrors[RepositoryCodeownerError!]!Specific lint error code.

RepositoryLanguage

Fields

NameTypeDescription
colorColorColor to visualize the repository language.
nameString!Name of the repository language.
shareFloatPercentage of the repository’s languages.

Requirement

Represents a requirement.

Fields

NameTypeDescription
authorUserCore!Author of the requirement.
createdAtTime!Timestamp of when the requirement was created.
descriptionStringDescription of the requirement.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
idID!ID of the requirement.
iid warning-solidString!Deprecated in GitLab 15.8. Use work_item_iid instead.
lastTestReportManuallyCreatedBooleanIndicates if latest test report was created by user.
lastTestReportStateTestReportStateLatest requirement test report state.
projectProject!Project to which the requirement belongs.
stateRequirementState!State of the requirement.
titleStringTitle of the requirement.
titleHtmlStringGitLab Flavored Markdown rendering of title.
updatedAtTime!Timestamp of when the requirement was last updated.
userPermissionsRequirementPermissions!Permissions for the current user on the resource.
workItemIidString!Work item IID of the requirement, will replace current IID as identifier soon.

Fields with arguments

Requirement.testReports

Test reports of the requirement.

Returns TestReportConnection.

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

Arguments
NameTypeDescription
sortSortList test reports by sort order.

RequirementPermissions

Check permissions for the current user on a requirement.

Fields

NameTypeDescription
adminRequirementBoolean!If true, the user can perform admin_requirement on this resource.
createRequirementBoolean!If true, the user can perform create_requirement on this resource.
destroyRequirementBoolean!If true, the user can perform destroy_requirement on this resource.
readRequirementBoolean!If true, the user can perform read_requirement on this resource.
updateRequirementBoolean!If true, the user can perform update_requirement on this resource.

RequirementStatesCount

Counts of requirements by their state.

Fields

NameTypeDescription
archivedIntNumber of archived requirements.
openedIntNumber of opened requirements.

ResourceQuotas

Resource quotas of a workspace.

Fields

NameTypeDescription
cpuString!Number of cpu cores.
memoryString!Bytes of memory.

RootStorageStatistics

Fields

NameTypeDescription
buildArtifactsSizeFloat!CI artifacts size in bytes.
containerRegistrySizeFloat!Container Registry size in bytes.
containerRegistrySizeIsEstimatedBoolean!Indicates whether the deduplicated Container Registry size for the namespace is an estimated value or not.
costFactoredStorageSize warning-solidFloat!Introduced in GitLab 16.2. Status: Experiment. Total storage in bytes with any applicable cost factor for forks applied. This will equal storage_size if there is no applicable cost factor.
dependencyProxySizeFloat!Dependency Proxy sizes in bytes.
lfsObjectsSizeFloat!LFS objects size in bytes.
packagesSizeFloat!Packages size in bytes.
pipelineArtifactsSizeFloat!CI pipeline artifacts size in bytes.
registrySizeEstimated warning-solidBoolean!Deprecated in GitLab 16.2. Use container_registry_size_is_estimated.
repositorySizeFloat!Git repository size in bytes.
snippetsSizeFloat!Snippets size in bytes.
storageSizeFloat!Total storage in bytes.
uploadsSizeFloat!Uploads size in bytes.
wikiSizeFloat!Wiki size in bytes.

RunnerArchitecture

Fields

NameTypeDescription
downloadLocationString!Download location for the runner for the platform architecture.
nameString!Name of the runner platform architecture.

RunnerPermissions

Fields

NameTypeDescription
assignRunnerBoolean!If true, the user can perform assign_runner on this resource.
deleteRunnerBoolean!If true, the user can perform delete_runner on this resource.
readRunnerBoolean!If true, the user can perform read_runner on this resource.
updateRunnerBoolean!If true, the user can perform update_runner on this resource.

RunnerPlatform

Fields

NameTypeDescription
architecturesRunnerArchitectureConnectionRunner architectures supported for the platform. (see Connections)
humanReadableNameString!Human readable name of the runner platform.
nameString!Name slug of the runner platform.

RunnerSetup

Fields

NameTypeDescription
installInstructionsString!Instructions for installing the runner on the specified architecture.
registerInstructionsStringInstructions for registering the runner. The actual registration tokens are not included in the commands. Instead, a placeholder $REGISTRATION_TOKEN is shown.

SastCiConfiguration

Represents a CI configuration of SAST.

Fields

NameTypeDescription
analyzersSastCiConfigurationAnalyzersEntityConnectionList of analyzers entities attached to SAST configuration. (see Connections)
globalSastCiConfigurationEntityConnectionList of global entities related to SAST configuration. (see Connections)
pipelineSastCiConfigurationEntityConnectionList of pipeline entities related to SAST configuration. (see Connections)

SastCiConfigurationAnalyzersEntity

Represents an analyzer entity in SAST CI configuration.

Fields

NameTypeDescription
descriptionStringAnalyzer description that is displayed on the form.
enabledBooleanIndicates whether an analyzer is enabled.
labelStringAnalyzer label used in the config UI.
nameStringName of the analyzer.
variablesSastCiConfigurationEntityConnectionList of supported variables. (see Connections)

SastCiConfigurationEntity

Represents an entity in SAST CI configuration.

Fields

NameTypeDescription
defaultValueStringDefault value that is used if value is empty.
descriptionStringEntity description that is displayed on the form.
fieldStringCI keyword of entity.
labelStringLabel for entity used in the form.
optionsSastCiConfigurationOptionsEntityConnectionDifferent possible values of the field. (see Connections)
sizeSastUiComponentSizeSize of the UI component.
typeStringType of the field value.
valueStringCurrent value of the entity.

SastCiConfigurationOptionsEntity

Represents an entity for options in SAST CI configuration.

Fields

NameTypeDescription
labelStringLabel of option entity.
valueStringValue of option entity.

SavedReply

Fields

NameTypeDescription
contentString!Content of the saved reply.
idUsersSavedReplyID!Global ID of the user saved reply.
nameString!Name of the saved reply.

Scan

Represents the security scan information.

Fields

NameTypeDescription
errors[String!]!List of errors.
nameString!Name of the scan.
statusScanStatus!Indicates the status of the scan.
warnings[String!]!List of warnings.

ScanExecutionPolicy

Represents the scan execution policy.

Fields

NameTypeDescription
deprecatedProperties warning-solid[String!]Introduced in GitLab 17.3. Status: Experiment. All deprecated properties in the policy.
descriptionString!Description of the policy.
editPathString!URL of policy edit page.
enabledBoolean!Indicates whether this policy is enabled.
nameString!Name of the policy.
policyScopePolicyScopeScope of the policy.
sourceSecurityPolicySource!Source of the policy. Its fields depend on the source type.
updatedAtTime!Timestamp of when the policy YAML was last updated.
yamlString!YAML definition of the policy.

ScanResultPolicy

Represents the scan result policy.

Fields

NameTypeDescription
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 warning-solid[String!]Introduced in GitLab 16.10. Status: Experiment. All deprecated properties in the policy.
descriptionString!Description of the policy.
editPathString!URL of policy edit page.
enabledBoolean!Indicates whether this policy is enabled.
nameString!Name of the policy.
policyScopePolicyScopeScope of the policy.
roleApprovers[MemberAccessLevelName!]Approvers of the role type. Users belonging to these role(s) alone will be approvers.
sourceSecurityPolicySource!Source of the policy. Its fields depend on the source type.
updatedAtTime!Timestamp of when the policy YAML was last updated.
userApprovers[UserCore!]Approvers of the user type.
yamlString!YAML definition of the policy.

ScannedResource

Represents a resource scanned by a security scan.

Fields

NameTypeDescription
requestMethodStringHTTP request method used to access the URL.
urlStringURL scanned by the scanner.

SearchBlobChunk

JSON structure of a matched chunk.

Fields

NameTypeDescription
lines warning-solid[SearchBlobLine!]Introduced in GitLab 17.2. Status: Experiment. Path of the file.
matchCountInChunk warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Number of matches in the chunk.

SearchBlobFileType

JSON structure of a file with matches.

Fields

NameTypeDescription
blameUrl warning-solidStringIntroduced in GitLab 17.2. Status: Experiment. Blame URL of the file.
chunks warning-solid[SearchBlobChunk!]Introduced in GitLab 17.2. Status: Experiment. Maximum matches per file.
fileUrl warning-solidStringIntroduced in GitLab 17.2. Status: Experiment. URL of the file.
language warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Language of the file.
matchCount warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Matches per file up to a max of 50 chunks. Default is 3.
matchCountTotal warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Total number of matches per file.
path warning-solidStringIntroduced in GitLab 17.2. Status: Experiment. Path of the file.
projectPath warning-solidStringIntroduced in GitLab 17.2. Status: Experiment. Full path of the project.

SearchBlobLine

JSON structure of each line in a matched chunk.

Fields

NameTypeDescription
highlights warning-solid[[Int!]!]Introduced in GitLab 17.8. Status: Experiment. Column numbers of the first and last highlighted characters on a line.
lineNumber warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Line number of the blob.
text warning-solidStringIntroduced in GitLab 17.2. Status: Experiment. Text content of the blob.

SecurityPolicyValidationError

Security policy validation error.

Fields

NameTypeDescription
fieldString!Error field.
indexIntIndex of the errored action.
levelString!Error level.
messageString!Error message.
titleStringError title.

SecurityReportSummary

Represents summary of a security report.

Fields

NameTypeDescription
apiFuzzingSecurityReportSummarySectionAggregated counts for the api_fuzzing scan.
clusterImageScanningSecurityReportSummarySectionAggregated counts for the cluster_image_scanning scan.
containerScanningSecurityReportSummarySectionAggregated counts for the container_scanning scan.
containerScanningForRegistrySecurityReportSummarySectionAggregated counts for the container_scanning_for_registry scan.
coverageFuzzingSecurityReportSummarySectionAggregated counts for the coverage_fuzzing scan.
dastSecurityReportSummarySectionAggregated counts for the dast scan.
dependencyScanningSecurityReportSummarySectionAggregated counts for the dependency_scanning scan.
genericSecurityReportSummarySectionAggregated counts for the generic scan.
sastSecurityReportSummarySectionAggregated counts for the sast scan.
secretDetectionSecurityReportSummarySectionAggregated counts for the secret_detection scan.

SecurityReportSummarySection

Represents a section of a summary of a security report.

Fields

NameTypeDescription
scannedResourcesScannedResourceConnectionList of the first 20 scanned resources. (see Connections)
scannedResourcesCountIntTotal number of scanned resources.
scannedResourcesCsvPathStringPath to download all the scanned resources in CSV format.
scansScanConnection!List of security scans ran for the type. (see Connections)
vulnerabilitiesCountIntTotal number of vulnerabilities.

SecurityScanners

Represents a list of security scanners.

Fields

NameTypeDescription
available[SecurityScannerType!]List of analyzers which are available for the project.
enabled[SecurityScannerType!]List of analyzers which are enabled for the project.
pipelineRun[SecurityScannerType!]List of analyzers which ran successfully in the latest pipeline.

SecurityTrainingUrl

Represents a URL related to a security training.

Fields

NameTypeDescription
identifierStringName of the vulnerability identifier.
nameStringName of the training provider.
statusTrainingUrlRequestStatusStatus of the request to training provider.
urlStringURL of the link for security training content.

SentryDetailedError

A Sentry error.

Fields

NameTypeDescription
countInt!Count of occurrences.
culpritString!Culprit of the error.
externalBaseUrlString!External Base URL of the Sentry Instance.
externalUrlString!External URL of the error.
firstReleaseLastCommitStringCommit the error was first seen.
firstReleaseShortVersionStringRelease short version the error was first seen.
firstReleaseVersionStringRelease version the error was first seen.
firstSeenTime!Timestamp when the error was first seen.
frequency[SentryErrorFrequency!]!Last 24hr stats of the error.
gitlabCommitStringGitLab commit SHA attributed to the Error based on the release version.
gitlabCommitPathStringPath to the GitLab page for the GitLab commit attributed to the error.
gitlabIssuePathStringURL of GitLab Issue.
idID!ID (global ID) of the error.
integratedBooleanError tracking backend.
lastReleaseLastCommitStringCommit the error was last seen.
lastReleaseShortVersionStringRelease short version the error was last seen.
lastReleaseVersionStringRelease version the error was last seen.
lastSeenTime!Timestamp when the error was last seen.
messageStringSentry metadata message of the error.
sentryIdString!ID (Sentry ID) of the error.
sentryProjectIdID!ID of the project (Sentry project).
sentryProjectNameString!Name of the project affected by the error.
sentryProjectSlugString!Slug of the project affected by the error.
shortIdString!Short ID (Sentry ID) of the error.
statusSentryErrorStatus!Status of the error.
tagsSentryErrorTags!Tags associated with the Sentry Error.
titleString!Title of the error.
typeString!Type of the error.
userCountInt!Count of users affected by the error.

SentryError

A Sentry error. A simplified version of SentryDetailedError.

Fields

NameTypeDescription
countInt!Count of occurrences.
culpritString!Culprit of the error.
externalUrlString!External URL of the error.
firstSeenTime!Timestamp when the error was first seen.
frequency[SentryErrorFrequency!]!Last 24hr stats of the error.
idID!ID (global ID) of the error.
lastSeenTime!Timestamp when the error was last seen.
messageStringSentry metadata message of the error.
sentryIdString!ID (Sentry ID) of the error.
sentryProjectIdID!ID of the project (Sentry project).
sentryProjectNameString!Name of the project affected by the error.
sentryProjectSlugString!Slug of the project affected by the error.
shortIdString!Short ID (Sentry ID) of the error.
statusSentryErrorStatus!Status of the error.
titleString!Title of the error.
typeString!Type of the error.
userCountInt!Count of users affected by the error.

SentryErrorCollection

An object containing a collection of Sentry errors, and a detailed error.

Fields

NameTypeDescription
externalUrlStringExternal URL for Sentry.

Fields with arguments

SentryErrorCollection.detailedError

Detailed version of a Sentry error on the project.

Returns SentryDetailedError.

Arguments
NameTypeDescription
idGitlabErrorTrackingDetailedErrorID!ID of the Sentry issue.
SentryErrorCollection.errorStackTrace

Stack Trace of Sentry Error.

Returns SentryErrorStackTrace.

Arguments
NameTypeDescription
idGitlabErrorTrackingDetailedErrorID!ID of the Sentry issue.
SentryErrorCollection.errors

Collection of Sentry Errors.

Returns SentryErrorConnection.

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

Arguments
NameTypeDescription
searchTermStringSearch query for the Sentry error details.
sortStringAttribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default.

SentryErrorFrequency

Fields

NameTypeDescription
countInt!Count of errors received since the previously recorded time.
timeTime!Time the error frequency stats were recorded.

SentryErrorStackTrace

An object containing a stack trace entry for a Sentry error.

Fields

NameTypeDescription
dateReceivedString!Time the stack trace was received by Sentry.
issueIdString!ID of the Sentry error.
stackTraceEntries[SentryErrorStackTraceEntry!]!Stack trace entries for the Sentry error.

SentryErrorStackTraceContext

An object context for a Sentry error stack trace.

Fields

NameTypeDescription
codeString!Code number of the context.
lineInt!Line number of the context.

SentryErrorStackTraceEntry

An object containing a stack trace entry for a Sentry error.

Fields

NameTypeDescription
colStringFunction in which the Sentry error occurred.
fileNameStringFile in which the Sentry error occurred.
functionStringFunction in which the Sentry error occurred.
lineStringFunction in which the Sentry error occurred.
traceContext[SentryErrorStackTraceContext!]Context of the Sentry error.

SentryErrorTags

State of a Sentry error.

Fields

NameTypeDescription
levelStringSeverity level of the Sentry Error.
loggerStringLogger of the Sentry Error.

SeverityOverride

Represents a vulnerability severity override.

Fields

NameTypeDescription
authorUserCore!User who changed the severity.
createdAtTimeTime of severity change.
newSeverityVulnerabilitySeverity!New severity of the vulnerability.
originalSeverityVulnerabilitySeverity!Original severity of the vulnerability.

SlashCommand

Duo Chat slash command.

Fields

NameTypeDescription
descriptionString!Description of what the slash command does.
nameString!Name of the slash command.
shouldSubmitBoolean!Indicates whether the command should be submitted automatically when clicked.

Snippet

Represents a snippet entry.

Fields

NameTypeDescription
authorUserCoreOwner of the snippet.
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
createdAtTime!Timestamp this snippet was created.
descriptionStringDescription of the snippet.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
fileNameStringFile Name of the snippet.
hiddenBoolean!Indicates the snippet is hidden because the author has been banned.
httpUrlToRepoStringHTTP URL to the snippet repository.
idSnippetID!ID of the snippet.
importedBoolean!Indicates whether the snippet was imported.
importedFromImportSource!Import source of the snippet.
projectProjectProject the snippet is associated with.
rawUrlString!Raw URL of the snippet.
sshUrlToRepoStringSSH URL to the snippet repository.
titleString!Title of the snippet.
updatedAtTime!Timestamp this snippet was updated.
userPermissionsSnippetPermissions!Permissions for the current user on the resource.
visibilityLevelVisibilityLevelsEnum!Visibility Level of the snippet.
webUrlString!Web URL of the snippet.

Fields with arguments

Snippet.blobs

Snippet blobs.

Returns SnippetBlobConnection.

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

Arguments
NameTypeDescription
paths[String!]Paths of the blobs.
Snippet.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.

SnippetBlob

Represents the snippet blob.

Fields

NameTypeDescription
binaryBoolean!Shows whether the blob is binary.
externalStorageStringBlob external storage.
modeStringBlob mode.
nameStringBlob name.
pathStringBlob path.
plainDataStringBlob plain highlighted data.
rawPathString!Blob raw content endpoint path.
rawPlainDataStringRaw content of the blob, if the blob is text data.
renderedAsTextBoolean!Shows whether the blob is rendered as text.
richDataStringBlob highlighted data.
richViewerSnippetBlobViewerBlob content rich viewer.
simpleViewerSnippetBlobViewer!Blob content simple viewer.
sizeInt!Blob size.

SnippetBlobViewer

Represents how the blob content should be displayed.

Fields

NameTypeDescription
collapsedBoolean!Shows whether the blob should be displayed collapsed.
fileTypeString!Content file type.
loadAsyncBoolean!Shows whether the blob content is loaded asynchronously.
loadingPartialNameString!Loading partial name.
renderErrorStringError rendering the blob content.
tooLargeBoolean!Shows whether the blob is too large to be displayed.
typeBlobViewersType!Type of blob viewer.

SnippetPermissions

Fields

NameTypeDescription
adminSnippetBoolean!If true, the user can perform admin_snippet on this resource.
awardEmojiBoolean!If true, the user can perform award_emoji on this resource.
createNoteBoolean!If true, the user can perform create_note on this resource.
readSnippetBoolean!If true, the user can perform read_snippet on this resource.
reportSnippetBoolean!If true, the user can perform report_snippet on this resource.
updateSnippetBoolean!If true, the user can perform update_snippet on this resource.

SnippetRepositoryRegistry

Represents the Geo sync and verification state of a snippet repository.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the SnippetRepositoryRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the SnippetRepositoryRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the SnippetRepositoryRegistry.
lastSyncFailureStringError message during sync of the SnippetRepositoryRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the SnippetRepositoryRegistry.
missingOnPrimaryBooleanIndicate if the SnippetRepositoryRegistry is missing on primary.
modelRecordIdIntID of the SnippetRepositoryRegistry’s model record.
retryAtTimeTimestamp after which the SnippetRepositoryRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the SnippetRepositoryRegistry.
snippetRepositoryIdID!ID of the Snippet Repository.
stateRegistryStateSync state of the SnippetRepositoryRegistry.
verificationChecksumStringThe local checksum of the SnippetRepositoryRegistry.
verificationChecksumMismatchedStringThe expected checksum of the SnippetRepositoryRegistry in case of mismatch.
verificationFailureStringError message during verification of the SnippetRepositoryRegistry.
verificationRetryAtTimeTimestamp after which the SnippetRepositoryRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the SnippetRepositoryRegistry.
verificationStartedAtTimeTimestamp when the verification of SnippetRepositoryRegistry started.
verificationStateVerificationStateEnumVerification state of the SnippetRepositoryRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the SnippetRepositoryRegistry.

SquashOption

Squash option overrides for a protected branch.

Fields

NameTypeDescription
helpTextString!Help text for the squash option.
optionString!Human-readable description of the squash option.

SshSignature

SSH signature for a signed commit.

Fields

NameTypeDescription
commitShaStringSHA of the associated commit.
keyKeySSH key used for the signature.
keyFingerprintSha256StringFingerprint of the key.
projectProjectProject of the associated commit.
userUserCoreUser associated with the key.
verificationStatusVerificationStatusIndicates verification status of the associated key or certificate.

StandardRole

Represents a standard role.

Fields

NameTypeDescription
accessLevelInt!Access level as a number.
descriptionStringRole description.
detailsPath warning-solidStringIntroduced in GitLab 17.4. Status: Experiment. URL path to the role details webpage.
idID!Role ID.
membersCount warning-solidIntIntroduced in GitLab 17.3. Status: Experiment. Number of times the role has been directly assigned to a group or project member.
nameStringRole name.
usersCount warning-solidIntIntroduced in GitLab 17.5. Status: Experiment. Number of users who have been directly assigned the role in at least one group or project.

StandardsAdherenceChecksStatus

Progress of standards adherence checks.

Fields

NameTypeDescription
checksCompletedInt!Number of adherence checks successfully completed.
startedAtTime!UTC timestamp when the adherence checks scan was started.
totalChecksInt!Number of adherence checks multiplied by the number of projects in the group.

StatusAction

Fields

NameTypeDescription
buttonTitleStringTitle for the button, for example: Retry the job.
confirmationMessage warning-solidStringIntroduced in GitLab 17.0. Status: Experiment. Custom confirmation message for a manual job.
iconStringIcon used in the action button.
idString!ID for a status action.
methodStringMethod for the action, for example: :post.
pathStringPath for the action.
titleStringTitle for the action, for example: Retry.

StringExpression

an expression with a string value.

Fields

NameTypeDescription
fieldString!Field the expression applies to.
operatorString!Operator of the expression.
valueString!String value of the expression.

Submodule

Fields

NameTypeDescription
flatPathString!Flat path of the entry.
idID!ID of the entry.
nameString!Name of the entry.
pathString!Path of the entry.
shaString!SHA of the entry.
treeUrlStringTree URL for the sub-module.
typeEntryType!Type of tree entry.
webUrlStringWeb URL for the sub-module.

SubscriptionFutureEntry

Represents an entry from the future subscriptions.

Fields

NameTypeDescription
companyStringCompany of the licensee.
emailStringEmail of the licensee.
expiresAtDateDate when the license expires.
nameStringName of the licensee.
planString!Name of the subscription plan.
startsAtDateDate when the license started.
typeString!Type of license the subscription will yield.
usersInLicenseCountIntNumber of paid user seats.

SuggestedReviewersType

Represents a Suggested Reviewers result set.

Fields

NameTypeDescription
accepted[String!]List of accepted reviewer usernames.
createdAtTime!Timestamp of when the suggestions were created.
suggested[String!]!List of suggested reviewer usernames.
updatedAtTime!Timestamp of when the suggestions were updated.

SystemNoteMetadata

Fields

NameTypeDescription
actionStringSystem note metadata action.
descriptionVersionDescriptionVersionVersion of the changed description.
idSystemNoteMetadataID!Global ID of the specific system note metadata.

Tag

Fields

NameTypeDescription
commitCommitCommit for the tag.
messageStringTagging message.
nameString!Name of the tag.

TaskCompletionStatus

Completion status of tasks.

Fields

NameTypeDescription
completedCountInt!Number of completed tasks.
countInt!Number of total tasks.

TerraformModuleMetadata

Terraform module metadata.

Fields

NameTypeDescription
createdAtTime!Timestamp of when the metadata was created.
fieldsTerraformModuleMetadataFields!Fields of the metadata.
idPackagesTerraformModuleMetadatumID!ID of the metadata.
updatedAtTime!Timestamp of when the metadata was last updated.

TerraformModuleMetadataDependencies

Terraform module metadata dependencies.

Fields

NameTypeDescription
modules[TerraformModuleMetadataDependency!]Modules of the module.
providers[TerraformModuleMetadataDependency!]Providers of the module.

TerraformModuleMetadataDependency

Terraform module metadata dependency.

Fields

NameTypeDescription
nameString!Name of the dependency.
sourceStringSource of the dependency.
versionStringVersion of the dependency.

TerraformModuleMetadataExample

Terraform module metadata example.

Fields

NameTypeDescription
inputs[TerraformModuleMetadataInput!]Inputs of the module.
nameString!Name of the example.
outputs[TerraformModuleMetadataOutput!]Outputs of the module.
readmeStringReadme data.
readmeHtmlStringGitLab Flavored Markdown rendering of readme.

TerraformModuleMetadataFields

Terraform module metadata fields type.

Fields

NameTypeDescription
examples[TerraformModuleMetadataExample!]Examples of the module.
rootTerraformModuleMetadataRoot!Root module.
submodules[TerraformModuleMetadataSubmodule!]Submodules of the module.

TerraformModuleMetadataInput

Terraform module metadata input type.

Fields

NameTypeDescription
defaultStringDefault value of the input.
descriptionStringDescription of the input.
nameString!Name of the input.
typeString!Type of the input.

TerraformModuleMetadataOutput

Terraform module metadata output.

Fields

NameTypeDescription
descriptionStringDescription of the output field.
nameString!Name of the output field.

TerraformModuleMetadataRoot

Metadata for Terraform root module.

Fields

NameTypeDescription
dependenciesTerraformModuleMetadataDependenciesDependencies of the module.
inputs[TerraformModuleMetadataInput!]Inputs of the module.
outputs[TerraformModuleMetadataOutput!]Outputs of the module.
readmeStringReadme data.
readmeHtmlStringGitLab Flavored Markdown rendering of readme.
resources[String!]Resources of the module.

TerraformModuleMetadataSubmodule

Terraform module metadata submodule.

Fields

NameTypeDescription
dependenciesTerraformModuleMetadataDependenciesDependencies of the submodule.
inputs[TerraformModuleMetadataInput!]Inputs of the module.
nameString!Name of the submodule.
outputs[TerraformModuleMetadataOutput!]Outputs of the module.
readmeStringReadme data.
readmeHtmlStringGitLab Flavored Markdown rendering of readme.
resources[String!]Resources of the submodule.

TerraformState

Fields

NameTypeDescription
createdAtTime!Timestamp the Terraform state was created.
deletedAtTimeTimestamp the Terraform state was deleted.
idID!ID of the Terraform state.
latestVersionTerraformStateVersionLatest version of the Terraform state.
lockedAtTimeTimestamp the Terraform state was locked.
lockedByUserUserCoreUser currently holding a lock on the Terraform state.
nameString!Name of the Terraform state.
updatedAtTime!Timestamp the Terraform state was updated.

TerraformStateVersion

Fields

NameTypeDescription
createdAtTime!Timestamp the version was created.
createdByUserUserCoreUser that created this version.
downloadPathStringURL for downloading the version’s JSON file.
idID!ID of the Terraform state version.
jobCiJobJob that created this version.
serialIntSerial number of the version.
updatedAtTime!Timestamp the version was updated.

TerraformStateVersionRegistry

Represents the Geo sync and verification state of a terraform state version.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the TerraformStateVersionRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the TerraformStateVersionRegistry was created.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the TerraformStateVersionRegistry.
lastSyncFailureStringError message during sync of the TerraformStateVersionRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the TerraformStateVersionRegistry.
missingOnPrimaryBooleanIndicate if the TerraformStateVersionRegistry is missing on primary.
modelRecordIdIntID of the TerraformStateVersionRegistry’s model record.
retryAtTimeTimestamp after which the TerraformStateVersionRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the TerraformStateVersionRegistry.
stateRegistryStateSync state of the TerraformStateVersionRegistry.
terraformStateVersionIdID!ID of the terraform state version.
verificationChecksumStringThe local checksum of the TerraformStateVersionRegistry.
verificationChecksumMismatchedStringThe expected checksum of the TerraformStateVersionRegistry in case of mismatch.
verificationFailureStringError message during verification of the TerraformStateVersionRegistry.
verificationRetryAtTimeTimestamp after which the TerraformStateVersionRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the TerraformStateVersionRegistry.
verificationStartedAtTimeTimestamp when the verification of TerraformStateVersionRegistry started.
verificationStateVerificationStateEnumVerification state of the TerraformStateVersionRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the TerraformStateVersionRegistry.

TestCase

Test case in pipeline test report.

Fields

NameTypeDescription
attachmentUrlStringURL of the test case attachment file.
classnameStringClassname of the test case.
executionTimeFloatTest case execution time in seconds.
fileStringPath to the file of the test case.
nameStringName of the test case.
recentFailuresRecentFailuresRecent failure history of the test case on the base branch.
stackTraceStringStack trace of the test case.
statusTestCaseStatusStatus of the test case (error, failed, success, skipped).
systemOutputStringSystem output of the test case.

TestReport

Represents a requirement test report.

Fields

NameTypeDescription
authorUserCoreAuthor of the test report.
createdAtTime!Timestamp of when the test report was created.
idID!ID of the test report.
stateTestReportState!State of the test report.
usesLegacyIidBooleanIndicates whether the test report was generated with references to legacy requirement IIDs.

TestReportSummary

Test report for a pipeline.

Fields

NameTypeDescription
testSuitesTestSuiteSummaryConnection!Test suites belonging to a pipeline test report. (see Connections)
totalTestReportTotal!Total report statistics for a pipeline test report.

TestReportTotal

Total test report statistics.

Fields

NameTypeDescription
countIntTotal number of the test cases.
errorIntTotal number of test cases that had an error.
failedIntTotal number of test cases that failed.
skippedIntTotal number of test cases that were skipped.
successIntTotal number of test cases that succeeded.
suiteErrorStringTest suite error message.
timeFloatTotal duration of the tests.

TestSuite

Test suite in a pipeline test report.

Fields

NameTypeDescription
errorCountIntTotal number of test cases that had an error.
failedCountIntTotal number of test cases that failed in the test suite.
nameStringName of the test suite.
skippedCountIntTotal number of test cases that were skipped in the test suite.
successCountIntTotal number of test cases that succeeded in the test suite.
suiteErrorStringTest suite error message.
testCasesTestCaseConnectionTest cases in the test suite. (see Connections)
totalCountIntTotal number of the test cases in the test suite.
totalTimeFloatTotal duration of the tests in the test suite.

TestSuiteSummary

Test suite summary in a pipeline test report.

Fields

NameTypeDescription
buildIds[ID!]IDs of the builds used to run the test suite.
errorCountIntTotal number of test cases that had an error.
failedCountIntTotal number of test cases that failed in the test suite.
nameStringName of the test suite.
skippedCountIntTotal number of test cases that were skipped in the test suite.
successCountIntTotal number of test cases that succeeded in the test suite.
suiteErrorStringTest suite error message.
totalCountIntTotal number of the test cases in the test suite.
totalTimeFloatTotal duration of the tests in the test suite.

TimeReportStats

Represents the time report stats for timeboxes.

Fields

NameTypeDescription
completeTimeboxMetricsCompleted issues metrics.
incompleteTimeboxMetricsIncomplete issues metrics.
totalTimeboxMetricsTotal issues metrics.

TimeTrackingTimelogCategory

Fields

NameTypeDescription
billableBooleanWhether the category is billable or not.
billingRateFloatBilling rate for the category.
colorColorColor assigned to the category.
createdAtTime!When the category was created.
descriptionStringDescription of the category.
idID!Internal ID of the timelog category.
nameString!Name of the category.
updatedAtTime!When the category was last updated.

TimeboxMetrics

Represents measured stats metrics for timeboxes.

Fields

NameTypeDescription
countInt!Count metric.
weightInt!Weight metric.

TimeboxReport

Represents a historically accurate report about the timebox.

Fields

NameTypeDescription
burnupTimeSeries[BurnupChartDailyTotals!]Daily scope and completed totals for burnup charts.
errorTimeboxReportErrorIf the report cannot be generated, information about why.
statsTimeReportStatsRepresents the time report stats for the timebox.

TimeboxReportError

Explains why we could not generate a timebox report.

Fields

NameTypeDescription
codeTimeboxReportErrorReasonMachine readable code, categorizing the error.
messageStringHuman readable message explaining what happened.

TimelineEventTagType

Describes a tag on an incident management timeline event.

Fields

NameTypeDescription
idIncidentManagementTimelineEventTagID!ID of the timeline event tag.
nameString!Name of the timeline event tag.

TimelineEventType

Describes an incident management timeline event.

Fields

NameTypeDescription
actionString!Indicates the timeline event icon.
authorUserCoreUser that created the timeline event.
createdAtTime!Timestamp when the event created.
editableBoolean!Indicates the timeline event is editable.
idIncidentManagementTimelineEventID!ID of the timeline event.
incidentIssue!Incident of the timeline event.
noteStringText note of the timeline event.
noteHtmlStringHTML note of the timeline event.
occurredAtTime!Timestamp when the event occurred.
promotedFromNoteNoteNote from which the timeline event was created.
timelineEventTagsTimelineEventTagTypeConnectionTags for the incident timeline event. (see Connections)
updatedAtTime!Timestamp when the event updated.
updatedByUserUserCoreUser that updated the timeline event.

Timelog

Fields

NameTypeDescription
idID!Internal ID of the timelog.
issueIssueIssue that logged time was added to.
mergeRequestMergeRequestMerge request that logged time was added to.
noteNoteNote where the quick action was executed to add the logged time.
projectProject!Target project of the timelog merge request or issue.
spentAtTimeTimestamp of when the time tracked was spent at.
summaryStringSummary of how the time was spent.
timeSpentInt!Time spent displayed in seconds.
userUserCore!User that logged the time.
userPermissionsTimelogPermissions!Permissions for the current user on the resource.

TimelogPermissions

Fields

NameTypeDescription
adminTimelogBoolean!If true, the user can perform admin_timelog on this resource.

Todo

Representing a to-do entry.

Fields

NameTypeDescription
actionTodoActionEnum!Action of the to-do item.
authorUserCore!Author of this to-do item.
bodyString!Body of the to-do item.
createdAtTime!Timestamp this to-do item was created.
groupGroupGroup this to-do item is associated with.
idID!ID of the to-do item.
memberAccessTypeStringAccess type of access request to-do items.
noteNoteNote which created this to-do item.
projectProjectProject this to-do item is associated with.
snoozedUntilTimeThe time until when the todo is snoozed.
stateTodoStateEnum!State of the to-do item.
target warning-solidTodoable!Deprecated in GitLab 17.4. Use target_entity field.
targetEntityTodoableTarget of the to-do item.
targetTypeTodoTargetEnum!Target type of the to-do item.
targetUrlStringURL of the to-do item target.

Topic

Fields

NameTypeDescription
avatarUrlStringURL to avatar image file of the topic.
descriptionStringDescription of the topic.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
idID!ID of the topic.
nameString!Name of the topic.
titleString!Title of the topic.

Tree

Fields

NameTypeDescription
blobsBlobConnection!Blobs of the tree. (see Connections)
lastCommitCommitLast commit for the tree.
submodulesSubmoduleConnection!Sub-modules of the tree. (see Connections)
treesTreeEntryConnection!Trees of the tree. (see Connections)

TreeEntry

Represents a directory.

Fields

NameTypeDescription
flatPathString!Flat path of the entry.
idID!ID of the entry.
nameString!Name of the entry.
pathString!Path of the entry.
shaString!SHA of the entry.
typeEntryType!Type of tree entry.
webPathStringWeb path for the tree entry (directory).
webUrlStringWeb URL for the tree entry (directory).

UnprotectAccessLevel

Defines which user roles, users, or groups can unprotect a protected branch.

Fields

NameTypeDescription
accessLevelInt!GitLab::Access level.
accessLevelDescriptionString!Human readable representation for the access level.
groupAccessLevelGroupGroup associated with this access level.
userAccessLevelUserUser associated with this access level.

UploadRegistry

Represents the Geo replication and verification state of an upload.

Fields

NameTypeDescription
checksumMismatchBooleanIndicate if the checksums of the UploadRegistry do not match on the primary and secondary.
createdAtTimeTimestamp when the UploadRegistry was created.
fileIdID!ID of the Upload.
forceToRedownloadBooleanIndicate if a forced redownload is to be performed.
idID!ID of the UploadRegistry.
lastSyncFailureStringError message during sync of the UploadRegistry.
lastSyncedAtTimeTimestamp of the most recent successful sync of the UploadRegistry.
missingOnPrimaryBooleanIndicate if the UploadRegistry is missing on primary.
modelRecordIdIntID of the UploadRegistry’s model record.
retryAtTimeTimestamp after which the UploadRegistry is resynced.
retryCountIntNumber of consecutive failed sync attempts of the UploadRegistry.
stateRegistryStateSync state of the UploadRegistry.
verificationChecksumStringThe local checksum of the UploadRegistry.
verificationChecksumMismatchedStringThe expected checksum of the UploadRegistry in case of mismatch.
verificationFailureStringError message during verification of the UploadRegistry.
verificationRetryAtTimeTimestamp after which the UploadRegistry is reverified.
verificationRetryCountIntNumber of consecutive failed verification attempts of the UploadRegistry.
verificationStartedAtTimeTimestamp when the verification of UploadRegistry started.
verificationStateVerificationStateEnumVerification state of the UploadRegistry.
verifiedAtTimeTimestamp of the most recent successful verification of the UploadRegistry.

UsageTrendsMeasurement

Represents a recorded measurement (object count) for the Admins.

Fields

NameTypeDescription
countInt!Object count.
identifierMeasurementIdentifier!Type of objects being measured.
recordedAtTimeTime the measurement was recorded.

UserAchievement

Fields

NameTypeDescription
achievementAchievement!Achievement awarded.
awardedByUserUserCore!Awarded by.
createdAtTime!Timestamp the achievement was created.
idAchievementsUserAchievementID!ID of the user achievement.
priorityIntPriority of the user achievement.
revokedAtTimeTimestamp the achievement was revoked.
revokedByUserUserCoreRevoked by.
showOnProfileBoolean!Indicates whether or not the achievement is shown on the profile.
updatedAtTime!Timestamp the achievement was last updated.
userUserCore!Achievement recipient.

UserAddOnAssignment

An assignment of an AddOnPurchase to a User.

Fields

NameTypeDescription
addOnPurchaseAddOnPurchase!Add-on purchase the user is assigned to.

UserCallout

Fields

NameTypeDescription
dismissedAtTimeDate when the callout was dismissed.
featureNameUserCalloutFeatureNameEnumName of the feature that the callout is for.

UserCore

Core representation of a GitLab user.

Fields

NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.

Fields with arguments

UserCore.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
UserCore.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
UserCore.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
UserCore.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
UserCore.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

Arguments
NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
UserCore.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

Arguments
NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
UserCore.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
UserCore.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
UserCore.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
UserCore.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
UserCore.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
UserCore.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

Arguments
NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.
UserCore.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
NameTypeDescription
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 warning-solid[String!]Deprecated in GitLab 16.7. Use actual_states instead.
projectIds[ProjectID!]Filter workspaces by project GlobalIDs.

UserMemberRole

Fields

NameTypeDescription
idGlobalID!Global ID of the user member role association.
memberRoleMemberRole!Member Role to which the user belongs.
userUserCore!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

NameTypeDescription
applicableApprovalRules[ApprovalRule!]Approval rules that apply to this user for this merge request.
approvedBoolean!Whether this user has approved this merge request.
canMergeBoolean!Whether this user can merge this merge request.
canUpdateBoolean!Whether this user can update this merge request.
reviewStateMergeRequestReviewStateState of the review by this user.
reviewedBoolean!Whether this user has provided a review for this merge request.

UserPermissions

Fields

NameTypeDescription
createSnippetBoolean!If true, the user can perform create_snippet on this resource.

UserPreferences

Fields

NameTypeDescription
extensionsMarketplaceOptInStatusExtensionsMarketplaceOptInStatus!Status of the Web IDE Extension Marketplace opt-in for the user.
issuesSortIssueSortSort order for issue lists.
organizationGroupsProjectsDisplay warning-solidOrganizationGroupProjectDisplay!Introduced in GitLab 17.2. Status: Experiment. Default list view for organization groups and projects.
organizationGroupsProjectsSort warning-solidOrganizationGroupProjectSortIntroduced in GitLab 17.2. Status: Experiment. Sort order for organization groups and projects.
projectsSortProjectSortSort order for projects.
timezone warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Timezone of the user.
useWorkItemsViewBooleanUse work item view instead of legacy issue view.
visibilityPipelineIdTypeVisibilityPipelineIdTypeDetermines whether the pipeline list shows ID or IID.

UserStatus

Fields

NameTypeDescription
availabilityAvailabilityEnum!User availability status.
emojiStringString representation of emoji.
messageStringUser status message.
messageHtmlStringHTML of the user status message.

UsersQueuedForRolePromotion

Represents a Pending Member Approval Queued for Role Promotion.

Fields

NameTypeDescription
newAccessLevelAccessLevelHighest New GitLab::Access level requested for the member.
userUserCoreUser that is associated with the member approval object.

ValueStream

Fields

NameTypeDescription
idAnalyticsCycleAnalyticsValueStreamID!ID of the value stream.
nameString!Name of the value stream.
namespaceNamespace!Namespace the value stream belongs to.
project warning-solidProjectIntroduced in GitLab 15.6. Status: Experiment. Project the value stream belongs to, returns empty if it belongs to a group.

Fields with arguments

ValueStream.stages

Value Stream stages.

Returns [ValueStreamStage!].

Arguments
NameTypeDescription
idIDValue stream stage id.

ValueStreamAnalytics

Fields

NameTypeDescription
aggregationStatusAggregationStatusShows information about background data collection and aggregation.

ValueStreamAnalyticsDateMetric

Fields

NameTypeDescription
dateDateDate for the metric.
identifierString!Identifier for the metric.
links[ValueStreamMetricLinkType!]!Optional links for drilling down.
titleString!Title for the metric.
unitStringUnit of measurement.
valueFloatValue for the metric.

ValueStreamAnalyticsMetric

Fields

NameTypeDescription
identifierString!Identifier for the metric.
links[ValueStreamMetricLinkType!]!Optional links for drilling down.
titleString!Title for the metric.
unitStringUnit of measurement.
valueFloatValue for the metric.

ValueStreamDashboardCount

Represents a recorded measurement (object count) for the requested group.

Fields

NameTypeDescription
countIntObject count.
identifierValueStreamDashboardMetric!Type of object being measured.
recordedAtTimeTime the measurement was taken.

ValueStreamMetricLinkType

Fields

NameTypeDescription
docsLinkBooleanLink to the metric documentation.
labelString!Label for the link.
nameString!Name of the link group.
urlString!Drill-down URL.

ValueStreamStage

Fields

NameTypeDescription
customBoolean!Whether the stage is customized.
endEventHtmlDescriptionString!HTML description of the end event.
endEventIdentifierValueStreamStageEvent!End event identifier.
endEventLabelLabelLabel associated with end event.
hiddenBoolean!Whether the stage is hidden.
idAnalyticsCycleAnalyticsStageID!ID of the value stream.
nameString!Name of the stage.
startEventHtmlDescriptionString!HTML description of the start event.
startEventIdentifierValueStreamStageEvent!Start event identifier.
startEventLabelLabelLabel associated with start event.

Fields with arguments

ValueStreamStage.metrics

Aggregated metrics for the given stage.

Returns ValueStreamStageMetrics!.

Arguments
NameTypeDescription
assigneeUsernames[String!]Usernames of users assigned to the issue or the merge request.
authorUsernameStringUsername of the author of the issue or the merge request.
epicIdIDID of an epic associated with the issues. Using the filter is not supported for stages based on merge requests.
iterationIdIDID 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.
milestoneTitleStringMilestone applied to the issue or the merge request.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
notNegatedValueStreamAnalyticsIssuableFilterInputArgument used for adding negated filters.
timeframeTimeframe!Aggregation timeframe. Filters the issue or the merge request creation time for FOSS projects, and the end event timestamp for licensed projects or groups.
weightIntWeight applied to the issue. Using the filter is not supported for stages based on merge requests.

ValueStreamStageItems

Fields

NameTypeDescription
durationStringDuration of the item on the stage.
durationInMillisecondsBigIntDuration of item on stage in milliseconds.
endEventTimestampTimeWhen exited the stage.
recordIssuableItem record.

ValueStreamStageMetrics

Fields

NameTypeDescription
averageValueStreamAnalyticsMetricAverage duration in seconds.
countValueStreamAnalyticsMetricLimited item count. The backend counts maximum 1000 items, for free projects, and maximum 10,000 items for licensed projects or licensed groups.
medianValueStreamAnalyticsMetricMedian duration in seconds.
series warning-solidValueStreamStageSeries!Introduced in GitLab 17.4. Status: Experiment. Data series in the value stream stage.

Fields with arguments

ValueStreamStageMetrics.items

Items in the stage.

  • Introduced in GitLab 17.4.
  • Status: Experiment.

Returns ValueStreamStageItemsConnection.

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

Arguments
NameTypeDescription
sortValueStreamStageItemSortSort stage items by criteria.

ValueStreamStageSeries

Fields

NameTypeDescription
averageDurations[ValueStreamAnalyticsDateMetric!]Average duration for each day within the given date range.

VulnerabilitiesCountByDay

Represents the count of vulnerabilities by severity on a particular day. This data is retained for 365 days.

Fields

NameTypeDescription
criticalInt!Total number of vulnerabilities on a particular day with critical severity.
dateISO8601Date!Date for the count.
highInt!Total number of vulnerabilities on a particular day with high severity.
infoInt!Total number of vulnerabilities on a particular day with info severity.
lowInt!Total number of vulnerabilities on a particular day with low severity.
mediumInt!Total number of vulnerabilities on a particular day with medium severity.
totalInt!Total number of vulnerabilities on a particular day.
unknownInt!Total number of vulnerabilities on a particular day with unknown severity.

Vulnerability

Represents a vulnerability.

Fields

NameTypeDescription
aiResolutionAvailableBooleanIndicates whether this type of vulnerability can be resolved with AI.
aiResolutionEnabledBooleanIndicates whether this specific vulnerability can be resolved with AI.
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
confirmedAtTimeTimestamp of when the vulnerability state was changed to confirmed.
confirmedByUserCoreUser that confirmed the vulnerability.
cveEnrichmentCveEnrichmentTypeEnrichment (EPSS score and KEV) for CVE vulnerabilities.
cvss[CvssType!]!CVSS information for the vulnerability.
descriptionStringDescription of the vulnerability.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
details[VulnerabilityDetail!]!Details of the vulnerability.
detectedAtTime!Timestamp of when the vulnerability was first detected.
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
dismissalReasonVulnerabilityDismissalReasonReason for dismissal. Returns null for states other than dismissed.
dismissedAtTimeTimestamp of when the vulnerability state was changed to dismissed.
dismissedByUserCoreUser that dismissed the vulnerability.
externalIssueLinksVulnerabilityExternalIssueLinkConnection!List of external issue links related to the vulnerability. (see Connections)
falsePositiveBooleanIndicates whether the vulnerability is a false positive.
hasRemediationsBooleanIndicates whether there is a remediation available for this vulnerability.
idID!GraphQL ID of the vulnerability.
identifiers[VulnerabilityIdentifier!]!Identifiers of the vulnerability.
links[VulnerabilityLink!]!List of links associated with the vulnerability.
locationVulnerabilityLocationLocation metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability.
mergeRequestMergeRequestMerge request that fixes the vulnerability.
nameStringName or title of this object.
presentOnDefaultBranchBoolean!Indicates whether the vulnerability is present on the default branch or not.
primaryIdentifierVulnerabilityIdentifierPrimary identifier of the vulnerability.
projectProjectProject on which the vulnerability was found.
reportTypeVulnerabilityReportTypeType 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, GENERIC). Scan Type in the UI.
representationInformation warning-solidVulnerabilityRepresentationInformationIntroduced in GitLab 17.7. Status: Experiment. Information about the representation of the vulnerability, such as resolved commit SHA.
resolvedAtTimeTimestamp of when the vulnerability state was changed to resolved.
resolvedByUserCoreUser that resolved the vulnerability.
resolvedOnDefaultBranchBoolean!Indicates whether the vulnerability is fixed on the default branch or not.
scannerVulnerabilityScannerScanner metadata for the vulnerability.
severityVulnerabilitySeveritySeverity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL).
severityOverridesSeverityOverrideConnectionList of severity changes for the vulnerability. (see Connections)
solutionStringRecommended solution for the vulnerability.
stateVulnerabilityStateState of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED).
stateCommentStringComment given for the vulnerability state change.
stateTransitionsVulnerabilityStateTransitionTypeConnectionList of state transitions related to the vulnerability. (see Connections)
titleStringTitle of the vulnerability.
updatedAtTimeTimestamp of when the vulnerability was last updated.
userNotesCountInt!Number of user notes attached to the vulnerability.
userPermissionsVulnerabilityPermissions!Permissions for the current user on the resource.
uuidString!UUID of the vulnerability finding. Can be used to look up the associated security report finding.
vulnerabilityPathStringPath to the vulnerability’s details page.
webUrlStringURL to the vulnerability’s details page.

Fields with arguments

List of issue links related to the vulnerability.

Returns VulnerabilityIssueLinkConnection!.

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

Arguments
NameTypeDescription
linkTypeVulnerabilityIssueLinkTypeFilter issue links by link type.
Vulnerability.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.

VulnerabilityArchive

Represents a vulnerability archive.

Fields

NameTypeDescription
archivedRecordsCountInt!Number of records the archive contains.
monthInt!Month of the archive, represented as a number from 1 (January) to 12 (December).
yearInt!Year of the archive.

VulnerabilityContainerImage

Represents a container image reported on the related vulnerability.

Fields

NameTypeDescription
nameStringName of the container image.

VulnerabilityDetailBase

Represents the vulnerability details base.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.

VulnerabilityDetailBoolean

Represents the vulnerability details boolean value.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.
valueBoolean!Value of the field.

VulnerabilityDetailCode

Represents the vulnerability details code field.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
langStringLanguage of the code.
nameStringName of the field.
valueString!Source code.

VulnerabilityDetailCodeFlowNode

Represents the vulnerability details code flow node item.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
fileLocationVulnerabilityDetailFileLocation!Location of the file.
nameStringName of the field.
nodeTypeCodeFlowNodeType!Node Type.

VulnerabilityDetailCodeFlows

Represents the vulnerability details code flows item.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
items[[VulnerabilityDetailCodeFlowNode!]!]!List of flows represented by list of CodeFlowNodeItem.
nameStringName of the field.

VulnerabilityDetailCommit

Represents the vulnerability details commit field.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.
valueString!Commit SHA value.

VulnerabilityDetailDiff

Represents the vulnerability details diff field.

Fields

NameTypeDescription
afterString!Value of the field after the change.
beforeString!Value of the field before the change.
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.

VulnerabilityDetailFileLocation

Represents the vulnerability details location within a file in the project.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
fileNameString!File name.
lineEndInt!End line number of the file location.
lineStartInt!Start line number of the file location.
nameStringName of the field.

VulnerabilityDetailInt

Represents the vulnerability details integer value.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.
valueInt!Value of the field.

VulnerabilityDetailList

Represents the vulnerability details list value.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
items[VulnerabilityDetail!]!List of details.
nameStringName of the field.

VulnerabilityDetailMarkdown

Represents the vulnerability details Markdown field.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.
valueString!Value of the Markdown field.

VulnerabilityDetailModuleLocation

Represents the vulnerability details location within a file in the project.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
moduleNameString!Module name.
nameStringName of the field.
offsetInt!Offset of the module location.

VulnerabilityDetailNamedList

Represents the vulnerability details named list.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
items warning-solid[VulnerabilityDetailNamedListItem!]!Introduced in GitLab 16.1. Status: Experiment. Named list of details.
nameStringName of the field.

VulnerabilityDetailNamedListItem

Represents the vulnerability details named list item.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.
value warning-solidVulnerabilityDetail!Introduced in GitLab 16.1. Status: Experiment. Value of the field.

VulnerabilityDetailRow

Represents an individual row in a table.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.
row[VulnerabilityDetail!]!Value of the field.

VulnerabilityDetailTable

Represents the vulnerability details table value.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
headers[VulnerabilityDetail!]!Table headers.
nameStringName of the field.
rows[VulnerabilityDetailRow!]!Table rows.

VulnerabilityDetailText

Represents the vulnerability details text field.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
nameStringName of the field.
valueString!Value of the text field.

VulnerabilityDetailUrl

Represents the vulnerability details URL field.

Fields

NameTypeDescription
descriptionStringDescription of the field.
fieldNameStringName of the field.
hrefString!Href of the URL.
nameStringName of the field.
textStringText of the URL.

VulnerabilityEvidence

Represents a Vulnerability Evidence.

Fields

NameTypeDescription
requestVulnerabilityRequestHTTP request of the Vulnerability Evidence.
responseVulnerabilityResponseHTTP response of the Vulnerability Evidence.
sourceVulnerabilityEvidenceSourceSource of the Vulnerability Evidence.
summaryStringSummary of the Vulnerability Evidence.
supportingMessages[VulnerabilityEvidenceSupportingMessage!]Supporting messages of the Vulnerability Evidence.

VulnerabilityEvidenceSource

Represents a vulnerability evidence.

Fields

NameTypeDescription
identifierString!ID of the Vulnerability Evidence Source.
nameString!Name of the Vulnerability Evidence Source.
urlStringURL of the Vulnerability Evidence Source.

VulnerabilityEvidenceSupportingMessage

Represents a vulnerability evidence supporting message.

Fields

NameTypeDescription
nameString!Name of the vulnerability supporting message.
requestVulnerabilityRequestHTTP request of the vulnerability evidence supporting message.
responseVulnerabilityResponseHTTP response of the vulnerability evidence supporting message.

Represents an external issue link of a vulnerability.

Fields

NameTypeDescription
externalIssueExternalIssueThe external issue attached to the issue link.
idVulnerabilitiesExternalIssueLinkID!GraphQL ID of the external issue link.
linkTypeVulnerabilityExternalIssueLinkType!Type of the external issue link.

VulnerabilityIdentifier

Represents a vulnerability identifier.

Fields

NameTypeDescription
externalIdStringExternal ID of the vulnerability identifier.
externalTypeStringExternal type of the vulnerability identifier.
nameStringName of the vulnerability identifier.
urlStringURL of the vulnerability identifier.

Represents an issue link of a vulnerability.

Fields

NameTypeDescription
idID!GraphQL ID of the vulnerability.
issueIssueIssue attached to issue link.
linkTypeVulnerabilityIssueLinkType!Type of the issue link.

Represents a link related to a vulnerability.

Fields

NameTypeDescription
nameStringName of the link.
urlString!URL of the link.

VulnerabilityLocationClusterImageScanning

Represents the location of a vulnerability found by a cluster image scan.

Fields

NameTypeDescription
dependencyVulnerableDependencyDependency containing the vulnerability.
imageStringName of the vulnerable container image.
kubernetesResourceVulnerableKubernetesResourceKubernetes resource which uses the vulnerable container image.
operatingSystemStringOperating system that runs on the vulnerable container image.

VulnerabilityLocationContainerScanning

Represents the location of a vulnerability found by a container security scan.

Fields

NameTypeDescription
containerRepositoryUrlStringURL of scanned image.
dependencyVulnerableDependencyDependency containing the vulnerability.
imageStringName of the vulnerable container image.
operatingSystemStringOperating system that runs on the vulnerable container image.

VulnerabilityLocationCoverageFuzzing

Represents the location of a vulnerability found by a Coverage Fuzzing scan.

Fields

NameTypeDescription
blobPathStringBlob path to the vulnerable file.
crashAddressStringRelative address in memory were the crash occurred.
crashTypeStringType of the crash.
endLineStringNumber of the last relevant line in the vulnerable file.
fileStringPath to the vulnerable file.
stacktraceSnippetStringStack trace recorded during fuzzing resulting the crash.
startLineStringNumber of the first relevant line in the vulnerable file.
vulnerableClassStringClass containing the vulnerability.
vulnerableMethodStringMethod containing the vulnerability.

VulnerabilityLocationDast

Represents the location of a vulnerability found by a DAST scan.

Fields

NameTypeDescription
hostnameStringDomain name of the vulnerable request.
paramStringQuery parameter for the URL on which the vulnerability occurred.
pathStringURL path and query string of the vulnerable request.
requestMethodStringHTTP method of the vulnerable request.

VulnerabilityLocationDependencyScanning

Represents the location of a vulnerability found by a dependency security scan.

Fields

NameTypeDescription
blobPathStringBlob path to the vulnerable file.
dependencyVulnerableDependencyDependency containing the vulnerability.
fileStringPath to the vulnerable file.

VulnerabilityLocationGeneric

Represents the location of a vulnerability found by a generic scanner.

Fields

NameTypeDescription
descriptionStringFree-form description of where the vulnerability is located.

VulnerabilityLocationSast

Represents the location of a vulnerability found by a SAST scan.

Fields

NameTypeDescription
blobPathStringBlob path to the vulnerable file.
endLineStringNumber of the last relevant line in the vulnerable file.
fileStringPath to the vulnerable file.
startLineStringNumber of the first relevant line in the vulnerable file.
vulnerableClassStringClass containing the vulnerability.
vulnerableMethodStringMethod containing the vulnerability.

VulnerabilityLocationSecretDetection

Represents the location of a vulnerability found by a secret detection scan.

Fields

NameTypeDescription
blobPathStringBlob path to the vulnerable file.
endLineStringNumber of the last relevant line in the vulnerable file.
fileStringPath to the vulnerable file.
startLineStringNumber of the first relevant line in the vulnerable file.
vulnerableClassStringClass containing the vulnerability.
vulnerableMethodStringMethod containing the vulnerability.

VulnerabilityManagementPolicy

Represents the vulnerability management policy.

Fields

NameTypeDescription
descriptionString!Description of the policy.
editPathString!URL of policy edit page.
enabledBoolean!Indicates whether this policy is enabled.
nameString!Name of the policy.
policyScopePolicyScopeScope of the policy.
sourceSecurityPolicySource!Source of the policy. Its fields depend on the source type.
updatedAtTime!Timestamp of when the policy YAML was last updated.
yamlString!YAML definition of the policy.

VulnerabilityPermissions

Check permissions for the current user on a vulnerability.

Fields

NameTypeDescription
adminVulnerabilityBoolean!If true, the user can perform admin_vulnerability on this resource.
adminVulnerabilityExternalIssueLinkBoolean!If true, the user can perform admin_vulnerability_external_issue_link on this resource.
adminVulnerabilityIssueLinkBoolean!If true, the user can perform admin_vulnerability_issue_link on this resource.
createVulnerabilityExportBoolean!If true, the user can perform create_vulnerability_export on this resource.
createVulnerabilityFeedbackBoolean!If true, the user can perform create_vulnerability_feedback on this resource.
destroyVulnerabilityFeedbackBoolean!If true, the user can perform destroy_vulnerability_feedback on this resource.
readVulnerabilityBoolean!If true, the user can perform read_vulnerability on this resource.
readVulnerabilityFeedbackBoolean!If true, the user can perform read_vulnerability_feedback on this resource.
updateVulnerabilityFeedbackBoolean!If true, the user can perform update_vulnerability_feedback on this resource.

VulnerabilityRemediationType

Represents a vulnerability remediation type.

Fields

NameTypeDescription
diffStringDiff of the remediation.
summaryStringSummary of the remediation.

VulnerabilityRepresentationInformation

Represents vulnerability information.

Fields

NameTypeDescription
resolvedInCommitShaStringSHA of the commit where the vulnerability was resolved.

VulnerabilityRequest

Represents a Vulnerability Request.

Fields

NameTypeDescription
bodyStringBody of the Vulnerability Request.
headers[VulnerabilityRequestResponseHeader!]!HTTP headers of the Vulnerability Request.
methodStringMethod of the Vulnerability Request.
urlStringURL of the Vulnerability Request.

VulnerabilityRequestResponseHeader

Represents a Vulnerability Request/Response Header.

Fields

NameTypeDescription
nameStringName of the Vulnerability Request/Response Header.
valueStringValue of the Vulnerability Request/Response Header.

VulnerabilityResponse

Represents a Vulnerability Response.

Fields

NameTypeDescription
bodyStringBody of the Vulnerability Response.
headers[VulnerabilityRequestResponseHeader!]!HTTP headers of the Vulnerability Response.
reasonPhraseStringReason Phrase of the Vulnerability Response.
statusCodeIntStatus Code of the Vulnerability Response.

VulnerabilityScanner

Represents a vulnerability scanner.

Fields

NameTypeDescription
externalIdStringExternal ID of the vulnerability scanner.
idIDID of the scanner.
nameStringName of the vulnerability scanner.
reportTypeVulnerabilityReportTypeType of the vulnerability report.
reportTypeHumanizedStringHumanized type of the vulnerability report.
vendorStringVendor of the vulnerability scanner.

VulnerabilitySeveritiesCount

Represents vulnerability counts by severity.

Fields

NameTypeDescription
criticalIntNumber of vulnerabilities of CRITICAL severity of the project.
highIntNumber of vulnerabilities of HIGH severity of the project.
infoIntNumber of vulnerabilities of INFO severity of the project.
lowIntNumber of vulnerabilities of LOW severity of the project.
mediumIntNumber of vulnerabilities of MEDIUM severity of the project.
unknownIntNumber of vulnerabilities of UNKNOWN severity of the project.

VulnerabilityStateTransitionType

Represents a state transition of a vulnerability.

Fields

NameTypeDescription
authorUserCoreUser who changed the state of the vulnerability.
commentStringComment for the state change.
createdAtTime!Time of the state change of the vulnerability.
dismissalReasonVulnerabilityDismissalReasonReason for the dismissal.
fromStateVulnerabilityState!State of the vulnerability before transition.
idVulnerabilitiesStateTransitionID!ID of the state transition.
toStateVulnerabilityState!State of the vulnerability after transition.

VulnerableDependency

Represents a vulnerable dependency. Used in vulnerability location data.

Fields

NameTypeDescription
packageVulnerablePackagePackage associated with the vulnerable dependency.
versionStringVersion of the vulnerable dependency.

VulnerableKubernetesResource

Represents a vulnerable Kubernetes resource. Used in vulnerability location data.

Fields

NameTypeDescription
agentClusterAgentKubernetes agent that performed the scan.
clusterIdClustersClusterIDID of the cluster integration used to perform the scan.
containerNameString!Name of the container that had its image scanned.
kindString!Kind of the Kubernetes resource.
nameString!Name of the Kubernetes resource.
namespaceString!Kubernetes namespace where the resource resides.

VulnerablePackage

Represents a vulnerable package. Used in vulnerability dependency data.

Fields

NameTypeDescription
nameStringName of the vulnerable package.

VulnerableProjectsByGrade

Represents vulnerability letter grades with associated projects.

Fields

NameTypeDescription
countInt!Number of projects within this grade.
gradeVulnerabilityGrade!Grade based on the highest severity vulnerability present.
projectsProjectConnection!Projects within this grade. (see Connections)

WikiPage

A wiki page.

Fields

NameTypeDescription
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
idWikiPageMetaID!Global ID of the wiki page metadata record.
nameStringName or title of this object.
titleString!Wiki page title.
userPermissionsWikiPagePermissions!Permissions for the current user on the resource.
webUrlStringURL of this object.

Fields with arguments

WikiPage.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.

WikiPagePermissions

Fields

NameTypeDescription
createNoteBoolean!If true, the user can perform create_note on this resource.
readWikiPageBoolean!If true, the user can perform read_wiki_page on this resource.

WorkItem

Fields

NameTypeDescription
archived warning-solidBoolean!Introduced in GitLab 16.5. Status: Experiment. Whether the work item belongs to an archived project. Always false for group level work items.
author warning-solidUserCoreIntroduced in GitLab 15.9. Status: Experiment. User that created the work item.
closedAtTimeTimestamp of when the work item was closed.
confidentialBoolean!Indicates the work item is confidential.
createNoteEmailStringUser specific email address for the work item.
createdAtTime!Timestamp of when the work item was created.
descriptionStringDescription of the work item.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
duplicatedToWorkItemUrlStringURL of the work item that the work item is marked as a duplicate of.
idWorkItemID!Global ID of the work item.
iidString!Internal ID of the work item.
lockVersionInt!Lock version of the work item. Incremented each time the work item is updated.
movedToWorkItemUrlStringURL of the work item that the work item was moved to.
nameStringName or title of this object.
namespace warning-solidNamespaceIntroduced in GitLab 15.10. Status: Experiment. Namespace the work item belongs to.
project warning-solidProjectIntroduced in GitLab 15.3. Status: Experiment. Project the work item belongs to.
promotedToEpicUrlStringURL of the epic that the work item has been promoted to.
stateWorkItemState!State of the work item.
titleString!Title of the work item.
titleHtmlStringGitLab Flavored Markdown rendering of title.
updatedAtTime!Timestamp of when the work item was last updated.
userPermissionsWorkItemPermissions!Permissions for the current user on the resource.
webUrlStringURL of this object.
widgets[WorkItemWidget!]Collection of widgets that belong to the work item.
workItemTypeWorkItemType!Type assigned to the work item.

Fields with arguments

WorkItem.reference

Internal reference of the work item. Returned in shortened format by default.

Returns String!.

Arguments
NameTypeDescription
fullBooleanBoolean option specifying whether the reference should be returned in full.

WorkItemClosingMergeRequest

Fields

NameTypeDescription
fromMrDescriptionBoolean!Whether this merge request link was created by referencing the work item on the merge request description, using the closing pattern.
idMergeRequestsClosingIssuesID!Global ID of the closing merge request association.
mergeRequestMergeRequestRelated merge request.

WorkItemDescriptionTemplate

Fields

NameTypeDescription
categoryStringCategory of description template.
contentStringContent of Description Template.
nameStringName of Description Template.
projectIdIntID of the description template project.

WorkItemLinkedResource

Fields

NameTypeDescription
urlString!URL of resource.

WorkItemNumberFieldValue

Fields

NameTypeDescription
customFieldCustomField!Custom field associated with the custom field value.
valueFloatNumber value of the custom field.

WorkItemPermissions

Check permissions for the current user on a work item.

Fields

NameTypeDescription
adminParentLinkBoolean!If true, the user can perform admin_parent_link on this resource.
adminWorkItemBoolean!If true, the user can perform admin_work_item on this resource.
adminWorkItemLinkBoolean!If true, the user can perform admin_work_item_link on this resource.
cloneWorkItemBoolean!If true, the user can perform clone_work_item on this resource.
createNoteBoolean!If true, the user can perform create_note on this resource.
deleteWorkItemBoolean!If true, the user can perform delete_work_item on this resource.
markNoteAsInternalBoolean!If true, the user can perform mark_note_as_internal on this resource.
moveWorkItemBoolean!If true, the user can perform move_work_item on this resource.
readWorkItemBoolean!If true, the user can perform read_work_item on this resource.
reportSpamBoolean!If true, the user can perform report_spam on this resource.
setWorkItemMetadataBoolean!If true, the user can perform set_work_item_metadata on this resource.
summarizeCommentsBoolean!If true, the user can perform summarize_comments on this resource.
updateWorkItemBoolean!If true, the user can perform update_work_item on this resource.

WorkItemRelatedBranch

Fields

NameTypeDescription
comparePathStringPath to comparison of branch to default branch.
nameString!Name of the branch.
pipelineStatusDetailedStatusStatus of pipeline for the branch.

WorkItemSelectFieldValue

Fields

NameTypeDescription
customFieldCustomField!Custom field associated with the custom field value.
selectedOptions[CustomFieldSelectOption!]Selected options of the custom field.

WorkItemStateCountsType

Represents total number of work items for the represented states.

Fields

NameTypeDescription
allIntNumber of work items for the project or group.
closedIntNumber of work items with state CLOSED for the project or group.
openedIntNumber of work items with state OPENED for the project or group.

WorkItemTextFieldValue

Fields

NameTypeDescription
customFieldCustomField!Custom field associated with the custom field value.
valueStringText value of the custom field.

WorkItemTimelog

Fields

NameTypeDescription
idID!Internal ID of the timelog.
noteNoteNote where the quick action was executed to add the logged time.
spentAtTimeTimestamp of when the time tracked was spent at.
summaryStringSummary of how the time was spent.
timeSpentInt!Time spent displayed in seconds.
userUserCore!User that logged the time.
userPermissionsTimelogPermissions!Permissions for the current user on the resource.

WorkItemType

Fields

NameTypeDescription
iconNameStringIcon name of the work item type.
idWorkItemsTypeID!Global ID of the work item type.
nameString!Name of the work item type.
supportedConversionTypes warning-solid[WorkItemType!]Introduced in GitLab 17.8. Status: Experiment. Supported conversion types for the work item type.
widgetDefinitions warning-solid[WorkItemWidgetDefinition!]Introduced in GitLab 16.7. Status: Experiment. Available widgets for the work item type.

WorkItemTypeCountsByState

Represents work item counts for the work item type.

Fields

NameTypeDescription
countsByStateWorkItemStateCountsType!Total number of work items for the represented states.
workItemTypeWorkItemType!Work item type.

WorkItemTypeDepthLimitReachedByType

Represents Depth limit reached for the allowed work item type.

Fields

NameTypeDescription
depthLimitReachedBoolean!Indicates if maximum allowed depth has been reached for the descendant type.
workItemTypeWorkItemType!Work item type.

WorkItemWidgetAssignees

Represents an assignees widget.

Fields

NameTypeDescription
allowsMultipleAssignees warning-solidBooleanDeprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use: workitemWidgetDefinitionAssignees.allowsMultipleAssignees.
assigneesUserCoreConnectionAssignees of the work item. (see Connections)
canInviteMembers warning-solidBoolean!Deprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use: workitemWidgetDefinitionAssignees.canInviteMembers.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetAwardEmoji

Represents the emoji reactions widget.

Fields

NameTypeDescription
awardEmojiAwardEmojiConnectionEmoji reactions on the work item. (see Connections)
downvotesInt!Number of downvotes the work item has received.
typeWorkItemWidgetTypeWidget type.
upvotesInt!Number of upvotes the work item has received.

WorkItemWidgetColor

Represents a color widget.

Fields

NameTypeDescription
colorStringColor of the Work Item.
textColorStringText color generated for the Work Item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetCrmContacts

Represents CRM contacts widget.

Fields

NameTypeDescription
contactsCustomerRelationsContactConnectionCollection of CRM contacts associated with the work item. (see Connections)
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetCurrentUserTodos

Represents a todos widget.

Fields

NameTypeDescription
typeWorkItemWidgetTypeWidget type.

Fields with arguments

WorkItemWidgetCurrentUserTodos.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
NameTypeDescription
stateTodoStateEnumState of the to-do items.

WorkItemWidgetCustomFields

Represents a custom fields widget.

Fields

NameTypeDescription
customFieldValues warning-solid[WorkItemCustomFieldValue!]Introduced in GitLab 17.9. Status: Experiment. Custom field values associated to the work item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetCustomStatus

Represents Custom Status widget.

Fields

NameTypeDescription
iconName warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Icon name of the Custom Status.
id warning-solidWorkItemsWidgetsCustomStatusID!Introduced in GitLab 17.8. Status: Experiment. ID of the Custom Status.
name warning-solidStringIntroduced in GitLab 17.8. Status: Experiment. Name of the Custom Status.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetDefinitionAssignees

Represents an assignees widget definition.

Fields

NameTypeDescription
allowsMultipleAssigneesBoolean!Indicates whether multiple assignees are allowed.
canInviteMembersBoolean!Indicates whether the current user can invite members to the work item’s parent.
typeWorkItemWidgetType!Widget type.

WorkItemWidgetDefinitionCustomStatus

Represents an Custom Status widget definition.

Fields

NameTypeDescription
allowedCustomStatuses warning-solidWorkItemWidgetCustomStatusConnectionIntroduced in GitLab 17.8. Status: Experiment. Allowed custom statuses for the work item type.
typeWorkItemWidgetType!Widget type.

WorkItemWidgetDefinitionGeneric

Represents a generic widget definition.

Fields

NameTypeDescription
typeWorkItemWidgetType!Widget type.

WorkItemWidgetDefinitionHierarchy

Represents a hierarchy widget definition.

Fields

NameTypeDescription
allowedChildTypesWorkItemTypeConnectionAllowed child types for the work item type. (see Connections)
allowedParentTypesWorkItemTypeConnectionAllowed parent types for the work item type. (see Connections)
typeWorkItemWidgetType!Widget type.

WorkItemWidgetDefinitionLabels

Represents a labels widget definition.

Fields

NameTypeDescription
allowsScopedLabelsBoolean!Indicates whether scoped labels are available.
typeWorkItemWidgetType!Widget type.

WorkItemWidgetDefinitionWeight

Represents a weight widget definition.

Fields

NameTypeDescription
editableBoolean!Indicates whether editable weight is available.
rollUpBoolean!Indicates whether rolled up weight is available.
typeWorkItemWidgetType!Widget type.

WorkItemWidgetDescription

Represents a description widget.

Fields

NameTypeDescription
descriptionStringDescription of the work item.
descriptionHtmlStringGitLab Flavored Markdown rendering of description.
editedBoolean!Whether the description has been edited since the work item was created.
lastEditedAtTimeTimestamp of when the work item’s description was last edited.
lastEditedByUserCoreUser that made the last edit to the work item’s description.
taskCompletionStatusTaskCompletionStatus!Task completion status of the work item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetDesigns

Represents designs widget.

Fields

NameTypeDescription
designCollectionDesignCollectionCollection of design images associated with the issue.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetDevelopment

Represents a development widget.

Fields

NameTypeDescription
closingMergeRequestsWorkItemClosingMergeRequestConnectionMerge requests that will close the work item when merged. (see Connections)
featureFlagsFeatureFlagConnectionFeature flags associated with the work item. (see Connections)
relatedBranchesWorkItemRelatedBranchConnectionBranches that have referred to the work item, but do not have an associated merge request. (see Connections)
relatedMergeRequests warning-solidMergeRequestConnectionIntroduced in GitLab 17.6. Status: Experiment. Merge requests where the work item has been mentioned. This field can only be resolved for one work item in any single request.
typeWorkItemWidgetTypeWidget type.
willAutoCloseByMergeRequestBoolean!Whether the work item will automatically be closed when a closing merge request is merged.

WorkItemWidgetEmailParticipants

Represents email participants widget.

Fields

NameTypeDescription
emailParticipantsEmailParticipantTypeConnectionCollection of email participants associated with the work item. (see Connections)
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetErrorTracking

Represents the error tracking widget.

Fields

NameTypeDescription
identifierBigIntError tracking issue id.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetHealthStatus

Represents a health status widget.

Fields

NameTypeDescription
healthStatusHealthStatusHealth status of the work item.
rolledUpHealthStatus warning-solid[WorkItemWidgetHealthStatusCount!]Introduced in GitLab 17.3. Status: Experiment. Rolled up health status of the work item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetHealthStatusCount

Represents work item counts for the health status.

Fields

NameTypeDescription
countInt!Number of work items with the health status.
healthStatusHealthStatus!Health status of the work items.

WorkItemWidgetHierarchy

Represents a hierarchy widget.

Fields

NameTypeDescription
ancestorsWorkItemConnectionAncestors (parents) of the work item. (see Connections)
childrenWorkItemConnectionChild work items. (see Connections)
depthLimitReachedByType warning-solid[WorkItemTypeDepthLimitReachedByType!]!Introduced in GitLab 17.4. Status: Experiment. Depth limit reached by allowed work item type.
hasChildrenBoolean!Indicates if the work item has children.
hasParentBoolean!Indicates if the work item has a parent.
parentWorkItemParent work item.
rolledUpCountsByType warning-solid[WorkItemTypeCountsByState!]!Introduced in GitLab 17.3. Status: Experiment. Counts of descendant work items by work item type and state.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetIteration

Represents an iteration widget.

Fields

NameTypeDescription
iterationIterationIteration of the work item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetLabels

Represents the labels widget.

Fields

NameTypeDescription
allowsScopedLabels warning-solidBooleanDeprecated in GitLab 16.7. Field moved to workItemType widget definition interface. Use: WorkItemWidgetDefinitionLabels.allowsScopedLabels.
labelsLabelConnectionLabels assigned to the work item. (see Connections)
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetLinkedItems

Represents the linked items widget.

Fields

NameTypeDescription
blockedBooleanIndicates the work item is blocked.
blockedByCountIntCount of items blocking the work item.
blockingCountIntCount of items the work item is blocking.
typeWorkItemWidgetTypeWidget type.

Fields with arguments

WorkItemWidgetLinkedItems.linkedItems

Linked items for the work item.

  • Introduced in GitLab 16.3.
  • Status: Experiment.

Returns LinkedWorkItemTypeConnection.

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

Arguments
NameTypeDescription
filterWorkItemRelatedLinkTypeFilter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.

WorkItemWidgetLinkedResources

Represents the linked resources widget.

Fields

NameTypeDescription
linkedResourcesWorkItemLinkedResourceConnectionResources for the work item. (see Connections)
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetMilestone

Represents a milestone widget.

Fields

NameTypeDescription
milestoneMilestoneMilestone of the work item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetNotes

Represents a notes widget.

Fields

NameTypeDescription
discussionLockedBooleanDiscussion lock attribute of the work item.
typeWorkItemWidgetTypeWidget type.

Fields with arguments

WorkItemWidgetNotes.discussions

Notes on this work item.

Returns DiscussionConnection.

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

Arguments
NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.

WorkItemWidgetNotifications

Represents the notifications widget.

Fields

NameTypeDescription
subscribedBoolean!Whether the current user is subscribed to notifications on the work item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetParticipants

Represents a participants widget.

Fields

NameTypeDescription
participantsUserCoreConnectionParticipants in the work item. (see Connections)
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetProgress

Represents a progress widget.

Fields

NameTypeDescription
currentValueIntCurrent value of the work item.
endValueIntEnd value of the work item.
progressIntProgress of the work item.
startValueIntStart value of the work item.
typeWorkItemWidgetTypeWidget type.
updatedAtTimeTimestamp of last progress update.

WorkItemWidgetRequirementLegacy

Represents a legacy requirement widget.

Fields

NameTypeDescription
legacyIid warning-solidIntDeprecated in GitLab 15.9. Use Work Item IID instead.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetStartAndDueDate

Represents a start and due date widget.

Fields

NameTypeDescription
dueDateDateDue date of the work item.
dueDateSourcingMilestoneMilestoneIndicates which milestone sources the rolled up due date.
dueDateSourcingWorkItemWorkItemIndicates which work_item sources the rolled up due date.
isFixedBoolean!Indicates if the work item is using fixed dates.
rollUpBoolean!Indicates if the work item can use rolled up dates.
startDateDateStart date of the work item.
startDateSourcingMilestoneMilestoneIndicates which milestone sources the rolled up start date.
startDateSourcingWorkItemWorkItemIndicates which work_item sources the rolled up start date.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetStatus

Represents a status widget.

Fields

NameTypeDescription
status warning-solidStringIntroduced in GitLab 15.5. Status: Experiment. Status of the work item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetTestReports

Represents a test reports widget.

Fields

NameTypeDescription
testReportsTestReportConnectionTest reports of the work item. (see Connections)
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetTimeTracking

Represents a time tracking widget.

Fields

NameTypeDescription
timeEstimateIntTime estimate of the work item.
timelogsWorkItemTimelogConnectionTimelogs on the work item. (see Connections)
totalTimeSpentIntTotal time (in seconds) reported as spent on the work item.
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetWeight

Represents a weight widget.

Fields

NameTypeDescription
rolledUpCompletedWeight warning-solidIntIntroduced in GitLab 17.3. Status: Experiment. Rolled up weight from closed descendant work items.
rolledUpWeight warning-solidIntIntroduced in GitLab 17.2. Status: Experiment. Rolled up weight from descendant work items.
typeWorkItemWidgetTypeWidget type.
weightIntWeight of the work item.
widgetDefinitionWorkItemWidgetDefinitionWeightWeight widget definition.

Workspace

Represents a remote development workspace.

Fields

NameTypeDescription
actualStateString!Actual state of the workspace.
clusterAgentClusterAgent!Kubernetes agent associated with the workspace.
createdAtTime!Timestamp of when the workspace was created.
deploymentResourceVersionIntVersion of the deployment resource for the workspace.
desiredConfigGeneratorVersion warning-solidInt!Introduced in GitLab 17.6. Status: Experiment. Version of the desired config generator for the workspace.
desiredStateString!Desired state of the workspace.
desiredStateUpdatedAtTime!Timestamp of the last update to the desired state.
devfileString!Source YAML of the devfile used to configure the workspace.
devfilePathStringPath to the devfile used to configure the workspace.
devfileRef warning-solidString!Deprecated in GitLab 17.8. Field is renamed to project_ref.
devfileWebUrl warning-solidStringDeprecated in GitLab 17.8. Field is not used.
editor warning-solidString!Deprecated in GitLab 17.5. Field is not used.
forceIncludeAllResources warning-solidBoolean!Introduced in GitLab 17.6. Status: Experiment. Forces all resources to be included for the workspaceduring the next reconciliation with the agent.
idRemoteDevelopmentWorkspaceID!Global ID of the workspace.
maxHoursBeforeTermination warning-solidInt!Deprecated in GitLab 17.9. Field is not used.
nameString!Name of the workspace in Kubernetes.
namespaceString!Namespace of the workspace in Kubernetes.
processedDevfileString!Processed YAML of the devfile used to configure the workspace.
projectIdID!ID of the project that contains the devfile for the workspace.
projectRefString!Git reference that contains the devfile used to configure the workspace, and that will be cloned into the workspace.
respondedToAgentAtTimeTimestamp of the last response sent to the GitLab agent for Kubernetes for the workspace.
updatedAtTime!Timestamp of the last update to any mutable workspace property.
urlString!URL of the workspace.
userUserCore!Owner of the workspace.
workspaceVariables warning-solidWorkspaceVariableConnectionIntroduced in GitLab 17.9. Status: Experiment. User defined variables associated with the workspace.
workspacesAgentConfigVersion warning-solidInt!Introduced in GitLab 17.6. Status: Experiment. Version of the associated WorkspacesAgentConfig for the workspace.

WorkspaceResources

Resource specifications of the workspace container.

Fields

NameTypeDescription
limitsResourceQuotasLimits for the requested container resources of a workspace.
requestsResourceQuotasRequested resources for the container of a workspace.

WorkspaceVariable

Represents a remote development workspace variable.

Fields

NameTypeDescription
createdAtTime!Timestamp of when the workspace variable was created.
idRemoteDevelopmentWorkspaceVariableID!Global ID of the workspace variable.
keyStringName of the workspace variable.
updatedAtTime!Timestamp of when the workspace variable was updated.
valueStringValue of the workspace variable.
variableTypeWorkspaceVariableTypeType of the workspace variable.

WorkspacesAgentConfig

Represents a workspaces agent config.

Fields

NameTypeDescription
allowPrivilegeEscalationBoolean!Allow privilege escalation.
annotations[KubernetesAnnotation!]!Annotations to apply to Kubernetes objects.
clusterAgentClusterAgent!Cluster agent that the workspaces agent config belongs to.
createdAtTime!Timestamp of when the workspaces agent config was created.
defaultMaxHoursBeforeTermination warning-solidInt!Deprecated in GitLab 17.9. Field is not used.
defaultResourcesPerWorkspaceContainer warning-solidWorkspaceResources!Introduced in GitLab 17.9. Status: Experiment. Default cpu and memory resources of the workspace container.
defaultRuntimeClassString!Default Kubernetes RuntimeClass.
dnsZoneString!DNS zone where workspaces are available.
enabledBoolean!Indicates whether remote development is enabled for the GitLab agent.
gitlabWorkspacesProxyNamespaceString!Namespace where gitlab-workspaces-proxy is installed.
idRemoteDevelopmentWorkspacesAgentConfigID!Global ID of the workspaces agent config.
imagePullSecrets warning-solid[ImagePullSecrets!]!Introduced in GitLab 17.9. Status: Experiment. Kubernetes secrets to pull private images for a workspace.
labels[KubernetesLabel!]!Labels to apply to Kubernetes objects.
maxHoursBeforeTerminationLimit warning-solidInt!Deprecated in GitLab 17.9. Field is not used.
maxResourcesPerWorkspace warning-solidWorkspaceResources!Introduced in GitLab 17.9. Status: Experiment. Maximum cpu and memory resources of the workspace.
networkPolicyEgress warning-solid[NetworkPolicyEgress!]!Introduced in GitLab 17.9. Status: Experiment. IP CIDR range specifications for egress destinations from a workspace.
networkPolicyEnabledBoolean!Whether the network policy of the workspaces agent config is enabled.
projectIdIDID of the project that the workspaces agent config belongs to.
updatedAtTime!Timestamp of the last update to any mutable workspaces agent config property.
useKubernetesUserNamespacesBoolean!Indicates whether to use user namespaces in Kubernetes.
workspacesPerUserQuotaInt!Maximum number of workspaces per user.
workspacesQuotaInt!Maximum number of workspaces for the GitLab agent.

X509Certificate

Represents an X.509 certificate.

Fields

NameTypeDescription
certificateStatusString!Indicates if the certificate is good or revoked.
createdAtTime!Timestamp of when the certificate was saved.
emailString!Email associated with the cerificate.
idID!ID of the certificate.
serialNumberString!Serial number of the certificate.
subjectString!Subject of the certificate.
subjectKeyIdentifierString!Subject key identifier of the certificate.
updatedAtTime!Timestamp of when the certificate was last updated.
x509IssuerX509Issuer!Issuer of the certificate.

X509Issuer

Issuer of an X.509 certificate.

Fields

NameTypeDescription
createdAtTimeTimestamp of when the issuer was created.
crlUrlStringCertificate revokation list of the issuer.
idIDID of the issuer.
subjectStringSubject of the issuer.
subjectKeyIdentifierStringSubject key identifier of the issuer.
updatedAtTimeTimestamp of when the issuer was last updated.

X509Signature

X.509 signature for a signed commit.

Fields

NameTypeDescription
commitShaStringSHA of the associated commit.
projectProjectProject of the associated commit.
userUserCoreUser associated with the key.
verificationStatusVerificationStatusIndicates verification status of the associated key or certificate.
x509CertificateX509CertificateCertificate used for the signature.

Enumeration types

Also called Enums, enumeration types are a special kind of scalar that is restricted to a particular set of allowed values.

For more information, see Enumeration Types on graphql.org.

AccessLevelEnum

Access level to a resource.

ValueDescription
ADMINAdmin access.
DEVELOPERDeveloper access.
GUESTGuest access.
MAINTAINERMaintainer access.
MINIMAL_ACCESSMinimal access.
NO_ACCESSNo access.
OWNEROwner access.
PLANNERPlanner access.
REPORTERReporter access.

AgentTokenStatus

Agent token statuses.

ValueDescription
ACTIVEActive agent token.
REVOKEDRevoked agent token.

AiAcceptedSelfHostedModels

LLMs supported by the self-hosted model features.

ValueDescription
CLAUDE_3Claude 3 model family, suitable for code generation and duo chat.
CODEGEMMACodeGemma Code: Suitable for code suggestions.
CODELLAMACode-Llama Instruct: Suitable for code suggestions.
CODESTRALCodestral: Suitable for code suggestions.
DEEPSEEKCODERDeepseek Coder base or instruct.
GPTGPT: Suitable for code suggestions.
LLAMA3LLaMA 3: Suitable for code suggestions and duo chat.
MISTRALMistral: Suitable for code suggestions and duo chat.
MIXTRALMixtral: Suitable for code suggestions and duo chat.

AiAction

Action to subscribe to.

ValueDescription
CHATChat action.

AiAdditionalContextCategory

The category of the additional context.

ValueDescription
DEPENDENCYDependency content category.
FILEFile content category.
ISSUEIssue content category.
LOCAL_GITLocal_git content category.
MERGE_REQUESTMerge_request content category.
SNIPPETSnippet content category.

AiConversationsThreadsConversationType

Conversation type of the thread.

ValueDescription
DUO_CHATduo_chat thread.
DUO_CODE_REVIEWduo_code_review thread.
DUO_QUICK_CHATduo_quick_chat thread.

AiFeatureProviders

Providers for AI features that can be configured.

ValueDescription
DISABLEDDisabled option.
SELF_HOSTEDSelf hosted option.
VENDOREDVendored option.

AiFeatures

AI features that can be configured in the settings.

ValueDescription
CODE_COMPLETIONSCode completion feature setting.
CODE_GENERATIONSCode generation feature setting.
DUO_CHATDuo chat feature setting.
DUO_CHAT_EXPLAIN_CODEDuo chat explain code feature setting.
DUO_CHAT_FIX_CODEDuo chat fix code feature setting.
DUO_CHAT_REFACTOR_CODEDuo chat refactor code feature setting.
DUO_CHAT_WRITE_TESTSDuo chat write test feature setting.

AiMessageRole

Possible message roles for AI features.

ValueDescription
ASSISTANTassistant message.
SYSTEMsystem message.
USERuser message.

AiMessageType

Types of messages returned from AI features.

ValueDescription
TOOLTool selection message.

AiSelfHostedModelReleaseState

GitLab release state of the model.

ValueDescription
BETABeta status.
EXPERIMENTALExperimental status.
GAGA status.

AiUsageCodeSuggestionEvent

Type of code suggestion event.

ValueDescription
CODE_SUGGESTION_ACCEPTED_IN_IDECode suggestion accepted.
CODE_SUGGESTION_REJECTED_IN_IDECode suggestion rejected.
CODE_SUGGESTION_SHOWN_IN_IDECode suggestion shown.

AlertManagementAlertSort

Values for sorting alerts.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
CREATED_TIME_ASCCreated time by ascending order.
CREATED_TIME_DESCCreated time by descending order.
ENDED_AT_ASCEnd time by ascending order.
ENDED_AT_DESCEnd time by descending order.
EVENT_COUNT_ASCEvents count by ascending order.
EVENT_COUNT_DESCEvents count by descending order.
SEVERITY_ASCSeverity from less critical to more critical.
SEVERITY_DESCSeverity from more critical to less critical.
STARTED_AT_ASCStart time by ascending order.
STARTED_AT_DESCStart time by descending order.
STATUS_ASCStatus by order: Ignored > Resolved > Acknowledged > Triggered.
STATUS_DESCStatus by order: Triggered > Acknowledged > Resolved > Ignored.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
UPDATED_TIME_ASCCreated time by ascending order.
UPDATED_TIME_DESCCreated time by descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

AlertManagementDomainFilter

Filters the alerts based on given domain.

ValueDescription
operationsAlerts for operations domain.
threat_monitoring warning-solidDeprecated in GitLab 15.0. Network policies are deprecated and will be removed in GitLab 16.0.

AlertManagementIntegrationType

Values of types of integrations.

ValueDescription
HTTPIntegration with any monitoring tool.
PROMETHEUSPrometheus integration.

AlertManagementPayloadAlertFieldName

Values for alert field names used in the custom mapping.

ValueDescription
DESCRIPTIONA high-level summary of the problem.
END_TIMEThe resolved time of the incident.
FINGERPRINTThe unique identifier of the alert. This can be used to group occurrences of the same alert.
GITLAB_ENVIRONMENT_NAMEThe name of the associated GitLab environment.
HOSTSOne or more hosts, as to where this incident occurred.
MONITORING_TOOLThe name of the associated monitoring tool.
SERVICEThe affected service.
SEVERITYThe severity of the alert.
START_TIMEThe time of the incident.
TITLEThe title of the incident.

AlertManagementPayloadAlertFieldType

Values for alert field types used in the custom mapping.

ValueDescription
ARRAYArray field type.
DATETIMEDateTime field type.
NUMBERNumber field type.
STRINGString field type.

AlertManagementSeverity

Alert severity values.

ValueDescription
CRITICALCritical severity.
HIGHHigh severity.
INFOInfo severity.
LOWLow severity.
MEDIUMMedium severity.
UNKNOWNUnknown severity.

AlertManagementStatus

Alert status values.

ValueDescription
ACKNOWLEDGEDSomeone is actively investigating the problem.
IGNOREDNo action will be taken.
RESOLVEDThe problem has been addressed.
TRIGGEREDInvestigation has not started.

AnalyticsAggregationPeriod

ValueDescription
DAYDaily aggregation.
MONTHMonthly aggregation.
WEEKWeekly aggregation.

ApiFuzzingScanMode

All possible ways to specify the API surface for an API fuzzing scan.

ValueDescription
HARThe API surface is specified by a HAR file.
OPENAPIThe API surface is specified by a OPENAPI file.
POSTMANThe API surface is specified by a POSTMAN file.

ApprovalReportType

ValueDescription
ANY_MERGE_REQUESTRepresents report_type for any_merge_request related approval rules.
LICENSE_SCANNINGRepresents report_type for license scanning related approval rules.
SCAN_FINDINGRepresents report_type for vulnerability check related approval rules.

ApprovalRuleType

The kind of an approval rule.

ValueDescription
ANY_APPROVERA any_approver approval rule.
CODE_OWNERA code_owner approval rule.
REGULARA regular approval rule.
REPORT_APPROVERA report_approver approval rule.

AssigneeWildcardId

Assignee ID wildcard values.

ValueDescription
ANYAn assignee is assigned.
NONENo assignee is assigned.

AutoStopSetting

Auto stop setting.

ValueDescription
ALWAYSAlways.
WITH_ACTIONWith Action.

AvailabilityEnum

User availability status.

ValueDescription
BUSYBusy.
NOT_SETNot Set.

AvailableExportFields

Available fields to be exported as CSV.

ValueDescription
AUTHORAuthor name.
AUTHOR_USERNAMEAuthor username.
CREATED_ATDate of creation.
DESCRIPTIONDescription.
IDUnique identifier.
TITLETitle.
TYPEType of the work item.

BlobViewersType

Types of blob viewers.

ValueDescription
auxiliaryAuxiliary blob viewers type.
richRich blob viewers type.
simpleSimple blob viewers type.

CarStatus

Status of a merge train’s car.

ValueDescription
FRESHCar’s status: fresh.
IDLECar’s status: idle.
MERGEDCar’s status: merged.
MERGINGCar’s status: merging.
SKIP_MERGEDCar’s status: skip_merged.
STALECar’s status: stale.

CiCatalogResourceComponentInputType

Available input types.

ValueDescription
ARRAYArray input.
BOOLEANBoolean input.
NUMBERNumber input.
STRINGString input.

CiCatalogResourceScope

Values for scoping catalog resources.

ValueDescription
ALLAll catalog resources visible to the current user.
NAMESPACESCatalog resources belonging to authorized namespaces of the user.

CiCatalogResourceSort

Values for sorting catalog resources.

ValueDescription
CREATED_ASCCreated date by ascending order.
CREATED_DESCCreated date by descending order.
LATEST_RELEASED_AT_ASCLatest release date by ascending order.
LATEST_RELEASED_AT_DESCLatest release date by descending order.
NAME_ASCName by ascending order.
NAME_DESCName by descending order.
STAR_COUNT_ASCStar count by ascending order.
STAR_COUNT_DESCStar count by descending order.
USAGE_COUNT_ASCLast 30-day usage count by ascending order.
USAGE_COUNT_DESCLast 30-day usage count by descending order.

CiCatalogResourceVerificationLevel

ValueDescription
GITLAB_MAINTAINEDThe resource is Gitlab Maintained.
GITLAB_PARTNER_MAINTAINEDThe resource is Gitlab Partner Maintained.
UNVERIFIEDThe resource is Unverified.
VERIFIED_CREATOR_MAINTAINEDThe resource is Verified Creator Maintained.

CiConfigIncludeType

Include type.

ValueDescription
componentComponent include.
fileProject file include.
localLocal include.
remoteRemote include.
templateTemplate include.

CiConfigStatus

Values for YAML processor result.

ValueDescription
INVALIDConfiguration file is not valid.
VALIDConfiguration file is valid.

CiFreezePeriodStatus

Deploy freeze period status.

ValueDescription
ACTIVEFreeze period is active.
INACTIVEFreeze period is inactive.

CiGroupVariablesSort

Values for sorting inherited variables.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
KEY_ASCKey by ascending order.
KEY_DESCKey by descending order.

CiJobFailureReason

ValueDescription
API_FAILUREA job that failed due to api failure.
ARCHIVED_FAILUREA job that failed due to archived failure.
BRIDGE_PIPELINE_IS_CHILD_PIPELINEA job that failed due to bridge pipeline is child pipeline.
BUILDS_DISABLEDA job that failed due to builds disabled.
CI_QUOTA_EXCEEDEDA job that failed due to ci quota exceeded.
DATA_INTEGRITY_FAILUREA job that failed due to data integrity failure.
DEPLOYMENT_REJECTEDA job that failed due to deployment rejected.
DOWNSTREAM_BRIDGE_PROJECT_NOT_FOUNDA job that failed due to downstream bridge project not found.
DOWNSTREAM_PIPELINE_CREATION_FAILEDA job that failed due to downstream pipeline creation failed.
ENVIRONMENT_CREATION_FAILUREA job that failed due to environment creation failure.
FAILED_OUTDATED_DEPLOYMENT_JOBA job that failed due to failed outdated deployment job.
FORWARD_DEPLOYMENT_FAILUREA job that failed due to forward deployment failure.
INSUFFICIENT_BRIDGE_PERMISSIONSA job that failed due to insufficient bridge permissions.
INSUFFICIENT_UPSTREAM_PERMISSIONSA job that failed due to insufficient upstream permissions.
INVALID_BRIDGE_TRIGGERA job that failed due to invalid bridge trigger.
IP_RESTRICTION_FAILUREA job that failed due to ip restriction failure.
JOB_EXECUTION_TIMEOUTA job that failed due to job execution timeout.
MISSING_DEPENDENCY_FAILUREA job that failed due to missing dependency failure.
NO_MATCHING_RUNNERA job that failed due to no matching runner.
PIPELINE_LOOP_DETECTEDA job that failed due to pipeline loop detected.
PROJECT_DELETEDA job that failed due to project deleted.
PROTECTED_ENVIRONMENT_FAILUREA job that failed due to protected environment failure.
REACHED_DOWNSTREAM_PIPELINE_TRIGGER_RATE_LIMITA job that failed due to reached downstream pipeline trigger rate limit.
REACHED_MAX_DESCENDANT_PIPELINES_DEPTHA job that failed due to reached max descendant pipelines depth.
REACHED_MAX_PIPELINE_HIERARCHY_SIZEA job that failed due to reached max pipeline hierarchy size.
RUNNER_SYSTEM_FAILUREA job that failed due to runner system failure.
RUNNER_UNSUPPORTEDA job that failed due to runner unsupported.
SCHEDULER_FAILUREA job that failed due to scheduler failure.
SCRIPT_FAILUREA job that failed due to script failure.
SECRETS_PROVIDER_NOT_FOUNDA job that failed due to secrets provider not found.
STALE_SCHEDULEA job that failed due to stale schedule.
STUCK_OR_TIMEOUT_FAILUREA job that failed due to stuck or timeout failure.
TRACE_SIZE_EXCEEDEDA job that failed due to trace size exceeded.
UNKNOWN_FAILUREA job that failed due to unknown failure.
UNMET_PREREQUISITESA job that failed due to unmet prerequisites.
UPSTREAM_BRIDGE_PROJECT_NOT_FOUNDA job that failed due to upstream bridge project not found.
USER_BLOCKEDA job that failed due to user blocked.

CiJobKind

ValueDescription
BRIDGEBridge CI job connecting a parent and child pipeline.
BUILDStandard CI job.

CiJobSource

ValueDescription
APIA job initiated by api.
CHATA job initiated by chat.
CONTAINER_REGISTRY_PUSHA job initiated by container registry push.
DUO_WORKFLOWA job initiated by duo workflow.
EXTERNALA job initiated by external.
EXTERNAL_PULL_REQUEST_EVENTA job initiated by external pull request event.
MERGE_REQUEST_EVENTA job initiated by merge request event.
ONDEMAND_DAST_SCANA job initiated by ondemand dast scan.
ONDEMAND_DAST_VALIDATIONA job initiated by ondemand dast validation.
PARENT_PIPELINEA job initiated by parent pipeline.
PIPELINEA job initiated by pipeline.
PIPELINE_EXECUTION_POLICYA job initiated by pipeline execution policy.
PIPELINE_EXECUTION_POLICY_SCHEDULEA job initiated by pipeline execution policy schedule.
PUSHA job initiated by push.
SCAN_EXECUTION_POLICYA job initiated by scan execution policy.
SCHEDULEA job initiated by schedule.
SECURITY_ORCHESTRATION_POLICYA job initiated by security orchestration policy.
TRIGGERA job initiated by trigger.
UNKNOWNA job initiated by unknown.
WEBA job initiated by web.
WEBIDEA job initiated by webide.

CiJobStatus

ValueDescription
CANCELEDA job that is canceled.
CANCELINGA job that is canceling.
CREATEDA job that is created.
FAILEDA job that is failed.
MANUALA job that is manual.
PENDINGA job that is pending.
PREPARINGA job that is preparing.
RUNNINGA job that is running.
SCHEDULEDA job that is scheduled.
SKIPPEDA job that is skipped.
SUCCESSA job that is success.
WAITING_FOR_CALLBACKA job that is waiting for callback.
WAITING_FOR_RESOURCEA job that is waiting for resource.

CiJobTokenScopeDirection

Direction of access.

ValueDescription
INBOUNDTarget projects in the inbound allowlist can access the scope project through their job tokens.
OUTBOUNDJob token scope project can access target project in the outbound allowlist.

CiJobTokenScopePolicies

CI_JOB_TOKEN policy.

ValueDescription
ADMIN_CONTAINERSAdmin Containers.
ADMIN_DEPLOYMENTSAdmin Deployments.
ADMIN_ENVIRONMENTSAdmin Environments.
ADMIN_JOBSAdmin Jobs.
ADMIN_PACKAGESAdmin Packages.
ADMIN_RELEASESAdmin Releases.
ADMIN_SECURE_FILESAdmin Secure Files.
ADMIN_TERRAFORM_STATEAdmin Terraform State.
READ_CONTAINERSRead Containers.
READ_DEPLOYMENTSRead Deployments.
READ_ENVIRONMENTSRead Environments.
READ_JOBSRead Jobs.
READ_PACKAGESRead Packages.
READ_RELEASESRead Releases.
READ_SECURE_FILESRead Secure Files.
READ_TERRAFORM_STATERead Terraform State.

CiPipelineCiSources

Ci Pipeline Ci sources enum.

ValueDescription
APIPipeline created by an API event.
CHATPipeline created by a chat event.
EXTERNALPipeline created by an external event.
EXTERNAL_PULL_REQUEST_EVENTPipeline created by an external pull request event.
MERGE_REQUEST_EVENTPipeline created by a merge request event.
PIPELINEPipeline created by a pipeline event.
PUSHPipeline created by a push event.
SCHEDULEPipeline created by a schedule event.
TRIGGERPipeline created by a trigger event.
UNKNOWNPipeline created by an unknown event.
WEBPipeline created by a web event.

CiPipelineCreationStatus

The status of a pipeline creation.

ValueDescription
FAILEDThe pipeline creation is failed.
IN_PROGRESSThe pipeline creation is in progress.
SUCCEEDEDThe pipeline creation is succeeded.

CiRunnerAccessLevel

ValueDescription
NOT_PROTECTEDA runner that is not protected.
REF_PROTECTEDA runner that is ref protected.

CiRunnerCloudProvider

Runner cloud provider.

ValueDescription
GKEGoogle Kubernetes Engine.
GOOGLE_CLOUDGoogle Cloud.

CiRunnerCreationMethod

ValueDescription
AUTHENTICATED_USERApplies to a runner that was created by an authenticated user.
REGISTRATION_TOKENApplies to a runner that was created by a runner registration token.

CiRunnerJobExecutionStatus

ValueDescription
ACTIVE warning-solidIntroduced in GitLab 17.2. Status: Experiment. Runner is busy.
IDLE warning-solidIntroduced in GitLab 15.7. Status: Experiment. Runner is idle.

CiRunnerMembershipFilter

Values for filtering runners in namespaces.

ValueDescription
ALL_AVAILABLE warning-solidIntroduced in GitLab 15.5. Status: Experiment. Include all runners. This list includes runners for all projects in the group and subgroups, as well as for the parent groups and instance.
DESCENDANTSInclude runners that have either a direct or inherited relationship. These runners can be specific to a project or a group.
DIRECTInclude runners that have a direct relationship.

CiRunnerOwnerWildcard

ValueDescription
ADMINISTRATORSFilter runners owned by an administrator.

CiRunnerSort

Values for sorting runners.

ValueDescription
CONTACTED_ASCOrdered by contacted_at in ascending order.
CONTACTED_DESCOrdered by contacted_at in descending order.
CREATED_ASCOrdered by created_at in ascending order.
CREATED_DESCOrdered by created_at in descending order.
MOST_ACTIVE_DESC warning-solidIntroduced in GitLab 16.2. Status: Experiment. Ordered by number of running jobs in descending order (only available on Ultimate plans).
TOKEN_EXPIRES_AT_ASCOrdered by token_expires_at in ascending order.
TOKEN_EXPIRES_AT_DESCOrdered by token_expires_at in descending order.

CiRunnerStatus

ValueDescription
NEVER_CONTACTEDRunner that has never contacted the instance.
OFFLINERunner that has not contacted this instance within the last 2 hours. Will be considered STALE if offline for more than 7 days.
ONLINERunner that contacted this instance within the last 2 hours.
STALERunner that has not contacted this instance within the last 7 days.

CiRunnerType

ValueDescription
GROUP_TYPEA runner that is group type.
INSTANCE_TYPEA runner that is instance type.
PROJECT_TYPEA runner that is project type.

CiRunnerUpgradeStatus

ValueDescription
AVAILABLEUpgrade is available for the runner.
INVALIDRunner version is not valid.
NOT_AVAILABLEUpgrade is not available for the runner.
RECOMMENDEDUpgrade is available and recommended for the runner.

CiVariableSort

Values for sorting variables.

ValueDescription
KEY_ASCSorted by key in ascending order.
KEY_DESCSorted by key in descending order.

CiVariableType

ValueDescription
ENV_VAREnv var type.
FILEFile type.

CodeFlowNodeType

The code flow node type.

ValueDescription
PROPAGATIONPropagation node.
SINKSink node.
SOURCESource node.

CodeQualityDegradationSeverity

ValueDescription
BLOCKERCode Quality degradation has a status of blocker.
CRITICALCode Quality degradation has a status of critical.
INFOCode Quality degradation has a status of info.
MAJORCode Quality degradation has a status of major.
MINORCode Quality degradation has a status of minor.
UNKNOWNCode Quality degradation has a status of unknown.

CodequalityReportsComparerReportGenerationStatus

Represents the generation status of the compared codequality report.

ValueDescription
ERRORAn error happened while generating the report.
PARSEDReport was generated.
PARSINGReport is being generated.

CodequalityReportsComparerStatus

Represents the state of the code quality report.

ValueDescription
FAILEDReport generated and there are new code quality degradations.
NOT_FOUNDHead report or base report not found.
SUCCESSNo degradations found in the head pipeline report.

CommitActionMode

Mode of a commit action.

ValueDescription
CHMODChmod command.
CREATECreate command.
DELETEDelete command.
MOVEMove command.
UPDATEUpdate command.

CommitEncoding

ValueDescription
BASE64Base64 encoding.
TEXTText encoding.

ComparableSecurityReportType

Comparable security report type.

ValueDescription
API_FUZZINGAPI Fuzzing report.
CONTAINER_SCANNINGContainer Scanning report.
COVERAGE_FUZZINGCoverage Fuzzing report.
DASTDAST report.
DEPENDENCY_SCANNINGDependency Scanning report.
SASTSAST report.
SECRET_DETECTIONSecret Detection report.

ComplianceFrameworkPresenceFilter

ComplianceFramework of a project for filtering.

ValueDescription
ANYAny compliance framework is assigned.
NONENo compliance framework is assigned.

ComplianceStandardsAdherenceCheckName

Name of the check for the compliance standard.

ValueDescription
AT_LEAST_ONE_NON_AUTHOR_APPROVALAt least one non author approval.
AT_LEAST_TWO_APPROVALSAt least two approvals.
DASTDast.
PREVENT_APPROVAL_BY_MERGE_REQUEST_AUTHORPrevent approval by merge request author.
PREVENT_APPROVAL_BY_MERGE_REQUEST_COMMITTERSPrevent approval by merge request committers.
SASTSast.

ComplianceStandardsAdherenceStandard

Name of the compliance standard.

ValueDescription
GITLABGitlab.
SOC2Soc2.

ComplianceStandardsAdherenceStatus

Status of the compliance standards adherence.

ValueDescription
FAILFail.
SUCCESSSuccess.

ComplianceViolationReason

Reason for the compliance violation.

ValueDescription
APPROVED_BY_COMMITTERApproved by committer.
APPROVED_BY_INSUFFICIENT_USERSApproved by insufficient users.
APPROVED_BY_MERGE_REQUEST_AUTHORApproved by merge request author.

ComplianceViolationSeverity

Severity of the compliance violation.

ValueDescription
CRITICALCritical severity.
HIGHHigh severity.
INFOInfo severity.
LOWLow severity.
MEDIUMMedium severity.

ComplianceViolationSort

Compliance violation sort values.

ValueDescription
MERGED_AT_ASCDate merged in ascending order, further sorted by ID in ascending order.
MERGED_AT_DESCDate merged in descending order, further sorted by ID in descending order.
MERGE_REQUEST_TITLE_ASCMerge request title in ascending order, further sorted by ID in ascending order.
MERGE_REQUEST_TITLE_DESCMerge request title in descending order, further sorted by ID in descending order.
SEVERITY_LEVEL_ASCSeverity in ascending order, further sorted by ID in ascending order.
SEVERITY_LEVEL_DESCSeverity in descending order, further sorted by ID in descending order.
VIOLATION_REASON_ASCViolation reason in ascending order, further sorted by ID in ascending order.
VIOLATION_REASON_DESCViolation reason in descending order, further sorted by ID in descending order.

ConanMetadatumFileTypeEnum

Conan file types.

ValueDescription
PACKAGE_FILEA package file type.
RECIPE_FILEA recipe file type.

ContactSort

Values for sorting contacts.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
DESCRIPTION_ASCDescription in ascending order.
DESCRIPTION_DESCDescription in descending order.
EMAIL_ASCEmail in ascending order.
EMAIL_DESCEmail in descending order.
FIRST_NAME_ASCFirst name in ascending order.
FIRST_NAME_DESCFirst name in descending order.
LAST_NAME_ASCLast name in ascending order.
LAST_NAME_DESCLast name in descending order.
ORGANIZATION_ASCOrganization in ascending order.
ORGANIZATION_DESCOrganization in descending order.
PHONE_ASCPhone in ascending order.
PHONE_DESCPhone in descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

ContainerExpirationPolicyCadenceEnum

ValueDescription
EVERY_DAYEvery day.
EVERY_MONTHEvery month.
EVERY_THREE_MONTHSEvery three months.
EVERY_TWO_WEEKSEvery two weeks.
EVERY_WEEKEvery week.

ContainerExpirationPolicyKeepEnum

ValueDescription
FIFTY_TAGS50 tags per image name.
FIVE_TAGS5 tags per image name.
ONE_HUNDRED_TAGS100 tags per image name.
ONE_TAG1 tag per image name.
TEN_TAGS10 tags per image name.
TWENTY_FIVE_TAGS25 tags per image name.

ContainerExpirationPolicyOlderThanEnum

ValueDescription
FOURTEEN_DAYS14 days until tags are automatically removed.
NINETY_DAYS90 days until tags are automatically removed.
SEVEN_DAYS7 days until tags are automatically removed.
SIXTY_DAYS60 days until tags are automatically removed.
THIRTY_DAYS30 days until tags are automatically removed.

ContainerProtectionRepositoryRuleAccessLevel

Access level for a container repository protection rule resource.

ValueDescription
ADMINAdmin access.
MAINTAINERMaintainer access.
OWNEROwner access.

ContainerProtectionTagRuleAccessLevel

Access level of a container registry tag protection rule resource.

ValueDescription
ADMIN warning-solidIntroduced in GitLab 17.8. Status: Experiment. Admin access.
MAINTAINER warning-solidIntroduced in GitLab 17.8. Status: Experiment. Maintainer access.
OWNER warning-solidIntroduced in GitLab 17.8. Status: Experiment. Owner access.

ContainerRepositoryCleanupStatus

Status of the tags cleanup of a container repository.

ValueDescription
ONGOINGTags cleanup is ongoing.
SCHEDULEDTags cleanup is scheduled and is going to be executed shortly.
UNFINISHEDTags cleanup has been partially executed. There are still remaining tags to delete.
UNSCHEDULEDTags cleanup is not scheduled. This is the default state.

ContainerRepositorySort

Values for sorting container repositories.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
NAME_ASCName by ascending order.
NAME_DESCName by descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

ContainerRepositoryStatus

Status of a container repository.

ValueDescription
DELETE_FAILEDDelete Failed status.
DELETE_ONGOINGDelete Ongoing status.
DELETE_SCHEDULEDDelete Scheduled status.

ContainerRepositoryTagSort

Values for sorting tags.

ValueDescription
NAME_ASCOrdered by name in ascending order.
NAME_DESCOrdered by name in descending order.
PUBLISHED_AT_ASCOrdered by published_at in ascending order. Only available for GitLab.com.
PUBLISHED_AT_DESCOrdered by published_at in descending order. Only available for GitLab.com.

CustomFieldType

Type of custom field.

ValueDescription
MULTI_SELECTMulti select field type.
NUMBERNumber field type.
SINGLE_SELECTSingle select field type.
TEXTText field type.

CustomerRelationsContactState

ValueDescription
activeActive contacts.
allAll available contacts.
inactiveInactive contacts.

CustomerRelationsOrganizationState

ValueDescription
activeActive organizations.
allAll available organizations.
inactiveInactive organizations.

CustomizableDashboardCategory

Categories for customizable dashboards.

ValueDescription
ANALYTICSAnalytics category for customizable dashboards.

CvssSeverity

Values for a CVSS severity.

ValueDescription
CRITICALCritical severity.
HIGHHigh severity.
LOWLow severity.
MEDIUMMedium severity.
NONENot a vulnerability.

DastPreScanVerificationCheckType

Check type of the pre scan verification step.

ValueDescription
AUTHENTICATIONAuthentication check.
CONNECTIONConnection check.
CRAWLINGCrawling check.

DastPreScanVerificationStatus

Status of DAST pre scan verification.

ValueDescription
COMPLETEPre Scan Verification complete without errors.
COMPLETE_WITH_ERRORSPre Scan Verification finished with one or more errors.
FAILEDPre Scan Validation unable to finish.
RUNNINGPre Scan Verification in execution.

DastProfileCadenceUnit

Unit for the duration of Dast Profile Cadence.

ValueDescription
DAYDAST Profile Cadence duration in days.
MONTHDAST Profile Cadence duration in months.
WEEKDAST Profile Cadence duration in weeks.
YEARDAST Profile Cadence duration in years.

DastScanMethodType

Scan method to be used by the scanner.

ValueDescription
GRAPHQLGraphQL scan method.
HARHAR scan method.
OPENAPIOpenAPI scan method.
POSTMAN_COLLECTIONPostman scan method.
WEBSITEWebsite scan method.

DastScanTypeEnum

ValueDescription
ACTIVEActive DAST scan. This scan will make active attacks against the target site.
PASSIVEPassive DAST scan. This scan will not make active attacks against the target site.

DastSiteProfileValidationStatusEnum

ValueDescription
FAILED_VALIDATIONSite validation process finished but failed.
INPROGRESS_VALIDATIONSite validation process is in progress.
NONENo site validation exists.
PASSED_VALIDATIONSite validation process finished successfully.
PENDING_VALIDATIONSite validation process has not started.

DastSiteValidationStatusEnum

ValueDescription
FAILED_VALIDATIONSite validation process finished but failed.
INPROGRESS_VALIDATIONSite validation process is in progress.
PASSED_VALIDATIONSite validation process finished successfully.
PENDING_VALIDATIONSite validation process has not started.

DastSiteValidationStrategyEnum

ValueDescription
HEADERHeader validation.
META_TAGMeta tag validation.
TEXT_FILEText file validation.

DastTargetTypeEnum

ValueDescription
APIAPI target.
WEBSITEWebsite target.

DataVisualizationColorEnum

Color of the data visualization palette.

ValueDescription
AQUAAqua color.
BLUEBlue color.
GREENGreen color.
MAGENTAMagenta color.
ORANGEOrange color.

DataVisualizationWeightEnum

Weight of the data visualization palette.

ValueDescription
WEIGHT_100100 weight.
WEIGHT_200200 weight.
WEIGHT_300300 weight.
WEIGHT_400400 weight.
WEIGHT_5050 weight.
WEIGHT_500500 weight.
WEIGHT_600600 weight.
WEIGHT_700700 weight.
WEIGHT_800800 weight.
WEIGHT_900900 weight.
WEIGHT_950950 weight.

DependencyProxyManifestStatus

ValueDescription
DEFAULTDependency proxy manifest has a status of default.
ERRORDependency proxy manifest has a status of error.
PENDING_DESTRUCTIONDependency proxy manifest has a status of pending_destruction.
PROCESSINGDependency proxy manifest has a status of processing.

DependencySort

Values for sorting dependencies.

ValueDescription
NAME_ASCName by ascending order.
NAME_DESCName by descending order.
PACKAGER_ASCPackager by ascending order.
PACKAGER_DESCPackager by descending order.
SEVERITY_ASCSeverity by ascending order.
SEVERITY_DESCSeverity by descending order.

DeploymentApprovalSummaryStatus

Status of the deployment approval summary.

ValueDescription
APPROVEDSummarized deployment approval status that is approved.
PENDING_APPROVALSummarized deployment approval status that is pending approval.
REJECTEDSummarized deployment approval status that is rejected.

DeploymentStatus

All deployment statuses.

ValueDescription
BLOCKEDA deployment that is blocked.
CANCELEDA deployment that is canceled.
CREATEDA deployment that is created.
FAILEDA deployment that is failed.
RUNNINGA deployment that is running.
SKIPPEDA deployment that is skipped.
SUCCESSA deployment that is success.

DeploymentTier

All environment deployment tiers.

ValueDescription
DEVELOPMENTDevelopment.
OTHEROther.
PRODUCTIONProduction.
STAGINGStaging.
TESTINGTesting.

DeploymentsApprovalStatus

Status of the deployment approval.

ValueDescription
APPROVEDA deployment approval that is approved.
REJECTEDA deployment approval that is rejected.

DesignCollectionCopyState

Copy state of a DesignCollection.

ValueDescription
ERRORThe DesignCollection encountered an error during a copy.
IN_PROGRESSThe DesignCollection is being copied.
READYThe DesignCollection has no copy in progress.

DesignVersionEvent

Mutation event of a design within a version.

ValueDescription
CREATIONA creation event.
DELETIONA deletion event.
MODIFICATIONA modification event.
NONENo change.

DetailedMergeStatus

Detailed representation of whether a GitLab merge request can be merged.

ValueDescription
APPROVALS_SYNCINGMerge request approvals currently syncing.
BLOCKED_STATUSMerge request dependencies must be merged.
CHECKINGCurrently checking for mergeability.
CI_MUST_PASSPipeline must succeed before merging.
CI_STILL_RUNNINGPipeline is still running.
COMMITS_STATUSSource branch exists and contains commits.
CONFLICTThere are conflicts between the source and target branches.
DISCUSSIONS_NOT_RESOLVEDDiscussions must be resolved before merging.
DRAFT_STATUSMerge request must not be draft before merging.
EXTERNAL_STATUS_CHECKSStatus checks must pass.
JIRA_ASSOCIATIONEither the title or description must reference a Jira issue.
LOCKED_LFS_FILESMerge request includes locked LFS files.
LOCKED_PATHSMerge request includes locked paths.
MERGEABLEBranch can be merged.
MERGE_TIMEMerge request may not be merged until after the specified time.
NEED_REBASEMerge request needs to be rebased.
NOT_APPROVEDMerge request must be approved before merging.
NOT_OPENMerge request must be open before merging.
PREPARINGMerge request diff is being created.
REQUESTED_CHANGESIndicates a reviewer has requested changes.
SECURITY_POLICIES_VIOLATIONSAll policy rules must be satisfied.
UNCHECKEDMerge status has not been checked.

DiffPositionType

Type of file the position refers to.

ValueDescription
fileUnknown file type.
imageAn image.
textText file.

DoraMetricBucketingInterval

All possible ways that DORA metrics can be aggregated.

ValueDescription
ALLAll data points are combined into a single value.
DAILYData points are combined into chunks by day.
MONTHLYData points are combined into chunks by month.

DuoWorkflowStatus

The status of the workflow.

ValueDescription
CREATEDThe workflow is created.
FAILEDThe workflow is failed.
FINISHEDThe workflow is finished.
INPUT_REQUIREDThe workflow is input_required.
PAUSEDThe workflow is paused.
RUNNINGThe workflow is running.
STOPPEDThe workflow is stopped.

EntryType

Type of a tree entry.

ValueDescription
blobFile tree type.
commitCommit tree type.
treeDirectory tree type.

EpicSort

Roadmap sort values.

ValueDescription
CREATED_AT_ASCSort by created_at by ascending order.
CREATED_AT_DESCSort by created_at by descending order.
END_DATE_ASCSort by end date in ascending order.
END_DATE_DESCSort by end date in descending order.
START_DATE_ASCSort by start date in ascending order.
START_DATE_DESCSort by start date in descending order.
TITLE_ASCSort by title in ascending order.
TITLE_DESCSort by title in descending order.
UPDATED_AT_ASCSort by updated_at by ascending order.
UPDATED_AT_DESCSort by updated_at by descending order.
end_date_asc warning-solidDeprecated in GitLab 13.11. Use END_DATE_ASC.
end_date_desc warning-solidDeprecated in GitLab 13.11. Use END_DATE_DESC.
start_date_asc warning-solidDeprecated in GitLab 13.11. Use START_DATE_ASC.
start_date_desc warning-solidDeprecated in GitLab 13.11. Use START_DATE_DESC.

EpicState

State of an epic.

ValueDescription
allAll epics.
closedClosed epics.
openedOpen epics.

EpicStateEvent

State event of an epic.

ValueDescription
CLOSEClose the epic.
REOPENReopen the epic.

EpicWildcardId

Epic ID wildcard values.

ValueDescription
ANYAny epic is assigned.
NONENo epic is assigned.

EscalationRuleStatus

Escalation rule statuses.

ValueDescription
ACKNOWLEDGED.
RESOLVED.

EventAction

Event action.

ValueDescription
APPROVEDApproved action.
CLOSEDClosed action.
COMMENTEDCommented action.
CREATEDCreated action.
DESTROYEDDestroyed action.
EXPIREDExpired action.
JOINEDJoined action.
LEFTLeft action.
MERGEDMerged action.
PUSHEDPushed action.
REOPENEDReopened action.
UPDATEDUpdated action.

ExclusionScannerEnum

Enum for the security scanners used with exclusions.

ValueDescription
SECRET_PUSH_PROTECTIONSecret Push Protection.

ExclusionTypeEnum

Enum for types of exclusion for a security scanner.

ValueDescription
PATHFile or directory location.
RAW_VALUERaw value to ignore.
REGEX_PATTERNRegex pattern matching rules.
RULEScanner rule identifier.

ExtensionsMarketplaceOptInStatus

Values for status of the Web IDE Extension Marketplace opt-in for the user.

ValueDescription
DISABLEDWeb IDE Extension Marketplace opt-in status: DISABLED.
ENABLEDWeb IDE Extension Marketplace opt-in status: ENABLED.
UNSETWeb IDE Extension Marketplace opt-in status: UNSET.

FindingReportsComparerStatus

Report comparison status.

ValueDescription
ERRORAn error happened while generating the report.
PARSEDReport was generated.
PARSINGReport is being generated.

GeoRegistriesBulkAction

Action to trigger on multiple Geo registries.

ValueDescription
RESYNC_ALLResync multiple registries.
REVERIFY_ALLReverify multiple registries.

GeoRegistryAction

Action to trigger on an individual Geo registry.

ValueDescription
RESYNCResync a registry.
REVERIFYReverify a registry.

GeoRegistryClass

Geo registry class.

ValueDescription
CI_SECURE_FILE_REGISTRYGeo::CiSecureFileRegistry registry class.
CONTAINER_REPOSITORY_REGISTRYGeo::ContainerRepositoryRegistry registry class.
DEPENDENCY_PROXY_BLOB_REGISTRYGeo::DependencyProxyBlobRegistry registry class.
DEPENDENCY_PROXY_MANIFEST_REGISTRYGeo::DependencyProxyManifestRegistry registry class.
DESIGN_MANAGEMENT_REPOSITORY_REGISTRYGeo::DesignManagementRepositoryRegistry registry class.
GROUP_WIKI_REPOSITORY_REGISTRYGeo::GroupWikiRepositoryRegistry registry class.
JOB_ARTIFACT_REGISTRYGeo::JobArtifactRegistry registry class.
LFS_OBJECT_REGISTRYGeo::LfsObjectRegistry registry class.
MERGE_REQUEST_DIFF_REGISTRYGeo::MergeRequestDiffRegistry registry class.
PACKAGE_FILE_REGISTRYGeo::PackageFileRegistry registry class.
PAGES_DEPLOYMENT_REGISTRYGeo::PagesDeploymentRegistry registry class.
PIPELINE_ARTIFACT_REGISTRYGeo::PipelineArtifactRegistry registry class.
PROJECT_REPOSITORY_REGISTRYGeo::ProjectRepositoryRegistry registry class.
PROJECT_WIKI_REPOSITORY_REGISTRYGeo::ProjectWikiRepositoryRegistry registry class.
SNIPPET_REPOSITORY_REGISTRYGeo::SnippetRepositoryRegistry registry class.
TERRAFORM_STATE_VERSION_REGISTRYGeo::TerraformStateVersionRegistry registry class.
UPLOAD_REGISTRYGeo::UploadRegistry registry class.

GeoRegistrySort

Values for sorting Geo registries.

ValueDescription
ID_ASCID by ascending order.
ID_DESCID by descending order.
LAST_SYNCED_AT_ASCLatest sync date by ascending order.
LAST_SYNCED_AT_DESCLatest sync date by descending order.
VERIFIED_AT_ASCLatest verification date by ascending order.
VERIFIED_AT_DESCLatest verification date by descending order.

GitlabSubscriptionsAddOnType

Types of add-ons.

ValueDescription
CODE_SUGGESTIONSGitLab Duo Pro seat add-on.
DUO_ENTERPRISEGitLab Duo Enterprise seat add-on.

GitlabSubscriptionsUserRole

Role of User.

ValueDescription
DEVELOPERDeveloper.
GUESTGuest.
MAINTAINERMaintainer.
OWNEROwner.
PLANNERPlanner.
REPORTERReporter.

GitlabSubscriptionsUserSort

Values for sorting users.

ValueDescription
ID_ASCId by ascending order.
ID_DESCId by descending order.
LAST_ACTIVITY_ON_ASCLast activity by ascending order.
LAST_ACTIVITY_ON_DESCLast activity by descending order.
NAME_ASCName by ascending order.
NAME_DESCName by descending order.

GoogleCloudArtifactRegistryArtifactsSort

Values for sorting artifacts.

ValueDescription
BUILD_TIME_ASCOrdered by build_time in ascending order.
BUILD_TIME_DESCOrdered by build_time in descending order.
IMAGE_SIZE_BYTES_ASCOrdered by image_size_bytes in ascending order.
IMAGE_SIZE_BYTES_DESCOrdered by image_size_bytes in descending order.
MEDIA_TYPE_ASCOrdered by media_type in ascending order.
MEDIA_TYPE_DESCOrdered by media_type in descending order.
NAME_ASCOrdered by name in ascending order.
NAME_DESCOrdered by name in descending order.
UPDATE_TIME_ASCOrdered by update_time in ascending order.
UPDATE_TIME_DESCOrdered by update_time in descending order.
UPLOAD_TIME_ASCOrdered by upload_time in ascending order.
UPLOAD_TIME_DESCOrdered by upload_time in descending order.

GroupMemberRelation

Group member relation.

ValueDescription
DESCENDANTSMembers in the group’s subgroups.
DIRECTMembers in the group itself.
INHERITEDMembers in the group’s ancestor groups.
SHARED_FROM_GROUPSInvited group’s members.

GroupPermission

User permission on groups.

ValueDescription
CREATE_PROJECTSGroups where the user can create projects.
IMPORT_PROJECTSGroups where the user can import projects to.
TRANSFER_PROJECTSGroups where the user can transfer projects to.

GroupReleaseSort

Values for sorting releases belonging to a group.

ValueDescription
RELEASED_AT_ASCReleased at by ascending order.
RELEASED_AT_DESCReleased at by descending order.

HealthStatus

Health status of an issue or epic.

ValueDescription
atRiskAt risk.
needsAttentionNeeds attention.
onTrackOn track.

HealthStatusFilter

Health status of an issue or epic for filtering.

ValueDescription
ANYAny health status is assigned.
NONENo health status is assigned.
atRiskAt risk.
needsAttentionNeeds attention.
onTrackOn track.

ImportSource

Import source.

ValueDescription
BITBUCKETBitbucket.
BITBUCKET_SERVERBitbucket Server.
CUSTOM_TEMPLATECustom Template.
FOGBUGZFogbugz.
GITGit.
GITEAGitea.
GITHUBGithub.
GITLAB_GROUPGitlab Group.
GITLAB_MIGRATIONGitlab Migration.
GITLAB_PROJECTGitlab Project.
MANIFESTManifest.
NONENot imported.

ImportSourceUserStatus

ValueDescription
AWAITING_APPROVALAn import source user mapping that is awaiting approval.
COMPLETEDAn import source user mapping that is completed.
FAILEDAn import source user mapping that is failed.
KEEP_AS_PLACEHOLDERAn import source user mapping that is keep as placeholder.
PENDING_REASSIGNMENTAn import source user mapping that is pending reassignment.
REASSIGNMENT_IN_PROGRESSAn import source user mapping that is reassignment in progress.
REJECTEDAn import source user mapping that is rejected.

IntegrationType

Integration Names.

ValueDescription
BEYOND_IDENTITYBeyond Identity.

IssuableResourceLinkType

Issuable resource link type enum.

ValueDescription
generalGeneral link type.
pagerdutyPagerduty link type.
slackSlack link type.
zoomZoom link type.

IssuableSearchableField

Fields to perform the search in.

ValueDescription
DESCRIPTIONSearch in description field.
TITLESearch in title field.

IssuableSeverity

Incident severity.

ValueDescription
CRITICALCritical severity.
HIGHHigh severity.
LOWLow severity.
MEDIUMMedium severity.
UNKNOWNUnknown severity.

IssuableState

State of a GitLab issue or merge request.

ValueDescription
allAll available.
closedIn closed state.
lockedDiscussion has been locked.
openedIn open state.

IssuableSubscriptionEvent

Values for subscribing and unsubscribing from issuables.

ValueDescription
SUBSCRIBESubscribe to an issuable.
UNSUBSCRIBEUnsubscribe from an issuable.

IssueCreationIterationWildcardId

Iteration ID wildcard values for issue creation.

ValueDescription
CURRENTCurrent iteration.

IssueEscalationStatus

Issue escalation status values.

ValueDescription
ACKNOWLEDGEDSomeone is actively investigating the problem.
IGNOREDNo action will be taken.
RESOLVEDThe problem has been addressed.
TRIGGEREDInvestigation has not started.

IssueSort

Values for sorting issues.

ValueDescription
BLOCKING_ISSUES_ASCBlocking issues count by ascending order.
BLOCKING_ISSUES_DESCBlocking issues count by descending order.
CLOSED_AT_ASCClosed time by ascending order.
CLOSED_AT_DESCClosed time by descending order.
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
DUE_DATE_ASCDue date by ascending order.
DUE_DATE_DESCDue date by descending order.
ESCALATION_STATUS_ASCStatus from triggered to resolved.
ESCALATION_STATUS_DESCStatus from resolved to triggered.
HEALTH_STATUS_ASCIssues with healthy issues first.
HEALTH_STATUS_DESCIssues with unhealthy issues first.
LABEL_PRIORITY_ASCLabel priority by ascending order.
LABEL_PRIORITY_DESCLabel priority by descending order.
MILESTONE_DUE_ASCMilestone due date by ascending order.
MILESTONE_DUE_DESCMilestone due date by descending order.
POPULARITY_ASCNumber of upvotes (awarded “thumbs up” emoji) by ascending order.
POPULARITY_DESCNumber of upvotes (awarded “thumbs up” emoji) by descending order.
PRIORITY_ASCPriority by ascending order.
PRIORITY_DESCPriority by descending order.
PUBLISHED_ASCPublished issues shown last.
PUBLISHED_DESCPublished issues shown first.
RELATIVE_POSITION_ASCRelative position by ascending order.
SEVERITY_ASCSeverity from less critical to more critical.
SEVERITY_DESCSeverity from more critical to less critical.
SLA_DUE_AT_ASCIssues with earliest SLA due time shown first.
SLA_DUE_AT_DESCIssues with latest SLA due time shown first.
TITLE_ASCTitle by ascending order.
TITLE_DESCTitle by descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
WEIGHT_ASCWeight by ascending order.
WEIGHT_DESCWeight by descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

IssueState

State of a GitLab issue.

ValueDescription
allAll available.
closedIn closed state.
lockedDiscussion has been locked.
openedIn open state.

IssueStateEvent

Values for issue state events.

ValueDescription
CLOSECloses the issue.
REOPENReopens the issue.

IssueType

Issue type.

ValueDescription
EPIC warning-solidIntroduced in GitLab 16.7. Status: Experiment. Epic issue type. Available only when feature epics is available and the feature flag work_item_epics is enabled.
INCIDENTIncident issue type.
ISSUEIssue issue type.
KEY_RESULT warning-solidIntroduced in GitLab 15.7. Status: Experiment. Key Result issue type. Available only when feature flag okrs_mvc is enabled.
OBJECTIVE warning-solidIntroduced in GitLab 15.6. Status: Experiment. Objective issue type. Available only when feature flag okrs_mvc is enabled.
REQUIREMENTRequirement issue type.
TASKTask issue type.
TEST_CASETest Case issue type.
TICKETTicket issue type.

IterationSearchableField

Fields to perform the search in.

ValueDescription
CADENCE_TITLESearch in cadence_title field.
TITLESearch in title field.

IterationSort

Iteration sort values.

ValueDescription
CADENCE_AND_DUE_DATE_ASCSort by cadence id in ascending and due date in ascending order.
CADENCE_AND_DUE_DATE_DESCSort by cadence id in ascending and due date in descending order.

IterationState

State of a GitLab iteration.

ValueDescription
allAny iteration.
closedClosed iteration.
currentCurrent iteration.
openedOpen iteration.
upcomingUpcoming iteration.

IterationWildcardId

Iteration ID wildcard values.

ValueDescription
ANYAn iteration is assigned.
CURRENTCurrent iteration.
NONENo iteration is assigned.

JobArtifactFileType

ValueDescription
ACCESSIBILITYACCESSIBILITY job artifact file type.
ANNOTATIONSANNOTATIONS job artifact file type.
API_FUZZINGAPI FUZZING job artifact file type.
ARCHIVEARCHIVE job artifact file type.
BROWSER_PERFORMANCEBROWSER PERFORMANCE job artifact file type.
CLUSTER_APPLICATIONSCLUSTER APPLICATIONS job artifact file type.
CLUSTER_IMAGE_SCANNINGCLUSTER IMAGE SCANNING job artifact file type.
COBERTURACOBERTURA job artifact file type.
CODEQUALITYCODE QUALITY job artifact file type.
CONTAINER_SCANNINGCONTAINER SCANNING job artifact file type.
COVERAGE_FUZZINGCOVERAGE FUZZING job artifact file type.
CYCLONEDXCYCLONEDX job artifact file type.
DASTDAST job artifact file type.
DEPENDENCY_SCANNINGDEPENDENCY SCANNING job artifact file type.
DOTENVDOTENV job artifact file type.
JACOCOJACOCO job artifact file type.
JUNITJUNIT job artifact file type.
LICENSE_SCANNINGLICENSE SCANNING job artifact file type.
LOAD_PERFORMANCELOAD PERFORMANCE job artifact file type.
LSIFLSIF job artifact file type.
METADATAMETADATA job artifact file type.
METRICSMETRICS job artifact file type.
METRICS_REFEREEMETRICS REFEREE job artifact file type.
NETWORK_REFEREENETWORK REFEREE job artifact file type.
PERFORMANCEPERFORMANCE job artifact file type.
REPOSITORY_XRAYREPOSITORY XRAY job artifact file type.
REQUIREMENTSREQUIREMENTS job artifact file type.
REQUIREMENTS_V2REQUIREMENTS V2 job artifact file type.
SASTSAST job artifact file type.
SECRET_DETECTIONSECRET DETECTION job artifact file type.
TERRAFORMTERRAFORM job artifact file type.
TRACETRACE job artifact file type.

LabelSearchFieldList

List of fields where the provided searchTerm should be looked up.

ValueDescription
DESCRIPTIONSearch in the label description.
TITLESearch in the label title.

ListLimitMetric

List limit metric setting.

ValueDescription
all_metricsLimit list by number and total weight of issues.
issue_countLimit list by number of issues.
issue_weightsLimit list by total weight of issues.

MeasurementIdentifier

Possible identifier types for a measurement.

ValueDescription
GROUPSGroup count.
ISSUESIssue count.
MERGE_REQUESTSMerge request count.
PIPELINESPipeline count.
PIPELINES_CANCELEDPipeline count with canceled status.
PIPELINES_FAILEDPipeline count with failed status.
PIPELINES_SKIPPEDPipeline count with skipped status.
PIPELINES_SUCCEEDEDPipeline count with success status.
PROJECTSProject count.
USERSUser count.

MemberAccessLevel

Access level of a group or project member.

ValueDescription
DEVELOPERThe Developer role gives users access to contribute code while restricting sensitive administrative actions.
GUESTThe Guest role is for users who need visibility into a project or group but should not have the ability to make changes, such as external stakeholders.
MAINTAINERThe Maintainer role is primarily used for managing code reviews, approvals, and administrative settings for projects. This role can also manage project memberships.
MINIMAL_ACCESSThe Minimal Access role is for users who need the least amount of access into groups and projects. You can assign this role as a default, before giving a user another role with more permissions.
OWNERThe Owner role is typically assigned to the individual or team responsible for managing and maintaining the group or creating the project. This role has the highest level of administrative control, and can manage all aspects of the group or project, including managing other Owners.
PLANNERThe Planner role is suitable for team members who need to manage projects and track work items but do not need to contribute code.
REPORTERThe Reporter role is suitable for team members who need to stay informed about a project or group but do not actively contribute code.

MemberAccessLevelName

Name of access levels of a group or project member.

ValueDescription
DEVELOPERDeveloper access.
GUESTGuest access.
MAINTAINERMaintainer access.
OWNEROwner access.
PLANNERPlanner access.
REPORTERReporter access.

MemberApprovalStatusType

Types of member approval status.

ValueDescription
APPROVEDApproved promotion request.
DENIEDDenied promotion request.
PENDINGPending promotion request.

MemberRoleAdminPermission

Member role admin permission.

ValueDescription
READ_ADMIN_CICD warning-solidIntroduced in GitLab 17.9. Status: Experiment. Read CI/CD details including runners and jobs.
READ_ADMIN_DASHBOARD warning-solidIntroduced in GitLab 17.6. Status: Experiment. Read-only access to admin dashboard.
READ_ADMIN_MONITORING warning-solidIntroduced in GitLab 17.9. Status: Experiment. Allows read access to system monitoring including system info, background migrations, health checks, audit logs, and gitaly in the Admin Area.
READ_ADMIN_SUBSCRIPTION warning-solidIntroduced in GitLab 17.9. Status: Experiment. Read subscription details in the Admin area.
READ_ADMIN_USERS warning-solidIntroduced in GitLab 17.9. Status: Experiment. Allows read access to the user list and user details in the Admin area.

MemberRolePermission

Member role permission.

ValueDescription
ADMIN_CICD_VARIABLESCreate, read, update, and delete CI/CD variables.
ADMIN_COMPLIANCE_FRAMEWORKCreate, read, update, and delete compliance frameworks. Users with this permission can also assign a compliance framework label to a project, and set the default framework of a group.
ADMIN_GROUP_MEMBERAdd or remove users in a group, and assign roles to users. When assigning a role, users with this custom permission must select a role that has the same or fewer permissions as the default role used as the base for their custom role.
ADMIN_INTEGRATIONSCreate, read, update, and delete integrations with external applications.
ADMIN_MERGE_REQUESTAllows approval of merge requests.
ADMIN_PROTECTED_BRANCHCreate, read, update, and delete protected branches for a project.
ADMIN_PROTECTED_ENVIRONMENTSCreate, read, update, and delete environments.
ADMIN_PUSH_RULESConfigure push rules for repositories at the group or project level.
ADMIN_RUNNERSCreate, view, edit, and delete group or project Runners. Includes configuring Runner settings.
ADMIN_SECURITY_TESTINGEdit and manage security testing configurations and settings.
ADMIN_TERRAFORM_STATEExecute terraform commands, lock/unlock terraform state files, and remove file versions.
ADMIN_VULNERABILITYEdit the vulnerability object, including the status and linking an issue. Includes the read_vulnerability permission actions.
ADMIN_WEB_HOOKManage webhooks.
ARCHIVE_PROJECTAllows archiving of projects.
MANAGE_DEPLOY_TOKENSManage deploy tokens at the group or project level.
MANAGE_GROUP_ACCESS_TOKENSCreate, read, update, and delete group access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role.
MANAGE_MERGE_REQUEST_SETTINGSConfigure merge request settings at the group or project level. Group actions include managing merge checks and approval settings. Project actions include managing MR configurations, approval rules and settings, and branch targets. In order to enable Suggested reviewers, the “Manage project access tokens” custom permission needs to be enabled.
MANAGE_PROJECT_ACCESS_TOKENSCreate, read, update, and delete project access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role.
MANAGE_PROTECTED_TAGSCreate, read, update, and delete protected tags.
MANAGE_SECURITY_POLICY_LINKAllows linking security policy projects.
READ_ADMIN_CICDRead CI/CD details including runners and jobs.
READ_ADMIN_DASHBOARDRead-only access to admin dashboard.
READ_ADMIN_MONITORINGAllows read access to system monitoring including system info, background migrations, health checks, audit logs, and gitaly in the Admin Area.
READ_ADMIN_SUBSCRIPTIONRead subscription details in the Admin area.
READ_ADMIN_USERSAllows read access to the user list and user details in the Admin area.
READ_CODEAllows read-only access to the source code in the user interface. Does not allow users to edit or download repository archives, clone or pull repositories, view source code in an IDE, or view merge requests for private projects. You can download individual files because read-only access inherently grants the ability to make a local copy of the file.
READ_COMPLIANCE_DASHBOARDRead compliance capabilities including adherence, violations, and frameworks for groups and projects.
READ_CRM_CONTACTRead CRM contact.
READ_DEPENDENCYAllows read-only access to the dependencies and licenses.
READ_RUNNERSAllows read-only access to group or project runners, including the runner fleet dashboard.
READ_VULNERABILITYRead vulnerability reports and security dashboards.
REMOVE_GROUPAbility to delete or restore a group. This ability does not allow deleting top-level groups. Review the Retention period settings to prevent accidental deletion.
REMOVE_PROJECTAllows deletion of projects.

MemberRoleStandardPermission

Member role standard permission.

ValueDescription
ADMIN_CICD_VARIABLESCreate, read, update, and delete CI/CD variables.
ADMIN_COMPLIANCE_FRAMEWORKCreate, read, update, and delete compliance frameworks. Users with this permission can also assign a compliance framework label to a project, and set the default framework of a group.
ADMIN_GROUP_MEMBERAdd or remove users in a group, and assign roles to users. When assigning a role, users with this custom permission must select a role that has the same or fewer permissions as the default role used as the base for their custom role.
ADMIN_INTEGRATIONSCreate, read, update, and delete integrations with external applications.
ADMIN_MERGE_REQUESTAllows approval of merge requests.
ADMIN_PROTECTED_BRANCHCreate, read, update, and delete protected branches for a project.
ADMIN_PROTECTED_ENVIRONMENTS warning-solidIntroduced in GitLab 17.9. Status: Experiment. Create, read, update, and delete environments.
ADMIN_PUSH_RULESConfigure push rules for repositories at the group or project level.
ADMIN_RUNNERSCreate, view, edit, and delete group or project Runners. Includes configuring Runner settings.
ADMIN_SECURITY_TESTING warning-solidIntroduced in GitLab 17.9. Status: Experiment. Edit and manage security testing configurations and settings.
ADMIN_TERRAFORM_STATEExecute terraform commands, lock/unlock terraform state files, and remove file versions.
ADMIN_VULNERABILITYEdit the vulnerability object, including the status and linking an issue. Includes the read_vulnerability permission actions.
ADMIN_WEB_HOOKManage webhooks.
ARCHIVE_PROJECTAllows archiving of projects.
MANAGE_DEPLOY_TOKENSManage deploy tokens at the group or project level.
MANAGE_GROUP_ACCESS_TOKENSCreate, read, update, and delete group access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role.
MANAGE_MERGE_REQUEST_SETTINGSConfigure merge request settings at the group or project level. Group actions include managing merge checks and approval settings. Project actions include managing MR configurations, approval rules and settings, and branch targets. In order to enable Suggested reviewers, the “Manage project access tokens” custom permission needs to be enabled.
MANAGE_PROJECT_ACCESS_TOKENSCreate, read, update, and delete project access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role.
MANAGE_PROTECTED_TAGS warning-solidIntroduced in GitLab 17.9. Status: Experiment. Create, read, update, and delete protected tags.
MANAGE_SECURITY_POLICY_LINKAllows linking security policy projects.
READ_CODEAllows read-only access to the source code in the user interface. Does not allow users to edit or download repository archives, clone or pull repositories, view source code in an IDE, or view merge requests for private projects. You can download individual files because read-only access inherently grants the ability to make a local copy of the file.
READ_COMPLIANCE_DASHBOARDRead compliance capabilities including adherence, violations, and frameworks for groups and projects.
READ_CRM_CONTACTRead CRM contact.
READ_DEPENDENCYAllows read-only access to the dependencies and licenses.
READ_RUNNERSAllows read-only access to group or project runners, including the runner fleet dashboard.
READ_VULNERABILITYRead vulnerability reports and security dashboards.
REMOVE_GROUPAbility to delete or restore a group. This ability does not allow deleting top-level groups. Review the Retention period settings to prevent accidental deletion.
REMOVE_PROJECTAllows deletion of projects.

MemberRolesAccessLevel

Access level of a group or project member.

ValueDescription
DEVELOPERThe Developer role gives users access to contribute code while restricting sensitive administrative actions.
GUESTThe Guest role is for users who need visibility into a project or group but should not have the ability to make changes, such as external stakeholders.
MAINTAINERThe Maintainer role is primarily used for managing code reviews, approvals, and administrative settings for projects. This role can also manage project memberships.
MINIMAL_ACCESSThe Minimal Access role is for users who need the least amount of access into groups and projects. You can assign this role as a default, before giving a user another role with more permissions.
PLANNERThe Planner role is suitable for team members who need to manage projects and track work items but do not need to contribute code.
REPORTERThe Reporter role is suitable for team members who need to stay informed about a project or group but do not actively contribute code.

MemberRolesOrderBy

Values for ordering member roles by a specific field.

ValueDescription
CREATED_ATOrdered by creation time.
IDOrdered by id.
NAMEOrdered by name.

MemberSort

Values for sorting members.

ValueDescription
ACCESS_LEVEL_ASCAccess level ascending order.
ACCESS_LEVEL_DESCAccess level descending order.
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
USER_FULL_NAME_ASCUser’s full name ascending order.
USER_FULL_NAME_DESCUser’s full name descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

MergeRequestNewState

New state to apply to a merge request.

ValueDescription
CLOSEDClose the merge request if it is open.
OPENOpen the merge request if it is closed.

MergeRequestReviewState

State of a review of a GitLab merge request.

ValueDescription
APPROVEDMerge request reviewer has approved the changes.
REQUESTED_CHANGESMerge request reviewer has requested changes.
REVIEWEDMerge request reviewer has reviewed.
REVIEW_STARTEDMerge request reviewer has started a review.
UNAPPROVEDMerge request reviewer removed their approval of the changes.
UNREVIEWEDAwaiting review from merge request reviewer.

MergeRequestSort

Values for sorting merge requests.

ValueDescription
CLOSED_AT_ASCClosed time by ascending order.
CLOSED_AT_DESCClosed time by descending order.
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
LABEL_PRIORITY_ASCLabel priority by ascending order.
LABEL_PRIORITY_DESCLabel priority by descending order.
MERGED_AT_ASCMerge time by ascending order.
MERGED_AT_DESCMerge time by descending order.
MILESTONE_DUE_ASCMilestone due date by ascending order.
MILESTONE_DUE_DESCMilestone due date by descending order.
POPULARITY_ASCNumber of upvotes (awarded “thumbs up” emoji) by ascending order.
POPULARITY_DESCNumber of upvotes (awarded “thumbs up” emoji) by descending order.
PRIORITY_ASCPriority by ascending order.
PRIORITY_DESCPriority by descending order.
TITLE_ASCTitle by ascending order.
TITLE_DESCTitle by descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

MergeRequestState

State of a GitLab merge request.

ValueDescription
allAll available.
closedIn closed state.
lockedDiscussion has been locked.
mergedMerge request has been merged.
openedOpened merge request.

MergeStatus

Representation of whether a GitLab merge request can be merged.

ValueDescription
CANNOT_BE_MERGEDThere are conflicts between the source and target branches.
CANNOT_BE_MERGED_RECHECKCurrently unchecked. The previous state was CANNOT_BE_MERGED.
CAN_BE_MERGEDThere are no conflicts between the source and target branches.
CHECKINGCurrently checking for mergeability.
UNCHECKEDMerge status has not been checked.

MergeStrategyEnum

ValueDescription
ADD_TO_MERGE_TRAIN_WHEN_CHECKS_PASSUse the add_to_merge_train_when_checks_pass merge strategy.
ADD_TO_MERGE_TRAIN_WHEN_PIPELINE_SUCCEEDSUse the add_to_merge_train_when_pipeline_succeeds merge strategy.
MERGE_TRAINUse the merge_train merge strategy.
MERGE_WHEN_CHECKS_PASSUse the merge_when_checks_pass merge strategy.
MERGE_WHEN_PIPELINE_SUCCEEDSUse the merge_when_pipeline_succeeds merge strategy.

MergeTrainStatus

ValueDescription
ACTIVEActive merge train.
COMPLETEDCompleted merge train.

MergeabilityCheckIdentifier

Representation of mergeability check identifier.

ValueDescription
CI_MUST_PASSChecks whether CI has passed.
COMMITS_STATUSChecks source branch exists and contains commits.
CONFLICTChecks whether the merge request has a conflict.
DISCUSSIONS_NOT_RESOLVEDChecks whether the merge request has open discussions.
DRAFT_STATUSChecks whether the merge request is draft.
JIRA_ASSOCIATION_MISSINGChecks whether the title or description references a Jira issue.
LOCKED_LFS_FILESChecks whether the merge request contains locked LFS files that are locked by users other than the merge request author.
LOCKED_PATHSChecks whether the merge request contains locked paths.
MERGE_REQUEST_BLOCKEDChecks whether the merge request is blocked.
MERGE_TIMEChecks whether the merge is blocked due to a scheduled merge time.
NEED_REBASEChecks whether the merge request needs to be rebased.
NOT_APPROVEDChecks whether the merge request is approved.
NOT_OPENChecks whether the merge request is open.
REQUESTED_CHANGESChecks whether the merge request has changes requested.
SECURITY_POLICY_VIOLATIONSChecks whether the security policies are satisfied.
STATUS_CHECKS_MUST_PASSChecks whether the external status checks pass.

MergeabilityCheckStatus

Representation of whether a mergeability check passed, checking, failed or is inactive.

ValueDescription
CHECKINGMergeability check is being checked.
FAILEDMergeability check has failed. The merge request cannot be merged.
INACTIVEMergeability check is disabled via settings.
SUCCESSMergeability check has passed.
WARNINGMergeability check has passed with a warning.

MilestoneSort

Values for sorting milestones.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
DUE_DATE_ASCMilestone due date by ascending order.
DUE_DATE_DESCMilestone due date by descending order.
EXPIRED_LAST_DUE_DATE_ASCGroup milestones in this order: non-expired milestones with due dates, non-expired milestones without due dates and expired milestones then sort by due date in ascending order.
EXPIRED_LAST_DUE_DATE_DESCGroup milestones in this order: non-expired milestones with due dates, non-expired milestones without due dates and expired milestones then sort by due date in descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

MilestoneStateEnum

Current state of milestone.

ValueDescription
activeMilestone is currently active.
closedMilestone is closed.

MilestoneWildcardId

Milestone ID wildcard values.

ValueDescription
ANYMilestone is assigned.
NONENo milestone is assigned.
STARTEDMilestone assigned is open and started (start date <= today).
UPCOMINGMilestone assigned is due in the future (due date > today).

MlModelVersionsOrderBy

Field names for ordering machine learning model versions.

ValueDescription
CREATED_ATOrdered by creation time.
IDOrdered by id.
VERSIONOrdered by name.

MlModelsOrderBy

Values for ordering machine learning models by a specific field.

ValueDescription
CREATED_ATOrdered by creation time.
IDOrdered by id.
NAMEOrdered by name.
UPDATED_ATOrdered by update time.

MoveType

The position to which the adjacent object should be moved.

ValueDescription
afterAdjacent object is moved after the object that is being moved.
beforeAdjacent object is moved before the object that is being moved.

MutationOperationMode

Different toggles for changing mutator behavior.

ValueDescription
APPENDPerforms an append operation.
REMOVEPerforms a removal operation.
REPLACEPerforms a replace operation.

NamespaceClusterAgentFilter

Possible filter types for remote development cluster agents in a namespace.

ValueDescription
AVAILABLECluster agents in the namespace that can be used for hosting workspaces.
DIRECTLY_MAPPEDCluster agents that are directly mapped to the given namespace.
UNMAPPEDCluster agents within a namespace that are not directly mapped to it.

NamespaceProjectSort

Values for sorting projects.

ValueDescription
ACTIVITY_DESCSort by latest activity, descending order.
EXCESS_REPO_STORAGE_SIZE_DESCSort by excess repository storage size, descending order.
SIMILARITYMost similar to the search query.
STORAGE warning-solidDeprecated in GitLab 16.9. Please use EXCESS_REPO_STORAGE_SIZE_DESC.
STORAGE_SIZE_ASCSort by total storage size, ascending order.
STORAGE_SIZE_DESCSort by total storage size, descending order.

NegatedIterationWildcardId

Negated Iteration ID wildcard values.

ValueDescription
CURRENTCurrent iteration.

NegatedMilestoneWildcardId

Negated Milestone ID wildcard values.

ValueDescription
STARTEDMilestone assigned is open and yet to be started (start date > today).
UPCOMINGMilestone assigned is open but due in the past (due date <= today).

NotesFilterType

Work item notes collection type.

ValueDescription
ALL_NOTESShow all activity.
ONLY_ACTIVITYShow history only.
ONLY_COMMENTSShow comments only.

OncallRotationUnitEnum

Rotation length unit of an on-call rotation.

ValueDescription
DAYSDays.
HOURSHours.
WEEKSWeeks.

OpenTelemetryMetricType

Enum defining the type of OpenTelemetry metric.

ValueDescription
EXPONENTIAL_HISTOGRAM_TYPEExponential Histogram Type type.
GAUGE_TYPEGauge Type type.
HISTOGRAM_TYPEHistogram Type type.
SUM_TYPESum Type type.

OrganizationGroupProjectDisplay

Default list view for organization groups and projects.

ValueDescription
GROUPS warning-solidIntroduced in GitLab 17.2. Status: Experiment. Display organization groups list.
PROJECTS warning-solidIntroduced in GitLab 17.2. Status: Experiment. Display organization projects list.

OrganizationGroupProjectSort

Values for sorting organization groups and projects.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
NAME_ASC warning-solidIntroduced in GitLab 17.2. Status: Experiment. Name ascending order.
NAME_DESC warning-solidIntroduced in GitLab 17.2. Status: Experiment. Name descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

OrganizationSort

Values for sorting organizations.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
DEFAULT_RATE_ASCDefault Rate in ascending order.
DEFAULT_RATE_DESCDefault Rate in descending order.
DESCRIPTION_ASCDescription in ascending order.
DESCRIPTION_DESCDescription in descending order.
NAME_ASCName in ascending order.
NAME_DESCName in descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

OrganizationUserAccessLevel

Access level of an organization user.

ValueDescription
DEFAULT warning-solidIntroduced in GitLab 16.11. Status: Experiment. Guest access.
OWNER warning-solidIntroduced in GitLab 16.11. Status: Experiment. Owner access.

PackageDependencyType

ValueDescription
BUNDLE_DEPENDENCIESbundleDependencies dependency type.
DEPENDENCIESdependencies dependency type.
DEV_DEPENDENCIESdevDependencies dependency type.
PEER_DEPENDENCIESpeerDependencies dependency type.

PackageGroupSort

Values for sorting group packages.

ValueDescription
CREATED_ASCOrdered by created_at in ascending order.
CREATED_DESCOrdered by created_at in descending order.
NAME_ASCOrdered by name in ascending order.
NAME_DESCOrdered by name in descending order.
PROJECT_PATH_ASCOrdered by project path in ascending order.
PROJECT_PATH_DESCOrdered by project path in descending order.
TYPE_ASCOrdered by type in ascending order.
TYPE_DESCOrdered by type in descending order.
VERSION_ASCOrdered by version in ascending order.
VERSION_DESCOrdered by version in descending order.

PackageManager

Values for package manager.

ValueDescription
APKPackage manager: apk.
BUNDLERPackage manager: bundler.
COMPOSERPackage manager: composer.
CONANPackage manager: conan.
CONDAPackage manager: conda.
GOPackage manager: go.
GRADLEPackage manager: gradle.
MAVENPackage manager: maven.
NPMPackage manager: npm.
NUGETPackage manager: nuget.
PIPPackage manager: pip.
PIPENVPackage manager: pipenv.
PNPMPackage manager: pnpm.
POETRYPackage manager: poetry.
SBTPackage manager: sbt.
SETUPTOOLSPackage manager: setuptools.
YARNPackage manager: yarn.

PackageSort

Values for sorting package.

ValueDescription
CREATED_ASCOrdered by created_at in ascending order.
CREATED_DESCOrdered by created_at in descending order.
NAME_ASCOrdered by name in ascending order.
NAME_DESCOrdered by name in descending order.
TYPE_ASCOrdered by type in ascending order.
TYPE_DESCOrdered by type in descending order.
VERSION_ASCOrdered by version in ascending order.
VERSION_DESCOrdered by version in descending order.

PackageStatus

ValueDescription
DEFAULTPackages with a default status.
DEPRECATEDPackages with a deprecated status.
ERRORPackages with a error status.
HIDDENPackages with a hidden status.
PENDING_DESTRUCTIONPackages with a pending_destruction status.
PROCESSINGPackages with a processing status.

PackageTypeEnum

ValueDescription
COMPOSERPackages from the Composer package manager.
CONANPackages from the Conan package manager.
DEBIANPackages from the Debian package manager.
GENERICPackages from the Generic package manager.
GOLANGPackages from the Golang package manager.
HELMPackages from the Helm package manager.
MAVENPackages from the Maven package manager.
ML_MODELPackages from the Ml_model package manager.
NPMPackages from the npm package manager.
NUGETPackages from the Nuget package manager.
PYPIPackages from the PyPI package manager.
RPMPackages from the Rpm package manager.
RUBYGEMSPackages from the Rubygems package manager.
TERRAFORM_MODULEPackages from the Terraform Module package manager.

PackagesCleanupKeepDuplicatedPackageFilesEnum

ValueDescription
ALL_PACKAGE_FILESValue to keep all package files.
FIFTY_PACKAGE_FILESValue to keep 50 package files.
FORTY_PACKAGE_FILESValue to keep 40 package files.
ONE_PACKAGE_FILEValue to keep 1 package files.
TEN_PACKAGE_FILESValue to keep 10 package files.
THIRTY_PACKAGE_FILESValue to keep 30 package files.
TWENTY_PACKAGE_FILESValue to keep 20 package files.

PackagesProtectionRuleAccessLevel

Access level of a package protection rule resource.

ValueDescription
ADMINAdmin access.
MAINTAINERMaintainer access.
OWNEROwner access.

PackagesProtectionRulePackageType

Package type of a package protection rule resource.

ValueDescription
CONAN warning-solidIntroduced in GitLab 17.6. Status: Experiment. Packages of the Conan format. Available only when feature flag packages_protected_packages_conan is enabled.
MAVEN warning-solidIntroduced in GitLab 17.9. Status: Experiment. Packages of the Maven format. Available only when feature flag packages_protected_packages_maven is enabled.
NPMPackages of the npm format.
PYPIPackages of the PyPI format.

PipelineAnalyticsJobStatus

ValueDescription
ANYJobs with any status.
FAILEDJob that failed.
OTHERJob that was canceled or skipped.
SUCCESSJob that succeeded.

PipelineConfigSourceEnum

ValueDescription
AUTO_DEVOPS_SOURCEAuto DevOps source.
BRIDGE_SOURCEBridge source.
COMPLIANCE_SOURCECompliance source.
EXTERNAL_PROJECT_SOURCEExternal project source.
PARAMETER_SOURCEParameter source.
PIPELINE_EXECUTION_POLICY_FORCEDPipeline execution policy forced.
REMOTE_SOURCERemote source.
REPOSITORY_SOURCERepository source.
SECURITY_POLICIES_DEFAULT_SOURCESecurity policies default source.
UNKNOWN_SOURCEUnknown source.
WEBIDE_SOURCEWebide source.

PipelineMergeRequestEventType

Event type of the pipeline associated with a merge request.

ValueDescription
DETACHEDPipeline run on the changes in the merge request source branch.
MERGED_RESULTPipeline run on the changes from the source branch combined with the target branch.
MERGE_TRAINPipeline ran as part of a merge train.

PipelineScheduleSort

Values for sorting pipeline schedules.

ValueDescription
CREATED_AT_ASCSort pipeline schedules by created date in ascending order.
CREATED_AT_DESCSort pipeline schedules by created date in descending order.
DESCRIPTION_ASCSort pipeline schedules by description in ascending order.
DESCRIPTION_DESCSort pipeline schedules by description in descending order.
ID_ASCSort pipeline schedules by ID in ascending order.
ID_DESCSort pipeline schedules by ID in descending order.
NEXT_RUN_AT_ASCSort pipeline schedules by next run in ascending order.
NEXT_RUN_AT_DESCSort pipeline schedules by next run in descending order.
REF_ASCSort pipeline schedules by target in ascending order.
REF_DESCSort pipeline schedules by target in descending order.
UPDATED_AT_ASCSort pipeline schedules by updated date in ascending order.
UPDATED_AT_DESCSort pipeline schedules by updated date in descending order.

PipelineScheduleStatus

ValueDescription
ACTIVEActive pipeline schedules.
INACTIVEInactive pipeline schedules.

PipelineScopeEnum

ValueDescription
BRANCHESBranches.
FINISHEDPipeline has completed.
PENDINGPipeline has not started running yet.
RUNNINGPipeline is running.
TAGSTags.

PipelineSecurityReportFindingSort

Pipeline security report finding sort values.

ValueDescription
severity_ascSeverity in ascending order.
severity_descSeverity in descending order.

PipelineStatusEnum

ValueDescription
CANCELEDPipeline was canceled before completion.
CANCELINGPipeline is in the process of canceling.
CREATEDPipeline has been created.
FAILEDAt least one stage of the pipeline failed.
MANUALPipeline needs to be manually started.
PENDINGPipeline has not started running yet.
PREPARINGPipeline is preparing to run.
RUNNINGPipeline is running.
SCHEDULEDPipeline is scheduled to run.
SKIPPEDPipeline was skipped.
SUCCESSPipeline completed successfully.
WAITING_FOR_CALLBACKPipeline is waiting for an external action.
WAITING_FOR_RESOURCEA resource (for example, a runner) that the pipeline requires to run is unavailable.

PipelineVariablesDefaultRoleType

Pipeline variables minimum override roles.

ValueDescription
DEVELOPERDeveloper.
MAINTAINERMaintainer.
NO_ONE_ALLOWEDNo one allowed.
OWNEROwner.

PolicyProjectCreatedStatus

Types of security policy project created status.

ValueDescription
ERRORCreating the security policy project faild.
SUCCESSCreating the security policy project was successful.

PolicyViolationErrorType

ValueDescription
ARTIFACTS_MISSINGRepresents error which occurs when pipeline is misconfigured and does not include necessary artifacts to evaluate a policy.
SCAN_REMOVEDRepresents mismatch between the scans of the source and target pipelines.
UNKNOWNRepresents unknown error.

PolicyViolationStatus

ValueDescription
FAILEDRepresents a failed policy violation.
RUNNINGRepresents a running policy violation.
WARNINGRepresents a policy violation warning.

ProductAnalyticsState

Current state of the product analytics stack.

ValueDescription
COMPLETEStack has been initialized and has data.
CREATE_INSTANCEStack has not been created yet.
LOADING_INSTANCEStack is currently initializing.
WAITING_FOR_EVENTSStack is waiting for events from users.

ProjectArchived

Values for the archived argument.

ValueDescription
EXCLUDEExclude archived projects.
INCLUDEInclude archvied projects.
ONLYOnly archived projects.

ProjectFeatureAccessLevel

Access level of a project feature.

ValueDescription
DISABLEDNot enabled for anyone.
ENABLEDEnabled for everyone able to access the project.
PRIVATEEnabled only for team members.

ProjectMemberRelation

Project member relation.

ValueDescription
DESCENDANTSDescendants members.
DIRECTDirect members.
INHERITEDInherited members.
INVITED_GROUPSInvited Groups members.
SHARED_INTO_ANCESTORSShared Into Ancestors members.

ProjectSecretsManagerStatus

Values for the project secrets manager status.

ValueDescription
ACTIVESecrets manager has been provisioned.
PROVISIONINGSecrets manager is being provisioned.

ProjectSort

Values for sorting projects.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
ID_ASCID by ascending order.
ID_DESCID by descending order.
LATEST_ACTIVITY_ASCLatest activity by ascending order.
LATEST_ACTIVITY_DESCLatest activity by descending order.
NAME_ASCName by ascending order.
NAME_DESCName by descending order.
PATH_ASCPath by ascending order.
PATH_DESCPath by descending order.
STARS_ASCStars by ascending order.
STARS_DESCStars by descending order.
STORAGE_SIZE_ASCStorage size by ascending order.
STORAGE_SIZE_DESCStorage size by descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

ReachabilityType

Dependency reachability status.

ValueDescription
IN_USEDependency is imported and in use.
UNKNOWNDependency reachability status is unknown.

RefType

Type of ref.

ValueDescription
HEADSRef type for branches.
TAGSRef type for tags.

RegistryState

State of a Geo registry.

ValueDescription
FAILEDRegistry that failed to sync.
PENDINGRegistry waiting to be synced.
STARTEDRegistry currently syncing.
SYNCEDRegistry that is synced.

RelativePositionType

The position to which the object should be moved.

ValueDescription
AFTERObject is moved after an adjacent object.
BEFOREObject is moved before an adjacent object.

ReleaseAssetLinkType

Type of the link: other, runbook, image, package.

ValueDescription
IMAGEImage link type.
OTHEROther link type.
PACKAGEPackage link type.
RUNBOOKRunbook link type.

ReleaseSort

Values for sorting releases.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
RELEASED_AT_ASCReleased at by ascending order.
RELEASED_AT_DESCReleased at by descending order.

ReleaseTagWildcardId

Release tag ID wildcard values.

ValueDescription
ANYRelease tag is assigned.
NONENo release tag is assigned.

ReplicationStateEnum

ValueDescription
FAILEDReplication process finished but failed.
PENDINGReplication process has not started.
STARTEDReplication process is in progress.
SYNCEDReplication process finished successfully.

RequirementState

State of a requirement.

ValueDescription
ARCHIVEDArchived requirement.
OPENEDOpen requirement.

RequirementStatusFilter

Status of a requirement based on last test report.

ValueDescription
FAILEDFailed test report.
MISSINGRequirements without any test report.
PASSEDPassed test report.

ReviewerWildcardId

Reviewer ID wildcard values.

ValueDescription
ANYAny reviewer is assigned.
NONENo reviewer is assigned.

SastUiComponentSize

Size of UI component in SAST configuration page.

ValueDescription
LARGESize of UI component in SAST configuration page is large.
MEDIUMSize of UI component in SAST configuration page is medium.
SMALLSize of UI component in SAST configuration page is small.

SbomSourceType

Values for sbom source types.

ValueDescription
CONTAINER_SCANNINGSource Type: container_scanning.
CONTAINER_SCANNING_FOR_REGISTRYSource Type: container_scanning_for_registry.
DEPENDENCY_SCANNINGSource Type: dependency_scanning.
NIL_SOURCEEnum source nil.

ScanStatus

The status of the security scan.

ValueDescription
CREATEDThe scan has been created.
JOB_FAILEDThe related CI build failed.
PREPARATION_FAILEDReport couldn’t be prepared.
PREPARINGPreparing the report for the scan.
PURGEDReport for the scan has been removed from the database.
REPORT_ERRORThe report artifact provided by the CI build couldn’t be parsed.
SUCCEEDEDThe report has been successfully prepared.

SearchLevel

Level of search.

ValueDescription
GLOBALGlobal search including all groups and projects.
GROUPGroup search.
PROJECTProject search.

SearchType

Type of search.

ValueDescription
ADVANCEDAdvanced search.
BASICBasic search.
ZOEKTExact code search.

SecurityPolicyRelationType

ValueDescription
DESCENDANTPolicies defined for the group’s descendant projects/groups only. Only valid for group-level policies.
DIRECTPolicies defined for the project/group only.
INHERITEDPolicies defined for the project/group and ancestor groups.
INHERITED_ONLYPolicies defined for the project/group’s ancestor groups only.

SecurityReportTypeEnum

ValueDescription
API_FUZZINGAPI FUZZING scan report.
CLUSTER_IMAGE_SCANNINGCLUSTER IMAGE SCANNING scan report.
CONTAINER_SCANNINGCONTAINER SCANNING scan report.
COVERAGE_FUZZINGCOVERAGE FUZZING scan report.
DASTDAST scan report.
DEPENDENCY_SCANNINGDEPENDENCY SCANNING scan report.
SASTSAST scan report.
SAST_ADVANCEDSAST ADVANCED scan report.
SAST_IACSAST IAC scan report.
SECRET_DETECTIONSECRET DETECTION scan report.

SecurityScannerType

The type of the security scanner.

ValueDescription
API_FUZZINGAPI Fuzzing scanner.
CLUSTER_IMAGE_SCANNINGCluster Image Scanning scanner.
CONTAINER_SCANNINGContainer Scanning scanner.
COVERAGE_FUZZINGCoverage Fuzzing scanner.
DASTDAST scanner.
DEPENDENCY_SCANNINGDependency Scanning scanner.
SASTSAST scanner.
SAST_ADVANCEDSast Advanced scanner.
SAST_IACSast Iac scanner.
SECRET_DETECTIONSecret Detection scanner.

SentryErrorStatus

State of a Sentry error.

ValueDescription
IGNOREDError has been ignored.
RESOLVEDError has been resolved.
RESOLVED_IN_NEXT_RELEASEError has been ignored until next release.
UNRESOLVEDError is unresolved.

ServiceType

ValueDescription
APPLE_APP_STORE_SERVICEAppleAppStoreService type.
ASANA_SERVICEAsanaService type.
ASSEMBLA_SERVICEAssemblaService type.
BAMBOO_SERVICEBambooService type.
BUGZILLA_SERVICEBugzillaService type.
BUILDKITE_SERVICEBuildkiteService type.
CAMPFIRE_SERVICECampfireService type.
CLICKUP_SERVICEClickupService type.
CONFLUENCE_SERVICEConfluenceService type.
CUSTOM_ISSUE_TRACKER_SERVICECustomIssueTrackerService type.
DATADOG_SERVICEDatadogService type.
DIFFBLUE_COVER_SERVICEDiffblueCoverService type.
DISCORD_SERVICEDiscordService type.
DRONE_CI_SERVICEDroneCiService type.
EMAILS_ON_PUSH_SERVICEEmailsOnPushService type.
EWM_SERVICEEwmService type.
EXTERNAL_WIKI_SERVICEExternalWikiService type.
GITHUB_SERVICEGithubService type.
GITLAB_SLACK_APPLICATION_SERVICEGitlabSlackApplicationService type.
GIT_GUARDIAN_SERVICEGitGuardianService type.
GOOGLE_PLAY_SERVICEGooglePlayService type.
HANGOUTS_CHAT_SERVICEHangoutsChatService type.
HARBOR_SERVICEHarborService type.
IRKER_SERVICEIrkerService type.
JENKINS_SERVICEJenkinsService type.
JIRA_CLOUD_APP_SERVICEJiraCloudAppService type.
JIRA_SERVICEJiraService type.
MATRIX_SERVICEMatrixService type.
MATTERMOST_SERVICEMattermostService type.
MATTERMOST_SLASH_COMMANDS_SERVICEMattermostSlashCommandsService type.
MICROSOFT_TEAMS_SERVICEMicrosoftTeamsService type.
PACKAGIST_SERVICEPackagistService type.
PHORGE_SERVICEPhorgeService type.
PIPELINES_EMAIL_SERVICEPipelinesEmailService type.
PIVOTALTRACKER_SERVICEPivotaltrackerService type.
PROMETHEUS_SERVICEPrometheusService type.
PUMBLE_SERVICEPumbleService type.
PUSHOVER_SERVICEPushoverService type.
REDMINE_SERVICERedmineService type.
SLACK_SERVICESlackService type.
SLACK_SLASH_COMMANDS_SERVICESlackSlashCommandsService type.
SQUASH_TM_SERVICESquashTmService type.
TEAMCITY_SERVICETeamcityService type.
TELEGRAM_SERVICETelegramService type.
UNIFY_CIRCUIT_SERVICEUnifyCircuitService type.
WEBEX_TEAMS_SERVICEWebexTeamsService type.
YOUTRACK_SERVICEYoutrackService type.
ZENTAO_SERVICEZentaoService type.

ShaFormat

How to format SHA strings.

ValueDescription
LONGUnabbreviated format.
SHORTAbbreviated format. Short SHAs are typically eight characters long.

SharedRunnersSetting

ValueDescription
DISABLED_AND_OVERRIDABLESharing of runners is disabled and overridable.
DISABLED_AND_UNOVERRIDABLESharing of runners is disabled and unoverridable.
ENABLEDSharing of runners is enabled.

SnippetBlobActionEnum

Type of a snippet blob input action.

ValueDescription
createCreate a snippet blob.
deleteDelete a snippet blob.
moveMove a snippet blob.
updateUpdate a snippet blob.

Sort

Common sort values.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

SortDirectionEnum

Values for sort direction.

ValueDescription
ASCAscending order.
DESCDescending order.

SourceUserSort

Values for sorting the mapping of users on source instance to users on destination instance.

ValueDescription
SOURCE_NAME_ASCInstance source name by ascending order.
SOURCE_NAME_DESCInstance source name by descending order.
STATUS_ASCStatus of the mapping by ascending order.
STATUS_DESCStatus of the mapping by descending order.

SquashOptionSetting

Options for default squash behaviour for merge requests.

ValueDescription
ALLOWEDAllow.
ALWAYSRequire.
ENCOURAGEDEncourage.
NEVERDo not allow.

SubscriptionHistoryChangeType

Types of change for a subscription history record.

ValueDescription
GITLAB_SUBSCRIPTION_DESTROYEDThis was the previous state before the subscription was destroyed.
GITLAB_SUBSCRIPTION_UPDATEDThis was the previous state before the subscription was updated.

SubscriptionStatus

Status of the subscription to an issuable.

ValueDescription
EXPLICITLY_SUBSCRIBEDUser is explicitly subscribed to the issuable.
EXPLICITLY_UNSUBSCRIBEDUser is explicitly unsubscribed from the issuable.

TestCaseStatus

ValueDescription
errorTest case that has a status of error.
failedTest case that has a status of failed.
skippedTest case that has a status of skipped.
successTest case that has a status of success.

TestReportState

State of a test report.

ValueDescription
FAILEDFailed test report.
PASSEDPassed test report.

TimeboxReportErrorReason

Category of error.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
LABEL_PRIORITY_ASCLabel priority by ascending order.
LABEL_PRIORITY_DESCLabel priority by descending order.
MILESTONE_DUE_ASCMilestone due date by ascending order.
MILESTONE_DUE_DESCMilestone due date by descending order.
MISSING_DATESOne or both of start_date and due_date is missing.
PRIORITY_ASCPriority by ascending order.
PRIORITY_DESCPriority by descending order.
TOO_MANY_EVENTSThere are too many events.
UNSUPPORTEDThis type does not support timebox reports.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

TimelogSort

Values for sorting timelogs.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
SPENT_AT_ASCSpent at ascending order.
SPENT_AT_DESCSpent at descending order.
TIME_SPENT_ASCTime spent ascending order.
TIME_SPENT_DESCTime spent descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

TodoActionEnum

ValueDescription
added_approverUser was added as an approver.
approval_requiredUser was set as an approver.
assignedUser was assigned.
build_failedBuild triggered by the user failed.
directly_addressedUser was directly addressed.
markedUser added a to-do item.
member_access_requestedGroup or project access requested from the user.
mentionedUser was mentioned.
merge_train_removedMerge request authored by the user was removed from the merge train.
okr_checkin_requestedAn OKR assigned to the user requires an update.
review_requestedReview was requested from the user.
review_submittedMerge request authored by the user received a review.
ssh_key_expiredSSH key of the user has expired.
ssh_key_expiring_soonSSH key of the user will expire soon.
unmergeableMerge request authored by the user could not be merged.

TodoSort

Sort options for todos.

ValueDescription
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
LABEL_PRIORITY_ASCBy label priority in ascending order.
LABEL_PRIORITY_DESCBy label priority in descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

TodoStateEnum

ValueDescription
doneState of the todo is done.
pendingState of the todo is pending.

TodoTargetEnum

ValueDescription
ALERTAlert.
COMMITCommit.
DESIGNDesign.
EPICAn Epic.
ISSUEIssue.
KEYSSH key.
MERGEREQUESTMerge request.
NAMESPACENamespace.
PROJECTProject.
USERUser.
VULNERABILITYVulnerability.
WIKIPAGEMETAWiki page.
WORKITEMWork item.

TrainingUrlRequestStatus

Status of the request to the training provider. The URL of a TrainingUrl is calculated asynchronously. When PENDING, the URL of the TrainingUrl will be null. When COMPLETED, the URL of the TrainingUrl will be available.

ValueDescription
COMPLETEDCompleted request.
PENDINGPending request.

TypeEnum

ValueDescription
personalSnippet created independent of any project.
projectSnippet related to a specific project.

UserCalloutFeatureNameEnum

Name of the feature that the callout is for.

ValueDescription
ACTIVE_USER_COUNT_THRESHOLDCallout feature name for active_user_count_threshold.
BRANCH_RULES_INFO_CALLOUTCallout feature name for branch_rules_info_callout.
BRANCH_RULES_TIP_CALLOUTCallout feature name for branch_rules_tip_callout.
BUY_PIPELINE_MINUTES_NOTIFICATION_DOTCallout feature name for buy_pipeline_minutes_notification_dot.
CANARY_DEPLOYMENTCallout feature name for canary_deployment.
CI_DEPRECATION_WARNING_FOR_TYPES_KEYWORDCallout feature name for ci_deprecation_warning_for_types_keyword.
CI_MINUTES_LIMIT_ALERT_DANGER_STAGECallout feature name for ci_minutes_limit_alert_danger_stage.
CI_MINUTES_LIMIT_ALERT_EXCEEDED_STAGECallout feature name for ci_minutes_limit_alert_exceeded_stage.
CI_MINUTES_LIMIT_ALERT_WARNING_STAGECallout feature name for ci_minutes_limit_alert_warning_stage.
CLUSTER_SECURITY_WARNINGCallout feature name for cluster_security_warning.
DEPLOYMENT_APPROVALS_EMPTY_STATECallout feature name for deployment_approvals_empty_state.
DEPLOYMENT_DETAILS_FEEDBACKCallout feature name for deployment_details_feedback.
DUO_CHAT_CALLOUTCallout feature name for duo_chat_callout.
FEATURE_FLAGS_NEW_VERSIONCallout feature name for feature_flags_new_version.
GCP_SIGNUP_OFFERCallout feature name for gcp_signup_offer.
GEO_ENABLE_HASHED_STORAGECallout feature name for geo_enable_hashed_storage.
GEO_MIGRATE_HASHED_STORAGECallout feature name for geo_migrate_hashed_storage.
GKE_CLUSTER_INTEGRATIONCallout feature name for gke_cluster_integration.
GOLD_TRIAL_BILLINGSCallout feature name for gold_trial_billings.
JOINING_A_PROJECT_ALERTCallout feature name for joining_a_project_alert.
MR_EXPERIENCE_SURVEYCallout feature name for mr_experience_survey.
NAMESPACE_OVER_STORAGE_USERS_COMBINED_ALERTCallout feature name for namespace_over_storage_users_combined_alert.
NAMESPACE_STORAGE_LIMIT_ALERT_ALERT_THRESHOLDCallout feature name for namespace_storage_limit_alert_alert_threshold.
NAMESPACE_STORAGE_LIMIT_ALERT_ERROR_THRESHOLDCallout feature name for namespace_storage_limit_alert_error_threshold.
NAMESPACE_STORAGE_LIMIT_ALERT_WARNING_THRESHOLDCallout feature name for namespace_storage_limit_alert_warning_threshold.
NAMESPACE_STORAGE_PRE_ENFORCEMENT_BANNERCallout feature name for namespace_storage_pre_enforcement_banner.
NEW_MERGE_REQUEST_DASHBOARD_WELCOMECallout feature name for new_merge_request_dashboard_welcome.
NEW_MR_DASHBOARD_BANNERCallout feature name for new_mr_dashboard_banner.
NEW_TOP_LEVEL_GROUP_ALERTCallout feature name for new_top_level_group_alert.
NEW_USER_SIGNUPS_CAP_REACHEDCallout feature name for new_user_signups_cap_reached.
OPENSSL_CALLOUTCallout feature name for openssl_callout.
PERIOD_IN_TERRAFORM_STATE_NAME_ALERTCallout feature name for period_in_terraform_state_name_alert.
PERSONAL_ACCESS_TOKEN_EXPIRYCallout feature name for personal_access_token_expiry.
PERSONAL_PROJECT_LIMITATIONS_BANNERCallout feature name for personal_project_limitations_banner.
PIPELINE_NEEDS_BANNERCallout feature name for pipeline_needs_banner.
PIPELINE_NEEDS_HOVER_TIPCallout feature name for pipeline_needs_hover_tip.
PIPL_COMPLIANCE_ALERTCallout feature name for pipl_compliance_alert.
PLANNER_ROLE_CALLOUTCallout feature name for planner_role_callout.
PREVIEW_USER_OVER_LIMIT_FREE_PLAN_ALERTCallout feature name for preview_user_over_limit_free_plan_alert.
PRODUCT_ANALYTICS_DASHBOARD_FEEDBACKCallout feature name for product_analytics_dashboard_feedback.
PROFILE_PERSONAL_ACCESS_TOKEN_EXPIRYCallout feature name for profile_personal_access_token_expiry.
PROJECT_QUALITY_SUMMARY_FEEDBACKCallout feature name for project_quality_summary_feedback.
PROJECT_REPOSITORY_LIMIT_ALERT_WARNING_THRESHOLDCallout feature name for project_repository_limit_alert_warning_threshold.
REGISTRATION_ENABLED_CALLOUTCallout feature name for registration_enabled_callout.
SECURITY_CONFIGURATION_DEVOPS_ALERTCallout feature name for security_configuration_devops_alert.
SECURITY_CONFIGURATION_UPGRADE_BANNERCallout feature name for security_configuration_upgrade_banner.
SECURITY_NEWSLETTER_CALLOUTCallout feature name for security_newsletter_callout.
SECURITY_POLICY_PROTECTED_BRANCH_MODIFICATIONCallout feature name for security_policy_protected_branch_modification.
SECURITY_TRAINING_FEATURE_PROMOTIONCallout feature name for security_training_feature_promotion.
SUBMIT_LICENSE_USAGE_DATA_BANNERCallout feature name for submit_license_usage_data_banner.
SUGGEST_PIPELINECallout feature name for suggest_pipeline.
SUGGEST_POPOVER_DISMISSEDCallout feature name for suggest_popover_dismissed.
TABS_POSITION_HIGHLIGHTCallout feature name for tabs_position_highlight.
TERRAFORM_NOTIFICATION_DISMISSEDCallout feature name for terraform_notification_dismissed.
THREAT_MONITORING_INFOCallout feature name for threat_monitoring_info.
TRANSITION_TO_JIHU_CALLOUTCallout feature name for transition_to_jihu_callout.
TRIAL_STATUS_REMINDER_D14Callout feature name for trial_status_reminder_d14.
TRIAL_STATUS_REMINDER_D3Callout feature name for trial_status_reminder_d3.
TWO_FACTOR_AUTH_RECOVERY_SETTINGS_CHECKCallout feature name for two_factor_auth_recovery_settings_check.
ULTIMATE_TRIALCallout feature name for ultimate_trial.
UNFINISHED_TAG_CLEANUP_CALLOUTCallout feature name for unfinished_tag_cleanup_callout.
USER_REACHED_LIMIT_FREE_PLAN_ALERTCallout feature name for user_reached_limit_free_plan_alert.
VERIFICATION_REMINDERCallout feature name for verification_reminder.
VSD_FEEDBACK_BANNERCallout feature name for vsd_feedback_banner.
VULNERABILITY_REPORT_GROUPINGCallout feature name for vulnerability_report_grouping.
WEB_IDE_ALERT_DISMISSEDCallout feature name for web_ide_alert_dismissed.
WEB_IDE_CI_ENVIRONMENTS_GUIDANCECallout feature name for web_ide_ci_environments_guidance.
WORK_ITEM_EPIC_FEEDBACKCallout feature name for work_item_epic_feedback.

UserPromotionStatusType

Types of User Promotion States.

ValueDescription
FAILEDFailed to apply promotion requests for user.
PARTIAL_SUCCESSUser promotion was successful, but all promotion requests were not successfully applied.
SUCCESSSuccessfully applied all promotion requests for user.

UserState

Possible states of a user.

ValueDescription
activeUser is active and can use the system.
bannedUser is blocked, and their contributions are hidden.
blockedUser has been blocked by an administrator and cannot use the system.
blocked_pending_approvalUser is blocked and pending approval.
deactivatedUser is no longer active and cannot use the system.
ldap_blockedUser has been blocked by the system.

UserType

Possible types of user.

ValueDescription
ADMIN_BOTAdmin bot.
ALERT_BOTAlert bot.
AUTOMATION_BOTAutomation bot.
CI_PIPELINE_BOTCi pipeline bot.
DUO_CODE_REVIEW_BOTDuo code review bot.
GHOSTGhost.
HUMANHuman.
IMPORT_USERImport user.
LLM_BOTLlm bot.
MIGRATION_BOTMigration bot.
PLACEHOLDERPlaceholder.
PROJECT_BOTProject bot.
SECURITY_BOTSecurity bot.
SECURITY_POLICY_BOTSecurity policy bot.
SERVICE_ACCOUNTService account.
SERVICE_USERService user.
SUGGESTED_REVIEWERS_BOTSuggested reviewers bot.
SUPPORT_BOTSupport bot.
VISUAL_REVIEW_BOTVisual review bot.

ValueStreamDashboardMetric

Possible identifier types for a measurement.

ValueDescription
CONTRIBUTORSContributor count. EXPERIMENTAL: Only available on the SaaS version of GitLab when the ClickHouse database backend is enabled.
GROUPSGroup count.
ISSUESIssue count.
MERGE_REQUESTSMerge request count.
PIPELINESPipeline count.
PROJECTSProject count.
USERSUser count.

ValueStreamDashboardProjectLevelMetric

Possible identifier types for project-level measurement.

ValueDescription
CONTRIBUTORSContributor count. EXPERIMENTAL: Only available on the SaaS version of GitLab when the ClickHouse database backend is enabled.
ISSUESIssue count.
MERGE_REQUESTSMerge request count.
PIPELINESPipeline count.

ValueStreamStageEvent

Stage event identifiers.

ValueDescription
CODE_STAGE_STARTCode stage start event.
ISSUE_CLOSEDIssue closed event.
ISSUE_CREATEDIssue created event.
ISSUE_DEPLOYED_TO_PRODUCTIONIssue deployed to production event.
ISSUE_FIRST_ADDED_TO_BOARDIssue first added to board event.
ISSUE_FIRST_ADDED_TO_ITERATIONIssue first added to iteration event.
ISSUE_FIRST_ASSIGNED_ATIssue first assigned at event.
ISSUE_FIRST_ASSOCIATED_WITH_MILESTONEIssue first associated with milestone event.
ISSUE_FIRST_MENTIONED_IN_COMMITIssue first mentioned in commit event.
ISSUE_LABEL_ADDEDIssue label added event.
ISSUE_LABEL_REMOVEDIssue label removed event.
ISSUE_LAST_EDITEDIssue last edited event.
ISSUE_STAGE_ENDIssue stage end event.
MERGE_REQUEST_CLOSEDMerge request closed event.
MERGE_REQUEST_CREATEDMerge request created event.
MERGE_REQUEST_FIRST_ASSIGNED_ATMerge request first assigned at event.
MERGE_REQUEST_FIRST_COMMIT_ATMerge request first commit at event.
MERGE_REQUEST_FIRST_DEPLOYED_TO_PRODUCTIONMerge request first deployed to production event.
MERGE_REQUEST_LABEL_ADDEDMerge request label added event.
MERGE_REQUEST_LABEL_REMOVEDMerge request label removed event.
MERGE_REQUEST_LAST_APPROVED_ATMerge request last approved at event.
MERGE_REQUEST_LAST_BUILD_FINISHEDMerge request last build finished event.
MERGE_REQUEST_LAST_BUILD_STARTEDMerge request last build started event.
MERGE_REQUEST_LAST_EDITEDMerge request last edited event.
MERGE_REQUEST_MERGEDMerge request merged event.
MERGE_REQUEST_REVIEWER_FIRST_ASSIGNEDMerge request reviewer first assigned event.
PLAN_STAGE_STARTPlan stage start event.

ValueStreamStageItemSort

Sorting values available to value stream stage items.

ValueDescription
DURATION_ASCDuration by ascending order.
DURATION_DESCDuration by ascending order.
END_EVENT_ASCStage end event time by ascending order.
END_EVENT_DESCStage end event time by descending order.

VerificationStateEnum

ValueDescription
DISABLEDVerification process is disabled.
FAILEDVerification process finished but failed.
PENDINGVerification process has not started.
STARTEDVerification process is in progress.
SUCCEEDEDVerification process finished successfully.

VerificationStatus

Verification status of a GPG, X.509 or SSH signature for a commit.

ValueDescription
MULTIPLE_SIGNATURESmultiple_signatures verification status.
OTHER_USERother_user verification status.
REVOKED_KEYrevoked_key verification status.
SAME_USER_DIFFERENT_EMAILsame_user_different_email verification status.
UNKNOWN_KEYunknown_key verification status.
UNVERIFIEDunverified verification status.
UNVERIFIED_KEYunverified_key verification status.
VERIFIEDverified verification status.
VERIFIED_CAverified_ca verification status.
VERIFIED_SYSTEMverified_system verification status.

VisibilityLevelsEnum

ValueDescription
internalInternal visibility level.
privatePrivate visibility level.
publicPublic visibility level.

VisibilityPipelineIdType

Determines whether the pipeline list shows ID or IID.

ValueDescription
IDDisplay pipeline ID.
IIDDisplay pipeline IID.

VisibilityScopesEnum

ValueDescription
internalSnippet is visible for any logged in user except external users.
privateSnippet is visible only to the snippet creator.
publicSnippet can be accessed without any authentication.

VulnerabilityDismissalReason

The dismissal reason of the Vulnerability.

ValueDescription
ACCEPTABLE_RISKThe vulnerability is known, and has not been remediated or mitigated, but is considered to be an acceptable business risk.
FALSE_POSITIVEAn error in reporting in which a test result incorrectly indicates the presence of a vulnerability in a system when the vulnerability is not present.
MITIGATING_CONTROLA management, operational, or technical control (that is, safeguard or countermeasure) employed by an organization that provides equivalent or comparable protection for an information system.
NOT_APPLICABLEThe vulnerability is known, and has not been remediated or mitigated, but is considered to be in a part of the application that will not be updated.
USED_IN_TESTSThe finding is not a vulnerability because it is part of a test or is test data.

VulnerabilityExternalIssueLinkExternalTracker

The external tracker of the external issue link related to a vulnerability.

ValueDescription
JIRAJira external tracker.

VulnerabilityExternalIssueLinkType

The type of the external issue link related to a vulnerability.

ValueDescription
CREATEDCreated link type.

VulnerabilityGrade

The grade of the vulnerable project.

ValueDescription
AA grade.
BB grade.
CC grade.
DD grade.
FF grade.

VulnerabilityIssueLinkType

The type of the issue link related to a vulnerability.

ValueDescription
CREATEDIssue is created for the vulnerability.
RELATEDHas a related issue.

VulnerabilityOwaspTop10

OwaspTop10 category of the vulnerability.

ValueDescription
A01_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A01:2021-Broken Access Control, OWASP top 10 category.
A02_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A02:2021-Cryptographic Failures, OWASP top 10 category.
A03_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A03:2021-Injection, OWASP top 10 category.
A04_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A04:2021-Insecure Design, OWASP top 10 category.
A05_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A05:2021-Security Misconfiguration, OWASP top 10 category.
A06_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A06:2021-Vulnerable and Outdated Components, OWASP top 10 category.
A07_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A07:2021-Identification and Authentication Failures, OWASP top 10 category.
A08_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A08:2021-Software and Data Integrity Failures, OWASP top 10 category.
A09_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A09:2021-Security Logging and Monitoring Failures, OWASP top 10 category.
A10_2017A10:2017-Insufficient Logging & Monitoring, OWASP top 10 category.
A10_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A10:2021-Server-Side Request Forgery, OWASP top 10 category.
A1_2017A1:2017-Injection, OWASP top 10 category.
A1_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A1:2021-Broken Access Control, OWASP top 10 category.
A2_2017A2:2017-Broken Authentication, OWASP top 10 category.
A2_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A2:2021-Cryptographic Failures, OWASP top 10 category.
A3_2017A3:2017-Sensitive Data Exposure, OWASP top 10 category.
A3_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A3:2021-Injection, OWASP top 10 category.
A4_2017A4:2017-XML External Entities (XXE), OWASP top 10 category.
A4_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A4:2021-Insecure Design, OWASP top 10 category.
A5_2017A5:2017-Broken Access Control, OWASP top 10 category.
A5_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A5:2021-Security Misconfiguration, OWASP top 10 category.
A6_2017A6:2017-Security Misconfiguration, OWASP top 10 category.
A6_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A6:2021-Vulnerable and Outdated Components, OWASP top 10 category.
A7_2017A7:2017-Cross-Site Scripting (XSS), OWASP top 10 category.
A7_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A7:2021-Identification and Authentication Failures, OWASP top 10 category.
A8_2017A8:2017-Insecure Deserialization, OWASP top 10 category.
A8_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A8:2021-Software and Data Integrity Failures, OWASP top 10 category.
A9_2017A9:2017-Using Components with Known Vulnerabilities, OWASP top 10 category.
A9_2021 warning-solidIntroduced in GitLab 16.8. Status: Experiment. A9:2021-Security Logging and Monitoring Failures, OWASP top 10 category.
NONENo OWASP top 10 category.

VulnerabilityReportType

The type of the security scan that found the vulnerability.

ValueDescription
API_FUZZINGAPI Fuzzing report.
CLUSTER_IMAGE_SCANNINGCluster Image Scanning report.
CONTAINER_SCANNINGContainer Scanning report.
CONTAINER_SCANNING_FOR_REGISTRYContainer Scanning For Registry report.
COVERAGE_FUZZINGCoverage Fuzzing report.
DASTDAST report.
DEPENDENCY_SCANNINGDependency Scanning report.
GENERICGeneric report.
SASTSAST report.
SECRET_DETECTIONSecret Detection report.

VulnerabilitySeverity

The severity of the vulnerability.

ValueDescription
CRITICALCritical severity.
HIGHHigh severity.
INFOInfo severity.
LOWLow severity.
MEDIUMMedium severity.
UNKNOWNUnknown severity.

VulnerabilitySort

Vulnerability sort values.

ValueDescription
detected_ascDetection timestamp in ascending order.
detected_descDetection timestamp in descending order.
severity_ascSeverity in ascending order.
severity_descSeverity in descending order.

VulnerabilityState

The state of the vulnerability.

ValueDescription
CONFIRMEDFor details, see vulnerability status values.
DETECTEDFor details, see vulnerability status values.
DISMISSEDFor details, see vulnerability status values.
RESOLVEDFor details, see vulnerability status values.

WeightWildcardId

Weight ID wildcard values.

ValueDescription
ANYWeight is assigned.
NONENo weight is assigned.

WorkItemAwardEmojiUpdateAction

Values for work item award emoji update enum.

ValueDescription
ADDAdds the emoji.
REMOVERemoves the emoji.
TOGGLEToggles the status of the emoji.

WorkItemRelatedLinkType

Values for work item link types.

ValueDescription
BLOCKED_BYBlocked by type.
BLOCKSBlocks type.
RELATEDRelated type.

WorkItemSort

Values for sorting work items.

ValueDescription
CLOSED_AT_ASC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Closed time by ascending order.
CLOSED_AT_DESC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Closed time by descending order.
CREATED_ASCCreated at ascending order.
CREATED_DESCCreated at descending order.
DUE_DATE_ASC warning-solidIntroduced in GitLab 17.9. Status: Experiment. Due date by ascending order.
DUE_DATE_DESC warning-solidIntroduced in GitLab 17.9. Status: Experiment. Due date by descending order.
ESCALATION_STATUS_ASC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Status from triggered to resolved.
ESCALATION_STATUS_DESC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Status from resolved to triggered.
LABEL_PRIORITY_ASCLabel priority by ascending order.
LABEL_PRIORITY_DESCLabel priority by descending order.
MILESTONE_DUE_ASCMilestone due date by ascending order.
MILESTONE_DUE_DESCMilestone due date by descending order.
POPULARITY_ASC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Number of upvotes (awarded “thumbs up” emoji) by ascending order.
POPULARITY_DESC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Number of upvotes (awarded “thumbs up” emoji) by descending order.
PRIORITY_ASC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Priority by ascending order.
PRIORITY_DESC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Priority by descending order.
RELATIVE_POSITION_ASC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Relative position by ascending order.
SEVERITY_ASC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Severity from less critical to more critical.
SEVERITY_DESC warning-solidIntroduced in GitLab 17.10. Status: Experiment. Severity from more critical to less critical.
START_DATE_ASC warning-solidIntroduced in GitLab 17.9. Status: Experiment. start date by ascending order.
START_DATE_DESC warning-solidIntroduced in GitLab 17.9. Status: Experiment. start date by descending order.
TITLE_ASCTitle by ascending order.
TITLE_DESCTitle by descending order.
UPDATED_ASCUpdated at ascending order.
UPDATED_DESCUpdated at descending order.
created_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_ASC.
created_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: CREATED_DESC.
updated_asc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_ASC.
updated_desc warning-solidDeprecated in GitLab 13.5. This was renamed. Use: UPDATED_DESC.

WorkItemState

State of a GitLab work item.

ValueDescription
CLOSEDIn closed state.
OPENIn open state.

WorkItemStateEvent

Values for work item state events.

ValueDescription
CLOSECloses the work item.
REOPENReopens the work item.

WorkItemTodoUpdateAction

Values for work item to-do update enum.

ValueDescription
ADDAdds the to-do.
MARK_AS_DONEMarks the to-do as done.

WorkItemWidgetType

Type of a work item widget.

ValueDescription
ASSIGNEESAssignees widget.
AWARD_EMOJIAward Emoji widget.
COLORColor widget.
CRM_CONTACTSCrm Contacts widget.
CURRENT_USER_TODOSCurrent User Todos widget.
CUSTOM_FIELDSCustom Fields widget.
CUSTOM_STATUSCustom Status widget.
DESCRIPTIONDescription widget.
DESIGNSDesigns widget.
DEVELOPMENTDevelopment widget.
EMAIL_PARTICIPANTSEmail Participants widget.
ERROR_TRACKINGError Tracking widget.
HEALTH_STATUSHealth Status widget.
HIERARCHYHierarchy widget.
ITERATIONIteration widget.
LABELSLabels widget.
LINKED_ITEMSLinked Items widget.
LINKED_RESOURCESLinked Resources widget.
MILESTONEMilestone widget.
NOTESNotes widget.
NOTIFICATIONSNotifications widget.
PARTICIPANTSParticipants widget.
PROGRESSProgress widget.
REQUIREMENT_LEGACYRequirement Legacy widget.
START_AND_DUE_DATEStart And Due Date widget.
STATUSStatus widget.
TEST_REPORTSTest Reports widget.
TIME_TRACKINGTime Tracking widget.
WEIGHTWeight widget.

WorkspaceVariableInputType

Enum for the type of the variable to be injected in a workspace.

ValueDescription
ENVIRONMENTName type.

WorkspaceVariableType

Enum for the type of the variable injected in a workspace.

ValueDescription
ENVIRONMENTEnvironment type.

Scalar types

Scalar values are atomic values, and do not have fields of their own. Basic scalars include strings, boolean values, and numbers. This schema also defines various custom scalar values, such as types for times and dates.

This schema includes custom scalar types for identifiers, with a specific type for each kind of object.

For more information, read about Scalar Types on graphql.org.

AbuseReportID

A AbuseReportID is a global ID. It is encoded as a string.

An example AbuseReportID is: "gid://gitlab/AbuseReport/1".

AchievementsAchievementID

A AchievementsAchievementID is a global ID. It is encoded as a string.

An example AchievementsAchievementID is: "gid://gitlab/Achievements::Achievement/1".

AchievementsUserAchievementID

A AchievementsUserAchievementID is a global ID. It is encoded as a string.

An example AchievementsUserAchievementID is: "gid://gitlab/Achievements::UserAchievement/1".

AiAgentID

A AiAgentID is a global ID. It is encoded as a string.

An example AiAgentID is: "gid://gitlab/Ai::Agent/1".

AiAgentVersionID

A AiAgentVersionID is a global ID. It is encoded as a string.

An example AiAgentVersionID is: "gid://gitlab/Ai::AgentVersion/1".

AiConversationThreadID

A AiConversationThreadID is a global ID. It is encoded as a string.

An example AiConversationThreadID is: "gid://gitlab/Ai::Conversation::Thread/1".

AiDuoWorkflowsWorkflowID

A AiDuoWorkflowsWorkflowID is a global ID. It is encoded as a string.

An example AiDuoWorkflowsWorkflowID is: "gid://gitlab/Ai::DuoWorkflows::Workflow/1".

AiModelID

A AiModelID is a global ID. It is encoded as a string.

An example AiModelID is: "gid://gitlab/Ai::Model/1".

AiSelfHostedModelID

A AiSelfHostedModelID is a global ID. It is encoded as a string.

An example AiSelfHostedModelID is: "gid://gitlab/Ai::SelfHostedModel/1".

AlertManagementAlertID

A AlertManagementAlertID is a global ID. It is encoded as a string.

An example AlertManagementAlertID is: "gid://gitlab/AlertManagement::Alert/1".

AlertManagementHttpIntegrationID

A AlertManagementHttpIntegrationID is a global ID. It is encoded as a string.

An example AlertManagementHttpIntegrationID is: "gid://gitlab/AlertManagement::HttpIntegration/1".

AnalyticsCycleAnalyticsStageID

A AnalyticsCycleAnalyticsStageID is a global ID. It is encoded as a string.

An example AnalyticsCycleAnalyticsStageID is: "gid://gitlab/Analytics::CycleAnalytics::Stage/1".

AnalyticsCycleAnalyticsValueStreamID

A AnalyticsCycleAnalyticsValueStreamID is a global ID. It is encoded as a string.

An example AnalyticsCycleAnalyticsValueStreamID is: "gid://gitlab/Analytics::CycleAnalytics::ValueStream/1".

AnalyticsDevopsAdoptionEnabledNamespaceID

A AnalyticsDevopsAdoptionEnabledNamespaceID is a global ID. It is encoded as a string.

An example AnalyticsDevopsAdoptionEnabledNamespaceID is: "gid://gitlab/Analytics::DevopsAdoption::EnabledNamespace/1".

AntiAbuseReportsLabelID

A AntiAbuseReportsLabelID is a global ID. It is encoded as a string.

An example AntiAbuseReportsLabelID is: "gid://gitlab/AntiAbuse::Reports::Label/1".

AntiAbuseReportsNoteID

A AntiAbuseReportsNoteID is a global ID. It is encoded as a string.

An example AntiAbuseReportsNoteID is: "gid://gitlab/AntiAbuse::Reports::Note/1".

AppSecFuzzingCoverageCorpusID

A AppSecFuzzingCoverageCorpusID is a global ID. It is encoded as a string.

An example AppSecFuzzingCoverageCorpusID is: "gid://gitlab/AppSec::Fuzzing::Coverage::Corpus/1".

ApprovalProjectRuleID

A ApprovalProjectRuleID is a global ID. It is encoded as a string.

An example ApprovalProjectRuleID is: "gid://gitlab/ApprovalProjectRule/1".

AuditEventsAmazonS3ConfigurationID

A AuditEventsAmazonS3ConfigurationID is a global ID. It is encoded as a string.

An example AuditEventsAmazonS3ConfigurationID is: "gid://gitlab/AuditEvents::AmazonS3Configuration/1".

AuditEventsExternalAuditEventDestinationID

A AuditEventsExternalAuditEventDestinationID is a global ID. It is encoded as a string.

An example AuditEventsExternalAuditEventDestinationID is: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1".

AuditEventsGoogleCloudLoggingConfigurationID

A AuditEventsGoogleCloudLoggingConfigurationID is a global ID. It is encoded as a string.

An example AuditEventsGoogleCloudLoggingConfigurationID is: "gid://gitlab/AuditEvents::GoogleCloudLoggingConfiguration/1".

AuditEventsGroupExternalStreamingDestinationID

A AuditEventsGroupExternalStreamingDestinationID is a global ID. It is encoded as a string.

An example AuditEventsGroupExternalStreamingDestinationID is: "gid://gitlab/AuditEvents::Group::ExternalStreamingDestination/1".

AuditEventsGroupNamespaceFilterID

A AuditEventsGroupNamespaceFilterID is a global ID. It is encoded as a string.

An example AuditEventsGroupNamespaceFilterID is: "gid://gitlab/AuditEvents::Group::NamespaceFilter/1".

AuditEventsInstanceAmazonS3ConfigurationID

A AuditEventsInstanceAmazonS3ConfigurationID is a global ID. It is encoded as a string.

An example AuditEventsInstanceAmazonS3ConfigurationID is: "gid://gitlab/AuditEvents::Instance::AmazonS3Configuration/1".

AuditEventsInstanceExternalAuditEventDestinationID

A AuditEventsInstanceExternalAuditEventDestinationID is a global ID. It is encoded as a string.

An example AuditEventsInstanceExternalAuditEventDestinationID is: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1".

AuditEventsInstanceExternalStreamingDestinationID

A AuditEventsInstanceExternalStreamingDestinationID is a global ID. It is encoded as a string.

An example AuditEventsInstanceExternalStreamingDestinationID is: "gid://gitlab/AuditEvents::Instance::ExternalStreamingDestination/1".

AuditEventsInstanceGoogleCloudLoggingConfigurationID

A AuditEventsInstanceGoogleCloudLoggingConfigurationID is a global ID. It is encoded as a string.

An example AuditEventsInstanceGoogleCloudLoggingConfigurationID is: "gid://gitlab/AuditEvents::Instance::GoogleCloudLoggingConfiguration/1".

AuditEventsInstanceNamespaceFilterID

A AuditEventsInstanceNamespaceFilterID is a global ID. It is encoded as a string.

An example AuditEventsInstanceNamespaceFilterID is: "gid://gitlab/AuditEvents::Instance::NamespaceFilter/1".

AuditEventsStreamingHTTPNamespaceFilterID

A AuditEventsStreamingHTTPNamespaceFilterID is a global ID. It is encoded as a string.

An example AuditEventsStreamingHTTPNamespaceFilterID is: "gid://gitlab/AuditEvents::Streaming::HTTP::NamespaceFilter/1".

AuditEventsStreamingHeaderID

A AuditEventsStreamingHeaderID is a global ID. It is encoded as a string.

An example AuditEventsStreamingHeaderID is: "gid://gitlab/AuditEvents::Streaming::Header/1".

AuditEventsStreamingInstanceHeaderID

A AuditEventsStreamingInstanceHeaderID is a global ID. It is encoded as a string.

An example AuditEventsStreamingInstanceHeaderID is: "gid://gitlab/AuditEvents::Streaming::InstanceHeader/1".

AwardableID

A AwardableID is a global ID. It is encoded as a string.

An example AwardableID is: "gid://gitlab/Awardable/1".

BigInt

Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it’s encoded as a string.

BoardID

A BoardID is a global ID. It is encoded as a string.

An example BoardID is: "gid://gitlab/Board/1".

BoardsEpicBoardID

A BoardsEpicBoardID is a global ID. It is encoded as a string.

An example BoardsEpicBoardID is: "gid://gitlab/Boards::EpicBoard/1".

BoardsEpicListID

A BoardsEpicListID is a global ID. It is encoded as a string.

An example BoardsEpicListID is: "gid://gitlab/Boards::EpicList/1".

Boolean

Represents true or false values.

CiBuildID

A CiBuildID is a global ID. It is encoded as a string.

An example CiBuildID is: "gid://gitlab/Ci::Build/1".

CiCatalogResourceID

A CiCatalogResourceID is a global ID. It is encoded as a string.

An example CiCatalogResourceID is: "gid://gitlab/Ci::Catalog::Resource/1".

CiCatalogResourcesComponentID

A CiCatalogResourcesComponentID is a global ID. It is encoded as a string.

An example CiCatalogResourcesComponentID is: "gid://gitlab/Ci::Catalog::Resources::Component/1".

CiCatalogResourcesVersionID

A CiCatalogResourcesVersionID is a global ID. It is encoded as a string.

An example CiCatalogResourcesVersionID is: "gid://gitlab/Ci::Catalog::Resources::Version/1".

CiJobArtifactID

A CiJobArtifactID is a global ID. It is encoded as a string.

An example CiJobArtifactID is: "gid://gitlab/Ci::JobArtifact/1".

CiPipelineID

A CiPipelineID is a global ID. It is encoded as a string.

An example CiPipelineID is: "gid://gitlab/Ci::Pipeline/1".

CiPipelineScheduleID

A CiPipelineScheduleID is a global ID. It is encoded as a string.

An example CiPipelineScheduleID is: "gid://gitlab/Ci::PipelineSchedule/1".

CiPipelineScheduleVariableID

A CiPipelineScheduleVariableID is a global ID. It is encoded as a string.

An example CiPipelineScheduleVariableID is: "gid://gitlab/Ci::PipelineScheduleVariable/1".

CiProcessableID

A CiProcessableID is a global ID. It is encoded as a string.

An example CiProcessableID is: "gid://gitlab/Ci::Processable/1".

CiRunnerID

A CiRunnerID is a global ID. It is encoded as a string.

An example CiRunnerID is: "gid://gitlab/Ci::Runner/1".

CiRunnerManagerID

A CiRunnerManagerID is a global ID. It is encoded as a string.

An example CiRunnerManagerID is: "gid://gitlab/Ci::RunnerManager/1".

CiStageID

A CiStageID is a global ID. It is encoded as a string.

An example CiStageID is: "gid://gitlab/Ci::Stage/1".

CiSubscriptionsProjectID

A CiSubscriptionsProjectID is a global ID. It is encoded as a string.

An example CiSubscriptionsProjectID is: "gid://gitlab/Ci::Subscriptions::Project/1".

CiTriggerID

A CiTriggerID is a global ID. It is encoded as a string.

An example CiTriggerID is: "gid://gitlab/Ci::Trigger/1".

ClustersAgentID

A ClustersAgentID is a global ID. It is encoded as a string.

An example ClustersAgentID is: "gid://gitlab/Clusters::Agent/1".

ClustersAgentTokenID

A ClustersAgentTokenID is a global ID. It is encoded as a string.

An example ClustersAgentTokenID is: "gid://gitlab/Clusters::AgentToken/1".

ClustersAgentsUrlConfigurationID

A ClustersAgentsUrlConfigurationID is a global ID. It is encoded as a string.

An example ClustersAgentsUrlConfigurationID is: "gid://gitlab/Clusters::Agents::UrlConfiguration/1".

ClustersClusterID

A ClustersClusterID is a global ID. It is encoded as a string.

An example ClustersClusterID is: "gid://gitlab/Clusters::Cluster/1".

Color

Color represented as a hex code or named color.

For example: “#fefefe”.

ComplianceManagementComplianceFrameworkComplianceRequirementID

A ComplianceManagementComplianceFrameworkComplianceRequirementID is a global ID. It is encoded as a string.

An example ComplianceManagementComplianceFrameworkComplianceRequirementID is: "gid://gitlab/ComplianceManagement::ComplianceFramework::ComplianceRequirement/1".

ComplianceManagementComplianceFrameworkComplianceRequirementsControlID

A ComplianceManagementComplianceFrameworkComplianceRequirementsControlID is a global ID. It is encoded as a string.

An example ComplianceManagementComplianceFrameworkComplianceRequirementsControlID is: "gid://gitlab/ComplianceManagement::ComplianceFramework::ComplianceRequirementsControl/1".

ComplianceManagementFrameworkID

A ComplianceManagementFrameworkID is a global ID. It is encoded as a string.

An example ComplianceManagementFrameworkID is: "gid://gitlab/ComplianceManagement::Framework/1".

ContainerRegistryProtectionRuleID

A ContainerRegistryProtectionRuleID is a global ID. It is encoded as a string.

An example ContainerRegistryProtectionRuleID is: "gid://gitlab/ContainerRegistry::Protection::Rule/1".

ContainerRegistryProtectionTagRuleID

A ContainerRegistryProtectionTagRuleID is a global ID. It is encoded as a string.

An example ContainerRegistryProtectionTagRuleID is: "gid://gitlab/ContainerRegistry::Protection::TagRule/1".

ContainerRepositoryID

A ContainerRepositoryID is a global ID. It is encoded as a string.

An example ContainerRepositoryID is: "gid://gitlab/ContainerRepository/1".

CustomEmojiID

A CustomEmojiID is a global ID. It is encoded as a string.

An example CustomEmojiID is: "gid://gitlab/CustomEmoji/1".

CustomerRelationsContactID

A CustomerRelationsContactID is a global ID. It is encoded as a string.

An example CustomerRelationsContactID is: "gid://gitlab/CustomerRelations::Contact/1".

CustomerRelationsOrganizationID

A CustomerRelationsOrganizationID is a global ID. It is encoded as a string.

An example CustomerRelationsOrganizationID is: "gid://gitlab/CustomerRelations::Organization/1".

DastProfileID

A DastProfileID is a global ID. It is encoded as a string.

An example DastProfileID is: "gid://gitlab/Dast::Profile/1".

DastProfileScheduleID

A DastProfileScheduleID is a global ID. It is encoded as a string.

An example DastProfileScheduleID is: "gid://gitlab/Dast::ProfileSchedule/1".

DastScannerProfileID

A DastScannerProfileID is a global ID. It is encoded as a string.

An example DastScannerProfileID is: "gid://gitlab/DastScannerProfile/1".

DastSiteProfileID

A DastSiteProfileID is a global ID. It is encoded as a string.

An example DastSiteProfileID is: "gid://gitlab/DastSiteProfile/1".

DastSiteTokenID

A DastSiteTokenID is a global ID. It is encoded as a string.

An example DastSiteTokenID is: "gid://gitlab/DastSiteToken/1".

DastSiteValidationID

A DastSiteValidationID is a global ID. It is encoded as a string.

An example DastSiteValidationID is: "gid://gitlab/DastSiteValidation/1".

Date

Date represented in ISO 8601.

DependencyProxyManifestID

A DependencyProxyManifestID is a global ID. It is encoded as a string.

An example DependencyProxyManifestID is: "gid://gitlab/DependencyProxy::Manifest/1".

DeployKeyID

A DeployKeyID is a global ID. It is encoded as a string.

An example DeployKeyID is: "gid://gitlab/DeployKey/1".

DeploymentID

A DeploymentID is a global ID. It is encoded as a string.

An example DeploymentID is: "gid://gitlab/Deployment/1".

DescriptionVersionID

A DescriptionVersionID is a global ID. It is encoded as a string.

An example DescriptionVersionID is: "gid://gitlab/DescriptionVersion/1".

DesignManagementDesignAtVersionID

A DesignManagementDesignAtVersionID is a global ID. It is encoded as a string.

An example DesignManagementDesignAtVersionID is: "gid://gitlab/DesignManagement::DesignAtVersion/1".

DesignManagementDesignID

A DesignManagementDesignID is a global ID. It is encoded as a string.

An example DesignManagementDesignID is: "gid://gitlab/DesignManagement::Design/1".

DesignManagementVersionID

A DesignManagementVersionID is a global ID. It is encoded as a string.

An example DesignManagementVersionID is: "gid://gitlab/DesignManagement::Version/1".

DiffNoteID

A DiffNoteID is a global ID. It is encoded as a string.

An example DiffNoteID is: "gid://gitlab/DiffNote/1".

DiscussionID

A DiscussionID is a global ID. It is encoded as a string.

An example DiscussionID is: "gid://gitlab/Discussion/1".

Duration

Duration between two instants, represented as a fractional number of seconds.

For example: 12.3334.

EmailID

A EmailID is a global ID. It is encoded as a string.

An example EmailID is: "gid://gitlab/Email/1".

EnvironmentID

A EnvironmentID is a global ID. It is encoded as a string.

An example EnvironmentID is: "gid://gitlab/Environment/1".

EpicID

A EpicID is a global ID. It is encoded as a string.

An example EpicID is: "gid://gitlab/Epic/1".

EpicTreeSortingID

A EpicTreeSortingID is a global ID. It is encoded as a string.

An example EpicTreeSortingID is: "gid://gitlab/EpicTreeSorting/1".

Float

Represents signed double-precision fractional values as specified by IEEE 754.

GeoBaseRegistryID

A GeoBaseRegistryID is a global ID. It is encoded as a string.

An example GeoBaseRegistryID is: "gid://gitlab/Geo::BaseRegistry/1".

GitlabErrorTrackingDetailedErrorID

A GitlabErrorTrackingDetailedErrorID is a global ID. It is encoded as a string.

An example GitlabErrorTrackingDetailedErrorID is: "gid://gitlab/Gitlab::ErrorTracking::DetailedError/1".

GitlabSubscriptionsAddOnPurchaseID

A GitlabSubscriptionsAddOnPurchaseID is a global ID. It is encoded as a string.

An example GitlabSubscriptionsAddOnPurchaseID is: "gid://gitlab/GitlabSubscriptions::AddOnPurchase/1".

GlobalID

A global identifier.

A global identifier represents an object uniquely across the application. An example of a global identifier is "gid://gitlab/User/1".

gid://gitlab stands for the root name. User is the name of the ActiveRecord class of the record. 1 is the record id as per the id in the db table.

Global identifiers are encoded as strings.

GoogleCloudImage

Represents a Google Cloud Image for GKE.

GoogleCloudMachineType

Represents a Google Cloud Compute machine type.

GoogleCloudProject

Represents a Google Cloud Compute project.

GoogleCloudRegion

Represents a Google Cloud Compute region.

GoogleCloudZone

Represents a Google Cloud Compute zone.

GroupID

A GroupID is a global ID. It is encoded as a string.

An example GroupID is: "gid://gitlab/Group/1".

GroupsSavedReplyID

A GroupsSavedReplyID is a global ID. It is encoded as a string.

An example GroupsSavedReplyID is: "gid://gitlab/Groups::SavedReply/1".

ID

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

ISO8601Date

An ISO 8601-encoded date.

ISO8601DateTime

An ISO 8601-encoded datetime.

ImportSourceUserID

A ImportSourceUserID is a global ID. It is encoded as a string.

An example ImportSourceUserID is: "gid://gitlab/Import::SourceUser/1".

IncidentManagementEscalationPolicyID

A IncidentManagementEscalationPolicyID is a global ID. It is encoded as a string.

An example IncidentManagementEscalationPolicyID is: "gid://gitlab/IncidentManagement::EscalationPolicy/1".

IncidentManagementEscalationRuleID

A IncidentManagementEscalationRuleID is a global ID. It is encoded as a string.

An example IncidentManagementEscalationRuleID is: "gid://gitlab/IncidentManagement::EscalationRule/1".

IncidentManagementIssuableResourceLinkID

A IncidentManagementIssuableResourceLinkID is a global ID. It is encoded as a string.

An example IncidentManagementIssuableResourceLinkID is: "gid://gitlab/IncidentManagement::IssuableResourceLink/1".

IncidentManagementOncallParticipantID

A IncidentManagementOncallParticipantID is a global ID. It is encoded as a string.

An example IncidentManagementOncallParticipantID is: "gid://gitlab/IncidentManagement::OncallParticipant/1".

IncidentManagementOncallRotationID

A IncidentManagementOncallRotationID is a global ID. It is encoded as a string.

An example IncidentManagementOncallRotationID is: "gid://gitlab/IncidentManagement::OncallRotation/1".

IncidentManagementTimelineEventID

A IncidentManagementTimelineEventID is a global ID. It is encoded as a string.

An example IncidentManagementTimelineEventID is: "gid://gitlab/IncidentManagement::TimelineEvent/1".

IncidentManagementTimelineEventTagID

A IncidentManagementTimelineEventTagID is a global ID. It is encoded as a string.

An example IncidentManagementTimelineEventTagID is: "gid://gitlab/IncidentManagement::TimelineEventTag/1".

Int

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

IntegrationsPrometheusID

A IntegrationsPrometheusID is a global ID. It is encoded as a string.

An example IntegrationsPrometheusID is: "gid://gitlab/Integrations::Prometheus/1". The older format "gid://gitlab/PrometheusService/1" was deprecated in 14.1.

IssuableID

A IssuableID is a global ID. It is encoded as a string.

An example IssuableID is: "gid://gitlab/Issuable/1".

IssuablesCustomFieldID

A IssuablesCustomFieldID is a global ID. It is encoded as a string.

An example IssuablesCustomFieldID is: "gid://gitlab/Issuables::CustomField/1".

IssuablesCustomFieldSelectOptionID

A IssuablesCustomFieldSelectOptionID is a global ID. It is encoded as a string.

An example IssuablesCustomFieldSelectOptionID is: "gid://gitlab/Issuables::CustomFieldSelectOption/1".

IssueID

A IssueID is a global ID. It is encoded as a string.

An example IssueID is: "gid://gitlab/Issue/1".

IssueParentID

A IssueParentID is a global ID. It is encoded as a string.

An example IssueParentID is: "gid://gitlab/IssueParent/1".

IterationID

A IterationID is a global ID. It is encoded as a string.

An example IterationID is: "gid://gitlab/Iteration/1". The older format "gid://gitlab/EEIteration/1" was deprecated in 13.3.

IterationsCadenceID

A IterationsCadenceID is a global ID. It is encoded as a string.

An example IterationsCadenceID is: "gid://gitlab/Iterations::Cadence/1".

JSON

Represents untyped JSON.

JobID

A CommitStatusID is a global ID. It is encoded as a string.

An example CommitStatusID is: "gid://gitlab/CommitStatus/1".

JsonString

JSON object as raw string.

LabelID

A LabelID is a global ID. It is encoded as a string.

An example LabelID is: "gid://gitlab/Label/1".

ListID

A ListID is a global ID. It is encoded as a string.

An example ListID is: "gid://gitlab/List/1".

MemberRoleID

A MemberRoleID is a global ID. It is encoded as a string.

An example MemberRoleID is: "gid://gitlab/MemberRole/1".

MergeRequestID

A MergeRequestID is a global ID. It is encoded as a string.

An example MergeRequestID is: "gid://gitlab/MergeRequest/1".

MergeRequestsClosingIssuesID

A MergeRequestsClosingIssuesID is a global ID. It is encoded as a string.

An example MergeRequestsClosingIssuesID is: "gid://gitlab/MergeRequestsClosingIssues/1".

MergeRequestsExternalStatusCheckID

A MergeRequestsExternalStatusCheckID is a global ID. It is encoded as a string.

An example MergeRequestsExternalStatusCheckID is: "gid://gitlab/MergeRequests::ExternalStatusCheck/1".

MergeTrainsCarID

A MergeTrainsCarID is a global ID. It is encoded as a string.

An example MergeTrainsCarID is: "gid://gitlab/MergeTrains::Car/1".

MilestoneID

A MilestoneID is a global ID. It is encoded as a string.

An example MilestoneID is: "gid://gitlab/Milestone/1".

MlCandidateID

A MlCandidateID is a global ID. It is encoded as a string.

An example MlCandidateID is: "gid://gitlab/Ml::Candidate/1".

MlCandidateMetadataID

A MlCandidateMetadataID is a global ID. It is encoded as a string.

An example MlCandidateMetadataID is: "gid://gitlab/Ml::CandidateMetadata/1".

MlCandidateMetricID

A MlCandidateMetricID is a global ID. It is encoded as a string.

An example MlCandidateMetricID is: "gid://gitlab/Ml::CandidateMetric/1".

MlCandidateParamID

A MlCandidateParamID is a global ID. It is encoded as a string.

An example MlCandidateParamID is: "gid://gitlab/Ml::CandidateParam/1".

MlExperimentID

A MlExperimentID is a global ID. It is encoded as a string.

An example MlExperimentID is: "gid://gitlab/Ml::Experiment/1".

MlModelID

A MlModelID is a global ID. It is encoded as a string.

An example MlModelID is: "gid://gitlab/Ml::Model/1".

MlModelVersionID

A MlModelVersionID is a global ID. It is encoded as a string.

An example MlModelVersionID is: "gid://gitlab/Ml::ModelVersion/1".

NamespaceID

A NamespaceID is a global ID. It is encoded as a string.

An example NamespaceID is: "gid://gitlab/Namespace/1".

NamespacesNamespaceBanID

A NamespacesNamespaceBanID is a global ID. It is encoded as a string.

An example NamespacesNamespaceBanID is: "gid://gitlab/Namespaces::NamespaceBan/1".

NoteID

A NoteID is a global ID. It is encoded as a string.

An example NoteID is: "gid://gitlab/Note/1".

NoteableID

A NoteableID is a global ID. It is encoded as a string.

An example NoteableID is: "gid://gitlab/Noteable/1".

OperationsFeatureFlagID

A OperationsFeatureFlagID is a global ID. It is encoded as a string.

An example OperationsFeatureFlagID is: "gid://gitlab/Operations::FeatureFlag/1".

OrganizationsOrganizationID

A OrganizationsOrganizationID is a global ID. It is encoded as a string.

An example OrganizationsOrganizationID is: "gid://gitlab/Organizations::Organization/1".

OrganizationsOrganizationUserID

A OrganizationsOrganizationUserID is a global ID. It is encoded as a string.

An example OrganizationsOrganizationUserID is: "gid://gitlab/Organizations::OrganizationUser/1".

PackagesConanFileMetadatumID

A PackagesConanFileMetadatumID is a global ID. It is encoded as a string.

An example PackagesConanFileMetadatumID is: "gid://gitlab/Packages::Conan::FileMetadatum/1".

PackagesConanMetadatumID

A PackagesConanMetadatumID is a global ID. It is encoded as a string.

An example PackagesConanMetadatumID is: "gid://gitlab/Packages::Conan::Metadatum/1".

PackagesDependencyID

A PackagesDependencyID is a global ID. It is encoded as a string.

An example PackagesDependencyID is: "gid://gitlab/Packages::Dependency/1".

PackagesDependencyLinkID

A PackagesDependencyLinkID is a global ID. It is encoded as a string.

An example PackagesDependencyLinkID is: "gid://gitlab/Packages::DependencyLink/1".

PackagesMavenMetadatumID

A PackagesMavenMetadatumID is a global ID. It is encoded as a string.

An example PackagesMavenMetadatumID is: "gid://gitlab/Packages::Maven::Metadatum/1".

PackagesNugetDependencyLinkMetadatumID

A PackagesNugetDependencyLinkMetadatumID is a global ID. It is encoded as a string.

An example PackagesNugetDependencyLinkMetadatumID is: "gid://gitlab/Packages::Nuget::DependencyLinkMetadatum/1".

PackagesNugetMetadatumID

A PackagesNugetMetadatumID is a global ID. It is encoded as a string.

An example PackagesNugetMetadatumID is: "gid://gitlab/Packages::Nuget::Metadatum/1".

PackagesPackageFileID

A PackagesPackageFileID is a global ID. It is encoded as a string.

An example PackagesPackageFileID is: "gid://gitlab/Packages::PackageFile/1".

PackagesPackageID

A PackagesPackageID is a global ID. It is encoded as a string.

An example PackagesPackageID is: "gid://gitlab/Packages::Package/1".

PackagesProtectionRuleID

A PackagesProtectionRuleID is a global ID. It is encoded as a string.

An example PackagesProtectionRuleID is: "gid://gitlab/Packages::Protection::Rule/1".

PackagesPypiMetadatumID

A PackagesPypiMetadatumID is a global ID. It is encoded as a string.

An example PackagesPypiMetadatumID is: "gid://gitlab/Packages::Pypi::Metadatum/1".

PackagesTerraformModuleMetadatumID

A PackagesTerraformModuleMetadatumID is a global ID. It is encoded as a string.

An example PackagesTerraformModuleMetadatumID is: "gid://gitlab/Packages::TerraformModule::Metadatum/1".

PagesDeploymentID

A PagesDeploymentID is a global ID. It is encoded as a string.

An example PagesDeploymentID is: "gid://gitlab/PagesDeployment/1".

PathLockID

A PathLockID is a global ID. It is encoded as a string.

An example PathLockID is: "gid://gitlab/PathLock/1".

PayloadAlertFieldPathSegment

String or integer.

ProjectID

A ProjectID is a global ID. It is encoded as a string.

An example ProjectID is: "gid://gitlab/Project/1".

ProjectImportStateID

A ProjectImportStateID is a global ID. It is encoded as a string.

An example ProjectImportStateID is: "gid://gitlab/ProjectImportState/1".

ProjectsBranchRuleID

A ProjectsBranchRuleID is a global ID. It is encoded as a string.

An example ProjectsBranchRuleID is: "gid://gitlab/Projects::BranchRule/1".

ProjectsSavedReplyID

A ProjectsSavedReplyID is a global ID. It is encoded as a string.

An example ProjectsSavedReplyID is: "gid://gitlab/Projects::SavedReply/1".

ProjectsTargetBranchRuleID

A ProjectsTargetBranchRuleID is a global ID. It is encoded as a string.

An example ProjectsTargetBranchRuleID is: "gid://gitlab/Projects::TargetBranchRule/1".

ReleaseID

A ReleaseID is a global ID. It is encoded as a string.

An example ReleaseID is: "gid://gitlab/Release/1".

ReleasesLinkID

A ReleasesLinkID is a global ID. It is encoded as a string.

An example ReleasesLinkID is: "gid://gitlab/Releases::Link/1".

RemoteDevelopmentRemoteDevelopmentAgentConfigID

A RemoteDevelopmentRemoteDevelopmentAgentConfigID is a global ID. It is encoded as a string.

An example RemoteDevelopmentRemoteDevelopmentAgentConfigID is: "gid://gitlab/RemoteDevelopment::RemoteDevelopmentAgentConfig/1".

RemoteDevelopmentWorkspaceID

A RemoteDevelopmentWorkspaceID is a global ID. It is encoded as a string.

An example RemoteDevelopmentWorkspaceID is: "gid://gitlab/RemoteDevelopment::Workspace/1".

RemoteDevelopmentWorkspaceVariableID

A RemoteDevelopmentWorkspaceVariableID is a global ID. It is encoded as a string.

An example RemoteDevelopmentWorkspaceVariableID is: "gid://gitlab/RemoteDevelopment::WorkspaceVariable/1".

RemoteDevelopmentWorkspacesAgentConfigID

A RemoteDevelopmentWorkspacesAgentConfigID is a global ID. It is encoded as a string.

An example RemoteDevelopmentWorkspacesAgentConfigID is: "gid://gitlab/RemoteDevelopment::WorkspacesAgentConfig/1".

SbomComponentID

A SbomComponentID is a global ID. It is encoded as a string.

An example SbomComponentID is: "gid://gitlab/Sbom::Component/1".

SecurityProjectSecurityExclusionID

A SecurityProjectSecurityExclusionID is a global ID. It is encoded as a string.

An example SecurityProjectSecurityExclusionID is: "gid://gitlab/Security::ProjectSecurityExclusion/1".

SecurityTrainingProviderID

A SecurityTrainingProviderID is a global ID. It is encoded as a string.

An example SecurityTrainingProviderID is: "gid://gitlab/Security::TrainingProvider/1".

SnippetID

A SnippetID is a global ID. It is encoded as a string.

An example SnippetID is: "gid://gitlab/Snippet/1".

String

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

SystemNoteMetadataID

A SystemNoteMetadataID is a global ID. It is encoded as a string.

An example SystemNoteMetadataID is: "gid://gitlab/SystemNoteMetadata/1".

TerraformStateID

A TerraformStateID is a global ID. It is encoded as a string.

An example TerraformStateID is: "gid://gitlab/Terraform::State/1".

Time

Time represented in ISO 8601.

For example: “2021-03-09T14:58:50+00:00”.

See https://www.iso.org/iso-8601-date-and-time-format.html.

TimelogID

A TimelogID is a global ID. It is encoded as a string.

An example TimelogID is: "gid://gitlab/Timelog/1".

TodoID

A TodoID is a global ID. It is encoded as a string.

An example TodoID is: "gid://gitlab/Todo/1".

TodoableID

A TodoableID is a global ID. It is encoded as a string.

An example TodoableID is: "gid://gitlab/Todoable/1".

UntrustedRegexp

A regexp containing patterns sourced from user input.

Upload

UploadID

A UploadID is a global ID. It is encoded as a string.

An example UploadID is: "gid://gitlab/Upload/1".

UserID

A UserID is a global ID. It is encoded as a string.

An example UserID is: "gid://gitlab/User/1".

UsersSavedReplyID

A UsersSavedReplyID is a global ID. It is encoded as a string.

An example UsersSavedReplyID is: "gid://gitlab/Users::SavedReply/1".

VulnerabilitiesExternalIssueLinkID

A VulnerabilitiesExternalIssueLinkID is a global ID. It is encoded as a string.

An example VulnerabilitiesExternalIssueLinkID is: "gid://gitlab/Vulnerabilities::ExternalIssueLink/1".

VulnerabilitiesScannerID

A VulnerabilitiesScannerID is a global ID. It is encoded as a string.

An example VulnerabilitiesScannerID is: "gid://gitlab/Vulnerabilities::Scanner/1".

VulnerabilitiesStateTransitionID

A VulnerabilitiesStateTransitionID is a global ID. It is encoded as a string.

An example VulnerabilitiesStateTransitionID is: "gid://gitlab/Vulnerabilities::StateTransition/1".

VulnerabilityID

A VulnerabilityID is a global ID. It is encoded as a string.

An example VulnerabilityID is: "gid://gitlab/Vulnerability/1".

WikiPageMetaID

A WikiPageMetaID is a global ID. It is encoded as a string.

An example WikiPageMetaID is: "gid://gitlab/WikiPage::Meta/1".

WorkItemID

A WorkItemID is a global ID. It is encoded as a string.

An example WorkItemID is: "gid://gitlab/WorkItem/1".

While we transition from Issues into Work Items this type will temporarily support IssueID like: "gid://gitlab/Issue/1". This behavior will be removed without notice in the future.

WorkItemsParentID

A WorkItemsParentID is a global ID. It is encoded as a string.

An example WorkItemsParentID is: "gid://gitlab/WorkItems::Parent/1".

WorkItemsRelatedWorkItemLinkID

A WorkItemsRelatedWorkItemLinkID is a global ID. It is encoded as a string.

An example WorkItemsRelatedWorkItemLinkID is: "gid://gitlab/WorkItems::RelatedWorkItemLink/1".

WorkItemsTypeID

A WorkItemsTypeID is a global ID. It is encoded as a string.

An example WorkItemsTypeID is: "gid://gitlab/WorkItems::Type/1".

WorkItemsWidgetsCustomStatusID

A WorkItemsWidgetsCustomStatusID is a global ID. It is encoded as a string.

An example WorkItemsWidgetsCustomStatusID is: "gid://gitlab/WorkItems::Widgets::CustomStatus/1".

Abstract types

Abstract types (unions and interfaces) are ways the schema can represent values that may be one of several concrete types.

  • A Union is a set of possible types. The types might not have any fields in common.
  • An Interface is a defined set of fields. Types may implement an interface, which guarantees that they have all the fields in the set. A type may implement more than one interface.

See the GraphQL documentation for more information on using abstract types.

Unions

CiJobTokenScopeTarget

Represents an object that is the target of a CI_JOB_TOKEN allowlist entry.

One of:

CiRunnerCloudProvisioning

Information used in runner cloud provisioning.

One of:

DependencyLinkMetadata

Represents metadata associated with a dependency link.

One of:

ExpressionValue

Represents possible value types for an expression.

One of:

GoogleCloudArtifactRegistryArtifact

A base type of Google Artifact Registry artifacts.

One of:

GoogleCloudArtifactRegistryArtifactDetails

Details type of Google Artifact Registry artifacts.

One of:

Issuable

Represents an issuable.

One of:

JobNeedUnion

One of:

NoteableType

Represents an object that supports notes.

One of:

PackageMetadata

Represents metadata associated with a Package.

One of:

Registrable

One of:

SecurityPolicySource

Represents a policy source. Its fields depend on the source type.

One of:

VulnerabilityDetail

Represents a vulnerability detail field. The fields with data will depend on the vulnerability detail type.

One of:

VulnerabilityLocation

Represents a vulnerability location. The fields with data will depend on the vulnerability report type.

One of:

Interfaces

AccessLevelInterface

Implementations:

Fields
NameTypeDescription
minimumAccessLevelForDelete warning-solidContainerProtectionTagRuleAccessLevelIntroduced in GitLab 17.8. Status: Experiment. 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 minimum access level is enforced. Users with the Developer role or higher can delete tags by default.
minimumAccessLevelForPush warning-solidContainerProtectionTagRuleAccessLevelIntroduced in GitLab 17.8. Status: Experiment. 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 minimum access level is enforced. Users with the Developer role or higher can push tags by default.

AlertManagementIntegration

Implementations:

Fields
NameTypeDescription
activeBooleanWhether the endpoint is currently accepting alerts.
apiUrlStringURL at which Prometheus metrics can be queried to populate the metrics dashboard.
idID!ID of the integration.
nameStringName of the integration.
tokenStringToken used to authenticate alert notification requests.
typeAlertManagementIntegrationType!Type of integration.
urlStringEndpoint which accepts alert notifications.

AmazonS3ConfigurationInterface

Implementations:

Fields
NameTypeDescription
accessKeyXidString!Access key ID of the Amazon S3 account.
awsRegionString!AWS region where the bucket is created.
bucketNameString!Name of the bucket where the audit events would be logged.
idID!ID of the configuration.
nameString!Name of the external destination to send audit events to.

AuditEventStreamingDestinationInterface

Implementations:

Fields
NameTypeDescription
categoryString!Category of the external destination to send audit events to.
configJSON!Config of the external destination.
eventTypeFilters[String!]!List of event type filters added for streaming.
idID!ID of the destination.
nameString!Name of the external destination to send audit events to.
secretTokenString!Secret token for the destination, will be non-empty value only for http category.

BaseDiscussionInterface

Implementations:

Fields
NameTypeDescription
createdAtTime!Timestamp of the discussion’s creation.
idDiscussionID!ID of the discussion.
replyIdDiscussionID!ID used to reply to the discussion.
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.

BaseHeaderInterface

Implementations:

Fields
NameTypeDescription
activeBoolean!Header is active or not.
idID!ID of the header.
keyString!Key of the header.
valueString!Value of the header.

BaseNoteInterface

Implementations:

Fields
NameTypeDescription
authorUserCoreUser who wrote the note.
awardEmojiAwardEmojiConnectionList of emoji reactions associated with the note. (see Connections)
bodyString!Content of the note.
bodyFirstLineHtmlString!First line of the note content.
bodyHtmlStringGitLab Flavored Markdown rendering of the content of the note.
createdAtTime!Timestamp of the note creation.
lastEditedAtTimeTimestamp when note was last edited.
lastEditedByUserCoreUser who last edited the note.
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.
updatedAtTime!Timestamp of the note’s last activity.
urlStringURL to view the note in the Web UI.

CiVariable

Implementations:

Fields
NameTypeDescription
idID!ID of the variable.
keyStringName of the variable.
rawBooleanIndicates whether the variable is raw.
valueStringValue of the variable.
variableTypeCiVariableTypeType of the variable.

CommitSignature

Represents signing information for a commit.

Implementations:

Fields
NameTypeDescription
commitShaStringSHA of the associated commit.
projectProjectProject of the associated commit.
verificationStatusVerificationStatusIndicates verification status of the associated key or certificate.

CurrentUserTodos

Implementations:

Fields with arguments
CurrentUserTodos.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

####### Arguments

NameTypeDescription
stateTodoStateEnumState of the to-do items.

DesignFields

Implementations:

Fields
NameTypeDescription
diffRefsDiffRefs!Diff refs for this design.
eventDesignVersionEvent!How this design was changed in the current version.
filenameString!Filename of the design.
fullPathID!Full path to the design file.
idID!ID of this design.
imageString!URL of the full-sized image.
imageV432x230StringThe URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
issueIssue!Issue the design belongs to.
notesCountInt!Total count of user-created notes for this design.
projectProject!Project the design belongs to.

Entry

Implementations:

Fields
NameTypeDescription
flatPathString!Flat path of the entry.
idID!ID of the entry.
nameString!Name of the entry.
pathString!Path of the entry.
shaString!SHA of the entry.
typeEntryType!Type of tree entry.

Eventable

Implementations:

Fields
NameTypeDescription
eventsEventConnectionList of events associated with the object. (see Connections)

ExpressionInterface

Defines the common fields for all expressions.

Implementations:

Fields
NameTypeDescription
fieldString!Field the expression applies to.
operatorString!Operator of the expression.

ExternalAuditEventDestinationInterface

Implementations:

Fields
NameTypeDescription
destinationUrlString!External destination to send audit events to.
eventTypeFilters[String!]!List of event type filters added for streaming.
idID!ID of the destination.
nameString!Name of the external destination to send audit events to.
verificationTokenString!Verification token to validate source of event.

GoogleCloudLoggingConfigurationInterface

Implementations:

Fields
NameTypeDescription
clientEmailString!Client email.
googleProjectIdNameString!Google project ID.
idID!ID of the configuration.
logIdNameString!Log ID.
nameString!Name of the external destination to send audit events to.

LabelInterface

Implementations:

Fields
NameTypeDescription
colorString!Background color of the label.
createdAtTime!When the label was created.
descriptionStringDescription of the label (Markdown rendered as HTML for caching).
textColorString!Text color of the label.
titleString!Content of the label.
updatedAtTime!When the label was last updated.

MemberInterface

Implementations:

Fields
NameTypeDescription
accessLevelAccessLevelGitLab::Access level.
createdAtTimeDate and time the membership was created.
createdByUserCoreUser that authorized membership.
expiresAtTimeDate and time the membership expires.
idID!ID of the member.
updatedAtTimeDate and time the membership was last updated.
userUserCoreUser that is associated with the member object.
Fields with arguments
MemberInterface.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

####### Arguments

NameTypeDescription
idMergeRequestID!Global ID of the merge request.

NoteableInterface

Implementations:

Fields
NameTypeDescription
commentersUserCoreConnection!All commenters on this noteable. (see Connections)
discussionsDiscussionConnection!All discussions on this noteable. (see Connections)
Fields with arguments
NoteableInterface.notes

All notes on this noteable.

Returns NoteConnection!.

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

####### Arguments

NameTypeDescription
filterNotesFilterTypeType of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.

OrchestrationPolicy

Implementations:

Fields
NameTypeDescription
descriptionString!Description of the policy.
editPathString!URL of policy edit page.
enabledBoolean!Indicates whether this policy is enabled.
nameString!Name of the policy.
policyScopePolicyScopeScope of the policy.
updatedAtTime!Timestamp of when the policy YAML was last updated.
yamlString!YAML definition of the policy.

PackageFileMetadata

Represents metadata associated with a Package file.

Implementations:

Fields
NameTypeDescription
createdAtTime!Date of creation.
updatedAtTime!Date of most recent update.

PendingMemberInterface

Implementations:

Fields
NameTypeDescription
accessLevelAccessLevelGitLab::Access level.
approvedBooleanWhether the pending member has been approved.
avatarUrlStringURL to avatar image file of the pending member.
createdAtTimeDate and time the membership was created.
createdByUserCoreUser that authorized membership.
emailStringPublic email of the pending member.
expiresAtTimeDate and time the membership expires.
idID!ID of the member.
invitedBooleanWhether the pending member has been invited.
nameStringName of the pending member.
updatedAtTimeDate and time the membership was last updated.
userUserCoreUser that is associated with the member object.
usernameStringUsername of the pending member.
webUrlStringWeb URL of the pending member.
Fields with arguments
PendingMemberInterface.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

####### Arguments

NameTypeDescription
idMergeRequestID!Global ID of the merge request.

ResolvableInterface

Implementations:

Fields
NameTypeDescription
resolvableBoolean!Indicates if the object can be resolved.
resolvedBoolean!Indicates if the object is resolved.
resolvedAtTimeTimestamp of when the object was resolved.
resolvedByUserCoreUser who resolved the object.

RoleInterface

Implementations:

Fields
NameTypeDescription
descriptionStringRole description.
detailsPath warning-solidStringIntroduced in GitLab 17.4. Status: Experiment. URL path to the role details webpage.
idID!Role ID.
membersCount warning-solidIntIntroduced in GitLab 17.3. Status: Experiment. Number of times the role has been directly assigned to a group or project member.
nameStringRole name.
usersCount warning-solidIntIntroduced in GitLab 17.5. Status: Experiment. Number of users who have been directly assigned the role in at least one group or project.

Service

Implementations:

Fields
NameTypeDescription
activeBooleanIndicates if the service is active.
serviceTypeServiceTypeType of the service.
typeStringClass name of the service.

TerraformModuleMetadataSharedFields

Implementations:

Fields
NameTypeDescription
inputs[TerraformModuleMetadataInput!]Inputs of the module.
outputs[TerraformModuleMetadataOutput!]Outputs of the module.
readmeStringReadme data.
readmeHtmlStringGitLab Flavored Markdown rendering of readme.

TimeboxReportInterface

Implementations:

Fields with arguments
TimeboxReportInterface.report

Historically accurate report about the timebox.

Returns TimeboxReport.

####### Arguments

NameTypeDescription
fullPathStringFull path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

Todoable

Implementations:

Fields
NameTypeDescription
nameStringName or title of this object.
webUrlStringURL of this object.

User

Representation of a GitLab user.

Implementations:

Fields
NameTypeDescription
activeBooleanIndicates if the user is active.
avatarUrlStringURL of the user’s avatar.
bioStringBio of the user.
botBoolean!Indicates if the user is a bot.
calloutsUserCalloutConnectionUser callouts that belong to the user. (see Connections)
commitEmailStringUser’s default commit email.
createdAtTimeTimestamp of when the user was created.
discordStringDiscord ID of the user.
email warning-solidStringDeprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emailsEmailConnectionUser’s email addresses. (see Connections)
gitpodEnabledBooleanWhether Gitpod is enabled at the user level.
groupCountIntGroup count for the user.
groupMembershipsGroupMemberConnectionGroup memberships of the user. (see Connections)
humanBooleanIndicates if the user is a regular user.
idUserID!Global ID of the user.
ideIdeIDE settings.
jobTitleStringJob title of the user.
lastActivityOnDateDate the user last performed any actions.
linkedinStringLinkedIn profile name of the user.
locationStringLocation of the user.
nameString!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.
namespaceNamespacePersonal namespace of the user.
namespaceCommitEmailsNamespaceCommitEmailConnectionUser’s custom namespace commit emails. (see Connections)
organizationStringWho the user represents or works for.
preferencesGitpodPathStringWeb path to the Gitpod section within user preferences.
profileEnableGitpodPathStringWeb path to enable Gitpod for the user.
projectMembershipsProjectMemberConnectionProject memberships of the user. (see Connections)
pronounsStringPronouns of the user.
publicEmailStringUser’s public email.
savedRepliesSavedReplyConnectionSaved replies authored by the user. (see Connections)
stateUserState!State of the user.
statusUserStatusUser status.
twitterStringX (formerly Twitter) username of the user.
typeUserType!Type of the user.
userPermissionsUserPermissions!Permissions for the current user on the resource.
userPreferencesUserPreferencesPreferences for the user.
usernameString!Username of the user. Unique within this instance of GitLab.
webPathString!Web path of the user.
webUrlString!Web URL of the user.
Fields with arguments
User.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

####### Arguments

NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
User.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

####### Arguments

NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsernameStringUsername of the reviewer.
reviewerWildcardIdReviewerWildcardIdFilter by reviewer presence. Incompatible with reviewerUsername.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
User.contributedProjects

Projects the user has contributed to.

Returns ProjectConnection.

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

####### Arguments

NameTypeDescription
includePersonalBooleanInclude personal projects.
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortSort contributed projects.
User.groups

Groups where the user has access.

Returns GroupConnection.

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

####### Arguments

NameTypeDescription
permissionScopeGroupPermissionFilter by permissions the user has on groups.
searchStringSearch by group name or path.
User.organizations

Organizations where the user has access.

  • Introduced in GitLab 16.6.
  • Status: Experiment.

Returns OrganizationConnection.

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

####### Arguments

NameTypeDescription
searchStringSearch query, which can be for the organization name or a path.
soloOwnedBooleanWhen true, returns only organizations solely owned by the user.
User.reviewRequestedMergeRequests

Merge requests assigned to the user for review.

Returns MergeRequestConnection.

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

####### Arguments

NameTypeDescription
approvedBooleanLimit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy[String!]Usernames of the approvers.
approver[String!]Usernames of possible approvers.
assigneeUsernameStringUsername of the assignee.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsernameStringUsername of the author.
blobPath warning-solidStringIntroduced in GitLab 17.7. Status: Experiment. Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments. Available only when the feature flag filter_blob_path is enabled.
createdAfterTimeMerge requests created after the timestamp.
createdBeforeTimeMerge requests created before the timestamp.
deployedAfterTimeMerge requests deployed after the timestamp.
deployedBeforeTimeMerge requests deployed before the timestamp.
deploymentIdStringID of the deployment.
draftBooleanLimit result to draft merge requests.
environmentNameStringEnvironment merge requests have been deployed to.
groupIdGroupIDThe global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
iids[String!]Array of IIDs of merge requests, for example [1, 2].
in[IssuableSearchableField!]Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchivedBooleanMerge requests from archived projects.
labelName[String]Labels applied to the merge request.
labels warning-solid[String!]Deprecated in GitLab 17.1. Use labelName.
mergedAfterTimeMerge requests merged after the date.
mergedBeforeTimeMerge requests merged before the date.
mergedByStringUsername of the merger.
milestoneTitleStringTitle of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardIdMilestoneWildcardIdFilter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmojiStringFilter by your reaction emoji.
notMergeRequestsResolverNegatedParamsList of negated arguments. Warning: this argument is experimental and a subject to change in future.
projectIdProjectIDThe global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPathStringThe full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTagStringFilter by release tag.
reviewState warning-solidMergeRequestReviewStateIntroduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates warning-solid[MergeRequestReviewState!]Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
searchStringSearch query for title or description.
sortMergeRequestSortSort 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.
stateMergeRequestStateMerge request state. If provided, all resolved merge requests will have the state.
subscribedSubscriptionStatusMerge 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.
updatedAfterTimeMerge requests updated after the timestamp.
updatedBeforeTimeMerge requests updated before the timestamp.
User.savedReply

Saved reply authored by the user.

Returns SavedReply.

####### Arguments

NameTypeDescription
idUsersSavedReplyID!ID of a saved reply.
User.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

####### Arguments

NameTypeDescription
ids[SnippetID!]Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
typeTypeEnumType of snippet.
visibilityVisibilityScopesEnumVisibility of the snippet.
User.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

####### Arguments

NameTypeDescription
minAccessLevelAccessLevelEnumReturn only projects where current user has at least the specified access level.
programmingLanguageNameStringFilter projects by programming language name (case insensitive). For example: “css” or “ruby”.
searchStringSearch query.
sortProjectSortList starred projects by sort order.
User.timelogs

Time logged by the user.

Returns TimelogConnection.

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

####### Arguments

NameTypeDescription
endDateTimeList timelogs within a date range where the logged date is equal to or before endDate.
endTimeTimeList timelogs within a time range where the logged time is equal to or before endTime.
groupIdGroupIDList timelogs for a group.
projectIdProjectIDList timelogs for a project.
sortTimelogSortList timelogs in a particular order.
startDateTimeList timelogs within a date range where the logged date is equal to or after startDate.
startTimeTimeList timelogs within a time range where the logged time is equal to or after startTime.
usernameStringList timelogs for a user.
User.todos

To-do items of the user.

Returns TodoConnection.

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

####### Arguments

NameTypeDescription
action[TodoActionEnum!]Action to be filtered.
authorId[ID!]ID of an author.
groupId[ID!]ID of a group.
isSnoozedBooleanWhether the to-do item is snoozed.
projectId[ID!]ID of a project.
sortTodoSortSort todos by given criteria.
state[TodoStateEnum!]State of the todo.
type[TodoTargetEnum!]Type of the todo.
User.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

  • Introduced in GitLab 15.10.
  • Status: Experiment.

Returns UserAchievementConnection.

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

####### Arguments

NameTypeDescription
includeHiddenBooleanIndicates whether or not achievements hidden from the profile should be included in the result.

WorkItemCustomFieldValue

Implementations:

Fields
NameTypeDescription
customFieldCustomField!Custom field associated with the custom field value.

WorkItemWidget

Implementations:

Fields
NameTypeDescription
typeWorkItemWidgetTypeWidget type.

WorkItemWidgetDefinition

Implementations:

Fields
NameTypeDescription
typeWorkItemWidgetType!Widget type.

Input types

Types that may be used as arguments (all scalar types may also be used as arguments).

Only general use input types are listed here. For mutation input types, see the associated mutation type above.

AiAdditionalContextInput

Arguments

NameTypeDescription
categoryAiAdditionalContextCategory!Category of the additional context.
contentString!Content of the additional context.
idString!ID of the additional context.
metadataJSONMetadata of the additional context.

AiChatInput

Arguments

NameTypeDescription
additionalContext[AiAdditionalContextInput!]Additional context to be passed for the chat.
agentVersionIdAiAgentVersionIDGlobal ID of the agent version to answer the chat.
contentString!Content of the message.
currentFileAiCurrentFileInputInformation about currently selected text which can be passed for additional context.
namespaceIdNamespaceIDGlobal ID of the namespace the user is acting on.
resourceIdAiModelIDGlobal ID of the resource to mutate.

AiCurrentFileInput

Arguments

NameTypeDescription
contentAboveCursorStringContent above cursor.
contentBelowCursorStringContent below cursor.
fileNameString!File name.
selectedTextString!Selected text.

AiExplainVulnerabilityInput

Arguments

NameTypeDescription
includeSourceCodeBooleanInclude vulnerablility source code in the AI prompt.
resourceIdAiModelID!Global ID of the resource to mutate.

AiGenerateCommitMessageInput

Arguments

NameTypeDescription
resourceIdAiModelID!Global ID of the resource to mutate.

AiGenerateCubeQueryInput

Arguments

NameTypeDescription
questionString!Question to ask a project’s data.
resourceIdAiModelID!Global ID of the resource to mutate.

AiGenerateDescriptionInput

Arguments

NameTypeDescription
contentString!Content of the message.
descriptionTemplateNameStringName of the description template to use to generate message off of.
resourceIdAiModelID!Global ID of the resource to mutate.

AiMeasureCommentTemperatureInput

Arguments

NameTypeDescription
contentString!Content of the message.
resourceIdAiModelID!Global ID of the resource to mutate.

AiResolveVulnerabilityInput

Arguments

NameTypeDescription
resourceIdAiModelID!Global ID of the resource to mutate.
vulnerableMergeRequestIdMergeRequestIDGlobal ID of the merge request which the merge request containing the vulnerability resolution will target.

AiSummarizeCommentsInput

Arguments

NameTypeDescription
resourceIdAiModelID!Global ID of the resource to mutate.

AiSummarizeNewMergeRequestInput

Summarize a new merge request based on two branches. Returns null if the add_ai_summary_for_new_mr feature flag is disabled.

Arguments

NameTypeDescription
resourceIdAiModelID!Global ID of the resource to mutate.
sourceBranchString!Source branch of the changes.
sourceProjectIdIDID of the project where the changes are from.
targetBranchString!Target branch of where the changes will be merged into.

AiSummarizeReviewInput

Arguments

NameTypeDescription
resourceIdAiModelID!Global ID of the resource to mutate.

AlertManagementPayloadAlertFieldInput

Field that are available while modifying the custom mapping attributes for an HTTP integration.

Arguments

NameTypeDescription
fieldNameAlertManagementPayloadAlertFieldName!GitLab alert field name.
labelStringHuman-readable label of the payload path.
path[PayloadAlertFieldPathSegment!]!Path to value inside payload JSON.
typeAlertManagementPayloadAlertFieldType!Type of the parsed value.

BoardIssueInput

Arguments

NameTypeDescription
assigneeUsername[String]Filter by assignee username.
assigneeWildcardIdAssigneeWildcardIdFilter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsernameStringFilter by author username.
confidentialBooleanFilter by confidentiality.
epicId warning-solidEpicIDDeprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
epicWildcardIdEpicWildcardIdFilter by epic ID wildcard. Incompatible with epicId.
healthStatusFilterHealthStatusFilterHealth status of the issue, “none” and “any” values are supported.
iids[String!]List of IIDs of issues. For example ["1", "2"].
iterationCadenceId[IterationsCadenceID!]Filter by a list of iteration cadence IDs.
iterationId[IterationID!]Filter by a list of iteration IDs. Incompatible with iterationWildcardId.
iterationTitleStringFilter by iteration title.
iterationWildcardIdIterationWildcardIdFilter by iteration ID wildcard.
labelName[String]Filter by label name.
milestoneTitleStringFilter by milestone title.
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
notNegatedBoardIssueInputList of negated arguments.
orUnionedIssueFilterInputList of arguments with inclusive OR.
releaseTagStringFilter by release tag.
searchStringSearch query for issue title or description.
types[IssueType!]Filter by the given issue types.
weightStringFilter by weight.
weightWildcardIdWeightWildcardIdFilter by weight ID wildcard. Incompatible with weight.

BranchProtectionInput

Arguments

NameTypeDescription
allowForcePushBooleanAllows users with write access to the branch rule target to force push changes.
codeOwnerApprovalRequiredBooleanEnforce code owner approvals before allowing a merge.
mergeAccessLevels[MergeAccessLevelInput!]Details about who can merge into the branch rule target.
pushAccessLevels[PushAccessLevelInput!]Details about who can push to the branch rule target.

CiVariableInput

Attributes for defining a CI/CD variable.

Arguments

NameTypeDescription
keyString!Name of the variable.
valueString!Value of the variable.
variableTypeCiVariableTypeType of variable.

CommitAction

Arguments

NameTypeDescription
actionCommitActionMode!Action to perform: create, delete, move, update, or chmod.
contentStringContent of the file.
encodingCommitEncodingEncoding of the file. Default is text.
executeFilemodeBooleanEnables/disables the execute flag on the file.
filePathString!Full path to the file.
lastCommitIdStringLast known file commit ID.
previousPathStringOriginal full path to the file being moved.

ComplianceFrameworkFilters

Arguments

NameTypeDescription
idComplianceManagementFrameworkIDID of the compliance framework.
ids[ComplianceManagementFrameworkID!]IDs of the compliance framework.
notNegatedComplianceFrameworkFiltersNegated compliance framework filter input.
presenceFilterComplianceFrameworkPresenceFilterChecks presence of compliance framework of the project, “none” and “any” values are supported.

ComplianceFrameworkInput

Arguments

NameTypeDescription
colorStringNew color representation of the compliance framework in hex format. e.g. #FCA121.
defaultBooleanSet this compliance framework as the default framework for the group.
descriptionStringNew description for the compliance framework.
nameStringNew name for the compliance framework.
pipelineConfigurationFullPath warning-solidStringDeprecated: Use pipeline execution policies instead. Deprecated in GitLab 17.4.

ComplianceRequirementInput

Arguments

NameTypeDescription
descriptionStringNew description for the compliance requirement.
nameStringNew name for the compliance requirement.

ComplianceRequirementsControlInput

Arguments

NameTypeDescription
expressionStringExpression of the compliance control.
nameStringNew name for the compliance requirement control.

ComplianceStandardsAdherenceInput

Arguments

NameTypeDescription
checkNameComplianceStandardsAdherenceCheckNameName of the check for the compliance standard.
projectIds[ProjectID!]Filter compliance standards adherence by project.
standardComplianceStandardsAdherenceStandardName of the compliance standard.

ComplianceStandardsProjectAdherenceInput

Arguments

NameTypeDescription
checkNameComplianceStandardsAdherenceCheckNameName of the check for the compliance standard.
standardComplianceStandardsAdherenceStandardName of the compliance standard.

ComplianceViolationInput

Arguments

NameTypeDescription
mergedAfterDateMerge requests merged after the date (inclusive).
mergedBeforeDateMerge requests merged before the date (inclusive).
projectIds[ProjectID!]Filter compliance violations by project.
targetBranchStringFilter compliance violations by target branch.

ComplianceViolationProjectInput

Arguments

NameTypeDescription
mergedAfterDateMerge requests merged after the date (inclusive).
mergedBeforeDateMerge requests merged before the date (inclusive).
targetBranchStringFilter compliance violations by target branch.

CustomFieldSelectOptionInput

Attributes for the custom field select option.

Arguments

NameTypeDescription
idIssuablesCustomFieldSelectOptionIDGlobal ID of the custom field select option to update. Creates a new record if not provided.
valueString!Value of the custom field select option.

DastProfileCadenceInput

Represents DAST Profile Cadence.

Arguments

NameTypeDescription
durationIntDuration of the DAST Profile Cadence.
unitDastProfileCadenceUnitUnit for the duration of DAST Profile Cadence.

DastProfileScheduleInput

Input type for DAST Profile Schedules.

Arguments

NameTypeDescription
activeBooleanStatus of a Dast Profile Schedule.
cadenceDastProfileCadenceInputCadence of a Dast Profile Schedule.
startsAtTimeStart time of a Dast Profile Schedule.
timezoneStringTime Zone for the Start time of a Dast Profile Schedule.

DastSiteProfileAuthInput

Input type for DastSiteProfile authentication.

Arguments

NameTypeDescription
enabledBooleanIndicates whether authentication is enabled.
passwordStringPassword to authenticate with on the target.
passwordFieldStringName of password field at the sign-in HTML form.
submitFieldStringName or ID of sign-in submit button at the sign-in HTML form.
urlStringThe URL of the page containing the sign-in HTML form on the target website.
usernameStringUsername to authenticate with on the target.
usernameFieldStringName of username field at the sign-in HTML form.

DeploymentsOrderByInput

Values for ordering deployments by a specific field.

Arguments

NameTypeDescription
createdAtSortDirectionEnumOrder by Created time.
finishedAtSortDirectionEnumOrder by Finished time.

DiffImagePositionInput

Arguments

NameTypeDescription
baseShaStringMerge base of the branch the comment was made on.
headShaString!SHA of the HEAD at the time the comment was made.
heightInt!Total height of the image.
pathsDiffPathsInput!The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required.
startShaString!SHA of the branch being compared against.
widthInt!Total width of the image.
xInt!X position of the note.
yInt!Y position of the note.

DiffPathsInput

Arguments

NameTypeDescription
newPathStringPath of the file on the HEAD SHA.
oldPathStringPath of the file on the start SHA.

DiffPositionInput

Arguments

NameTypeDescription
baseShaStringMerge base of the branch the comment was made on.
headShaString!SHA of the HEAD at the time the comment was made.
newLineIntLine on HEAD SHA that was changed. Please see the REST API Documentation for more information on how to use this field.
oldLineIntLine on start SHA that was changed. Please see the REST API Documentation for more information on how to use this field.
pathsDiffPathsInput!The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required.
startShaString!SHA of the branch being compared against.

DoraProjectFilterInput

Filter parameters for projects to be aggregated for DORA metrics.

Arguments

NameTypeDescription
topic[String!]Filter projects by topic.

EpicFilters

Arguments

NameTypeDescription
authorUsernameStringFilter by author username.
confidentialBooleanFilter by confidentiality.
labelName[String]Filter by label name.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
notNegatedEpicBoardIssueInputNegated epic arguments.
orUnionedEpicFilterInputList of arguments with inclusive OR.
searchStringSearch query for epic title or description.

EpicTreeNodeFieldsInputType

A node of an epic tree.

Arguments

NameTypeDescription
adjacentReferenceIdEpicTreeSortingIDID of the epic issue or issue the epic or issue is switched with.
idEpicTreeSortingID!ID of the epic issue or epic that is being moved.
newParentIdEpicIDID of the new parent epic.
relativePositionMoveTypeType of switch. Valid values are after or before.

EscalationRuleInput

Represents an escalation rule.

Arguments

NameTypeDescription
elapsedTimeSecondsInt!Time in seconds before the rule is activated.
oncallScheduleIidIDOn-call schedule to notify.
statusEscalationRuleStatus!Status required to prevent the rule from activating.
usernameStringUsername of the user to notify.

GoogleCloudNodePool

Attributes for defining Node Pool in GKE.

Arguments

NameTypeDescription
imageTypeGoogleCloudImage!Image to use on the pool.
labels[GoogleCloudNodePoolLabel!]Labels for the node pool of the runner.
machineTypeGoogleCloudMachineType!Machine type to use.
nameString!Name of the node pool.
nodeCountInt!Node count of the pool.

GoogleCloudNodePoolLabel

Labels for the Node Pool of a GKE cluster.

Arguments

NameTypeDescription
keyString!Key of the label.
valueString!Value of the label.

JiraUsersMappingInputType

Arguments

NameTypeDescription
gitlabIdIntID of the GitLab user.
jiraAccountIdString!Jira account ID of the user.

MergeAccessLevelInput

Defines which user roles, users, or groups can merge into a protected branch.

Arguments

NameTypeDescription
accessLevelIntAccess level allowed to perform action.
groupIdGroupIDGroup associated with the access level.
userIdUserIDUser associated with the access level.

MergeRequestsResolverNegatedParams

Arguments

NameTypeDescription
approvedBy[String!]Filters merge requests to exclude any that are approved by usernames in the given array.
assigneeUsernames[String!]Filters merge requests to exclude any that are assigned to the usernames in the given array.
authorUsernameStringFilters merge requests to exclude any that are authored by the given user.
labelName[String!]Filters merge requests to exclude any that have the labels provided in the given array.
labels warning-solid[String!]Deprecated: Use labelName. Deprecated in GitLab 17.7.
milestoneTitleStringFilters merge requests to those not in the given milestone.
myReactionEmojiStringFilters merge requests to those without the given reaction from the authenticated user.
releaseTagStringFilters merge requests to those without the given release tag.
reviewStates warning-solid[MergeRequestReviewState!]Deprecated: Status: Experiment. Introduced in GitLab 17.9.
reviewerUsernameStringFilters merge requests to those not reviewed by the given user.
sourceBranches[String!]Filters merge requests to exclude the source branch names provided in the given array.
targetBranches[String!]Filters merge requests to exclude the target branch names provided in the given array.

MonthSelectionInput

A year and month input for querying product analytics usage data.

Arguments

NameTypeDescription
monthInt!Month of the period to return.
yearInt!Year of the period to return.

NegatedBoardIssueInput

Arguments

NameTypeDescription
assigneeUsername[String]Filter by assignee username.
authorUsernameStringFilter by author username.
epicId warning-solidEpicIDDeprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
healthStatusFilterHealthStatusHealth status not applied to the issue. Includes issues where health status is not set.
iids[String!]List of IIDs of issues. For example ["1", "2"].
iterationId[IterationID!]Filter by a list of iteration IDs. Incompatible with iterationWildcardId.
iterationTitleStringFilter by iteration title.
iterationWildcardIdNegatedIterationWildcardIdFilter by iteration ID wildcard.
labelName[String]Filter by label name.
milestoneTitleStringFilter by milestone title.
milestoneWildcardIdMilestoneWildcardIdFilter by milestone ID wildcard.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
releaseTagStringFilter by release tag.
types[IssueType!]Filter by the given issue types.
weightStringFilter by weight.

NegatedComplianceFrameworkFilters

Arguments

NameTypeDescription
idComplianceManagementFrameworkIDID of the compliance framework.
ids[ComplianceManagementFrameworkID!]IDs of the compliance framework.

NegatedEpicBoardIssueInput

Arguments

NameTypeDescription
authorUsernameStringFilter by author username.
labelName[String]Filter by label name.
myReactionEmojiStringFilter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.

NegatedEpicFilterInput

Arguments

NameTypeDescription
authorUsernameStringFilter by author username.
labelName[String]Filter by label name.
myReactionEmojiStringFilter by reaction emoji applied by the current user.

NegatedIssueFilterInput

Arguments

NameTypeDescription
assigneeIdStringID of a user not assigned to the issues.
assigneeUsernames[String!]Usernames of users not assigned to the issue.
authorUsername[String!]Username of a user who didn’t author the issue.
epicIdStringID of an epic not associated with the issues.
healthStatusFilter[HealthStatus!]Health status not applied to the issue. Includes issues where health status is not set.
iids[String!]List of IIDs of issues to exclude. For example, [1, 2].
iterationId[ID!]List of iteration Global IDs not applied to the issue.
iterationWildcardIdIterationWildcardIdFilter by negated iteration ID wildcard.
labelName[String!]Labels not applied to this issue.
milestoneTitle[String!]Milestone not applied to this issue.
milestoneWildcardIdNegatedMilestoneWildcardIdFilter by negated milestone wildcard values.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
releaseTag[String!]Release tag not associated with the issue’s milestone. Ignored when parent is a group.
types[IssueType!]Filters out issues by the given issue types.
weightStringWeight not applied to the issue.

NegatedValueStreamAnalyticsIssuableFilterInput

Arguments

NameTypeDescription
assigneeUsernames[String!]Usernames of users not assigned to the issue or merge request.
authorUsernameStringUsername of a user who didn’t author the issue or merge request.
epicIdIDID of an epic not associated with the issues. Using the filter is not supported for stages based on merge requests.
iterationIdIDList of iteration Global IDs not applied to the issue. Using the filter is not supported for stages based on merge requests.
labelNames[String!]Labels not applied to the issue or merge request.
milestoneTitleStringMilestone not applied to the issue or merge request.
myReactionEmojiStringFilter by reaction emoji applied by the current user.
weightIntWeight not applied to the issue. Using the filter is not supported for stages based on merge requests.

NegatedWorkItemFilterInput

Arguments

NameTypeDescription
assigneeUsernames[String!]Usernames of users not assigned to the work item.
authorUsername[String!]Username of a user who didn’t author the work item.
labelName[String!]Labels not applied to the work item.
milestoneTitle[String!]Milestone not applied to the work item.
milestoneWildcardIdNegatedMilestoneWildcardIdFilter by negated milestone wildcard values.
myReactionEmojiStringFilter by reaction emoji not applied by the current user.

OncallRotationActivePeriodInputType

Active period time range for on-call rotation.

Arguments

NameTypeDescription
endTimeString!End of the rotation active period in 24 hour format. For example, “18:30”.
startTimeString!Start of the rotation active period in 24 hour format. For example, “18:30”.

OncallRotationDateInputType

Date input type for on-call rotation.

Arguments

NameTypeDescription
dateString!Date component of the date in YYYY-MM-DD format.
timeString!Time component of the date in 24hr HH:MM format.

OncallRotationLengthInputType

The rotation length of the on-call rotation.

Arguments

NameTypeDescription
lengthInt!Rotation length of the on-call rotation.
unitOncallRotationUnitEnum!Unit of the rotation length of the on-call rotation.

OncallUserInputType

The rotation user and color palette.

Arguments

NameTypeDescription
colorPaletteDataVisualizationColorEnumValue of DataVisualizationColorEnum. The color from the palette to assign to the on-call user.
colorWeightDataVisualizationWeightEnumColor weight to assign to for the on-call user. To view on-call schedules in GitLab, do not provide a value below 500. A value between 500 and 950 ensures sufficient contrast.
usernameString!Username of the user to participate in the on-call rotation. For example, "user_one".

PipelineScheduleVariableInput

Attributes for the pipeline schedule variable.

Arguments

NameTypeDescription
destroyBooleanBoolean option to destroy the variable.
idCiPipelineScheduleVariableIDID of the variable to mutate.
keyString!Name of the variable.
valueString!Value of the variable.
variableTypeCiVariableType!Type of the variable.

PushAccessLevelInput

Defines which user roles, users, deploy keys, or groups can push to a protected branch.

Arguments

NameTypeDescription
accessLevelIntAccess level allowed to perform action.
deployKeyIdDeployKeyIDDeploy key assigned to the access level.
groupIdGroupIDGroup associated with the access level.
userIdUserIDUser associated with the access level.

ReleaseAssetLinkInput

Fields that are available when modifying a release asset link.

Arguments

NameTypeDescription
directAssetPathStringRelative path for a direct asset link.
linkTypeReleaseAssetLinkTypeType of the asset link.
nameString!Name of the asset link.
urlString!URL of the asset link.

ReleaseAssetsInput

Fields that are available when modifying release assets.

Arguments

NameTypeDescription
links[ReleaseAssetLinkInput!]List of asset links to associate to the release.

RequirementLegacyFilterInput

Arguments

NameTypeDescription
legacyIids[String!]!List of legacy requirement IIDs of work items. or example ["1", "2"].

SastCiConfigurationAnalyzersEntityInput

Represents the analyzers entity in SAST CI configuration.

Arguments

NameTypeDescription
enabledBoolean!State of the analyzer.
nameString!Name of analyzer.
variables[SastCiConfigurationEntityInput!]List of variables for the analyzer.

SastCiConfigurationEntityInput

Represents an entity in SAST CI configuration.

Arguments

NameTypeDescription
defaultValueString!Default value that is used if value is empty.
fieldString!CI keyword of entity.
valueString!Current value of the entity.

SastCiConfigurationInput

Represents a CI configuration of SAST.

Arguments

NameTypeDescription
analyzers[SastCiConfigurationAnalyzersEntityInput!]List of analyzers and related variables for the SAST configuration.
global[SastCiConfigurationEntityInput!]List of global entities related to SAST configuration.
pipeline[SastCiConfigurationEntityInput!]List of pipeline entities related to SAST configuration.

SnippetBlobActionInputType

Represents an action to perform over a snippet file.

Arguments

NameTypeDescription
actionSnippetBlobActionEnum!Type of input action.
contentStringSnippet file content.
filePathString!Path of the snippet file.
previousPathStringPrevious path of the snippet file.

StatusFilterInput

Arguments

NameTypeDescription
statusRequirementStatusFilter!Status of the work item.

StatusInput

Arguments

NameTypeDescription
statusTestReportState!Status to assign to the work item.

Timeframe

A time-frame defined as a closed inclusive range of two dates.

Arguments

NameTypeDescription
endDate!End of the range.
startDate!Start of the range.

TrackingEventInput

Attributes for defining a tracking event.

Arguments

NameTypeDescription
actionString!Event action.
categoryString!Event category.
extraJSONExtra metadata for the event.
labelStringEvent label.
propertyStringEvent property.
valueStringEvent value.

UnionedEpicFilterInput

Arguments

NameTypeDescription
authorUsername warning-solid[String!]Deprecated: Use authorUsernames instead. Deprecated in GitLab 16.6.
authorUsernames[String!]Filters epics that are authored by one of the given users.
labelName warning-solid[String!]Deprecated: Use labelNames instead. Deprecated in GitLab 16.6.
labelNames[String!]Filters epics that have at least one of the given labels.

UnionedIssueFilterInput

Arguments

NameTypeDescription
assigneeUsernames[String!]Filters issues that are assigned to at least one of the given users.
authorUsernames[String!]Filters issues that are authored by one of the given users.
labelNames[String!]Filters issues that have at least one of the given labels.

UnionedWorkItemFilterInput

Arguments

NameTypeDescription
assigneeUsernames[String!]Filters work items that are assigned to at least one of the given users.
authorUsernames[String!]Filters work items that are authored by one of the given users.
labelNames[String!]Filters work items that have at least one of the given labels.

UpdateDiffImagePositionInput

Arguments

NameTypeDescription
heightIntTotal height of the image.
widthIntTotal width of the image.
xIntX position of the note.
yIntY position of the note.

ValueStreamSettingInput

Attributes for value stream setting.

Arguments

NameTypeDescription
projectIdsFilter[ProjectID!]Projects’ global IDs used to filter value stream data.

ValueStreamStageInput

Attributes for value stream stage.

Arguments

NameTypeDescription
customBooleanWhether the stage is customized. If false, it assigns a built-in default stage by name.
endEventIdentifierValueStreamStageEventEnd event identifier.
endEventLabelIdLabelIDLabel ID associated with the end event identifier.
hiddenBooleanWhether the stage is hidden.
nameString!Name of the stage.
startEventIdentifierValueStreamStageEventStart event identifier.
startEventLabelIdLabelIDLabel ID associated with the start event identifier.

VulnerabilityIdentifierInput

Arguments

NameTypeDescription
externalIdStringExternal ID of the vulnerability identifier.
externalTypeStringExternal type of the vulnerability identifier.
nameString!Name of the vulnerability identifier.
urlString!URL of the vulnerability identifier.

VulnerabilityScannerInput

Arguments

NameTypeDescription
idString!Unique ID that identifies the scanner.
nameString!Human readable value that identifies the analyzer, not required to be unique.
urlString!Link to more information about the analyzer.
vendorVulnerabilityScannerVendorInputInformation about vendor/maintainer of the scanner.
versionString!Version of the scanner.

VulnerabilityScannerVendorInput

Arguments

NameTypeDescription
nameString!Name of the vendor/maintainer.

WorkItemConvertTaskInput

Arguments

NameTypeDescription
lineNumberEndInt!Last line in the Markdown source that defines the list item task.
lineNumberStartInt!First line in the Markdown source that defines the list item task.
lockVersionInt!Current lock version of the work item containing the task in the description.
titleString!Full string of the task to be replaced. New title for the created work item.
workItemTypeIdWorkItemsTypeID!Global ID of the work item type used to create the new work item.

WorkItemDescriptionTemplateContentInput

Arguments

NameTypeDescription
nameString!Name of the description template.
projectIdInt!ID of the project the template belongs to.

WorkItemResolveDiscussionsInput

Arguments

NameTypeDescription
discussionIdStringID of a discussion to resolve.
noteableIdNoteableID!Global ID of the noteable where discussions will be resolved when the work item is created. Only MergeRequestID is supported at the moment.

WorkItemWidgetAssigneesInput

Arguments

NameTypeDescription
assigneeIds[UserID!]!Global IDs of assignees.

WorkItemWidgetAwardEmojiUpdateInput

Arguments

NameTypeDescription
actionWorkItemAwardEmojiUpdateAction!Action for the update.
nameString!Emoji name.

WorkItemWidgetColorInput

Arguments

NameTypeDescription
colorColor!Color of the work item.

WorkItemWidgetCrmContactsCreateInput

Arguments

NameTypeDescription
contactIds[CustomerRelationsContactID!]!CRM contact IDs to set.

WorkItemWidgetCrmContactsUpdateInput

Arguments

NameTypeDescription
contactIds[CustomerRelationsContactID!]!CRM contact IDs to set. Replaces existing contacts by default.
operationModeMutationOperationModeSet the operation mode.

WorkItemWidgetCurrentUserTodosInput

Arguments

NameTypeDescription
actionWorkItemTodoUpdateAction!Action for the update.
todoIdTodoIDGlobal ID of the to-do. If not present, all to-dos of the work item will be updated.

WorkItemWidgetDescriptionInput

Arguments

NameTypeDescription
descriptionString!Description of the work item.

WorkItemWidgetHealthStatusInput

Arguments

NameTypeDescription
healthStatusHealthStatusHealth status to be assigned to the work item.

WorkItemWidgetHierarchyCreateInput

Arguments

NameTypeDescription
parentIdWorkItemIDGlobal ID of the parent work item.

WorkItemWidgetHierarchyUpdateInput

Arguments

NameTypeDescription
adjacentWorkItemIdWorkItemIDID of the work item to be switched with.
childrenIds[WorkItemID!]Global IDs of children work items.
parentIdWorkItemIDGlobal ID of the parent work item. Use null to remove the association.
relativePositionRelativePositionTypeType of switch. Valid values are BEFORE or AFTER.

WorkItemWidgetIterationInput

Arguments

NameTypeDescription
iterationIdIterationIDIteration to assign to the work item.

WorkItemWidgetLabelsCreateInput

Arguments

NameTypeDescription
labelIds[LabelID!]!IDs of labels to be added to the work item.

WorkItemWidgetLabelsUpdateInput

Arguments

NameTypeDescription
addLabelIds[LabelID!]Global IDs of labels to be added to the work item.
removeLabelIds[LabelID!]Global IDs of labels to be removed from the work item.

WorkItemWidgetLinkedItemsCreateInput

Arguments

NameTypeDescription
linkTypeWorkItemRelatedLinkTypeType of link. Defaults to RELATED.
workItemsIds[WorkItemID!]!Global IDs of the items to link. Maximum number of IDs you can provide: 10.

WorkItemWidgetMilestoneInput

Arguments

NameTypeDescription
milestoneIdMilestoneIDMilestone to assign to the work item.

WorkItemWidgetNotesInput

Arguments

NameTypeDescription
discussionLockedBoolean!Discussion lock attribute for notes widget of the work item.

WorkItemWidgetNotificationsUpdateInput

Arguments

NameTypeDescription
subscribedBoolean!Desired state of the subscription.

WorkItemWidgetProgressInput

Arguments

NameTypeDescription
currentValueInt!Current progress value of the work item.
endValueIntEnd value of the work item.
startValueIntStart value of the work item.

WorkItemWidgetStartAndDueDateUpdateInput

Arguments

NameTypeDescription
dueDateDateDue date for the work item.
isFixedBooleanIndicates if the work item is using fixed dates.
startDateDateStart date for the work item.

WorkItemWidgetTimeTrackingInput

Arguments

NameTypeDescription
timeEstimateStringTime estimate for the work item in human readable format. For example: 1h 30m.
timelogWorkItemWidgetTimeTrackingTimelogInputTimelog data for time spent on the work item.

WorkItemWidgetTimeTrackingTimelogInput

Arguments

NameTypeDescription
spentAtTimeTimestamp of when the time tracked was spent at, if not provided would be set to current timestamp.
summaryStringSummary of how the time was spent.
timeSpentString!Amount of time spent in human readable format. For example: 1h 30m.

WorkItemWidgetWeightInput

Arguments

NameTypeDescription
weightIntWeight of the work item.

WorkspaceVariableInput

Attributes for defining a variable to be injected in a workspace.

Arguments

NameTypeDescription
keyString!Name of the workspace variable.
type warning-solidWorkspaceVariableInputTypeDeprecated: Use variableType instead. Deprecated in GitLab 17.9.
valueString!Value of the variable.
variableTypeWorkspaceVariableTypeType of the variable to be injected in a workspace.